slControl API

LogoutChangelog (26.08.2024)Legal notesBasic usageRequest EmulatorTroubleshooting
Global
Get list of accessible customersGet lookup tables for settingsGet lookup tables for devicesGet lookup tables for operationModeGet lookup tables for gatewaysGet lookup tables for jobsGet lookup tables for alerts
Customers
Get customer configurationUpdate customer configurationGet mesh network
Groups
Get group tree
Lamp switches
Get lamp switchesUpdate lamp switches
Luminaire points
Get luminaire pointsUpdate luminaire pointsCreate luminaire pointsDelete luminaire points
Devices
Get devicesGet device dataGet device stateUpdate device dataUpdate device operation stateGet operation modeUpdate operation modeDelete deviceDelete devices
Devices - Statistics/Logs
Get radar dataGet motion dataGet device energyGet environmental data
Gateways
Get gatewaysGet gateway dataCreate gatewaysDelete a gateway
Jobs
Get jobs state of a deviceGet job state by slcID
Alerts
Get alertsCreate alertsUpdate alerts

Get alerts

This request delivers all alarms of one or more customers.

API endpoint

alert

Request method

GET

Request headers

-

Request URL parameters

Format

This parameter is optional. Default is json.

format=json|xml

Customer

This parameter is required. You may access data of one or more customers by comma delimited string of customers slcIDs. No comma at the beginning or end of this string.

customer=104,105

Limit by time

You may restrict the recordset by start time and/oder end time. Timeconstraints are local time.

from=2017-11-25T08:00:35
to=2017-11-25T15:00:35

Limit by state

You may restrict the recordset by comma delimited list of alertState(s). No comma at the beginning or end of this string.

state=3,6

Limit by type

You may restrict the recordset by comma delimited list of alertType(s). No comma at the beginning or end of this string.

types=4097,4353

Response content

EntityTypeNullableDescription
customer[]array (mainEntity)no

mainEntity

EntityTypeNullableDescription
customer_idintnoslcID of customer
alert[]array (alert)noalerts

alert

EntityTypeNullableDescription
idintnoslcID of alarm
typeint (alertType)noalert type
stateint (alertState)noalert state
event_datedatetimenodate and time of alert
gateway_idintyesslcID of gateway (origin of alert, if available)
device_idintyesslcID of device (it is a device specific alert, if available)
job_idintyesslcID of job (if available)

alertType

ValueDescription
-9External alert
-4Tilt Alert
-3Smart Meter Alert
-2SLC RC-Switch Offline
0Unbekannter Fehler
4097Gateway-Fehler: Nicht erreichbar
4353Gateway-Fehler: Hardware failure
4354Gateway: Betriebsystemfehler
4608Gateway: Unbekannte Warnung
4609Gateway: Sensor Warnung
4610Gateway: Log-Warnung
4611Gateway: Betriebsystemwarnung
8193
8194Geräte-Fehler: Hardware-Fehler
8448
8449
8450
8451
8452
8453
8454
8704Geräte-Warnung: Sensoren
8705Geräte-Warnung: Übertemperatur Steuerung
8706Geräte-Warnung: Übertemperatur LED
12289Job: Jobausführung schlug fehl
12290Die Geräte-ID wird bereits bei einem anderen Kunden gebraucht.

alertState

ValueDescription
1Noch nicht versendet
3Alarm versendet
4Bestätigt
5In Bearbeitung
6Behoben

Response: example in XML

<?xml version="1.0" encoding="UTF-8" ?>
<slControl>
	<customer>
		<customer_id>2</customer_id>
		<alert>
			<id>21</id>
			<type>8452</type>
			<state>3</state>
			<event_date>2016-10-13 15:30:44</event_date>
			<gateway_id>79</gateway_id>
		</alert>
		<alert>
			<id>23</id>
			<type>12289</type>
			<state>6</state>
			<event_date>2018-04-22 11:21:13</event_date>
			<job_id>17</job_id>
		</alert>
		<alert>
			<id>72</id>
			<type>-9</type>
			<state>1</state>
			<event_date>2018-04-15 15:21:33</event_date>
		</alert>
	</customer>
	<customer>
		<customer_id>4</customer_id>
		<alert>
			<id>31</id>
			<type>12289</type>
			<state>6</state>
			<event_date>2017-05-14 18:45:37</event_date>
			<job_id>45</job_id>
		</alert>
		<alert>
			<id>39</id>
			<type>12289</type>
			<state>6</state>
			<event_date>2017-05-14 18:45:37</event_date>
			<job_id>72</job_id>
		</alert>
	</customer>
</slControl>

Response: example in JSON

 {
 	"customer": {
 		"customer_id": "4",
 		"alert": [{
 			"id": "31",
 			"type": "12289",
 			"state": "6",
 			"event_date": "2017-05-14 18:45:37",
 			"job_id": "45"
 		}, {
 			"id": "39",
 			"type": "12289",
 			"state": "6",
 			"event_date": "2017-05-14 18:45:37",
 			"job_id": "72"
 		}, {
 			"id": "40",
 			"type": "12289",
 			"state": "6",
 			"event_date": "2017-05-14 18:45:37",
 			"job_id": "83"
 		}, {
 			"id": "41",
 			"type": "12289",
 			"state": "6",
 			"event_date": "2017-05-14 18:45:37",
 			"job_id": "84"
 		}, {
 			"id": "42",
 			"type": "12289",
 			"state": "6",
 			"event_date": "2017-05-14 18:45:37",
 			"job_id": "85"
 		}, {
 			"id": "43",
 			"type": "12289",
 			"state": "6",
 			"event_date": "2017-05-14 18:45:37",
 			"job_id": "92"
 		}, {
 			"id": "67",
 			"type": "12289",
 			"state": "6",
 			"event_date": "2018-11-08 14:37:36",
 			"job_id": "33"
 		}]
 	}
 }