OpenAPI reference

Receiver Location

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

Push new/updated Location 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}

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

Push new/updated Location 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' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"LOC1","type":"ON_STREET","name":"Gent Zuid","address":"F.Rooseveltlaan 3A","city":"Gent","postal_code":"9000","country":"BEL","coordinates":{"latitude":"51.047599","longitude":"3.729944"},"evses":[{"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,"tariff_id":"11","last_updated":"2015-03-16T10:10:02Z"}],"last_updated":"2015-06-28T08:12:01Z"}],"operator":{"name":"BeCharged"},"last_updated":"2015-06-29T20:39:09Z"}'

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.

Request body

application/json · Required

Schema: Location

Field	Type	Required	Description
`id`	`string`	Yes	—
`type`	`"ON_STREET"	"PARKING_GARAGE"	"UNDERGROUND_GARAGE"
`name`	`string`	No	—
`address`	`string`	Yes	—
`city`	`string`	Yes	—
`postal_code`	`string`	Yes	—
`country`	`string`	Yes	—
`coordinates`	`GeoLocation`	Yes	`GeoLocation`
`related_locations`	`AdditionalGeoLocation[]`	No	—
`evses`	`EVSE[]`	No	—
`directions`	`DisplayText[]`	No	—
`operator`	`BusinessDetails`	No	`BusinessDetails`
`suboperator`	`BusinessDetails`	No	`BusinessDetails`
`owner`	`BusinessDetails`	No	`BusinessDetails`
`facilities`	`"HOTEL"	"RESTAURANT"	"CAFE"
`time_zone`	`string`	No	—
`opening_times`	`Hours`	No	`Hours`
`charging_when_closed`	`boolean`	No	—
`images`	`Image[]`	No	—
`energy_mix`	`EnergyMix`	No	`EnergyMix`
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "id": "LOC1",
3  "type": "ON_STREET",
4  "name": "Gent Zuid",
5  "address": "F.Rooseveltlaan 3A",
6  "city": "Gent",
7  "postal_code": "9000",
8  "country": "BEL",
9  "coordinates": {
10    "latitude": "51.047599",
11    "longitude": "3.729944"
12  },
13  "evses": [
14    {
15      "uid": "3256",
16      "evse_id": "BE-BEC-E041503001",
17      "status": "AVAILABLE",
18      "connectors": [
19        {
20          "id": "1",
21          "standard": "IEC_62196_T2",
22          "format": "CABLE",
23          "power_type": "AC_3_PHASE",
24          "voltage": 220,
25          "amperage": 16,
26          "tariff_id": "11",
27          "last_updated": "2015-03-16T10:10:02Z"
28        }
29      ],
30      "last_updated": "2015-06-28T08:12:01Z"
31    }
32  ],
33  "operator": {
34    "name": "BeCharged"
35  },
36  "last_updated": "2015-06-29T20:39:09Z"
37}

Example 2

1{
2  "id": "LOC2",
3  "type": "PARKING_GARAGE",
4  "name": "Central Station Garage",
5  "address": "Stationsplein 1",
6  "city": "Utrecht",
7  "postal_code": "3511AA",
8  "country": "NLD",
9  "coordinates": {
10    "latitude": "52.089444",
11    "longitude": "5.110278"
12  },
13  "evses": [
14    {
15      "uid": "EVSE-UTR-1",
16      "status": "AVAILABLE",
17      "connectors": [
18        {
19          "id": "1",
20          "standard": "IEC_62196_T2",
21          "format": "SOCKET",
22          "power_type": "AC_3_PHASE",
23          "voltage": 400,
24          "amperage": 32,
25          "last_updated": "2015-07-01T07:59:00Z"
26        }
27      ],
28      "last_updated": "2015-07-01T07:59:00Z"
29    }
30  ],
31  "operator": {
32    "name": "RailCharge"
33  },
34  "last_updated": "2015-07-01T07:59:00Z"
35}

Responses

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

`200` — successful response

application/json

Schema: LocationResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "address": "F.Rooseveltlaan 3A",
7    "charging_when_closed": true,
8    "city": "Gent",
9    "coordinates": {
10      "latitude": "51.047599",
11      "longitude": "3.729944"
12    },
13    "country": "BEL",
14    "directions": [
15      {
16        "language": "en",
17        "text": "Enter via main gate"
18      }
19    ],
20    "energy_mix": {
21      "energy_sources": [
22        {
23          "percentage": 100,
24          "source": "SOLAR"
25        }
26      ],
27      "is_green_energy": true
28    },
29    "evses": [
30      {
31        "connectors": [
32          {
33            "amperage": 64,
34            "format": "SOCKET",
35            "id": "1",
36            "last_updated": "2015-03-16T10:10:02Z",
37            "power_type": "AC_1_PHASE",
38            "standard": "IEC_62196_T2",
39            "tariff_id": "11",
40            "voltage": 230
41          }
42        ],
43        "evse_id": "BE-BEC-E041503003",
44        "floor_level": "-1",
45        "last_updated": "2015-06-28T08:12:01Z",
46        "physical_reference": "1",
47        "status": "AVAILABLE",
48        "uid": "3256"
49      }
50    ],
51    "facilities": [
52      "BUS_STOP"
53    ],
54    "id": "LOC1",
55    "images": [],
56    "last_updated": "2015-06-29T20:39:09Z",
57    "name": "Gent Zuid",
58    "opening_times": {
59      "twentyfourseven": true
60    },
61    "operator": {
62      "name": "BeCharged"
63    },
64    "owner": {
65      "name": "Gent Municipality"
66    },
67    "postal_code": "9000",
68    "related_locations": [],
69    "suboperator": {
70      "name": "BeCharged Sub"
71    },
72    "time_zone": "Europe/Brussels",
73    "type": "ON_STREET"
74  }
75}

`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' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"LOC1","type":"ON_STREET","name":"Gent Zuid","address":"F.Rooseveltlaan 3A","city":"Gent","postal_code":"9000","country":"BEL","coordinates":{"latitude":"51.047599","longitude":"3.729944"},"evses":[{"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,"tariff_id":"11","last_updated":"2015-03-16T10:10:02Z"}],"last_updated":"2015-06-28T08:12:01Z"}],"operator":{"name":"BeCharged"},"last_updated":"2015-06-29T20:39:09Z"}'

OpenAPI reference

Receiver Location

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

Push new/updated Location 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}

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

Push new/updated Location 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' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"LOC1","type":"ON_STREET","name":"Gent Zuid","address":"F.Rooseveltlaan 3A","city":"Gent","postal_code":"9000","country":"BEL","coordinates":{"latitude":"51.047599","longitude":"3.729944"},"evses":[{"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,"tariff_id":"11","last_updated":"2015-03-16T10:10:02Z"}],"last_updated":"2015-06-28T08:12:01Z"}],"operator":{"name":"BeCharged"},"last_updated":"2015-06-29T20:39:09Z"}'

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.

Request body

application/json · Required

Schema: Location

Field	Type	Required	Description
`id`	`string`	Yes	—
`type`	`"ON_STREET"	"PARKING_GARAGE"	"UNDERGROUND_GARAGE"
`name`	`string`	No	—
`address`	`string`	Yes	—
`city`	`string`	Yes	—
`postal_code`	`string`	Yes	—
`country`	`string`	Yes	—
`coordinates`	`GeoLocation`	Yes	`GeoLocation`
`related_locations`	`AdditionalGeoLocation[]`	No	—
`evses`	`EVSE[]`	No	—
`directions`	`DisplayText[]`	No	—
`operator`	`BusinessDetails`	No	`BusinessDetails`
`suboperator`	`BusinessDetails`	No	`BusinessDetails`
`owner`	`BusinessDetails`	No	`BusinessDetails`
`facilities`	`"HOTEL"	"RESTAURANT"	"CAFE"
`time_zone`	`string`	No	—
`opening_times`	`Hours`	No	`Hours`
`charging_when_closed`	`boolean`	No	—
`images`	`Image[]`	No	—
`energy_mix`	`EnergyMix`	No	`EnergyMix`
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "id": "LOC1",
3  "type": "ON_STREET",
4  "name": "Gent Zuid",
5  "address": "F.Rooseveltlaan 3A",
6  "city": "Gent",
7  "postal_code": "9000",
8  "country": "BEL",
9  "coordinates": {
10    "latitude": "51.047599",
11    "longitude": "3.729944"
12  },
13  "evses": [
14    {
15      "uid": "3256",
16      "evse_id": "BE-BEC-E041503001",
17      "status": "AVAILABLE",
18      "connectors": [
19        {
20          "id": "1",
21          "standard": "IEC_62196_T2",
22          "format": "CABLE",
23          "power_type": "AC_3_PHASE",
24          "voltage": 220,
25          "amperage": 16,
26          "tariff_id": "11",
27          "last_updated": "2015-03-16T10:10:02Z"
28        }
29      ],
30      "last_updated": "2015-06-28T08:12:01Z"
31    }
32  ],
33  "operator": {
34    "name": "BeCharged"
35  },
36  "last_updated": "2015-06-29T20:39:09Z"
37}

Example 2

1{
2  "id": "LOC2",
3  "type": "PARKING_GARAGE",
4  "name": "Central Station Garage",
5  "address": "Stationsplein 1",
6  "city": "Utrecht",
7  "postal_code": "3511AA",
8  "country": "NLD",
9  "coordinates": {
10    "latitude": "52.089444",
11    "longitude": "5.110278"
12  },
13  "evses": [
14    {
15      "uid": "EVSE-UTR-1",
16      "status": "AVAILABLE",
17      "connectors": [
18        {
19          "id": "1",
20          "standard": "IEC_62196_T2",
21          "format": "SOCKET",
22          "power_type": "AC_3_PHASE",
23          "voltage": 400,
24          "amperage": 32,
25          "last_updated": "2015-07-01T07:59:00Z"
26        }
27      ],
28      "last_updated": "2015-07-01T07:59:00Z"
29    }
30  ],
31  "operator": {
32    "name": "RailCharge"
33  },
34  "last_updated": "2015-07-01T07:59:00Z"
35}

Responses

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

`200` — successful response

application/json

Schema: LocationResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "address": "F.Rooseveltlaan 3A",
7    "charging_when_closed": true,
8    "city": "Gent",
9    "coordinates": {
10      "latitude": "51.047599",
11      "longitude": "3.729944"
12    },
13    "country": "BEL",
14    "directions": [
15      {
16        "language": "en",
17        "text": "Enter via main gate"
18      }
19    ],
20    "energy_mix": {
21      "energy_sources": [
22        {
23          "percentage": 100,
24          "source": "SOLAR"
25        }
26      ],
27      "is_green_energy": true
28    },
29    "evses": [
30      {
31        "connectors": [
32          {
33            "amperage": 64,
34            "format": "SOCKET",
35            "id": "1",
36            "last_updated": "2015-03-16T10:10:02Z",
37            "power_type": "AC_1_PHASE",
38            "standard": "IEC_62196_T2",
39            "tariff_id": "11",
40            "voltage": 230
41          }
42        ],
43        "evse_id": "BE-BEC-E041503003",
44        "floor_level": "-1",
45        "last_updated": "2015-06-28T08:12:01Z",
46        "physical_reference": "1",
47        "status": "AVAILABLE",
48        "uid": "3256"
49      }
50    ],
51    "facilities": [
52      "BUS_STOP"
53    ],
54    "id": "LOC1",
55    "images": [],
56    "last_updated": "2015-06-29T20:39:09Z",
57    "name": "Gent Zuid",
58    "opening_times": {
59      "twentyfourseven": true
60    },
61    "operator": {
62      "name": "BeCharged"
63    },
64    "owner": {
65      "name": "Gent Municipality"
66    },
67    "postal_code": "9000",
68    "related_locations": [],
69    "suboperator": {
70      "name": "BeCharged Sub"
71    },
72    "time_zone": "Europe/Brussels",
73    "type": "ON_STREET"
74  }
75}

`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' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"id":"LOC1","type":"ON_STREET","name":"Gent Zuid","address":"F.Rooseveltlaan 3A","city":"Gent","postal_code":"9000","country":"BEL","coordinates":{"latitude":"51.047599","longitude":"3.729944"},"evses":[{"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,"tariff_id":"11","last_updated":"2015-03-16T10:10:02Z"}],"last_updated":"2015-06-28T08:12:01Z"}],"operator":{"name":"BeCharged"},"last_updated":"2015-06-29T20:39:09Z"}'

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