Skip to navigation

Create a location

Creates a location under your OCPI party. A location id is never reused, even after the location is deleted.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
location_idstringRequired1-36 characters
addressstringRequired1-45 characters
citystringRequired1-45 characters
countrystringRequiredformat: "^[A-Z]{3}$"=3 characters
coordinatesobjectRequired
time_zonestringRequired1-255 characters
namestring or nullOptional<=255 characters
postal_codestring or nullOptional<=10 characters
statestring or nullOptional<=20 characters
parking_typeenum or nullOptional

Allowed parking_type values on ocpp.ocpp_locations.

facilitieslist of strings or nullOptional
opening_timesobject or nullOptional
charging_when_closedboolean or nullOptional
publishboolean or nullOptionalDefaults to false
publish_allowed_tolist of objects or nullOptional
related_locationslist of objects or nullOptional
parking_placeslist of objects or nullOptional
directionslist of objects or nullOptional
operatorobject or nullOptional
suboperatorobject or nullOptional
ownerobject or nullOptional
imageslist of objects or nullOptional
energy_mixobject or nullOptional
help_phonestring or nullOptional<=25 characters

Response

The created object.
idinteger
location_idstring
publishboolean
addressstring
citystring
countrystring
coordinatesobject
time_zonestring
last_updateddatetime
revisioninteger
roleenum or any
originenum or any
country_codestring
party_idstring
ocpi_versionenum or any
organization_idstring
created_atdatetime
updated_atdatetime
publish_allowed_tolist of objects or nullOptional
namestring or nullOptional
postal_codestring or nullOptional
statestring or nullOptional
related_locationslist of objects or nullOptional
parking_typeenum or any or nullOptional
parking_placeslist of objects or nullOptional
directionslist of objects or nullOptional
operatorobject or nullOptional
suboperatorobject or nullOptional
ownerobject or nullOptional
facilitieslist of strings or nullOptional
opening_timesobject or nullOptional
charging_when_closedboolean or nullOptional
imageslist of objects or nullOptional
energy_mixobject or nullOptional
help_phonestring or nullOptional
ocpp_versionstring or nullOptional

Errors

401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error