A route handle encodes a path from a previously calculated route. It can be used to compactly cache a route for a brief amount of time. Thus, it can be used to retrieve more data along the route and get updated traffic information.
However, it does not store the route data itself, meaning that it can not be used to retrieve exactly the same traffic data.
For sample requests of the route handle API, see these tutorials:
For code samples that demonstrate how to use the
origin parameter to get an updated route and route handle, see these tutorials:
A route handle encodes a path tightly coupled to the underlying map data. There are roughly three scenarios that can invalidate an existing handle:
Note that regardless of the frequency of these changes invalidating some or all route handles, a user should always be prepared to handle failures. A simple procedure to handle these failures would be to recalculate the route to retrieve a new (valid) route handle.
Parameters used to calculate the route are not encoded in the route handle, so they should be specified again when recreating a route using
For example, the
transportMode parameter does not have to match the transport mode previously used for route calculation. However, when using a different transport mode, the request may fail, e.g. when the route has road segments forbidden for the provided transport mode.
The route handle endpoint supports all electric vehicle (EV) parameters that are used to calculate the route with the exception of the following: