Documentation

Locations

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

POST/1/map/locations

Get locations by IDs

Retrieve specific locations by their IDs with optional status filtering

Request
Request bodyapplication/json
idsstring[]
statusstring[]
Responses
200Location details including EVSEs and tariffs application/json
dataobject[]

The locations with their additional charges and tariffs

country_codestring

The roaming partner country code of the location

party_idstring

The roaming partner party id of the location

idstring

The unique identifier of the location

publishboolean
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystring
externalIdstring

The raw location identifier as supplied by the CPO, without the countryCode:partyId prefix carried by id

cdrAdditionalChargesobject[]

The additional roaming based charges which may apply on sessions at this location

idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
price_componentsobject[]
restrictionsobject
tariffsobject[]

The tariffs in use by the connectors of this location

country_codestring
party_idstring
idstring
currencystring
typestring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
price_componentsobject[]
restrictionsobject
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
environ_impactobject[]
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
metaobject

Response metadata including total count

totalinteger

The total number of locations returned

400Invalid request parameters
No response body.
500Internal server error
No response body.
GET/1/map/locations/{locationId}

Get a single location

Retrieve a single location by its external id, optionally validating that the requested evse uid and connector id exist on it

Request
Path parameters1
locationIdstringREQUIRED
Responses
200Location details including EVSEs and tariffs application/json
country_codestring

The roaming partner country code of the location

party_idstring

The roaming partner party id of the location

idstring

The unique identifier of the location

publishboolean
publish_allowed_toobject[]
uidstring
typestring
visual_numberstring
issuerstring
group_idstring
namestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
related_locationsobject[]
latitudestring
longitudestring
parking_typestring
evsesobject[]
uidstring
evse_idstring
statusstring
status_scheduleobject[]
period_beginstring <date-time>
period_endstring <date-time>
statusstring
capabilitiesstring[]
connectorsobject[]
idstring
standardstring
formatstring
power_typestring
max_voltageinteger <int32>
max_amperageinteger <int32>
max_electric_powerinteger <int32>
tariff_idsstring[]
terms_and_conditionsstring
last_updatedobject
ocpp_statusstring
floor_levelstring
coordinatesobject
latitudestring
longitudestring
physical_referencestring
directionsobject[]
languagestring
textstring
parking_restrictionsstring[]
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
last_updatedobject
directionsobject[]
languagestring
textstring
operatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
suboperatorobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
ownerobject
namestring
websitestring
logoobject
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
facilitiesstring[]
time_zonestring
opening_timesobject
regular_hoursobject[]
weekdayinteger <int32>
period_beginstring
period_endstring
twentyfoursevenboolean
exceptional_openingsobject[]
period_beginstring
period_endstring
exceptional_closingsobject[]
period_beginstring
period_endstring
charging_when_closedboolean
imagesobject[]
urlstring
thumbnailstring
categorystring
typestring
widthinteger <int32>
heightinteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
charging_accessibilitystring
externalIdstring

The raw location identifier as supplied by the CPO, without the countryCode:partyId prefix carried by id

cdrAdditionalChargesobject[]

The additional roaming based charges which may apply on sessions at this location

idstring
labelstring
typestring
targetstring
pricestring
tariff_elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
tariffsobject[]

The tariffs in use by the connectors of this location

country_codestring
party_idstring
idstring
currencystring
typestring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
min_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
max_priceobject
excl_vatnumber <double>
incl_vatnumber <double>
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
vatnumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_currentnumber <double>
max_currentnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
reservationstring
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
start_date_timestring <date-time>
end_date_timestring <date-time>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
categorystring
amountnumber <double>
supplier_namestring
energy_product_namestring
last_updatedstring <date-time>
404Location, evse or connector not found
No response body.
500Internal server error
No response body.