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 gateways

This request delivers all lookup tables needed for gateways.

API endpoint

lookupTables/gateway

Request method

GET

Request headers

-

Request URL parameters

Format

This parameter is optional. Default is json.

format=json|xml

Response content

EntityTypeNullableDescription
gatewayarray (mainEntity)no

mainEntity

EntityTypeNullableDescription
outputTypearray (item)nolist of output types
operationModeTypearray (item)nolist of operation mode 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>
	<gateway>
		<outputType>
			<item>
				<id>0</id>
				<name>Static</name>
			</item>
			<item>
				<id>1</id>
				<name>Latching</name>
			</item>
			<item>
				<id>2</id>
				<name>PulseFeedback</name>
			</item>
		</outputType>
		<operationModeType>
			<item>
				<id>0</id>
				<name>Permanent aus- / ausgeschaltet (Konstanter Wert)</name>
			</item>
			<item>
				<id>1</id>
				<name>Nach Datum / Zeit / Wochentag</name>
			</item>
			<item>
				<id>2</id>
				<name>Nach Umgebungshelligkeit</name>
			</item>
			<item>
				<id>3</id>
				<name>Nach Zeit und Umgebungshelligkeit</name>
			</item>
			<item>
				<id>4</id>
				<name>Nach Zeit oder Umgebungshelligkeit</name>
			</item>
			<item>
				<id>5</id>
				<name>Nach digitalem Erweiterungs-Eingang</name>
			</item>
			<item>
				<id>6</id>
				<name>Nach digitalem Erweiterungs-Eingang (invertiert)</name>
			</item>
			<item>
				<id>7</id>
				<name>Nach analogem Erweiterungs-Eingang</name>
			</item>
			<item>
				<id>8</id>
				<name>Manuell mit virtuellem Schalter (auf Gateway)</name>
			</item>
			<item>
				<id>9</id>
				<name>Zentral (von der Webanwendung) kontrolliert: Jobs => ein / aus</name>
			</item>
		</operationModeType>
	</gateway>
</slControl>

Response: example in JSON

{
	"gateway": {
		"outputType": {
			"item": [{
				"id": "89",
				"name": "Static"
			}, {
				"id": "90",
				"name": "Latching"
			}, {
				"id": "91",
				"name": "PulseFeedback"
			}]
		},
		"operationModeType": {
			"item": [{
				"id": "41",
				"name": "Permanent aus- \/ ausgeschaltet (Konstanter Wert)"
			}, {
				"id": "42",
				"name": "Nach Datum \/ Zeit \/ Wochentag"
			}, {
				"id": "43",
				"name": "Nach Umgebungshelligkeit"
			}, {
				"id": "44",
				"name": "Nach Zeit und Umgebungshelligkeit"
			}, {
				"id": "45",
				"name": "Nach Zeit oder Umgebungshelligkeit"
			}, {
				"id": "46",
				"name": "Nach digitalem Erweiterungs-Eingang"
			}, {
				"id": "47",
				"name": "Nach digitalem Erweiterungs-Eingang (invertiert)"
			}, {
				"id": "48",
				"name": "Nach analogem Erweiterungs-Eingang"
			}, {
				"id": "49",
				"name": "Manuell mit virtuellem Schalter (auf Gateway)"
			}, {
				"id": "50",
				"name": "Zentral (von der Webanwendung) kontrolliert: Jobs => ein \/ aus"
			}]
		}
	}
}