Skip to main content
POST
/
api
/
doorbellcamera
/
findComponentEventsForDoorbellCamera
Retrieve all component events relevant to the specified Doorbell Camera
curl --request POST \
  --url https://api2.rhombussystems.com/api/doorbellcamera/findComponentEventsForDoorbellCamera \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "doorbellCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "limit": 50,
  "createdAfterMs": 1640995200000,
  "createdBeforeMs": 1640995200000,
  "typeFilter": [
    "DoorbellEvent"
  ]
}
'
{
  "componentEvents": [
    {
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "newSupervisionState": "CUT_DETECTED",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "correlationId": "<string>",
      "createdAtMs": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123,
      "type": "DoorbellEvent",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for retrieving component events for a doorbell camera.

​
doorbellCameraUuid
string<RUUID> | null
required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
limit
integer<int32> | null
required

Limits the number of returned events to the latest LIMIT events. Maximum value is 100.

Example:

50

​
createdAfterMs
integer<int64> | null

Returns events created after (exclusive) the specified millisecond epoch timestamp

Example:

1640995200000

​
createdBeforeMs
integer<int64> | null

Returns events created before (exclusive) the specified millisecond epoch timestamp

Example:

1640995200000

​
typeFilter
enum<string>[] | null

Limits results to only contain the specified type of events, if applicable

Limits results to only contain the specified type of events, if applicable

Available options:
DoorbellEvent,
DoorReaderStateChangeEvent,
DoorRelayStateChangeEvent,
DoorPositionIndicatorStateChangeEvent,
RequestToExitStateChangeEvent,
CredentialReceivedEvent,
ButtonEvent,
GenericInputStateChangeEvent,
GenericRelayStateChangeEvent,
AccessControlUnitTamperEvent,
AccessControlUnitLocationLockdownStateEvent,
DoorLocationLockdownStateEvent,
PanicButtonEvent,
AccessControlUnitBatteryStateChangeEvent,
WaveToUnlockIntentExpiredEvent,
DoorStateChangeEvent,
DoorAuthFirstInStateEvent,
DoorScheduleFirstInStateEvent,
AccessControlUnitDoorFirstInStateEvent,
AperioDoorExtensionStateEvent,
AperioActivatorStateEvent,
AperioKeyCylinderStateEvent,
AperioDoorModeEvent,
AperioDoorHandleStateEvent,
AperioGatewayStateEvent,
AperioGatewayConnectionStateChangeEvent,
AperioDtcEvent,
AperioTamperStateEvent

Response

200 - application/json

OK

Response object containing component events for a doorbell camera.

​
componentEvents
object[] | null

List of component events for the doorbell camera

List of component events for the doorbell camera

​
error
boolean | null
​
errorMsg
string | null
​
warningMsg
string | null