Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
LPR Vehicle Lists

Fetches information about all the vehicle records in the given list, including the user data.

get/lprVehicleLists/{id}/vehicles

Path parameters

idstring required

Account ID. Use self as the Account ID to reference the account of the current session

Query parameters

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

platestring

Provide the license plate in uppercase to be searched with an exact match

plate__containsstring

Provide the string to search for within a license plate. The results will include partial and exact matches. Refrain from passing an asterisk (*) or you will receive a 400 Bad Request.

accessType__inAccessType1[]

Search based on the access type

securityStatus__inSecurityStatus[]

Filters by only those records under a specific type of security status

[
  "exempted"
]
userDataobject

Dynamically named query parameter that allows clients to filter events based on specific values in user supplied fields.

  • This allows searching by user supplied attributes instead of plates, for example, apartment number, organization etc.
  • If the user for example wishes to search for organization having value ABC then the correct way to search is userData.organization=ABC. This then needs to be specified directly in the query parameters or in json object as a key value pair.
  • The list of user Data keys can be obtained by calling /lprVehicleLists:listFields endpoint
userTags__instring[]

Filters the result by one or more user tags. Each value should match a tag string exactly. This parameter is mutually exclusive with userTags__contains using both will return a 400 Bad Request error.

userTags__containsstring

Filter results by substring or exact match within user tags. Do not pass * this will result in a 400 Bad Request. This parameter is mutually exclusive with userTags__in using both will return a 400 Bad Request error.

Response

Successfully returns information about the vehicle records

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger nullable

The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information.

Example response

{
  "results": [
    {
      "validFrom": "2022-01-24",
      "validTo": "2022-02-25",
      "securityStatus": "exempted",
      "userData": {
        "owner": "John Doe",
        "apartmentNum": "105A"
      },
      "userTags": [
        "105A",
        "Jhon"
      ],
      "color": "white",
      "model": "camry",
      "make": "volvo",
      "plate": "ABC123",
      "id": "ABC123-20221014123567",
      "createTimestamp": "2017-02-27T10:44:13.423Z",
      "updateTimestamp": "2017-02-27T10:44:13.423Z"
    }
  ]
}