Sockets

Socket objects

Socket objects consist of the following properties:

id
The socket’s unique identifier.
chargingStationId
The identifier of the charging station that contains this socket.
chargingUnitId
The identifier of the charging unit device that contains this socket.
deviceRank
Defines the physical order of the sockets on the charging unit, i.e. the first socket has rank 1, the second rank 2, etc.
stationRank
Defines the logical order of the sockets in the charging station. This order is used on the console display and in the user interface.
numberOfSessions
The number of sessions requested on this socket.
socketStatus
One of: AVAILABLE, IN_USE, RESERVED or FAILURE.
socketType
One of TYPE_1, TYPE_2, TYPE_3A, TYPE_3B, SCHUKO_BE_FR or SCHUKO_NL.
powerType
One of SINGLE_PHASE_16A_230V, SINGLE_PHASE_32A_230V, TRIPLE_PHASE_16A_230_400V, TRIPLE_PHASE_32A_230_400V.
current, voltage, phases
Same as powerType in numeric instead of symbolic form.

Example object

See the sockets property of the example charging station object.

Console display order

Suppose a charging station is installed consisting of two charging units and a console. The charging units are configured as follows:

Charging unit Device rank Station rank
BC07-1303001 1 4
2 3
BC07-1303002 1 2
2 1

The console will display four options which will be mapped to the hardware as follows:

User choice Interpreted as
Socket 1 BC07-1303002 socket 2
Socket 2 BC07-1303002 socket 1
Socket 3 BC07-1303001 socket 2
Socket 4 BC07-1303001 socket 1

Services

GET /abs/frontend/socket

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

Query Parameters:
 
  • chargingStationId? – Only return sockets connected to this charging station.
Status Codes:
  • 204 – Unknown charging station.

Example response

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

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

GET /abs/frontend/socket/(id)

Return the socket with the given id.

Status Codes:
  • 202 – Unknown socket.

Example response

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

Create a socket.

Query Parameters:
 
  • chargingUnitId – The charging unit to which this socket belongs.
  • socketType – The socket type (see above).
  • powerType – The power type.
  • deviceRank – The rank of the socket on the charging unit.
  • stationRank? – The rank of the socket in the charging station. If not specified, the socket will be sorted last.
Status Codes:
  • 216 – Unknown charging unit.
  • 307 – A socket with this device rank already exists for this charging unit.

Example response

{ "statusCode": "100", "id": 4567 }
PUT /abs/frontend/socket/(id)

Update a socket. Note that the chargingUnitId cannot be changed once a socket has been created – a socket forms an integral part of a charging unit and should not be re-assigned to another one.

Query Parameters:
 
  • socketType? – The socket type (see above).
  • powerType? – The power type.
  • stationRank? – The new station rank. The socket will be inserted in this position, and other sockets will be shifted one position to the right if needed.
Status Codes:
  • 202 – Unknown socket.
  • 216 – Unknown charging unit.
  • 307 – A socket with this device rank already exists for this charging unit.
DELETE /abs/frontend/socket/(id)

Delete the socket and all associated data.

Status Codes:
  • 202 – Unknown socket.