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 lookup tables for alerts

This request delivers all lookup tables needed for alerts.

API endpoint

lookupTables/alert

Request method

GET

Request headers

-

Request URL parameters

Format

This parameter is optional. Default is json.

format=json|xml

Response content

EntityTypeNullableDescription
alertarray (mainEntity)no

mainEntity

EntityTypeNullableDescription
alertStatearray (item)nolist of alert states
alertTypearray (item)nolist of alert types

item

EntityTypeNullableDescription
itemarray (itemValue)nolist of alert types

itemValue

EntityTypeNullableDescription
idintnoslcID of item
namestringnodescription

Response: example in XML

<?xml version="1.0" encoding="UTF-8" ?>
<slControl>
	<alert>
		<alertType>
			<item>
				<id>-9</id>
				<name>External alert</name>
			</item>
			<item>
				<id>4097</id>
				<name>Gateway-Fehler: Nicht erreichbar</name>
			</item>
			<item>
				<id>4353</id>
				<name>Gateway-Fehler: Hardware failure</name>
			</item>
			<item>
				<id>4354</id>
				<name>Gateway: Betriebsystemfehler</name>
			</item>
			<item>
				<id>4608</id>
				<name>Gateway: Unbekannte Warnung</name>
			</item>
			<item>
				<id>4609</id>
				<name>Gateway: Sensor Warnung</name>
			</item>
			<item>
				<id>4610</id>
				<name>Gateway: Log-Warnung</name>
			</item>
			<item>
				<id>4611</id>
				<name>Gateway: Betriebsystemwarnung</name>
			</item>
			<item>
				<id>8193</id>
				<name>Geräte-Fehler: Nicht erreichbar</name>
			</item>
			<item>
				<id>8448</id>
				<name>Geräte-Fehler: Unbekannter Fehler</name>
			</item>
			<item>
				<id>8449</id>
				<name>Geräte-Fehler: RTC Modul</name>
			</item>
			<item>
				<id>8450</id>
				<name>Geräte-Fehler: GPS Modul</name>
			</item>
			<item>
				<id>8451</id>
				<name>Geräte-Fehler: Temperatursensor-Fehler</name>
			</item>
			<item>
				<id>8452</id>
				<name>Geräte-Fehler: Peripherie Fehler (z.B. Bewegungssensor)</name>
			</item>
			<item>
				<id>8453</id>
				<name>Device: Peripheral failure (digitaler LED Temperatur Sensor)</name>
			</item>
			<item>
				<id>8454</id>
				<name>Device: Peripheral failure (EVG Lampenfehler)</name>
			</item>
			<item>
				<id>8704</id>
				<name>Geräte-Warnung: Sensoren</name>
			</item>
			<item>
				<id>8705</id>
				<name>Geräte-Warnung: Übertemperatur Steuerung</name>
			</item>
			<item>
				<id>8706</id>
				<name>Geräte-Warnung: Übertemperatur LED</name>
			</item>
			<item>
				<id>12289</id>
				<name>Job: Jobausführung schlug fehl</name>
			</item>
			<item>
				<id>12290</id>
				<name>Die Geräte-ID wird bereits bei einem anderen Kunden gebraucht.</name>
			</item>
		</alertType>
		<alertState>
			<item>
				<id>1</id>
				<name>Noch nicht versendet</name>
			</item>
			<item>
				<id>3</id>
				<name>Alarm versendet</name>
			</item>
			<item>
				<id>4</id>
				<name>Bestätigt</name>
			</item>
			<item>
				<id>5</id>
				<name>In Bearbeitung</name>
			</item>
			<item>
				<id>6</id>
				<name>Behoben</name>
			</item>
		</alertState>
	</alert>
</slControl>

Response: example in JSON

{
	"alert": {
		"alertType": {
			"item": [{
				"id": "-9",
				"name": "External alert"
			}, {
				"id": "4097",
				"name": "Gateway-Fehler: Nicht erreichbar"
			}, {
				"id": "4353",
				"name": "Gateway-Fehler: Hardware failure"
			}, {
				"id": "4354",
				"name": "Gateway: Betriebsystemfehler"
			}, {
				"id": "4608",
				"name": "Gateway: Unbekannte Warnung"
			}, {
				"id": "4609",
				"name": "Gateway: Sensor Warnung"
			}, {
				"id": "4610",
				"name": "Gateway: Log-Warnung"
			}, {
				"id": "4611",
				"name": "Gateway: Betriebsystemwarnung"
			}, {
				"id": "8193",
				"name": "Ger\u00e4te-Fehler: Nicht erreichbar"
			}, {
				"id": "8448",
				"name": "Ger\u00e4te-Fehler: Unbekannter Fehler"
			}, {
				"id": "8449",
				"name": "Ger\u00e4te-Fehler: RTC Modul"
			}, {
				"id": "8450",
				"name": "Ger\u00e4te-Fehler: GPS Modul"
			}, {
				"id": "8451",
				"name": "Ger\u00e4te-Fehler: Temperatursensor-Fehler"
			}, {
				"id": "8452",
				"name": "Ger\u00e4te-Fehler: Peripherie Fehler (z.B. Bewegungssensor)"
			}, {
				"id": "8453",
				"name": "Device: Peripheral failure (digitaler LED Temperatur Sensor)"
			}, {
				"id": "8454",
				"name": "Device: Peripheral failure (EVG Lampenfehler)"
			}, {
				"id": "8704",
				"name": "Ger\u00e4te-Warnung: Sensoren"
			}, {
				"id": "8705",
				"name": "Ger\u00e4te-Warnung: \u00dcbertemperatur Steuerung"
			}, {
				"id": "8706",
				"name": "Ger\u00e4te-Warnung: \u00dcbertemperatur LED"
			}, {
				"id": "12289",
				"name": "Job: Jobausf\u00fchrung schlug fehl"
			}, {
				"id": "12290",
				"name": "Die Ger\u00e4te-ID wird bereits bei einem anderen Kunden gebraucht."
			}]
		},
		"alertState": {
			"item": [{
				"id": "1",
				"name": "Noch nicht versendet"
			}, {
				"id": "3",
				"name": "Alarm versendet"
			}, {
				"id": "4",
				"name": "Best\u00e4tigt"
			}, {
				"id": "5",
				"name": "In Bearbeitung"
			}, {
				"id": "6",
				"name": "Behoben"
			}]
		}
	}
}