This request delivers all devices of a certain customer.
device/list/slcID of customer
GET
-
This parameter is optional. Default is "json".
format=json|xml
This parameter is optional. Expects a comma separated list of values. Default is "base".
Please note that if you use "state", no base data will be delivered. Therefore use "base,state" as filter if you want base data to be included in this case.
data=base,state (base=base value attributes, state=state value attributes)
This parameter is optional. No filter if missing. Expects a comma separated list of values.
kind=0,1 (0=conventional lamps, 1=intelligent lamps/sensors)
This parameter is optional. No filter if missing. Expects a comma separated list of values.
Please note that conventional lamps do not have an online state. You may filter them out with "kind=1" for now.
state=0,1 ... (see onlineState for possible values)
| Entity | Type | Nullable | Description |
|---|---|---|---|
| customer | array (mainEntity) | no |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| customer_id | int | no | slcID of customer |
| device[] | array (device) | no | list of devices |
| Entity | Type | Nullable | Description |
|---|---|---|---|
| id | int | no | slcID of device |
| slcDeviceAddress | int | yes | slcDeviceAddress |
| name | string | yes | name of device (base) |
| location | int | yes | slcID of node in tree (base) |
| luminaire_point | int | yes | slcID of luminaire point (base) |
| coords | array (coords) | no | location (base) |
| online_status_id | int (onlineState) | no | device online state (state) |
| last_connection_at | timestamp | yes | last actualization of the device state data (state) |
| led_brightness | byte | yes | led brightness in % |
Please note that some attributes are dependent on data-filter (base/state).
| Entity | Type | Nullable | Description |
|---|---|---|---|
| latitude | string | yes | latitude (WGS84) |
| longitude | string | yes | longitude (WGS84) |
| x | string | yes | x (LV95) |
| y | string | yes | y (LV95) |
| Value | Description |
|---|---|
| 0 | Unbekannt |
| 1 | Verfügbar (Online) |
| 2 | Nicht verfügbar (Offline) |
| 3 | Inaktiv |
<?xml version="1.0" encoding="UTF-8" ?> <slControl> <customer> <customer_id>122</customer_id> <device> <id>18496</id> <name>Johann-Mutter-Str. 002</name> <location>2565</location> <luminaire_point>19049</luminaire_point> <coords> <latitude>48.046474456787</latitude> <longitude>10.873240470886</longitude> </coords> </device> <device> <id>19036</id> <name>Johann-Arnold-Strasse 009</name> <location>2621</location> <coords></coords> </device> </customer> </slControl>
{
"customer": {
"customer_id": "122",
"device": [{
"id": "18496",
"name": "Johann-Mutter-Str. 002",
"location": "2565",
"luminaire_point": "19049",
"coords": {
"latitude": "48.046474456787",
"longitude": "10.873240470886"
}
}, {
"id": "19036",
"name": "Johann-Arnold-Strasse 009",
"location": "2621",
"coords": {}
}]
}
}