Doorbell Camera Webservice

Get all rules for a doorbell camera

Get all rules for a doorbell camera.

post/api/doorbellcamera/getRulesForDoorbellCamera

Request

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

doorbellCameraUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "doorbellCameraUuid": "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

{
  "rules": [
    {
      "action": {
        "activateLocationLockdown": {
          "locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        },
        "audioPlaybackActions": [
          {
            "audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "audioGateways": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ]
          }
        ],
        "cancelLoopingAudioPlaybackAction": {
          "_audioDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA.v0"
          ],
          "audioDevices": [
            "AAAAAAAAAAAAAAAAAAAAAA.v0"
          ]
        },
        "changeComponentCompositeAccessStateActions": [
          {
            "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ],
        "connectAudioDeviceToMobileAppAction": {
          "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "targetDoorStationUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ],
          "targetUserUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ]
        },
        "connectAudioDeviceToPhoneNumberAction": {
          "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "doorUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        },
        "createAlarmAction": {
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "mediaDeviceUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA.v0"
          ],
          "sirenSettings": {
            "audioGateways": [
              "AAAAAAAAAAAAAAAAAAAAAA"
            ],
            "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
        },
        "customLLMActions": [
          {
            "deviceFacetUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA.v0"
            ],
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ],
        "enableDisableAudioRecordActions": [
          {
            "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ],
        "robotActions": [
          {
            "mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ],
        "thirdPartyAudioPlaybackAction": {
          "proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        },
        "thirdPartyStrobeSirenAction": {
          "proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        },
        "triggerComponentRelayActions": [
          {
            "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ]
      },
      "doorbellCameraComponentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "doorbellCameraUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleFilters": {
        "scheduleUuids": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "ruleName": "Motion Detection Rule",
      "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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