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 group tree

This request delivers the hierarchical structure of all groups that may contain luminaire points.

Watch out, a customer may have more than one root node.

API endpoint

groupTree/slcID of customer

Request method

GET

Request headers

-

Request URL parameters

Format

This parameter is optional. Default is json.

format=json|xml

Response content

EntityTypeNullableDescription
customer[]array (mainEntity)no

mainEntity

EntityTypeNullableDescription
customer_idintnoslcID of customer
nodearray (node)nonode

node

EntityTypeNullableDescription
idintnoslcID of node
namestringnoname of node
nodearray (node)nosubnodes

Response: example in XML

<?xml version="1.0" encoding="UTF-8" ?>
<slControl>
	<customer>
		<customer_id>4</customer_id>
		<node>
			<id>208</id>
			<name>esave Demo</name>
			<node>
				<id>2108</id>
				<name>Asia-Tests</name>
			</node>
			<node>
				<id>2100</id>
				<name>iFux Livio</name>
			</node>
			<node>
				<id>1926</id>
				<name>Test</name>
			</node>
			<node>
				<id>1520</id>
				<name>EVG Demo</name>
			</node>
			<node>
				<id>277</id>
				<name>iFux Leuchten</name>
				<node>
					<id>2848</id>
					<name>esave ME</name>
				</node>
			</node>
		</node>
		<node>
			<id>2827</id>
			<name>Messe</name>
		</node>
		<node>
			<id>1146</id>
			<name>Leuchtstellen Demo</name>
		</node>
		<node>
			<id>2124</id>
			<name>EHAG</name>
		</node>
		<node>
			<id>2836</id>
			<name>IBN Demo</name>
		</node>
	</customer>
</slControl>

Response: example in JSON

{
	"customer": {
		"customer_id": "4",
		"node": [{
			"id": "208",
			"name": "esave Demo",
			"node": [{
				"id": "2108",
				"name": "Asia-Tests"
			}, {
				"id": "2100",
				"name": "iFux Livio"
			}, {
				"id": "1926",
				"name": "Test"
			}, {
				"id": "1520",
				"name": "EVG Demo"
			}, {
				"id": "277",
				"name": "iFux Leuchten",
				"node": {
					"id": "2848",
					"name": "esave ME"
				}
			}]
		}, {
			"id": "2827",
			"name": "Messe"
		}, {
			"id": "1146",
			"name": "Leuchtstellen Demo"
		}, {
			"id": "2124",
			"name": "EHAG"
		}, {
			"id": "2836",
			"name": "IBN Demo"
		}]
	}
}