This API returns the 'current' dim level of fixtures on a floor. The API uses pagination with the ‘page’ query parameters to paginate through the items in a collection. Pagination reduces the overall payload size and increases the API performance.
The sensors in Manage are classified into the following four types; only emergency and fixtured sensors may have dim levels:
- Emergency sensors: Sensors designated as emergency fixtures in Manage
- Desk sensors: Sensors designated as desk sensors
- Fixtureless sensors: Sensors designed as fixtureless, including desk sensors
- Fixtured sensors: Sensors that are not designated as fixtureless; exclusive of 'fixtureless' and inclusive of ‘emergency’ sensors
Request
GET https://{em_ip_address_or_hostname}/ems/api/org/sensor/dimlevel/list/floor/{floor_id}?class={class}&page={page_number}
Parameters
Request |
|
em_ip_address or hostname |
Manage server IP address or hostname |
floor_id |
Floor identifier. Use the Floor ID returned in the Get All Floors API, or in Enlighted Manage (EM), select Facility > Floor in the left panel, and click the Settings tab to obtain the Floor ID. |
class |
|
page |
The page for which data will be retrieved. Twenty (20) records are returned per page. |
Response |
|
Id** |
Fixture identifier |
dimlevel |
Most recent dim level of the fixture, updated every 600 seconds (5 minutes); 0-100% |
page |
The page currently being returned; integer |
records |
Total number of resources recorded across all pages; integer |
total |
Total page count to return all resources for the request; no max, integer |
Sample Code
Request the current dim level details for fixtures on the first floor with Floor ID ‘1’. The first floor has 115 fixtures, and the user requests the fourth page of 5 pages. The API returns dim level for 20 fixtures on the floor.
Get https:// 192.80.3.2/ems/api/org/sensor/dimlevel/list/floor/1?class=fixtured&page=4 |
Comments
Article is closed for comments.