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 lamp switches

This request delivers all lamp switches of a customer.

API endpoint

switch/slcID of customer

Request method

GET

Request headers

-

Request URL parameters

-

Response content

EntityTypeNullableDescription
switcharray (mainEntity)noIt's only an array if more than one switch is found. Otherwise, the object maainEntity is assigned directly.

mainEntity

EntityTypeNullableDescription
idintnoslcID of switch
switch_idintnoswitch number
namestringyesname of switch
brightnessintnobrightness if active
stateboolnois active
permanentboolnopersistent switch state
modeintno0 = OFF | 1 = Relative brightness | 2 = Absolute brightness | 3 = Blink

Response example

{
	"switch": [{
		"id": "3",
		"switch_id": "2",
		"name": "99%",
		"brightness": "99",
		"state": "false"
	}, {
		"id": "6",
		"switch_id": "1",
		"name": "100%",
		"brightness": "100",
		"state": "false"
	}, {
		"id": "23",
		"switch_id": "3",
		"name": "Test Mauro",
		"brightness": "100",
		"state": "false"
	}, {
		"id": "26",
		"switch_id": "0",
		"name": "agga",
		"brightness": "99",
		"state": "true"
	}]
}