elevator_incidents {metro}R Documentation

Elevator/Escalator Outages

Description

Elevator/Escalator Outages

Usage

elevator_incidents(StationCode = NULL, api_key = wmata_key())

Arguments

StationCode

Station code. Use rail_stations() to return a list of all station codes. Use NULL (default) to list all incidents.

api_key

Subscription key which provides access to this API. Defaults Sys.getenv("WMATA_KEY") via wmata_key().

Format

A data frame with 1 row per incident and 9 variables:

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).

UnitType

Type of unit. Will be ELEVATOR or ESCALATOR.

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).

LocationDescription

Free-text description of the unit location within a station (e.g.: Escalator between mezzanine and platform).

SymptomDescription

Description for why the unit is out of service or otherwise in reduced operation.

DateOutOfServ

Date and time (UTC) unit was reported out of service.

DateUpdated

Date and time (UTC) outage details was last updated.

EstimatedReturnToService

Estimated date and time (UTC) by when unit is expected to return to normal service. May be NULL.

Details

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.

Value

Data frame of reported elevator and escalator outages.

See Also

https://developer.wmata.com/docs/services/54763641281d83086473f232/operations/54763641281d830c946a3d76

Other Incident APIs: bus_incidents(), rail_incidents()

Examples

## Not run: 
elevator_incidents()

## End(Not run)

[Package metro version 0.9.3 Index]