Get Real-time Desk Occupancy for a Floor

This API returns the desk occupancy for all desk sensors on a floor.

You will need the IoT sensor license and Real-time Desk Occupancy API License (API-RTO-DSK) to get real-time desk occupancy for a floor. Read Request License to purchase licenses if you have not, and assign 'Desk Sensor' Fixture Type to sensors before using this API call. Refer to the article Enable Desk Sensors that describes how to assign 'Desk Sensor' Fixture Type to sensors. 


GET https://{em_ip_address_or_hostname}/ems/api/org/sensor/v1/getDeskOccupancyState/list/floor/{floor_id}



em_ip_address or hostname

Manage’s IP address or hostname


Floor identifier. Use the Floor ID returned in the Get All Floors API, or in Manage, select Facility > Floor in the left panel, and click the Settings tab to see the Floor ID.



The fixture or sensor identifier. 


Sensor name.


0 – Desk Unoccupied

1 – Desk Occupied

-1 – Fault. Sensors are not reporting occupancy


Sample Code

For example, if Floor 1 has three desk sensors, send a request to return the Desk occupancy for all desk sensors on the floor. The occupancy status for all desk sensors on Floor 1 is returned.


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
    "deskSensor": [
            "id": "70",
            "name": "Sensor71bd6a",
            "occupancyState": "0"
            "id": "71",
            "name": "Sensor71af2a",
            "occupancyState": "0"
            "id": "72",
            "name": "Sensor71b13e",
            "occupancyState": "1"
Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request


Article is closed for comments.