Get Fixture Dim Level by Floor

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:

  1. Emergency sensors: Sensors designated as emergency fixtures in Manage 
  2. Desk sensors: Sensors designated as desk sensors 
  3. Fixtureless sensors: Sensors designed as fixtureless, including desk sensors
  4. 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

  • 'emergency' (only returns sensors designated as emergency fixtures in Manage)
  • 'desk' (only returns sensors designated as desk sensors in EM)
  • 'fixtureless' (only returns sensors designed as fixtureless in EM, will be fully inclusive of desk sensors)
    • returns ‘-1’ as dimLevel
  • 'fixtured' (only returns sensors that are not designated as fixtureless, completely exclusive of fixtureless, completely inclusive of ‘Emergency’).

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

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 837
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
"sensor":[
{
"dimLevel": "37",
"id": "80",
},
{
"dimLevel": "85",
"id": "79",
},

{
...
}
],
"page": "4",
"records": "115",
"total": "6"
}

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.