Skip to content

RoutePlannerPreferences

A user's sticky EV Route Planner preferences, created with defaults on first access. PATCH treats the body as a partial map — only the keys you include are changed.

urlstring, (uri)read-onlyrequired
Example:"https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735/route_planner_preferences"
preferred_vehiclestring or null, (uri)required

Link to the vehicle selected by default, or null if none is set.

Example:"https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H"
min_charger_power_wattsinteger or nullrequired

Soft minimum charger power (watts) for en-route charger search. Null means all chargers.

Enum:2200050000100000150000250000null
arrive_with_min_percentinteger, [ 0 .. 100 ]required

Default arrival battery floor seeded into new route plans.

distance_unitstring or nullrequired

Unit used to display distances. AUTO means the user chose to derive the unit from their locale; null means the user has never set it.

Enum:"AUTO""MILES""KILOMETRES"null
Example:"MILES"
temperature_unitstring or nullrequired

Unit used to display temperatures. AUTO means the user chose to derive the unit from their locale; null means the user has never set it.

Enum:"AUTO""CELSIUS""FAHRENHEIT"null
Example:"AUTO"
battery_displaystring or nullrequired

Whether battery figures read as a percentage or as distance left. null means the user has never set it.

Enum:"PERCENT""DISTANCE"null
Example:"PERCENT"
break_every_minutesinteger or nullrequired
Example:120
Any of:

Driving minutes between breaks. 0 means no breaks; null means the user has never set it.

integer
Value:0
break_minutesinteger or null, [ 5 .. 120 ]required

Length of each break, in minutes. null means the user has never set it.

Example:20
network_preferencesobject or null, <= 100 propertiesrequired

Charging networks the user prefers or avoids, by the network's name. A network not listed is neutral. null means the user has never set it.

Example:
{ "IONNA": "PREFER", "EVgo": "AVOID" }
updated_atstring, (date-time)read-onlyrequired
{ "url": "https://api.ev.energy/v2/users/user01HN2NJ9NMRZBXT1H6FT9N7735/route_planner_preferences", "preferred_vehicle": "https://api.ev.energy/v2/vehicles/vhcl01HRFF3SEVSCRAV9B3CHVDFN0H", "min_charger_power_watts": 22000, "arrive_with_min_percent": 0, "distance_unit": "MILES", "temperature_unit": "AUTO", "battery_display": "PERCENT", "break_every_minutes": 120, "break_minutes": 20, "network_preferences": { "IONNA": "PREFER", "EVgo": "AVOID" }, "updated_at": "2019-08-24T14:15:22Z" }