| name | data type | constraints | description |
|---|---|---|---|
| weight | number | required | |
| backEdge | Edge | ||
| stateData | StateData | ||
| walkDistance | number | required | |
| carPickupState | CarPickupState | ||
| timeSeconds | number | required | Returns time in seconds since epoch |
| elapsedTimeSeconds | number | required | returns the length of the trip in seconds up to this state |
| rentingVehicleFromStation | boolean | required | |
| rentingFloatingVehicle | boolean | required | |
| rentingVehicle | boolean | required | |
| vehicleRentalState | VehicleRentalState | ||
| vehicleParked | boolean | required | |
| final | boolean | required | True if the state at vertex can be the end of path. |
| vertex | Vertex | ||
| timeDeltaSeconds | number | required | |
| weightDelta | number | required | |
| backState | State | ||
| backMode | TraverseMode | ||
| backWalkingBike | boolean | required | |
| nextResult | State | Optional next result that allows Edge to return multiple results. | |
| request | AStarRequest | ||
| preferences | RoutingPreferences | ||
| nonTransitMode | TraverseMode | This method is on State rather than RouteRequest because we care whether the user is in possession of a rented bike. | |
| time | number | ||
| vehicleRentalNetwork | string |
Example
{
"weight" : 12345.0,
"backEdge" : {
"fromVertex" : {
"outgoing" : [ { }, { } ],
"incoming" : [ { }, { } ],
"degreeOut" : 12345,
"degreeIn" : 12345,
"x" : 12345.0,
"y" : 12345.0,
"lon" : 12345.0,
"lat" : 12345.0,
"name" : { },
"defaultName" : "...",
"stationElement" : { },
"label" : "...",
"coordinate" : { },
"incomingStreetEdges" : [ { }, { } ],
"outgoingStreetEdges" : [ { }, { } ]
},
"toVertex" : {
"outgoing" : [ { }, { } ],
"incoming" : [ { }, { } ],
"degreeOut" : 12345,
"degreeIn" : 12345,
"x" : 12345.0,
"y" : 12345.0,
"lon" : 12345.0,
"lat" : 12345.0,
"name" : { },
"defaultName" : "...",
"stationElement" : { },
"label" : "...",
"coordinate" : { },
"incomingStreetEdges" : [ { }, { } ],
"outgoingStreetEdges" : [ { }, { } ]
},
"roundabout" : true,
"defaultName" : "...",
"name" : { },
"geometry" : {
"coordinate" : { },
"boundary" : { },
"empty" : true,
"boundaryDimension" : 12345,
"coordinateSequence" : { },
"coordinates" : [ { }, { } ],
"ring" : true,
"length" : 12345.0,
"numPoints" : 12345,
"closed" : true,
"startPoint" : { },
"endPoint" : { },
"geometryType" : "...",
"dimension" : 12345,
"envelope" : { },
"rectangle" : true,
"centroid" : { },
"simple" : true,
"interiorPoint" : { },
"factory" : { },
"valid" : true,
"precisionModel" : { },
"envelopeInternal" : { },
"area" : 12345.0,
"userData" : { },
"numGeometries" : 12345,
"SRID" : 12345
},
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"distanceIndependentTime" : 12345
},
"stateData" : {
"vehicleRentalNetwork" : "...",
"rentalVehicleFormFactor" : "OTHER"
},
"walkDistance" : 12345.0,
"carPickupState" : "IN_CAR",
"timeSeconds" : 12345,
"elapsedTimeSeconds" : 12345,
"rentingVehicleFromStation" : true,
"rentingFloatingVehicle" : true,
"rentingVehicle" : true,
"vehicleRentalState" : "RENTING_FLOATING",
"vehicleParked" : true,
"final" : true,
"vertex" : {
"outgoing" : [ {
"fromVertex" : { },
"toVertex" : { },
"roundabout" : true,
"defaultName" : "...",
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"distanceIndependentTime" : 12345
}, {
"fromVertex" : { },
"toVertex" : { },
"roundabout" : true,
"defaultName" : "...",
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"distanceIndependentTime" : 12345
} ],
"incoming" : [ {
"fromVertex" : { },
"toVertex" : { },
"roundabout" : true,
"defaultName" : "...",
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"distanceIndependentTime" : 12345
}, {
"fromVertex" : { },
"toVertex" : { },
"roundabout" : true,
"defaultName" : "...",
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"distanceIndependentTime" : 12345
} ],
"degreeOut" : 12345,
"degreeIn" : 12345,
"x" : 12345.0,
"y" : 12345.0,
"lon" : 12345.0,
"lat" : 12345.0,
"name" : { },
"defaultName" : "...",
"stationElement" : {
"name" : { },
"code" : "...",
"description" : { },
"coordinate" : { },
"wheelchairAccessibility" : "POSSIBLE",
"levelName" : "...",
"levelIndex" : 12345.0,
"parentStation" : { },
"partOfStation" : true,
"id" : { }
},
"label" : "...",
"coordinate" : {
"y" : 12345.0,
"z" : 12345.0,
"x" : 12345.0,
"m" : 12345.0,
"valid" : true
},
"incomingStreetEdges" : [ {
"elevationProfile" : { },
"elevationFlattened" : true,
"maxSlope" : 12345.0,
"effectiveBikeDistance" : 12345.0,
"effectiveBikeDistanceForWorkCost" : 12345.0,
"bicycleSafetyFactor" : 12345.0,
"effectiveBicycleSafetyDistance" : 12345.0,
"walkSafetyFactor" : 12345.0,
"effectiveWalkSafetyDistance" : 12345.0,
"roundabout" : true,
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"wheelchairAccessible" : true,
"permission" : "BICYCLE",
"back" : true,
"walkNoThruTraffic" : true,
"motorVehicleNoThruTraffic" : true,
"bicycleNoThruTraffic" : true,
"stairs" : true,
"link" : true,
"carSpeed" : 12345.0,
"slopeOverride" : true,
"inAngle" : 12345,
"outAngle" : 12345,
"turnRestrictions" : [ { }, { } ],
"fromVertex" : { },
"toVertex" : { },
"defaultName" : "...",
"distanceIndependentTime" : 12345
}, {
"elevationProfile" : { },
"elevationFlattened" : true,
"maxSlope" : 12345.0,
"effectiveBikeDistance" : 12345.0,
"effectiveBikeDistanceForWorkCost" : 12345.0,
"bicycleSafetyFactor" : 12345.0,
"effectiveBicycleSafetyDistance" : 12345.0,
"walkSafetyFactor" : 12345.0,
"effectiveWalkSafetyDistance" : 12345.0,
"roundabout" : true,
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"wheelchairAccessible" : true,
"permission" : "PEDESTRIAN_AND_CAR",
"back" : true,
"walkNoThruTraffic" : true,
"motorVehicleNoThruTraffic" : true,
"bicycleNoThruTraffic" : true,
"stairs" : true,
"link" : true,
"carSpeed" : 12345.0,
"slopeOverride" : true,
"inAngle" : 12345,
"outAngle" : 12345,
"turnRestrictions" : [ { }, { } ],
"fromVertex" : { },
"toVertex" : { },
"defaultName" : "...",
"distanceIndependentTime" : 12345
} ],
"outgoingStreetEdges" : [ {
"elevationProfile" : { },
"elevationFlattened" : true,
"maxSlope" : 12345.0,
"effectiveBikeDistance" : 12345.0,
"effectiveBikeDistanceForWorkCost" : 12345.0,
"bicycleSafetyFactor" : 12345.0,
"effectiveBicycleSafetyDistance" : 12345.0,
"walkSafetyFactor" : 12345.0,
"effectiveWalkSafetyDistance" : 12345.0,
"roundabout" : true,
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"wheelchairAccessible" : true,
"permission" : "PEDESTRIAN_AND_BICYCLE",
"back" : true,
"walkNoThruTraffic" : true,
"motorVehicleNoThruTraffic" : true,
"bicycleNoThruTraffic" : true,
"stairs" : true,
"link" : true,
"carSpeed" : 12345.0,
"slopeOverride" : true,
"inAngle" : 12345,
"outAngle" : 12345,
"turnRestrictions" : [ { }, { } ],
"fromVertex" : { },
"toVertex" : { },
"defaultName" : "...",
"distanceIndependentTime" : 12345
}, {
"elevationProfile" : { },
"elevationFlattened" : true,
"maxSlope" : 12345.0,
"effectiveBikeDistance" : 12345.0,
"effectiveBikeDistanceForWorkCost" : 12345.0,
"bicycleSafetyFactor" : 12345.0,
"effectiveBicycleSafetyDistance" : 12345.0,
"walkSafetyFactor" : 12345.0,
"effectiveWalkSafetyDistance" : 12345.0,
"roundabout" : true,
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"wheelchairAccessible" : true,
"permission" : "BICYCLE",
"back" : true,
"walkNoThruTraffic" : true,
"motorVehicleNoThruTraffic" : true,
"bicycleNoThruTraffic" : true,
"stairs" : true,
"link" : true,
"carSpeed" : 12345.0,
"slopeOverride" : true,
"inAngle" : 12345,
"outAngle" : 12345,
"turnRestrictions" : [ { }, { } ],
"fromVertex" : { },
"toVertex" : { },
"defaultName" : "...",
"distanceIndependentTime" : 12345
} ]
},
"timeDeltaSeconds" : 12345,
"weightDelta" : 12345.0,
"backState" : {
"weight" : 12345.0,
"backEdge" : {
"fromVertex" : { },
"toVertex" : { },
"roundabout" : true,
"defaultName" : "...",
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"distanceIndependentTime" : 12345
},
"stateData" : {
"vehicleRentalNetwork" : "...",
"rentalVehicleFormFactor" : "MOPED"
},
"walkDistance" : 12345.0,
"carPickupState" : "WALK_TO_PICKUP",
"timeSeconds" : 12345,
"elapsedTimeSeconds" : 12345,
"rentingVehicleFromStation" : true,
"rentingFloatingVehicle" : true,
"rentingVehicle" : true,
"vehicleRentalState" : "BEFORE_RENTING",
"vehicleParked" : true,
"final" : true,
"vertex" : {
"outgoing" : [ { }, { } ],
"incoming" : [ { }, { } ],
"degreeOut" : 12345,
"degreeIn" : 12345,
"x" : 12345.0,
"y" : 12345.0,
"lon" : 12345.0,
"lat" : 12345.0,
"name" : { },
"defaultName" : "...",
"stationElement" : { },
"label" : "...",
"coordinate" : { },
"incomingStreetEdges" : [ { }, { } ],
"outgoingStreetEdges" : [ { }, { } ]
},
"timeDeltaSeconds" : 12345,
"weightDelta" : 12345.0,
"backState" : { },
"backMode" : "BICYCLE",
"backWalkingBike" : true,
"nextResult" : { },
"request" : { },
"preferences" : { },
"nonTransitMode" : "FLEX",
"time" : 12345,
"vehicleRentalNetwork" : "..."
},
"backMode" : "CAR",
"backWalkingBike" : true,
"nextResult" : {
"weight" : 12345.0,
"backEdge" : {
"fromVertex" : { },
"toVertex" : { },
"roundabout" : true,
"defaultName" : "...",
"name" : { },
"geometry" : { },
"distanceMeters" : 12345.0,
"effectiveWalkDistance" : 12345.0,
"distanceIndependentTime" : 12345
},
"stateData" : {
"vehicleRentalNetwork" : "...",
"rentalVehicleFormFactor" : "BICYCLE"
},
"walkDistance" : 12345.0,
"carPickupState" : "IN_CAR",
"timeSeconds" : 12345,
"elapsedTimeSeconds" : 12345,
"rentingVehicleFromStation" : true,
"rentingFloatingVehicle" : true,
"rentingVehicle" : true,
"vehicleRentalState" : "RENTING_FROM_STATION",
"vehicleParked" : true,
"final" : true,
"vertex" : {
"outgoing" : [ { }, { } ],
"incoming" : [ { }, { } ],
"degreeOut" : 12345,
"degreeIn" : 12345,
"x" : 12345.0,
"y" : 12345.0,
"lon" : 12345.0,
"lat" : 12345.0,
"name" : { },
"defaultName" : "...",
"stationElement" : { },
"label" : "...",
"coordinate" : { },
"incomingStreetEdges" : [ { }, { } ],
"outgoingStreetEdges" : [ { }, { } ]
},
"timeDeltaSeconds" : 12345,
"weightDelta" : 12345.0,
"backState" : { },
"backMode" : "CAR",
"backWalkingBike" : true,
"nextResult" : { },
"request" : { },
"preferences" : { },
"nonTransitMode" : "CAR",
"time" : 12345,
"vehicleRentalNetwork" : "..."
},
"request" : { },
"preferences" : { },
"nonTransitMode" : "WALK",
"time" : 12345,
"vehicleRentalNetwork" : "..."
}