Doorbell Camera Webservice

Retrieve all component events relevant to the specified Doorbell Camera

Retrieve all component events relevant to the specified Doorbell Camera

post/api/doorbellcamera/findComponentEventsForDoorbellCamera

Request

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

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

createdBeforeMsinteger nullable

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

doorbellCameraUuidstring RUUID nullable required

base 64 (url-safe) uuid string

limitinteger nullable required

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

typeFilterComponentEventEnumType[] nullable

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

Example request

{
  "createdAfterMs": 1640995200000,
  "createdBeforeMs": 1640995200000,
  "doorbellCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "limit": 50
}

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

{
  "componentEvents": [
    {
      "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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