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.
Mutation
To start a navigation session, you need a route id, an alternative_id, your current_location and the instructions input. Of these four 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.
Arguments
input • NavigationStartInput
• Required
Navigation start input
Response
A response can either contain a data or an
errors object. The response header will always return
200 as a status code.
Data object
When successful, a data object will be returned with the
requested fields. If there are no fields present the
data object will return the operation name with the
appropriate return type. If the operation was a query, this output
will be an object of the schema’s query root type; if the operation
was a mutation, this output will be an object of the schema’s mutation
root type.
Error object
If unsuccessful, an errors object will be returned with
more details in the extensions object. The error object
can contain any of the following objects.
Error
NAVIGATION_INSTRUCTION_REQUIRED
Instruction need to be active in the route. Please plan another route with instruction on
Error
NAVIGATION_LOCATION_TOO_FAR
Current location is too far away from the route origin. Please plan another route from current location
Error
NAVIGATION_SOC_BELOW_ALLOWED
State of charge is bellow allowed by the route state of charge. Please plan another route from current location
Error
ROUTE_ALTERNATIVE_NOT_FOUND
No route alternative was found with the provided ID
Error
ROUTE_NOT_FOUND
No route was found with the provided ID