OpenAPI reference

Receiver Token

PATCH/tokens/{country_code}/{party_id}/{token_uid}

Notify the CPO of partial updates to a Token. Path `token_uid` and query `type` (defaulting to the body `type`, then RFID) identify the row.

API: OCPI 2.2.1 (CPO) · Module: Tokens (CPO)
Base path: /tokens · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

PATCH /tokens/{country_code}/{party_id}/{token_uid}

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

Notify the CPO of partial updates to a Token. Path token_uid and query type (defaulting to the body type, then RFID) identify the row.

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 PATCH 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"valid":false,"whitelist":"NEVER","last_updated":"2015-06-22T08:15:00Z"}'

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).
`token_uid`	`string`	Yes	Token.uid of the Token.

Query parameters

Name	Type	Required	Description
`type`	`TokenType`	No	Token.type, defaults to RFID if not provided.

Request body

application/json · Required

Schema: TokenPatch

Field	Type	Required	Description
`country_code`	`string`	No	—
`party_id`	`string`	No	—
`uid`	`string`	No	—
`type`	`"AD_HOC_USER"	"APP_USER"	"RFID"
`contract_id`	`string`	No	—
`visual_number`	`string`	No	—
`issuer`	`string`	No	—
`group_id`	`string`	No	—
`valid`	`boolean`	No	—
`whitelist`	`"ALWAYS"	"ALLOWED"	"ALLOWED_OFFLINE"
`language`	`string`	No	—
`default_profile_type`	`"CHEAP"	"FAST"	"GREEN"
`energy_contract`	`EnergyContract`	No	`EnergyContract`
`last_updated`	`string (date-time)`	Yes	Timestamp when this Token was last updated (or created).

Request examples

Example 1

1{
2  "valid": false,
3  "whitelist": "NEVER",
4  "last_updated": "2015-06-22T08:15:00Z"
5}

Example 2

1{
2  "issuer": "Example Mobility Updated",
3  "language": "en",
4  "last_updated": "2015-06-22T10:00:00Z"
5}

Responses

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

`200` — successful response

application/json

Schema: TokenResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`TokenOut`	No	`TokenOut`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "contract_id": "NL-TNM-012345678905880-S",
7    "country_code": "NL",
8    "default_profile_type": "GREEN",
9    "energy_contract": {
10      "contract_id": "ENERGY-CONTRACT-001",
11      "supplier_name": "Greenchoice"
12    },
13    "group_id": "GROUP-001",
14    "issuer": "MobilityPlus",
15    "language": "nl",
16    "last_updated": "2024-01-15T10:00:00Z",
17    "party_id": "TNM",
18    "type": "RFID",
19    "uid": "012345678905880",
20    "valid": true,
21    "visual_number": "DF000-2001-8999-1",
22    "whitelist": "ALLOWED"
23  }
24}

`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}

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Unknown token",
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 PATCH 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"valid":false,"whitelist":"NEVER","last_updated":"2015-06-22T08:15:00Z"}'

OpenAPI reference

Receiver Token

PATCH/tokens/{country_code}/{party_id}/{token_uid}

Notify the CPO of partial updates to a Token. Path `token_uid` and query `type` (defaulting to the body `type`, then RFID) identify the row.

API: OCPI 2.2.1 (CPO) · Module: Tokens (CPO)
Base path: /tokens · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

PATCH /tokens/{country_code}/{party_id}/{token_uid}

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

Notify the CPO of partial updates to a Token. Path token_uid and query type (defaulting to the body type, then RFID) identify the row.

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 PATCH 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"valid":false,"whitelist":"NEVER","last_updated":"2015-06-22T08:15:00Z"}'

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).
`token_uid`	`string`	Yes	Token.uid of the Token.

Query parameters

Name	Type	Required	Description
`type`	`TokenType`	No	Token.type, defaults to RFID if not provided.

Request body

application/json · Required

Schema: TokenPatch

Field	Type	Required	Description
`country_code`	`string`	No	—
`party_id`	`string`	No	—
`uid`	`string`	No	—
`type`	`"AD_HOC_USER"	"APP_USER"	"RFID"
`contract_id`	`string`	No	—
`visual_number`	`string`	No	—
`issuer`	`string`	No	—
`group_id`	`string`	No	—
`valid`	`boolean`	No	—
`whitelist`	`"ALWAYS"	"ALLOWED"	"ALLOWED_OFFLINE"
`language`	`string`	No	—
`default_profile_type`	`"CHEAP"	"FAST"	"GREEN"
`energy_contract`	`EnergyContract`	No	`EnergyContract`
`last_updated`	`string (date-time)`	Yes	Timestamp when this Token was last updated (or created).

Request examples

Example 1

1{
2  "valid": false,
3  "whitelist": "NEVER",
4  "last_updated": "2015-06-22T08:15:00Z"
5}

Example 2

1{
2  "issuer": "Example Mobility Updated",
3  "language": "en",
4  "last_updated": "2015-06-22T10:00:00Z"
5}

Responses

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

`200` — successful response

application/json

Schema: TokenResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`TokenOut`	No	`TokenOut`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "contract_id": "NL-TNM-012345678905880-S",
7    "country_code": "NL",
8    "default_profile_type": "GREEN",
9    "energy_contract": {
10      "contract_id": "ENERGY-CONTRACT-001",
11      "supplier_name": "Greenchoice"
12    },
13    "group_id": "GROUP-001",
14    "issuer": "MobilityPlus",
15    "language": "nl",
16    "last_updated": "2024-01-15T10:00:00Z",
17    "party_id": "TNM",
18    "type": "RFID",
19    "uid": "012345678905880",
20    "valid": true,
21    "visual_number": "DF000-2001-8999-1",
22    "whitelist": "ALLOWED"
23  }
24}

`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}

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Unknown token",
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 PATCH 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"valid":false,"whitelist":"NEVER","last_updated":"2015-06-22T08:15:00Z"}'

Receiver Token

Overview

How to call

Request

Path parameters

Query parameters

Request body

Request examples

Responses

`200` — successful response

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

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Receiver Token

Overview

How to call

Request

Path parameters

Query parameters

Request body

Request examples

Responses

`200` — successful response

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

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page