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"
}
'import requests
url = "https://api2.rhombussystems.com/api/relay/updateDetailsV2"
payload = {
"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"
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api2.rhombussystems.com/api/relay/updateDetailsV2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/relay/updateDetailsV2")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Primary NVR for main building\",\n \"descriptionUpdated\": true,\n \"directionRadians\": 123,\n \"directionRadiansUpdated\": true,\n \"floorNumber\": 123,\n \"floorNumberUpdated\": true,\n \"latitude\": 123,\n \"latitudeUpdated\": true,\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"locationUuidUpdated\": true,\n \"longitude\": 123,\n \"longitudeUpdated\": true,\n \"name\": \"Main NVR\",\n \"nameUpdated\": true,\n \"policyUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"subLocationsHierarchyKey\": \"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA\",\n \"subLocationsHierarchyKeyUpdated\": true,\n \"uuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Update NVR details V2
Update hardware details of NVR.
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"
}
'import requests
url = "https://api2.rhombussystems.com/api/relay/updateDetailsV2"
payload = {
"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"
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api2.rhombussystems.com/api/relay/updateDetailsV2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/relay/updateDetailsV2")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"Primary NVR for main building\",\n \"descriptionUpdated\": true,\n \"directionRadians\": 123,\n \"directionRadiansUpdated\": true,\n \"floorNumber\": 123,\n \"floorNumberUpdated\": true,\n \"latitude\": 123,\n \"latitudeUpdated\": true,\n \"locationUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"locationUuidUpdated\": true,\n \"longitude\": 123,\n \"longitudeUpdated\": true,\n \"name\": \"Main NVR\",\n \"nameUpdated\": true,\n \"policyUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\",\n \"subLocationsHierarchyKey\": \"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA\",\n \"subLocationsHierarchyKeyUpdated\": true,\n \"uuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
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.
api-token, api, partner-api-token, partner-api Body
Request object for updating NVR details.
Description of the NVR
"Primary NVR for main building"
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Name of the NVR
"Main NVR"
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).
^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"