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 customer configuration

Request customer settings that are relevant for field communication.

API endpoint

customer/config/slcID of customer

Request method

GET

Request headers

-

Request URL parameters

-

Response content

EntityTypeNullableDescription
customerConfigobject (mainEntity)no

mainEntity

EntityTypeNullableDescription
customer_idintnoslcID of customer
timezone_idint (timeZone)noslcID of timezone
namestringyescustomer name
fwupdate_autoboolnogateway shall update lamps automatically with new firmware
fwupdate_time_fromtimeyesstart time for firmware updates (NULL=always)
fwupdate_time_totimeyesend time for firmware updates (NULL=always)
device_notreachable_sensitivity_idint (notReachableSensitivity)nosensibility for not reachable alarms

notReachableSensitivity

ValueDescription
0aggressive (alert after >= 4h)
1normal (alert after >= 24h)
2lazy (alert after >= 48 h)

timeZone

ValueDescription
91China Standard Time
266Caucasus Standard Time
430North Asia East Standard Time
1494E. Australia Standard Time
1505Belarus Standard Time
2199Newfoundland Standard Time
2447Korea Standard Time
3448West Asia Standard Time
3718Central Brazilian Standard Time
4220Arabic Standard Time
5127Tokyo Standard Time
6605Tasmania Standard Time
7088UTC-02
7115Samoa Standard Time
7243UTC
7782Kamchatka Standard Time
8451SA Western Standard Time
8973Kaliningrad Standard Time
10608Libya Standard Time
10700Yakutsk Standard Time
12214Pacific Standard Time
12469Middle East Standard Time
13341North Asia Standard Time
14300Central Asia Standard Time
14404New Zealand Standard Time
14844Iran Standard Time
15410Dateline Standard Time
16165Hawaiian Standard Time
16191GMT Standard Time
16233Bangladesh Standard Time
16877Pacific Standard Time (Mexico)
17698Russia Time Zone 11
17764N. Central Asia Standard Time
17771Bahia Standard Time
18366Arab Standard Time
18986Central Standard Time (Mexico)
19906Mauritius Standard Time
20409E. South America Standard Time
21466US Eastern Standard Time
22063Pacific SA Standard Time
23297Azerbaijan Standard Time
23623Azores Standard Time
23803AUS Eastern Standard Time
25984FLE Standard Time
26194E. Europe Standard Time
26647Paraguay Standard Time
26719Central Standard Time
27497Arabian Standard Time
29009Mountain Standard Time
29383South Africa Standard Time
29501Russia Time Zone 3
30680Mountain Standard Time (Mexico)
31119Alaskan Standard Time
31929Central Pacific Standard Time
32753West Pacific Standard Time
34116Turkey Standard Time
34353E. Africa Standard Time
34899Singapore Standard Time
35115Cape Verde Standard Time
36602Montevideo Standard Time
40598GTB Standard Time
40787W. Europe Standard Time
41472Eastern Standard Time
42814Nepal Standard Time
43171Venezuela Standard Time
43352Russia Time Zone 10
43571Taipei Standard Time
45099Line Islands Standard Time
46430W. Australia Standard Time
46582Morocco Standard Time
47018Tonga Standard Time
47492Namibia Standard Time
47896Ekaterinburg Standard Time
48608SE Asia Standard Time
49036US Mountain Standard Time
50199W. Central Africa Standard Time
50249Sri Lanka Standard Time
50871Myanmar Standard Time
51093Georgian Standard Time
51675Fiji Standard Time
51914Cen. Australia Standard Time
52115SA Eastern Standard Time
52751Mid-Atlantic Standard Time
54019Magadan Standard Time
54255SA Pacific Standard Time
54304Jordan Standard Time
54711Russian Standard Time
54893Greenwich Standard Time
54894UTC+12
54923Central America Standard Time
54938Syria Standard Time
56022Egypt Standard Time
57137Canada Central Standard Time
58992Atlantic Standard Time
59406Afghanistan Standard Time
59754Central European Standard Time
60130UTC-11
61056Vladivostok Standard Time
61426India Standard Time
62773Greenland Standard Time
63171Argentina Standard Time
64425Israel Standard Time
64508Romance Standard Time
64684AUS Central Standard Time
64713Ulaanbaatar Standard Time
65352Pakistan Standard Time
65465Central Europe Standard Time

Response on sucess

Headers

200 OK

Content (example)

{
 	"customerConfig": {
 		"customer_id": 4,
 		"name": "esave (Demo)",
 		"timezone_id": 40787,
 		"fwupdate_auto": true,
 		"fwupdate_time_from": "00:00",
 		"fwupdate_time_to": "00:00",
 		"device_notreachable_sensitivity_id": 2
 	}
}

Response on error

Headers

400 Bad Request

Content (example)

{
	"error": 6000
}

Error Codes

CodeDescription
6000customer not found