Skip to main content
POST
/
api
/
search
/
searchLicensePlates
Search license plates
curl --request POST \
  --url https://api2.rhombussystems.com/api/search/searchLicensePlates \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endTime": 1640998800000,
  "forcedFuzziness": 2,
  "fuzzy": true,
  "licensePlate": "ABC123",
  "startTime": 1640995200000
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "vehicleEvents": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "eventTimestamp": 123,
      "imageS3Key": "<string>",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "matchingLicensePlates": [
        "<string>"
      ],
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "partialLicensePlates": [
        "<string>"
      ],
      "searchMatchedTerm": "<string>",
      "searchMatchedType": "<string>",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "thumbnailS3Key": "<string>",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "vehicleLicensePlate": "<string>"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for searching license plates.

deviceUuids
(string<DeviceFacetUuid> | null)[] | null

List of device facet UUIDs to search in

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

endTime
integer<int64> | null

End time in milliseconds for the search period

Example:

1640998800000

forcedFuzziness
integer<int32> | null

Forced fuzziness level for the search (deprecated)

Example:

2

fuzzy
boolean | null

Whether to use fuzzy search

Example:

true

licensePlate
string | null

License plate number to search for

Example:

"ABC123"

startTime
integer<int64> | null

Start time in milliseconds for the search period

Example:

1640995200000

Response

200 - application/json

OK

Response object for searching license plates.

error
boolean | null
errorMsg
string | null
vehicleEvents
object[] | null

List of vehicle events matching the search criteria

warningMsg
string | null