High Mobility Push API 1.0.0
This document specifies the JSON format for each vehicle property that is made available through High Mobility's streaming and push interfaces.
SUB {instance}/{auto_api_level}/{app_id}/{vin}/charging_session/{action}/{property}
Operation IDliveinstancerequiredstringuid: instancelive/sandbox
- Allowed values:
- "live"
- "sandbox"
auto_api_levelrequiredstringuid: auto_api_levelAutoAPI level
Const:"level13"app_idrequiredstringuid: app_idApplication id
vinrequiredstringuid: vinVIN
capabilityrequiredstringuid: capabilityCapability
Const:"charging_session"actionrequiredstringuid: actionAction
Const:"get"propertyrequiredstringuid: propertyProperty
qos1Accepts one of the following messages:
- #0Charging Session Business Errorsobjectuid: charging_session_get_business_errorsversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"business_errors"requiredobjectnon-emptyrequiredrestricted anyarray<object>
Business errors
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "business_errors", "data": { "charging_session": { "business_errors": [ { "data": "dolore sit qui consectetur sunt", "timestamp": "2019-08-24T14:15:22Z" } ] } } }
This example has been generated automatically.
- #1Charging Session Calculated Energy Chargedobjectuid: charging_session_get_calculated_energy_chargedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"calculated_energy_charged"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Calculated amount of energy charged during the session
requiredobjectunitrequiredstring- Allowed values:
- "joules"
- "kilojoules"
- "watt_hours"
- "kilowatt_hours"
- "ampere_hours"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "calculated_energy_charged", "data": { "charging_session": { "calculated_energy_charged": { "data": { "unit": "kilowatt_hours", "value": 88017651.3763172 }, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #2Charging Session Charging Costobjectuid: charging_session_get_charging_costversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"charging_cost"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Charging cost information
requiredobjectCharging cost information
currencyrequiredstringCurrency ISO code
calculated_charging_costrequirednumberCalculated charging cost
calculated_savingsrequirednumberCalculated savings from charging
simulated_immediate_charging_costrequirednumberSimulated charging costs
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "charging_cost", "data": { "charging_session": { "charging_cost": { "data": { "currency": "aute nulla adipisicing deserunt irure", "calculated_charging_cost": 63634430.73076698, "calculated_savings": -79649593.49813375, "simulated_immediate_charging_cost": -49397217.135194845 }, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #3Charging Session Displayed Start State Of Chargeobjectuid: charging_session_get_displayed_start_state_of_chargeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"displayed_start_state_of_charge"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Displayed state of charge at start to the driver
datarequirednumberPercentage value between 0.0 - 1.0 (0% - 100%)
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "displayed_start_state_of_charge", "data": { "charging_session": { "displayed_start_state_of_charge": { "data": -29817892.261693224, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #4Charging Session Displayed State Of Chargeobjectuid: charging_session_get_displayed_state_of_chargeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"displayed_state_of_charge"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Displayed state of charge to the driver
datarequirednumberPercentage value between 0.0 - 1.0 (0% - 100%)
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "displayed_state_of_charge", "data": { "charging_session": { "displayed_state_of_charge": { "data": -53902664.44204883, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #5Charging Session End Timeobjectuid: charging_session_get_end_timeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"end_time"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
End time of the charging session
datarequiredstringformat: date-timetimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "end_time", "data": { "charging_session": { "end_time": { "data": "1973-03-21T08:38:02.000Z", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #6Charging Session Energy Chargedobjectuid: charging_session_get_energy_chargedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"energy_charged"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Energy charged during the session
requiredobjectunitrequiredstring- Allowed values:
- "joules"
- "kilojoules"
- "watt_hours"
- "kilowatt_hours"
- "ampere_hours"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "energy_charged", "data": { "charging_session": { "energy_charged": { "data": { "unit": "ampere_hours", "value": 26567261.893773735 }, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #7Charging Session Locationobjectuid: charging_session_get_locationversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"location"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Charging location address
requiredobjectCharging location address
municipalityrequiredstringMunicipality component of the address
formatted_addressrequiredstringFull formatted address
street_addressrequiredstringStreet address component
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "location", "data": { "charging_session": { "location": { "data": { "municipality": "magna culpa", "formatted_address": "dolor velit", "street_address": "Ut ad" }, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #8Charging Session Odometerobjectuid: charging_session_get_odometerversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"odometer"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
The vehicle odometer value in a given units
requiredobjectunitrequiredstring- Allowed values:
- "meters"
- "millimeters"
- "centimeters"
- "decimeters"
- "kilometers"
- "megameters"
- "inches"
- "feet"
- "yards"
- "miles"
- "scandinavian_miles"
- "nautical_miles"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "odometer", "data": { "charging_session": { "odometer": { "data": { "unit": "kilometers", "value": 3032399.5877975225 }, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #9Charging Session Preconditioning Stateobjectuid: charging_session_get_preconditioning_stateversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"preconditioning_state"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Preconditioning is active or not
datarequiredstringActive state
- Allowed values:
- "inactive"
- "active"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "preconditioning_state", "data": { "charging_session": { "preconditioning_state": { "data": "active", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #10Charging Session Public Charging Pointsobjectuid: charging_session_get_public_charging_pointsversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"public_charging_points"requiredobjectnon-emptyrequiredrestricted anyarray<object>
Matching public charging points.
requiredobjectCharging point
cityrequiredstringCity the charging point is in.
postal_coderequiredstringPostal code the charging point is at.
streetrequiredstringStreet address the chargin point is at.
providerrequiredstringThe provider name of the charging point.
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "public_charging_points", "data": { "charging_session": { "public_charging_points": [ { "data": { "city": "mollit amet velit dolore non", "postal_code": "sint ullamco", "street": "consectetur pariatur laborum", "provider": "pariatur dolor" }, "timestamp": "2019-08-24T14:15:22Z" } ] } } }
This example has been generated automatically.
- #11Charging Session Start Timeobjectuid: charging_session_get_start_timeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"start_time"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Start time of the charging session
datarequiredstringformat: date-timetimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "start_time", "data": { "charging_session": { "start_time": { "data": "2008-11-04T22:14:47.000Z", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #12Charging Session Time Zoneobjectuid: charging_session_get_time_zoneversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"time_zone"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Time zone of the charging session
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "time_zone", "data": { "charging_session": { "time_zone": { "data": "aute dolor fugiat", "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #13Charging Session Total Charging Durationobjectuid: charging_session_get_total_charging_durationversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"total_charging_duration"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Total time charging was active during the session
requiredobjectunitrequiredstring- Allowed values:
- "seconds"
- "minutes"
- "hours"
- "days"
- "weeks"
- "months"
- "milliseconds"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Examples
{ "version": 1, "message_id": "B10BB67D6B4D2EBAB49FD3F81D41111C2AC0D6E0816DE47F87DCDD1388F3D911", "vin": "VFXXXXXXXXXXXXXXX", "capability": "charging_session", "property": "total_charging_duration", "data": { "charging_session": { "total_charging_duration": { "data": { "unit": "milliseconds", "value": 5532622.88625209 }, "timestamp": "2019-08-24T14:15:22Z" } } } }
This example has been generated automatically.
- #1Charging Session Business Errorsobjectuid: charging_session_get_business_errorsversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"business_errors"requiredobjectnon-emptyrequiredrestricted anyarray<object>
Business errors
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
- #2Charging Session Calculated Energy Chargedobjectuid: charging_session_get_calculated_energy_chargedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"calculated_energy_charged"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Calculated amount of energy charged during the session
requiredobjectunitrequiredstring- Allowed values:
- "joules"
- "kilojoules"
- "watt_hours"
- "kilowatt_hours"
- "ampere_hours"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #3Charging Session Charging Costobjectuid: charging_session_get_charging_costversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"charging_cost"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Charging cost information
requiredobjectCharging cost information
currencyrequiredstringCurrency ISO code
calculated_charging_costrequirednumberCalculated charging cost
calculated_savingsrequirednumberCalculated savings from charging
simulated_immediate_charging_costrequirednumberSimulated charging costs
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #4Charging Session Displayed Start State Of Chargeobjectuid: charging_session_get_displayed_start_state_of_chargeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"displayed_start_state_of_charge"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Displayed state of charge at start to the driver
datarequirednumberPercentage value between 0.0 - 1.0 (0% - 100%)
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #5Charging Session Displayed State Of Chargeobjectuid: charging_session_get_displayed_state_of_chargeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"displayed_state_of_charge"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Displayed state of charge to the driver
datarequirednumberPercentage value between 0.0 - 1.0 (0% - 100%)
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #6Charging Session End Timeobjectuid: charging_session_get_end_timeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"end_time"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
End time of the charging session
datarequiredstringformat: date-timetimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #7Charging Session Energy Chargedobjectuid: charging_session_get_energy_chargedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"energy_charged"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Energy charged during the session
requiredobjectunitrequiredstring- Allowed values:
- "joules"
- "kilojoules"
- "watt_hours"
- "kilowatt_hours"
- "ampere_hours"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #8Charging Session Locationobjectuid: charging_session_get_locationversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"location"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Charging location address
requiredobjectCharging location address
municipalityrequiredstringMunicipality component of the address
formatted_addressrequiredstringFull formatted address
street_addressrequiredstringStreet address component
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #9Charging Session Odometerobjectuid: charging_session_get_odometerversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"odometer"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
The vehicle odometer value in a given units
requiredobjectunitrequiredstring- Allowed values:
- "meters"
- "millimeters"
- "centimeters"
- "decimeters"
- "kilometers"
- "megameters"
- "inches"
- "feet"
- "yards"
- "miles"
- "scandinavian_miles"
- "nautical_miles"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #10Charging Session Preconditioning Stateobjectuid: charging_session_get_preconditioning_stateversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"preconditioning_state"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Preconditioning is active or not
datarequiredstringActive state
- Allowed values:
- "inactive"
- "active"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #11Charging Session Public Charging Pointsobjectuid: charging_session_get_public_charging_pointsversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"public_charging_points"requiredobjectnon-emptyrequiredrestricted anyarray<object>
Matching public charging points.
requiredobjectCharging point
cityrequiredstringCity the charging point is in.
postal_coderequiredstringPostal code the charging point is at.
streetrequiredstringStreet address the chargin point is at.
providerrequiredstringThe provider name of the charging point.
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
- #12Charging Session Start Timeobjectuid: charging_session_get_start_timeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"start_time"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Start time of the charging session
datarequiredstringformat: date-timetimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #13Charging Session Time Zoneobjectuid: charging_session_get_time_zoneversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"time_zone"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Time zone of the charging session
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- #14Charging Session Total Charging Durationobjectuid: charging_session_get_total_charging_durationversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"total_charging_duration"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Total time charging was active during the session
requiredobjectunitrequiredstring- Allowed values:
- "seconds"
- "minutes"
- "hours"
- "days"
- "weeks"
- "months"
- "milliseconds"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_business_errorsversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"business_errors"requiredobjectnon-emptyrequiredrestricted anyarray<object>
Business errors
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_calculated_energy_chargedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"calculated_energy_charged"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Calculated amount of energy charged during the session
requiredobjectunitrequiredstring- Allowed values:
- "joules"
- "kilojoules"
- "watt_hours"
- "kilowatt_hours"
- "ampere_hours"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_charging_costversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"charging_cost"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Charging cost information
requiredobjectCharging cost information
currencyrequiredstringCurrency ISO code
calculated_charging_costrequirednumberCalculated charging cost
calculated_savingsrequirednumberCalculated savings from charging
simulated_immediate_charging_costrequirednumberSimulated charging costs
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_displayed_start_state_of_chargeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"displayed_start_state_of_charge"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Displayed state of charge at start to the driver
datarequirednumberPercentage value between 0.0 - 1.0 (0% - 100%)
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_displayed_state_of_chargeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"displayed_state_of_charge"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Displayed state of charge to the driver
datarequirednumberPercentage value between 0.0 - 1.0 (0% - 100%)
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_end_timeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"end_time"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
End time of the charging session
datarequiredstringformat: date-timetimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_energy_chargedversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"energy_charged"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Energy charged during the session
requiredobjectunitrequiredstring- Allowed values:
- "joules"
- "kilojoules"
- "watt_hours"
- "kilowatt_hours"
- "ampere_hours"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_locationversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"location"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Charging location address
requiredobjectCharging location address
municipalityrequiredstringMunicipality component of the address
formatted_addressrequiredstringFull formatted address
street_addressrequiredstringStreet address component
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_odometerversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"odometer"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
The vehicle odometer value in a given units
requiredobjectunitrequiredstring- Allowed values:
- "meters"
- "millimeters"
- "centimeters"
- "decimeters"
- "kilometers"
- "megameters"
- "inches"
- "feet"
- "yards"
- "miles"
- "scandinavian_miles"
- "nautical_miles"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_preconditioning_stateversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"preconditioning_state"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Preconditioning is active or not
datarequiredstringActive state
- Allowed values:
- "inactive"
- "active"
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_public_charging_pointsversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"public_charging_points"requiredobjectnon-emptyrequiredrestricted anyarray<object>
Matching public charging points.
requiredobjectCharging point
cityrequiredstringCity the charging point is in.
postal_coderequiredstringPostal code the charging point is at.
streetrequiredstringStreet address the chargin point is at.
providerrequiredstringThe provider name of the charging point.
Additional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_start_timeversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"start_time"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Start time of the charging session
datarequiredstringformat: date-timetimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_time_zoneversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"time_zone"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Time zone of the charging session
datarequiredstringtimestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
- objectuid: charging_session_get_total_charging_durationversionrequirednumberuid: versionmessage_idrequiredstringuid: message_idvinrequiredstringuid: vincapabilityrequiredstringConst:"charging_session"propertyrequiredstringConst:"total_charging_duration"requiredobjectnon-emptyrequiredrestricted anyobjectnon-empty
Total time charging was active during the session
requiredobjectunitrequiredstring- Allowed values:
- "seconds"
- "minutes"
- "hours"
- "days"
- "weeks"
- "months"
- "milliseconds"
valuerequirednumberAdditional properties are NOT allowed.
timestamprequiredstringformat: date-timeuid: timestampAdditional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.