Itinerary Object
Fields
#
accessibilityScore
Computes a numeric accessibility score between 0 and 1.
The closer the value is to 1 the better the wheelchair-accessibility of this itinerary is.
A value of null
means that no score has been computed, not that the leg is inaccessible.
More information is available in the feature documentation .
arrivedAtDestinationWithRentedBicycle
Does the itinerary end without dropping off the rented bicycle:
elevationGained
How much elevation is gained, in total, over the course of the itinerary, in meters.
elevationLost
How much elevation is lost, in total, over the course of the itinerary, in meters.
endTime
Time when the user arrives to the destination. Format: Unix timestamp in milliseconds.
fares
Information about the fares for this itinerary. This is primarily a GTFS Fares V1 interface
and always returns an empty list. Use the leg's fareProducts
instead.
legs
A list of Legs. Each Leg is either a walking (cycling, car) portion of the itinerary, or a transit leg on a particular vehicle. So a itinerary where the user walks to the Q train, transfers to the 6, then walks to their destination, has four legs.
numberOfTransfers
How many transfers are part of this itinerary.
Notes:
- Interlined/stay-seated transfers do not increase this count.
- Transferring from a flex to a fixed schedule trip and vice versa increases this count.
startTime
Time when the user leaves from the origin. Format: Unix timestamp in milliseconds.
systemNotices
A list of system notices. Contains debug information for itineraries. One use-case is to run a routing search with 'debugItineraryFilter: true'. This will then tag itineraries instead of removing them from the result. This make it possible to inspect the itinerary-filter-chain.
Usages
#
References
#
- Field itineraries from Plan
- Field node from PlanEdge
Int