Camera Webservice

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

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/camera/updateCameraLineCrossingThresholds
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

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.

Request body

cameraUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

directionsCrossingDirectionEnum[] nullable

Set of crossing directions to monitor.

invertedboolean nullable

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.

objectType'HUMAN' | 'VEHICLE' | 'FACE' | 'LPR' | 'POSE' | 'CLIP_EMBED' | 'UNKNOWN'

Example request

{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "pointA": {
    "x": 0.5,
    "y": 0.5
  },
  "pointB": {
    "x": 0.5,
    "y": 0.5
  }
}

Response

OK

errorboolean nullable
errorCodestring nullable

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

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.