CPO Locations

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

No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.

POST/2/locations/cpo

Create Location

Authorization
User sessionAPI credential
Permissions
cpo-locations:write
OAuth
-
Request
Request bodyapplication/json
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimburse
accountIdstringREQUIRED
accountLegacyIdstring
addressstringREQUIRED
billingPolicyobject
subscriptionBillingobject[]REQUIRED
entityobject
accountIdstring
typestringREQUIRED
accountuser
userIdstring
percentagenumber
min 0max 100
usageReimbursementobject | object | object | object[]REQUIRED
citystringREQUIRED
countrystringREQUIRED
facilitatorAccountIdstring | null
facilitiesstring[]
geoLocationobject
coordinatesnumber[]
typestring
legacyIdstring
namestringREQUIRED
opening_timesobject | null
exceptional_closingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
exceptional_openingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
regular_hoursobject[]
period_beginstringREQUIRED
period_endstringREQUIRED
weekdaynumberREQUIRED
min 1max 7
twentyfoursevenboolean
parking_typestring
postal_codestringREQUIRED
publishingModestring
userEmailstring <email>
userIdstring
Responses
200OK application/json
dataLocationResource
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
accountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursement
userIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2
typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomsp
providerIdstringREQUIRED
publishingModestring
privatepublic
sourcestringREQUIRED
cpoeclearingocpiroad-cpo-internal
statusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/2/locations/cpo/search

Search Locations

Authorization
User sessionAPI credential
Permissions
cpo-locations:read
OAuth
-
Request
Request bodyapplication/json
accessPolicystring
accountIdstring
createdAtobject
$eqnumber | string <date-time>
$gtenumber | string <date-time>
$ltenumber | string <date-time>
filenamestring
default locations-cpo.csv
formatstring
default json
fromstring <date-time>
hasErrorsboolean
idstring
idsstring[]
importIdstring
limitnumber
default 50
localestring
namestring
searchIdstring
searchPhrasestring
shallowboolean
default false
skipnumber
default 0
sortobject
default {"field":"createdAt","order":"desc"}
fieldstringREQUIRED
orderstringREQUIRED
ascdesc
tostring <date-time>
Responses
200OK application/json
dataLocationResource[]REQUIRED
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
accountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursement
userIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2
typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomsp
providerIdstringREQUIRED
publishingModestring
privatepublic
sourcestringREQUIRED
cpoeclearingocpiroad-cpo-internal
statusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobjectREQUIRED
limitnumberREQUIRED
skipnumberREQUIRED
totalnumberREQUIRED
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/2/locations/cpo/{location}

Get Location

Authorization
User sessionAPI credential
Permissions
cpo-locations:read
OAuth
-
Request
Path parameters1
locationstringREQUIRED
Responses
200OK application/json
dataLocationResource
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
accountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursement
userIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2
typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomsp
providerIdstringREQUIRED
publishingModestring
privatepublic
sourcestringREQUIRED
cpoeclearingocpiroad-cpo-internal
statusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PATCH/2/locations/cpo/{location}

Update Location

Authorization
User sessionAPI credential
Permissions
cpo-locations:write
OAuth
-
Request
Path parameters1
locationstringREQUIRED
Request bodyapplication/json
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimburse
accountIdstringREQUIRED
accountLegacyIdstring
addressstringREQUIRED
billingPolicyobject
subscriptionBillingobject[]REQUIRED
entityobject
accountIdstring
typestringREQUIRED
accountuser
userIdstring
percentagenumber
min 0max 100
usageReimbursementobject | object | object | object[]REQUIRED
citystringREQUIRED
countrystringREQUIRED
facilitatorAccountIdstring | null
facilitiesstring[]
geoLocationobject
coordinatesnumber[]
typestring
legacyIdstring
namestringREQUIRED
opening_timesobject | null
exceptional_closingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
exceptional_openingsobject[]
period_beginstring <date-time>REQUIRED
period_endstring <date-time>REQUIRED
regular_hoursobject[]
period_beginstringREQUIRED
period_endstringREQUIRED
weekdaynumberREQUIRED
min 1max 7
twentyfoursevenboolean
parking_typestring
postal_codestringREQUIRED
publishingModestring
suboperatorobject
namestring | null
userEmailstring <email>
userIdstring
Responses
200OK application/json
dataLocationResource
accessPolicystringREQUIRED
businessReimbursecommunityReimburseemployeeReimbursenoReimbursesplitReimburse
accountobject
accountIdstring
addressstring
auditEntiresboolean
billingPolicyobject
charging_when_closedboolean
citystring
connectorTypesstring[]
coordinatesobject
countrystring
countryCodestring
creditBillingTargetobject[]
accountIdstring
percentagenumber
typestring
creditreimbursement
userIdstring
deletedboolean
deletedAtstring <date-time>
eclearingExternalIdstring
energyDeliveryAreastring
evseIdsstring[]
evsesobject[]
facilitatorAccountIdstring
facilitiesstring[]
geoLocationobject
coordinatesobjectREQUIRED
0numberREQUIRED
1numberREQUIRED
lengthnumberREQUIRED
2
typestringREQUIRED
hasTariffInfoboolean
idstringREQUIRED
importsobject
importIdsstring[]REQUIRED
referencestringREQUIRED
infraProviderIdstring
isPublishedboolean
last_updatedstring <date-time>
legacyIdstring
maxPowernumber
migrationAtstring <date-time>
migrationIdstring
minPowernumber
namestringREQUIRED
numericIdentitynumber
ocpiCredentialsIdstring
ocpiCredentialsNamestring
ocpiCredentialsVersionUrlstring
ocpiExternalIdstring
opening_timesobject
parking_typestring
postalCodestring
postal_codestring
powerTypestring
providerContextstringREQUIRED
cpomsp
providerIdstringREQUIRED
publishingModestring
privatepublic
sourcestringREQUIRED
cpoeclearingocpiroad-cpo-internal
statusstring
suboperatorobject
syncEclearingStatusobject
syncOcpiCredentialIdsstring[]
syncOcpiStatusobject
timestampsboolean
timezonestring
typestring
userobject
userIdstring
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/2/locations/cpo/{location}

Delete Location

Authorization
User sessionAPI credential
Permissions
cpo-locations:write
OAuth
-
Request
Path parameters1
locationstringREQUIRED
Responses
200OK application/json
No response body.
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED