Documentation

CPO · Tokens

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.
GET/cpo/2.1.1/tokens/{country_code}/{party_id}/{token_uid}

Get a token

Returns a token the MSP previously pushed to the CPO.

ROADAdditional fields
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
token_uidstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
uidstring
typestring
auth_idstringROAD

The token's eMI3 contract identifier.

visual_numberstring
issuerstring
validboolean
whiteliststring
languagestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object.

party_idstringROAD

OCPI party id of the party that owns the object.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/cpo/2.1.1/tokens/{country_code}/{party_id}/{token_uid}

Put a token

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

ROADAdditional fields
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
token_uidstringREQUIRED
Request bodyREQUIREDapplication/json
uidstring
typestring
auth_idstringROAD

The token's eMI3 contract identifier.

visual_numberstring
issuerstring
validboolean
whiteliststring
languagestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object.

party_idstringROAD

OCPI party id of the party that owns the object.

Responses
200OCPI response envelope application/json
dataobject
uidstring
typestring
auth_idstringROAD

The token's eMI3 contract identifier.

visual_numberstring
issuerstring
validboolean
whiteliststring
languagestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object.

party_idstringROAD

OCPI party id of the party that owns the object.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/cpo/2.1.1/tokens/{country_code}/{party_id}/{token_uid}

Patch a token

Partially updates a token in the CPO's system.

ROADAdditional fields
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
token_uidstringREQUIRED
Request bodyREQUIREDapplication/json
uidstring
typestring
auth_idstringROAD

The token's eMI3 contract identifier.

visual_numberstring
issuerstring
validboolean
whiteliststring
languagestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object.

party_idstringROAD

OCPI party id of the party that owns the object.

Responses
200OCPI response envelope application/json
dataobject
uidstring
typestring
auth_idstringROAD

The token's eMI3 contract identifier.

visual_numberstring
issuerstring
validboolean
whiteliststring
languagestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object.

party_idstringROAD

OCPI party id of the party that owns the object.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.