Camera Webservice

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

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/camera/getFootageBoundingBoxes
  • 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

durationinteger nullable

Duration in seconds

startTimeinteger nullable

Start time in seconds since epoch

Example request

{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "duration": 3600,
  "startTime": 1640995200
}

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.