Query

Unknown

Arguments

id· ID· required

ID of the navigation session to retrieve

Fields

id· ID

ID of the navigation session.

overview· NavigationOverview

Navigation session details overview.

state_of_charge· Float

State of charge at the last known location.

last_known_location· Point

Last known location.

next_stop· NavigationStop

Next stop details. Can be a charging or a location stop.

legs· NavigationRouteLeg

Continuously updated route legs.

distance· Float

Distance from the start to the end of a leg.

durations· RouteDetailsDurations

Aggregation of all durations of a route leg.

origin· RouteDetailsLegFeaturePoint

Origin point location.

destination· RouteDetailsLegFeaturePoint

Destination point location.

range_at_origin· Float

Range at the start of a leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

range_at_destination· Float

Range available at the end of a leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

range_after_charge· Float

Range after charging on the leg. The ranges in kilometers and miles are estimates, calculated based on the Chargetrip range, current route conditions, weather scenario (current or seasonal), and the route input at the time of planning. For HEVs and PHEVs this field will return null.

type· RouteDetailsLegType

Type of a leg.

station· RouteDetailsLegStation

Information about the station at the destination of a leg.

sections· NavigationLegSection

Road sections of a leg - divided by means of transportation.

tags· RouteDetailsTag

Aggregation of tags over the current leg. Tags are further subdivided over individual sections and maneuvers.

durations· RouteDetailsDurations

Continuously updated durations of the route.

instructions· RouteInstruction

Navigation route instructions.

live_route_request· NavigationLiveRouteRequest

Continuously updated route request input.

vehicle· NavigationRouteVehicle

Vehicle used on a route.

id· ID

ID of the vehicle.

battery· RouteVehicleBattery

EV battery specific configuration.

capacity· StateOfCharge

Usable capacity of a battery used to compute a route. The value must be between 50% and 150% of a vehicle's baseline battery capacity. If not provided, the vehicle's full usable capacity by default.

state_of_charge· StateOfCharge

Current amount of energy in a battery. If not provided, battery is assumed to be fully charged.

final_state_of_charge· StateOfCharge

Desired final amount of energy in a battery at the end of a trip. The value must be between 0 and 80% of the vehicle's battery capacity. If not provided, or if the specified value is below the safe risk margin, the safe risk margin is used by default.

temperature· Temperature

Temperature of the battery.

current· Float

Battery current in ampere.

voltage· Float

Battery voltage in volts.

power· Float

Value of the positive or negative power, in kWh. When negative, the vehicle is charging.

is_charging· Boolean

Flag indicating if the vehicle is charging.

charging· RouteVehicleCharging

Charging configuration.

mode· ChargeMode

Mode that indicates if the charging time is optimized or if always charged to the maximum state of charge.

minimum_power· Float

Minimum desired power of chargers, in kWh.

risk_margin· Int

Minimum remaining state of charge at charging stops, expressed as a percentage. The value must be between 0 and 60. If not provided, the project configuration value is used.

connectors· RouteVehicleChargingConnector

Supported connectors. If not specified, it defaults to the vehicle's connectors.

standard· ConnectorType

Type of the plug.

CHADEMO

The connector type is CHAdeMO, DC.

DOMESTIC_A

Standard/domestic household, type "A", NEMA 1-15, 2 pins.

DOMESTIC_B

Standard/domestic household, type "B", NEMA 5-15, 3 pins.

DOMESTIC_C

Standard/domestic household, type "C", CEE 7/17, 2 pins.

DOMESTIC_D

Standard/domestic household, type "D", 3 pins.

DOMESTIC_E

Standard/domestic household, type "E", CEE 7/5 3 pins.

DOMESTIC_F

Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.

DOMESTIC_G

Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.

DOMESTIC_H

Standard/domestic household, type "H", SI-32, 3 pins.

DOMESTIC_I

Standard/domestic household, type "I", AS 3112, 3 pins.

DOMESTIC_J

Standard/domestic household, type "J", SEV 1011, 3 pins.

DOMESTIC_K

Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.

DOMESTIC_L

Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.

DOMESTIC_M

Standard/Domestic household, type "M", BS 546, 3 pins.

DOMESTIC_N

Standard/Domestic household, type "N", NBR 14136, 3 pins.

DOMESTIC_O

Standard/Domestic household, type "O", TIS 166-2549, 3 pins.

IEC_60309_2_single_16

IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).

IEC_60309_2_three_16

IEC 60309-2 Industrial connector three phase 16 amperes (usually red).

IEC_60309_2_three_32

IEC 60309-2 Industrial connector three phase 32 amperes (usually red).

IEC_60309_2_three_64

IEC 60309-2 Industrial connector three phase 64 amperes (usually red).

IEC_62196_T1

IEC 62196 Type 1 "SAE J1772".

IEC_62196_T1_COMBO

Combo Type 1 based, DC.

IEC_62196_T2

IEC 62196 Type 2 "Mennekes".

IEC_62196_T2_COMBO

Combo Type 2 based, DC.

IEC_62196_T3A

IEC 62196 Type 3A.

IEC_62196_T3C

IEC 62196 Type 3C "Scame".

PANTOGRAPH_BOTTOM_UP

On-board bottom-up-pantograph typically for bus charging.

PANTOGRAPH_TOP_DOWN

Off-board top-down-pantograph typically for bus charging.

TESLA_R

Tesla connector "Roadster"-type (round, 4 pins).

TESLA_S

Tesla connector "Model-S"-type (oval, 5 pins).

GB_T

The connector type is GB_T (Chinese standard), DC.

CHAOJI

The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.

NEMA_5_20

The connector type is NEMA 5-20, 3 pins.

NEMA_6_30

The connector type is NEMA 6-30, 3 pins.

NEMA_6_50

The connector type is NEMA 6-50, 3 pins.

NEMA_10_30

The connector type is NEMA 10-30, 3 pins.

NEMA_10_50

The connector type is NEMA 10-50, 3 pins.

NEMA_14_30

The connector type is NEMA 14-30, 3 pins, rating of 30 A.

NEMA_14_50

The connector type is NEMA 14-50, 3 pins, rating of 50 A.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

maximum_charge_speed· ChargeSpeed

Maximum charging speed for this plug.

adapters· RouteVehicleChargingConnector

Supported adapters. If not specified, adapters will not be considered.

standard· ConnectorType

Type of the plug.

CHADEMO

The connector type is CHAdeMO, DC.

DOMESTIC_A

Standard/domestic household, type "A", NEMA 1-15, 2 pins.

DOMESTIC_B

Standard/domestic household, type "B", NEMA 5-15, 3 pins.

DOMESTIC_C

Standard/domestic household, type "C", CEE 7/17, 2 pins.

DOMESTIC_D

Standard/domestic household, type "D", 3 pins.

DOMESTIC_E

Standard/domestic household, type "E", CEE 7/5 3 pins.

DOMESTIC_F

Standard/domestic household, type "F", CEE 7/4, Schuko, 3 pins.

DOMESTIC_G

Standard/domestic household, type "G", BS 1363, Commonwealth, 3 pins.

DOMESTIC_H

Standard/domestic household, type "H", SI-32, 3 pins.

DOMESTIC_I

Standard/domestic household, type "I", AS 3112, 3 pins.

DOMESTIC_J

Standard/domestic household, type "J", SEV 1011, 3 pins.

DOMESTIC_K

Standard/domestic household, type "K", DS 60884-2-D1, 3 pins.

DOMESTIC_L

Standard/domestic household, type "L", CEI 23-16-VII, 3 pins.

DOMESTIC_M

Standard/Domestic household, type "M", BS 546, 3 pins.

DOMESTIC_N

Standard/Domestic household, type "N", NBR 14136, 3 pins.

DOMESTIC_O

Standard/Domestic household, type "O", TIS 166-2549, 3 pins.

IEC_60309_2_single_16

IEC 60309-2 Industrial connector single phase 16 amperes (usually blue).

IEC_60309_2_three_16

IEC 60309-2 Industrial connector three phase 16 amperes (usually red).

IEC_60309_2_three_32

IEC 60309-2 Industrial connector three phase 32 amperes (usually red).

IEC_60309_2_three_64

IEC 60309-2 Industrial connector three phase 64 amperes (usually red).

IEC_62196_T1

IEC 62196 Type 1 "SAE J1772".

IEC_62196_T1_COMBO

Combo Type 1 based, DC.

IEC_62196_T2

IEC 62196 Type 2 "Mennekes".

IEC_62196_T2_COMBO

Combo Type 2 based, DC.

IEC_62196_T3A

IEC 62196 Type 3A.

IEC_62196_T3C

IEC 62196 Type 3C "Scame".

PANTOGRAPH_BOTTOM_UP

On-board bottom-up-pantograph typically for bus charging.

PANTOGRAPH_TOP_DOWN

Off-board top-down-pantograph typically for bus charging.

TESLA_R

Tesla connector "Roadster"-type (round, 4 pins).

TESLA_S

Tesla connector "Model-S"-type (oval, 5 pins).

GB_T

The connector type is GB_T (Chinese standard), DC.

CHAOJI

The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.

NEMA_5_20

The connector type is NEMA 5-20, 3 pins.

NEMA_6_30

The connector type is NEMA 6-30, 3 pins.

NEMA_6_50

The connector type is NEMA 6-50, 3 pins.

NEMA_10_30

The connector type is NEMA 10-30, 3 pins.

NEMA_10_50

The connector type is NEMA 10-50, 3 pins.

NEMA_14_30

The connector type is NEMA 14-30, 3 pins, rating of 30 A.

NEMA_14_50

The connector type is NEMA 14-50, 3 pins, rating of 50 A.

GBT_AC

Guobiao GB/T 20234.2 AC socket/connector.

GBT_DC

Guobiao GB/T 20234.3 DC connector.

maximum_charge_speed· ChargeSpeed

Maximum charging speed for this plug.

maximum_state_of_charge· Int

Maximum state of charge (%) the vehicle can reach at any charging stop. If not specified defaults to 80%.

climate· Boolean

Flag indicating if climate control is on.

heat_pump· HeatPumpMode

Vehicle Heat Pump configuration.

cabin· RouteVehicleCabin

Vehicle cabin configuration used for the route calculation. Applied only if vehicle.climate is set to true.

origin· RouteOriginFeaturePoint

Origin of a route.

destination· RouteDestinationFeaturePoint

Destination of a route.

via· NavigationViaFeaturePoint

Via points of a route.

id· ID

ID of the feature.

type· FeatureType

Feature type.

geometry· Point

Geometry of the feature.

properties· NavigationViaProperties

Additional feature properties for via. If a `station.id` or `station.external_id` are provided, it will be treated as a charging stop. If omitted or `location.name` is provided, the stop is treated as a non-charging stop location.

operators· RouteOperatorPreferences

Operator preferences for a route. When provided, prefers routes that use higher order operators.

ranking· RouteOperatorPreferencesRanking

Ranking of an operator with multiple levels, each level having its own penalty value.

type· RouteOperatorsType

Flag indicating if an operator should be preferred or required.

levels· RouteOperatorPreferencesRankingLevels

Ranking levels for operator ranking.

low· RouteOperatorsValue

Least significant level for operators ranking.

medium· RouteOperatorsValue

Medium level for operators ranking.

high· RouteOperatorsValue

Most significant level for operator ranking.

exclude· RouteOperatorsValue

Operators that should be excluded for a route calculation.

avoid· RouteOperatorsValue

Operators that should be avoided, but not excluded, for a route calculation.

alternative_station_radius· AlternativeStationRadius

Alternative stations along a route within a specified radius of 500 to 5000 meters, or the equivalent in another unit.

avoid· RouteAvoid· beta

List of route features to avoid in a route. This is a best-effort preference; depending on the available routes, some features may not be fully avoidable.

driving_preferences· RouteDrivingPreferences· beta

Configuration options for the route's driving conditions. Includes factors to adjust average speed, set a maximum speed, and define a base driving style. If not specified, no adjustments are applied.

station_preferences· RouteStationPreferences

Charging stations preferences for route calculation.

polyline· String

Polyline containing encoded coordinates.

telemetry· Telemetry

Telemetry data.

vehicle_status· NavigationVehicleStatus

The status of the navigation session vehicle. The status can be driving, charging or parked.

status· NavigationStatus

The status of a navigation session. The status can be active, finished or error.

meta· NavigationMeta

Navigation meta information.

Errors

Operations can fail. To handle all errors correctly, consider implementing the following error scenario’s.

navigation_invalid_route_status
navigation_not_found
operation_not_allowed
rate_limit_exceeded
route_polyline_invalid_decimals

Was this helpful?