api.md

Shared

Types:

• References
• ResponseWrapper

AgenciesWithCoverage

Types:

• AgenciesWithCoverageListResponse

Methods:

• client.agenciesWithCoverage.list() -> AgenciesWithCoverageListResponse

Agency

Types:

• AgencyRetrieveResponse

Methods:

• client.agency.retrieve(agencyId) -> AgencyRetrieveResponse

VehiclesForAgency

Types:

• VehiclesForAgencyListResponse

Methods:

• client.vehiclesForAgency.list(agencyId, { ...params }) -> VehiclesForAgencyListResponse

Config

Types:

• ConfigRetrieveResponse

Methods:

• client.config.retrieve() -> ConfigRetrieveResponse

CurrentTime

Types:

• CurrentTimeRetrieveResponse

Methods:

• client.currentTime.retrieve() -> CurrentTimeRetrieveResponse

StopsForLocation

Types:

• StopsForLocationListResponse

Methods:

• client.stopsForLocation.list({ ...params }) -> StopsForLocationListResponse

StopsForRoute

Types:

• StopsForRouteListResponse

Methods:

• client.stopsForRoute.list(routeId, { ...params }) -> StopsForRouteListResponse

StopsForAgency

Types:

• StopsForAgencyListResponse

Methods:

• client.stopsForAgency.list(agencyId) -> StopsForAgencyListResponse

Stop

Types:

• StopRetrieveResponse

Methods:

• client.stop.retrieve(stopId) -> StopRetrieveResponse

StopIDsForAgency

Types:

• StopIDsForAgencyListResponse

Methods:

• client.stopIdsForAgency.list(agencyId) -> StopIDsForAgencyListResponse

ScheduleForStop

Types:

• ScheduleForStopRetrieveResponse

Methods:

• client.scheduleForStop.retrieve(stopId, { ...params }) -> ScheduleForStopRetrieveResponse

Route

Types:

• RouteRetrieveResponse

Methods:

• client.route.retrieve(routeId) -> RouteRetrieveResponse

RouteIDsForAgency

Types:

• RouteIDsForAgencyListResponse

Methods:

• client.routeIdsForAgency.list(agencyId) -> RouteIDsForAgencyListResponse

RoutesForLocation

Types:

• RoutesForLocationListResponse

Methods:

• client.routesForLocation.list({ ...params }) -> RoutesForLocationListResponse

RoutesForAgency

Types:

• RoutesForAgencyListResponse

Methods:

• client.routesForAgency.list(agencyId) -> RoutesForAgencyListResponse

ScheduleForRoute

Types:

• ScheduleForRouteRetrieveResponse

Methods:

• client.scheduleForRoute.retrieve(routeId, { ...params }) -> ScheduleForRouteRetrieveResponse

ArrivalAndDeparture

Types:

• ArrivalAndDepartureRetrieveResponse
• ArrivalAndDepartureListResponse

Methods:

• client.arrivalAndDeparture.retrieve(stopId, { ...params }) -> ArrivalAndDepartureRetrieveResponse
• client.arrivalAndDeparture.list(stopId, { ...params }) -> ArrivalAndDepartureListResponse

Trip

Types:

• TripRetrieveResponse

Methods:

• client.trip.retrieve(tripId) -> TripRetrieveResponse

TripsForLocation

Types:

• TripsForLocationListResponse

Methods:

• client.tripsForLocation.list({ ...params }) -> TripsForLocationListResponse

TripDetails

Types:

• TripDetailRetrieveResponse

Methods:

• client.tripDetails.retrieve(tripId, { ...params }) -> TripDetailRetrieveResponse

TripForVehicle

Types:

• TripForVehicleRetrieveResponse

Methods:

• client.tripForVehicle.retrieve(vehicleId, { ...params }) -> TripForVehicleRetrieveResponse

TripsForRoute

Types:

• TripsForRouteListResponse

Methods:

• client.tripsForRoute.list(routeId, { ...params }) -> TripsForRouteListResponse

ReportProblemWithStop

Methods:

• client.reportProblemWithStop.retrieve(stopId, { ...params }) -> ResponseWrapper

ReportProblemWithTrip

Methods:

• client.reportProblemWithTrip.retrieve(tripId, { ...params }) -> ResponseWrapper

SearchForStop

Types:

• SearchForStopListResponse

Methods:

• client.searchForStop.list({ ...params }) -> SearchForStopListResponse

SearchForRoute

Types:

• SearchForRouteListResponse

Methods:

• client.searchForRoute.list({ ...params }) -> SearchForRouteListResponse

Block

Types:

• BlockRetrieveResponse

Methods:

• client.block.retrieve(blockId) -> BlockRetrieveResponse

Shape

Types:

• ShapeRetrieveResponse

Methods:

• client.shape.retrieve(shapeId) -> ShapeRetrieveResponse