Sections

  • Basics
  • API reference
  • Release notes
  • Deprecations
  • Examples
Sign in / Sign up
    • System
    • Day
    • Night
  • Sign in / Sign up
Introduction
Subscribe to navigation updates

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

route_id • ID

ID of the route of the navigation session

route_alternative_id • ID

ID of the route alternative of the navigation session

current_location • PointInput

Current coordinates

type • PointType

Point type

Show PointType enum values

Point

coordinates • Float

Coordinates [longitude, latitude]

instructions • NavigationInstructionsInput

Instruction input format

instructions_format • InstructionsFormat

Turn by turn instructions format for a route

Show InstructionsFormat enum values

Chargetrip

Chargetrip raw instructions

MapboxV5

Mapbox instructions mapping

language • MappingLanguage

Preferred navigation instructions language. Default: en

Default • en

Show MappingLanguage enum values

en

English(US)

precision • Int

Number of decimals used for the Google Polyline encoding Algorithm. Allowed values are 5 or 6, the default is 5

Default • 5

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

  • Basics

    API Basics GraphQL Basics EV basics
  • API reference

    API Vehicles Stations Routes Navigation Vehicle connectivity Tile service Isolines
  • Products

    Website Dashboard Help center SDKs
  • Tooling

    Playground Voyager Examples API Status
  • Legal

    Terms & Conditions Privacy Policy Cookie Policy SLA Security
Mission StatementState of chargeTry Chargetrip Go

© Chargetrip 2023

Build with love in

Amsterdam ❤️

API reference

  • API
  • Vehicles
  • Stations
  • Routes
  • Navigation
  • Vehicle connectivity
  • Tile service
  • Isolines

Sections

  • Quick setup guide
  • Pagination
  • Introduction
  • Query vehicles
  • Query vehicle details
  • Query premium vehicle details
  • Introduction
  • Query stations
  • Query station details
  • Query stations around a GeoJSON point
  • Query station reviews
  • Mutate to create a station review
  • Query station operators
  • Query station operator details
  • Query station tariffs
  • Query station tariff details
  • Query station amenities
  • Query station statistics
  • Introduction
  • Mutate to create a new route
  • Subscribe to route updates
  • Query route details
  • Query route path
  • Introduction
  • Mutate to start a new navigation session
  • Subscribe to navigation updates
  • Query navigation session
  • Mutate to update a navigation session
  • Mutate to recalculate navigation
  • Mutate to finish navigation
  • Introduction
  • Mutate to create a new connected vehicle
  • Subscribe to a connected vehicle
  • Mutate to authorize a connected vehicle
  • Query connected vehicle list
  • Query data from vehicle
  • Query connected vehicle
  • Mutate to update a connected vehicle
  • Mutate to remove a connected vehicle
  • Introduction
  • Properties
  • Filters
  • Integration
  • Introduction
  • Mutation to create an isoline
  • Subscribe to isoline details
  • Query isoline details