Get footage bounding boxes

Get object bounding boxes for a specified camera. Note: bounding box values are given as permyriad shorts relative to image. To convert to absolute pixel values, use the following: abs_pix = (rel_permyriad / 10000) * image_dim

POST /api/camera/getFootageBoundingBoxes

Get footage bounding boxes

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getFootageBoundingBoxes \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "duration": 3600,
  "startTime": 1640995200
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "footageBoundingBoxes": [
    {
      "b": 123,
      "l": 123,
      "r": 123,
      "t": 123,
      "ts": 123,
      "al": true,
      "c": 123,
      "cd": "<string>",
      "cdn": "<string>",
      "croppedImageLocator": "<string>",
      "dw": true,
      "fn": "<string>",
      "kp": {},
      "loudness": 123,
      "lp": "<string>",
      "m": true,
      "objectId": 123,
      "p": "<string>",
      "reid": 123,
      "ro": [
        "<string>"
      ],
      "sensorValType": {
        "sensorBoolean": true,
        "sensorDouble": 123,
        "sensorLong": 123
      },
      "toastOrderIdInfo": {
        "employeeName": "<string>",
        "guid": "<string>",
        "locationName": "<string>",
        "restaurantName": "<string>",
        "toastCheckInfo": {
          "totalAmount": 123
        }
      },
      "uf": "<string>",
      "vn": "<string>"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

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

x-auth-scheme · enum<string> · default: api-token · 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.

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

Body

application/json

Request to retrieve footage bounding boxes for a camera within a time range.

cameraUuid · string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

duration · integer<int32> | null

Duration in seconds

Example:

3600

startTime · integer<int64> | null

Start time in seconds since epoch

Example:

1640995200

Response

200 - application/json

OK

Response containing footage bounding boxes for a camera.

error · boolean | null

errorMsg · string | null

footageBoundingBoxes · object[] | null

List of footage bounding boxes

Show child attributes

warningMsg · string | null