Door Webservice

Get list of door open/close events for door sensor

Get list of door open/close events for door sensor

post/api/door/getDoorEventsForSensor

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/door/getDoorEventsForSensor
  • 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

Timestamp in milliseconds to get events created after this time

createdBeforeMsinteger nullable

Timestamp in milliseconds to get events created before this time

limitinteger nullable

Maximum number of events to return

sensorUuidstring RUUID nullable

base 64 (url-safe) uuid string

stateChangedOnlyboolean nullable

When true, only return events where the door state actually changed (open/close transitions), excluding the periodic heartbeat events that report an unchanged state

stateFilter'OPEN' | 'CLOSED' | 'AJAR'

Filter events by door state

Example request

{
  "createdAfterMs": 1640995200000,
  "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

{
  "doorEvents": [
    {
      "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.