Get Organization Details
Returns details about the organization. The data returned includes the list of all campuses in the organization. The company and campus IDs returned are used as the primary identifiers in other API calls.
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 |
| title 24 compliance | Enabled if the site is geographically located where Title 24 is required |
| latitude | Company’s latitude coordinate |
| longitude | Company’s longitude coordinate |
Sample Code
Using your EM IP address, send a request to return the list of all campuses belonging to the organization. The sample response includes the company ID, company name, along with the contact details for the organization, and the list of all campuses belonging to the organization. In the example below, the company, Acme Inc., has two campuses, Hampton and Monroe. The response displays organization details for Acme Inc., along with details of both the campuses.
| Get https://{192.80.3.2}/ems/api/org/company HTTP/1.1 200 OK Server: Apache-Coyote/1.1 Content-Type: application/json Content-Length: 7582 Date: Sat, 21 Jul 2015 17:06:51 GMT { "id": "1", "name": "Acme Inc.", "address": "Sunnycreek, CA\r\nUSA", "contact": "408 555-1212", "email": "peter@acme.com", "completionstatus": "3", "validdomain": "acme.com", "price": "0.15", "timezone_name": "America/Los_Angeles", "campus": [ { "id": "3", "name": "Hampton Campus", "calcMethod": "SENSOR_BASED", "contractBaseline": "0.00" }, { "id": "5", "name": "Monroe Campus", "calcMethod": "SENSOR_BASED", "contractBaseline": "0.00" }, ], "ntpEnable": "Y", "ntpServers": "0.us.pool.ntp.org,1.us.pool.ntp.org,2.us.pool.ntp.org,3.us.pool.ntp.org", "title24": { "compliance": { "flag": "No" }, …… "formtype": "" }, "latitude": "37.39428", "longitude": "-122.03806" } |
Get All Campuses
Returns the list of all campuses in the 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 |
| 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. |
| contractBaseline | Baseline energy savings for the campus. |
Sample Code
In the example, the details of both campuses for Acme Inc., are returned when you send a request with the EM IP address.
Get https://{192.80.3.2}/ems/api/org/campus/list/1 |
Get All Buildings
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 that is returned for each building is used as the primary identifier for obtaining the list of floors in 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 your EM IP address, send a request to return the list of all buildings on the campus. 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 |
Get All Floors
Returns the list of all floors in the building of an organization. The Floor ID returned for each floor in the building is used as the primary identifier in other API calls.
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. Note that the Floor ID returned for each floor is used as the 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 |