Start a new navigation session
After creating a new route and obtaining your route
id, you can use the
startNavigation mutation to start a new navigation session. A navigation session is automatically finished after 48 hours of inactivity. During that time frame you can subscribe to it for updates or query its current state.
To start a navigation session, you need a route
alternative_id and your
current_location. Of these three arguments
alternative_id is optional. In case no alternative was chosen explicitly the first route is used for the navigation session. In order to start a navigation session you need to be in proximity of the route.
Navigation start input
If successful, the HTTP status code in the response header is 200 and the response body contains the attributes you requested.
If unsuccessful, the header status code is an error code and the response body contains an error response object. The error response object can be any of the ones below.
Errors and warnings
Instruction need to be active in the route. Please plan another route with instruction on
Current location is too far away from the route origin. Please plan another route from current location
State of charge is bellow allowed by the route state of charge. Please plan another route from current location
No route alternative was found with the provided ID
No route was found with the provided ID