5.16.1 api lpr licenseplate

The api/lpr/licenseplate function is used for access control by license plate recognition.

Service and Privileges Groups

Service group is API Access Control.
Privileges group is Access Control.

Methods

POST

Request

The request contains parameters in the application/json format.

Table 1. Request JSON Keys

Key Name	Mandatory	Expected Values	Default Value	Description
lprUuid	Yes	uuid string	–	Uuid of the licence plate recognition event generated by the License Plate Recognition system.
lprID	Yes	ID number	–	Internally unique identifier designating one license plate in one recorded car arrival. One and the same license plate can be recognized multiple times within one arrival. In case the camera obtains more details from another recognition, the plateText will be specified while the lprID will remain the same. Each recognition event generates a lprUuid of its own.
accessPoint	Yes	0 or 1	-	Indicates whether a vehicle with the detected license plate is entering (0) or exiting (1) – this is important for Access Rules that are applied to the event in the 2N device.
plateText	Yes	license plate string	–	Text of the recognized license plate that is used to identify a user in the 2N device directory.
lprDir	No	0 to 3	–	Defines the detected car/license plate motion direction according to the camera direction setting. Options: 0 = unknown 1 = Undefined (In or Out) 2 = in 3 = out
plateImage	No	image encoded in base64	No image	The image in which the license plate was recognized. The size of the image data is limited to 256 kB.

Example of Request

URL:
https://192.168.1.1/api/lpr/licenseplate

JSON:
{
    "lprUuid": "bc4baad9-d2cd-4706-986f-b942963bfa9f",
    "lprID": 143289,
    "accessPoint": 0,
    "plateText": "ABC123456",
    "plateImage": "/9j/4AAQSkZJRgABAQEASABIAAD//gATQ3JlYXRlZCB3aXRoIEdJTVD/4gKwSUNDX1BST0ZJTEUAAQEAAAKgbGNtcwQwAABtbnRyUkdCIFhZWiAH5AAMABIACgAHAA5hY3NwTVNGVAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA9tYAAQAAAADTLWxjbXMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA1kZXNjAAABIAAAAEBjcHJ0AAABYAAAADZ3dHB0AAABmAAAABRjaGFkAAABrAAAACxyWFlaAAAB2AAAABRiWFlaAAAB7AAAABRnWFlaAAACAAAAABRyVFJDAAACFAAAACBnVFJDAAACFAAAACBiVFJDAAACFAAAACBjaHJtAAACNAAAACRkbW5kAAACWAAAACRkbWRkAAACfAAAACRtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACQAAAAcAEcASQBNAFAAIABiAHUAaQBsAHQALQBpAG4AIABzAFIARwBCbWx1YwAAAAAAAAABAAAADGVuVVMAAAAaAAAAHABQAHUAYgBsAGkAYwAgAEQAbwBtAGEAaQBuAABYWVogAAAAAAAA9tYAAQAAAADTLXNmMzIAAAAAAAEMQgAABd7///MlAAAHkwAA/ZD///uh///9ogAAA9wAAMBuWFlaIAAAAAAAAG+gAAA49QAAA5BYWVogAAAAAAAAJJ8AAA+EAAC2xFhZWiAAAAAAAABilwAAt4cAABjZcGFyYQAAAAAAAwAAAAJmZgAA8qcAAA1ZAAAT0AAACltjaHJtAAAAAAADAAAAAKPXAABUfAAATM0AAJmaAAAmZwAAD1xtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAEcASQBNAFBtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEL/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wgARCABMAIADAREAAhEBAxEB/8QAGwAAAgMBAQEAAAAAAAAAAAAAAAcFBggDBAL/xAAaAQACAwEBAAAAAAAAAAAAAAAABQMEBgIB/9oADAMBAAIQAxAAAAHUx4kXairWqwAAAAAAAAAAFlrWHgkcKhqtzRps56eO5KPsAD5CGnh689S0Unk75j5I/rz2Wilh5odHZvQxU0KGfJNf4/WS0Unk65An4Js6aJDfaF5qKmPP3zGezycd3xsbH6vFe1x7yRO+/ghnyS207dds1/J3x35707l9HUrlS+0LufdAk0VnXyfbqlkzXbFx+rxXtce8kTvv4IZ8kutG601bK60bluqWoCxBmnS55/IHeetAjbalp8niGfJdi4/V4r2uPeSJ338EM+SbLxmup1yosGi6j3acZNCBrTJajPWgR3Cpaa6lplnU5rYmP1eK9rj3kid9/BDPkm0MXr1g0XVW1VAAqVurorOvs9aBH9nut8lp1C3VsddfxbtMg8kTv2cdIHQImqpa3ijcAAAWzJdZK1lZM10NPA7Ujmdrzr5hQWjRa9kLtsKWmRddlouaEAAAAAAAAAACRil1vktRa6tnh75FSxgAAAAAAAAAASkUno89/8QAKhAAAQMDAwIGAgMAAAAAAAAABQADBAIGBwEVFzE2EhMWMzQ1EBEUMDL/2gAIAQEAAQUCrr0bpL5Kpad5KKLkoouSii5KKLkoouSii5KKLkoouSii5KKLkoouSiiE5L8bjblLzeSCVUUWmY7smvZCK2QitjIqoMQbpTbdb1eyEVIgSomi001q1rDz2qFjUlXIg5S6q0ILMIBKPDoT3qkSvVIlRpTM1nIwtmEQx2MaYDVOU06vx25TJ4btBeD824Poli738pdVHusrFYlSnZshNMuP1Y/GyRwnKP8Aqw+17vrqruSy5tU63MlRvKNQfnXB9EsXe/lLqgNpzT+kTGMalRLMDxE2y1GomXMLgK67h9QkLD7Xu7uTGMnxQMnRvFBgfOuD6JYu9/KXVWw1Szb1w37SGnTMglpKlk5c782H2vd3cmNJPlmL4jfybaH/AD7g+iWLvfyl1Vua/sBc1jTSpjjYquNiq42Ko7bkq3tbD7Xu7uS0JWkO45UaiZGiY1ajTbiq0pArF3v5Rbq1bVtX04FjcnQ1ydDXJ0NcnQ1d9ys3HVbt9Rgog1PpKFdNf1qLyVWyxydDVy3s+dZWLqNfMuELQeGERkkVI/sgj5BORbQOkAMTzDcijYhq2IatiGrYhq2IatiGrYhq2IatiGrYhq2IatiGpmO1GpX/xAAsEQABAwAJAgcBAQEAAAAAAAABAAIDBAUQERMVM1FSEkIhMTJBcYGRIhQw/9oACAEDAQE/AVLWAaboxeswl2CzCXYLMJdgswl2CzCXYLMJdgswl2CzCXYLMJdgswl2CzCXYLMJdgoqwBN0gQN6p8nTH0j3sa1zvSFgy8T+LBl4n8WDLxP4sGTifywAu8AsGXifxOje3xcLPNYUg82myr5C5hYfZVl22UZgZE25OljYbnOX+iLkF/oi5BBwcLwqwjDXBw91QWBsXVvYQCLip48KQtUWo1TaTviyre76VZdtgpUzRcHJ7y89TrA0u9IVCjdHH/SrLtVD0Gqma7lRXl8LSVWLbpA5Retqm0nfFlW930qy7bIKK+fx9k2rmD1FNosLe1eSfPGz1OVKnx3eHkFQ9Bqpeu5Vc69haqxb/AcotRqm0nfFlW930qy7bKOLom/Cnpohd0AJ9Pld5eCdK9/qNtD0Gql67lVzv7LVS29ULlFqNU2k74sq3u+lWXbZBpN+FSKG+WTraVl8u4WXy7hZfLuFNR3QXdXuqHoNVL13KiO6ZmpwDhcUygNa/qvU+k74sq3u+lWI8Gmyj03Cb0OHgsxj2KzGPYrMY9isxj2KpdIbPd0+ygprIowwhTyCWQvC8lHWFwukCzGPYqkUwzDpb4CyrR6ipohMzpKkidEbnD/rHG6U3NCghELOmwi/zWFHxWFHxWFHxWFHxWFHxWFHxWFHxWFHxWFHxWFHxWFHxWFHxQAHlZ//xAAvEQABAwEFBgYDAQEBAAAAAAABAAIDBAUQERVREhMxUoGRITIzQUJxFDTwIiMw/9oACAECAQE/AeKhs0uGMhwWWxalZbFqVlsWpWWxalZbFqVlsWpWWxalZbFqVlsWpWWxalZbFqVlsWpUtm4DGIojDwKs6MPkLj7XOc1vi4rfxcw7rfxcw7rfxcw7rfRcw73EhoxK38XMO6bIx/lON4mjPgHC60ow14ePdWX8+l1W8vmdimwSvGLWr8abkK/Gm5CnNLDg4KzZHPYWn2VoSF0ux7C4EtOIVPJvog9SeQqn9Vn2LrU4M6qy/n0udSQuO0WpjAwbLeFxcG+JKr5GSS/4Vl/Poq79h397KjH/AAaqxgZO4BWa7GItUnkKp/VZ9i61ODOqsv59Lp6uODwPFPtN58rU6snf8kSXcUymlk8rVSU/47MDxKrv2Hf3sqP0Gq024Pa5WY7/AG5ql8jlT+qz7F1qcGdVZfz6XVJxmf8Aap6AzM2yUyz4W8fFMijj8ovrv2Hf3sqP0Gq024xhyonbM7VL5HKn9Vn2LrU4M6qy/n0uqPWf9qmrmRRhjhwWZQ6FZlDoVmUOhUFSyox2PZV37Dv72VH6DVWN24HJriwhwT7Sc5hbsqn9Zn3danBnVWWfFwuqaETO22nArLJNQssk1CyyTULLJNQqOmdT7W0eKqKF80peCoIzFGGG6WzcTjGVlkmoVNRNgO244m61D5AqeYwP2wo5WSjaYf8A1kkbENp5VTOZ5Nq4Ejgt/LzHut/LzHut/LzHut/LzHut/LzHut/LzHut/LzHut/LzHut/LzHut/LzHut/LzHut/LzHuiS7xN3//EAEIQAAECAwEKCAwFBQAAAAAAAAIBAwAEERIFECEzNUFRkpPREyIxNHORsbIUMmFxcnSBgoOhwcIkQkPh8TBSVGPw/9oACAEBAAY/AlIlQRTCqrBN3PYR1E/Vd5F9kYqV1C3xipXULfGKldQt8YqV1C3xipXULfGKldQt8YqV1C3xipXULfGKldQt8YqV1C3xipXULfGKldQt8CF0JdAFf1Wc3sgXAJDAkqhJnhqWBbKzBcb0U/5L1lls3S0ANY5hNbEoyfNbEoyfNbEoUikZkRTOrJXkBsVM15BFKrHMJrYlFX5Z1lNLgKN6iYVWCM5KZERSqkrRUS9MShrXgFRQ8y5oub8T7b0orYIhOgjhlnVVhWn5xppxOUVLCkZQY1oygxrQjrDgvNryEC1SGJhoUDwhFtImlM/zhJyyivvkvG0Ii0pFFJEXyrBNOgjjZJRRLPEzKp4oFxfNypEv0g9sXR9Xc7q3roeiH1i5vxPtvAy1OEDYJZEaJgSDffPhHTwkS571loCcLQKVh1JlsmlcctCBctKRc34n2xKe/wB5YnrSqtDpEqRlaMagqr5Fhp7M6180X+Il+kHti6Pq7ndW9dD0Q+sXN+J9t5XGrLTCLThXPpH4mccc8jY2d8YJMXF0u8btijYA0Cf2pRIXhZ1q0n5QW0vyhHAFQYbSy2i8vniU9/vLE/0kTkvXCDiH1p+0ScxnBxQ60/aJfpB7Yuj6u53VvXQ9EPrFzfifbeuegpROBEuvDDsm3Kq843SpEVE5KxxDblk/1hvj8RMuveQzVb8p7/eWJ/pIfZzONV9qL/MTVOUKH1LEt0g9sXR9Xc7q3roeiH1i5vxPtvXO6AOyHpuXdZsO0wOKqKmCmiMZLa67oxktrrujGS2uu6GUmSbLha04Na8n8xKe/wB5Yn+kiSNVoKlYX2pSHWHEq24KgXmht4p0jbA7Vjg6KvtrF0VX/HPsvXQ9EPrFznPyopp2brySr7PhDA+KqLQhjmj/AFpHNH+tI5o/8o5o/wDKJVWmja4K1W35aboZlHJd1wgrxhpTCtYmZoBUBdKqIsVTAsC3Oy/DEKU4UFoq+yOZv9aR4O234PLVwpWqleugdOLQEr1w5LEtk/GA9BQrMy0rZpp5F839VGZZonXF0ZoFitp1eM4Wlb1l1sXB0GlYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYyfK7EYsstg0OgBpe//xAAnEAABAgQGAgMBAQAAAAAAAAABABEhMVHwEEFhkaHBcYEwsdHxIP/aAAgBAQABPyEF8SSYAVUJJrxHiCLex8tGjRo0aNGjRo0aIIaYXG8jct4PpDxGOuAMiET+TgzZJG5wZ6pfHsFdHSvLpWt0o4OCEA4whgccD0r66QSZ4AEO4wGQEhgBMowFgWAJklsDHBKjk/8AYHfE7RpIQR4nhSl9t7BjlOePtBGNBY7AmHJmyiQAmIsgNiUDFaQYTW6yOATjiYsax9BCvFGKiwVxnBJuBDJCSOgIzAsNd38tgmOSZYGA5GUkcLNkctOUapzIMGCJOHLHMQDhkUEIWOoB4S4UYqLBXGcJDkELE5gM0yknRDykRr9PGDhUnQAJDa4cXctJA9sy1PQXLTstAhnJGaNKNqmHR5bdRiosFcZxBiENUHclVCZPwgDEmeicwc6x3ciZL6XYG0seWnZaBGJz/oG4KHanb/Q/DqxUYqLBXGcRQLwuKjphJoAMhPL/ABPnyykoTf5Du4FC5adtoE+bs3mDkhMRjAqDFBs+FpgXAP4IjDBncxhYKqEAjs6l4+2BDxRhYpGYV89q+e1/e/a/v/tNk6DgjQZDHTeRx3N5WcELYgiCIQFwRkj64Qfkln7Vw9ogf7pdyc00wiU3AoAjzoSpH7HtEfZBkGpZj5cuegw1E5BNjGt5FpoJYFxnyobFX90r+6V/dK/ulf3Sv7pX90r+6V/dK/ulf3Sv7pafpg7DD//aAAwDAQACAAMAAAAQ5222222dFT9dTNQqNhSVn9+sNdo2ZCesNp6Jf3+sNzOtfOesNwSWfGJsVSW3WR3rWtttttt9iSSSSSSU/8QAJxEAAQIEBAcBAQAAAAAAAAAAAQARMWGx0RAhkfFBUXGBocHw4TD/2gAIAQMBAT8QJADlGnWDD98LaDdbQbraDdbQbraDdbQbraDdbQbraDdbQbraDdbQboKYTENEAARBGGTMvHH1gVYhMg63pZbkst6WTMdZbA4y5ktyWQFyBMEYAEmEURCQAJG2HRQdCoO/1g1WIBPUhMiAzK3YLdgntuJIHzFz9muhwRm7wWTgI6A4KEHgIdDmvIFV5qmEX1xUHf6wGWwGQyFkTkcnA2xCZB0agWJLt2C9vpVlSiJcMGoFGShpkicCIof1eUKrzVMIvrioO/1gGblzH1zUYz0yuoeB651QABgGTmwCOHHSKGEyl1WVKpKBZjZg1H4UA8cC2o/F5AqvNUwi+uKg7/WAAxyURK5I7CDzWRN6BdP7575aQxrKlUlAmOeD6H9Rhhwz0LryBVeaphF9cVB3+sPDURwFnzfk3IrfDZb4bLfDZZ2g5oS7DmqypVJQJ/EsDlqLsiuEckFOkAuze0TFmphF9cUc8OCRq1sCAdBA8V8wuvmF18wuvmF1ksRmjNrIzIkPBuZPNAEYGyBJOE2OSOI49l8wum5VDgSVl7R12jyKyvqHp/XNuP0UJjmYkzwADA6lNApTQKU0ClNApTQKU0ClNApTQKU0ClNApTQKU0CAsDYf/8QAJxEAAQICCgMBAQAAAAAAAAAAAQAR0fEQITFBUWFxobHwgZHB4TD/2gAIAQIBAT8QAJMEAaYLfc1PBBTwQU8EFPBBTwQU8EFPBBTwQU8EFPBBTwQU8EEcjnIxRDIGIQyrO5s+0BWAGZZSZFSZFSZFAxYepGh8LDNSZFFGCWRBoJADlEgSJzEaNcZqJrs80P1sJA0CeEIxZSxSxFhgOBRR3qNoXq2R6ZsKtQ7oAmwIaOxCdK0ivUVFbc8LqMRR0NF2eaCd0TWazFA4mCgWyAzqQ0SdgxPkqz0vXE4IQbF31BQYGv2HQ7wB5E1tzwuoxFHQ0XZ5oO22AfcFYkNa4K2CGlXCIOTlMTjG+weynQj1hguJwW3+lFxUN6P6jjGh/R/VsjwuoxFHQ0XZ5oMccWxZATUHJza2SrcTqMGViY0H2nicFs/pWSx5H4hnG9x7EVsjwuoxFHQ0XZ5o3jlH7O6xsXxClgipYIqWCKqkIqW5+TguJwWz+lHAAcgP6L8K2JBceEBAAkM7/P1A7GDmjoaIIvZY+njQUOi3ArvGC7xgusYLrGCCsDUsyeKGnALWvcAEQxyEQCGKCdmDcbvK7xgviQigDXlfxBdYLxiEJuBuNf6lrAdsREdQsAyoKubFTJFTJFTJFTJFTJFTJFTJFTJFTJFTJFTJFTJFHnSTnR//xAAkEAEAAQMEAgIDAQAAAAAAAAABEQAhMRBBUYFhoSBxMJHxsf/aAAgBAQABPxAvDyhiVLYAvNJ7hnAN3C8mTj8vnz58+fPnz58+fKctkm85Z5Cj5UduBYqUGRGhsipogkzZlcgm+lqVYS8wLq3lj1MqCQxuVYmiuZkSeACvWht3UyOOBKXQF7B5RsAGWgosTWlCIAKrY0YHfM5keB1fQ0DBPgQxORiQcAULChPSAnBIjfZK/jq/n6kgwAoGEk3GyUe9dkpQGETcssrR6KISwQ2FZyt8EYTYon6GmNqOqZEaLkx1TSu7GXkau+DBJ56GgmuFQBAK2wb0Gi4QAAlADAYND7Rcc+haSit9fMbzVZhtiiurHTxOlcwIXOYYjgOKRJDRLxW61mZB0Zfaj4rRJ56GhHw/gbACs3wbTNEntl+hZmfu1Q+6En7E9CoIEx4+gAo4HsgPF8P3FSOcg5JkphItLB5NF3talYIF7YDt/vzRjaqHY9+9GR+DEnnoaB/VgRJ1+1XuoKZAASIIAMzlNHPYwFDwu+yKFxWCL4bDo+C72tSoAM8q0Rkd69iV/et3wGJPPQ0AVC+OQH2VALyIviwDfMmYi0/BQbv25MCRwi2InfRd7GqYDYMDAnx6VM6aFCqgdmHNEQRAApKMhKCTEULN5LyMdqGrxgLwXMnZ+nROGk4SraSZUFElukB8DBh4kHcnG3o3HEs80g20tA0SmwTqpYMLE4EMW2o/4k4UYR2aHLyzhYSR5IJ4NEgtSnXdIiACDAyErpZAE8WZKDr/AEqKgE4iMnhFI2W9LL4JIH1fMdw/lYQIX4dIuVCg674kgSWwA+pyumSPjX0J+UGDBgwYMGDBgwYMiFYNegNP/9k="
}

Response

The response is in the application/json format.

Table 2. Response JSON Keys

Key	Typical Returned Values	Description
success	`true`, `false`	The value is `true` when the request is processed successfully. When there is an error, the value is `false` and additional information is available in the `error` key.

Example of Response

{
    "success": true
}

There may occur various errors (e.g. missing mandatory parameter). When Error code 13 (parameter data are too big) is returned, the request was not processed and it is necessary to send the request again with a smaller image or without an image.

Subsequently received duplicate valid requests are ignored (the last ten successful requests are held in the memory). It is possible to attempt at resending a request when there is no reply from a 2N device without the risk of a duplicate barrier opening or duplicate event logging.