Step 2: Create a Vehicle List
At this step, a plate list is created, empty at first, to which the plate to track will be added later. Creation of a plate list requires User groups to be defined that have access to it. These will be the groups selected at Step 1.
To do so, run the request ...
|
POST Request Sample |
| /api/v1/plate-lists | |
... with the body holding a PlateListUpsertDto JSON file, in which the properties of the list to create are defined.
|
name Required |
string |
maxLength: 128
Plate list name; it makes sense to give meaningful, self-explanatory names to plate lists |
|
enabled Optional |
boolean |
List enabled/disabled indicator. Set "enabled": true to enable the list right after it is created |
|
event_level REQUIRED |
integer($int32)
|
Priority code of the events on the monitor, one of:
0 - Low 1 - Normal 2 - High 3 - Critical |
|
user_groups REQUIRED |
integer($int32)
|
User groups' identifiers tasked with tracking the plate. Set equal to those selected at step 1. |
If successful, the response will come in to confirm the creation of the list with the requested properties in the form of a PlateList JSON object in the response body:
|
id Optional |
integer($unt32) |
The created list identifier, needed at step 3.
|
|
name Required |
string |
Plate list name |
|
enabled Optional |
boolean |
List enabled/disabled indicator. |
|
event_level REQUIRED |
integer($int32)
|
Priority code of the events on the monitor, one of:
0 - Low 1 - Normal 2 - High 3 - Critical |
The other export_path, status, permissions and has_exported parameters in the PlateList are irrelevant to the case.