Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
LPR Rules

Fetches lpr rules based on a filter

get/lprAlertConditionRules

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"
]
name__containsstring

Filter to get the accounts whose name contains the provided substring. The lookup is exact and case insensitive.

type__in'lprRuleAccessControlAllow' | 'lprRuleAccessControlDeny' | 'lprRuleWatch' | 'lprRuleCountAggr' | 'lprRuleHotlist' | 'lprRuleUnlisted' | 'lprRuleWrongDirection' | 'lprRuleOverstay'

Enumerates available rule types. The brief synopsis of the rules as follows.

  • lprRuleAccessControlAllow creates an alert when vehicles are seen whose access type is allow.
  • lprRuleAccessControlDeny creates an alert when vehicles are seen whose access type is deny.
  • lprRuleWatch raises an alert if a vehicle is seen once and is not seen again within the specified time interval.
  • lprRuleCountAggr sets up aggregation for camera or location and fires an alert if the aggregation (detection count) in a specified time interval falls above or below threshold.
  • lprRuleHotlist configures to receive an alert for a specific plate or list of vehicles.
  • lprRuleUnlisted configures to receive an alert for vehicles which are not part of the vehicle list.
  • lprRuleWrongDirection configures to receive an alert when a vehicle is traveling in the wrong direction.
  • lprRuleOverstay configures to receive an alert when a vehicle is still present at a configured time of day.

Search based on the rule type. Supported values are:

  • lprRuleAccessControlAllow - creates an alert when vehicles are seen whose access type is allow.
  • lprRuleAccessControlDeny - creates an alert when vehicles are seen whose access type is deny.
  • lprRuleWatch - raises an alert if a vehicle is seen once and is not seen again within the specified time interval.
  • lprRuleCountAggr - sets up aggregation for camera or location and fires an alert if the aggregation (detection count) in a specified time interval falls above or below threshold.
  • lprRuleHotlist - configures to receive an alert for a specific plate or list of vehicles.
  • lprRuleUnlisted - configures to receive an alert for vehicles which are not part of the vehicle list.
  • lprRuleWrongDirection - configures to receive an alert when a vehicle is traveling in the wrong direction.
  • lprRuleOverstay - configures to receive an alert when a vehicle is still present at a configured time of day.
priority__lteinteger

Filter by priority__lte

priority__gteinteger

Filter by priority__gte

enabledboolean

Filter against enabled rules (when set to true) or disabled rules (when set to false)

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

All the rules that met the filter criteria of this API inputs.

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": [
    {
      "type": "lprRuleAccessControlAllow",
      "name": "Allow Employees vehicles",
      "priority": 10,
      "notes": "This rule filters plates belonging to global employee list and allows access",
      "enabled": false,
      "eventFilter": {
        "eventTypes": [
          "een.lprPlateReadEvent.v1"
        ],
        "schedule": {
          "sunday": [
            {
              "start": "18:34",
              "end": "20:11"
            }
          ],
          "monday": [
            {
              "start": "21:38",
              "end": "17:12"
            }
          ],
          "tuesday": [
            {
              "start": "12:48",
              "end": "11:20"
            }
          ],
          "wednesday": [
            {
              "start": "22:41",
              "end": "22:23"
            }
          ],
          "thursday": [
            {
              "start": "20:00",
              "end": "22:50"
            }
          ],
          "friday": [
            {
              "start": "09:40",
              "end": "16:18"
            }
          ],
          "saturday": [
            {
              "start": "23:32",
              "end": "21:45"
            }
          ]
        },
        "resourceFilter": {
          "actors": [
            {
              "id": "100b913c",
              "type": "camera"
            }
          ]
        }
      },
      "configuration": {
        "barrierOpen": true,
        "filterType": "plate",
        "plates": [
          "ABC123"
        ]
      },
      "id": "f65907c0-5bb9-45cd-bc2e-173aa9a3f009",
      "createTimeStamp": "2021-04-22T00:00:00.000+00:00",
      "updateTimeStamp": "2021-04-22T00:20:00.000+00:00",
      "createdByUserId": "ca0de584",
      "outputAlertTypes": [
        "een.LprAccessControlAllow.v1"
      ]
    }
  ]
}