OpenAPI reference

Receiver Commands

POST/commands/{command}/{uid}

Receive the asynchronous CommandResult that the CPO posts to the eMSP-supplied ``response_url`` after dispatching a command at the Charge Point.

API: OCPI 2.1.1 (eMSP) · Module: Commands (eMSP)
Base path: /commands · Base URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1

Overview

POST /commands/{command}/{uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/commands/{command}/{uid}

Receive the asynchronous CommandResult that the CPO posts to the eMSP-supplied response_url after dispatching a command at the Charge Point.

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/emsp/2.1.1/commands/CMD1/example' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"result":"ACCEPTED"}'

Request

Path parameters

Name	Type	Required	Description
`command`	`CommandType`	Yes	The command type (e.g. START_SESSION).
`uid`	`string`	Yes	Unique ID used to identify the specific command request.

Request body

application/json · Required

Schema: CommandResponse

Field	Type	Required	Description
`result`	`"NOT_SUPPORTED"	"REJECTED"	"ACCEPTED"

Request examples

Example 1

1{
2  "result": "ACCEPTED"
3}

Example 2

1{
2  "result": "TIMEOUT"
3}

Responses

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

`200` — successful response

application/json

Schema: CommandResponseEnvelope

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "result": "ACCEPTED"
7  }
8}

`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": 2000,
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/emsp/2.1.1/commands/CMD1/example' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"result":"ACCEPTED"}'

OpenAPI reference

Receiver Commands

POST/commands/{command}/{uid}

Receive the asynchronous CommandResult that the CPO posts to the eMSP-supplied ``response_url`` after dispatching a command at the Charge Point.

API: OCPI 2.1.1 (eMSP) · Module: Commands (eMSP)
Base path: /commands · Base URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1

Overview

POST /commands/{command}/{uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/commands/{command}/{uid}

Receive the asynchronous CommandResult that the CPO posts to the eMSP-supplied response_url after dispatching a command at the Charge Point.

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/emsp/2.1.1/commands/CMD1/example' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"result":"ACCEPTED"}'

Request

Path parameters

Name	Type	Required	Description
`command`	`CommandType`	Yes	The command type (e.g. START_SESSION).
`uid`	`string`	Yes	Unique ID used to identify the specific command request.

Request body

application/json · Required

Schema: CommandResponse

Field	Type	Required	Description
`result`	`"NOT_SUPPORTED"	"REJECTED"	"ACCEPTED"

Request examples

Example 1

1{
2  "result": "ACCEPTED"
3}

Example 2

1{
2  "result": "TIMEOUT"
3}

Responses

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

`200` — successful response

application/json

Schema: CommandResponseEnvelope

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "result": "ACCEPTED"
7  }
8}

`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": 2000,
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/emsp/2.1.1/commands/CMD1/example' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"result":"ACCEPTED"}'

Receiver Commands

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 Commands

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