The encodedPath is an object which describes a complete routeA route corresponds to a path of a vehicle through the underlying transport network. The main attributes of a route are the distance and the time that the vehicle travels along the path. path.
The encoded path as part of the PathWaypoint is used to recalculate a predefined route, considering another vehicleThe term vehicle describes what is being routed or planned for. Vehicles are used in route calculation, distance matrix calculation and effectively also in tour planning. In route calculation, vehicle properties like overall size, weight and speed are in focus. In tour planning, it is vehicle properties like capacity and availability. Commonly a vehicle is motorized, like a truck - including its trailer or a car. However also a bike or even a pedestrian are included in this definition. profileA profile is a collection of parameters used to configure the request. Full profiles consist of a number of specialized sub-profiles like the VehicleProfile which describes the properties of a vehicle. and/or other parameters in the request.
The PTV xRoute service returns the resulting path of a route calculation in an encoded path. Then it can be used in another request using a path waypoint.
This object is encoded and can only be handled by PTV xServers.
The PTV xRoute service is able to calculate a route from a path waypoint.
In this case, the route is recalculated along the path, taking into account the request parameters and the new vehicle profile. The result contains the same path, but with updated information (travel time, cost,...)
It is also possible to recalculate a route, using a path waypoint, in order to retrieve some information that were not retrieved with the previous request, for example: the emissions, the toll costs, the directions.
It is guaranteed that the route response for the route with the PathWaypoint is equal to the original response when the request parameters and profile are the same.
Currently the encoded path concept is restricted:
Do not to store the string representing the encoded path in a database to avoid compatibility problems with the next xServer and map versions. Always use the returned encoded path immediately in a new request.
|Showcase||Calculate and Visualize Time Dependent Route Metrics|
|Showcase||Calculating alternative routes|
|Showcase||Calculating reachable area|
|Showcase||Calculating reachable locations|
|Integration Sample||Calculating time dependent route metrics|
|Integration Sample||Calculating alternative routes|
|Technical concept||Route Locations, Waypoints and Route Legs|