README
@datafire/wmata_incidents
Client library for Incidents
Installation and Usage
npm install --save @datafire/wmata_incidents
let wmata_incidents = require('@datafire/wmata_incidents').create({
apiKeyHeader: "",
apiKeyQuery: ""
});
.then(data => {
console.log(data);
});
Description
Rail, bus, and elevator disruptions/outages.
Actions
54763641281d830c946a3d78
Description
Returns a set of reported bus incidents/delays for a given Route. Omit the Route to return all reported items.
Note that the Route parameter accepts only base route names and no variations, i.e.: use 10A instead of 10Av1 and 10Av2.
Bus incidents/delays are refreshed once every 20 to 30 seconds approximately.
Response Elements
| Element | Description |
|---|---|
| BusIncidents | Array containing bus incident information (BusIncident). |
| DateUpdated | Date and time (Eastern Standard Time) of last update. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-28T08:13:03). |
| Description | Free-text description of the delay or incident. |
| IncidentID | Unique identifier for an incident. |
| IncidentType | Free-text description of the incident type. Usually Delay or Alert but is subject to change at any time. |
| RoutesAffected | Array containing routes affected. Routes listed are usually identical to base route names (i.e.: not 10Av1 or 10Av2, but 10A), but may differ from what our bus methods return. |
wmata_incidents.54763641281d830c946a3d78({}, context)
Input
- input
object- Route
string(values: 90, X1): Bus route. Use full route code, i.e.: C2 instead of C2v1, C2v2, etc.
- Route
Output
Output schema unknown
54763641281d830c946a3d79
Description
Returns a list of reported elevator and escalator outages at a given station. Omit the StationCode parameter to return all reported outages.
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.
Elevator and escalator outages are refreshed once every 20 to 30 seconds approximately.
Response Elements
| Element | Description |
|---|---|
| ElevatorIncidents | Array containing elevator/escalator outage information (ElevatorIncident). |
| DateOutOfServ | 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). |
| DateUpdated | 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). |
| DisplayOrder | Deprecated. |
| EstimatedReturnToService | 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). |
| LocationDescription | Free-text description of the unit location within a station (e.g.: Escalator between mezzanine and platform). |
| StationCode | Unit's station code. Use this value in other rail-related APIs to retrieve data about a station. |
| StationName | Full station name, may include entrance information (e.g.: Metro Center, G and 11th St Entrance). |
| SymptomCode | Deprecated. |
| SymptomDescription | Description for why the unit is out of service or otherwise in reduced operation. |
| TimeOutOfService | Deprecated. Use the time portion of the DateOutOfServ element. |
| UnitName | 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). |
| UnitStatus | Deprecated. If listed here, the unit is inoperational or otherwise impaired. |
| UnitType | Type of unit. Will be ELEVATOR or ESCALATOR. |
wmata_incidents.54763641281d830c946a3d79({}, context)
Input
- input
object- StationCode
string(values: A03, E09): Two-letter station code. Use the Station List method to return a list of all station codes.
- StationCode
Output
Output schema unknown
54763641281d830c946a3d7a
Description
Returns reported rail incidents (significant disruptions and delays to normal service). The data is identical to WMATA's Metrorail Service Status feed.
Rail incidents are refreshed once every 20 to 30 seconds approximately.
Response Elements
| Element | Description |
|---|---|
| Incidents | Array containing rail disruption information (Incident). |
| DateUpdated | Date and time (Eastern Standard Time) of last update. Will be in YYYY-MM-DDTHH:mm:SS format (e.g.: 2010-07-29T14:21:28). |
| DelaySeverity | Deprecated. |
| Description | Free-text description of the incident. |
| EmergencyText | Deprecated. |
| EndLocationFullName | Deprecated. |
| IncidentID | Unique identifier for an incident. |
| IncidentType | Free-text description of the incident type. Usually Delay or Alert but is subject to change at any time. |
| LinesAffected | Semi-colon and space separated list of line codes (e.g.:
RD; or BL;
OR; or BL; OR; RD;). We do
plan to update this to return something more reasonable like an
array, but until then, use code similar to the following:"RD; GR; BL;".split(/;[\s]?/).filter(function(fn) { return fn
!== ''; }) |
| PassengerDelay | Deprecated. |
| StartLocationFullName | Deprecated. |
wmata_incidents.54763641281d830c946a3d7a(null, context)
Input
This action has no parameters
Output
Output schema unknown
54763641281d830c946a3d75
Description
Returns a set of reported bus incidents/delays for a given Route. Omit the Route to return all reported items.
Note that the Route parameter accepts only base route names and no variations, i.e.: use 10A instead of 10Av1 and 10Av2.
Bus incidents/delays are refreshed once every 20 to 30 seconds approximately.
Response Elements
| Element | Description |
|---|---|
| BusIncidents | Array containing bus incident information (BusIncident). |
| DateUpdated | Date and time (Eastern Standard Time) of last update. Will be in YYYY-MM-DDTHH:mm:ss format (e.g.: 2014-10-28T08:13:03). |
| Description | Free-text description of the delay or incident. |
| IncidentID | Unique identifier for an incident. |
| IncidentType | Free-text description of the incident type. Usually Delay or Alert but is subject to change at any time. |
| RoutesAffected | Array containing routes affected. Routes listed are usually identical to base route names (i.e.: not 10Av1 or 10Av2, but 10A), but may differ from what our bus methods return. |
wmata_incidents.54763641281d830c946a3d75({}, context)
Input
- input
object- Route
string(values: 90, X1): Base bus route; variations are not recognized (i.e.: C2 instead of C2v1, C2v2, etc.).
- Route
Output
Output schema unknown
54763641281d830c946a3d76
Description
Returns a list of reported elevator and escalator outages at a given station. Omit the StationCode parameter to return all reported outages.
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.
Elevator and escalator outages are refreshed once every 20 to 30 seconds approximately.
Response Elements
| Element | Description |
|---|---|
| ElevatorIncidents | Array containing elevator/escalator outage information (ElevatorIncident). |
| DateOutOfServ | 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). |
| DateUpdated | 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). |
| DisplayOrder | Deprecated. |
| EstimatedReturnToService | 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). |
| LocationDescription | Free-text description of the unit location within a station (e.g.: Escalator between mezzanine and platform). |
| StationCode | Unit's station code. Use this value in other rail-related APIs to retrieve data about a station. |
| StationName | Full station name, may include entrance information (e.g.: Metro Center, G and 11th St Entrance). |
| SymptomCode | Deprecated. |
| SymptomDescription | Description for why the unit is out of service or otherwise in reduced operation. |
| TimeOutOfService | Deprecated. Use the time portion of the DateOutOfServ element. |
| UnitName | 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). |
| UnitStatus | Deprecated. If listed here, the unit is inoperational or otherwise impaired. |
| UnitType | Type of unit. Will be ELEVATOR or ESCALATOR. |
wmata_incidents.54763641281d830c946a3d76({}, context)
Input
- input
object- StationCode
string(values: A03, E09): Station code. Use the Station List method to return a list of all station codes.
- StationCode
Output
Output schema unknown
54763641281d830c946a3d77
Description
Returns reported rail incidents (significant disruptions and delays to normal service). The data is identical to WMATA's Metrorail Service Status feed.
Rail incidents are refreshed once every 20 to 30 seconds approximately.
Response Elements
| Element | Description |
|---|---|
| Incidents | Array containing rail disruption information (Incident). |
| DateUpdated | Date and time (Eastern Standard Time) of last update. Will be in YYYY-MM-DDTHH:mm:SS format (e.g.: 2010-07-29T14:21:28). |
| DelaySeverity | Deprecated. |
| Description | Free-text description of the incident. |
| EmergencyText | Deprecated. |
| EndLocationFullName | Deprecated. |
| IncidentID | Unique identifier for an incident. |
| IncidentType | Free-text description of the incident type. Usually Delay or Alert but is subject to change at any time. |
| LinesAffected | Semi-colon and space separated list of line codes (e.g.:
RD; or BL;
OR; or BL; OR; RD;). We do
plan to update this to return something more reasonable like an
array, but until then, use code similar to the following:"RD; GR; BL;".split(/;[\s]?/).filter(function(fn) { return fn
!== ''; }) |
| PassengerDelay | Deprecated. |
| StartLocationFullName | Deprecated. |
wmata_incidents.54763641281d830c946a3d77(null, context)
Input
This action has no parameters
Output
Output schema unknown
Definitions
This integration has no definitions