Doorbell Camera Webservice

Update hardware details of doorbell camera

Update hardware details of doorbell camera.

post/api/doorbellcamera/updateDetails

Request

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

associatedCamerasstring[] nullable

Optional list of associated camera device facet UUIDs

descriptionstring nullable

Optional description for the doorbell camera

deviceUuidstring RUUID nullable

base 64 (url-safe) uuid string

directionRadiansnumber float nullable

Optional direction in radians for the doorbell camera

floorNumberinteger nullable

Optional floor number where the doorbell camera is located

latitudenumber double nullable

Optional latitude coordinate of the doorbell camera

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

longitudenumber double nullable

Optional longitude coordinate of the doorbell camera

namestring nullable

Optional name for the doorbell camera

policyUuidstring RUUID nullable

base 64 (url-safe) uuid string

subLocationsHierarchyKeystring SubLocationsHierarchyKey nullable

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

subLocationsHierarchyKeyUpdatedboolean nullable

Whether the sub-locations hierarchy key has been updated

Example request

{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.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

Changes

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