Response Data Type

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

Properties
name data type description
requestParameters object A dictionary of the parameters provided in the request that triggered this response.
debugOutput DebugOutput Debugging and profiling information
elevationMetadata ElevationMetadata
plan TripPlan The actual trip plan.
error PlannerError The error (if any) that this response raised.

Example

{
  "requestParameters" : {
    "property1" : "...",
    "property2" : "..."
  },
  "debugOutput" : {
    "precalculationTime" : 12345,
    "pathCalculationTime" : 12345,
    "pathTimes" : [ 12345, 12345 ],
    "renderingTime" : 12345,
    "totalTime" : 12345,
    "timedOut" : true
  },
  "elevationMetadata" : {
    "ellipsoidToGeoidDifference" : 12345.0,
    "geoidElevation" : true
  },
  "plan" : {
    "date" : 12345,
    "from" : {
      "name" : "...",
      "stopId" : { },
      "stopCode" : "...",
      "platformCode" : "...",
      "lon" : 12345.0,
      "lat" : 12345.0,
      "arrival" : 12345,
      "departure" : 12345,
      "orig" : "...",
      "zoneId" : "...",
      "stopIndex" : 12345,
      "stopSequence" : 12345,
      "vertexType" : "BIKESHARE",
      "bikeShareId" : "..."
    },
    "to" : {
      "name" : "...",
      "stopId" : { },
      "stopCode" : "...",
      "platformCode" : "...",
      "lon" : 12345.0,
      "lat" : 12345.0,
      "arrival" : 12345,
      "departure" : 12345,
      "orig" : "...",
      "zoneId" : "...",
      "stopIndex" : 12345,
      "stopSequence" : 12345,
      "vertexType" : "BIKEPARK",
      "bikeShareId" : "..."
    },
    "itineraries" : [ {
      "duration" : 12345,
      "startTime" : 12345,
      "endTime" : 12345,
      "walkTime" : 12345,
      "transitTime" : 12345,
      "waitingTime" : 12345,
      "walkDistance" : 12345.0,
      "walkLimitExceeded" : true,
      "elevationLost" : 12345.0,
      "elevationGained" : 12345.0,
      "transfers" : 12345,
      "fare" : { },
      "leg" : [ { }, { } ],
      "tooSloped" : true
    }, {
      "duration" : 12345,
      "startTime" : 12345,
      "endTime" : 12345,
      "walkTime" : 12345,
      "transitTime" : 12345,
      "waitingTime" : 12345,
      "walkDistance" : 12345.0,
      "walkLimitExceeded" : true,
      "elevationLost" : 12345.0,
      "elevationGained" : 12345.0,
      "transfers" : 12345,
      "fare" : { },
      "leg" : [ { }, { } ],
      "tooSloped" : true
    } ]
  },
  "error" : {
    "id" : 12345,
    "msg" : "...",
    "message" : "NO_TRANSIT_TIMES",
    "missing" : [ "...", "..." ],
    "noPath" : true
  }
}