Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
LPR Vehicle Lists

Fetches all available fields in vehicle Lists for this account. Specifically, using this API, the user may:

  • Obtain the list of fields for ordered display of vehicle records, wherein each field is a column.
  • Obtain the possible values for some or all of the fields for search queries.
  • Understand user defined fields in the records of vehicle Lists, which is a dynamic set.
get/lprVehicleLists:listFields

Response

List of all fields

namestring

User friendly Displayable name of the field

keystring required

The actual field

valueRange'fixed' | 'unlimited'

Indicates whether the possible values for this field is static or unbounded

Example response

[
  {
    "key": "actor",
    "valueRange": "fixed"
  },
  {
    "key": "userData.apartmentNum",
    "name": "Apartment Number"
  }
]