Encoded Path


Short description


Detailed Consideration

Output path

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.

Input Waypoint

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.

Good to know


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.

Alternative routes can be returned with an encoded path.

The encoded path can be used in RouteRequest, ReachableAreasRequest, and ReachableLocationsRequest


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