OpenAPI reference

Receiver Connector

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

Push a new or updated Connector object. Path ``connector_id`` MUST equal ``body.id`` (2001 on mismatch).

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

Overview

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

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

Push a new or updated Connector object. Path connector_id MUST equal body.id (2001 on mismatch).

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.2.1/locations/NL/ABC/LOC1/EVSE1/1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","max_voltage":220,"max_amperage":16,"tariff_ids":["11"],"last_updated":"2015-06-29T21:39:01Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).
`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.

Request body

application/json · Required

Schema: Connector

Field	Type	Required	Description
`id`	`string`	Yes	—
`standard`	`"CHADEMO"	"CHAOJI"	"DOMESTIC_A"
`format`	`"SOCKET"	"CABLE"`	Yes
`power_type`	`"AC_1_PHASE"	"AC_2_PHASE"	"AC_2_PHASE_SPLIT"
`max_voltage`	`integer`	Yes	—
`max_amperage`	`integer`	Yes	—
`max_electric_power`	`integer`	No	—
`tariff_ids`	`string[]`	No	—
`terms_and_conditions`	`string`	No	—
`last_updated`	`string (date-time)`	Yes	—

Request example

1{
2  "id": "1",
3  "standard": "IEC_62196_T2",
4  "format": "CABLE",
5  "power_type": "AC_3_PHASE",
6  "max_voltage": 220,
7  "max_amperage": 16,
8  "tariff_ids": [
9    "11"
10  ],
11  "last_updated": "2015-06-29T21:39:01Z"
12}

Responses

Status	Description	Schema
`200`	Successful Response	`ConnectorResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`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": "2024-01-15T10:00:00Z",
5  "data": {
6    "format": "SOCKET",
7    "id": "1",
8    "last_updated": "2024-01-15T10:00:00Z",
9    "max_amperage": 32,
10    "max_electric_power": 22000,
11    "max_voltage": 400,
12    "power_type": "AC_3_PHASE",
13    "standard": "IEC_62196_T2",
14    "tariff_ids": [
15      "TARIFF-001"
16    ],
17    "terms_and_conditions": "https://example.com/terms"
18  }
19}

`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": 2001,
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.2.1/locations/NL/ABC/LOC1/EVSE1/1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","max_voltage":220,"max_amperage":16,"tariff_ids":["11"],"last_updated":"2015-06-29T21:39:01Z"}'

OpenAPI reference

Receiver Connector

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

Push a new or updated Connector object. Path ``connector_id`` MUST equal ``body.id`` (2001 on mismatch).

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

Overview

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

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

Push a new or updated Connector object. Path connector_id MUST equal body.id (2001 on mismatch).

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.2.1/locations/NL/ABC/LOC1/EVSE1/1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","max_voltage":220,"max_amperage":16,"tariff_ids":["11"],"last_updated":"2015-06-29T21:39:01Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code (uppercase).
`party_id`	`string`	Yes	CPO/eMSP party ID (ISO-15118, 3 uppercase alphanumerics).
`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.

Request body

application/json · Required

Schema: Connector

Field	Type	Required	Description
`id`	`string`	Yes	—
`standard`	`"CHADEMO"	"CHAOJI"	"DOMESTIC_A"
`format`	`"SOCKET"	"CABLE"`	Yes
`power_type`	`"AC_1_PHASE"	"AC_2_PHASE"	"AC_2_PHASE_SPLIT"
`max_voltage`	`integer`	Yes	—
`max_amperage`	`integer`	Yes	—
`max_electric_power`	`integer`	No	—
`tariff_ids`	`string[]`	No	—
`terms_and_conditions`	`string`	No	—
`last_updated`	`string (date-time)`	Yes	—

Request example

1{
2  "id": "1",
3  "standard": "IEC_62196_T2",
4  "format": "CABLE",
5  "power_type": "AC_3_PHASE",
6  "max_voltage": 220,
7  "max_amperage": 16,
8  "tariff_ids": [
9    "11"
10  ],
11  "last_updated": "2015-06-29T21:39:01Z"
12}

Responses

Status	Description	Schema
`200`	Successful Response	`ConnectorResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`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": "2024-01-15T10:00:00Z",
5  "data": {
6    "format": "SOCKET",
7    "id": "1",
8    "last_updated": "2024-01-15T10:00:00Z",
9    "max_amperage": 32,
10    "max_electric_power": 22000,
11    "max_voltage": 400,
12    "power_type": "AC_3_PHASE",
13    "standard": "IEC_62196_T2",
14    "tariff_ids": [
15      "TARIFF-001"
16    ],
17    "terms_and_conditions": "https://example.com/terms"
18  }
19}

`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": 2001,
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.2.1/locations/NL/ABC/LOC1/EVSE1/1' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"1","standard":"IEC_62196_T2","format":"CABLE","power_type":"AC_3_PHASE","max_voltage":220,"max_amperage":16,"tariff_ids":["11"],"last_updated":"2015-06-29T21:39:01Z"}'

Receiver Connector

Overview

How to call

Request

Path parameters

Request body

Request example

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 Connector

Overview

How to call

Request

Path parameters

Request body

Request example

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