OSIS Location Use End-point - Tracking Real-time Utilization

Overview

The location use end-point is primarily used for recording real-time utilization events relation to room locations. The data is typically pushed to OSIS from sensor vendors.

The location use data is then used in floor-plan visualizations when display the current occupancy status of a room, a person has been detected occupying a room.

Mapping Sensor IDs To Locations (Rooms)

In order for OSIS to properly associate a sensor reading on a floor plan the sensor ID will need to be paired with an OSIS location ID.

API End-point
POST /api/sensormap/
Items To Keep In Mind
  • A sensor_id and location need to be unique together
  • The location represents an OSIS room ID and can be retrieved from the rooms API endpoint: 
      GET /api/room/
Sample Body
{
    "sensor_id": "05F-F5F8",
    "location": 4626
}

Recording Real-time Sensor Data

API End-point
POST /api/locuse/
Items To Keep In Mind
  • Ensure that event_type and event_interval are both always set to 1
  • event_end and event_start will be the same date and time as an indicator of the measurements point in time
  • sensor_id indicates the vendor supplied unique code representing the identifier for the sensor used to monitor a room. OSIS expects the ID to have a 1 to 1 relationship with a room record.
  • use_type can be 1 for an occupied room or 0 to indicate an un-occupied room
  • Date/time values to be UTC
Sample Body
{
    "use_type": 1,
    "event_type": 1,
    "event_interval": 1,
    "event_start": "2020-05-19T18:00:00Z",
    "event_end": "2020-05-19T18:00:00Z",
    "sensor_id": "05F-F5F8"
}