OpenAPI reference

Sender Location

GET/locations/{location_id}/{evse_uid}

Retrieve a specific EVSE object from the Sender (CPO).

API: OCPI 2.2.1 (CPO) · Module: Locations (CPO)
Base path: /locations · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

GET /locations/{location_id}/{evse_uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/locations/{location_id}/{evse_uid}

Retrieve a specific EVSE object from the Sender (CPO).

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/cpo/2.2.1/locations/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Path parameters

Name	Type	Required	Description
`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": "2024-01-15T10:00:00Z",
5  "data": {
6    "capabilities": [
7      "RFID_READER",
8      "REMOTE_START_STOP_CAPABLE"
9    ],
10    "connectors": [
11      {
12        "format": "SOCKET",
13        "id": "1",
14        "last_updated": "2024-01-15T10:00:00Z",
15        "max_amperage": 32,
16        "max_voltage": 400,
17        "power_type": "AC_3_PHASE",
18        "standard": "IEC_62196_T2",
19        "tariff_ids": [
20          "TARIFF-001"
21        ]
22      }
23    ],
24    "coordinates": {
25      "latitude": "51.04759",
26      "longitude": "3.72994"
27    },
28    "directions": [
29      {
30        "language": "en",
31        "text": "Near the entrance"
32      }
33    ],
34    "evse_id": "BE-BEC-E041503001",
35    "floor_level": "-1",
36    "images": [],
37    "last_updated": "2024-01-15T10:00:00Z",
38    "parking_restrictions": [
39      "EV_ONLY"
40    ],
41    "physical_reference": "3",
42    "status": "AVAILABLE",
43    "status_schedule": [],
44    "uid": "3256"
45  }
46}

`401` — unauthorized

application/json

Response example

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

`404` — not found

application/json

Response example

1{
2  "status_code": 2003,
3  "status_message": "Unknown location",
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/cpo/2.2.1/locations/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

OpenAPI reference

Sender Location

GET/locations/{location_id}/{evse_uid}

Retrieve a specific EVSE object from the Sender (CPO).

API: OCPI 2.2.1 (CPO) · Module: Locations (CPO)
Base path: /locations · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1

Overview

GET /locations/{location_id}/{evse_uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.2.1/locations/{location_id}/{evse_uid}

Retrieve a specific EVSE object from the Sender (CPO).

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/cpo/2.2.1/locations/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Request

Path parameters

Name	Type	Required	Description
`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": "2024-01-15T10:00:00Z",
5  "data": {
6    "capabilities": [
7      "RFID_READER",
8      "REMOTE_START_STOP_CAPABLE"
9    ],
10    "connectors": [
11      {
12        "format": "SOCKET",
13        "id": "1",
14        "last_updated": "2024-01-15T10:00:00Z",
15        "max_amperage": 32,
16        "max_voltage": 400,
17        "power_type": "AC_3_PHASE",
18        "standard": "IEC_62196_T2",
19        "tariff_ids": [
20          "TARIFF-001"
21        ]
22      }
23    ],
24    "coordinates": {
25      "latitude": "51.04759",
26      "longitude": "3.72994"
27    },
28    "directions": [
29      {
30        "language": "en",
31        "text": "Near the entrance"
32      }
33    ],
34    "evse_id": "BE-BEC-E041503001",
35    "floor_level": "-1",
36    "images": [],
37    "last_updated": "2024-01-15T10:00:00Z",
38    "parking_restrictions": [
39      "EV_ONLY"
40    ],
41    "physical_reference": "3",
42    "status": "AVAILABLE",
43    "status_schedule": [],
44    "uid": "3256"
45  }
46}

`401` — unauthorized

application/json

Response example

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

`404` — not found

application/json

Response example

1{
2  "status_code": 2003,
3  "status_message": "Unknown location",
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/cpo/2.2.1/locations/LOC1/EVSE1' \
2  -H "Authorization: Token $OCPI_TOKEN"

Sender 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

Sender 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