Search Webservice

Search license plates

Fuzzy search for license plate sightings based on a partial or full plate number. Use /vehicle/getVehicleEvents instead.

post/api/search/searchLicensePlates

Request

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

deviceUuidsstring[] nullable

List of device facet UUIDs to search in

endTimeinteger nullable

End time in milliseconds for the search period

forcedFuzzinessinteger nullable

Forced fuzziness level for the search (deprecated)

fuzzyboolean nullable

Whether to use fuzzy search

licensePlatestring nullable

License plate number to search for

startTimeinteger nullable

Start time in milliseconds for the search period

Example request

{
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "endTime": 1640998800000,
  "forcedFuzziness": 2,
  "fuzzy": true,
  "licensePlate": "ABC123",
  "startTime": 1640995200000
}

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

Example response

{
  "vehicleEvents": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.