Hub Client Info

OCPI 2.2.1

By Abhishek Uniyal · Updated

Hub Client Info in OCPI 2.2.1

The Hub owns ClientInfo and sends connection information to connected parties, which act as Receivers. The typical-role module table is guidance, not a mandatory roster. A platform can provide combined CPO and eMSP services. ClientInfo.role follows this version's wire Role enum. This version includes HUB in its Role enum; that value is not universal across later versions.

Sources (7)
party_id · CiString(3) · cardinality 1: CPO or eMSP ID of this party (following the 15118 ISO standard), as used in the credentials exchange. country_code · CiString(2) · cardinality 1: Country code of the country this party is operating in, as used in the credentials exchange. role · Role · cardinality 1: The role of the connected party. status · ConnectionStatus · cardinality 1: Status of the connection to the party. last_updated · DateTime · cardinality 1: Timestamp when this ClientInfo object was last updated.OCPI 2.2.1 specification · #mod_hub_client_info_hub_client_info_object"*Data owner: `Hub`*"OCPI 2.2.1 specification · #mod_hub_client_info_module"This module provides parties connected to a hub with the connection status of other parties that are connected to a hub that they can communicate with. So, CPOs know which eMSP and other parties are online and vice versa."OCPI 2.2.1 specification · #mod_hub_client_info_module"With this interface the Hub can push the ClientInfo information to a connected client (eMSP/CPO etc)"OCPI 2.2.1 specification · #mod_hub_client_info_client_interface"The following table shows the typical modules implemented by the different roles. These are not required. The table shows the typical communication role: Receiver, Sender or Both."OCPI 2.2.1 specification · #introduction_typical_roles"Some of these roles can be combined in one company. A Platform can provide service for multiple CPOs or eMSPs, but also for both eMSPs and CPOs."OCPI 2.2.1 specification · #terminology_rolesCPO: Charge Point Operator Role. EMSP: eMobility Service Provider Role. HUB: Hub 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.OCPI 2.2.1 Types chapter · #types_role_enum

Example payload · connected-cpo

{
  "country_code": "NL",
  "party_id": "EXA",
  "role": "CPO",
  "status": "CONNECTED",
  "last_updated": "2026-01-01T00:00:00Z"
}

Example payload · offline-emsp

{
  "country_code": "NL",
  "party_id": "EXB",
  "role": "EMSP",
  "status": "OFFLINE",
  "last_updated": "2026-01-01T00:00:00Z"
}

Which endpoints does this module define?

These paths illustrate the requests. Use the URLs advertised by your partner, replace the placeholders and choose the matching interface. A listed method does not establish that this site's simulator implements it.

Connected party · receiver interface

  • Retrieve a ClientInfo object as it is stored in the connected clients system.

    GET
    /ocpi/2.2.1/clientinfo/{country_code}/{party_id}
  • Push new/updated ClientInfo object to the connect client.

    PUT
    /ocpi/2.2.1/clientinfo/{country_code}/{party_id}
Source
Method: Description GET: Retrieve a ClientInfo object as it is stored in the connected clients system. POST: n/a PUT: Push new/updated ClientInfo object to the connect client. PATCH: n/a DELETE: n/a, Use PUT, ClientInfo objects cannot be removed).OCPI 2.2.1 specification · #mod_hub_client_info_client_interface

Hub · sender interface

  • Get the list of known ClientInfo objects, last updated between the {date_from} and {date_to} paginated)

    GET
    /ocpi/2.2.1/clientinfo/
Source
Method: Description GET: Get the list of known ClientInfo objects, last updated between the {date_from} and {date_to} paginated) POST: n/a PUT: n/a PATCH: n/a DELETE: n/aOCPI 2.2.1 specification · #mod_hub_client_info_hub_interface

Try an endpoint

Send a request to this site's OCPI endpoints and read the answer. It never reaches your own system.