Get the List of Emergency Fixtures by Floor

This API retrieves the fixture details and Fixture IDs for the sensors based on the designated sensor or fixture type. 

Note: This API is an enhancement to the Get Sensor Location by Floor API, allowing you to filter results based on sensor type. Enlighted Manage (EM) versions below 3.10 do not support filtering based on sensor type. 

 The sensors in Manage are classified into the following types: 

  • Emergency sensors –  Returns sensors designated as emergency fixtures in the Manage (EM)
  • Desk sensors  – Returns sensors designated as Desk sensors in EM. See Enable Desk Sensors.
  • Fixtureless sensors  Returns sensors designed as Fixtureless in EM including Desk sensors.  
  • Fixtured sensors  Returns sensors that are not designated as fixtureless sensors.

Refer to the article Adding and Managing Fixture Database in the Manage to understand how fixture types are categorized and added to the Manage as fixtures and fixtureless sensors.

The API response is filtered based on the category of sensors. When the category or class is not specified in the API call, the response is not filtered. If the Floor ID is incorrect, the command returns 400 with the message "Floor ID does not exist, please correct and try again".

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/fixture/location/list/floor/{floor_id}/1?class={filter}

Parameters

Request  Description

em_ip_address_or_hostname

The Manage IP address or hostname

floor-id

Floor ID. Use the Get All Floors API to obtain the Floor ID.

filter

Filter: Class Value. Specify only one filter class, if the filter class is not specified, then the response is not filtered.

  • Emergency – Returns sensors designated as emergency fixtures in the Energy Manager (EM)
  • Desk – Returns sensors designated as Desk sensors in EM
  • Fixtureless – Returns sensors designed as Fixtureless in EM including Desk sensors.
  • Fixtured – Returns sensors that control lighting fixtures.
Response   
fixture-id Sensor or Fixture ID.

Fixture:

id

Fixture identifier

name

Name of the Fixture

xaxis

Scaled reference of the distance measured in the horizontal dimension from the lower-left corner of the uploaded floor plan

yaxis

Scaled reference of the distance measured in the vertical dimension from the lower-left corner of the uploaded floor plan.

macaddress

MAC Address

groupid

Profile group identifier. The ID of the profile associated with the fixture.  

class

Sensor Type: Emergency, Desk, Fixtureless, Fixtured

Sample Code

Send a request to retrieve fixture details filtered based on the type of sensors 'fixtured' on Floor 2. The API returns the fixture details of all sensors that control light fixtures (fixtured) on Floor 2.

GET https: //10.4.23.19/ems/api/org/fixture/location/list/floor/2/fixtured
HTTP/1.1 200

{
fixture: [
{
id: 28
name: Sensor00c017,
xaxis: 966,
yaxis: 391,
macaddress: 0:c0:17,
groupid: 185,           
class: fixtured

}
{
id: 1364
name: Sensor00629dd,
xaxis: 270,
yaxis: 90,
macaddress: 6:29:dd,
groupid: 196,           
class: fixtured
}
{
id:17
...
}
]
}
Was this article helpful?
0 out of 1 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.