OpenAPI reference

Receiver ClientInfo

PUT/hubclientinfo/{country_code}/{party_id}

Push new or updated ClientInfo from the Hub to a connected client. Path ``(country_code, party_id)`` MUST match body fields (2001 on mismatch per OCPI 2.2.1 §17.4).

API: OCPI 2.2.1 (CPO) · Module: Hub Client Info (CPO)
Base path: /hubclientinfo · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

PUT /hubclientinfo/{country_code}/{party_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/hubclientinfo/{country_code}/{party_id}

Push new or updated ClientInfo from the Hub to a connected client. Path (country_code, party_id) MUST match body fields (2001 on mismatch per OCPI 2.2.1 §17.4).

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/hubclientinfo/NL/ABC' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"party_id":"EXA","country_code":"NL","role":"CPO","status":"CONNECTED","last_updated":"2025-06-29T20:39:09Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).

Request body

application/json · Required

Schema: ClientInfo

Field	Type	Required	Description
`party_id`	`string`	Yes	CPO or eMSP ID of the subject party.
`country_code`	`string`	Yes	Country code of the subject party's operation.
`role`	`"CPO"	"EMSP"	"HUB"
`status`	`"CONNECTED"	"OFFLINE"	"PLANNED"
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "party_id": "EXA",
3  "country_code": "NL",
4  "role": "CPO",
5  "status": "CONNECTED",
6  "last_updated": "2025-06-29T20:39:09Z"
7}

Example 2

1{
2  "party_id": "EMP",
3  "country_code": "DE",
4  "role": "EMSP",
5  "status": "SUSPENDED",
6  "last_updated": "2025-07-01T08:00:00Z"
7}

Responses

Status	Description	Schema
`200`	Successful Response	`ClientInfoResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: ClientInfoResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`ClientInfoOut`	No	Read-side DTO -- direct 1:1 mapping onto `HubClientInfo` ORM columns.

Response example

1{
2  "data": {
3    "country_code": "NL",
4    "last_updated": "2024-01-15T10:00:00Z",
5    "party_id": "TNM",
6    "role": "EMSP",
7    "status": "CONNECTED"
8  },
9  "status_code": 1000,
10  "status_message": "Success",
11  "timestamp": "2024-01-15T10:00:00Z"
12}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/hubclientinfo/NL/ABC' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"party_id":"EXA","country_code":"NL","role":"CPO","status":"CONNECTED","last_updated":"2025-06-29T20:39:09Z"}'

OpenAPI reference

Receiver ClientInfo

PUT/hubclientinfo/{country_code}/{party_id}

Push new or updated ClientInfo from the Hub to a connected client. Path ``(country_code, party_id)`` MUST match body fields (2001 on mismatch per OCPI 2.2.1 §17.4).

API: OCPI 2.2.1 (CPO) · Module: Hub Client Info (CPO)
Base path: /hubclientinfo · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

PUT /hubclientinfo/{country_code}/{party_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/hubclientinfo/{country_code}/{party_id}

Push new or updated ClientInfo from the Hub to a connected client. Path (country_code, party_id) MUST match body fields (2001 on mismatch per OCPI 2.2.1 §17.4).

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/hubclientinfo/NL/ABC' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"party_id":"EXA","country_code":"NL","role":"CPO","status":"CONNECTED","last_updated":"2025-06-29T20:39:09Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).

Request body

application/json · Required

Schema: ClientInfo

Field	Type	Required	Description
`party_id`	`string`	Yes	CPO or eMSP ID of the subject party.
`country_code`	`string`	Yes	Country code of the subject party's operation.
`role`	`"CPO"	"EMSP"	"HUB"
`status`	`"CONNECTED"	"OFFLINE"	"PLANNED"
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "party_id": "EXA",
3  "country_code": "NL",
4  "role": "CPO",
5  "status": "CONNECTED",
6  "last_updated": "2025-06-29T20:39:09Z"
7}

Example 2

1{
2  "party_id": "EMP",
3  "country_code": "DE",
4  "role": "EMSP",
5  "status": "SUSPENDED",
6  "last_updated": "2025-07-01T08:00:00Z"
7}

Responses

Status	Description	Schema
`200`	Successful Response	`ClientInfoResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: ClientInfoResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`ClientInfoOut`	No	Read-side DTO -- direct 1:1 mapping onto `HubClientInfo` ORM columns.

Response example

1{
2  "data": {
3    "country_code": "NL",
4    "last_updated": "2024-01-15T10:00:00Z",
5    "party_id": "TNM",
6    "role": "EMSP",
7    "status": "CONNECTED"
8  },
9  "status_code": 1000,
10  "status_message": "Success",
11  "timestamp": "2024-01-15T10:00:00Z"
12}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/hubclientinfo/NL/ABC' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"party_id":"EXA","country_code":"NL","role":"CPO","status":"CONNECTED","last_updated":"2025-06-29T20:39:09Z"}'

Receiver ClientInfo

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Receiver ClientInfo

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page