Sections

Sign in / Sign up
Subscribe to navigation updates Mutate to update a navigation session

Query a navigation session

When you have obtained a navigation id through the startNavigation mutation, you can query for its current state.

Query

To query the navigation details you will need to provide the navigation ID as an argument. For doing turn-by-turn navigation we strongly recommend you to use the subscription service. A subscription provides you with updates on the navigation session whilst a navigation query only gives you a snapshot of the current state.

Arguments

id • ID

• Required

ID of the navigation session to retrieve

Other fields

id • ID

ID of the navigation session

route_id • ID

The current route used for navigation

route_alternative_id • ID

The current route alternative used for navigation

state • NavigationState

The state of a navigation session. The status can be driving, charging, finished, or error

Show NavigationState enum values

state_of_charge • Float

State of charge at the last known location

Show arguments

last_known_location • Point

Last known location

next_station • NavigationStation

Next charging station

alternative_stations • NavigationStation

A set of alternative charging stations to next station

instructions • JSON

Navigation instructions

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.