Get list of door open/close events for door sensor

Get list of door open/close events for door sensor

POST /api/door/getDoorEventsForSensor

Get list of door open/close events for door sensor

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/door/getDoorEventsForSensor \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "createdAfterMs": 1640995200000,
  "createdBeforeMs": 1640995200000,
  "limit": 100,
  "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "doorEvents": [
    {
      "baseStationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "batteryPercentage": 123,
      "bleDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "bleRssi": 123,
      "closeBaseStations": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "stateChanged": true,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for retrieving door open/close events for a door sensor.

createdAfterMs · integer<int64> | null

Timestamp in milliseconds to get events created after this time

Example:

1640995200000

createdBeforeMs · integer<int64> | null

Timestamp in milliseconds to get events created before this time

Example:

1640995200000

limit · integer<int32> | null

Maximum number of events to return

Example:

100

sensorUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

stateFilter · enum<string>

Filter events by door state

Available options: OPEN, CLOSED, AJAR

Response

200 - application/json

OK

Response object containing door open/close events for a door sensor.

doorEvents · object[] | null

List of door open/close events for the sensor

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null