Skip to main content
POST
/
api
/
camera
/
updateDetailsV2
Update camera details V2
curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/updateDetailsV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "customData": "<string>",
  "customDataUpdated": false,
  "deleted": false,
  "deletedUpdated": false,
  "description": "Camera monitoring the front entrance",
  "descriptionUpdated": false,
  "directionRadians": 1.5708,
  "directionRadiansUpdated": false,
  "facetNameMap": {},
  "facetNameMapUpdated": false,
  "floorNumber": 1,
  "floorNumberUpdated": false,
  "latitude": 37.7749,
  "latitudeUpdated": false,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "locationUuidUpdated": false,
  "longitude": -122.4194,
  "longitudeUpdated": false,
  "mummified": false,
  "mummifiedUpdated": false,
  "name": "Front Door Camera",
  "nameUpdated": false,
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "policyUuidUpdated": false,
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKeyUpdated": false,
  "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 to update camera information V2 with partial update support.

​
customData
string | null

Custom data for the camera

​
customDataUpdated
boolean | null

Whether custom data was updated

Example:

false

​
deleted
boolean | null

Whether the camera is deleted

Example:

false

​
deletedUpdated
boolean | null

Whether deleted status was updated

Example:

false

​
description
string | null

Description of the camera

Example:

"Camera monitoring the front entrance"

​
descriptionUpdated
boolean | null

Whether description was updated

Example:

false

​
directionRadians
number<float> | null

Direction in radians

Example:

1.5708

​
directionRadiansUpdated
boolean | null

Whether direction radians was updated

Example:

false

​
facetNameMap
object

Mapping of device facets to names

​
facetNameMapUpdated
boolean | null

Whether facet name map was updated

Example:

false

​
floorNumber
integer<int32> | null

Floor number

Example:

1

​
floorNumberUpdated
boolean | null

Whether floor number was updated

Example:

false

​
latitude
number<double> | null

Latitude coordinate

Example:

37.7749

​
latitudeUpdated
boolean | null

Whether latitude was updated

Example:

false

​
locationUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
locationUuidUpdated
boolean | null

Whether location UUID was updated

Example:

false

​
longitude
number<double> | null

Longitude coordinate

Example:

-122.4194

​
longitudeUpdated
boolean | null

Whether longitude was updated

Example:

false

​
mummified
boolean | null

Whether the camera is mummified

Example:

false

​
mummifiedUpdated
boolean | null

Whether mummified status was updated

Example:

false

​
name
string | null

Name of the camera

Example:

"Front Door Camera"

​
nameUpdated
boolean | null

Whether name was updated

Example:

false

​
policyUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
policyUuidUpdated
boolean | null

Whether policy UUID was updated

Example:

false

​
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

Whether sub-locations hierarchy key was updated

Example:

false

​
uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response indicating the result of updating camera information V2.

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