Get all Areas

In the Enlighted Manage (EM), the organization hierarchy includes campuses, buildings, floors, and areas. An area on a floor is a grouping of a subset of devices including gateways, sensors, Enlighted Room Control (ERCs) switches, plugloads, etc., on a floor. Areas are assigned on a floor based on usage or a specific purpose profile of the area in EM.

This API returns details of all areas on a floor. The Area ID returned for each area is used as the primary identifier in other API calls.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/area/v2/list/{floor_id}

Parameters

Request
em_ip_address or hostname The Manage’s IP address or hostname
floor_id Floor identifier. Use the Get All Floors API, or in EM, select Facility > Floor > in the left panel, and click the Settings tab to obtain the Floor ID.
Response
Id** Area identifier (**used as the primary identifier in other API calls)
name Area name as described in the EM
description Area description as described in the EM. The field will be empty if there is no description entered in the EM.
zonesensorenable

The area has been activated as a zone sensor area. The area starts reporting consolidated occupancy status information from individual sensors. Note that the zone sensor license must be purchased and available for the sensors to report occupancy information. Otherwise, occupancy data is not reported by the sensors.

true – Sensors in the area are enabled as zone sensors.
false – Sensors in the area are disabled as zone sensors.

Sample Code

Send a request to return the list of all areas on the first floor with ID ‘1’. For example, if the first floor has two areas: Hardware and Software, the details of the areas along with their corresponding Area IDs ‘9’ and ‘27’ will be returned as shown below. The Area IDs are used as the primary identifiers in other API calls.

Get https://{192.80.3.2}/ems/api/org/area/v2/list/1

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
"area": [
{
   "id": "9", **Area ID**
  "name": "Hardware",
  "description": "hw eng",
  "zonesensorenable": "true",
},
{
  "id": "27", **Area ID**
  "name": "Software",
  "description": "sw eng",
  "zonesensorenable": "false",
}
]
}

 

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

Comments

Please sign in to leave a comment.