Query 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 • non_null • ID

Required

ID of the navigation session to retrieve

Other fields

id • non_null • ID

Required

ID of the navigation session

route_id • scalar • String

The current route used for navigation

route_alternative_id • scalar • String

The current route alternative used for navigation

state • enum • NavigationState

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

state_of_charge • scalar • Float

State of charge at the last known location

last_known_location • object • Point

Last known location

next_station • object • NavigationStation

Next charging station

alternative_stations • list • NavigationStation

A set of alternative charging stations to next station

instructions • scalar • JSON

Navigation instructions

Show arguments

Response

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

Error

NAVIGATION_INVALID_MAPPING_LANGUAGE

Mapping language is not valid

Error

NAVIGATION_INVALID_MAPPING_PROVIDER

Mapping provider is not valid

Error

NAVIGATION_INVALID_ROUTE_STATUS

Cannot generate instructions mapping for route with status '$ROUTESTATUS'

Error

NAVIGATION_NOT_FOUND

No navigation session was found with the provided ID

Error

NAVIGATION_TRANSLATOR_NOT_FOUND

Translator for language "$LANGUAGE" was not found or loaded in the translators list

Error

ROUTE_POLYLINE_INVALID_DECIMALS

Value for decimals number is not valid. Allowed values are 5 or 6

Request

          query navigation {  navigation(id: "624e918b89403385e0eb97d0") {    route_id    route_alternative_id    state    state_of_charge    last_known_location {      type      coordinates    }    next_station {      station_id      station_location {        type        coordinates      }      via {        type        coordinates      }      estimated_state_of_charge      estimated_duration      estimated_consumption    }    alternative_stations {      station_id      station_location {        type        coordinates      }      via {        type        coordinates      }      estimated_state_of_charge      estimated_consumption      estimated_duration    }    instructions(instructions_format: MapboxV5, language: en, precision: 6)  }}

Playground

Response

          {  "data": {    "navigation": {      "route_id": "624e92170ccb0eeb800aa9cc",      "route_alternative_id": "624e9217ed4e70241b3092b5",      "state": "driving",      "state_of_charge": 60.5,      "last_known_location": {        "type": "Point",        "coordinates": [          9.9936818,          53.5510846        ]      },      "next_station": {        "station_id": null,        "station_location": {          "type": "Point",          "coordinates": [            8.806422,            53.073635          ]        },        "via": [],        "estimated_state_of_charge": 29.59827119941316,        "estimated_duration": 3955,        "estimated_consumption": 30.90172880058684      },      "alternative_stations": [],      "instructions": {        "routes": [          {            // Note: Instructions are removed from this example response          }        ]      }    }  }}

Query a navigation session

Query

Arguments

Other fields

Response

Errors and warnings