Documentation

CPO · Tokens

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.

GET/cpo/tokens/{country_code}/{party_id}/{token_uid}

Get a token

Returns a token the eMSP previously pushed to the CPO.

Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
token_uidstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
visual_numberstring
issuerstring
group_idstring
validboolean
whiteliststring
languagestring
default_profile_typestring
energy_contractobject
supplier_namestring
contract_idstring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/cpo/tokens/{country_code}/{party_id}/{token_uid}

Put a token

Creates or replaces a token in the CPO's system.

Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
token_uidstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestring
party_idstring
uidstring
typestring
contract_idstring
visual_numberstring
issuerstring
group_idstring
validboolean
whiteliststring
languagestring
default_profile_typestring
energy_contractobject
supplier_namestring
contract_idstring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
visual_numberstring
issuerstring
group_idstring
validboolean
whiteliststring
languagestring
default_profile_typestring
energy_contractobject
supplier_namestring
contract_idstring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/cpo/tokens/{country_code}/{party_id}/{token_uid}

Patch a token

Partially updates a token in the CPO's system.

Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
token_uidstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestring
party_idstring
uidstring
typestring
contract_idstring
visual_numberstring
issuerstring
group_idstring
validboolean
whiteliststring
languagestring
default_profile_typestring
energy_contractobject
supplier_namestring
contract_idstring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
visual_numberstring
issuerstring
group_idstring
validboolean
whiteliststring
languagestring
default_profile_typestring
energy_contractobject
supplier_namestring
contract_idstring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.