OpenAPI reference

Start Session Command

POST/commands/START_SESSION

OCPI 2.2.1 Receiver interface endpoint for POST /commands/START_SESSION. The Sender requests the CPO to forward a START_SESSION command to a charge point. The immediate response only confirms whether

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/START_SESSION

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

OCPI 2.2.1 Receiver interface endpoint for POST /commands/START_SESSION. The Sender requests the CPO to forward a START_SESSION command to a charge point. The immediate response only confirms whether the CPO accepted the request for delivery. 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/START_SESSION' \
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/START_SESSION/cmd-start-rfid-001","token":{"country_code":"NL","party_id":"TNM","uid":"012345678905880","type":"RFID","contract_id":"NL-TNM-012345678905880-S","issuer":"MobilityPlus","valid":true,"whitelist":"ALWAYS","last_updated":"2024-01-15T10:00:00Z"},"location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1","authorization_reference":"AUTH-REF-START-001"}'

Request

Request body

application/json · Required

Schema: StartSession

Field	Type	Required	Description
`response_url`	`string`	Yes	—
`token`	`Token`	Yes	`Token`
`location_id`	`string`	Yes	—
`evse_uid`	`string`	No	—
`connector_id`	`string`	No	—
`authorization_reference`	`string`	No	—

Request example

1{
2  "response_url": "https://example.com/ocpi/emsp/2.2.1/commands/START_SESSION/cmd-start-rfid-001",
3  "token": {
4    "country_code": "NL",
5    "party_id": "TNM",
6    "uid": "012345678905880",
7    "type": "RFID",
8    "contract_id": "NL-TNM-012345678905880-S",
9    "issuer": "MobilityPlus",
10    "valid": true,
11    "whitelist": "ALWAYS",
12    "last_updated": "2024-01-15T10:00:00Z"
13  },
14  "location_id": "LOC-NL-TNM-001",
15  "evse_uid": "LOC-NL-TNM-001*E1",
16  "connector_id": "1",
17  "authorization_reference": "AUTH-REF-START-001"
18}

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/START_SESSION' \
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/START_SESSION/cmd-start-rfid-001","token":{"country_code":"NL","party_id":"TNM","uid":"012345678905880","type":"RFID","contract_id":"NL-TNM-012345678905880-S","issuer":"MobilityPlus","valid":true,"whitelist":"ALWAYS","last_updated":"2024-01-15T10:00:00Z"},"location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1","authorization_reference":"AUTH-REF-START-001"}'

OpenAPI reference

Start Session Command

POST/commands/START_SESSION

OCPI 2.2.1 Receiver interface endpoint for POST /commands/START_SESSION. The Sender requests the CPO to forward a START_SESSION command to a charge point. The immediate response only confirms whether

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/START_SESSION

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

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/START_SESSION' \
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/START_SESSION/cmd-start-rfid-001","token":{"country_code":"NL","party_id":"TNM","uid":"012345678905880","type":"RFID","contract_id":"NL-TNM-012345678905880-S","issuer":"MobilityPlus","valid":true,"whitelist":"ALWAYS","last_updated":"2024-01-15T10:00:00Z"},"location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1","authorization_reference":"AUTH-REF-START-001"}'

Request

Request body

application/json · Required

Schema: StartSession

Field	Type	Required	Description
`response_url`	`string`	Yes	—
`token`	`Token`	Yes	`Token`
`location_id`	`string`	Yes	—
`evse_uid`	`string`	No	—
`connector_id`	`string`	No	—
`authorization_reference`	`string`	No	—

Request example

1{
2  "response_url": "https://example.com/ocpi/emsp/2.2.1/commands/START_SESSION/cmd-start-rfid-001",
3  "token": {
4    "country_code": "NL",
5    "party_id": "TNM",
6    "uid": "012345678905880",
7    "type": "RFID",
8    "contract_id": "NL-TNM-012345678905880-S",
9    "issuer": "MobilityPlus",
10    "valid": true,
11    "whitelist": "ALWAYS",
12    "last_updated": "2024-01-15T10:00:00Z"
13  },
14  "location_id": "LOC-NL-TNM-001",
15  "evse_uid": "LOC-NL-TNM-001*E1",
16  "connector_id": "1",
17  "authorization_reference": "AUTH-REF-START-001"
18}

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/START_SESSION' \
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/START_SESSION/cmd-start-rfid-001","token":{"country_code":"NL","party_id":"TNM","uid":"012345678905880","type":"RFID","contract_id":"NL-TNM-012345678905880-S","issuer":"MobilityPlus","valid":true,"whitelist":"ALWAYS","last_updated":"2024-01-15T10:00:00Z"},"location_id":"LOC-NL-TNM-001","evse_uid":"LOC-NL-TNM-001*E1","connector_id":"1","authorization_reference":"AUTH-REF-START-001"}'

Start Session 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

Start Session 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