Developers

Search

Mutation

Unknown

Arguments

input· CreateRouteInput· required
Input for generating a route.

Fields

ID· ID

Errors

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

alternative_station_radius_above_allowed
The radius value is above allowed, the maximum value is $VALUE $UNIT.
alternative_station_radius_below_allowed
The radius value is below allowed, the minimum value is $VALUE $UNIT.
cabin_desired_temperature_above_allowed
The provided desired cabin temperature is too high. The value must be less than or equal to $VALUE $UNIT.
cabin_desired_temperature_below_allowed
The provided desired cabin temperature is too low. The value must be greater than or equal to $VALUE $UNIT.
conflicting_weather_parameters
Invalid combination: 'weather.type' and 'season' cannot be used together.
consumption_exceeded
Provided consumption value for $LOCATION is not valid. The value must be between 0 and $MAXVALUE kwh, or the equivalent in another unit, for this vehicle.
custom_air_pressure_above_allowed
The provided custom air pressure is too high. The value must be lower than or equal to $VALUE $UNIT.
custom_air_pressure_below_allowed
The provided custom air pressure is too low. The value must be greater than or equal to $VALUE $UNIT.
custom_solar_irradiance_above_allowed
The provided custom solar irradiance is too high. The value must be lower than or equal to 1200 $UNIT.
custom_solar_irradiance_below_allowed
The provided custom solar irradiance is too low. The value must be greater than or equal to 0 $UNIT.
custom_temperature_above_allowed
The provided custom temperature is too high. The value must be lower than or equal to $VALUE $UNIT.
custom_temperature_below_allowed
The provided custom temperature is too low. The value must be greater than or equal to $VALUE $UNIT.
invalid_weather_input
weather.custom cannot be used when weather.type is not set to CUSTOM.
missing_custom_weather_parameters
weather.custom must be provided when weather.type is set to CUSTOM.
negative_value_not_allowed
Negative value for $LOCATION is not allowed.
occupants_above_allowed
Provided number of occupants for $LOCATION is not valid. The value must be less than or equal to $OCCUPANTSCOUNT for this vehicle.
occupants_below_allowed
Provided number of occupants for $LOCATION is not valid. The value must be at least 1.
occupants_not_specified
Total occupant weight requires occupants to be specified for $LOCATION.
operator_both_excluded_and_ranking
Operator $OPERATORID is both in the ranking and excluded lists.
operator_duplicated_in_avoid
Operator $OPERATORID is multiple times in the avoid lists.
operator_duplicated_in_exclude
Operator $OPERATORID is multiple times in the exclude lists.
operator_duplicated_in_ranking
Operator $OPERATORID is multiple times in the ranking lists.
operator_in_avoid_and_excluded
Operator $OPERATORID is set in both avoid and excluded for [$COUNTRIES].
operator_in_multiple_ranking_levels
Operator $OPERATORID is set in multiple ranking levels for [$COUNTRIES].
operator_in_ranking_and_avoid
Operator $OPERATORID is set in both ranking and avoid for [$COUNTRIES].
operator_in_ranking_and_excluded
Operator $OPERATORID is set in both ranking and excluded for [$COUNTRIES].
operator_not_found
No operator was found with the $OPERATORID ID.
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.
route_alternatives_above_allowed
Provided number of alternative routes is not valid. The value must be lower than or equal to 2.
route_alternatives_below_allowed
Provided number of alternative routes is not valid. The value must be higher than or equal to 0.
route_battery_capacity_above_allowed
The provided battery capacity is too high. The value must be less than or equal to $MAX kwh or the equivalent in another unit.
route_battery_capacity_below_allowed
The provided battery capacity is too small. The value must be greater than or equal to $MIN kwh or the equivalent in another unit.
route_cargo_below_allowed
Provided amount of cargo weight is not valid. The value cannot be negative.
route_destination_invalid_properties
Destination properties are invalid. $MESSAGE
route_destination_location_missing
Missing location data for the destination. The destination must include at least one of the following: geometry coordinates, station_id or external_station_id.
route_destination_station_and_external_station_not_matching
The destination station for the route requested was not matched with the external station.
route_destination_station_not_found
The destination station for the route requested was not found with the provided ID.
route_final_soc_too_high
The provided final state of charge is too high. The value must be less than or equal to 80% of the vehicle battery capacity.
route_invalid_destination_coordinates
The destination coordinates provided are not valid.
route_invalid_maximum_state_of_charge
Invalid maximum_state_of_charge: must be an integer between 80 and 100 (inclusive).
route_invalid_origin_coordinates
The origin coordinates provided are not valid.
route_invalid_safe_risk_margin
Safe risk margin needs to be a value between 0 and 60.
route_invalid_via_coordinates
The via coordinates provided are not valid.
route_min_power_below_allowed
The provided minimum power is too small. The value must be greater than 0.
route_occupant_weight_below_allowed
Provided occupant weight is not valid. The value cannot be negative.
route_same_coordinates_consecutive_via
The coordinates of consecutive via points cannot be the same.
route_same_coordinates_origin_destination
The origin coordinates cannot be the same as the destination coordinates.
route_same_coordinates_origin_via
The origin coordinates cannot be the same as the (first) via point coordinates.
route_same_coordinates_via_destination
The (last) via coordinates cannot be the same as the destination coordinates.
route_speed_factor_above_allowed
The speed factor is too high. The value must be equal or lower than 1.20.
route_speed_factor_below_allowed
The speed factor is too low. The value must be equal or higher than 0.8.
route_station_invalid_charger
The provided via station $STATIONID cannot be used as charging stop. The charger standard of the vehicle is not supported.
route_station_invalid_min_power
The minimum power requested is higher than the station could support.
route_station_invalid_speed
The provided via station $STATIONID cannot be used as charging stop. The station does not support DC charging (> 43kW).
route_station_invalid_truck_only
The station selected as via is restricted to heavy-duty trucks and is not accessible to this vehicle.
route_station_out_of_service
The provided via station $STATIONID cannot be used as charging stop. All compatible connectors at this station are out of service.
route_traffic_aware_disabled
Traffic-aware routing is not enabled for your project. Please contact support to activate this feature.
route_traffic_aware_invalid_departure_date
Traffic-aware routing is not supported for past departure dates. Omit the {departure_time path} or set it to a date in the future.
route_via_cargo_below_allowed
Provided amount of cargo is not valid. The value must be greater than 0.
route_via_invalid_properties
Via properties are invalid. $MESSAGE
route_via_location_missing
Missing location data for one or more vias. All vias must include at least one of the following: geometry coordinates, station_id or external_station_id.
route_via_station_and_external_station_not_matching
The via station for the route requested was not matched with the external station.
route_via_station_missing_station_identifier
Via properties are invalid. A station ID or external station ID must be provided to use a station as a via point.
route_via_station_not_found
The station ID used as a via for the requested route was not found.
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.
station_destination_coordinates_not_matching
Coordinates [$DESTINATIONCOORDINATES] of destination don't match with station coordinates [$STATIONCOORDINATES].
station_via_coordinates_not_matching
Coordinates [$VIACOORDINATES] of via don't match with station coordinates [$STATIONCOORDINATES].
vehicle_type_not_allowed
Vehicle of type $TYPE is not allowed for this operation.
zero_or_negative_value_not_allowed
Zero or negative value for $LOCATION is not allowed.

Was this helpful?

  • Getting started

    Get started with the Chargetrip API.

  • API reference

    Browse our api and endpoints.

  • Examples

    Explore examples and start building.