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

Create alerts

Create alarms for lamps or gateways.

API endpoint

alert

Request method

POST

Request headers

-

Request URL parameters

-

Request content

EntityTypeNullableDescription
alertarray (mainEntity)no

mainEntity

EntityTypeNullableDescription
alert_type_idint (alertType)noalert type
gateway_idintyesslcID of gateway (origin of alarm, if available)
device_idintyesslcAddress of device/lamp (it is a device specific alert, if available)
parametersstringyesalarm specific parameters as escaped JSON string
event_datetimestampnodate and time of alarm

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.

Request content: example

{
	"alert": {
		"gateway_id": 274,
		"device_id": null,
		"alert_type_id": 4611,
		"parameters": "{\"error_message\":\"High (\\/var) file system space usage of 65.1% detected!\",\"sys_varfs_usage\":\"65.1%\"}",
		"event_date": "2018-05-14T09:55:20.376023Z"
	}
}