TripPlannerResponse Data Type

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

Properties
name data type description
requestParameters map of string A dictionary of the parameters provided in the request that triggered this response.
debugOutput DebugOutput Debugging and profiling information
elevationMetadata ElevationMetadata
plan ApiTripPlan The actual trip plan.
previousPageCursor string Use the cursor to get the previous page of results. Insert the cursor into the request and post it to get the previous page.

The previous page is a set of itineraries departing BEFORE the first itinerary in the result for a depart after search. When using the default sort order the previous set of itineraries is inserted before the current result.

Note! The behavior is undefined if timetableView is off. This is possible to support, but require more information to be included in the cursor.

nextPageCursor string Use the cursor to get the next page of results. Insert the cursor into the request and post it to get the next page.

The next page is a set of itineraries departing AFTER the last itinerary in this result.

Note! The behavior is undefined if timetableView is off. This is possible to support, but require more information to be included in the cursor.

error PlannerError The error (if any) that this response raised.
metadata ApiTripSearchMetadata

Example

{
  "requestParameters" : {
    "property1" : "...",
    "property2" : "..."
  },
  "debugOutput" : {
    "precalculationTime" : 12345,
    "directStreetRouterTime" : 12345,
    "transitRouterTime" : 12345,
    "filteringTime" : 12345,
    "renderingTime" : 12345,
    "totalTime" : 12345,
    "transitRouterTimes" : {
      "tripPatternFilterTime" : 12345,
      "accessEgressTime" : 12345,
      "raptorSearchTime" : 12345,
      "itineraryCreationTime" : 12345
    }
  },
  "elevationMetadata" : {
    "ellipsoidToGeoidDifference" : 12345.0,
    "geoidElevation" : true
  },
  "plan" : {
    "date" : 12345,
    "from" : {
      "name" : "...",
      "stopId" : "...",
      "stopCode" : "...",
      "platformCode" : "...",
      "lon" : 12345.0,
      "lat" : 12345.0,
      "arrival" : 12345,
      "departure" : 12345,
      "zoneId" : "...",
      "stopIndex" : 12345,
      "stopSequence" : 12345,
      "vertexType" : "BIKESHARE",
      "bikeShareId" : "...",
      "vehicleParking" : { }
    },
    "to" : {
      "name" : "...",
      "stopId" : "...",
      "stopCode" : "...",
      "platformCode" : "...",
      "lon" : 12345.0,
      "lat" : 12345.0,
      "arrival" : 12345,
      "departure" : 12345,
      "zoneId" : "...",
      "stopIndex" : 12345,
      "stopSequence" : 12345,
      "vertexType" : "TRANSIT",
      "bikeShareId" : "...",
      "vehicleParking" : { }
    },
    "itineraries" : [ {
      "duration" : 12345,
      "startTime" : 12345,
      "endTime" : 12345,
      "walkTime" : 12345,
      "transitTime" : 12345,
      "waitingTime" : 12345,
      "walkDistance" : 12345.0,
      "walkLimitExceeded" : true,
      "generalizedCost" : 12345,
      "elevationLost" : 12345.0,
      "elevationGained" : 12345.0,
      "transfers" : 12345,
      "fare" : { },
      "legs" : [ { }, { } ],
      "systemNotices" : [ { }, { } ],
      "tooSloped" : true,
      "arrivedAtDestinationWithRentedBicycle" : true
    }, {
      "duration" : 12345,
      "startTime" : 12345,
      "endTime" : 12345,
      "walkTime" : 12345,
      "transitTime" : 12345,
      "waitingTime" : 12345,
      "walkDistance" : 12345.0,
      "walkLimitExceeded" : true,
      "generalizedCost" : 12345,
      "elevationLost" : 12345.0,
      "elevationGained" : 12345.0,
      "transfers" : 12345,
      "fare" : { },
      "legs" : [ { }, { } ],
      "systemNotices" : [ { }, { } ],
      "tooSloped" : true,
      "arrivedAtDestinationWithRentedBicycle" : true
    } ]
  },
  "previousPageCursor" : "...",
  "nextPageCursor" : "...",
  "error" : {
    "id" : 12345,
    "msg" : "...",
    "message" : "GRAPH_UNAVAILABLE",
    "missing" : [ "...", "..." ]
  },
  "metadata" : {
    "searchWindowUsed" : 12345
  }
}