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 gateways

This request delivers all gateways of one or more customers.

API endpoint

gateway

Request method

GET

Request headers

-

Request URL parameters

Format

This parameter is optional. Default is json.

format=json|xml

Customer

This parameter is required. You may access data of one or more customers by comma delimited string of customers slcIDs. No comma at the beginning or end of this string.

customer=104,105

Response content

EntityTypeNullableDescription
customer[]array (mainEntity)no

mainEntity

EntityTypeNullableDescription
customer_idintnoslcID of customer
gateway[]array (gateway)nogateways

gateway

EntityTypeNullableDescription
idintnoslcID of gateway
hw_idstringnoslcHardwareAdress of gateway
namestringyesname of gateway
latitudefloatyeslatitude (WGS84)
longitudefloatyeslongitude (WGS84)
last_connection_atdatetimeyesdate and time of last connection
last_activity_atdatetimeyesdate and time of last activity

Response: example in XML

<?xml version="1.0" encoding="UTF-8" ?>
<slControl>
	<customer>
		<customer_id>103</customer_id>
		<gateway>
			<id>90</id>
			<hw_id>123942B1-D9EBBCBD-BCBEEA11-CD725E17</hw_id>
			<name>Schuch Demo</name>
			<latitude>47.000</latitude>
			<longitude>7.001</longitude>
			<last_connection_at>2017-05-04 07:37:05</last_connection_at>
			<last_activitiy_at>2017-05-04 07:37:05</last_activitiy_at>
		</gateway>
	</customer>
</slControl>

Response: example in JSON

{
	"customer": {
		"customer_id": "103",
		"gateway": {
			"id": "90",
			"hw_id": "123942B1-D9EBBCBD-BCBEEA11-CD725E17",
			"name": "Schuch Demo",
			"latitude": "47.000",
			"longitude": "7.001",
			"last_connection_at": "2017-05-04 07:37:05",
			"last_activitiy_at": "2017-05-04 07:37:05"
		}
	}
}