Skip to main content

DriverResponse

_idId (string)required
emailstring<email>required
badge_idsstring[]
partner_idPartner Id (string)required
site_idsstring[]required
profile object
anyOf
default objectrequired

Charging profile used on weekdays without an exception.

ac object

Defaults applied to AC charging sessions.

anyOf
expected_arrival_time objectrequired

Expected arrival time at the charging location

anyOf
string
requested_min_energyRequested Min Energy (integer)required

Requested minimum energy in Wh

requested_max_energyRequested Max Energy (integer)required

Requested maximum energy in Wh

estimated_departure_timeEstimated Departure Time (string)required
dc object

Defaults applied to DC charging sessions.

anyOf
expected_arrival_time objectrequired

Expected arrival time at the charging location

anyOf
string
requested_min_state_of_chargeRequested Min State Of Charge (number)required

Requested minimum state of charge in percentage

Possible values: >= 0 and <= 100

requested_max_state_of_chargeRequested Max State Of Charge (number)required

Requested maximum state of charge in percentage

Possible values: >= 0 and <= 100

estimated_departure_timeEstimated Departure Time (string)required
exceptions object

Weekday overrides, keyed by Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday (case-sensitive), not by site ID. Each override replaces the entire default profile for that day; fields are not merged. Profiles apply to the driver across all linked sites.

property name* DriverProfile
ac object

Defaults applied to AC charging sessions.

anyOf
expected_arrival_time objectrequired

Expected arrival time at the charging location

anyOf
string
requested_min_energyRequested Min Energy (integer)required

Requested minimum energy in Wh

requested_max_energyRequested Max Energy (integer)required

Requested maximum energy in Wh

estimated_departure_timeEstimated Departure Time (string)required
dc object

Defaults applied to DC charging sessions.

anyOf
expected_arrival_time objectrequired

Expected arrival time at the charging location

anyOf
string
requested_min_state_of_chargeRequested Min State Of Charge (number)required

Requested minimum state of charge in percentage

Possible values: >= 0 and <= 100

requested_max_state_of_chargeRequested Max State Of Charge (number)required

Requested maximum state of charge in percentage

Possible values: >= 0 and <= 100

estimated_departure_timeEstimated Departure Time (string)required
timezoneTimezone (string)required

Timezone used to interpret weekdays and profile times, e.g. Europe/Brussels.

car object
anyOf
unique_code object
anyOf
string
makeMake (string)required
modelModel (string)required
yearYear (integer)required
trim object
anyOf
string
variant object
anyOf
string
ac_max_power_kw object
anyOf
number
dc_max_power_kw object
anyOf
number
battery_capacity_kwh_gross object
anyOf
number
battery_capacity_kwh_net object
anyOf
number
range_km object
anyOf
number
allow_zero_currentAllow Zero Current (boolean)
Default value: true
has_seen_onboardingHas Seen Onboarding (boolean)
Default value: false
has_passwordHas Password (boolean)
Default value: false
email_notifications_enabledEmail Notifications Enabled (boolean)
Default value: true
DriverResponse
{
"_id": "string",
"email": "user@example.com",
"badge_ids": [
"string"
],
"partner_id": "string",
"site_ids": [
"string"
],
"profile": {
"default": {
"ac": {
"estimated_departure_time": "17:00:00",
"expected_arrival_time": "08:00:00",
"requested_max_energy": 20000,
"requested_min_energy": 5000
}
},
"exceptions": {
"Friday": {
"ac": {
"estimated_departure_time": "12:00:00",
"expected_arrival_time": "08:00:00",
"requested_max_energy": 10000,
"requested_min_energy": 5000
}
}
},
"timezone": "Europe/Brussels"
},
"car": {
"unique_code": "string",
"make": "string",
"model": "string",
"year": 0,
"trim": "string",
"variant": "string",
"ac_max_power_kw": 0,
"dc_max_power_kw": 0,
"battery_capacity_kwh_gross": 0,
"battery_capacity_kwh_net": 0,
"range_km": 0,
"allow_zero_current": true
},
"has_seen_onboarding": false,
"has_password": false,
"email_notifications_enabled": true
}