v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
LPR Rules

Create a new rule that produces alerts based on certain conditions. Specifically, the user specifies alert conditions that indicate when the alert is produced based on following:

  • Which resources (cameras, account or location) can produce the alert
  • What is the schedule for the alert.
  • What event types, or which vehicles (specific plates, or belonging to a vehicleList) can produce the alert.
post/lprAlertConditionRules

Request body

OR
OR
OR
OR
OR
OR

Example request

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

Response

Response on successful creation of requested lpr alertConditionRule

OR
OR
OR
OR
OR
OR

Example response

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