EAeagleeyenetworks
LPR Vehicle Lists

GET /lprVehicleLists

Fetches the available vehicleLists based on the filter

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/lprVehicleLists
  • Auth
    HTTP bearer

Query parameters

actorstring[]

Filter to get only events where the actorType and actorId value equals any one of the supplied value in the list. For each entry of list, the actor type has to be prefixed along with actor id like actorType:actorId. For example, to filter for camera with id 100d4c41, the actorId that has to be used is camera:100d4c41. To search for events from a specific type of actor, for example users, use a wildcard as actorId: user:*.

[
  "camera:100d4c41",
  "location:abcd1234"
]
platestring

Provide the license plate in uppercase to be searched with an exact match

name__containsstring

Phrase that is used to search for resources (rules or lists) whose names contain it

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Response

Fetches all the vehicle list that matches the filtering based on the query parameters. Only list properties are returned per list. The individual vehicle records within a list are not returned

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger nullable

The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information.

Example response

{
  "results": [
    {
      "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
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.