API docs by Redocly

OCPI 2.3.0 - HubClientInfo Module - Sender Interface (2.3.0)

Download OpenAPI specification:

URL: https://evroaming.org

The Sender Interface is implemented by the Hub. Allows connected parties to request ClientInfo objects from the Hub.

OCPI 2.3.0 Specification

Schemas

OCPIResponse

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
}

Role

string <enum> (Role)
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"

ConnectionStatus

string <enum> (ConnectionStatus)
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"

ClientInfo

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)
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 the connected party.

status
required
string <enum> (ConnectionStatus)
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 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"
}

HubClientInfo

Get list of ClientInfo objects

Fetch ClientInfo objects from the Hub. If date_from and/or date_to are provided, only objects with last_updated between the given dates will be returned. This request is paginated.

Authorizations:
ocpiAuthorization
query Parameters
date_from
string <date-time>

Only return objects that have last_updated after or equal to this Date/Time (inclusive).

date_to
string <date-time>

Only return objects that have last_updated up to this Date/Time, but not including (exclusive).

offset
integer >= 0
Default: 0

The offset of the first object returned. Default is 0.

limit
integer >= 1

Maximum number of objects to GET.

header Parameters
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).

Responses

Response samples

Content type
application/json
{
  • "status_code": 1000,
  • "status_message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "data": [
    ]
}