eMSP · Locations

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 fields
    Adds charging_accessibility to locations, saying who can use the charge points.
    When not enabled: Objects carry only the fields the OCPI specification defines.
  • OCPP connector status
    Adds ocpp_status to each connector: the status as the charge point reports it, in OCPP 1.6 terms. It is more detailed than the OCPI EVSE status, which lets a payment terminal tell whether a plug is free.
    When not enabled: Connectors carry only OCPI fields, and availability comes from the EVSE status.
  • Remapped party identity
    country_code, party_id and EVSE ids on locations, tariffs and CDRs can differ from those of the party that created them. Road rewrites them according to rules set up for the connection.
    When not enabled: Objects keep the identity of the party that created them.
GET/msp/locations/{country_code}/{party_id}/{location_id}

Get a location

ROADAdditional fieldsROADOCPP connector statusROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
country_codestringROAD
party_idstringROAD
idstring
publishboolean
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
uidstring
evse_idstringROAD
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstringROAD
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystringROAD
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/msp/locations/{country_code}/{party_id}/{location_id}

Put a location

ROADAdditional fieldsROADOCPP connector statusROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestringROAD
party_idstringROAD
idstring
publishboolean
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
uidstring
evse_idstringROAD
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstringROAD
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystringROAD
Responses
200OCPI response envelope application/json
dataobject
country_codestringROAD
party_idstringROAD
idstring
publishboolean
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
uidstring
evse_idstringROAD
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstringROAD
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystringROAD
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/msp/locations/{country_code}/{party_id}/{location_id}

Patch a location

ROADAdditional fieldsROADOCPP connector statusROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestringROAD
party_idstringROAD
idstring
publishboolean
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
uidstring
evse_idstringROAD
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstringROAD
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystringROAD
Responses
200OCPI response envelope application/json
dataobject
country_codestringROAD
party_idstringROAD
idstring
publishboolean
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
uidstring
evse_idstringROAD
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstringROAD
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystringROAD
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/msp/locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Get an EVSE

Request
Path parameters4
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
evse_uidstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/msp/locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Put an EVSE

Request
Path parameters4
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
evse_uidstringREQUIRED
Request bodyREQUIREDapplication/json
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
Responses
200OCPI response envelope application/json
dataobject
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/msp/locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Patch an EVSE

Request
Path parameters4
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
evse_uidstringREQUIRED
Request bodyREQUIREDapplication/json
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
Responses
200OCPI response envelope application/json
dataobject
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/msp/locations/{country_code}/{party_id}/{location_id}/{evse_uid}/{connector_id}

Get a connector

Request
Path parameters5
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
evse_uidstringREQUIRED
connector_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/msp/locations/{country_code}/{party_id}/{location_id}/{evse_uid}/{connector_id}

Put a connector

Request
Path parameters5
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
evse_uidstringREQUIRED
connector_idstringREQUIRED
Request bodyREQUIREDapplication/json
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
Responses
200OCPI response envelope application/json
dataobject
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/msp/locations/{country_code}/{party_id}/{location_id}/{evse_uid}/{connector_id}

Patch a connector

Request
Path parameters5
country_codestringREQUIRED
party_idstringREQUIRED
location_idstringREQUIRED
evse_uidstringREQUIRED
connector_idstringREQUIRED
Request bodyREQUIREDapplication/json
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
Responses
200OCPI response envelope application/json
dataobject
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.