Get footage bounding boxes for multiple cameras

Get object bounding boxes for multiple cameras. 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/getFootageBoundingBoxesForMultiple

Get footage bounding boxes for multiple cameras

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/camera/getFootageBoundingBoxesForMultiple \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "durationSec": 3600,
  "startTimeSec": 1640995200
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "footageBoundingBoxMap": {},
  "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 multiple cameras within a time range.

cameraUuids · (string<DeviceFacetUuid> | null)[] | null

List of camera UUIDs to retrieve bounding boxes for

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

durationSec · integer<int32> | null

Duration in seconds

Example:

3600

startTimeSec · integer<int64> | null

Start time in seconds since epoch

Example:

1640995200

Response

200 - application/json

OK

Response containing footage bounding boxes for multiple cameras.

error · boolean | null

errorMsg · string | null

footageBoundingBoxMap · object

Mapping of timestamps to footage bounding box summaries

Show child attributes

warningMsg · string | null