Get Organization Details
Returns details about the organization. The data includes the list of all campuses in the organization.
GET https://{em_ip_address_or_hostname}/ems/api/org/company
Parameters
| Request | |
| em_ip_address or hostname | The Manage’s IP address or hostname |
| Response | |
| id | Organization identifier from Manage |
| name | Organization name as described in the Manage |
| address | Organization address |
| contact | Company's contact phone information |
| The email address of the contact person in the company | |
| completionstatus | For internal use |
| validdomain | The domain name for the company |
| price | Electricity rate in cents per kWh |
| timezone_name | Timezone information for the specified organization location |
| campus |
List of campuses in the company along with details for each campus
|
| location | Campus location |
| title 24 compliance | Enabled if the site is geographically located where Title 24 is required Yes: Enabled, No: Disabled |
| latitude | Company’s latitude coordinate |
| longitude | Company’s longitude coordinate |
Sample Code
Send a request to Manage to return the list of all campuses in an organization. The response includes the company ID, company name, organization contact details, and list of all campuses in the organization. For example, the company, Acme Inc., has two campuses, Hampton and Monroe. The response displays organization and campuses details.
|
|
Get All Campuses (DRAFT)
Returns the list of campuses for an organization.
GET https://{em_ip_address_or_hostname}/ems/api/org/campus/list/1
Parameters
| Request | |
| em_ip_address or hostname | The Manage IP address or host name |
| Response | |
| id | Campus identifier from the Manage |
| name | Campus name as described in the Manage |
| location | Company's location in string |
| contractBaseline | Baseline energy savings for the campus |
| calcMethod |
Energy savings are 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. |
Sample Code
In the example, the details of campuses for Acme Inc., are returned when you send a GET request to Manage.
Get https://{192.80.3.2}/ems/api/org/campus/list/1 |
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 |
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 |
Get All Floors
Returns the list of all floors in the building of an organization.
Request
GET https://{em_ip_address_or_hostname}/ems/api/org/floor/v1/list
Parameters
| Request | |
| em_ip_address or hostname: | Enlighted Manage (EM) IP address or hostname |
| Response | |
| Id** | Floor identifier. (**used as the primary identifier in other API calls) |
| name: | Floor name as described in Manage |
| buildingName: | Building name |
| campusName: | Campus name |
| organization: | Organization name |
| description: | Floor description; this field will be empty if it is not described in the EM |
| floorPlanUrl: | Floor plan image name. If the floor plan does not have a name, it is returned as default_floor_plan.gif |
Sample Code
Send a request to Manage using its IP address to return the list of all floors in the building. For example, if the Main building in Hampton campus has three floors: First Floor, Second Floor, and Third Floor, the response will include details for all three floors. The Floor ID can be used as a primary identifier in other API calls.
Get https://{192.80.3.2}/ems/api/org/floor/v1/list |
Get Floor Plan Image
Returns the floor plan image for a particular floor.
Request
GET https://{em_ip_address_or_hostname}/ems/api/org/floor/{floor_id}
Parameters
| Request | |
| em_ip_address or hostname | The Enlighted Manage (EM) IP address or hostname |
| floor_id | Floor identifier. Use the Floor ID returned in 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 | |
| Floor plan image | Displays the floor plan image |