Indoor Positioning

The Indoor Positioning API supports the following services to access data:

  1. REST Service
    1. Retrieve historical event data for assets in a location
    2. Receive near real-time event data for assets in a location

a – Retrieve historical event data for assets in a location

METHOD GET
URI <production url>/enterprise/environment/locations/<locationUid>/

events?eventType=IPS_EVENT&startTime=1480928400000&endTime=1481007600000

Sample URI

<production url>/enterprise/environment/locations/ENT_LAYOUT_qagkvg3mn/

events?eventType=IPS_EVENT&startTime=1480928400000&endTime=1481007600000

Query Parameters

Parameter Description Required? Filter Values
locationUid GE Identifier for a location Yes Value such as "ENT_LAYOUT_qagkvg3mn".
events? Query for near real-time event data Yes eventType
eventType

Filter for environment event

Yes Insert the following enumeration codes to receive indoor position data:
  • IPS_EVENT - Indoor Position data
startTime Start time (timestamp) recorded in EPOCH format (milliseconds). Yes

Numerical value, such as

1453766605577.
Note: If you use the same timestamp for startTime and endTime, a single result will be returned.
endTime Start time (timestamp) recorded in EPOCH format (milliseconds). Yes

Numerical value, such as

1453766605577.

b - Receive near real-time event data for assets in a location

Method GET
URI <production url>/enterprise/environment/locations/<locationUid>/ latestEvent?eventType=<eventType>
Sample URI <production url>/enterprise/environment/locations/LOCATION-282/ latestEvent?eventType=OCCUPANCY

Query Parameters

Parameter Description Required? Filter Values
locationUid GE Identifier for a location Yes Value such as "LOCATION-282".
latestEvent? Query for near real-time event data Yes eventType
eventTypes Filter for environment event Yes See the enumeration codes for eventTypes : ENTERPRISES in the Glossary for Intelligent Enterprises.

Sample Response

{
  "content": [
    {
      "locationUid": "location_IPS_002",
      "assetUid": null,
      "eventType": "IPS_EVENT",
      "timestamp": 1491265280729,
      "properties": {
        "sessionId": "f221d2c4-4dc0-4a61-80a8-edd7559aeaec",
        "userType": "CUSTOMER",
        "deviceId": "SimulatorDeviceId",
        "sourceType": "VLC"
      }
   }
 ]
} 

JSON Response Parameters

Parameter Data Type Description
locationUid String Unique, customer-defined identifier for a specific location.
assetUid String The customer-defined identifier for a specific asset.
eventType String Identifies this type of event:
  • CO2 – Carbon dioxide measurement data
  • HUMIDITY – Relative humidity measurement data
  • LIGHT_LEVEL – Ambient light measurement data
  • OCCUPANCY – Occupancy measurement data
  • TEMP – Ambient temperature data
timestamp Number Actual timestamp when event occurred. Timestamps are in EPOCH format (milliseconds).
properties N/A Custom properties captured for this event type.
...sessionId N/A Unique system-defined identifier for indoor position session.
...userType N/A Customer-defined type for device user.
Measures N/A Event type measurement data
...deviceId N/A Unique system-defined identifier for mobile device.
...durationInSec N/A Dwell time at position (seconds)
...orientation N/A Angle direction (degrees)
...x N/A x coordinate (meters)
...y N/A y coordinate (meters)
...z N/A z coordinate (meters)