Retrieve all component events relevant to the specified Doorbell Camera

Retrieve all component events relevant to the specified Doorbell Camera

POST /api/doorbellcamera/findComponentEventsForDoorbellCamera

Retrieve all component events relevant to the specified Doorbell Camera

cURL

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
}
'

200

{
  "componentEvents": [
    {
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "correlationId": "<string>",
      "createdAtMs": 123,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "timestampMs": 123,
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "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 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

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Show child attributes

error · boolean | null

errorMsg · string | null

warningMsg · string | null