Documentation

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 fields
    Adds 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.
  • Locations without EVSEs left out
    Location lists leave out locations that have no EVSEs.
    When not enabled: Locations are listed whether or not they have EVSEs.
  • 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/cpo/2.1.1/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[]
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
nameobject
languagestring
textstring
latitudestring
longitudestring
related_locationsobject[]
nameobject
languagestring
textstring
latitudestring
longitudestring
evsesobject[]
uidstring
evse_idstringROAD

Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.

statusstring
status_scheduleobject[]
period_beginstring
period_endstring
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
voltageinteger <int32>
amperageinteger <int32>
tariff_idstring
terms_and_conditionsstring
last_updatedobject
ocpp_statusstringROAD

Connector status as the charge point reports it, in OCPP 1.6 terms.

capabilitiesstring[]ROAD

Capabilities of the connector, in the shape OCPI 2.3.0 uses.

max_electric_powerinteger <int32>ROAD

Maximum power in watts. When present it overrides the value calculated from voltage and amperage.

floor_levelstring
coordinatesobject
nameobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
parkingobject[]ROAD

Parking details for the EVSE.

parking_idstring
evse_positionstring
accepted_service_providersstring[]ROAD

Service providers accepted at the EVSE.

registry_infoobjectROAD

National access point reporting details for the EVSE.

commissioned_atobject
decommissioned_atobject
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[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

publishbooleanROAD

Whether the location is published. false marks it private.

connection_namestring
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
price_componentsobject[]
restrictionsobject
tariff_country_codestringROAD

Country code of the party the location's tariffs belong to.

tariff_party_idstringROAD

Party id of the party the location's tariffs belong to.

charging_accessibilitystringROAD

Who can charge at the location: ALL or TESLA.

parking_placesobject[]ROAD

Parking places at the location, for national access point reporting.

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[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestringROAD

Phone number to call for help at the location, for national access point reporting.

registry_infoobjectROAD

National access point reporting details for the location: operator contact, commissioning dates, grid connection, payment instruments and green energy certification.

operator_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
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
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/cpo/2.1.1/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
idstring
typestring
namestring
addressstring
citystring
postal_codestring
countrystring
coordinatesobject
nameobject
languagestring
textstring
latitudestring
longitudestring
related_locationsobject[]
nameobject
languagestring
textstring
latitudestring
longitudestring
evsesobject[]
uidstring
evse_idstringROAD

Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.

statusstring
status_scheduleobject[]
period_beginstring
period_endstring
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
voltageinteger <int32>
amperageinteger <int32>
tariff_idstring
terms_and_conditionsstring
last_updatedobject
ocpp_statusstringROAD

Connector status as the charge point reports it, in OCPP 1.6 terms.

capabilitiesstring[]ROAD

Capabilities of the connector, in the shape OCPI 2.3.0 uses.

max_electric_powerinteger <int32>ROAD

Maximum power in watts. When present it overrides the value calculated from voltage and amperage.

floor_levelstring
coordinatesobject
nameobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
parkingobject[]ROAD

Parking details for the EVSE.

parking_idstring
evse_positionstring
accepted_service_providersstring[]ROAD

Service providers accepted at the EVSE.

registry_infoobjectROAD

National access point reporting details for the EVSE.

commissioned_atobject
decommissioned_atobject
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[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

publishbooleanROAD

Whether the location is published. false marks it private.

connection_namestring
cdr_charge_rulesobject[]
idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
price_componentsobject[]
restrictionsobject
tariff_country_codestringROAD

Country code of the party the location's tariffs belong to.

tariff_party_idstringROAD

Party id of the party the location's tariffs belong to.

charging_accessibilitystringROAD

Who can charge at the location: ALL or TESLA.

parking_placesobject[]ROAD

Parking places at the location, for national access point reporting.

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[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
lightingboolean
refrigeration_outletboolean
standardsstring[]
apds_referencestring
help_phonestringROAD

Phone number to call for help at the location, for national access point reporting.

registry_infoobjectROAD

National access point reporting details for the location: operator contact, commissioning dates, grid connection, payment instruments and green energy certification.

operator_contactobject
phonestring
hotlinestring
emailstring
contact_personstring
websitestring
addressstring
citystring
postal_codestring
countrystring
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
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/cpo/2.1.1/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
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring
period_endstring
statusstring
capabilitiesstring[]
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
nameobject
languagestring
textstring
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
parkingobject[]
parking_idstring
evse_positionstring
accepted_service_providersstring[]
registry_infoobject
commissioned_atobject
decommissioned_atobject
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/cpo/2.1.1/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
idstring
standardstring
formatstring
power_typestring
voltageinteger <int32>
amperageinteger <int32>
tariff_idstring
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
capabilitiesstring[]
max_electric_powerinteger <int32>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.