Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
LPR Vehicle Lists

Adds a new vehicle record to the list. This method enforces strictness about the uniqueness of vehicle license plate, so the same plate/vehicle cannot be added more than once, and would result in error if attempted.

post/lprVehicleLists/{id}/vehicles

Path parameters

idstring required

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

Request body

validFromstring date nullable

Date from which this record is valid

validTostring date nullable

Date upto which this record is valid

accessType'allow' | 'deny' required
securityStatus'hotlist' | 'exempted'

Indicates whether vehicle is

  • hotlist: Vehicle flagged for tracking

  • exempted: Vehicle is exempt from watchlist rule and other rules. This is useful, for instance, when an organization wishes to avoid alerts on known vehicles, like employee vehicles.

  • none: Empty value provided when no special consideration for the vehicle

userDataUserDataLpr

Object containing all user information associated with the specific event. For example, for a plate read, this would contain user supplied attributes for the given plate like apartment number. the following are the guidelines for supplying User Data:

  • It is recommended to use camelCase for field names, but this is not required
  • Maximum of 5 unique keys.
  • Each key or value should have only 256 characters max.
  • The keys 'type' and 'creatorId' are reserved keys.
userTagsstring[]

Tags containing all user information associated with the specific vehicle entry.

  • Maximum of 10 Tags per vehicle.
  • Each Tag should have only 256 characters max.
color'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow'

Enumerations of standard colors for vehicles.

modelstring

Name of the vehicle model as defined by the manufacturer. Meant to be machine parsable, so should be in lowerCamelCase without spaces.

make'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others'

Enumerations of standard makes/brands for vehicles.

platestring required

License plate number of the vehicle in uppercase

Example request

{
  "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"
}

Response

Successful creation of new vehicle record

validFromstring date nullable

Date from which this record is valid

validTostring date nullable

Date upto which this record is valid

accessType'allow' | 'deny' required
securityStatus'hotlist' | 'exempted'

Indicates whether vehicle is

  • hotlist: Vehicle flagged for tracking

  • exempted: Vehicle is exempt from watchlist rule and other rules. This is useful, for instance, when an organization wishes to avoid alerts on known vehicles, like employee vehicles.

  • none: Empty value provided when no special consideration for the vehicle

userDataUserDataLpr

Object containing all user information associated with the specific event. For example, for a plate read, this would contain user supplied attributes for the given plate like apartment number. the following are the guidelines for supplying User Data:

  • It is recommended to use camelCase for field names, but this is not required
  • Maximum of 5 unique keys.
  • Each key or value should have only 256 characters max.
  • The keys 'type' and 'creatorId' are reserved keys.
userTagsstring[]

Tags containing all user information associated with the specific vehicle entry.

  • Maximum of 10 Tags per vehicle.
  • Each Tag should have only 256 characters max.
color'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow'

Enumerations of standard colors for vehicles.

modelstring

Name of the vehicle model as defined by the manufacturer. Meant to be machine parsable, so should be in lowerCamelCase without spaces.

make'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others'

Enumerations of standard makes/brands for vehicles.

platestring required

License plate number of the vehicle in uppercase

idstring required

Unique system generated id for record

createTimestampstring date-time required

Timestamp when this record created

updateTimestampstring date-time

Timestamp when this record last updated

listIdstring uuid required

Id of the list this record belongs to

Example response

{
  "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"
}