v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
LPR Vehicle Lists

Fetches the information about the specific vehicleList but not each vehicle record

get/lprVehicleLists/{id}

Path parameters

idstring required

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

Response

Returns information about the list. Only list properties are returned and not the individual vehicle records inside it.

namestring required

User supplied name for the list

enabledboolean

Whether list is enabled

notesstring

A verbose explanation of the vehicle list

idstring required

Unique system generated id for list

createTimestampstring date-time required

Timestamp when this list created

updateTimestampstring date-time required

Timestamp when this list last updated

createdByUserIdstring required

User id of the creator of the vehicle list

vehicleCountinteger required

Number of vehicles in the list

Example response

{
  "name": "EmployeesList",
  "notes": "This is vehicle list of denied vehicles",
  "resourceFilter": {
    "actors": [
      {
        "id": "100b913c"
      }
    ]
  },
  "id": "ABC123-20221014123567",
  "createTimestamp": "2017-02-27T10:44:13.423Z",
  "updateTimestamp": "2017-02-27T10:44:13.423Z",
  "createdByUserId": "ca0de584",
  "vehicleCount": 10
}