Charging stations

Charging station objects

Charging station objects consist of the following properties:

id
The charging station’s unique identifier.
name
The user-defined name of the charging station, used in the web interface.
stationNumber
The public identification number of the charging station.
published
If false, this charging station won’t be listed in requests from users who don’t have the host role.
sockets
An array of socket objects. This list is sorted by stationRank, i.e. the socket with the lowest stationRank is listed first. See Socket objects.
socketIds
An array with just the identifiers of the sockets. This list is sorted.
numberOfSessions:
The number of charging sessions requested on this charging station.
address, town, postcode, country
The street address of the charging station. The country code is two-letter ISO-3166.
buildingStorey
The floor on which the charging station is installed (e.g. for multi-level car parks).
longitude, latitude
The geographic location of the charging station.
publicStation
true if the station is accessible to the general public.
openingHours
A description of the opening hours of the charging station.
parkingSpacesCar
Number of parking spaces available for cars.
parkingSpacesMotorcycle
Number of parking spaces available for motorcycles.
parkingSpacesBicycle
Number of parking spaces available for bicycles.
ownerName
Name of the charging station’s owner.
logoURL
URL for the owner’s logo.
phone
The owner’s phone number.
operator
Name of the charging station’s operator.
operatorPhone
The operator’s phone number.

Example object

{
     "id": 7,
     "name": "Greenbridge Oostende",
     "stationNumber": "BE1007",
     "published": true,
     "sockets": [
         {
             "id": 13,
             "chargingStationId": 7,
             "rank": 1,
             "name": "1",
             "numberOfSessions": 227,
             "socketStatus": "AVAILABLE",
             "socketType": "TYPE_2",
             "powerType": "TRIPLE_PHASE_32A_230_400V",
             "current": 32,
             "voltage": 400
             "phases": 3,
         },
         {
             "id": 14,
             "chargingStationId": 7,
             "rank": 2,
             "name": "2",
             "numberOfSessions": 137,
             "socketStatus": "AVAILABLE",
             "socketType": "SCHUKO_BE_FR",
             "powerType": "SINGLE_PHASE_16A_230V",
             "current": 16,
             "voltage": 230
             "phases": 1,
         }
     ],
     "socketIds": [ 13, 14 ],
     "numberOfSessions": 364,
     "address": "Wetenschapspark 1",
     "town": "Oostende",
     "postcode": "8400",
     "country": "BE",
     "buildingStorey": null,
     "longitude": 2.994294,
     "latitude": 51.216941,
     "publicStation": true,
     "openingHours": null,
     "parkingSpacesCar": 2,
     "parkingSpacesMotorcycle": 0,
     "parkingSpacesBicycle": 0,
     "ownerName": "BeCharged",
     "logoURL": "http://api.becharged.eu/images/logos/becharged.png",
     "phone": "+32 (0)9 395 05 93",
     "operator": "BeCharged",
     "operatorPhone": "+32 (0)9 395 05 93"
 }

Services

GET /abs/frontend/chargingStation

Request a list of charging stations. Without query parameters, all charging stations are returned. With query parameters, only matching charging stations are returned.

Query Parameters:
 
  • stationNumber? – Only return the station with the given station number.
  • town?, postcode?, country? – Only return the stations with matching address information.
  • publicStation?, activationPush?, activationRFID?, ... – Only return stations with one of these properties set or unset (boolean: true or false).
  • socketType?, powerType?, socketStatus? – Only return stations which have a matching socket.

Example response

{ "statusCode": "100",
  "chargingStations": [ ...list of chargingStation objects... ] }
GET /abs/frontend/chargingStation/own

Same, but only return charging stations associated with the user’s account.

GET /abs/frontend/chargingStation/(id)

Return the charging station with the given id.

Status Codes:
  • 204 – Unknown charging station.

Example response

{ "statusCode": "100", "chargingStation": { ... } }
POST /abs/frontend/chargingStation

Create a new charging station.

Role:

admin

Query Parameters:
 
  • stationNumber – The charging station’s stationNumber.
  • name – The charging station’s name.
  • accountId? – Account of the station’s owner.
Status Codes:
  • 305 – A charging station with that number/name already exists.

Example response

{ "statusCode": "100", "id": 12345 }
PUT /abs/frontend/chargingStation/(id)

Update the charging station’s properties.

Role:

host

Status Codes:
  • 204 – Unknown charging station.
  • 305 – A charging station with that number/name already exists.
DELETE /abs/frontend/chargingStation/(id)

Delete the charging station. All devices connected to this charging station and all other associated data will be deleted as well.

Role:

admin

Status Codes:
  • 204 – Unknown charging station.

Electricity measurements

GET /abs/frontend/chargingStation/(id)/extMeasurements

Returns readings from an externel meter device. The result is a JSON object with timestamps as keys (encoded as strings, as required by the JSON specification) and a measurement objects as value. Currently the following data is included:

EA+
positive active power (W)
ER+
positive reactive power (W)
EA-
negative active power (W)
Role:

host

Query Parameters:
 
  • from? – Only return meter readings starting with this timestamp (inclusive).
  • to? – Only return meter readings up to this timestamp (exclusive).
  • limit? – Only return the n newest readings within the selected range (default: all).
Status Codes:
  • 204 – Unknown charging station.

Example response

{ "statusCode": "100",
  "extMeasurements": {
    "1378381157": {
      "EA+": 0.0,
      "ER+": 0.0,
      "EA-": 0.0 } } }