Subscribe to navigation updates
When you have obtained a navigation id through the startNavigation mutation, you can start a navigation subscription to get status and update details. As the vehicle is approaching a charge station, a lot can happen. Therefore, we recommend subscribing to a navigation session to push updates to the navigation app when necessary. Updates can be triggered, for example, when all connectors are occupied at the planned charge stop or if the end-user takes a wrong exit. In both cases, a reroute will be triggered.
By subscribing to a navigation session, updates are pushed to the navigation app when necessary.
Subscription
The subscription service needs to be initiated with a navigation ID. From there on it will start a navigation session and provide you with updates.
Listen to the timestamp
When starting the subscription always include the meta.updated_at field. Whenever this value changes the navigation application needs to re-render the polyline. This is updated when, for example, a wrong exit is taken and the recalculateNavigation mutation is called.
Arguments
id • ID
• Required
Frequently used fields
status • NavigationStatus
The status of a navigation session. The status can be driving, charging, finished, or error.
Show NavigationStatus enum values
meta • NavigationMeta
Navigation meta information.
Other fields
id • ID
ID of the navigation session.
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_INVALID_ROUTE_STATUS
Cannot start a navigation session for a route with status '$ROUTESTATUS'.
Error
NAVIGATION_NOT_FOUND
No navigation session was found with the provided ID.
Error
OPERATION_NOT_ALLOWED
You are not allowed to execute this operation. Enable it for the current application in the dashboard or reach out to customer support.
Error
ROUTE_POLYLINE_INVALID_DECIMALS
Value for decimals number is not valid. Allowed values are 5 or 6.