Locations (v1)

Download OpenAPI specification:Download

A "Location" within the Locations API denotes a physical area, like a parking lot, where multiple Charging Stations are installed. It typically serves as a centralized hub for electric vehicle charging.

The Location object encapsulates key information, including its name, address, and geographical coordinates. To retrieve the IDs of Charging Stations at a specific Location, utilize the List Charging Stations of a Location endpoint.

In the API, locationUid (also known as id) is the internal identifier for the Location within the ChargEye system. The locationId field is allocated for customers to assign their internal location reference ID for flexibility.

Create a Location

post/locations

Use this endpoint to create a new Location within the system. The request should include necessary details such as the name, address, and geographical coordinates to describe the Location. Upon successful creation, the system returns the system-internal identifier (id).

SecuritybearerAuth
Request
Request Body schema: application/json
required
required
object (PostedCeLocation)
address
string or null
Array of items or null = 2 items

GeoJson line string bounding box. [[minLon, maxLat], [maxLon, minLat]]

city
string or null
country
string or null
countryCode
string or null

Country code in ISO 3166 alpha 2 format, two letter code

geo
Array of any

Any other GeoJson features, such as satellite placements. Features array.

Array of objects or null (CeCommonLabel)
lat
number or null

Central point. GEO location, latitude

lng
number or null

Central point. GEO location, longitude

locationId
string or null
name
string or null
object (BusinessDetails)

Represents the business details of an operator, suboperator or owner.

object or null

Position estimate for the location.

The estimate may come from station GPS positions, or location address, or other sources that may not be entirely accurate. The confidence value indicates how reliable the estimate is, on a scale from 0 to 1.

postalCode
string or null <= 10 characters

Postal code of the location

roamingPoolId
string or null
state
string or null

State or province of the location, only to be used when relevant.

stationId
string

If stationId is posted, access to location will be inherited from station

Responses
200

OK

Response Schema: application/json
id
required
string
success
required
boolean
401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples
application/json
{
  • "location": {
    },
  • "stationId": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "success": true
}

List Locations

get/locations

Retrieve a list of all available Locations within the system. Each item in the response provides details about a specific Location, including its unique identifier, name, address, and geographical coordinates.

SecuritybearerAuth
Responses
200

OK

Response Schema: application/json
required
Array of objects (CensoredRowWithTenancy<LocationRow>)
Array
address
string or null
Array of items or null = 2 items

GeoJson line string bounding box. [[minLon, maxLat], [maxLon, minLat]]

city
string or null
country
string or null
countryCode
string or null

Country code in ISO 3166 alpha 2 format, two letter code

geo
Array of any

Any other GeoJson features, such as satellite placements. Features array.

id
required
string

location uid

Array of objects or null (CeCommonLabel)
lat
number or null

Central point. GEO location, latitude

lng
number or null

Central point. GEO location, longitude

locationId
string or null
name
string or null
object (BusinessDetails)

Represents the business details of an operator, suboperator or owner.

object or null

Position estimate for the location.

The estimate may come from station GPS positions, or location address, or other sources that may not be entirely accurate. The confidence value indicates how reliable the estimate is, on a scale from 0 to 1.

postalCode
string or null <= 10 characters

Postal code of the location

roamingPoolId
string or null
state
string or null

State or province of the location, only to be used when relevant.

tenantIdCPO
required
string
Deprecated

use tenantIds instead

tenantIdEMSP
required
string
Deprecated

use tenantIds instead

tenantIdMaintenance
required
string
Deprecated

use tenantIds instead

tenantIds
required
Array of strings

Which tenants has access to this row

401

Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission

Request samples 
Response samples 
application/json
{
  • "locations": [
    ]
}
Get network status
get/locations/network
Retrieve the status for the network, i.e. the list of the tenant's locations.


SecuritybearerAuth 
Request 
query Parameters
limit
number
Limit of locations to return, for pagination


 
locationIds
Array of arrays
 
paginationToken
string
For getting next batch of results for pagination


 
tsEnd
string
The end time limit for the alerts


 
tsStart
string
The start time limit for the alerts


 
Responses 
200
OK


Response Schema: application/json
required
Array of objects (NetworkStatusLocation) 
 
 Array 
address
string
 
city
string
 
id
required
string
 
lat
number
 
lng
number
 
name
string
 
positionConfidence
number
 
required
Array of objects (NetworkStatusStation) 
 
paginationToken
string
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "locations": [
    ],
  • "paginationToken": "string"
}
Get currently used power for whole network or a list of locations
get/locations/network/currentPower
Get currently used power for whole network or a list of locations


SecuritybearerAuth 
Request 
query Parameters
locationUids
Array of arrays
 
Responses 
200
OK


Response Schema: application/json
required
Array of objects (LocationPower) 
 
 Array 
currentPowerKw
required
number
 
locationUid
required
string
 
sessionCount
required
number
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "locations": [
    ]
}
Get network hardware errors
get/locations/network/hardwareErrors
Get network hardware errors


SecuritybearerAuth 
Request 
query Parameters
limit
number
Limit of locations to return, for pagination


 
locationIds
Array of arrays
 
paginationToken
string
For getting next batch of results for pagination


 
tsEnd
string
The end time limit for the alerts


 
tsStart
string
The start time limit for the alerts


 
Responses 
200
OK


Response Schema: application/json
required
Array of objects (NetworkStatusHardwareError) 
 
 Array 
object (PickAlertRow) 
 
ErrorCodeWithTimestamps (object) or PickErrorCodeWithTimestamps (object)
 
stationId
required
string
 
timestamp
required
string
 
paginationToken
required
string
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "paginationToken": "string"
}
Get network problematic sessions
get/locations/network/sessionProblems
Get network problematic sessions


SecuritybearerAuth 
Request 
query Parameters
limit
number
Limit of locations to return, for pagination


 
locationIds
Array of arrays
 
paginationToken
string
For getting next batch of results for pagination


 
tsEnd
string
The end time limit for the alerts


 
tsStart
string
The start time limit for the alerts


 
Responses 
200
OK


Response Schema: application/json
paginationToken
required
string
 
required
Array of objects (NetworkStatusSession) 
 
 Array 
alert
string
 
endTime
string
 
evId
string
 
object
Cluster-based EV identification


 
evModel
string
 
evName
string
 
locationUid
required
string
 
scheduleId
string
 
startTime
required
string
 
status
required
string
 Enum: "Alarm" "AuthorizedNotPluggedIn" "Charging" "Ended" "InsulationTest" "PluggedInIdle" "Scheduled" "Unknown"  
object
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "paginationToken": "string",
  • "sessions": [
    ]
}
Get network transactions
get/locations/network/transactions
Get network transactions


SecuritybearerAuth 
Request 
query Parameters
limit
number
Limit of locations to return, for pagination


 
locationIds
Array of arrays
 
paginationToken
string
For getting next batch of results for pagination


 
tsEnd
string
The end time limit for the alerts


 
tsStart
string
The start time limit for the alerts


 
Responses 
200
OK


Response Schema: application/json
paginationToken
string
 
required
Array of objects (NetworkStatusTransaction) 
 
 Array 
endTime
string
 
evId
string
Vehicle id, if known


 
object
Cluster-based EV identification


 
evseId
required
string
EVSE unique identifier.


 
locationUid
string
Location this EVSE lies in


 
powerKw
number
Power kilowatt present, max, avg


 
soc
number
Current SoC


 
socStart
number
State of Charge at the beginning of the transaction


 
startTime
string
Whole session start time


 
status
required
string (TransactionStatus) 
 Enum: "Alarm" "AuthorizedNotPluggedIn" "Charging" "Ended" "InsulationTest" "PluggedInIdle" "Unknown"  
technicalFailClassification
string (TechnicalFailClassification) 
One of:
     * OK - normal successful charging
     * LOW_POWER - charging is normal, but charging power is very low (<= 1kW) for some reason - indications of a charging problem
     * NOT_IDENTIFIED - cable connected, but not authed
     * NOT_PLUGGED_IN - authed, but cable not connected
     * HANDSHAKE_FAIL - cable connected and authed, but charging was not started
     * HANDSHAKE_CANCELED - charging didn't start - user stopped charging from charger, car or mobile phone during the preparation for charging (user-driven stop)
     * INVALID_SESSION - cable not connected and not authed
     * ABRUPTLY_CANCELED - user stopped charging in less than 10 seconds after start
     * ABRUPT_STOP - charging ended in less than 10 seconds after start without user stopping it
     * INVALID_USER - remote system stopped charging as unauthorized


 Enum: "ABRUPTLY_CANCELED" "ABRUPT_STOP" "HANDSHAKE_CANCELED" "HANDSHAKE_FAIL" "INVALID_SESSION" "INVALID_USER" "LOW_POWER" "NOT_IDENTIFIED" "NOT_PLUGGED_IN" "OK"  
txId
required
string
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "paginationToken": "string",
  • "transactions": [
    ]
}
Update a Location
patch/locations/{locationUid}
Update the details of an existing Location by specifying its unique system-internal identifier.
Provide the modified attributes in the request body to update the Location's name, address, or geographical coordinates.


SecuritybearerAuth 
Request 
path Parameters
locationUid
required
string
 
Request Body schema: application/json
required
required
object (PartialCeLocation) 
 
address
string or null
 
Array of items or null  = 2 items 
GeoJson line string bounding box.
[[minLon, maxLat], [maxLon, minLat]]


 
city
string or null
 
country
string or null
 
countryCode
string or null
Country code in ISO 3166 alpha 2 format, two letter code


 
geo
Array of any
Any other GeoJson features, such as satellite placements.
Features array.


 
id
string
location uid


 
Array of objects or null (CeCommonLabel) 
 
lat
number or null
Central point. GEO location, latitude


 
lng
number or null
Central point. GEO location, longitude


 
locationId
string or null
 
name
string or null
 
object (BusinessDetails) 
Represents the business details of an operator, suboperator or owner.


 
object or null
Position estimate for the location.


The estimate may come from station GPS positions, or location address, or other sources
that may not be entirely accurate. The confidence value indicates how reliable the
estimate is, on a scale from 0 to 1.


 
postalCode
string or null  <= 10 characters 
Postal code of the location


 
roamingPoolId
string or null
 
state
string or null
State or province of the location, only to be used when relevant.


 
Responses 
200
OK


Response Schema: application/json
success
required
boolean
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
application/json
{
  • "location": {
    }
}
Response samples 
application/json
{
  • "success": true
}
Get a Location
get/locations/{locationUid}
Access a specific location using its unique ID.
The response provides details about a specific Location,
including its name, address, and geographical coordinates.


Obtain the locationUid from the List Locations endpoint to use this operation.


SecuritybearerAuth 
Request 
path Parameters
locationUid
required
string
 
Responses 
200
OK


Response Schema: application/json
required
object (CensoredRowWithTenancy<LocationRow>) 
 
address
string or null
 
Array of items or null  = 2 items 
GeoJson line string bounding box.
[[minLon, maxLat], [maxLon, minLat]]


 
city
string or null
 
country
string or null
 
countryCode
string or null
Country code in ISO 3166 alpha 2 format, two letter code


 
geo
Array of any
Any other GeoJson features, such as satellite placements.
Features array.


 
id
required
string
location uid


 
Array of objects or null (CeCommonLabel) 
 
lat
number or null
Central point. GEO location, latitude


 
lng
number or null
Central point. GEO location, longitude


 
locationId
string or null
 
name
string or null
 
object (BusinessDetails) 
Represents the business details of an operator, suboperator or owner.


 
object or null
Position estimate for the location.


The estimate may come from station GPS positions, or location address, or other sources
that may not be entirely accurate. The confidence value indicates how reliable the
estimate is, on a scale from 0 to 1.


 
postalCode
string or null  <= 10 characters 
Postal code of the location


 
roamingPoolId
string or null
 
state
string or null
State or province of the location, only to be used when relevant.


 
tenantIdCPO
required
string
 Deprecated 
use tenantIds instead


 
tenantIdEMSP
required
string
 Deprecated 
use tenantIds instead


 
tenantIdMaintenance
required
string
 Deprecated 
use tenantIds instead


 
tenantIds
required
Array of strings
Which tenants has access to this row


 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "location": {
    }
}
List Charging Stations of a Location
get/locations/{locationUid}/stations
Retrieve a list of Charging Stations associated with a specific Location, identified by its id.
The response includes the Charging Station IDs and other details of each Charging Station.


Retrieve the full details of a charging station with the Charging Stations API.


SecuritybearerAuth 
Request 
path Parameters
locationUid
required
string
 
Responses 
200
OK


Response Schema: application/json
required
Array of objects (CensoredRowWithTenancy<ChargingStationRow>) 
 
 Array 
object (StationClassification) 
Charging station or location classification metadata.


 
commissioningRequired
boolean or null
 
object
 
customerSuppliedId
string
ID a customer has given to this station


 
firmwareVersion
string or null
 
groupPath
string or null
 
Array of objects or null (CeCommonLabel) 
 
licenseId
string or null
licenseId to enforce permissions on this charger


 
licenseTenantId
string or null
tenantId which provides / pays for the license


 
object or null
 
locationUid
string or null
 
object (StationManufacturingInfo) 
 
maxPowerKw
number
Charger maximum output power at any point in time in kilowatts. How much power it can output simultaneously to all its connectors.


 
model
string or null
 
name
required
string
 
notes
string or null
 
operationalStatus
string (StationOperationalStatus) 
 Enum: "IN_OPERATION" "NOT_IN_OPERATION" "OUT_OF_ORDER"  
operator
string or null
 
stationCapabilities
string or null
Capabilities that the station supports as a comma separated list.
For example when station supports serial connectable power modules,
contents would be:
stationCapabilities = "SerialConnection,Xxx, ... ,Yyy"


 
stationId
required
string
Station unique identifier.


 
tenantIdCPO
required
string
 Deprecated 
use tenantIds instead


 
tenantIdEMSP
required
string
 Deprecated 
use tenantIds instead


 
tenantIdMaintenance
required
string
 Deprecated 
use tenantIds instead


 
tenantIds
required
Array of strings
Which tenants has access to this row


 
vendorName
string or null
 
401
Unauthorized - Authorization: Bearer header is missing, invalid, expired, or user has no permission


Request samples 
Response samples 
application/json
{
  • "stations": [
    ]
}