Stay tuned, we are relaunching the VAPIX library soon!
End User Licenses Agreement (EULA)

License plate verifier API

The VAPIX® License plate verifier API contains the information and steps that makes it possible to detect and recognize license plates and whether the vehicle should be allowed to enter a restricted area such as a parking garage. It is split into three groups that handles everything from settings to how to query events and retrieve real time data from the system:

  • VAPIX events

  • Push events (HTTP, TCP, FTP)

  • Heartbeat services

  • Direct integration

  • Application API

  • Web services API

Analytic (ALPV) event types

The following table contain event types for the real-time, new, update and lost statuses.

#RAW recognition event, time msNumber plateCar IDLPR event (VAPIX ALLPLATES)Comments
110:12:10 AM 100AA7690EQ123~10:12:10 AM 100 LPR Event -
NEW -AA7690EQ		Events are sent immediately.
210:12:10 AM 150AA7690EQ123~10:12:10 AM 400 LPR Event -
UPDATE - AA7690EQ		A direction has been detected. An event has been sent.
310:12:10 AM 200AA7690EQ123
410:12:10 AM 250AA7690EO123
510:12:10 AM 350AA7690EO123
610:12:10 AM 400AA7690EO123~10:12:10 AM 400 LPR Event -
UPDATE - AA7690EO		A license plate has been changed. An event has been sent.
710:12:10 AM 450AA7690EO123
810:12:10 AM 750AA7690EO123
910:12:10 AM 850AA7690EO123
10License plate left the frame123
1110:12:16 AM 050----/----123456789~10:12:15 AM 1050 LPR Event -
LOST- AA7690EO		An event has been sent after the last license plate recognition +10 s.

  • A NEW event is generated on the first license plate detection (the direction is always undefined in this event).

  • The Update event is generated if direction, license plate, zone, etc. changes.

  • The LOST event is generated +10 seconds after the last recognition (this is a configurable parameter).

Examples

The ACAP will generate two events, NEW at first detection and LOST +10 seconds after the first detection.

Access control systems (real-time systems) use NEW and UPDATE events to check and open barriers. In traffic solutions, LOST events are used to get the final result. This means one car for every event.

Use the CARID field in the package to merge or update all events into one. This field is unique and the can be used by NEW, UPDATE and LOST for one vehicle.

Used times in the events

NameExampleDescriptionNEWUPDATELOST
capture_timestamp1678715164683UNIX frame timestamp,
ms UTC timestamp of event		SameDifferentSame
frame_timestamp167871564683793UNIX frame timestamp (internal from camera)DifferentDifferent0
capture_ts1678715164683000000The same as frame_timestamp but capture_timestamp*1000000 is used.SameDifferentSame
Datetime20230313
144604683		YYYYMMDD
HHMMSSFFF

YYYY - year 4 digits
MM - month 2 digits
DD - day 2 digits
HH - hours
MM - minutes
SS - seconds
FFF - milliseconds		SameDifferentSame

VAPIX Events

Real time recognition events can be received from a camera using VAPIX protocols in a format where all recognition related data except images are present. For more information see Event data streaming.

#EventsDescription
1ALPV.ALLPlatesEvent with complete metadata sent several times during recognition (NEW, UPDATE and LOST event types). These events does not have any conditions.
2ALPV.Allow_listTrigger events if there is a match to the list name. Sent only once.
3ALPV.Block_listTrigger events if there is a match to the list name. Sent only once.
4ALPV.Custom_listTrigger events if there is a match to the list name. Sent only once.
5ALPV.NotInListTrigger events if there is no match to the list name. Sent only once.
6ALPV.Roi1Trigger events if there is a match to the recognition zone/area of interest. Sent only once.
7ALPV.Roi2Trigger events if there is a match to the recognition zone/area of interest. Sent only once.
8ALPV.PlateINTrigger events if there is a match to the detect direction. Sent only once.
9ALPV.PlateOUTTrigger events if there is a match to the detect direction. Sent only once.
10ALPV.PlateInViewTrigger events for as long as a license plate is in the Area of Interest with a post event of 10 seconds.
11ALPV.NewEvent with complete metadata. Sent at the first license plate detection.
12ALPV.UpdateEvent with complete metadata. Sent if direction, license plate text, etc. changes.
13ALPV.LostEvent with complete metadata. Sent 10 seconds after the last recognition.
14ALPV.RealTimeEvent with complete metadata. Internal events Radar integration.

Events and Examples

ALPV.ALLPlates

This general metadata event is always available and contains all data from the LPR engine. The event can be sent several times for each individual license plate:

  • NEW: Used when a new License plate is detected. Only one event is produced and it does not contain direction.

  • UPDATE: Used when something changes in the LPR package. Multiple events can be produced depending on the changes of the LPR package and how long the license plate is on the scene.

  • LOST: Used when a vehicle exits the image. Only one image event is produced (sent +10 seconds after the last UPDATE event).

ParameterDescription
WidthThe width of the license plate, measured in pixels.
carMoveDirectionThe detected movement against a set of pre-set directions.
roIIDID of an area of interest where the plate was recognized.
vehicleTypeThe vehicle type. Can be CAR|TRUCK|BUS. This is parameter is supported from ALPV 2.9.19 or later.
ViewThe vehicle’s view. Can be front|rear.
TopThe top coordinate of the license plate, measured in pixels.
consumedTimeThe license plate recognition time, measured in milliseconds (ms).
TextThe license plate text.
iso3166-2The iso3166-2 code.
RegionThe local region name.
listNameThe name of the list. It will be empty if the plate text cannot be found in the list, or labelled on either the Block list or Allow list if it exists.
regionCodeThe region letter.
LeftThe left coordinate of the license plate, measured in pixels.
capture_timestampThe UNIX frame timestamp.
listDescriptionThe plate’s description if it was added to a list.
lpImageThe license plate image in Base64 (supported from ALPV 2.9.19 or later).
actionSet to either Accepted, Denied depending on whether an application configuration has occurred.
vehicleColorThe color of the vehicle. This is parameter is supported from ALPV 2.9.19 or later.
carIDThe internal runtime plate ID.
countryThe 3 letter country names in the Alpha-3 ISO-3166 format.
heightThe height of the license plate, measured in pixels.
frame_timestampThe UNIX frame timestamp from the camera.
listModeThe list mode. Can be allow|block|none
MACAddressThe camera’s MAC address.
carStateThe event type. Can be new|update|lost.

Package sample

<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.AllPlates</wsnt:Topic>
        <wsnt:ProducerReference>
          <wsa5:Address>uri://c37d4bf5-fa69-498d-8294-e0c8ade51ded/ProducerReference</wsa5:Address>
        </wsnt:ProducerReference>
        <wsnt:Message>
          <tt:Message UtcTime="2021-05-20T11:54:21.894000Z">
            <tt:Source>
            </tt:Source>
            <tt:Data>
            <tt:SimpleItem Name="consumedTime" Value="153" />
            <tt:SimpleItem Name="frame_timestamp" Value="1288416958" />
            <tt:SimpleItem Name="carMoveDirection" Value="unknown" />
            <tt:SimpleItem Name="carState" Value="new" />
            <tt:SimpleItem Name="action" Value="No action" />
            <tt:SimpleItem Name="capture_timestamp" Value="1621511661894" />
            <tt:SimpleItem Name="width" Value="168" />
            <tt:SimpleItem Name="carID" Value="1139066" />
            <tt:SimpleItem Name="top" Value="354" />
            <tt:SimpleItem Name="country" Value="PRT" />
            <tt:SimpleItem Name="left" Value="539" />
            <tt:SimpleItem Name="height" Value="28" />
            <tt:SimpleItem Name="listName" Value="" />
            <tt:SimpleItem Name="text" Value="II04458" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.Allow_list

Triggered events dependant on a list’s application name. Please note that these events are only available when a relay is connected.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.Allow_list</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-08T12:21:16.999671Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="1" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.Block_list

Triggered events dependant on a list’s application name. Please note that these events are only available when a relay is connected.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.Block_list</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-08T12:21:25.288828Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="1" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.Custom_list

Triggered events dependant on a list’s application name. Please note that these events are only available when a relay is connected.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.Custom_list</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-07T15:31:40.092488Z" PropertyOperation="Initialized">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="0" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.NotInList

Triggered events dependant on a list’s application name. Please note that these events are only available when a relay is connected.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.NotInList</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-08T12:21:41.969036Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="0" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.Roi1

A triggered event.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.Roi1</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-08T12:21:25.289164Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="1" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.Roi2

A triggered event.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.Roi2</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-08T12:21:25.289164Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="1" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.PlateIN

Triggered events. Please note that these events are only available when a relay is connected.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.PlateIn</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-08T12:21:17.212625Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="1" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.PlateOUT

Triggered events. Please note that these events are only available when a relay is connected.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.PlateOut</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://67005000-27b4-4856-b92c-490fc4cf6b15/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2023-12-08T12:21:42.378250Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="1" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.PlateInView

Triggered events. The event will trigger when the plate is first detected in an Area of Interest and stopped 10 seconds after the license plate has left the area.

active = 1
active = 0
Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.PlateInView</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://669dd136-d268-4365-83d0-b00c2e368a6c/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2024-02-14T15:36:51.583716Z" PropertyOperation="Changed">
          <tt:Source>
          </tt:Source>
          <tt:Key>
          </tt:Key>
          <tt:Data>
            <tt:SimpleItem Name="active" Value="1" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.New

A New event is generated on the first license plate detection. The direction is always undefined in New events.

Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.New</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://ae273212-d36d-4c76-bbd5-c1b08dde9e82/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2024-03-14T18:08:51.293000Z">
          <tt:Source>
          </tt:Source>
          <tt:Data>
            <tt:SimpleItem Name="frame_timestamp" Value="1710439731" />
            <tt:SimpleItem Name="vehicleColor" Value="BLACK" />
            <tt:SimpleItem Name="region" Value="" />
            <tt:SimpleItem Name="carID" Value="4" />
            <tt:SimpleItem Name="listMode" Value="none" />
            <tt:SimpleItem Name="country" Value="DNK" />
            <tt:SimpleItem Name="capture_timestamp" Value="1710439731293" />
            <tt:SimpleItem Name="text" Value="WR6677" />
            <tt:SimpleItem Name="roiID" Value="1" />
            <tt:SimpleItem Name="regionCode" Value="" />
            <tt:SimpleItem Name="iso3166-2" Value="" />
            <tt:SimpleItem Name="view" Value="front" />
            <tt:SimpleItem Name="MACAddress" Value="ACCC8EBFB452" />
            <tt:SimpleItem Name="listName" Value="" />
            <tt:SimpleItem Name="height" Value="28" />
            <tt:SimpleItem Name="width" Value="92" />
            <tt:SimpleItem Name="lpImage" Value="/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/wAALCAArAIgBAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/APE7qyltLtxKp5PWvV/CeNW+FWu2IGZYAJB+Bz/Q149eQuW3kYAPeq3lFhhcZH606HI3YOADgitfRtZutJuftFnO0Ui9COhFbl742S9YXUtjEL9SD5y8ZPrimax47uNZjQX9vHJPEAEl5BApLrxze6iIo7+CG6ES7U8xegqu3i/UmjigmVJ4kyI45BuCj2rGv9TmuWxOenRAOBVWQ4K5GOPSoTHtfvgjmpdMhZ7uMbMhTzXtfge4Gm+CfFOrODzF5CfXGP6143fTbmBjONw5+vet74XybfiN4VUd9VtP/Ry1lf2lJcxFbmTKt3I6V6l8F3Uz32mSZMN9AyK3qcV59e6csc9zDd5RopGUjuOabp2gS3Ey7OcEHHrXX6B8I7/XLZ5rOWNNrlSXOMn0rZT4EaurlftVrlRyC3Slf4HajAg82/sow52jc3U+nSppPgo1spOpaxZQqgG5icAenWp9P+CVreI0lrr9pMinBMRDY/WrA+CWnLqAshrsX2wLuMe3kD6ZpU+Dmji+uLQ62jTxJvlXZ90e5qtF8N/CRcxProZ1BY4HYVG/w98JXKSLYavJJcohdV2nnA+leSWEYGpOMnaMtgdsV6dqpGlfB2C2YETanPuwewzn+lePXpAkVOOBxW78Mw4+JPhPpj+1rTP/AH+SsW/snsL57aUYZeorrvh5rsmn+I9MYH93HIFI+vFWviTbm18Y6gO0zeaD7HmtPwSBM+VGOOc13VhdS2vhU3Fq0hmjvwQq9W59K63wdrK3WqeJr+93wIViJEnGz5W/wpPGF1bT+DRe2cvnRxXCPuU9Bnmue1O7tdaGqawEaSykvraJFI67V+bj3zXRfDe2iln1TU4IFhsp5NkUI6Db3x2rM0fVr2x8W3+r3dtG1jeXZs1lP3l2AgYH4fpSeHr+7TXZpryzjks9bnMIcH5l6j8qu6RodhdeLryGztlFhYR/ZmJGd7nk/lUC2/n3ut3+n20ItdPga3iAGAx7mvm2zSRryVY1JeRggH1Nd/8AF668h9D0pBt+y2wYj3IryW5AeUkDmuk+GIP/AAsfwn/2FrT/ANHJWfPFPqErzM++Y9d3WotJ860vN5DBUkBJx0Nd38V3a9bSdQVQqzW6gsPUUnw01W0sNRjN7L+7GSRj8q9g8KQnU0S8tJIEthqBnKO2DtrU1/RXupvEL217Zqt+IvLUv029c1S0vw+lt4RutMudTs4pLpwT8+Qo7gVFaaPpmm6ONOTXLBohqC3OXcDKgAFfrxWroNxpOjajqLr4jsTYXDb1gDDKH25rHs4dAtNS8+98VRXGnpM9xHa8cM3cnPPWo9Iu/C+m60l3J4kM1vE7PBAVOEJ71qaD4p8LaRFqGdaSVrq5edmKkEbu1Z8vjLwpo3hjUbSy1E3UlxvYDHOWrw7wSgvfFFhGQBH53mFvpzTPiJqf9p+LdQuVbIR9ifQVxbEmQg9+tdJ8MRj4keFP+wtaf+jlrnlu5o23RHGetTRXLyKwDEsTk5rvLsjVPBUbY+e2YbR6CuCkmaJlYZHuKu2+u38EZFvdzIp/hDEZpRrV+7hZJpt/X79QyatdbvmnlJ9Nxpq3sksg3SvjqBmmm4LSMBK3HvTUmUsGLOfbNSGcB/lYlR70x52IVS2T65piEyPtywBru/h1bCBNS1NvlS1gIVj/AHiOK4TUJi80kjNh5CSffmqqZb5s103wwP8Axcfwpk/8xa0/9HLXMDrTgxWXg4r0bwyobwrdBuQVP8q8/lJEoXsDQgBY5FIB+9b/AHajYfID3zSXHyhCvBqa4RRDEwGGPU0x/wDVH6ihx86e9Sxqpk6dCaltQDK+e3Ir04xrbfCBXgXY8837wj+KvK7sAhcjoarpwpxXSfDP/kpHhP8A7C9p/wCjkr//2Q==" />
            <tt:SimpleItem Name="consumedTime" Value="127" />
            <tt:SimpleItem Name="listDescription" Value="" />
            <tt:SimpleItem Name="action" Value="Denied" />
            <tt:SimpleItem Name="carState" Value="new" />
            <tt:SimpleItem Name="carMoveDirection" Value="unknown" />
            <tt:SimpleItem Name="left" Value="760" />
            <tt:SimpleItem Name="vehicleType" Value="CAR" />
            <tt:SimpleItem Name="top" Value="608" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.Update

A Update event is generated if something changes. This include direction of the vehicle, the license plate, etc.

Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.Update</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://ae273212-d36d-4c76-bbd5-c1b08dde9e82/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2024-03-14T18:08:51.560000Z">
          <tt:Source>
          </tt:Source>
          <tt:Data>
            <tt:SimpleItem Name="frame_timestamp" Value="1710439731" />
            <tt:SimpleItem Name="vehicleColor" Value="BLACK" />
            <tt:SimpleItem Name="region" Value="München" />
            <tt:SimpleItem Name="carID" Value="4" />
            <tt:SimpleItem Name="listMode" Value="none" />
            <tt:SimpleItem Name="country" Value="DEU" />
            <tt:SimpleItem Name="capture_timestamp" Value="1710439731560" />
            <tt:SimpleItem Name="text" Value="M WR6677" />
            <tt:SimpleItem Name="roiID" Value="1" />
            <tt:SimpleItem Name="regionCode" Value="M" />
            <tt:SimpleItem Name="iso3166-2" Value="" />
            <tt:SimpleItem Name="view" Value="front" />
            <tt:SimpleItem Name="MACAddress" Value="ACCC8EBFB452" />
            <tt:SimpleItem Name="listName" Value="" />
            <tt:SimpleItem Name="height" Value="28" />
            <tt:SimpleItem Name="width" Value="112" />
            <tt:SimpleItem Name="lpImage" Value="/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/wAALCAArAI0BAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/APHde0u4glaRlMo3ZJA4NdD8Ib3+zPGmnSsNsUsnlkf7wx/Oq3xOsxpXjPUoWQojuWVR0IPIrjTIAwfbz703zl3Y25Y05HYK6soIz0Paum8N+LdT8PborYiS3f70bfdNXYfG93aXz3elQR2kxHzlRnI9OajuvGd00sdxb21vZ3WcmaFNrH8ajvPF13cu0s0Fu9zkEXOwBxj3qSPxpqbW5hmKXJ6K8g3MPxNc3fXlzeSyzXTFm6DJ/SoFUshVV5HOTUTq7DBOTjtTYlEZXzQa9x+B8Ys9L8SazjiG12Ix9SD/APWryPV5Wkup5Wx+8YkV9Afsaf8AM4f9uf8A7Wr5+udfvprdonlARh93HarehJcq0GoRA7bWRXOO3I5r0j426fHd63pt8hAW5t1bdjqcV5jJpEUshTz/AJs4wB1rUtPCF3crFHb25llmYJHntXVj4H+KJUBaCIKOS3mKMfWrMXwN8RyErK8CL7uKsL8BtZYtGL2zBAyRvOcflTG+Crxxxtca9p0at0LScH6Vft/gNcSqjJq1o8T9HTnP0qW0+BMVxJIsGuwv5bbW2DOD6Hmmp8GdLUXckniGIpanE2F+59eaba/DDwnc71TxIrOi7m428fjVRvhx4XezvW0nWnnvYYWlVNp5x+FeQXChpGjcgMDxivYdKm/sL4GXzEFX1G4Eakeg/wD1GvE7oSrKockr619JfsZrj/hMecgmz/8Aa9fNV1BJFcNEeqHBNaelXslrFNEjn94MMPUV6j4sum1P4Z6DfkfvbdjET7Dgfyrzywuy90FZep4J9a9g8PxCO90MKzYaQE+xrd1vxLc6fb+KdJE1xJLNNH5L8naMgtz24r0IzwhbFHuQGESkgty3+Nc54gv7bSPGWrPcOUWfSG2HOMvnAx71zE1tpVnaae+qwNMx0zzI1z1dia7vwwkmg+Ake7UCWC3ebbn1yRXOeCNbXRdMu7LU7N7a6lhe7WZv4welReDh9otf+Ed1i0aP+10N0s4PL855/AVc8O6Lpusa9rDxW6JpkKC0QgY3EcEiotOsrWTVvEF3aQKlhYWLWaNj77Dkn68V81SoJL2QEZ3SFR7c16V8WWGleC/C2kROdwiM8iepOMZ/M149IQ5GHJwOhr6S/Y0/5nD/ALc//a9eA3glvknuiio8jF2AHTms6DcnJTLA8GvSvDdwNT+Her6a+TJasJk9K4PS50S6XzOobk+gr3bwze6fJo+jxo4kvRMhOOtdu2l3EmheJ/N05jdSufIJAJYEY4/Kub8S6Dq897pJhtZg6wRpuVuEI61reNvBt/4hvbaRmXbbWWA28AtIO341oXnhia+u44bpIBAuniASeYMq49Ku2WlX134Lm0rV7u3S8aMxLIHyCB93P5ViQeGNQv1uW8RajYeYtp9lt2ibp7nipvDGl31nffa9a1axeS2tGtbQK3C57np6Ve8Jra6N4fFreanZLOZHYssgIJJOKox3OlaH4J1u3udWtZ55/Nl/dsPmLD6182eHIRfeKLW1zhZZx+PNdB8Xr83vjO4jTBis4lhTn0Gf615wyksS+BzX0r+xr18YDsPsf/tevnu01OSA4wrKexFMa+V5GJVQT2FdR8O7orqEtozDy7hSpFczqtslhf3iHko5C/nVqx1u7tVieCTY0Z3KVPQ10/8AwtTxRMFRr9wAMZAxUE/xB8StCT/ac2weh5qk3jrxIxz/AGtc7T1+Y1WfxZq0gzJfzufXeaqy+JtUxgXUxX13mmt4g1DaC93L9Nxp39sXjgBp5SPXfUUl3ezDAlk69S1VTdz5Kl3Zt2ME123wvs/tGvvfsp8uzjMjZ7HHFcnrF495e3tyzjdLIze/WsrOevWvpX9jTp4v/wC3P/2vXzX0UgdMU0gCIHvkVu+GT5evWmzjJFTfEaGOPxDLsUDdgmucYlYvlOOaRmY5yTT97Bo8E+lDEsZCTmhDyw7EUOoDqAOMimyfMX3c4NROSHOCenrSTSPuQb2xj1qxZMTMhJydp/rXpvgomHwJ4juIiVm2Y3jrivL5idvU8mli+7X0p+xn18Yf9uf/ALXr/9k=" />
            <tt:SimpleItem Name="consumedTime" Value="131" />
            <tt:SimpleItem Name="listDescription" Value="" />
            <tt:SimpleItem Name="action" Value="Denied" />
            <tt:SimpleItem Name="carState" Value="update" />
            <tt:SimpleItem Name="carMoveDirection" Value="in" />
            <tt:SimpleItem Name="left" Value="768" />
            <tt:SimpleItem Name="vehicleType" Value="CAR" />
            <tt:SimpleItem Name="top" Value="614" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.Lost

A Lost event is generated +10 seconds after the last recognition.

Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.Lost</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://ae273212-d36d-4c76-bbd5-c1b08dde9e82/ProducerReference&lt;/wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2024-03-14T18:08:51.293000Z">
          <tt:Source>
          </tt:Source>
          <tt:Data>
            <tt:SimpleItem Name="frame_timestamp" Value="0" />
            <tt:SimpleItem Name="vehicleColor" Value="BLACK" />
            <tt:SimpleItem Name="region" Value="München" />
            <tt:SimpleItem Name="carID" Value="4" />
            <tt:SimpleItem Name="listMode" Value="none" />
            <tt:SimpleItem Name="country" Value="DEU" />
            <tt:SimpleItem Name="capture_timestamp" Value="1710439731293" />
            <tt:SimpleItem Name="text" Value="M WR6677" />
            <tt:SimpleItem Name="roiID" Value="1" />
            <tt:SimpleItem Name="regionCode" Value="M" />
            <tt:SimpleItem Name="iso3166-2" Value="" />
            <tt:SimpleItem Name="view" Value="front" />
            <tt:SimpleItem Name="MACAddress" Value="ACCC8EBFB452" />
            <tt:SimpleItem Name="listName" Value="" />
            <tt:SimpleItem Name="height" Value="28" />
            <tt:SimpleItem Name="width" Value="92" />
            <tt:SimpleItem Name="lpImage" Value="/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/wAALCAArAI0BAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/APHde0u4glaRlMo3ZJA4NdD8Ib3+zPGmnSsNsUsnlkf7wx/Oq3xOsxpXjPUoWQojuWVR0IPIrjTIAwfbz703zl3Y25Y05HYK6soIz0Paum8N+LdT8PborYiS3f70bfdNXYfG93aXz3elQR2kxHzlRnI9OajuvGd00sdxb21vZ3WcmaFNrH8ajvPF13cu0s0Fu9zkEXOwBxj3qSPxpqbW5hmKXJ6K8g3MPxNc3fXlzeSyzXTFm6DJ/SoFUshVV5HOTUTq7DBOTjtTYlEZXzQa9x+B8Ys9L8SazjiG12Ix9SD/APWryPV5Wkup5Wx+8YkV9Afsaf8AM4f9uf8A7Wr5+udfvprdonlARh93HarehJcq0GoRA7bWRXOO3I5r0j426fHd63pt8hAW5t1bdjqcV5jJpEUshTz/AJs4wB1rUtPCF3crFHb25llmYJHntXVj4H+KJUBaCIKOS3mKMfWrMXwN8RyErK8CL7uKsL8BtZYtGL2zBAyRvOcflTG+Crxxxtca9p0at0LScH6Vft/gNcSqjJq1o8T9HTnP0qW0+BMVxJIsGuwv5bbW2DOD6Hmmp8GdLUXckniGIpanE2F+59eaba/DDwnc71TxIrOi7m428fjVRvhx4XezvW0nWnnvYYWlVNp5x+FeQXChpGjcgMDxivYdKm/sL4GXzEFX1G4Eakeg/wD1GvE7oSrKockr619JfsZrj/hMecgmz/8Aa9fNV1BJFcNEeqHBNaelXslrFNEjn94MMPUV6j4sum1P4Z6DfkfvbdjET7Dgfyrzywuy90FZep4J9a9g8PxCO90MKzYaQE+xrd1vxLc6fb+KdJE1xJLNNH5L8naMgtz24r0IzwhbFHuQGESkgty3+Nc54gv7bSPGWrPcOUWfSG2HOMvnAx71zE1tpVnaae+qwNMx0zzI1z1dia7vwwkmg+Ake7UCWC3ebbn1yRXOeCNbXRdMu7LU7N7a6lhe7WZv4welReDh9otf+Ed1i0aP+10N0s4PL855/AVc8O6Lpusa9rDxW6JpkKC0QgY3EcEiotOsrWTVvEF3aQKlhYWLWaNj77Dkn68V81SoJL2QEZ3SFR7c16V8WWGleC/C2kROdwiM8iepOMZ/M149IQ5GHJwOhr6S/Y0/5nD/ALc//a9eA3glvknuiio8jF2AHTms6DcnJTLA8GvSvDdwNT+Her6a+TJasJk9K4PS50S6XzOobk+gr3bwze6fJo+jxo4kvRMhOOtdu2l3EmheJ/N05jdSufIJAJYEY4/Kub8S6Dq897pJhtZg6wRpuVuEI61reNvBt/4hvbaRmXbbWWA28AtIO341oXnhia+u44bpIBAuniASeYMq49Ku2WlX134Lm0rV7u3S8aMxLIHyCB93P5ViQeGNQv1uW8RajYeYtp9lt2ibp7nipvDGl31nffa9a1axeS2tGtbQK3C57np6Ve8Jra6N4fFreanZLOZHYssgIJJOKox3OlaH4J1u3udWtZ55/Nl/dsPmLD6182eHIRfeKLW1zhZZx+PNdB8Xr83vjO4jTBis4lhTn0Gf615wyksS+BzX0r+xr18YDsPsf/tevnu01OSA4wrKexFMa+V5GJVQT2FdR8O7orqEtozDy7hSpFczqtslhf3iHko5C/nVqx1u7tVieCTY0Z3KVPQ10/8AwtTxRMFRr9wAMZAxUE/xB8StCT/ac2weh5qk3jrxIxz/AGtc7T1+Y1WfxZq0gzJfzufXeaqy+JtUxgXUxX13mmt4g1DaC93L9Nxp39sXjgBp5SPXfUUl3ezDAlk69S1VTdz5Kl3Zt2ME123wvs/tGvvfsp8uzjMjZ7HHFcnrF495e3tyzjdLIze/WsrOevWvpX9jTp4v/wC3P/2vXzX0UgdMU0gCIHvkVu+GT5evWmzjJFTfEaGOPxDLsUDdgmucYlYvlOOaRmY5yTT97Bo8E+lDEsZCTmhDyw7EUOoDqAOMimyfMX3c4NROSHOCenrSTSPuQb2xj1qxZMTMhJydp/rXpvgomHwJ4juIiVm2Y3jrivL5idvU8mli+7X0p+xn18Yf9uf/ALXr/9k=" />
            <tt:SimpleItem Name="consumedTime" Value="127" />
            <tt:SimpleItem Name="listDescription" Value="" />
            <tt:SimpleItem Name="action" Value="Denied" />
            <tt:SimpleItem Name="carState" Value="lost" />
            <tt:SimpleItem Name="carMoveDirection" Value="in" />
            <tt:SimpleItem Name="left" Value="760" />
            <tt:SimpleItem Name="vehicleType" Value="CAR" />
            <tt:SimpleItem Name="top" Value="608" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

ALPV.RealTime

The following information used for Radar integration.

Package sample
<tt:MetadataStream xmlns:tt="http://www.onvif.org/ver10/schema">
  <tt:Event xmlns:tt="http://www.onvif.org/ver10/schema">
    <wsnt:NotificationMessage xmlns:tns1="http://www.onvif.org/ver10/topics" xmlns:tnsaxis="http://www.axis.com/2009/event/topics" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" xmlns:wsa5="http://www.w3.org/2005/08/addressing">
      <wsnt:Topic Dialect="http://docs.oasis-open.org/wsn/t-1/TopicExpression/Simple">tnsaxis:CameraApplicationPlatform/ALPV.RealTime</wsnt:Topic>
      <wsnt:ProducerReference>
        <wsa5:Address>uri://ae273212-d36d-4c76-bbd5-c1b08dde9e82/ProducerReference</wsa5:Address>
      </wsnt:ProducerReference>
      <wsnt:Message>
        <tt:Message UtcTime="2024-03-14T18:08:58.162077Z">
          <tt:Source>
          </tt:Source>
          <tt:Data>
            <tt:SimpleItem Name="timestamp" Value="1710439737193" />
            <tt:SimpleItem Name="isDetected" Value="1" />
            <tt:SimpleItem Name="coordinates_left" Value="0.106250" />
            <tt:SimpleItem Name="lpText" Value="MWR6677" />
            <tt:SimpleItem Name="coordinates_top" Value="-0.418519" />
            <tt:SimpleItem Name="carID" Value="4" />
            <tt:SimpleItem Name="coordinates_bottom" Value="-0.500000" />
            <tt:SimpleItem Name="coordinates_right" Value="0.368750" />
          </tt:Data>
        </tt:Message>
      </wsnt:Message>
    </wsnt:NotificationMessage>
  </tt:Event>
</tt:MetadataStream>

Push events

Data format of received data

  • TCP: Data formats are JSON files and base64-encoded pictures in the JSON body.

  • HTTP: Data formats are JSON files and JPG images (or base64-encoded pictures in the JSON body with non-multipart requests).

  • FTP: Data format is JPG images.

The following events can be sent several times for each individual license plate:

  • NEW: Used when a new License plate is detected. Only one event is produced and it does not contain direction.

  • UPDATE: Used when something changes in the LPR package. Multiple events can be produced depending on the changes of the LPR package and how long the license plate is on the scene.

  • LOST: Used when a vehicle exits the image. Only one image event is produced (sent +10 seconds after the last UPDATE event).

JSON file keys description

ArgumentDescription
packetCounterThe counter for sent packages.
capture_timestampThe UNIX frame timestamp, measured as an ms UTC timestamp of the event.
frame_timestampThe UNIX frame timestamp (internal from the camera).
capture_ts The same as frame_timestamp but measured in ns (capture_timestamp*1000000).
DatetimeTimestamp for the data:
YYYY = year
MM = month
DD = day
HH = hours
MM = minutes
SS = seconds
FFF = milliseconds
HHMM = optional timezones (hours, minutes)
Example: YYYYMMDD HHMMSSFFF
plateTextThe plate number.
plateUnicodeThe plate number in Unicode.
plateUTF8The plate text using UTF8 symbols.
plateASCIIThe plate text using ASCII symbols.
plateCountryThe country code, according to ISO 3166-1 alpha-3
plateISO3166-2The ISO3166-2 code.
plateRegionThe local region name.
plateRegionCodeThe region letter.
plateListThe name of the list The list will be empty if the plate text cannot be found in the list, or if it is on the Block or Allow lists.
plateListModeAllow or block a plate number.
plateListDescriptionThe description for a plate added to the list.
plateConfidenceThe recognition confidence level.
carStateThe event type. Can be new|update|lost.
roiIDThe area of interest ID where the plate was recognized.
GeotagA JSON object that contains latitude and longitude.
imageTypeThe kind of attached image. Can be either a plate only rectangle with the plate number, the full frame or a vehicle crop.
plateImageTypeThe attached image type.
plateImageSizeThe size of an plate’s image.
carMoveDirectionThe detected movement against a preset direction.
timeProcessingThe time it takes for an event to process.
plateCoordinatesThe coordinates of the license plate bounding box upper left corner and its dimensions calculated for the full video frame.
plateCoordinatesRelativeThe coordinates of the license plate bounding box upper left corner and its dimensions recalculated for the current image crop.
carIDThe internal runtime plate ID.
GEOtargetThe camera location description.
imagesURIAn array of available event images’ URIs:
1. The array element is the plate image.
2. The element dependant (AOI, frame or vehicle) image configuration.
3. The element dependant frame configuration.
imageArrayA JSON object with a base64 image.
imageFilePath to the AOI image.
imageFile2Path to the LP image.
profileIDThe profile number.
vehicle_infoContains vehicle recognition data (ALPV 2.9.19 or later):

  • View

  • Type

  • Color

camera_infoThe camera information structure.
sensorProviderIDThe readable name of the sender.

HTTP POST

This method should be used when you want HTTP POST events to the configured Server URL.

Content-Type

multipart/form-data or application/json

This method can be used alongside JSON LPV to send event images.

Package sample
{
  "packetCounter": "2117397",
  "capture_timestamp": "1702297625507",
  "frame_timestamp": "1702297625507641",
  "capture_ts": "1702297625507000000",
  "datetime": "20231211 142705507",
  "plateText": "HWR6677",
  "plateUnicode": "HWR6677",
  "plateUTF8": "HWR6677",
  "plateASCII": "HWR6677",
  "plateCountry": "DEU",
  "plateISO3166-2": "",
  "plateRegion": "Hannover",
  "plateRegionCode": "H",
  "plateList": "",
  "plateListMode": "",
  "plateListDescription": "",
  "plateConfidence": "0.737210",
  "carState": "update",
  "roiID": "1",
  "geotag": {
    "lat": 55.70421,
    "lon": 13.19366
  },
  "imageType": "plate",
  "plateImageType": "jpeg",
  "plateImageSize": "0",
  "carMoveDirection": "out",
  "timeProcessing": "0",
  "plateCoordinates": [
    514,
    570,
    120,
    28
  ],
  "plateCoordinatesRelative": [
    514,
    570,
    120,
    28
  ],
  "carID": "54950",
  "GEOtarget": "Camera",
  "imagesURI": [
    "/local/fflprapp/tools.cgi?action=getImage&name=52/20231211142706_413731lp_HWR6677_2117396.jpg",
    "/local/fflprapp/tools.cgi?action=getImage&name=48/20231211142705_954662roi_MWR6677_2117394.jpg"
  ],
  "imageFile": "localdata/images/48/20231211142705_954662roi_MWR6677_2117394.jpg",
  "imageFile2": "localdata/images/52/20231211142706_413731lp_HWR6677_2117396.jpg",
  "profileID": "2",
  "vehicle_info": {
    "view": "front",
    "type": "CAR",
    "color": "BLACK"
  },
  "camera_info": {
    "SerialNumber": "ACCC8EBFB452",
    "ProdShortName": "AXIS Q1700-LE",
    "IPAddress": "10.0.3.177",
    "MACAddress": "ACCC8EBFB452"
  },
  "sensorProviderID": "defaultID"
}

Using TCP

TCP send events to a configured TCP receiver. A JSON body must be used by LPV to send appropriate event images in base64.

Package sample
{
  "packetCounter": "8104955",
  "capture_timestamp": "1702299266977",
  "frame_timestamp": "1702299266977980",
  "capture_ts": "1702299266977000000",
  "datetime": "20231211 145426977",
  "plateText": "TÖLSL123",
  "plateUnicode": "TÖLSL123",
  "plateUTF8": "TÖLSL123",
  "plateASCII": "TÖLSL123",
  "plateCountry": "DEU",
  "plateISO3166-2": "",
  "plateRegion": "Bad Tölz",
  "plateRegionCode": "TÖL",
  "plateList": "Block list",
  "plateListMode": "block",
  "plateListDescription": "car_test_1",
  "plateConfidence": "0.725149",
  "carState": "new",
  "roiID": "1",
  "geotag": {
    "lat": 55.70421,
    "lon": 13.19366
  },
  "imageType": "plate",
  "plateImageType": "jpeg",
  "plateImageSize": "0",
  "carMoveDirection": "unknown",
  "timeProcessing": "0",
  "plateCoordinates": [
    670,
    496,
    276,
    44
  ],
  "plateCoordinatesRelative": [
    670,
    496,
    276,
    44
  ],
  "carID": "34939",
  "GEOtarget": "Camera",
  "imagesURI": [
    "/local/fflprapp/tools.cgi?action=getImage&name=67/20231211145427_793329lp_TOLSL123_8104954.jpg",
    "/local/fflprapp/tools.cgi?action=getImage&name=68/20231211145427_804106roi_TOLSL123_8104955.jpg"
  ],
  "ImageArray": [
    {
      "ImageType": "",
      "ImageFormat": "jpg",
      "BinaryImage": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII="
    }
  ],
  "imageFile": "/var/spool/storage/SD_DISK/fflprapp/images/68/20231211145427_804106roi_TOLSL123_8104955.jpg",
  "imageFile2": "/var/spool/storage/SD_DISK/fflprapp/images/67/20231211145427_793329lp_TOLSL123_8104954.jpg",
  "profileID": "1",
  "vehicle_info": {
    "view": "front",
    "type": "CAR",
    "color": "BLUE"
  },
  "camera_info": {
    "SerialNumber": "ACCC8E9BB16D",
    "ProdShortName": "AXIS P1447-LE",
    "IPAddress": "10.0.3.167",
    "MACAddress": "ACCC8E9BB16D"
  },
  "sensorProviderID": "defaultID"
}

Receiver example

Use this method when you want to receive data that can be stored as files using PHP.

PHP
<?php

# Create files in the following directory
$uploaddir = 'log/';

# Set path and filename where to store the event
$uploadfile = $uploaddir . basename($_FILES['event']['name']);

# Store the JSON file on disk
if (move_uploaded_file($_FILES['event']['tmp_name'], $uploadfile)) {
  # All good, do other things here
} else {
  # Failed moving file, do proper error handling
}

# Set path end filename where to store the image
$uploadfile = $uploaddir . basename($_FILES['image']['name']);

# Store the image file on disk
if (move_uploaded_file($_FILES['image']['tmp_name'], $uploadfile)) {
  # All good, do other things here
} else {
  # Failed moving file, do proper error handling
}

?>
Python
import json
from aiohttp.web import Response, Application, run_app, post

async def handle_files(request):
  print("-----new request-----")
  data = await request.post()
  for field_name, file_field in data.items():
    file_contents = file_field.file.read()
    if field_name == 'event':
      json_event = json.loads(file_contents)
      print(f'Event: {json_event}')
  return Response(status=200)

if __name__ == '__main__':
  app = Application()
  app.add_routes([post('/', handle_files)])
  run_app(app, host='0.0.0.0', port=5001)

Get PUSH event configurations

[GET]/local/fflprapp/cloud.cgi

To get configurations for 2nd and 3rd profiles use the following requests:

[GET] /local/fflprapp/cloud2.cgi
[GET] /local/fflprapp/cloud3.cgi
Response sample
200 OK
<?xml version="1.0" encoding="utf-8"?>
<cloud_config>
  <url>aHR0cDovLzEwLjAuNS4yMjM6NTAwMg==</url>
  <latitude>55.70421</latitude>
  <longitude>13.19366</longitude>
  <sensorProviderID>defaultID</sensorProviderID>
  <protocol>1</protocol>
  <enable>false</enable>
  <skip_image_in_post>false</skip_image_in_post>
  <event_new>true</event_new>
  <event_update>false</event_update>
  <event_lost>false</event_lost>
  <use_multipart>true</use_multipart>
  <use_event_buffer>true</use_event_buffer>
  <user></user>
  <password></password>
  <http_auth_type>0</http_auth_type>
  <send_second_image>false</send_second_image>
  <second_image_type>21</second_image_type>
  <path_template></path_template>
  <x_auth_key></x_auth_key>
</cloud_config>
FieldDescription
URLThe encoded target base64 URL. Determines the data that should be pushed to the URL or IP address using the format <IP>:port/path. No path is present when the TCP option is used, however the IP and port is still available.
LatitudeThe camera latitude coordinates, represented by a float number.
LongitudeThe camera longitude coordinates, represented by a float number.
sensorProviderIDThe camera identifier that is sent with all requests when multiple cameras are running to separate them.
ProtocolThe protocol that is sent.
TCP = 8
HTTP = 1
FTP = 16
EnableTrue: The function is enabled.
False: The function is disabled.
skip_image_in_postTrue: Sends the JSON packet, but no images.
False: Sends both the JSON packet and images.
event_newSends NEW events. Can be either true or false.
event_updateSends UPDATE events. Can be either true or false.
event_lostSends LOST events. Can be either true or false.
use_multipartTrue: Sends as multipart/form-data.
False: Sends as application/json.
use_event_bufferEvents will be re-sent from a buffer if the target URL is not accessible. Can be either true o false.
UserThe user name.
PasswordThe password.
http_auth_type
send_second_imageSends a second image with the License plate type alongside the regular image configured in the LPV settings. Can be either true or false.
path_templateThe custom path for FTP.
x_auth_keyThe Auth-Header.

Update PUSH event configurations

[POST] /local/fflprapp/cloud.cgi

To get configurations for 2nd and 3rd profiles use the following requests:

[POST] /local/fflprapp/cloud2.cgi
[POST] /local/fflprapp/cloud3.cgi

TCP

Body
<?xml version="1.0" encoding="utf-8"?>
<cloud_config>
  <url>MTAuMC41LjIyMzo3MDAx</url>
  <latitude>50.418114</latitude>
  <longitude>30.476213</longitude>
  <sensorProviderID>PostmanConfigured</sensorProviderID>
  <protocol>8</protocol>
  <enable>true</enable>
  <skip_image_in_post>true</skip_image_in_post>
  <event_new>true</event_new>
  <event_update>true</event_update>
  <event_lost>true</event_lost>
  <use_multipart>true</use_multipart>
  <use_event_buffer>true</use_event_buffer>
  <user></user>
  <password></password>
  <http_auth_type>0</http_auth_type>
  <send_second_image>false</send_second_image>
  <second_image_type>21</second_image_type>
  <path_template></path_template>
  <x_auth_key></x_auth_key>
</cloud_config>
Response sample HTTP
200 OK
<?xml version="1.0" encoding="utf-8"?>
<cloud_config>
  <url>aHR0cDovLzEwLjAuNS4yMjM6ODA3Ny9saXN0ZW5lci5waHA=</url>
  <latitude>50.418114</latitude>
  <longitude>30.476213</longitude>
  <sensorProviderID>PostmanConfigured</sensorProviderID>
  <protocol>1</protocol>
  <enable>true</enable>
  <skip_image_in_post>false</skip_image_in_post>
  <event_new>true</event_new>
  <event_update>true</event_update>
  <event_lost>true</event_lost>
  <use_multipart>true</use_multipart>
  <use_event_buffer>true</use_event_buffer>
  <user></user>
  <password></password>
  <http_auth_type>0</http_auth_type>
  <send_second_image>false</send_second_image>
  <second_image_type>21</second_image_type>
  <path_template></path_template>
  <x_auth_key></x_auth_key>
</cloud_config>
Response sample FTP
200 OK
Body
<?xml version="1.0" encoding="UTF-8"?>
<cloud_config>
  <url>ZnRwOi8vMTAuMC4zLjI0MToyMQ==</url>
  <user>user</user>
  <password>dXNlcg==</password>
  <latitude>50.418114</latitude>
  <longitude>30.476213</longitude>
  <sensorProviderID>PostmanConfigured</sensorProviderID>
  <protocol>16</protocol>
  <use_multipart>false</use_multipart>
  <use_event_buffer>true</use_event_buffer>
  <event_new>true</event_new>
  <event_update>false</event_update>
  <event_lost>false</event_lost>
  <send_second_image>false</send_second_image>
  <skip_image_in_post>true</skip_image_in_post>
  <enable>true</enable>
  <path_template></path_template>
  <x_auth_key></x_auth_key>
</cloud_config>
Response sample
200 OK

Heartbeat Service

The Heartbeat camera service can send a message with camera conditions to a specified web service in the JSON format. The sending period can be customized, with ranges between 5 to 60 minutes and up to once every 24 hours, as can the JSON fields in the messages.

The following table provides the information that can be included in the JSON message:

SectionField NameDescription
SystemtimestampThe date and time when the information was received.
IdentifyPlatformThe camera name.
VersionThe AXIS OS version.
ipAddressThe camera’s IP version.
macAddressThe camera’s MAC address.
osVersionThe version of the operating system installed on the camera.
anprVersionThe ANPR application version.
ALPVVersionThe ALPV application version.
device_idThe device ID name specified in the camera’s Integration settings.
numFramesThe number of frames.
numFramesAvgThe average number of frames.
numberOfReadsThe number of reads.
ServicesAvailable MemoryThe amount of available memory on the camera.
Package sample
Host: 10.0.3.196:8080
Authorization: Basic cm9vdDpwYXNz
Accept: */*
Content-Type: application/json
Content-Length: 357

{
  'system': {
    'timestamp': '2023-03-10T10:13:24.000Z'
  },
  'identify': {
    'platform': 'AXIS P1447-LE',
    'version': '11.1.72',
    'ipAddress': '10.0.3.167',
    'macAddress': 'AC:CC:8E:9B:B1:6D',
    'osVersion': '11.1.72',
    'anprVersion': '2.7.1'
  },
  'ALPV': {
    'device_ID': 'defaultID',
    'version': '2.7.1',
    'numFrames': '2476',
    'numFramesAvg': '5',
    'numberOfReads': '51'
  }
}

Configure Heartbeat service

[POST] /local/fflprapp/config_hb.cgi
Request sample
<?xml version="1.0" encoding="UTF-8"?>
<hb_config>
  <url>aHR0cDovLzEwLjAuNS4yMjM6ODA3Ny9saXN0ZW5lci5waHA=</url>
  <user>user</user>
  <password>dXNlcg==</password>
  <period>10</period>
  <enable>true</enable>
  <x_auth_key></x_auth_key>
  <http_auth_type>0</http_auth_type>
</hb_config>
FieldValue
URLThe base-64 encoded URL.
UserThe user.
PasswordThe base-64 encoded password.
PeriodThe interval between messages, measured in minutes:
5, 10, 30, 60, 1440
EnableEnables or disables the Hearbeat service. Can be either true or false.
x_auth_keyThe Auth-Header
http_auth_type
Response sample
200 OK

Configure and send Heartbeat service data

[POST] /local/fflprapp/config_hb_data.cgi
Request sample
{
  "system": {
    "timestamp": true
  },
  "identify": {
    "platform": true,
    "version": false,
    "ipAddress": true,
    "macAddress": false,
    "osVersion": true,
    anprVersion": false
  },
  "ALPV": {
    "version": true,
    "device_ID": true,
    "numFrames": false,
    "numFramesAvg": true,
    "numberofReads": true
  },
  "services": {
    "Available Memory": false
  }
}
Response sample
200 OK

Direct integration

2N integration

This part will show you how to integrate AXIS License Plate Verifier with 2N devices.

Get 2N integration settings

[GET] /local/fflprapp/config_2n.cgi
Response sample
200 OK
<?xml version="1.0" encoding="utf-8"?>
<tn_config>
  <url>127.0.0.11</url>
  <enable>true</enable>
  <user>operator</user>
  <password>YWQ=</password>
  <https>false</https>
  <accessPoint>1</accessPoint>
  <event_on_direction>2</event_on_direction>
</tn_config>

Configure 2N integration in ALPV

[POST] /local/fflprapp/config_2n.cgi
Request sample
<?xml version="1.0" encoding="utf-8"?>
<tn_config>
  <url>127.0.0.11</url>
  <user>operator</user>
  <password>YWQ=</password>
  <enable>true</enable>
  <https>false</https>
  <accessPoint>1</accessPoint>
  <event_on_direction>2</event_on_direction>
</tn_config>
FieldValue
URLThe 2N device URL.
UserThe 2N device user.
PasswordThe 2N device password.
EnableEnable or disable ALPV integration. Can be either true or false.
httpsEnable or disable the secure integration connection via HTTPS. Can be either true or false.
accessPointEntry = 0
Exit = 1
event_on_directionAny = 0
In = 2
Out = 3
Response sample
200 OK

Genetec integration

This part will show you how to integrate AXIS License Plate Verifier with Genetec Video Management Systems to send events.

Get Genetic integration settings

[GET] /local/fflprapp/config_gsc.cgi
Response sample
200 OK
<?xml version="1.0" encoding="utf-8"?>
<gsc_config>
  <url>http://10.0.5.223:8077</url>
  <enable>true</enable>
  <user></user>
  <password></password>
  <https>false</https>
  <cameraID>AXIS P1447-LE</cameraID>
</gsc_config>

Configure Genetec integration

[POST] /local/fflprapp/config_gsc.cgi
Request sample
<?xml version="1.0" encoding="utf-8"?>
<gsc_config>
  <url>http://10.0.5.223:8077</url>
  <enable>true</enable>
  <user></user>
  <password></password>
  <cameraID>AXIS P1447-LE</cameraID>
</gsc_config>
FieldValue
URLThe 2N device URL.
UserThe Genetec user.
PasswordThe Genetec password.
EnableEnable or disable ALPV integration. Can be either true or false.
cameraIDThe camera ID.
Response sample
200 OK

The following is an example for an ALPV event sent to Genetec.

[POST] /lpringestion/Reads
Package sample
{
  "ReferenceReadId": "1802305026703433",
  "ReferenceCameraId": "ACCC8E9BB16D",
  "Plate": "AXIS1234",
  "Confidence":"0.95",
  "PlateStateProvince":"AXIS",
  "PlateImage": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII=",
  "ContextImage": "iVBORw0KGgoAAAANSUhEUgAAAAgAAAAIAQMAAAD+wSzIAAAABlBMVEX///+/v7+jQ3Y5AAAADklEQVQI12P4AIX8EAgALgAD/aNpbtEAAAAASUVORK5CYII=",
  "CameraName":"AXIS P1447-LE",
  "VehicleDirection":"In",
  "ReadTimeUtc": "2023-12-11T14:30:26.703Z"
}

Application API

Get ALPV settings

[GET] /local/fflprapp/config.cgi
Response sample
200 OK
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <roi>
    <left>50</left>
    <top>50</top>
    <right>475</right>
    <bottom>950</bottom>
    <width>425</width>
    <height>900</height>
    <angle>0</angle>
  </roi>
  <roitwo>
    <left>525</left>
    <top>50</top>
    <right>475</right>
    <bottom>950</bottom>
    <width>425</width>
    <height>900</height>
    <angle>0</angle>
  </roitwo>
  <direction>
    <angle>180000</angle>
  </direction>
  <direction2>
    <angle>180000</angle>
  </direction2>
  <active_roi>2</active_roi>
  <roi1_view>0</roi1_view>
  <roi2_view>0</roi2_view>
  <plate>
    <plate_min_size_percent>130</plate_min_size_percent>
    <plate_min_size>130</plate_min_size>
    <plate_max_size>300</plate_max_size>
    <plate_min_size_symb>5</plate_min_size_symb>
    <plate_max_size_symb>10</plate_max_size_symb>
    <threshold>0.700000</threshold>
    <mmr_threshold>10</mmr_threshold>
  </plate>
  <sdCardStatus>1</sdCardStatus>
  <mmr_enabled>1</mmr_enabled>
  <cropModeFlag toggle="yes">1</cropModeFlag>
  <smallPicModeFlag toggle="no">1</smallPicModeFlag>
  <rulesEnableFlag toggle="yes">1</rulesEnableFlag>
  <dumpYUVFlag toggle="yes">0</dumpYUVFlag>
  <detectorOnlyFlag toggle="yes">0</detectorOnlyFlag>
  <saveReportsFlag toggle="yes">0</saveReportsFlag>
  <showColorFlag toggle="yes">0</showColorFlag>
  <showColorConfidenceFlag toggle="yes">0</showColorConfidenceFlag>
  <showPlateConfFlag toggle="yes">0</showPlateConfFlag>
  <showDirectionFlag toggle="yes">0</showDirectionFlag>
  <showProcessedTimeFlag toggle="yes">0</showProcessedTimeFlag>
  <showDebug toggle="yes">0</showDebug>
  <ttl>10000</ttl>
  <result_delay>0</result_delay>
  <barrier_mode>0</barrier_mode>
  <barrier_priority>0</barrier_priority>
  <barrier_vehicle_direction>0</barrier_vehicle_direction>
  <barrier_roi>0</barrier_roi>
  <ipc_login>root</ipc_login>
  <ipc_password>******</ipc_password>
  <relay_port>2</relay_port>
  <relay_port_virtual>-1</relay_port_virtual>
  <relay_type>0</relay_type>
  <full_frame>0</full_frame>
  <full_frame_downscale>2</full_frame_downscale>
  <bw_ldist>1</bw_ldist>
  <bw_strict>0</bw_strict>
  <getframe_driver>0</getframe_driver>
  <lpr_text_overlay>0</lpr_text_overlay>
  <lpr_text_overlay_duration>2</lpr_text_overlay_duration>
  <lpr_text_overlay_format>JUYgJVggeyVwbGF0ZX0=</lpr_text_overlay_format>
  <nocountry_filter>0</nocountry_filter>
  <plate_min_size_symb>5</plate_min_size_symb>
  <plate_max_size_symb>10</plate_max_size_symb>
  <config_version>1</config_version>
  <frame_rotate>0</frame_rotate>
  <keep_events>0</keep_events>
  <keep_events_period>0</keep_events_period>
  <stored_events>35646</stored_events>
  <defaultActionID>3</defaultActionID>
  <pulseDuration>3000</pulseDuration>
  <lprUseCase>5</lprUseCase>
  <debugLevel>1</debugLevel>
  <login>admin</login>
  <password>ZDNSbVpYa3hNdz09</password>
  <security>
    <use_https>0</use_https>
    <selfsigned_allow>0</selfsigned_allow>
    <curl_CApath>/etc/certs/mgmt/ca/</curl_CApath>
    <curl_CApath_enabled>1</curl_CApath_enabled>
  </security>
  <camera>
    <iskit>0</iskit>
    <isparamsoptimal>0</isparamsoptimal>
    <wdr>1</wdr>
    <contrast>50</contrast>
    <localcontrast>50</localcontrast>
    <maxgain>42</maxgain>
    <recommended>
      <wdr>0</wdr>
      <maxexposuretime>500</maxexposuretime>
      <maxgain>24</maxgain>
      <contrast>50</contrast>
      <localcontrast>20</localcontrast>
    </recommended>
  </camera>
  <initialsetupdone>1</initialsetupdone>
  <initialsetupstage>0</initialsetupstage>
  <CountryPriority></CountryPriority>
  <StatePriority></StatePriority>
  <curl_connect_timeout>10000</curl_connect_timeout>
  <events_storage_size>1000</events_storage_size>
  <resolution>
    <width access="priv">1920</width>
    <height access="priv">1080</height>
    <fk access="priv">1</fk>
    <ipc_password_valid access="priv">1</ipc_password_valid>
  </resolution>
  <configFileName access="const">localdata/cfg/fflprapp_config.xml</configFileName>
  <sqliteName access="const">/var/spool/storage/SD_DISK/fflprapp/fflprapp_events_mmr03.db</sqliteName>
  <imagesPath access="priv">/var/spool/storage/SD_DISK/fflprapp/images</imagesPath>
  <logsPath access="priv">/var/spool/storage/SD_DISK/fflprapp/logs</logsPath>
  <exportPath access="priv">export</exportPath>
  <maxEventsCount access="priv">100000</maxEventsCount>
  <logfileSize access="priv">0</logfileSize>
  <logfilesNum access="priv">10</logfilesNum>
  <httpPort access="priv">8765</httpPort>
  <documentRoot access="priv">.</documentRoot>
</configuration>

Get Area of Interest configuration

[GET] /local/fflprapp/api.cgi?api=getrroi
Response sample
200 OK
<pre>ROI1 is active
X0,Y0 = [96, 54]
X1,Y1 = [1824, 54]
X2,Y2 = [1824, 1026]
X3,Y3 = [96, 1026]
X4,Y4 = [0, 0]
X5,Y5 = [0, 0]
X6,Y6 = [0, 0]
X7,Y7 = [0, 0]
</pre>

Set Area of Interest configuration

[POST] /local/fflprapp/config.cgi
Request sample
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <active_roi>2</active_roi>
  <roi>
    <left>50</left>
    <top>50</top>
    <right>350</right>
    <bottom>350</bottom>
    <width>300</width>
    <height>300</height>
    <angle>0</angle>
  </roi>
  <roitwo>
    <left>500</left>
    <top>50</top>
    <right>990</right>
    <bottom>990</bottom>
    <width>425</width>
    <height>990</height>
    <angle>3000</angle>
  </roitwo>
</configuration>
Response sample
200 OK

Car direction

Change direction angle

[POST] local/fflprapp/config_json.cgi
Request sample
{
  "api": "setconfig",
  "config": "roi",
  "roi": [
    {
      "id": 1,
      "name": "roi1",
      "type": "polygon",
      "active": true,
      "angle": {{0-360000}},
      "coordinates": [
        [
          50,
          50
        ],
        [
          950,
          50
        ],
        [
          950,
          950
        ],
        [
          50,
          950
        ]
      ]
    },
    {
      "id": 2,
      "name": "roi2",
      "type": "polygon",
      "active": false,
      "angle": {{0-360000}},
      "coordinates": [
        [
          525,
          50
        ],
        [
          950,
          50
        ],
        [
          950,
          950
        ],
        [
          525,
          950
        ]
      ]
    }
  ]
}
Response sample
200 OK

List management

Get list settings

[GET] /local/fflprapp/list_mgmt.cgi
Response sample
200 OK
{
  "lists": [
    {
      "id": "1",
      "name": "Allow list",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "0",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ],
      "mode": "allow"
    },
    {
      "id": "2",
      "name": "Block list",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "0",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ],
      "mode": "block"
    },
    {
      "id": "3",
      "name": "Custom list",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "0",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ],
      "mode": "none"
    }
  ]
}
KeyValue
IdLists the ID string.
NameLists the name.
ScheduleA JSON object.
EnabledCan be either true or false.
start_timeThe start time, measured in seconds.
end_timeThe end time, measured in seconds.
Mon...SunDays of the week when the list schedule will work. Can be either true or false.
ModeThe list mode. Can be allow|block|none.

Change list settings

[POST] /local/fflprapp/list_mgmt.cgi
Request sample
{
  "lists": [
    {
      "id": "1",
      "name": "Allow list",
      "mode": "allow",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "86340",
          "Mon": false,
          "Tue": false,
          "Wed": false,
          "Thu": true,
          "Fri": false,
          "Sat": false,
          "Sun": false
        }
      ]
    },
    {
      "id": "2",
      "name": "Block list",
      "mode": "block",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "86340",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ]
    },
    {
      "id": "3",
      "name": "Custom list",
      "mode": "allow",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "86340",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ]
    }
  ]
}
Response sample
200 OK
{
  "lists": [
    {
      "id": "1",
      "name": "Allow list",
      "mode": "allow",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "86340",
          "Mon": false,
          "Tue": false,
          "Wed": false,
          "Thu": true,
          "Fri": false,
          "Sat": false,
          "Sun": false
        }
      ]
    },
    {
      "id": "2",
      "name": "Block list",
      "mode": "block",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "86340",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ]
    },
    {
      "id": "3",
      "name": "Custom list",
      "mode": "allow",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "86340",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ]
    }
  ]
}

Rename lists

[POST] /local/fflprapp/list_mgmt.cgi

The list can be renamed by specifying the new name in the name field of the corresponding list in the request body.

Request sample
{
  "lists": [
    {
      "id": "1",
      "name": "{{allow list name}}",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "0",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ]
      "mode": "allow"
    },
    {
      "id": "2",
      "name": "{{block list name}}",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "0",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ]
      "mode": "block"
    },
    {
      "id": "3",
      "name": "{{custom list name}}",
      "schedule": [
        {
          "enabled": false,
          "start_time": "0",
          "end_time": "0",
          "Mon": true,
          "Tue": true,
          "Wed": true,
          "Thu": true,
          "Fri": true,
          "Sat": true,
          "Sun": true
        }
      ]
      "mode": "none"
    }
  ]
}
Response sample
200 OK

Get Allow/Block/Custom list

[GET] /local/fflprapp/{{list_name}}.cgi
Response sample
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<bw_list mode="{{list_mode}}">
  <s>M SR1669,09-29-2023,car_test_2</s>
  <s>M UG0104,09-29-2023,test_more_updates</s>
</bw_list>
ParameterValue
list_nameallow_list|block_list|custom_list
list_modeThe list name:
allow|block|custom

Add a single plate to the Allow/Block/Custom list

[GET] /local/fflprapp/api.cgi?api=addplate&plate={{plate_text}},{{plate_date}},{{description}}&list={{list_name}}
ParameterValue
PlateThe plate text with date and description:
AA12DD,12-12-2023,Plate_description
ListThe list name:
allow|block|custom
Response sample
200 OK

Add a batch of plates to the Allow/Block/Custom list

[POST] /local/fflprapp/{{list_name}}.cgi
Request body sample
<?xml version="1.0" encoding="utf-8"?>
<bw_list mode="{{list_mode}}">
  <s>AA123DD</s>
  <s>AA124DD</s>
</bw_list>
ParameterValue
list_nameallow_list | block_list | custom_list
list_modeallow|block|custom
Response sample
200 OK

Remove a single plate from the Allow/Block/Custom list

[GET] /local/fflprapp/api.cgi?api=delplate&plate={{plate_text}}&list={{list_name}}
ParameterValue
plate_nameThe plate text that should be deleted.
list_nameallow|block|custom
Response sample
200 OK

Export a Allow/Block/Custom list

[GET] /local/fflprapp/api.cgi?api=export{{list_name}}
ParameterValue
list_nameallow|block|custom
Response sample
200 OK
M WR6677,09-29-2023,Most wanted car
TÖL SL123,09-29-2023,car_test_1

Import a list as a .csv file

Use the following sequence of commands to upload the Allow, Block or Custom list to your camera as a .csv file.

1. Create a new list:

[POST] /local/fflprapp/upload.cgi?command=new&list={{file name}}.csv

2. Upload data:

[POST] /local/fflprapp/upload.cgi?command=upload&list={{file name}}.csv

3. Save and apply:

[POST] /local/fflprapp/upload.cgi?command=save&list={{file name}}.csv
Shell script example
#!/bin/bash
#example:
#./send_list.sh block root:pass 10.0.3.167 block_list.csv
#./send_list.sh allow root:pass 10.0.3.167 allow_list.csv
#set -x
#clean temporary folder
rm -rf .$1
#recreate temporary folder .block or .allow
mkdir .$1
#go to temporary folder
cd .$1
#split input file in small chunks
split -l 500 ../$4
#Create new list
curl --anyauth -u "$2" -X POST -d "command=new&list=$1" http://$3/local/fflprapp/upload.cgi
#upload data
for i in `ls`;do
curl --anyauth -u "$2" -X POST -d "command=upload&list=$1" --data-urlencode "data@$i" http://$3/local/fflprapp/upload.cgi
done
#save&apply list
curl --anyauth -u "$2" -X POST -d "command=save&list=$1" http://$3/local/fflprapp/upload.cgi
#leave temporary folder
cd .. #data in a temporary folder not deleted for checking !

Event search and download

Search events

[GET] /local/fflprapp/events.cgi?timestampfrom={{timestamp_from}}&timestampto={{timestamp_to}}
KeyValue exampleDescription
timestampfrom1702386728835000The timstamp that filter records by time, measured in milliseconds (ms). Can be used without timestampto.
timestampto1702390328836000The timstamp that filter records by time, measured in milliseconds (ms). Can be used without timestampfrom.
textRZ9903FThe plate text.
plate_descStringThe plate description from List management if a plate was added to any list.
countryCZEThe country shown in the ISO 3166-alpha3 format.
car_type1CAR = 1; BUS = 2; TRUCK = 32
car_color065536 = for any or undefined
0 = Beige
1 = Black
2 = Blue
3 = Brown
4 = Gray
5 = Green
6 = Orange
7 = Red
8 = White
9 = Yellow
10 = Silver
roi_id-1
car_direction-1-1 for any
car_view1Rear = 1; Front = 0
Action1The filter used when an action is taken.
1 = opened
0 = no action
offsetThe amount of record that can be skipped before filling a reply, such as the SQL OFFSET clause.
Limit18Limit the result records.
Response sample
200 OK
<events>
  <currentTimestampUs>1702390328555082</currentTimestampUs>
  <event>
    <TS>CAR</TS>
    <MOD_TS>2023-12-12 16:12:04 EET</MOD_TS>
    <END_TS>0</END_TS>
    <CAR_ID>42628</CAR_ID>
    <LPR>MSR1669</LPR>
    <LPR_UTF8>M SR1669</LPR_UTF8>
    <LPR_UNICODE>\u004d\u0053\u0052\u0031\u0036\u0036\u0039</LPR_UNICODE>
    <RTIME>223.0</RTIME>
    <ACTION>100</ACTION>
    <ACT_PARAM>Allow list</ACT_PARAM>
    <THRESHOLD>0.701837122440338</THRESHOLD>
    <ROI_X>96</ROI_X>
    <ROI_Y>54</ROI_Y>
    <ROI_W>1728</ROI_W>
    <ROI_H>972</ROI_H>
    <LP_X>564</LP_X>
    <LP_Y>478</LP_Y>
    <LP_W>220</LP_W>
    <LP_H>32</LP_H>
    <ROI_ID>1</ROI_ID>
    <ROI_IDU>0</ROI_IDU>
    <FRAMES>0</FRAMES>
    <DIRECTION>2</DIRECTION>

  <LP_BMP>tools.cgi?action=getImage&amp;name=53/20231212161204_601572lp_MSR1669_8565355.jpg</LP_BMP>

  <ROI_BMP>tools.cgi?action=getImage&amp;name=51/20231212161204_259638roi_MSR1669_8565354.jpg</ROI_BMP>
    <COUNTRY>DEU</COUNTRY>
    <LP_LIST_MODE>1</LP_LIST_MODE>
    <LP_DESCRIPTION>car_test_2</LP_DESCRIPTION>
    <LP_REGION_UTF8>München</LP_REGION_UTF8>
    <ISO3166_2_CODE></ISO3166_2_CODE>
    <LP_TYPE>0</LP_TYPE>
    <EXT1></EXT1>
    <EXT2></EXT2>
    <EXT3></EXT3>
    <CAR_M_TYPE>CAR</CAR_M_TYPE>
    <CAR_COLOR>BLUE</CAR_COLOR>
    <CAR_CONF>55.8820610046387</CAR_CONF>
    <CAR_VIEW>0</CAR_VIEW>
  </event>
  <event>
    <TS>CAR</TS>
    <MOD_TS>2023-12-12 16:11:58 EET</MOD_TS>
    <END_TS>0</END_TS>
    <CAR_ID>42627</CAR_ID>
    <LPR>111WR6677</LPR>
    <LPR_UTF8>111WR6677</LPR_UTF8>
    <LPR_UNICODE>\u004d\u0036\u0036\u0037\u0037</LPR_UNICODE>
    <RTIME>286.0</RTIME>
    <ACTION>100</ACTION>
    <ACT_PARAM></ACT_PARAM>
    <THRESHOLD>0.739800155162811</THRESHOLD>
    <ROI_X>96</ROI_X>
    <ROI_Y>54</ROI_Y>
    <ROI_W>1728</ROI_W>
    <ROI_H>972</ROI_H>
    <LP_X>528</LP_X>
    <LP_Y>444</LP_Y>
    <LP_W>184</LP_W>
    <LP_H>30</LP_H>
    <ROI_ID>1</ROI_ID>
    <ROI_IDU>0</ROI_IDU>
    <FRAMES>0</FRAMES>
    <DIRECTION>2</DIRECTION>

  <LP_BMP>tools.cgi?action=getImage&amp;name=48/20231212161158_917432lp_111WR6677_8565325.jpg</LP_BMP>

  <ROI_BMP>tools.cgi?action=getImage&amp;name=42/20231212161153_323507roi_M6677_8565307.jpg</ROI_BMP>
    <COUNTRY>XX</COUNTRY>
    <LP_LIST_MODE>0</LP_LIST_MODE>
    <LP_DESCRIPTION></LP_DESCRIPTION>
    <LP_REGION_UTF8></LP_REGION_UTF8>
    <ISO3166_2_CODE></ISO3166_2_CODE>
    <LP_TYPE>0</LP_TYPE>
    <EXT1></EXT1>
    <EXT2></EXT2>
    <EXT3></EXT3>
    <CAR_M_TYPE>CAR</CAR_M_TYPE>
    <CAR_COLOR>BLUE</CAR_COLOR>
    <CAR_CONF>98.5452041625977</CAR_CONF>
    <CAR_VIEW>0</CAR_VIEW>
  </event>
</events>

Statistics

[GET] /local/fflprapp/search.cgi?limit=0
Response sample
200 OK
<events>
  <currentTimestampUs>1702306482677809</currentTimestampUs>
  <vcount>
    <direction>
      <in>978</in>
      <out>0</out>
      <unk>22</unk>
    </direction>
    <list>
      <blocklist>0</blocklist>
      <allowlist>0</allowlist>
      <customlist>0</customlist>
      <nonelist>1000</nonelist>
    </list>
    <roi>
      <roi1>1000</roi1>
      <roi2>0</roi2>
    </roi>
    <total>1000</total>
  </vcount>
</events>
Fence guard
Loitering guard
Cookie settings
 • 
My Axis
 • 
Developer community
 • 
About

©2008 - 2024 Axis Communications AB. AXIS COMMUNICATIONS, AXIS, ARTPEC and VAPIX are registered trademarks of Axis AB in various jurisdictions. All other trademarks are the property of their respective owners. We reserve the right to introduce modifications without notice.