Notifications

The ABS can send notifications when certain events happen. To receive notifications, create a notification object with the desired parameters.

Notification objects

Notification objects consist of the following properties:

id
The unique identifier of the notification object.
categories
A list of notification categories. See below.
protocol
“EMAIL” or “AMQP”. The emails will contain a human-readable message and a JSON-formatted object as an attachment.
target
The notification email address. / The AMQP URI.
chargingStationId
An optional charging station filter.
zoneId
An optional zone filter.

Categories

The following notification categories are defined:

CHARGING_SESSIONS
Send a notification when a charging session is started or stopped.
DEVICE_FAULTS
Send a notification when a device fault occurs.
DEVICE_WARNINGS
Send a notification when a device warning or fault occurs.
SERVER_LOGINS
Send a notification when a user logs in or out.
SERVER_OPERATIONS
Send a notification for every server action.
SMARTGRID
Send a notification for smartgrid events.

Notification contents

Email messages will contain a human-readable description of the event and a machine-readable JSON attachment. AMQP messages will contain a TextMessage with a JSON object.

For charging session notifications, the message will contain a charging session object (see Charging session objects). For device warnings and faults, the message will contain an alert object (see Alert objects). For server actions, the message will contain a history object (see History objects).

Example notification object

This object will request notifications of all charging session operations in zone 12 to admin@example.org.

{
  "id": 12345,
  "category": ["DEVICE_WARNINGS", "CHARGING_SESSIONS"]
  "protocol": "EMAIL",
  "target": "admin@example.org",
  "chargingStationId": null,
  "zoneId": 12
}

Notification services

GET /abs/frontend/notification

Retrieve all notification objects.

Role:admin
GET /abs/frontend/notification/(id)

Retrieve a specific notification object.

Role:admin
POST /abs/frontend/notification

Create a new notification object.

Role:

admin

Query Parameters:
 
  • categories – The desired notification categories (comma-separated list).
  • protocol – Must be “EMAIL” or “AMQP”.
  • target – The target email address or AMQP URI.
  • chargingStationId? – An optional charging station filter.
  • zoneId? – An optional zone filter.
Status Codes:
  • 204 – Unknown charging station.
  • 205 – Unknown zone.
  • 215 – Unknown notification rule.
PUT /abs/frontend/notification/(id)

Update a notification object.

Role:

admin

Query Parameters:
 
  • categories? – The new notification categories (comma-separated list).
  • protocol? – The new notification protocol.
  • target? – The new target email address or AMQP URI.
  • chargingStationId? – A new charging station filter, or -1 to delete an old one.
  • zoneId? – A new zone filter, or -1 to delete an old one.
Status Codes:
  • 204 – Unknown charging station.
  • 205 – Unknown zone.
DELETE /abs/frontend/notification/(id)

Delete a notification object.

Role:

admin

Status Codes:
  • 215 – Unknown notification rule.