Skip to content
CleverEV Docs

List locations

POST
/api/locations/list

Lists locations under the selected namespace.

Parameters

Header Parameters

x-compatibility-date
required
string
Allowed values: 2024-04-03

Request Body required

object
where
required
object
coordinates
object
latitude
required
Any of:
number
>= -9007199254740991 <= 9007199254740991
longitude
required
Any of:
number
>= -9007199254740991 <= 9007199254740991
chargers
object
type
Any of:
string
Allowed values: Private Public
status
Any of:
string
Allowed values: Available Preparing Charging SuspendedEVSE SuspendedEV Finishing Reserved Unavailable Faulted
plugncharge
boolean
connectors
object
type
Any of:
string
Allowed values: J1772_Type1 Mennekes_Type2 GBT_AC Tesla CCS1 CCS2 CHAdeMO GBT_DC Other
status
Any of:
string
Allowed values: Available Preparing Charging SuspendedEVSE SuspendedEV Finishing Reserved Unavailable Faulted
power
Any of:
number
>= -9007199254740991 <= 9007199254740991
current
Any of:
number
>= -9007199254740991 <= 9007199254740991
pagination
object
skip
integer
>= -9007199254740991 <= 9007199254740991
take
integer
>= -9007199254740991 <= 9007199254740991

Responses

200

Response for status ok

object
success
required
boolean
locations
required
Array<object>
object
id
required
string
>= 21 characters <= 21 characters
namespaceId
required
string
applicationId
required
string
durableObjectId
required
string
>= 64 characters <= 64 characters
name
required
string
<= 128 characters
timeZone
string
default: Etc/UTC
coordinates
object
latitude
required
number
>= -9007199254740991 <= 9007199254740991
longitude
required
number
>= -9007199254740991 <= 9007199254740991
tariff
required
object
elements
required
Array<object>
object
id
required
string
>= 21 characters <= 21 characters
name
required
string
<= 64 characters
backgroundColor
required
string
<= 12 characters
priceComponents
required
object
Flat
string
PerMinute
string
PerKilowattHour
string
restrictions
object
startTime
object
hour
required
integer
<= 23
minute
required
integer
<= 59
endTime
object
hour
required
integer
<= 23
minute
required
integer
<= 59
daysOfWeek
Array<string>
Allowed values: Mon Tue Wed Thu Fri Sat Sun
minEnergy
number
<= 9007199254740991
maxEnergy
number
<= 9007199254740991
minCurrent
number
<= 9007199254740991
maxCurrent
number
<= 9007199254740991
minPower
number
<= 9007199254740991
maxPower
number
<= 9007199254740991
minDuration
integer
<= 9007199254740991
maxDuration
integer
<= 9007199254740991
vehicleRequestingPower
boolean
minRestrictionsDuration
integer
>= -9007199254740991 <= 9007199254740991
minPrice
string
maxPrice
string
altTexts
Array<object>
object
language
required
string
>= 2 characters <= 2 characters
text
required
string
<= 512 characters
altUrl
string format: uri
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
count
required
integer
<= 9007199254740991

403

Response for status forbidden

object
success
required
boolean
message
required
string

500

Response for status internalServerError

object
success
required
boolean
message
required
string