Vehicle

Get vehicle events

Get vehicle events with filters and additive queries

POST/api/vehicle/getVehicleEvents

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for getting vehicle events with filters and additive queries.

deviceUuidFilterstring<DeviceFacetUuid>[] | nullbody

Filter events by specific reporting device uuids

endTimeMsinteger<int64> | nullbody

Time window filter end (newest) time in Epoch milliseconds

licensePlateExactQuerystring[] | nullbody

Query events by exact license plate number. Query fields are additive queries (returned events satisfy at least one of the query fields)

licensePlateFuzzyQuerystring | nullbody

Query events by partial or complete license plate with fuzzy character matching. Query fields are additive queries (returned events satisfy at least one of the query fields)

locationUuidFilterstring<RUUID>[] | nullbody

Filter events by specific reporting location uuids

nameQuerystring[] | nullbody

Query events by vehicle name. Query fields are additive queries (returned events satisfy at least one of the query fields)

startTimeMsinteger<int64> | nullbody

Time window filter start (oldest) time in Epoch milliseconds

unnamedQueryboolean | nullbody

Query events by name presence. If false, returns events with a name. If true, returns events without names. Omit if not needed. Query fields are additive queries (returned events satisfy at least one of the query fields)

vehicleLabelQuerystring[] | nullbody

Query events by vehicle labels. Query fields are additive queries (returned events satisfy at least one of the query fields)

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/vehicle/getVehicleEvents' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "deviceUuidFilter": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "endTimeMs": 0,
    "licensePlateExactQuery": [
      "<string>"
    ],
    "licensePlateFuzzyQuery": "<string>",
    "locationUuidFilter": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "nameQuery": [
      "<string>"
    ],
    "startTimeMs": 0,
    "unnamedQuery": true,
    "vehicleLabelQuery": [
      "<string>"
    ]
  }'

import requests

url = "https://api2.rhombussystems.com/api/vehicle/getVehicleEvents"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "deviceUuidFilter": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "endTimeMs": 0,
    "licensePlateExactQuery": [
        "<string>"
    ],
    "licensePlateFuzzyQuery": "<string>",
    "locationUuidFilter": [
        "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "nameQuery": [
        "<string>"
    ],
    "startTimeMs": 0,
    "unnamedQuery": True,
    "vehicleLabelQuery": [
        "<string>"
    ]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/vehicle/getVehicleEvents', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "deviceUuidFilter": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "endTimeMs": 0,
    "licensePlateExactQuery": [
      "<string>"
    ],
    "licensePlateFuzzyQuery": "<string>",
    "locationUuidFilter": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "nameQuery": [
      "<string>"
    ],
    "startTimeMs": 0,
    "unnamedQuery": true,
    "vehicleLabelQuery": [
      "<string>"
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "deviceUuidFilter": [
                "AAAAAAAAAAAAAAAAAAAAAA.v0"
              ],
              "endTimeMs": 0,
              "licensePlateExactQuery": [
                "<string>"
              ],
              "licensePlateFuzzyQuery": "<string>",
              "locationUuidFilter": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "nameQuery": [
                "<string>"
              ],
              "startTimeMs": 0,
              "unnamedQuery": true,
              "vehicleLabelQuery": [
                "<string>"
              ]
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/vehicle/getVehicleEvents"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "events": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "eventTimestamp": 0,
      "imageS3Key": "<string>",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "matchingLicensePlates": [
        "<string>"
      ],
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "partialLicensePlates": [
        "<string>"
      ],
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "thumbnailS3Key": "<string>",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "vehicleLicensePlate": "<string>"
    }
  ]
}

Response

200 OK

application/json · object

Response object containing vehicle events with filters and additive queries.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

eventsobject[] | null

List of vehicle events matching the query criteria

Show child attributes

deviceUuidstring<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

eventTimestampinteger<int64> | null

imageS3Keystring | null

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

matchingLicensePlatesstring[] | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

partialLicensePlatesstring[] | null

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

thumbnailS3Keystring | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

vehicleLicensePlatestring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.