OpenAPI reference

Receiver Location

PUT/locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Push new/updated EVSE object to the eMSP.

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

Overview

PUT /locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Push new/updated EVSE object to the eMSP.

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 PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"3256","evse_id":"BE-BEC-E041503001","status":"AVAILABLE","connectors":[{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","voltage":220,"amperage":16,"last_updated":"2015-06-29T21:39:01Z"}],"last_updated":"2015-06-29T21:39:01Z"}'

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).
`location_id`	`string`	Yes	Location.id of the Location object.
`evse_uid`	`string`	Yes	EVSE.uid of the EVSE object.

Request body

application/json · Required

Schema: EVSE

Field	Type	Required	Description
`uid`	`string`	Yes	—
`evse_id`	`string`	No	—
`status`	`"AVAILABLE"	"BLOCKED"	"CHARGING"
`status_schedule`	`StatusSchedule[]`	No	—
`capabilities`	`"CHARGING_PROFILE_CAPABLE"	"CREDIT_CARD_PAYABLE"	"REMOTE_START_STOP_CAPABLE"
`connectors`	`Connector[]`	Yes	`Connectors`
`floor_level`	`string`	No	—
`coordinates`	`GeoLocation`	No	`GeoLocation`
`physical_reference`	`string`	No	—
`parking_restrictions`	`"EV_ONLY"	"PLUGGED"	"DISABLED"
`directions`	`DisplayText[]`	No	—
`images`	`Image[]`	No	—
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "uid": "3256",
3  "evse_id": "BE-BEC-E041503001",
4  "status": "AVAILABLE",
5  "connectors": [
6    {
7      "id": "1",
8      "standard": "IEC_62196_T2",
9      "format": "CABLE",
10      "power_type": "AC_3_PHASE",
11      "voltage": 220,
12      "amperage": 16,
13      "last_updated": "2015-06-29T21:39:01Z"
14    }
15  ],
16  "last_updated": "2015-06-29T21:39:01Z"
17}

Example 2

1{
2  "uid": "EVSE-UTR-1",
3  "status": "CHARGING",
4  "capabilities": [
5    "REMOTE_START_STOP_CAPABLE",
6    "UNLOCK_CAPABLE"
7  ],
8  "connectors": [
9    {
10      "id": "1",
11      "standard": "IEC_62196_T2",
12      "format": "SOCKET",
13      "power_type": "AC_3_PHASE",
14      "voltage": 400,
15      "amperage": 32,
16      "last_updated": "2015-07-01T08:00:00Z"
17    }
18  ],
19  "last_updated": "2015-07-01T08:00:00Z"
20}

Responses

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

`200` — successful response

application/json

Schema: EvseResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "uid": "string",
7    "evse_id": "string",
8    "status": {
9      "_type": "EvseStatus"
10    },
11    "status_schedule": [
12      {
13        "_type": "StatusSchedule"
14      }
15    ],
16    "capabilities": [
17      {
18        "_type": "Capability"
19      }
20    ],
21    "connectors": [
22      {
23        "_type": "Connector"
24      }
25    ],
26    "floor_level": "string",
27    "coordinates": {
28      "_type": "GeoLocation"
29    },
30    "physical_reference": "string",
31    "last_updated": "2024-01-15T10:00:00Z"
32  }
33}

`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 PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"3256","evse_id":"BE-BEC-E041503001","status":"AVAILABLE","connectors":[{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","voltage":220,"amperage":16,"last_updated":"2015-06-29T21:39:01Z"}],"last_updated":"2015-06-29T21:39:01Z"}'

OpenAPI reference

Receiver Location

PUT/locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Push new/updated EVSE object to the eMSP.

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

Overview

PUT /locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}

Push new/updated EVSE object to the eMSP.

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 PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"3256","evse_id":"BE-BEC-E041503001","status":"AVAILABLE","connectors":[{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","voltage":220,"amperage":16,"last_updated":"2015-06-29T21:39:01Z"}],"last_updated":"2015-06-29T21:39:01Z"}'

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).
`location_id`	`string`	Yes	Location.id of the Location object.
`evse_uid`	`string`	Yes	EVSE.uid of the EVSE object.

Request body

application/json · Required

Schema: EVSE

Field	Type	Required	Description
`uid`	`string`	Yes	—
`evse_id`	`string`	No	—
`status`	`"AVAILABLE"	"BLOCKED"	"CHARGING"
`status_schedule`	`StatusSchedule[]`	No	—
`capabilities`	`"CHARGING_PROFILE_CAPABLE"	"CREDIT_CARD_PAYABLE"	"REMOTE_START_STOP_CAPABLE"
`connectors`	`Connector[]`	Yes	`Connectors`
`floor_level`	`string`	No	—
`coordinates`	`GeoLocation`	No	`GeoLocation`
`physical_reference`	`string`	No	—
`parking_restrictions`	`"EV_ONLY"	"PLUGGED"	"DISABLED"
`directions`	`DisplayText[]`	No	—
`images`	`Image[]`	No	—
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "uid": "3256",
3  "evse_id": "BE-BEC-E041503001",
4  "status": "AVAILABLE",
5  "connectors": [
6    {
7      "id": "1",
8      "standard": "IEC_62196_T2",
9      "format": "CABLE",
10      "power_type": "AC_3_PHASE",
11      "voltage": 220,
12      "amperage": 16,
13      "last_updated": "2015-06-29T21:39:01Z"
14    }
15  ],
16  "last_updated": "2015-06-29T21:39:01Z"
17}

Example 2

1{
2  "uid": "EVSE-UTR-1",
3  "status": "CHARGING",
4  "capabilities": [
5    "REMOTE_START_STOP_CAPABLE",
6    "UNLOCK_CAPABLE"
7  ],
8  "connectors": [
9    {
10      "id": "1",
11      "standard": "IEC_62196_T2",
12      "format": "SOCKET",
13      "power_type": "AC_3_PHASE",
14      "voltage": 400,
15      "amperage": 32,
16      "last_updated": "2015-07-01T08:00:00Z"
17    }
18  ],
19  "last_updated": "2015-07-01T08:00:00Z"
20}

Responses

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

`200` — successful response

application/json

Schema: EvseResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "uid": "string",
7    "evse_id": "string",
8    "status": {
9      "_type": "EvseStatus"
10    },
11    "status_schedule": [
12      {
13        "_type": "StatusSchedule"
14      }
15    ],
16    "capabilities": [
17      {
18        "_type": "Capability"
19      }
20    ],
21    "connectors": [
22      {
23        "_type": "Connector"
24      }
25    ],
26    "floor_level": "string",
27    "coordinates": {
28      "_type": "GeoLocation"
29    },
30    "physical_reference": "string",
31    "last_updated": "2024-01-15T10:00:00Z"
32  }
33}

`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 PUT 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"3256","evse_id":"BE-BEC-E041503001","status":"AVAILABLE","connectors":[{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","voltage":220,"amperage":16,"last_updated":"2015-06-29T21:39:01Z"}],"last_updated":"2015-06-29T21:39:01Z"}'

Receiver Location

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 Location

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