OpenAPI reference

Unlock Connector Command

POST/commands/UNLOCK_CONNECTOR

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

Overview

POST /commands/UNLOCK_CONNECTOR

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/commands/UNLOCK_CONNECTOR

OCPI 2.2.1 Receiver interface endpoint for POST /commands/UNLOCK_CONNECTOR. The Sender requests the CPO to unlock a specific connector on an EVSE. The immediate response indicates whether the unlock request could be forwarded. The final charge point outcome is returned asynchronously to the supplied response_url.

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 POST 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/commands/UNLOCK_CONNECTOR' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"response_url":"https://example.com/ocpi/emsp/2.2.1/commands/UNLOCK_CONNECTOR/cmd-unlock-001","location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1"}'

Request

Request body

application/json · Required

Schema: UnlockConnector

Field	Type	Required	Description
`response_url`	`string`	Yes	—
`location_id`	`string`	Yes	—
`evse_uid`	`string`	Yes	—
`connector_id`	`string`	Yes	—

Request example

1{
2  "response_url": "https://example.com/ocpi/emsp/2.2.1/commands/UNLOCK_CONNECTOR/cmd-unlock-001",
3  "location_id": "LOC-NL-TNM-001",
4  "evse_uid": "LOC-NL-TNM-001*E1",
5  "connector_id": "1"
6}

Responses

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

`200` — successful response

application/json

Schema: CommandResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "message": [
7      {
8        "language": "en",
9        "text": "Command accepted"
10      }
11    ],
12    "result": "ACCEPTED",
13    "timeout": 30
14  }
15}

`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 POST 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/commands/UNLOCK_CONNECTOR' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"response_url":"https://example.com/ocpi/emsp/2.2.1/commands/UNLOCK_CONNECTOR/cmd-unlock-001","location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1"}'

OpenAPI reference

Unlock Connector Command

POST/commands/UNLOCK_CONNECTOR

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

Overview

POST /commands/UNLOCK_CONNECTOR

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/commands/UNLOCK_CONNECTOR

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 POST 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/commands/UNLOCK_CONNECTOR' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"response_url":"https://example.com/ocpi/emsp/2.2.1/commands/UNLOCK_CONNECTOR/cmd-unlock-001","location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1"}'

Request

Request body

application/json · Required

Schema: UnlockConnector

Field	Type	Required	Description
`response_url`	`string`	Yes	—
`location_id`	`string`	Yes	—
`evse_uid`	`string`	Yes	—
`connector_id`	`string`	Yes	—

Request example

1{
2  "response_url": "https://example.com/ocpi/emsp/2.2.1/commands/UNLOCK_CONNECTOR/cmd-unlock-001",
3  "location_id": "LOC-NL-TNM-001",
4  "evse_uid": "LOC-NL-TNM-001*E1",
5  "connector_id": "1"
6}

Responses

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

`200` — successful response

application/json

Schema: CommandResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2024-01-15T10:00:00Z",
5  "data": {
6    "message": [
7      {
8        "language": "en",
9        "text": "Command accepted"
10      }
11    ],
12    "result": "ACCEPTED",
13    "timeout": 30
14  }
15}

`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 POST 'https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/commands/UNLOCK_CONNECTOR' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"response_url":"https://example.com/ocpi/emsp/2.2.1/commands/UNLOCK_CONNECTOR/cmd-unlock-001","location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1"}'

Unlock Connector Command

Overview

How to call

Request

Request body

Request example

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

Unlock Connector Command

Overview

How to call

Request

Request body

Request example

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