eMSP · Locations
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
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.
- OCPP connector statusAdds 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 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 a location
Returns a single location the CPO pushed to the eMSP.
Path parameters3
200OCPI response envelope application/json
dataobject
The roaming partner country code of the location Road can rewrite it according to the rules set up for the connection.
The roaming partner party id of the location Road can rewrite it according to the rules set up for the connection.
The unique identifier of the location
publish_allowed_toobject[]
coordinatesobject
related_locationsobject[]
evsesobject[]
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
status_scheduleobject[]
connectorsobject[]
Connector status as the charge point reports it, in OCPP 1.6 terms.
coordinatesobject
directionsobject[]
imagesobject[]
directionsobject[]
operatorobject
logoobject
suboperatorobject
logoobject
ownerobject
logoobject
opening_timesobject
regular_hoursobject[]
exceptional_openingsobject[]
exceptional_closingsobject[]
imagesobject[]
energy_mixobject
energy_sourcesobject[]
environ_impactobject[]
Who can charge at the location: ALL or TESLA.
401Missing or invalid OCPI token
Put a location
Creates or replaces a location in the eMSP's system.
Path parameters3
Request bodyREQUIREDapplication/json
The roaming partner country code of the location Road can rewrite it according to the rules set up for the connection.
The roaming partner party id of the location Road can rewrite it according to the rules set up for the connection.
The unique identifier of the location
publish_allowed_toobject[]
coordinatesobject
related_locationsobject[]
evsesobject[]
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
status_scheduleobject[]
connectorsobject[]
Connector status as the charge point reports it, in OCPP 1.6 terms.
coordinatesobject
directionsobject[]
imagesobject[]
directionsobject[]
operatorobject
logoobject
suboperatorobject
logoobject
ownerobject
logoobject
opening_timesobject
regular_hoursobject[]
exceptional_openingsobject[]
exceptional_closingsobject[]
imagesobject[]
energy_mixobject
energy_sourcesobject[]
environ_impactobject[]
Who can charge at the location: ALL or TESLA.
200OCPI response envelope application/json
dataobject
The roaming partner country code of the location Road can rewrite it according to the rules set up for the connection.
The roaming partner party id of the location Road can rewrite it according to the rules set up for the connection.
The unique identifier of the location
publish_allowed_toobject[]
coordinatesobject
related_locationsobject[]
evsesobject[]
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
status_scheduleobject[]
connectorsobject[]
Connector status as the charge point reports it, in OCPP 1.6 terms.
coordinatesobject
directionsobject[]
imagesobject[]
directionsobject[]
operatorobject
logoobject
suboperatorobject
logoobject
ownerobject
logoobject
opening_timesobject
regular_hoursobject[]
exceptional_openingsobject[]
exceptional_closingsobject[]
imagesobject[]
energy_mixobject
energy_sourcesobject[]
environ_impactobject[]
Who can charge at the location: ALL or TESLA.
401Missing or invalid OCPI token
Patch a location
Partially updates a location in the eMSP's system.
Path parameters3
Request bodyREQUIREDapplication/json
The roaming partner country code of the location Road can rewrite it according to the rules set up for the connection.
The roaming partner party id of the location Road can rewrite it according to the rules set up for the connection.
The unique identifier of the location
publish_allowed_toobject[]
coordinatesobject
related_locationsobject[]
evsesobject[]
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
status_scheduleobject[]
connectorsobject[]
Connector status as the charge point reports it, in OCPP 1.6 terms.
coordinatesobject
directionsobject[]
imagesobject[]
directionsobject[]
operatorobject
logoobject
suboperatorobject
logoobject
ownerobject
logoobject
opening_timesobject
regular_hoursobject[]
exceptional_openingsobject[]
exceptional_closingsobject[]
imagesobject[]
energy_mixobject
energy_sourcesobject[]
environ_impactobject[]
Who can charge at the location: ALL or TESLA.
200OCPI response envelope application/json
dataobject
The roaming partner country code of the location Road can rewrite it according to the rules set up for the connection.
The roaming partner party id of the location Road can rewrite it according to the rules set up for the connection.
The unique identifier of the location
publish_allowed_toobject[]
coordinatesobject
related_locationsobject[]
evsesobject[]
Identifier of the EVSE. Road can rewrite it according to the rules set up for the connection.
status_scheduleobject[]
connectorsobject[]
Connector status as the charge point reports it, in OCPP 1.6 terms.
coordinatesobject
directionsobject[]
imagesobject[]
directionsobject[]
operatorobject
logoobject
suboperatorobject
logoobject
ownerobject
logoobject
opening_timesobject
regular_hoursobject[]
exceptional_openingsobject[]
exceptional_closingsobject[]
imagesobject[]
energy_mixobject
energy_sourcesobject[]
environ_impactobject[]
Who can charge at the location: ALL or TESLA.
401Missing or invalid OCPI token
Get an EVSE
Returns a single EVSE of a location.
Path parameters4
200OCPI response envelope application/json
dataobject
status_scheduleobject[]
connectorsobject[]
coordinatesobject
directionsobject[]
imagesobject[]
401Missing or invalid OCPI token
Put an EVSE
Creates or replaces an EVSE of a location.
Path parameters4
Request bodyREQUIREDapplication/json
status_scheduleobject[]
connectorsobject[]
coordinatesobject
directionsobject[]
imagesobject[]
200OCPI response envelope application/json
dataobject
status_scheduleobject[]
connectorsobject[]
coordinatesobject
directionsobject[]
imagesobject[]
401Missing or invalid OCPI token
Patch an EVSE
Partially updates an EVSE of a location.
Path parameters4
Request bodyREQUIREDapplication/json
status_scheduleobject[]
connectorsobject[]
coordinatesobject
directionsobject[]
imagesobject[]
200OCPI response envelope application/json
dataobject
status_scheduleobject[]
connectorsobject[]
coordinatesobject
directionsobject[]
imagesobject[]
401Missing or invalid OCPI token
Get a connector
Returns a single connector of an EVSE.
Path parameters5
200OCPI response envelope application/json
dataobject
401Missing or invalid OCPI token
Put a connector
Creates or replaces a connector of an EVSE.
Path parameters5
Request bodyREQUIREDapplication/json
200OCPI response envelope application/json
dataobject
401Missing or invalid OCPI token
Patch a connector
Partially updates a connector of an EVSE.