Skip to main content
POST
/
api
/
relay
/
updateDetailsV2
Update NVR details V2
curl --request POST \
  --url https://api2.rhombussystems.com/api/relay/updateDetailsV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "description": "Primary NVR for main building",
  "descriptionUpdated": true,
  "directionRadians": 123,
  "directionRadiansUpdated": true,
  "floorNumber": 123,
  "floorNumberUpdated": true,
  "latitude": 123,
  "latitudeUpdated": true,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "locationUuidUpdated": true,
  "longitude": 123,
  "longitudeUpdated": true,
  "name": "Main NVR",
  "nameUpdated": true,
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKeyUpdated": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for updating NVR details.

description
string | null

Description of the NVR

Example:

"Primary NVR for main building"

descriptionUpdated
boolean | null
directionRadians
number<float> | null
directionRadiansUpdated
boolean | null
floorNumber
integer<int32> | null
floorNumberUpdated
boolean | null
latitude
number<double> | null
latitudeUpdated
boolean | null
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

locationUuidUpdated
boolean | null
longitude
number<double> | null
longitudeUpdated
boolean | null
name
string | null

Name of the NVR

Example:

"Main NVR"

nameUpdated
boolean | null
policyUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKey
object

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

Example:

"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeyUpdated
boolean | null
uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object for updating NVR details.

error
boolean | null
errorMsg
string | null
warningMsg
string | null