Documentation

CPO · 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
  • Session retrieval by authorization reference
    Non-standard CPO endpoint returning a session by the authorization reference issued during token authorization, resolving either the MSP or the platform authorization reference.
    Available on every connection.When not enabled: Not part of the OCPI specification.
GET/cpo/sessions

List sessions

Returns the CPO's sessions.

Responses
200OCPI response envelope application/json
dataobject[]
country_codestring
party_idstring
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
kwhnumber <double>
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
location_idstring
evse_uidstring
connector_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
total_costobject
excl_vatnumber <double>
incl_vatnumber <double>
statusstring
last_updatedstring <date-time>
evse_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/cpo/sessions/authorization-reference/{authorization_reference}

Get a session by authorization reference

Returns a single session by the authorization reference issued during token authorization, resolving either the MSP or the platform authorization reference.

ROADRoad extension: Session retrieval by authorization reference
Request
Path parameters1
authorization_referencestringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
country_codestring
party_idstring
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
kwhnumber <double>
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
location_idstring
evse_uidstring
connector_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
total_costobject
excl_vatnumber <double>
incl_vatnumber <double>
statusstring
last_updatedstring <date-time>
evse_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/cpo/sessions/{session_id}/charging_preferences

Set charging preferences

Sets the charging preferences of an ongoing session. The body carries the OCPI ChargingPreferences object; the response data is the ChargingPreferencesResponse enum.

Request
Path parameters1
session_idstringREQUIRED
Responses
200OCPI response envelope application/json
datastring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.