Get All Buildings API¶
Retrieve the list of all buildings on the campus for the organization, including the Building ID and Building details.
Request¶
GET https://{em_ip_address_or_hostname}/ems/api/org/building/list/{campus_id}
Parameters¶
Request¶
| Name | Description |
|---|---|
em_ip_address_or_hostname | The Enlighted Manage (EM) IP address or hostname |
campus_id | The ID of the campus for which all buildings will be returned |
Response¶
| Name | Description |
|---|---|
id | Building identifier from Manage |
name | Building name as described in 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 Request¶
Send a GET request to return the list of all buildings for the campus ID. Details are returned as an object response if a single building is available on the campus. If more than one building is available on 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
Sample Response¶
{
"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"
}
]
}