MSP · Sessions
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
ROADRoad deviations in this section
Road enables these for your connection on request.
- Additional fieldsAdds fields OCPI 2.1.1 does not define: the owning party (country_code and party_id) on every object, and extra location data such as a publish flag, charging accessibility, parking places and the details needed for national access point reporting. Sessions and CDRs also carry VAT-inclusive totals.When not enabled: Objects carry only the fields the OCPI specification defines.
GET/emsp/2.1.1/sessions/{country_code}/{party_id}/{session_id}
Get a session
Returns a single session the CPO pushed to the MSP.
ROADAdditional fields
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
session_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
idstring
start_datetimeobject
end_datetimeobject
kwhnumber <double>
auth_idstring
authorization_idstring
auth_methodstring
locationobject
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
coordinatesobject
nameobject
latitudestring
longitudestring
related_locationsobject[]
related_locationsobject[]
nameobject
latitudestring
longitudestring
evsesobject[]
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
capabilitiesstring[]
connectorsobject[]
floor_levelstring
coordinatesobject
physical_referencestring
directionsobject[]
parking_restrictionsstring[]
imagesobject[]
last_updatedobject
parkingobject[]
accepted_service_providersstring[]
registry_infoobject
directionsobject[]
directionsobject[]
languagestring
textstring
operatorobject
operatorobject
namestring
websitestring
logoobject
suboperatorobject
suboperatorobject
namestring
websitestring
logoobject
ownerobject
ownerobject
namestring
websitestring
logoobject
facilitiesstring[]
time_zonestring
opening_timesobject
opening_timesobject
regular_hoursobject[]
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_closingsobject[]
charging_when_closedboolean
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
registry_infoobject
operator_contactobject
owner_contactobject
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
meter_idstring
currencystring
charging_periodsobject[]
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
statusstring
last_updatedobject
evse_statusstringROAD
Last known status of the EVSE the session took place on.
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object.
party_idstringROAD
OCPI party id of the party that owns the object.
authorization_referencestring
total_cost_incl_vatnumber <double>ROAD
Total cost including VAT, alongside the VAT-exclusive total_cost.
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/emsp/2.1.1/sessions/{country_code}/{party_id}/{session_id}
Put a session
Creates or replaces a session in the MSP's system.
ROADAdditional fields
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
session_idstringREQUIRED
Request bodyREQUIREDapplication/json
idstring
start_datetimeobject
end_datetimeobject
kwhnumber <double>
auth_idstring
authorization_idstring
auth_methodstring
locationobject
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
coordinatesobject
nameobject
nameobject
languagestring
textstring
latitudestring
longitudestring
related_locationsobject[]
related_locationsobject[]
nameobject
nameobject
languagestring
textstring
latitudestring
longitudestring
evsesobject[]
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
status_scheduleobject[]
period_beginstring
period_endstring
statusstring
capabilitiesstring[]
connectorsobject[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
voltageinteger <int32>
amperageinteger <int32>
tariff_idstring
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
capabilitiesstring[]
max_electric_powerinteger <int32>
floor_levelstring
coordinatesobject
coordinatesobject
nameobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
parkingobject[]
parkingobject[]
parking_idstring
evse_positionstring
accepted_service_providersstring[]
registry_infoobject
registry_infoobject
commissioned_atobject
decommissioned_atobject
directionsobject[]
directionsobject[]
languagestring
textstring
operatorobject
operatorobject
namestring
websitestring
logoobject
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
suboperatorobject
namestring
websitestring
logoobject
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
ownerobject
namestring
websitestring
logoobject
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
opening_timesobject
regular_hoursobject[]
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_elementsobject[]
price_componentsobject[]
restrictionsobject
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
registry_infoobject
operator_contactobject
operator_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
owner_contactobject
owner_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
meter_idstring
currencystring
charging_periodsobject[]
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
statusstring
last_updatedobject
evse_statusstringROAD
Last known status of the EVSE the session took place on.
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object.
party_idstringROAD
OCPI party id of the party that owns the object.
authorization_referencestring
total_cost_incl_vatnumber <double>ROAD
Total cost including VAT, alongside the VAT-exclusive total_cost.
Responses
200OCPI response envelope application/json
dataobject
dataobject
idstring
start_datetimeobject
end_datetimeobject
kwhnumber <double>
auth_idstring
authorization_idstring
auth_methodstring
locationobject
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
coordinatesobject
nameobject
latitudestring
longitudestring
related_locationsobject[]
related_locationsobject[]
nameobject
latitudestring
longitudestring
evsesobject[]
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
capabilitiesstring[]
connectorsobject[]
floor_levelstring
coordinatesobject
physical_referencestring
directionsobject[]
parking_restrictionsstring[]
imagesobject[]
last_updatedobject
parkingobject[]
accepted_service_providersstring[]
registry_infoobject
directionsobject[]
directionsobject[]
languagestring
textstring
operatorobject
operatorobject
namestring
websitestring
logoobject
suboperatorobject
suboperatorobject
namestring
websitestring
logoobject
ownerobject
ownerobject
namestring
websitestring
logoobject
facilitiesstring[]
time_zonestring
opening_timesobject
opening_timesobject
regular_hoursobject[]
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_closingsobject[]
charging_when_closedboolean
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
registry_infoobject
operator_contactobject
owner_contactobject
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
meter_idstring
currencystring
charging_periodsobject[]
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
statusstring
last_updatedobject
evse_statusstringROAD
Last known status of the EVSE the session took place on.
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object.
party_idstringROAD
OCPI party id of the party that owns the object.
authorization_referencestring
total_cost_incl_vatnumber <double>ROAD
Total cost including VAT, alongside the VAT-exclusive total_cost.
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/emsp/2.1.1/sessions/{country_code}/{party_id}/{session_id}
Patch a session
Partially updates a session in the MSP's system.
ROADAdditional fields
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
session_idstringREQUIRED
Request bodyREQUIREDapplication/json
idstring
start_datetimeobject
end_datetimeobject
kwhnumber <double>
auth_idstring
authorization_idstring
auth_methodstring
locationobject
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
coordinatesobject
nameobject
nameobject
languagestring
textstring
latitudestring
longitudestring
related_locationsobject[]
related_locationsobject[]
nameobject
nameobject
languagestring
textstring
latitudestring
longitudestring
evsesobject[]
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
status_scheduleobject[]
period_beginstring
period_endstring
statusstring
capabilitiesstring[]
connectorsobject[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
voltageinteger <int32>
amperageinteger <int32>
tariff_idstring
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
capabilitiesstring[]
max_electric_powerinteger <int32>
floor_levelstring
coordinatesobject
coordinatesobject
nameobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
parkingobject[]
parkingobject[]
parking_idstring
evse_positionstring
accepted_service_providersstring[]
registry_infoobject
registry_infoobject
commissioned_atobject
decommissioned_atobject
directionsobject[]
directionsobject[]
languagestring
textstring
operatorobject
operatorobject
namestring
websitestring
logoobject
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
suboperatorobject
namestring
websitestring
logoobject
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
ownerobject
namestring
websitestring
logoobject
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
opening_timesobject
regular_hoursobject[]
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_elementsobject[]
price_componentsobject[]
restrictionsobject
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
registry_infoobject
operator_contactobject
operator_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
owner_contactobject
owner_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
meter_idstring
currencystring
charging_periodsobject[]
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
statusstring
last_updatedobject
evse_statusstringROAD
Last known status of the EVSE the session took place on.
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object.
party_idstringROAD
OCPI party id of the party that owns the object.
authorization_referencestring
total_cost_incl_vatnumber <double>ROAD
Total cost including VAT, alongside the VAT-exclusive total_cost.
Responses
200OCPI response envelope application/json
dataobject
dataobject
idstring
start_datetimeobject
end_datetimeobject
kwhnumber <double>
auth_idstring
authorization_idstring
auth_methodstring
locationobject
locationobject
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
coordinatesobject
nameobject
latitudestring
longitudestring
related_locationsobject[]
related_locationsobject[]
nameobject
latitudestring
longitudestring
evsesobject[]
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
capabilitiesstring[]
connectorsobject[]
floor_levelstring
coordinatesobject
physical_referencestring
directionsobject[]
parking_restrictionsstring[]
imagesobject[]
last_updatedobject
parkingobject[]
accepted_service_providersstring[]
registry_infoobject
directionsobject[]
directionsobject[]
languagestring
textstring
operatorobject
operatorobject
namestring
websitestring
logoobject
suboperatorobject
suboperatorobject
namestring
websitestring
logoobject
ownerobject
ownerobject
namestring
websitestring
logoobject
facilitiesstring[]
time_zonestring
opening_timesobject
opening_timesobject
regular_hoursobject[]
twentyfoursevenboolean
exceptional_openingsobject[]
exceptional_closingsobject[]
charging_when_closedboolean
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestring
party_idstring
publishboolean
connection_namestring
cdr_charge_rulesobject[]
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
tariff_country_codestring
tariff_party_idstring
charging_accessibilitystring
parking_placesobject[]
parking_placesobject[]
idstring
physical_referencestring
vehicle_typesstring[]
max_vehicle_weightinteger <int32>
max_vehicle_heightinteger <int32>
max_vehicle_lengthinteger <int32>
max_vehicle_widthinteger <int32>
parking_space_lengthinteger <int32>
parking_space_widthinteger <int32>
dangerous_goods_allowedboolean
directionstring
drive_throughboolean
restricted_to_typeboolean
reservation_requiredboolean
time_limitinteger <int32>
roofedboolean
imagesobject[]
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestring
registry_infoobject
registry_infoobject
operator_contactobject
owner_contactobject
aggregate_power_wattsinteger <int32>
grid_voltage_levelstring
commissioned_atobject
ocpp_versionstring
smart_charging_capableboolean
ad_hoc_payment_availableboolean
ad_hoc_price_urlstring
roaming_availableboolean
roaming_hubsstring[]
payment_instrumentsstring[]
free_of_chargeboolean
parking_places_totalinteger <int32>
parking_places_disabledinteger <int32>
parking_feeboolean
green_energy_certifiedboolean
green_energy_certificatestring
meter_idstring
currencystring
charging_periodsobject[]
charging_periodsobject[]
start_date_timeobject
dimensionsobject[]
dimensionsobject[]
typestring
volumenumber <double>
total_costnumber <double>
statusstring
last_updatedobject
evse_statusstringROAD
Last known status of the EVSE the session took place on.
country_codestringROAD
ISO 3166-1 alpha-2 country code of the party that owns the object.
party_idstringROAD
OCPI party id of the party that owns the object.
authorization_referencestring
total_cost_incl_vatnumber <double>ROAD
Total cost including VAT, alongside the VAT-exclusive total_cost.
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.