Download OpenAPI specification:
Typically implemented by all parties connecting to a Hub. With this interface the Hub can push the ClientInfo information to a connected client (eMSP/CPO etc) Example endpoint structure: /ocpi/cpo/2.0/clientinfo/{country_code}/{party_id}
| status_code required | integer OCPI status code, 1000 for success. |
| status_message | string An optional status message which may help when debugging. |
| timestamp required | string <date-time> The time this message was generated. |
| data | any Response data object or list of objects. |
{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": null
}| Enum | Description |
|---|---|
| CPO | Charge Point Operator Role. |
| EMSP | eMobility Service Provider Role. |
| NAP | National Access Point Role (national Database with all Location information of a country). |
| NSP | Navigation Service Provider Role, role like an eMSP (probably only interested in Location information). |
| OTHER | Other role. |
| SCSP | Smart Charging Service Provider Role. |
The role of a party in the OCPI ecosystem.
"CPO"| Enum | Description |
|---|---|
| CONNECTED | Party is connected. |
| OFFLINE | Party is currently not connected. |
| PLANNED | Connection to this party is planned, but has never been connected. |
| SUSPENDED | Party is now longer active, will never connect anymore. |
Status of the connection to a party.
"CONNECTED"| party_id required | string = 3 characters CPO or eMSP ID of this party (following the 15118 ISO standard), as used in the credentials exchange. | ||||||||||||||
| country_code required | string = 2 characters Country code of the country this party is operating in, as used in the credentials exchange. | ||||||||||||||
| role required | string <enum> (Role)
The role of the connected party. | ||||||||||||||
| status required | string <enum> (ConnectionStatus)
Status of the connection to the party. | ||||||||||||||
| last_updated required | string <date-time> Timestamp when this ClientInfo object was last updated. |
{- "party_id": "str",
- "country_code": "st",
- "role": "CPO",
- "status": "CONNECTED",
- "last_updated": "2019-08-24T14:15:22Z"
}If the Hub wants to check the status of a ClientInfo object in the connected client's system it might GET the object from the connected client's system for validation purposes. The Hub is the owner of the objects, so it would be illogical if the connected client system had a different status or was missing an object.
| country_code required | string = 2 characters Country code of the CPO that 'owns' this object (ISO-3166 alpha-2). |
| party_id required | string = 3 characters Party ID (Provider ID) of the CPO that 'owns' this object (following the ISO-15118 standard). |
| X-Request-ID required | string Every request SHALL contain a unique request ID, the response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. |
| X-Correlation-ID required | string Every request/response SHALL contain a unique correlation ID, every response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. When a Hub forwards a request to a party, the request SHALL contain the same X-Correlation-ID HTTP header (with the same value). |
{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": {
- "party_id": "str",
- "country_code": "st",
- "role": "CPO",
- "status": "CONNECTED",
- "last_updated": "2019-08-24T14:15:22Z"
}
}New or updated ClientInfo objects are pushed from the Hub to a connected client.
| country_code required | string = 2 characters Country code of the eMSP sending this PUT request to the CPO system. |
| party_id required | string = 3 characters Party ID (Provider ID) of the eMSP sending this PUT request to the CPO system. |
| X-Request-ID required | string Every request SHALL contain a unique request ID, the response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. |
| X-Correlation-ID required | string Every request/response SHALL contain a unique correlation ID, every response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. When a Hub forwards a request to a party, the request SHALL contain the same X-Correlation-ID HTTP header (with the same value). |
New or updated ClientInfo object.
| party_id required | string = 3 characters CPO or eMSP ID of this party (following the 15118 ISO standard), as used in the credentials exchange. | ||||||||||||||
| country_code required | string = 2 characters Country code of the country this party is operating in, as used in the credentials exchange. | ||||||||||||||
| role required | string <enum> (Role)
The role of the connected party. | ||||||||||||||
| status required | string <enum> (ConnectionStatus)
Status of the connection to the party. | ||||||||||||||
| last_updated required | string <date-time> Timestamp when this ClientInfo object was last updated. |
{- "party_id": "str",
- "country_code": "st",
- "role": "CPO",
- "status": "CONNECTED",
- "last_updated": "2019-08-24T14:15:22Z"
}{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": null
}