response Data Type

Represents a trip planner response, will be serialized into XML or JSON by Jersey

Namespace
(Default)
Properties
name data type type namespace min/max occurs description
debugOutput debugOutput element 0/1 Debugging and profiling information
error plannerError element 0/1 The error (if any) that this response raised.
plan tripPlan element 0/1 The actual trip plan.
requestParameters (custom) element 0/1 A dictionary of the parameters provided in the request that triggered this response.

Example

<response>
  <requestParameters>...</requestParameters>
  <debugOutput>
    <precalculationTime>...</precalculationTime>
    <pathCalculationTime>...</pathCalculationTime>
    <pathTimes>...</pathTimes>
    <renderingTime>...</renderingTime>
    <totalTime>...</totalTime>
    <timedOut>...</timedOut>
  </debugOutput>
  <plan>
    <date>...</date>
    <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>
    <itineraries>
      <itinerary>
        <duration>...</duration>
        <startTime>...</startTime>
        <endTime>...</endTime>
        <walkTime>...</walkTime>
        <transitTime>...</transitTime>
        <waitingTime>...</waitingTime>
        <walkDistance>...</walkDistance>
        <walkLimitExceeded>...</walkLimitExceeded>
        <elevationLost>...</elevationLost>
        <elevationGained>...</elevationGained>
        <transfers>...</transfers>
        <fare/>
        <legs>
          <leg/>
        </legs>
        <tooSloped>...</tooSloped>
      </itinerary>
    </itineraries>
  </plan>
  <error>
    <id>...</id>
    <msg>...</msg>
    <message>...</message>
    <missing>...</missing>
    <noPath>...</noPath>
  </error>
</response>