Sign in / Sign up
Route (NEW) introduction Subscribe to route updates (NEW)

Create a new route

As described in the route introduction, after executing the mutation a new route ID will be received in the response. 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.

Render route and route data

Mutation

To get a route ID, the input must contain at least the EV details and a departure location and destination. Other supported options are described below.

  • Support alternative stations along a route

    • To request alternative charging stations along a route, the alternative_station_radius property can be set on the input of the route mutation. The radius should be between 500 and 5000 meters. This will return all applicable stations within the set radius following the specified powers and standards.

  • Support stations as waypoint

    • A station can be added as a waypoint or as a destination. To do this, add station_id to request_input.via.properties.station or request_input.destination.properties.station.

  • Cargo load and occupants

    • To apply cargo and occupants, set request_input.origin.properties.vehicle.total_cargo_weight and request_input.origin.properties.vehicle.occupants. These values can be overridden on a leg basis by setting them on the request_input.via.properties.vehicle. Unless the values are set to 0, each leg inherits the values from the previous one or from the origin object.

  • Get additional properties

    • The route legs origin an destination have an optional properties attribute. This can be used to fetch details such as a complete address, the current temperature and air_pressure at that location.

  • Using unit arguments

    • All the fields that support unit conversion have a unit argument that can be set. For example, the range_at_origin and range_at_destination can be retrieved in kilometer, mile, kilowatt_hour or percentage. Please be aware that the percentages are based upon the usable_kwh or the capacity included inside this mutation.

  • Operator preference

    • The route request supports ranking or excluding operators based on preference. Operators can be ranked on ten different levels of preference. level_one is considered the highest level, and level_ten is the lowest. It is possible to skip levels or add multiple operators to the same level. Every level lowers the preference by 10 percent. Operator ranking can be enabled by setting the type to preferred or required on request_input.operators. If you always prefer and exclude the same operators, we recommend that you add your operator ranking to your client configuration instead. The route request will override any client configuration you might have.

Onboard chargers of 20 kWh are not used in routing unless a vehicle has no plugs above 20 kWh. Therefore, if you add a plug of 20 kWh or less to your route request, this plug will often be ignored.

Arguments

input • CreateRouteInput

• Required

Input for generating a route.

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.