Camera

Update camera line crossing thresholds

Updates the line-crossing feature for a camera. Accepts two points which define a line that determines the threshold for which INGRESS and EGRESS events will be generated. Consider the top-left corner of a camera's image to be the origin (0,0).

POST/api/camera/updateCameraLineCrossingThresholds

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 line crossing thresholds for a camera.

cameraUuidstring<DeviceFacetUuid> | nullbody

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

directionsenum<string>[] | nullbody

Set of crossing directions to monitor.

invertedboolean | nullbody

By default, INGRESS events occur when the following condition is met for the following line types: an entity moves from top -> bottom when a horizontal line is defined, an entity moves from left -> right when a vertical line is defined, an entity moves from top-left -> bottom-right when an upwards sloping line is defined, and an entity moves from top-right to bottom-left when a downwards sloping line is defined. Setting this value to true will switch INGRESS to EGRESS events and vice-versa.

Example: false

objectTypeenum<string>body

Available options: HUMAN, VEHICLE, FACE, LPR, POSE, CLIP_EMBED, UNKNOWN

pointAobjectbody

(X,Y) coordinate expressed as a percentage of the camera's resolution.Minimum range is 0.1 and maximum range is 0.9. Leaving this value as null will disable line-crossing.

Show child attributes

xnumber<float> | nullbody

Value ranges from 0.1 to 0.9

Example: 0.5

ynumber<float> | nullbody

Value ranges from 0.1 to 0.9

Example: 0.5

pointBobjectbody

(X,Y) coordinate expressed as a percentage of the camera's resolution.Minimum range is 0.1 and maximum range is 0.9. Leaving this value as null will disable line-crossing.

Show child attributes

xnumber<float> | nullbody

Value ranges from 0.1 to 0.9

Example: 0.5

ynumber<float> | nullbody

Value ranges from 0.1 to 0.9

Example: 0.5

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/camera/updateCameraLineCrossingThresholds' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "directions": [
      "INGRESS"
    ],
    "inverted": false,
    "objectType": "HUMAN",
    "pointA": {
      "x": 0.5,
      "y": 0.5
    },
    "pointB": {
      "x": 0.5,
      "y": 0.5
    }
  }'

import requests

url = "https://api2.rhombussystems.com/api/camera/updateCameraLineCrossingThresholds"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "directions": [
        "INGRESS"
    ],
    "inverted": False,
    "objectType": "HUMAN",
    "pointA": {
        "x": 0.5,
        "y": 0.5
    },
    "pointB": {
        "x": 0.5,
        "y": 0.5
    }
}

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/updateCameraLineCrossingThresholds', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "directions": [
      "INGRESS"
    ],
    "inverted": false,
    "objectType": "HUMAN",
    "pointA": {
      "x": 0.5,
      "y": 0.5
    },
    "pointB": {
      "x": 0.5,
      "y": 0.5
    }
  }),
});
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 = """
            {
              "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
              "directions": [
                "INGRESS"
              ],
              "inverted": false,
              "objectType": "HUMAN",
              "pointA": {
                "x": 0.5,
                "y": 0.5
              },
              "pointB": {
                "x": 0.5,
                "y": 0.5
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/camera/updateCameraLineCrossingThresholds"))
            .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 line crossing thresholds.

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.