OpenAPI reference

Receiver Location

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

Retrieve an EVSE as it is stored in the eMSP system.

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

GET /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}

Retrieve an EVSE as it is stored in the eMSP system.

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 GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

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.

Responses

Status	Description	Schema
`200`	Successful Response	`EvseResponse`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`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}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2000,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Resource not found",
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 GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

OpenAPI reference

Receiver Location

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

Retrieve an EVSE as it is stored in the eMSP system.

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

GET /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}

Retrieve an EVSE as it is stored in the eMSP system.

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 GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

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.

Responses

Status	Description	Schema
`200`	Successful Response	`EvseResponse`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`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}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2000,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Resource not found",
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 GET 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/locations/NL/ABC/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Receiver Location

Overview

How to call

Request

Path parameters

Responses

`200` — successful response

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Receiver Location

Overview

How to call

Request

Path parameters

Responses

`200` — successful response

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page