OpenAPI reference

Sender Location

GET/locations/{location_id}/{evse_uid}/{connector_id}

Retrieve a specific Connector of an EVSE of a Location.

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

Overview

GET /locations/{location_id}/{evse_uid}/{connector_id}

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

Retrieve a specific Connector of an EVSE of a Location.

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.1.1/locations/LOC1/EVSE1/1' \
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.
`connector_id`	`string`	Yes	Connector.id of the Connector object.

Responses

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

`200` — successful response

application/json

Schema: ConnectorResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "id": "string",
7    "standard": {
8      "_type": "ConnectorType"
9    },
10    "format": {
11      "_type": "ConnectorFormat"
12    },
13    "power_type": {
14      "_type": "PowerType"
15    },
16    "voltage": 0,
17    "amperage": 0,
18    "tariff_id": "string",
19    "terms_and_conditions": "https://example.com",
20    "last_updated": "2024-01-15T10:00:00Z"
21  }
22}

`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}

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

OpenAPI reference

Sender Location

GET/locations/{location_id}/{evse_uid}/{connector_id}

Retrieve a specific Connector of an EVSE of a Location.

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

Overview

GET /locations/{location_id}/{evse_uid}/{connector_id}

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

Retrieve a specific Connector of an EVSE of a Location.

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.1.1/locations/LOC1/EVSE1/1' \
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.
`connector_id`	`string`	Yes	Connector.id of the Connector object.

Responses

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

`200` — successful response

application/json

Schema: ConnectorResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "id": "string",
7    "standard": {
8      "_type": "ConnectorType"
9    },
10    "format": {
11      "_type": "ConnectorFormat"
12    },
13    "power_type": {
14      "_type": "PowerType"
15    },
16    "voltage": 0,
17    "amperage": 0,
18    "tariff_id": "string",
19    "terms_and_conditions": "https://example.com",
20    "last_updated": "2024-01-15T10:00:00Z"
21  }
22}

`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}

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

Sender Location

Overview

How to call

Request

Path parameters

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`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

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page