/lprVehicleLists/{id}/vehicles

post

https://{BaseUrl}/api/v3.0/lprVehicleLists/{id}/vehicles

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.

Path Params

string

required

Body Params

New record to be added.

validFrom

date | null

Date from which this record is valid

validTo

date | null

Date upto which this record is valid

schedule

object

It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days.

accessType

string

enum

required

Allowed:

securityStatus

string | null

enum

deprecated

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

Allowed:

userData

object | null

deprecated

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.

userTags

array of strings | null

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.

userTags

color

string | null

enum

Enumerations of standard colors for vehicles.

model

string | null

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

make

string | null

enum

Enumerations of standard makes/brands for vehicles.

plate

string

required

License plate number of the vehicle in uppercase

Responses

201Successful creation of new vehicle record

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

409There was a conflict while trying to perform your request. See error details for more information.

500Something went wrong in the server. Please try again.