Get All Buildings

The API returns the list of all buildings on the campus for the organization. The data returned includes all buildings with building identifiers and details. The building ID returned can be used for obtaining the list of floors with the Get All Floors API. 

GET https://{em_ip_address_or_hostname}/ems/api/org/building/list/campusId

Parameters

Request 
em_ip_address or hostname The Enlighted Manage’s (EM) IP address or hostname
campusId The ID of campus for which all buildings will be returned
Response 
id Building identifier from the Manage
name Building name as described in the Manage
useOrgLocation For internal use
visible For internal use
useOrgLocationTz For internal use
energySaveCalcMethod

Energy savings calculated based on the sensor’s baseline energy or contract baseline energy.

SENSOR_BASED – Savings based on the sensor’s baseline energy

CONTRACTUAL – Savings based on contract baseline energy. The contract baseline energy is calculated using the annual baseline energy savings stipulated in the customer’s signed agreement for the campus at the time of installation.

contractBaseline

Baseline energy savings for the campus.

Sample Code

Using Manage IP address, send a GET request to return the list of all buildings for the campus ID. If a single building is available in the campus, details are returned as an object response. If more than one building is available in the campus, details are returned as an array response.

In the example below, the campus has a single building called ‘Main Building’ and its details are returned as shown.

GET https://{192.80.3.2}/ems/api/org/building/list/3
{
   "building": {
       "id": "4",
       "name": "Main Building",
       "useOrgLocation": "true",
       "visible": "true",
       "useOrgLocationTz": "true",
       "energySaveCalcMethod": "SENSOR_BASED",
       "contractBaseline": "0.00"
   }
}

When a campus has two buildings: ‘Main 5’ and 'Main 6', their details are returned as shown below.

GET https://{192.80.3.2}/ems/api/org/building/list/4
{
   "building": [
  {
       "id": "5",
       "name": "Main 5",
       "useOrgLocation": "true",
       "visible": "true",
       "useOrgLocationTz": "true",
       "energySaveCalcMethod": "SENSOR_BASED",
       "contractBaseline": "0.00"
   },
   {
       "id": "6",
       "name": "Main 6",
       "useOrgLocation": "true",
       "visible": "true",
       "useOrgLocationTz": "true",
       "energySaveCalcMethod": "SENSOR_BASED",
       "contractBaseline": "0.00"
   }
]
}

 

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

Comments

Article is closed for comments.