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 
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
{
  "floor": [
    {
      "id": "1",
      "name": "First Floor",
     "buildingName": "Main Building",
     "campusName": "Hampton Campus",
     "organization": "Acme Inc",
      "description": "Sales and Marketing",
     "floorPlanUrl": "Main_bldg_flr1.jpg"
    },
    {
      "id": "2",
      "name": "Second Floor",
     "buildingName": "Main Building",
     "campusName": "Hampton Campus",
     "organization": "Acme Inc",
     "description": "Engineering and Product",
     "floorPlanUrl": "Main_bldg_flr2.jpg"
    },
    {
      "id": "3",
      "name": "Third Floor",
     "buildingName": "Main Building",
     "campusName": "Hampton Campus",
     "organization": "Acme Inc",
     "description": "Finance",
     "floorPlanUrl": "Main_bldg_flr3.jpg"
    }
  ]
} 

 

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.