OpenAPI reference

Receiver Session

PATCH/sessions/{country_code}/{party_id}/{session_id}

Same as the PUT method, but only the fields/objects that need to be updated have to be present.

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

Overview

PATCH /sessions/{country_code}/{party_id}/{session_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/sessions/{country_code}/{party_id}/{session_id}

Same as the PUT method, but only the fields/objects that need to be updated have to be present.

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/emsp/2.1.1/sessions/NL/ABC/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"kwh":14.1,"status":"COMPLETED","end_datetime":"2015-06-29T23:37:32Z","last_updated":"2015-06-29T23:37:32Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code of the party performing this request.
`party_id`	`string`	Yes	3-char party ID of the CPO or eMSP (ISO-15118).
`session_id`	`string`	Yes	Session.id of the Session object.

Request body

application/json · Required

Schema: SessionUpdate

Field	Type	Required	Description
`id`	`string`	No	—
`authorization_id`	`string`	No	—
`auth_id`	`string`	No	—
`auth_method`	`"AUTH_REQUEST"	"WHITELIST"`	No
`start_datetime`	`string (date-time)`	No	—
`end_datetime`	`string (date-time)`	No	—
`kwh`	`number`	No	—
`location`	`object`	No	—
`currency`	`string`	No	—
`total_cost`	`number`	No	—
`charging_periods`	`object[]`	No	—
`status`	`"ACTIVE"	"COMPLETED"	"INVALID"
`last_updated`	`string (date-time)`	No	—

Request examples

Example 1

1{
2  "kwh": 14.1,
3  "status": "COMPLETED",
4  "end_datetime": "2015-06-29T23:37:32Z",
5  "last_updated": "2015-06-29T23:37:32Z"
6}

Example 2

1{
2  "charging_periods": [
3    {
4      "start_date_time": "2015-07-01T08:00:00Z",
5      "dimensions": [
6        {
7          "type": "ENERGY",
8          "volume": 18.75
9        }
10      ]
11    }
12  ],
13  "last_updated": "2015-07-01T08:30:00Z"
14}

Responses

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

`200` — successful response

application/json

Schema: SessionResponse

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

Response example

1{
2  "data": {
3    "auth_id": "DE8ACC12E46L89",
4    "auth_method": "WHITELIST",
5    "authorization_id": "DE8ACC12E46L89",
6    "charging_periods": [
7      {
8        "dimensions": [
9          {
10            "type": "ENERGY",
11            "volume": 41
12          }
13        ],
14        "start_date_time": "2015-06-29T22:39:09Z"
15      }
16    ],
17    "currency": "EUR",
18    "end_datetime": "2015-06-29T23:50:16Z",
19    "id": "101",
20    "kwh": 41,
21    "last_updated": "2015-06-29T23:50:16Z",
22    "location": {
23      "address": "F.Rooseveltlaan 3A",
24      "city": "Gent",
25      "coordinates": {
26        "latitude": "51.047599",
27        "longitude": "3.729944"
28      },
29      "country": "BEL",
30      "evses": [
31        {
32          "connectors": [
33            {
34              "amperage": 64,
35              "format": "SOCKET",
36              "id": "1",
37              "last_updated": "2015-06-29T23:09:10Z",
38              "power_type": "AC_1_PHASE",
39              "standard": "IEC_62196_T2",
40              "tariff_id": "11",
41              "voltage": 230
42            }
43          ],
44          "evse_id": "BE-BEC-E041503003",
45          "last_updated": "2015-06-29T23:09:10Z",
46          "status": "AVAILABLE",
47          "uid": "3256"
48        }
49      ],
50      "id": "LOC1",
51      "last_updated": "2015-06-29T23:09:10Z",
52      "name": "Gent Zuid",
53      "postal_code": "9000",
54      "type": "ON_STREET"
55    },
56    "meter_id": "METER-001",
57    "start_datetime": "2015-06-29T22:39:09Z",
58    "status": "ACTIVE",
59    "total_cost": 10
60  },
61  "status_code": 1000,
62  "status_message": "Success",
63  "timestamp": "2015-06-29T22:39:09Z"
64}

`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 PATCH 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/sessions/NL/ABC/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"kwh":14.1,"status":"COMPLETED","end_datetime":"2015-06-29T23:37:32Z","last_updated":"2015-06-29T23:37:32Z"}'

OpenAPI reference

Receiver Session

PATCH/sessions/{country_code}/{party_id}/{session_id}

Same as the PUT method, but only the fields/objects that need to be updated have to be present.

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

Overview

PATCH /sessions/{country_code}/{party_id}/{session_id}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/sessions/{country_code}/{party_id}/{session_id}

Same as the PUT method, but only the fields/objects that need to be updated have to be present.

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/emsp/2.1.1/sessions/NL/ABC/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"kwh":14.1,"status":"COMPLETED","end_datetime":"2015-06-29T23:37:32Z","last_updated":"2015-06-29T23:37:32Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code of the party performing this request.
`party_id`	`string`	Yes	3-char party ID of the CPO or eMSP (ISO-15118).
`session_id`	`string`	Yes	Session.id of the Session object.

Request body

application/json · Required

Schema: SessionUpdate

Field	Type	Required	Description
`id`	`string`	No	—
`authorization_id`	`string`	No	—
`auth_id`	`string`	No	—
`auth_method`	`"AUTH_REQUEST"	"WHITELIST"`	No
`start_datetime`	`string (date-time)`	No	—
`end_datetime`	`string (date-time)`	No	—
`kwh`	`number`	No	—
`location`	`object`	No	—
`currency`	`string`	No	—
`total_cost`	`number`	No	—
`charging_periods`	`object[]`	No	—
`status`	`"ACTIVE"	"COMPLETED"	"INVALID"
`last_updated`	`string (date-time)`	No	—

Request examples

Example 1

1{
2  "kwh": 14.1,
3  "status": "COMPLETED",
4  "end_datetime": "2015-06-29T23:37:32Z",
5  "last_updated": "2015-06-29T23:37:32Z"
6}

Example 2

1{
2  "charging_periods": [
3    {
4      "start_date_time": "2015-07-01T08:00:00Z",
5      "dimensions": [
6        {
7          "type": "ENERGY",
8          "volume": 18.75
9        }
10      ]
11    }
12  ],
13  "last_updated": "2015-07-01T08:30:00Z"
14}

Responses

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

`200` — successful response

application/json

Schema: SessionResponse

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

Response example

1{
2  "data": {
3    "auth_id": "DE8ACC12E46L89",
4    "auth_method": "WHITELIST",
5    "authorization_id": "DE8ACC12E46L89",
6    "charging_periods": [
7      {
8        "dimensions": [
9          {
10            "type": "ENERGY",
11            "volume": 41
12          }
13        ],
14        "start_date_time": "2015-06-29T22:39:09Z"
15      }
16    ],
17    "currency": "EUR",
18    "end_datetime": "2015-06-29T23:50:16Z",
19    "id": "101",
20    "kwh": 41,
21    "last_updated": "2015-06-29T23:50:16Z",
22    "location": {
23      "address": "F.Rooseveltlaan 3A",
24      "city": "Gent",
25      "coordinates": {
26        "latitude": "51.047599",
27        "longitude": "3.729944"
28      },
29      "country": "BEL",
30      "evses": [
31        {
32          "connectors": [
33            {
34              "amperage": 64,
35              "format": "SOCKET",
36              "id": "1",
37              "last_updated": "2015-06-29T23:09:10Z",
38              "power_type": "AC_1_PHASE",
39              "standard": "IEC_62196_T2",
40              "tariff_id": "11",
41              "voltage": 230
42            }
43          ],
44          "evse_id": "BE-BEC-E041503003",
45          "last_updated": "2015-06-29T23:09:10Z",
46          "status": "AVAILABLE",
47          "uid": "3256"
48        }
49      ],
50      "id": "LOC1",
51      "last_updated": "2015-06-29T23:09:10Z",
52      "name": "Gent Zuid",
53      "postal_code": "9000",
54      "type": "ON_STREET"
55    },
56    "meter_id": "METER-001",
57    "start_datetime": "2015-06-29T22:39:09Z",
58    "status": "ACTIVE",
59    "total_cost": 10
60  },
61  "status_code": 1000,
62  "status_message": "Success",
63  "timestamp": "2015-06-29T22:39:09Z"
64}

`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 PATCH 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/sessions/NL/ABC/SESSION1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"kwh":14.1,"status":"COMPLETED","end_datetime":"2015-06-29T23:37:32Z","last_updated":"2015-06-29T23:37:32Z"}'

Receiver Session

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 Session

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