Camera

Update camera details V2

Update hardware details of camera.

POST/api/camera/updateDetailsV2

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request to update camera information V2 with partial update support.

customDatastring | nullbody

Custom data for the camera

customDataUpdatedboolean | nullbody

Whether custom data was updated

Example: false

deletedboolean | nullbody

Whether the camera is deleted

Example: false

deletedUpdatedboolean | nullbody

Whether deleted status was updated

Example: false

descriptionstring | nullbody

Description of the camera

Example: "Camera monitoring the front entrance"

descriptionUpdatedboolean | nullbody

Whether description was updated

Example: false

directionRadiansnumber<float> | nullbody

Direction in radians

Example: 1.5708

directionRadiansUpdatedboolean | nullbody

Whether direction radians was updated

Example: false

facetNameMapobject | nullbody

Mapping of device facets to names

facetNameMapUpdatedboolean | nullbody

Whether facet name map was updated

Example: false

floorNumberinteger<int32> | nullbody

Floor number

Example: 1

floorNumberUpdatedboolean | nullbody

Whether floor number was updated

Example: false

latitudenumber<double> | nullbody

Latitude coordinate

Example: 37.7749

latitudeUpdatedboolean | nullbody

Whether latitude was updated

Example: false

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationUuidUpdatedboolean | nullbody

Whether location UUID was updated

Example: false

longitudenumber<double> | nullbody

Longitude coordinate

Example: -122.4194

longitudeUpdatedboolean | nullbody

Whether longitude was updated

Example: false

mummifiedboolean | nullbody

Whether the camera is mummified

Example: false

mummifiedUpdatedboolean | nullbody

Whether mummified status was updated

Example: false

namestring | nullbody

Name of the camera

Example: "Front Door Camera"

nameUpdatedboolean | nullbody

Whether name was updated

Example: false

policyUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

policyUuidUpdatedboolean | nullbody

Whether policy UUID was updated

Example: false

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

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

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeyUpdatedboolean | nullbody

Whether sub-locations hierarchy key was updated

Example: false

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/camera/updateDetailsV2' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "customData": "<string>",
    "customDataUpdated": false,
    "deleted": false,
    "deletedUpdated": false,
    "description": "Camera monitoring the front entrance",
    "descriptionUpdated": false,
    "directionRadians": 1.5708,
    "directionRadiansUpdated": false,
    "facetNameMap": {
      "<key>": "<string>"
    },
    "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"
  }'

import requests

url = "https://api2.rhombussystems.com/api/camera/updateDetailsV2"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "customData": "<string>",
    "customDataUpdated": False,
    "deleted": False,
    "deletedUpdated": False,
    "description": "Camera monitoring the front entrance",
    "descriptionUpdated": False,
    "directionRadians": 1.5708,
    "directionRadiansUpdated": False,
    "facetNameMap": {
        "<key>": "<string>"
    },
    "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"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/camera/updateDetailsV2', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "customData": "<string>",
    "customDataUpdated": false,
    "deleted": false,
    "deletedUpdated": false,
    "description": "Camera monitoring the front entrance",
    "descriptionUpdated": false,
    "directionRadians": 1.5708,
    "directionRadiansUpdated": false,
    "facetNameMap": {
      "<key>": "<string>"
    },
    "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"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "customData": "<string>",
              "customDataUpdated": false,
              "deleted": false,
              "deletedUpdated": false,
              "description": "Camera monitoring the front entrance",
              "descriptionUpdated": false,
              "directionRadians": 1.5708,
              "directionRadiansUpdated": false,
              "facetNameMap": {
                "<key>": "<string>"
              },
              "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"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/camera/updateDetailsV2"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response indicating the result of updating camera information V2.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.