Get license plates by device

Get license plate counting events for a specified camera

POST /api/report/getLicensePlatesByDevice

Get license plates by device

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/report/getLicensePlatesByDevice \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "licensePlateEvents": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "eventTimestamp": 123,
      "imageS3Key": "<string>",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "matchingLicensePlates": [
        "<string>"
      ],
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "partialLicensePlates": [
        "<string>"
      ],
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "thumbnailS3Key": "<string>",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "vehicleLicensePlate": "<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 object for getting license plates by device.

deviceUuid · string<DeviceFacetUuid> | null · required

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

interval · enum<string> · required

Report interval for filtering face events

Available options: MINUTELY, QUARTERHOURLY, HOURLY, DAILY, WEEKLY, MONTHLY

dateLocal · string | null · deprecated

Deprecated input, use timestampMs instead

timestampMs · integer<int64> | null

Datetime provided as a UNIX timestamp in milliseconds

Required range: x >= 0

Response

200 - application/json

OK

Response object for getting license plates by device.

error · boolean | null

errorMsg · string | null

licensePlateEvents · object[] | null

List of license plate events

Show child attributes

warningMsg · string | null