Create a new route
As described in the route introduction, the first thing you will need to do is fetch a route ID
. This route ID
can then be sent to subscribe to route details and retrieve a polyline and other route data.
Render route and route data
Plot a route on a map and render the route detail data.
Mutation
To get a route ID
, you will need to provide us with EV details and at least a departure location and destination. Apart from that you can also support any of the options that are described below.
Arguments
input • RequestInput
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
CAR_NOT_FOUND
No car was found with the provided ID.
Error
CONSUMPTION_EXCEEDED
Provided consumption value for $LOCATION is not valid. The value must be between 0 and $MAXVALUE kwh/100km for this vehicle.
Error
EMPTY_ARRAY_NOT_ALLOWED
Array $NAME should have at least one value.
Error
ERROR_FORBIDDEN_MESSAGE
You are forbidden to execute this operation.
Error
INVALID_COORDINATES
Coordinates provided for $LOCATION are not valid.
Error
INVALID_UNIT
Provided unit type $TYPE for $LOCATION is not valid.
Error
INVALID_VALUE
Provided value $VALUE for $LOCATION is not valid. Expected value of type $EXPECTEDTYPE.
Error
NEGATIVE_VALUE_NOT_ALLOWED
Negative value for $LOCATION is not allowed.
Error
OCCUPANTS_ABOVE_ALLOWED
Provided number of occupants for $LOCATION is not valid. The value must be less than $OCCUPANTSCOUNT for this vehicle.
Error
OCCUPANTS_BELOW_ALLOWED
Provided number of occupants for $LOCATION is not valid. The value must be at least 1.
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
OPERATOR_BOTH_EXCLUDED_AND_RANKING
Operator $OPERATORID is both in the ranking and excluded lists.
Error
OPERATOR_DUPLICATED_IN_EXCLUDE
Operator $OPERATORID is multiple times in the exclude lists.
Error
OPERATOR_DUPLICATED_IN_RANKING
Operator $OPERATORID is multiple times in the ranking lists.
Error
OPERATOR_INVALID_RANKING
Operator ranking must be between 1 and 10.
Error
OPERATOR_NOT_FOUND
No operator was found with the $OPERATORID ID.
Error
OPERATOR_RANKING_NONE_GIVEN
The route operator type was set to $ROUTEOPTYPE, but no ranking was provided. Please add an operator to your client or route request.
Error
ROUTE_BATTERY_CAPACITY_ABOVE_ALLOWED
The provided battery capacity is too high. The value must be less than or equal to $MAX kwh.
Error
ROUTE_BATTERY_CAPACITY_BELOW_ALLOWED
The provided battery capacity is too small. The value must be greater than or equal to $MIN kwh.
Error
ROUTE_CARGO_BELOW_ALLOWED
Provided amount of cargo weight is not valid . The value must be greater than 0.
Error
ROUTE_CONSUMPTION_INVALID_WORST
Provided consumption value for $NAME is not valid. The worst value must be greater than or equal to best value.
Error
ROUTE_CONSUMPTION_TOTAL_EXCEEDED
Provided consumption values are not valid. The total must be between 0 and $MAXVALUE for this vehicle.
Error
ROUTE_DESTINATION_STATION_AND_EXTERNAL_STATION_NOT_MATCHING
The destination station for the route requested was not matched with the external station.
Error
ROUTE_DESTINATION_STATION_NOT_FOUND
The destination station for the route requested was not found with the provided ID.
Error
ROUTE_DUPLICATE_AMENITIES
Amenities $DUPLICATEDAMENITIES are duplicated.
Error
ROUTE_FINAL_SOC_EXCEEDING_BATTERY_CAPACITY
The provided final state of charge is too high. The value must be less than or equal to 80% of the vehicle battery capacity.
Error
ROUTE_INVALID_AMENITIES
Amenities $INVALIDAMENITIES are not valid. Allowed: $ALLOWEDAMENITIES.
Error
ROUTE_INVALID_DESTINATION_COORDINATES
The destination coordinates provided are not valid.
Error
ROUTE_INVALID_ORIGIN_COORDINATES
The origin coordinates provided are not valid.
Error
ROUTE_INVALID_SCHEDULED_CHARGE_STOP_DURATION
The scheduled charge stop duration is invalid. The value must be between 900 and 86400 seconds.
Error
ROUTE_INVALID_SCHEDULED_CHARGE_STOP_MAX_DISTANCE_FROM_STATION
The scheduled charge stop max_distance_from_station is invalid. The value must be between 0 and 1000 meters.
Error
ROUTE_INVALID_VIA_COORDINATES
The via coordinates provided are not valid.
Error
ROUTE_MAX_NUMBER_OF_PASSENGERS_EXCEEDED
Provided number of passengers is not valid. The value must be between 1 and $PASSENGERCOUNT for this vehicle.
Error
ROUTE_MIN_POWER_BELOW_ALLOWED
The provided minimum power is too small. The value must be greater than 0 kwh.
Error
ROUTE_ORIGIN_STATION_AND_EXTERNAL_STATION_NOT_MATCHING
The origin station for the route requested was not matched with the external station.
Error
ROUTE_ORIGIN_STATION_NOT_FOUND
The origin station for the route requested was not found with the provided ID.
Error
ROUTE_RADIUS_ABOVE_ALLOWED
The radius value is above allowed, the maximum value is 5000 meters.
Error
ROUTE_RADIUS_BELOW_ALLOWED
The radius value is below allowed, the minimum value is 500 meters.
Error
ROUTE_STATION_INVALID_CHARGER
The charger standard used on this vehicle is not supported by the station.
Error
ROUTE_STATION_INVALID_MIN_POWER
The minimum power requested is higher than the station could support.
Error
ROUTE_STATION_INVALID_SPEED
The station speed is not fast or turbo.
Error
ROUTE_VIA_CARGO_BELOW_ALLOWED
Provided amount of cargo is not valid. The value must be greater than 0.
Error
ROUTE_VIA_STATION_AND_EXTERNAL_STATION_NOT_MATCHING
The via station for the route requested was not matched with the external station.
Error
ROUTE_VIA_STATION_NOT_FOUND
The station ID used as a via for the requested route was not found.
Error
SOC_EXCEEDING_BATTERY_CAPACITY
The provided state of charge for $LOCATION is too high. The value must be less than or equal to the vehicle battery capacity.
Error
STATION_DESTINATION_COORDINATES_NOT_MATCHING
Coordinates [$DESTINATIONCOORDINATES] of destination don't match with station coordinates [$STATIONCOORDINATES].
Error
STATION_ORIGIN_COORDINATES_NOT_MATCHING
Coordinates [$ORIGINCOORDINATES] of origin don't match with station coordinates [$STATIONCOORDINATES].
Error
STATION_VIA_COORDINATES_NOT_MATCHING
Coordinates [$VIACOORDINATES] of via don't match with station coordinates [$STATIONCOORDINATES].
Error
TIRE_PRESSURE_BELOW_ALLOWED
Provided tire pressure is not valid. The value must be at least 1.
Error
VEHICLE_FREEMIUM_NOT_ALLOWED
You do not have access to this vehicle. Please upgrade to access this vehicle.
Error
ZERO_OR_NEGATIVE_VALUE_NOT_ALLOWED
Zero or negative value for $LOCATION is not allowed.