Documentation for C-Werk 2.0.

Previous page Face search API  Forensic Search MomentQuest (VMDA) API Next page

The POST request (see Search request) used for search start must contain the following JSON:

{
   "plate": "mask"
}

The plate parameter sets a search mask. The mask format corresponds to the one used in GUI (see LPR search).

Attention!

If the body of POST request is empty, then the search will return all the results for the recognized license plates.

ParameterRequiredDescription
result_typeNo

result_type=full means detailed response

Sample request:

POST http://127.0.0.1:80/search/auto/SERVER1/AVDetector.2/EventSupplier/past/future?result_type=full or POST http://127.0.0.1:80/search/auto/SERVER1/AVDetector.2/EventSupplier/past/future

GET http://127.0.0.1:80/search/auto/2e69ba76-23f1-4d07-a812-fee86e994b8e/result

Sample response:

      {
         "origin": "hosts/SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0",
         "plates": [
            "A035AF95"
         ],
         "position": {
            "bottom": 0.86805555555555558,
            "left": 0.31805555555555554,
            "right": 0.49027777777777776,
            "top": 0.81944444444444442
         },
         "timestamp": "20190912T105500.925000"
}
ParameterDescription
originCamera channel to take analyzed video stream from
timestampTime stamp of a frame with a license plate detected by the detection tool
platesList of supposed hypotheses
positionCoordinates of the recognized LP frame

Detailed response:

{
   "events" : [
      {
         "Direction" : 0,
         "Hypotheses" : [
            {
               "OCRQuality" : 50,
               "PlateCountry" : "us",
               "PlateFull" : "A035AF95",
               "PlateRectangle" : [
                  0.40104166666666669,
                  0.52941176470588236,
                  0.45000000000000001,
                  0.55147058823529416
               ],
               "TimeBest" : "20180730T094220.010000"
            },
            {
               "OCRQuality" : 32,
               "PlateCountry" : "us",
               "PlateFull" : "*E733X*9",
               "PlateRectangle" : [
                  0.40104166666666669,
                  0.52941176470588236,
                  0.45000000000000001,
                  0.55147058823529416
               ],
               "TimeBest" : "20180730T094220.010000"
            },
            {
               "OCRQuality" : 38,
               "PlateCountry" : "us",
               "PlateFull" : "E733XA***",
               "PlateRectangle" : [
                  0.40104166666666669,
                  0.52941176470588236,
                  0.45000000000000001,
                  0.55147058823529416
               ],
               "TimeBest" : "20180730T094220.010000"
            }
         ],
         "TimeBegin" : "20180730T094219.610000",
         "TimeEnd" : "20180730T094220.050000",
         "detector_type" : "plateRecognized",
         "origin_id" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0",
         "phase" : 0,
         "timestamp" : "20180730T094220.010000",
         "ts_vector_body" : "E733XA97 EZERZER 7ONEZER 3TWOZER 3THRZER XFOUZER AFIVZER 9SIXZER 7SEVZER 8LENGTHZER *E733X*9 *ZERONE EONEONE 7TWOONE 3THRONE 3FOUONE XFIVONE *SIXONE 9SEVONE 8LENGTHONE E733XA*** EZERTWO 7ONETWO 3TWOTWO 3THRTWO XFOUTWO AFIVTWO *SIXTWO *SEVTWO *EIGTWO 9LENGTHTWO"
      },

Sample request to receive events via Web-Socket:

ws://root:root@localhost/events?schema=proto

ParameterDescription
schemaschema=proto means detailed response

Sample detailed response:

{
    "objects": [
        {
            "body": {
                "@type": "type.googleapis.com/Grundig.bl.events.DetectorEvent",
                "details": [
                    {
                        "autoRecognitionResultEx": {
                            "direction": {
                                "value": "Outgoing"
                            },
                            "headlightsStatus": {
                                "value": "Disabled"
                            },
                            "hypotheses": [
                                {
                                    "country": "Denmark",
                                    "ocrQuality": 99,
                                    "plateFull": "CJ97139",
                                    "plateRectangle": {
                                        "h": 0.03703703703703709,
                                        "w": 0.067708333333333315,
                                        "x": 0.31302083333333336,
                                        "y": 0.96296296296296291
                                    },
                                    "plateState": "NA",
                                    "timeBest": "20230623T124816.295000"
                                }
                            ],
                            "plateType": {
                                "value": "EUnitedNations"
                            },
                            "timeBegin": "2023-06-23T12:48:16.295Z",
                            "timeEnd": "2023-06-23T12:48:16.295Z",
                            "vehicleBrand": {
                                "value": "Mercedes Benz"
                            },
                            "vehicleClass": {
                                "value": "Car"
                            },
                            "vehicleColor": {
                                "value": "Gray"
                            },
                            "vehicleModel": {
                                "value": "GLS Klasse"
                            }
                        }
                    },
                    {
                        "autoRecognitionResult": {
                            "direction": "Outgoing",
                            "headlightsStatus": "Disabled",
                            "hypotheses": [
                                {
                                    "country": "Denmark",
                                    "ocrQuality": 99,
                                    "plateFull": "CJ97139",
                                    "plateRectangle": {
                                        "h": 0.03703703703703709,
                                        "w": 0.067708333333333315,
                                        "x": 0.31302083333333336,
                                        "y": 0.96296296296296291
                                    },
                                    "plateState": "NA",
                                    "timeBest": "20230623T124816.295000"
                                }
                            ],
                            "plateType": "EUnitedNations",
                            "timeBegin": "20230623T124816.295000",
                            "timeEnd": "20230623T124816.295000",
                            "vehicleBrand": "Mercedes Benz",
                            "vehicleClass": "Car",
                            "vehicleColor": "Gray",
                            "vehicleModel": "GLS Klasse"
                        }
                    }
                ],
                "detectorDeprecated": "hosts/TEST/AVDetector.1/EventSupplier",
                "detectorExt": {
                    "accessPoint": "hosts/TEST/AVDetector.1/EventSupplier",
                    "friendlyName": "1.\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u0432\u0430\u043d\u0438\u0435 \u043d\u043e\u043c\u0435\u0440\u043e\u0432 \u0430\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u0435\u0439 (RR)"
                },
                "detectorsGroup": [
                    "DG_LPR_DETECTOR"
                ],
                "eventType": "plateRecognized",
                "guid": "d6650759-e89b-43dd-a610-459a6e421ccc",
                "nodeInfo": {
                    "friendlyName": "TEST",
                    "name": "TEST"
                },
                "originDeprecated": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                "originExt": {
                    "accessPoint": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                    "friendlyName": "1.\u041a\u0430\u043c\u0435\u0440\u0430"
                },
                "timestamp": "20230623T124816.295000"
            },
            "eventName": "Grundig.bl.events.DetectorEvent",
            "eventType": "ET_DetectorEvent",
            "localization": {
                "text": "\u041a\u0430\u043c\u0435\u0440\u0430 \"1.\u041a\u0430\u043c\u0435\u0440\u0430\". \u0421\u0440\u0430\u0431\u0430\u0442\u044b\u0432\u0430\u043d\u0438\u0435 \u0434\u0435\u0442\u0435\u043a\u0442\u043e\u0440\u0430 \"1.\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u0432\u0430\u043d\u0438\u0435 \u043d\u043e\u043c\u0435\u0440\u043e\u0432 \u0430\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u0435\u0439 (RR)\", \u041d\u043e\u043c\u0435\u0440 \"CJ97139\", \u0441\u0442\u0440\u0430\u043d\u0430 \"Denmark\", \u043a\u043b\u0430\u0441\u0441 \"\u0410\u0432\u0442\u043e\u043c\u043e\u0431\u0438\u043b\u044c\", \u0446\u0432\u0435\u0442 \"Gray\", \u043f\u0440\u043e\u0438\u0437\u0432\u043e\u0434\u0438\u0442\u0435\u043b\u044c \"Mercedes Benz\", \u043c\u043e\u0434\u0435\u043b\u044c \"GLS Klasse\", \u0441\u043e\u0441\u0442\u043e\u044f\u043d\u0438\u0435 \u0444\u0430\u0440 \"\u0412\u044b\u043a\u043b\u044e\u0447\u0435\u043d\u044b\" \u0420\u0430\u0441\u0448\u0438\u0440\u0435\u043d\u043d\u0430\u044f \u0438\u043d\u0444\u043e\u0440\u043c\u0430\u0446\u0438\u044f: \u0422\u0438\u043f \u0434\u0435\u0442\u0435\u043a\u0442\u043e\u0440\u0430 = \"\u0420\u0430\u0441\u043f\u043e\u0437\u043d\u0430\u043d\u043d\u044b\u0439 \u043d\u043e\u043c\u0435\u0440\""
            },
            "requiredPermissions": {
                "requiredObjectPermissions": [
                    {
                        "accessPoint": "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                        "cameraAccess": "CAMERA_ACCESS_ONLY_ARCHIVE"
                    }
                ]
            },
            "subjects": [
                "hosts/TEST/DeviceIpint.1/SourceEndpoint.video:0:0",
                "hosts/TEST/AVDetector.1/EventSupplier"
            ]
        }
    ]
}
ParameterDescription
vehicleBrandVehicle manufacturer
vehicleClassVehicle class
vehicleColorVehicle color
vehicleModelVehicle model
  • No labels