v1

latestSwagger 2.02026-07-146023.3 KB

XML - Elevator/Escalator Outages

<h4 class="text-primary">Description</h4> <p>Returns a list of <em>reported</em> elevator and escalator outages at a given station. Omit the StationCode parameter to return all reported outages.</p> <p>Note that for stations with multiple platforms and therefore StationCodes (e.g.: Metro Center, L'Enfant Plaza, etc.), a distinct call is required for each StationCode.</p> <p>Elevator and escalator outages are refreshed once every 20 to 30 seconds approximately.</p> <h4 class="text-primary">Response Elements</h4> <table class="table table-condensed table-hover"> <thead> <tr> <th class="col-md-3">Element</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>ElevatorIncidents</td> <td> Array containing elevator/escalator outage information (<a href="#ElevatorIncident">ElevatorIncident</a>). </td> </tr> <tr> <td colspan="2"> <div class="text-primary" style="margin-top: 1em"> <a id="ElevatorIncident" name= "ElevatorIncident">ElevatorIncident Elements</a> </div> </td> </tr> <tr> <td>DateOutOfServ</td> <td>Date and time (Eastern Standard Time) unit was reported out of service. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T15:17:00).</td> </tr> <tr> <td>DateUpdated</td> <td>Date and time (Eastern Standard Time) outage details was last updated. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T15:17:00).</td> </tr> <tr> <td style="text-decoration: line-through">DisplayOrder</td> <td><span class="text-danger">Deprecated.</span></td> </tr> <tr> <td>EstimatedReturnToService</td> <td>Estimated date and time (Eastern Standard Time) by when unit is expected to return to normal service. May be NULL, otherwise will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-27T23:59:59).</td> </tr> <tr> <td>LocationDescription</td> <td>Free-text description of the unit location within a station (e.g.: <span class="text-info">Escalator between mezzanine and platform</span>).</td> </tr> <tr> <td>StationCode</td> <td>Unit's station code. Use this value in other rail-related APIs to retrieve data about a station.</td> </tr> <tr> <td>StationName</td> <td>Full station name, may include entrance information (e.g.: <span class="text-info">Metro Center, G and 11th St Entrance</span>).</td> </tr> <tr> <td style="text-decoration: line-through">SymptomCode</td> <td><span class="text-danger">Deprecated.</span></td> </tr> <tr> <td>SymptomDescription</td> <td>Description for why the unit is out of service or otherwise in reduced operation.</td> </tr> <tr> <td style="text-decoration: line-through">TimeOutOfService</td> <td><span class="text-danger">Deprecated.</span> Use the time portion of the DateOutOfServ element.</td> </tr> <tr> <td>UnitName</td> <td>Unique identifier for unit, by type (a single elevator and escalator may have the same UnitName, but no two elevators or two escalators will have the same UnitName).</td> </tr> <tr> <td style="text-decoration: line-through">UnitStatus</td> <td><span class="text-danger">Deprecated.</span> If listed here, the unit is inoperational or otherwise impaired.</td> </tr> <tr> <td>UnitType</td> <td>Type of unit. Will be <span class="text-info">ELEVATOR</span> or <span class="text-info">ESCALATOR</span>.</td> </tr> </tbody> </table>
get/ElevatorIncidents

Query parameters

StationCode'A03' | 'E09'

Two-letter station code. Use the Station List method to return a list of all station codes.

Response

Default response code.