Occupancy Webservice

Get occupancy events for sensor

Get recent events for specified proximity tag

post/api/occupancy/getOccupancyEventsForSensor

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/occupancy/getOccupancyEventsForSensor
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

createdAfterMsinteger nullable

Filter events created after this timestamp (milliseconds since epoch)

createdBeforeMsinteger nullable

Filter events created before this timestamp (milliseconds since epoch)

limitinteger nullable

Maximum number of events to return

sensorUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "createdAfterMs": 1640908800000,
  "createdBeforeMs": 1640995200000,
  "limit": 100,
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "events": [
    {
      "baseStationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "bleDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "closeBaseStations": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.