CPO · 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 fieldsAdds charging_accessibility to locations, saying who can use the charge points.When not enabled: Objects carry only the fields the OCPI specification defines.
- Locations without EVSEs left outLocation lists leave out locations that have no EVSEs.When not enabled: Locations are listed whether or not they have EVSEs.
- Remapped party identitycountry_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/cpo/locations
List locations
Returns the CPO's locations, paginated via date_from, date_to, offset and limit query params.
ROADAdditional fieldsROADLocations without EVSEs left outROADRemapped party identity
Responses
200OCPI response envelope application/json
dataobject[]
dataobject[]
country_codestringROAD
The roaming partner country code of the location Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
The roaming partner party id of the location Road can rewrite it according to the rules set up for the connection.
idstring
The unique identifier of the location
publishboolean
publish_allowed_toobject[]
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
evsesobject[]
uidstring
evse_idstringROAD
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
statusstring
status_scheduleobject[]
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
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
Connector status as the charge point reports it, in OCPP 1.6 terms.
floor_levelstring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
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[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystringROAD
Who can charge at the location: ALL or TESLA.
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/cpo/locations/{location_id}
Get a location
Returns a single location by its id.
ROADAdditional fieldsROADLocations without EVSEs left outROADRemapped party identity
Request
Path parameters1
location_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
country_codestringROAD
The roaming partner country code of the location Road can rewrite it according to the rules set up for the connection.
party_idstringROAD
The roaming partner party id of the location Road can rewrite it according to the rules set up for the connection.
idstring
The unique identifier of the location
publishboolean
publish_allowed_toobject[]
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
evsesobject[]
uidstring
evse_idstringROAD
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
statusstring
status_scheduleobject[]
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
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
Connector status as the charge point reports it, in OCPP 1.6 terms.
floor_levelstring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
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[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystringROAD
Who can charge at the location: ALL or TESLA.
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/cpo/locations/{location_id}/{evse_uid}
Get an EVSE
Returns a single EVSE of a location.
ROADLocations without EVSEs left out
Request
Path parameters2
location_idstringREQUIRED
evse_uidstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
uidstring
evse_idstring
statusstring
status_scheduleobject[]
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
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
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
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/cpo/locations/{location_id}/{evse_uid}/{connector_id}
Get a connector
Returns a single connector of an EVSE.
ROADLocations without EVSEs left out
Request
Path parameters3
location_idstringREQUIRED
evse_uidstringREQUIRED
connector_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
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.