An Itinerary is one complete way of getting from the start location to the end location.
| name | data type | type | namespace | min/max occurs | wrapped by | description |
|---|---|---|---|---|---|---|
| duration | long | element | 0/1 | Duration of the trip on this itinerary, in seconds. | ||
| elevationGained | double | element | 0/1 | How much elevation is gained, in total, over the course of the trip, in meters. See elevationLost. | ||
| elevationLost | double | element | 0/1 | How much elevation is lost, in total, over the course of the trip, in meters. As an example, a trip that went from the top of Mount Everest straight down to sea level, then back up K2, then back down again would have an elevationLost of Everest + K2. | ||
| endTime | dateTime | element | 0/1 | Time that the trip arrives. | ||
| fare | fare | element | 0/1 | The cost of this trip | ||
| leg | leg | element | 0/unbounded | legs | A list of Legs. Each Leg is either a walking (cycling, car) portion of the trip, or a transit trip on a particular vehicle. So a trip where the use walks to the Q train, transfers to the 6, then walks to their destination, has four legs. | |
| startTime | dateTime | element | 0/1 | Time that the trip departs. | ||
| tooSloped | boolean | element | 1/1 | This itinerary has a greater slope than the user requested (but there are no possible itineraries with a good slope). | ||
| transfers | int | element | 0/1 | The number of transfers this trip has. | ||
| transitTime | long | element | 1/1 | How much time is spent on transit, in seconds. | ||
| waitingTime | long | element | 1/1 | How much time is spent waiting for transit to arrive, in seconds. | ||
| walkDistance | double | element | 0/1 | How far the user has to walk, in meters. | ||
| walkLimitExceeded | boolean | element | 1/1 | Indicates that the walk limit distance has been exceeded for this itinerary when true. | ||
| walkTime | long | element | 1/1 | How much time is spent walking, in seconds. |
Example
<i----->
<duration>...</duration>
<startTime>...</startTime>
<endTime>...</endTime>
<walkTime>...</walkTime>
<transitTime>...</transitTime>
<waitingTime>...</waitingTime>
<walkDistance>...</walkDistance>
<walkLimitExceeded>...</walkLimitExceeded>
<elevationLost>...</elevationLost>
<elevationGained>...</elevationGained>
<transfers>...</transfers>
<fare>
<fare>...</fare>
</fare>
<legs>
<leg agencyId="..." agencyName="..." agencyTimeZoneOffset="..." agencyUrl="..." alightRule="..." boardRule="..." headsign="..." interlineWithPreviousLeg="..." mode="..." rentedBike="..." route="..." routeColor="..." routeLongName="..." routeShortName="..." routeTextColor="..." routeType="..." serviceDate="..." tripBlockId="..." tripShortName="...">
<startTime>...</startTime>
<endTime>...</endTime>
<departureDelay>...</departureDelay>
<arrivalDelay>...</arrivalDelay>
<realTime>...</realTime>
<isNonExactFrequency>...</isNonExactFrequency>
<headway>...</headway>
<distance>...</distance>
<pathway>...</pathway>
<routeId>
<agencyId>...</agencyId>
<id>...</id>
</routeId>
<tripId>
<agencyId>...</agencyId>
<id>...</id>
</tripId>
<from orig="..." stopIndex="..." stopSequence="..." vertexType="..." zoneId="...">
<name>...</name>
<stopId/>
<stopCode>...</stopCode>
<platformCode>...</platformCode>
<lon>...</lon>
<lat>...</lat>
<arrival>...</arrival>
<departure>...</departure>
<bikeShareId>...</bikeShareId>
</from>
<to orig="..." stopIndex="..." stopSequence="..." vertexType="..." zoneId="...">
<name>...</name>
<stopId/>
<stopCode>...</stopCode>
<platformCode>...</platformCode>
<lon>...</lon>
<lat>...</lat>
<arrival>...</arrival>
<departure>...</departure>
<bikeShareId>...</bikeShareId>
</to>
<intermediateStops>
<stop orig="..." stopIndex="..." stopSequence="..." vertexType="..." zoneId="...">
<name>...</name>
<stopId/>
<stopCode>...</stopCode>
<platformCode>...</platformCode>
<lon>...</lon>
<lat>...</lat>
<arrival>...</arrival>
<departure>...</departure>
<bikeShareId>...</bikeShareId>
</stop>
</intermediateStops>
<legGeometry>
<points>...</points>
<levels>...</levels>
<length>...</length>
</legGeometry>
<steps>
<walkSteps>
<distance>...</distance>
<relativeDirection>...</relativeDirection>
<streetName>...</streetName>
<absoluteDirection>...</absoluteDirection>
<exit>...</exit>
<stayOn>...</stayOn>
<area>...</area>
<bogusName>...</bogusName>
<lon>...</lon>
<lat>...</lat>
<alerts/>
<elevation>...</elevation>
</walkSteps>
</steps>
<alerts alertDescriptionText="..." alertHeaderText="..." alertUrl="...">
<effectiveStartDate>...</effectiveStartDate>
</alerts>
<duration>...</duration>
</leg>
</legs>
<tooSloped>...</tooSloped>
</i----->