Zones

Warning

Future versions of the software will remove zones in favor of a different socket-based organization system.

Zone objects

Zone objects consist of the following properties:

id
The zone’s unique identifier.
name
The user-defined name of the zone, used in the web interface.
description
The user-defined description of the zone, used in the web interface.
chargingStationIds
An array with the identifiers of the charging stations in this zone.

Example object

{
    "id": 10000,
    "name": "Brussels",
    "description": "",
    "chargingStationIds": [ 10000, 10001 ]
}

Services

GET /abs/frontend/zone

Retrieve a list of all zones.

Role:admin

Example response

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

Retrieve a list of all zones associated with the current account.

Role:host
GET /abs/frontend/zone/(id)

Retrieve a specific zone.

Role:

host

Status Codes:
  • 205 – Unknown zone.

Example response

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

Create a new zone. Charging stations can be added to the zone by changing their zoneId property.

Role:

hostAdmin

Query Parameters:
 
  • name – The zone’s name.
  • description – The zone’s description.
Status Codes:
  • 304 – A zone with that name already exists.

Example response

{ "statusCode": "100", "id": 123456 }
PUT /abs/frontend/zone/(id)

Change a zone’s properties.

Role:

hostAdmin

Query Parameters:
 
  • name? – The zone’s name.
  • description? – The zone’s description.
Status Codes:
  • 205 – Unknown zone.
  • 304 – A zone with that name already exists.
DELETE /abs/frontend/delete/(id)

Delete this zone.

Role:

hostAdmin

Status Codes:
  • 205 – Unknown zone.