Relay Webservice

Update NVR details V2

Update hardware details of NVR.

post/api/relay/updateDetailsV2

Request

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

descriptionstring nullable

Description of the NVR

descriptionUpdatedboolean nullable
directionRadiansnumber float nullable
directionRadiansUpdatedboolean nullable
floorNumberinteger nullable
floorNumberUpdatedboolean nullable
latitudenumber double nullable
latitudeUpdatedboolean nullable
locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationUuidUpdatedboolean nullable
longitudenumber double nullable
longitudeUpdatedboolean nullable
namestring nullable

Name of the NVR

nameUpdatedboolean nullable
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
uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "description": "Primary NVR for main building",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "Main NVR",
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "uuid": "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.