Doorbell Camera Webservice

Get object bounding boxes for a specified doorbell camera

Get object bounding boxes for a specified doorbell 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/doorbellcamera/getBoundingBoxes

Request

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

deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

durationSecsinteger nullable
startTimeSecinteger nullable

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}

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.