itinerary Data Type

An Itinerary is one complete way of getting from the start location to the end location.

Namespace
(Default)
Properties
name data type type namespace min/max occurs 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
legs list of leg element 0/unbounded 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>
    <details>...</details>
  </fare>
  <legs>
    <startTime>...</startTime>
    <endTime>...</endTime>
    <departureDelay>...</departureDelay>
    <arrivalDelay>...</arrivalDelay>
    <realTime>...</realTime>
    <isNonExactFrequency>...</isNonExactFrequency>
    <headway>...</headway>
    <distance>...</distance>
    <pathway>...</pathway>
    <mode>...</mode>
    <route>...</route>
    <agencyName>...</agencyName>
    <agencyUrl>...</agencyUrl>
    <agencyBrandingUrl>...</agencyBrandingUrl>
    <agencyTimeZoneOffset>...</agencyTimeZoneOffset>
    <routeColor>...</routeColor>
    <routeType>...</routeType>
    <routeId>
      <agencyId>...</agencyId>
      <id>...</id>
    </routeId>
    <routeTextColor>...</routeTextColor>
    <interlineWithPreviousLeg>...</interlineWithPreviousLeg>
    <tripShortName>...</tripShortName>
    <tripBlockId>...</tripBlockId>
    <headsign>...</headsign>
    <agencyId>...</agencyId>
    <tripId>
      <agencyId>...</agencyId>
      <id>...</id>
    </tripId>
    <serviceDate>...</serviceDate>
    <routeBrandingUrl>...</routeBrandingUrl>
    <from>
      <name>...</name>
      <stopId/>
      <stopCode>...</stopCode>
      <platformCode>...</platformCode>
      <lon>...</lon>
      <lat>...</lat>
      <arrival>...</arrival>
      <departure>...</departure>
      <orig>...</orig>
      <zoneId>...</zoneId>
      <stopIndex>...</stopIndex>
      <stopSequence>...</stopSequence>
      <vertexType>...</vertexType>
      <bikeShareId>...</bikeShareId>
      <boardAlightType>...</boardAlightType>
      <flagStopArea/>
    </from>
    <to>
      <name>...</name>
      <stopId/>
      <stopCode>...</stopCode>
      <platformCode>...</platformCode>
      <lon>...</lon>
      <lat>...</lat>
      <arrival>...</arrival>
      <departure>...</departure>
      <orig>...</orig>
      <zoneId>...</zoneId>
      <stopIndex>...</stopIndex>
      <stopSequence>...</stopSequence>
      <vertexType>...</vertexType>
      <bikeShareId>...</bikeShareId>
      <boardAlightType>...</boardAlightType>
      <flagStopArea/>
    </to>
    <stop>
      <name>...</name>
      <stopId/>
      <stopCode>...</stopCode>
      <platformCode>...</platformCode>
      <lon>...</lon>
      <lat>...</lat>
      <arrival>...</arrival>
      <departure>...</departure>
      <orig>...</orig>
      <zoneId>...</zoneId>
      <stopIndex>...</stopIndex>
      <stopSequence>...</stopSequence>
      <vertexType>...</vertexType>
      <bikeShareId>...</bikeShareId>
      <boardAlightType>...</boardAlightType>
      <flagStopArea/>
    </stop>
    <legGeometry>
      <points>...</points>
      <levels>...</levels>
      <length>...</length>
    </legGeometry>
    <walkSteps>
      <distance>...</distance>
      <relativeDirection>...</relativeDirection>
      <streetName>...</streetName>
      <absoluteDirection>...</absoluteDirection>
      <exit>...</exit>
      <stayOn>...</stayOn>
      <area>...</area>
      <bogusName>...</bogusName>
      <lon>...</lon>
      <lat>...</lat>
      <elevation/>
      <alerts/>
    </walkSteps>
    <alerts>
      <alert/>
    </alerts>
    <routeShortName>...</routeShortName>
    <routeLongName>...</routeLongName>
    <boardRule>...</boardRule>
    <alightRule>...</alightRule>
    <rentedBike>...</rentedBike>
    <callAndRide>...</callAndRide>
    <flexCallAndRideMaxStartTime>...</flexCallAndRideMaxStartTime>
    <flexCallAndRideMinEndTime>...</flexCallAndRideMinEndTime>
    <flexDrtAdvanceBookMin>...</flexDrtAdvanceBookMin>
    <flexDrtPickupMessage>...</flexDrtPickupMessage>
    <flexDrtDropOffMessage>...</flexDrtDropOffMessage>
    <flexFlagStopPickupMessage>...</flexFlagStopPickupMessage>
    <flexFlagStopDropOffMessage>...</flexFlagStopDropOffMessage>
  </legs>
  <tooSloped>...</tooSloped>
</i----->