Isapi - Anpr
Isapi - Anpr
Developer Guide
Intelligent Security API (ANPR) Developer Guide
Legal Information
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE DOCUMENT IS PROVIDED "AS IS"
AND “WITH ALL FAULTS AND ERRORS”. OUR COMPANY MAKES NO REPRESENTATIONS OR
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. IN NO EVENT
WILL OUR COMPANY BE LIABLE FOR ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL, OR INDIRECT
DAMAGES, INCLUDING, AMONG OTHERS, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
INTERRUPTION OR LOSS OF DATA, CORRUPTION OF SYSTEMS, OR LOSS OF DOCUMENTATION,
WHETHER BASED ON BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, IN
CONNECTION WITH THE USE OF THE DOCUMENT, EVEN IF OUR COMPANY HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES OR LOSS.
i
Intelligent Security API (ANPR) Developer Guide
Contents
Chapter 1 Overview .................................................................................................................... 1
1.1 Introduction ........................................................................................................................... 1
1.2 Update History ....................................................................................................................... 1
Chapter 2 Configure ANPR Alarm ................................................................................................ 3
Chapter 3 Configure Blacklist and Whitelist ANPR Alarm ............................................................ 7
Chapter 4 Control Barrier Gate Status ....................................................................................... 11
Chapter 5 Alarm or Event Receiving .......................................................................................... 12
5.1 Receive Alarm/Event in Arming Mode ................................................................................. 12
5.2 Receive ANPR Alarm in Listening Mode ............................................................................... 14
Appendix A. Request URIs ........................................................................................................ 17
A.1 /ISAPI/Event/schedules/blackList ........................................................................................ 17
A.2 /ISAPI/Event/schedules/blackList/<ID> ............................................................................... 17
A.3 /ISAPI/Event/schedules/vehicledetects ............................................................................... 18
A.4 /ISAPI/Event/schedules/vehicledetects/<ID> ...................................................................... 19
A.5 /ISAPI/Event/schedules/whiteList ....................................................................................... 19
A.6 /ISAPI/Event/schedules/whiteList/<ID> .............................................................................. 20
A.7 /ISAPI/Event/triggers/<eventType>-<ID> ............................................................................ 21
A.8 /ISAPI/Event/triggersCap ..................................................................................................... 21
A.9 /ISAPI/ITC/capability ............................................................................................................ 22
A.10 /ISAPI/ITC/Entrance/barrierGateCtrl ................................................................................. 22
A.11 /ISAPI/ITC/Entrance/capabilities ....................................................................................... 23
A.12 /ISAPI/ITC/PlateRecognitionParam .................................................................................... 23
A.13 /ISAPI/ITC/plateRecognitionParam/capabilities ................................................................ 24
A.14 /ISAPI/Traffic/ANPR/alarmHttpPushProtocol .................................................................... 24
A.15 /ISAPI/Traffic/channels/<ID>/capabilities .......................................................................... 25
A.16 /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode ...................................................... 25
ii
Intelligent Security API (ANPR) Developer Guide
iii
Intelligent Security API (ANPR) Developer Guide
iv
Intelligent Security API (ANPR) Developer Guide
Chapter 1 Overview
1.1 Introduction
ANPR (Automatic Number Plate Recognition) function integrated by Intelligent Security API
(hereafter referred as to "ISAPI) helps to analyze the captured traffic capture and recognize the
vehicle license plate, and supports importing the list for comparison to trigger vehicle matched
(blacklist) or mismatched (whitelist) alarms.
1
Intelligent Security API (ANPR) Developer Guide
2
Intelligent Security API (ANPR) Developer Guide
3
Intelligent Security API (ANPR) Developer Guide
Steps
4
Intelligent Security API (ANPR) Developer Guide
Note
Before setting OSD parameters, you'd better call the corresponding URI by GET method to get
the configured or existing parameters for reference.
8. Perform one of the following operations to set arming schedule of ANPR alarm.
- Call /ISAPI/Event/schedules/vehicledetects by PUT method to set arming schedule of all
channels.
- Call /ISAPI/Event/schedules/vehicledetects/<ID> by PUT method to set arming schedule by
channel.
Note
Before setting arming schedule, you'd better call the corresponding URI by GET method to get
the default or configured parameters for reference.
9. Perform one of the following operations to set ANPR alarm linkage.
- Call /ISAPI/Traffic/channels/<ID>/eventTrigger by PUT method.
- Call /ISAPI/Event/triggers/<eventType>-<ID> by PUT method and set the <ID> in the URI to
"vehicledetection-<channelID>" (e.g., /ISAPI/Event/triggers/vehicledetection-101).
Note
If you want to receive the alarm in the platform, the linkage action must be set as "center"
(upload to center).
10. Optional: Call /ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json by PUT
method to filter the duplicated license plates and receive the same alarm just for once.
5
Intelligent Security API (ANPR) Developer Guide
Note
To check whether the device supports filtering duplicated license plates, you can call /ISAPI/
Traffic/channels/<ID>/capabilities by GET method to get the traffic channel capability
( XML_TrafficChannelCap ). If it supports, the node <isSupportFiltration> will be returned in
the capability message and its value is "true".
11. Optional: Set eventType to "ANPR" and receive ANPR alarm in arming mode (see Receive
Alarm/Event in Arming Mode ) or listening mode (see Receive ANPR Alarm in Listening
Mode ).
Note
Currently, for traffic camera or capture camera, receiving alarm or event in arming mode is not
supported.
The ANPR alarm details are returned in the message XML_EventNotificationAlert_ANPRMsg .
6
Intelligent Security API (ANPR) Developer Guide
7
Intelligent Security API (ANPR) Developer Guide
Steps
Figure 3-1 Programming Flow of Configuring Blacklist and Whitelist ANPR Alarm
1. Call /ISAPI/ITC/capability by GET method to check whether the device supports ANPR.
8
Intelligent Security API (ANPR) Developer Guide
Note
Before setting OSD parameters, you'd better call the corresponding URL by GET method to get
the default or configured parameters for reference.
8. Optional: Call /ISAPI/Traffic/channels/<ID>/searchLPListAudit by POST method to search for
default or configured blacklist or whitelist.
9. Optional: Call /ISAPI/Traffic/plateList by GET method to export the default or configured
license plate blacklist or whitelist.
10. Call /ISAPI/Traffic/channels/<ID>/licensePlateAuditData by GET method to export the
template of license plate list.
11. Import the blacklist or whitelist to be compared.
- Call /ISAPI/Traffic/channels/<ID>/licensePlateAuditData by PUT method to fill in the
template and import the blacklist or whitelist.
- Call /ISAPI/Traffic/plateList by PUT to import the blacklist or whitelist.
12. Perform one of the following operations to set the arming schedule.
- Set the arming schedule of all channels.
• Call /ISAPI/Event/schedules/vehicledetects by PUT method to set the arming schedule for
blacklist and whitelist ANPR alarm.
• Call /ISAPI/Event/schedules/blackList by PUT method to set the arming schedule for
blacklist ANPR alarm.
• Call /ISAPI/Event/schedules/whiteList by PUT method to set the arming schedule for
whitelist ANPR alarm.
- Set the arming schedule of a specific channel.
9
Intelligent Security API (ANPR) Developer Guide
Note
You can also call /ISAPI/Traffic/channels/<ID>/eventTrigger by PUT method to set the
linkage action of blacklist and whitelist ANPR alarm.
- Call /ISAPI/Event/triggers/<eventType>-<ID> by PUT method and set the <ID> in the URI to
"blacklist-<channelID>" (e.g., /ISAPI/Event/Trigger/blacklist-101) for setting the linkage
action of blacklist ANPR alarm.
- Call /ISAPI/Event/triggers/<eventType>-<ID> by PUT method and set the <ID> in the URI to
"whitelist-<channelID>" (e.g., /ISAPI/Event/Trigger/whitelist-101) for setting the linkage
action of whitelist ANPR alarm.
Note
If you want to receive the alarm in the platform, the linkage action must be set as "center"
(upload to center).
15. Optional: Set eventType to "ANPR" and receive blacklist and whitelist ANPR alarm in arming
mode (see Receive Alarm/Event in Arming Mode ) or listening mode (see Receive ANPR Alarm
in Listening Mode ).
Note
Currently, for traffic camera or capture camera, receiving alarm or event in arming mode is not
supported.
The details of blacklist and whitelist ANPR alarm is returned in the message
XML_EventNotificationAlert_ANPRMsg .
10
Intelligent Security API (ANPR) Developer Guide
11
Intelligent Security API (ANPR) Developer Guide
Note
Currently, for traffic camera or capture camera, receiving alarm or event in arming mode is not
supported.
12
Intelligent Security API (ANPR) Developer Guide
Steps
13
Intelligent Security API (ANPR) Developer Guide
realm="IP Camera(C2183)",
nonce="4e5468694e7a42694e7a4d364f4449354d7a6b354d54513d",
uri="/ISAPI/Event/notification/alertStream",
cnonce="3d183a245b8729121ae4ca3d41b90f18",
nc=00000001,
qop="auth",
response="f2e0728991bb031f83df557a8f185178"
Host: 10.6.165.192
HTTP/1.1 200 OK
MIME-Version: 1.0
Connection: close
Content-Type: multipart/mixed; boundary=<frontier>
--<frontier>
Content-Type: application/xml; charset="UTF-8"
Content-Length: text_length
<EventNotificationAlert/>
--<frontier>
Note
Some alarm data is in JSON format, so the Content-Type may be "application/xml" or "application/
json".
14
Intelligent Security API (ANPR) Developer Guide
Steps
Figure 5-2 API Calling Flow of Receiving ANPR Alarm in Listening Mode
1. Call /ISAPI/Event/notification/httpHosts/capabilities by GET method to get the capability of
HTTP listening server.
The HTTP listening server capability is returned in the message XML_HttpHostNotificationCap .
2. Check whether the node <ANPR> is returned in the listening server capability.
- If the node <ANPR> is returned in the capability, you can continue to perform the following
steps.
- If the capability does not contain node <ANPR>, it indicates that receiving ANPR alarm in
listening mode is not supported, please end this task.
3. Check whether the value of sub node <alarmHttpPushProtocol> of node <ANPR> in the
listening server capability message is "custom".
- If the value of node <alarmHttpPushProtocol> is "custom", perform step 4.
- If the value of node <alarmHttpPushProtocol> is not "custom", please directly perform step
6.
4. Optional: Call /ISAPI/Traffic/ANPR/alarmHttpPushProtocol by GET method to get the current
alarm receiving protocol for reference.
15
Intelligent Security API (ANPR) Developer Guide
Note
Before setting the listening server, you'd better call this URL by GET method to get default or
configured parameters for reference.
7. Call /ISAPI/Event/notification/httpHosts/<ID>/test by POST method to check whether the
listening server is working normally.
8. Call http://<ipAddress>:<portNo>/<url> by POST method to receive the ANPR alarm
information from the listening server.
16
Intelligent Security API (ANPR) Developer Guide
A.1 /ISAPI/Event/schedules/blackList
Get or set arming schedule of blacklist ANPR of all channels.
A.2 /ISAPI/Event/schedules/blackList/<ID>
Get or set arming schedule of blacklist ANPR by channel.
17
Intelligent Security API (ANPR) Developer Guide
Failed: XML_ResponseStatus
Table A-4 PUT /ISAPI/Event/schedules/blackList/<ID>
Method PUT
Description Set arming schedule of blacklist ANPR by channel.
Query None
Request XML_Schedule
Response XML_ResponseStatus
Remarks
The <ID> in the request URI consists of alarm category string (e.g., blacklist) and alarm triggered
channel ID (e.g., 101). For example, "blacklist-101".
A.3 /ISAPI/Event/schedules/vehicledetects
Get or set ANPR arming schedules of all channels.
18
Intelligent Security API (ANPR) Developer Guide
A.4 /ISAPI/Event/schedules/vehicledetects/<ID>
Get or set the arming schedule of blacklist and whitelist ANPR by channel.
Remarks
The <ID> in the request URI consists of alarm category string (e.g., vehicledetection) and alarm
triggered channel ID (e.g., 101). For example, "vehicledetection-101".
A.5 /ISAPI/Event/schedules/whiteList
Get or set arming schedule of whitelist ANPR of all channels.
19
Intelligent Security API (ANPR) Developer Guide
Request None
Response Succeeded: XML_WhiteListScheduleList
Failed: XML_ResponseStatus
Table A-10 PUT /ISAPI/Event/schedules/whiteList
Method PUT
Description Set arming schedule of whitelist ANPR of all channels.
Query None
Request XML_WhiteListScheduleList
Response XML_ResponseStatus
A.6 /ISAPI/Event/schedules/whiteList/<ID>
Get or set arming schedule of whitelist ANPR by channel.
Remarks
The <ID> in the request URI consists of alarm category string (e.g.,whitelist) and alarm triggered
channel ID (e.g., 101). For example, "whitelist-101".
20
Intelligent Security API (ANPR) Developer Guide
A.7 /ISAPI/Event/triggers/<eventType>-<ID>
Get, set, or delete the alarm linkage action by channel.
Remarks
The <eventType> in the request URI refers to the predefined event or alarm type name, and the
<ID> is the No. of the event detection channel. For example, if the No. of the face capture channel
is 101, the "<eventType>-<ID>" is "faceSnap-101".
A.8 /ISAPI/Event/triggersCap
Get alarm linkage capability.
21
Intelligent Security API (ANPR) Developer Guide
A.9 /ISAPI/ITC/capability
Get intelligent traffic capability.
A.10 /ISAPI/ITC/Entrance/barrierGateCtrl
Set parameters to control the barrier gate.
22
Intelligent Security API (ANPR) Developer Guide
Request XML_BarrierGateCtrl
Response XML_ResponseStatus
A.11 /ISAPI/ITC/Entrance/capabilities
Get entrance and exit capability.
A.12 /ISAPI/ITC/PlateRecognitionParam
Get or set ANPR parameters.
23
Intelligent Security API (ANPR) Developer Guide
Request XML_PlateRecognitionParam
Response XML_ResponseStatus
A.13 /ISAPI/ITC/plateRecognitionParam/capabilities
Get ANPR configuration capability.
A.14 /ISAPI/Traffic/ANPR/alarmHttpPushProtocol
Get or set alarm receiving protocol.
24
Intelligent Security API (ANPR) Developer Guide
Request XML_AlarmHttpPushProtocol
Response XML_ResponseStatus
A.15 /ISAPI/Traffic/channels/<ID>/capabilities
Get traffic channel capability.
Remarks
The <ID> in the request URI refers to the traffic channel ID.
A.16 /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode
Get or set ANPR mode parameters.
25
Intelligent Security API (ANPR) Developer Guide
Remarks
The <ID> in the request URI refers to the video channel ID.
A.17 /ISAPI/Traffic/channels/<ID>/eventTrigger
Get or set ANPR alarm linkage action by channel.
Remarks
The <ID> in the request URI refers to the video channel ID.
26
Intelligent Security API (ANPR) Developer Guide
A.18 /ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json
Get or set the parameters of filtering duplicated license plate.
Remarks
The <ID> in the request URI refers to channel ID.
A.19 /ISAPI/Traffic/channels/<ID>/licensePlateAuditData
Export license plate list template (XML or EXCEL file) and import list.
27
Intelligent Security API (ANPR) Developer Guide
"excel" or the URI does not contain this query parameter, it will
export an EXCEL file.
Request None.
Response Opaque data (binary data, in the EXCEL format)
Table A-33 PUT /ISAPI/Traffic/channels/<ID>/licensePlateAuditData
Method PUT
Description Import license plate list.
Query fileType: determine the format of exported file, if the value is "xml"
(i.e., /ISAPI/Traffic/channels/<ID>/licensePlateAuditData?
fileType=xml), the exported file is in XML format, if the value is
"excel" or the URI does not contain this query parameter, it will
export an EXCEL file.
Request Opaque data (binary data, in the EXCEL format)
Response XML_ResponseStatus
Remarks
The <ID> in the URI refers to the video channel ID.
A.20 /ISAPI/Traffic/channels/<ID>/picParam
Get or set the parameters of captured vehicle pictures by channel.
28
Intelligent Security API (ANPR) Developer Guide
Request XML_PicParam
Response XML_ResponseStatus
Remarks
The <ID> in the request URI refers to the video channel ID.
A.21 /ISAPI/Traffic/channels/<ID>/picParam/capabilities
Get captured picture configuration capability.
Remarks
The <ID> in the request URI refers to the channel ID.
A.22 /ISAPI/Traffic/channels/<ID>/searchLPListAudit
Search for license plate list by channel.
29
Intelligent Security API (ANPR) Developer Guide
Remarks
The <ID> in the request URI refers to the channel ID.
A.23 /ISAPI/Traffic/channels/<ID>/vehicleDetect
Get or set vehicle detection parameters.
Remarks
The <ID> in the request URI refers to the channel ID.
A.24 /ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities
Get the vehicle detection configuration capability.
30
Intelligent Security API (ANPR) Developer Guide
Query None
Request None
Response Succeeded: XML_Cap_VehicleDetectCfg
Failed: XML_ResponseStatus
A.25 /ISAPI/Traffic/MNPR/channels/<ID>
Get the manual license plate recognition result by channel.
Remarks
The <ID> in the request URI refers to the channel ID.
Example
Returned Picture Data in Form Format
GET /ISAPI/Traffic/MNPR/channels/<ID>
HTTP/1.1 200 OK
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary=boundary
Content-Length: 9907
--boundary
Content-Disposition: form-data; name="anpr.xml";filename="anpr.xml";
Content-Type: text/xml
Content-Length: 150
<EventNotificationAlert/>
--boundary
Content-Disposition: form-data; name="licensePlatePicture.jpg";filename="licensePlatePicture.jpg";
Content-Type: image/pjpeg
Content-Length: 200
31
Intelligent Security API (ANPR) Developer Guide
......JFIF.....`.`.....C........... .
..
................. $.' ",#..(7),01444.'9=82<.342...C. ....
.2!.!22222222222222222222222222222222222222222222222222...
.....................}........!1A..Qa."q.2....#B...R..$3br.
.....%&'()*456789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz..............
.....................w.......!1..AQ.aq."2...B.... #3R..br.
.$4.
--boundary
Content-Disposition: form-data; name="detectionPicture.jpg";filename="detectionPicture.jpg";
Content-Type: image/pjpeg
Content-Length: 9907
......JFIF.....`.`.....C........... .
..
................. $.' ",#..(7),01444.'9=82<.342...C. ....
.2!.!22222222222222222222222222222222222222222222222222...
.....................}........!1A..Qa."q.2....#B...R..$3br.
.....%&'()*456789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz..............
.....................w.......!1..AQ.aq."2...B.... #3R..br.
.$4.
--boundary--
A.26 /ISAPI/Traffic/plateList
Import and export vehicle blacklist and whitelist.
32
Intelligent Security API (ANPR) Developer Guide
A.27 /ISAPI/Event/notification/alertStream
Get the uploaded heartbeat or alarm/event information.
Note
The messages here only show the format of alarm/event
information to be uploaded. For details, refer to the corresponding
alarm/event configuration chapters.
Remarks
• After calling this URI, a persistent connection is set up between the device and the platform, and
the alarm or event information will be uploaded from device continuously once the alarm is
triggered or event occurred.
• You can check if the XML response message is the heartbeat information according to the nodes
<eventType> and <eventState>. If the values of these two node are "videoloss" and "inactive",
respectively, the returned message is the heartbeat information.
A.28 /ISAPI/Event/notification/httpHosts
Get or set parameters of all HTTP listening servers, add a HTTP listening server, and delete all HTTP
listening servers.
33
Intelligent Security API (ANPR) Developer Guide
34
Intelligent Security API (ANPR) Developer Guide
Request XML_HttpHostNotification
Response XML_ResponseStatus
Table A-48 DELETE /ISAPI/Event/notification/httpHosts
Method DELETE
Description Delete all HTTP listening servers.
Query None
Request None
Response XML_ResponseStatus
A.29 /ISAPI/Event/notification/httpHosts/<ID>
Get or set the parameters of a HTTP listening server, and delete a HTTP listening server.
35
Intelligent Security API (ANPR) Developer Guide
Remarks
The <ID> in the request URI refers to the HTTP listening server No.
A.30 /ISAPI/Event/notification/httpHosts/<ID>/test
Check whether the HTTP listening server is working normally.
Remarks
The <ID> in the request URI refers to the HTTP listening server ID.
36
Intelligent Security API (ANPR) Developer Guide
A.31 /ISAPI/Event/notification/httpHosts/capabilities
Get the configuration capabilities of all HTTP listening servers.
A.32 http://<ipAddress>:<portNo>/<url>
HTTP listening sever sends alarm information to alarm center.
Remarks
• The <ipAddress> in the request URL refers to the IP address or domain name of HTTP listening
server, the <portNo> is the port No. of HTTP listening server, and the <url> represents the
streaming URL, which is configured via the HTTP listening server.
• The default port No. is 80, so the request URL without port No. is also valid.
37
Intelligent Security API (ANPR) Developer Guide
B.1 JSON_Filtration
Message about license plate filtration in JSON format
{
"Filtration": {
"enabled":
/*optional, boolean, whether to enable filtering duplicated license plate, by default, it is "false"*/
}
}
B.2 JSON_ResponseStatus
JSON message about response status
{
"requestURL":"",
/*optional, string, request URL*/
"statusCode": ,
/*required, int, status code*/
"statusString":"",
/*required, string, status description*/
"subStatusCode":"",
/*required, string, sub status code*/
"errorCode": ,
/*optional, int, error code, which corresponds to subStatusCode, this field is required when statusCode is not 1. The
returned value is the transformed decimal number*/
"errorMsg":"",
/*optional, string, error details, this field is required when statusCode is not 1*/
}
Note
See Response Codes of Text Protocol for details about the status codes, sub status codes, error
codes, and error descriptions.
B.3 XML_AlarmHttpPushProtocol
XML message about alarm receiving protocol
<AlarmHttpPushProtocol version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<baseLineProtocolEnabled>
<!--required, xs:boolean, value: true, false-->
38
Intelligent Security API (ANPR) Developer Guide
</baseLineProtocolEnabled>
</AlarmHttpPushProtocol>
B.4 XML_BarrierGateCtrl
XML message about the control parameters of barrier gate
<BarrierGateCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<barrietGateNum>
<!--opt, xs:integer, barrier gate No., which is between 1 and 2-->
</barrietGateNum>
<BarrierGateCtrlList>
<barrietGateOper>
<!--opt, xs:string, barrier gate control types: "off"-fall, "on"-rise, "stop"-stop at a certain position, "locked"-lock-->
</barrietGateOper>
</BarrierGateCtrlList>
</BarrierGateCtrl>
B.5 XML_BlackListScheduleList
BlackListScheduleList message in XML format
<BlackListScheduleList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Schedule/><!--opt, see details in the message of XML_Schedule-->
</BlackListScheduleList>
See Also
XML_Schedule
B.6 XML_Cap_CapturePicOverlays
CapturePicOverlays capability message in XML format
<CapturePicOverlays version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<overlayInfoEnabled>
<!--req, xs:boolean, whether to enable text overlay-->
</overlayInfoEnabled>
<OverlayInfoList size="50"><!--req-->
<OverlayInfo><!--req-->
<itemType opt="0,1,2,3,…">
<!--req, xs:string, overlayed information type: 0-unknown, 1-place, 2-intersection No., 3-device No., 4-direction
No., 5-direction, 6-lane No., 7-lane, 8-capture time (without millisecond), 9-capture time (with millisecond), 10-license
plate number, 11-vehicle color, 12-vehicle type, 13-vehicle brand, 14-vehicle speed, 15-speed limit sign, 16-vehicle
length (between 1 and 99 meters), 17-violation code (traffic violation information is more useful than code, e.g.,
normal, low speed, overspeed, reverse driving, running the red light, occupying lane, driving over yellow lane line,
etc.), 18-camera information, 19-traffic violation, 20-overspeed ratio, 21-red light start time, 22-red light end time, 23-
39
Intelligent Security API (ANPR) Developer Guide
red light time, 24-security code, 25-capture No., 26-seatbelt, 27-reserved, 28-sun visor, 29-lane direction, 30-license
plate color, 31-scene No., 32-scene name, 33-yellow label vehicle detection, 34-dangerous goods transport vehicle
detection, 35-vehicle sub-brand detection, 36-vehicle direction, 37-window hangings, 38-making a call, 39-confidence,
40-verification unit, 41-verification certificate No., 42-calibration expiration date, 43-longitude and latitude, 44-tissue
box detection, 45-baby in arm detection, 46-label detection, 47-decoration detection, 48-face score, 49-face No., 50-
violation description, 51-marked speed limit, 52-segment speed, 53-segment distance, 54-segment overspeed ratio,
55-segment name, 56-segment ID, 57-traffic accident detection, 58-smoking, 59-wearing helmet, 60-manned, 61-
congestion-->
</itemType>
<editAble opt="true,false">
<!--req, xs:boolean, whether the overlayed information is editable-->
</editAble>
<itemOverlayEnabled opt="true,false">
<!--req, xs:boolean, whether to overlay the item-->
</itemOverlayEnabled>
<customName min="0" max="32">
<!--req, xs:string, custom overlaying name, the maximum length is 32 bytes (including '\0'). If this node is set to
none or NULL, the default name will be overlayed-->
</customName>
<changeLineNum min="0" max="100">
<!--req, xs:integer, number of line feeds, which is between 0 and 100 and the default value is 0-->
</changeLineNum>
<spaceNum min="0" max="255">
<!--req, xs:integer, number of spaces, which is between 0 and 255 and the default value is 0-->
</spaceNum>
<startPosEnable opt="true,false">
<!--dep, xs:boolean, whether to enable coordinate configuration, which is only valid for overlaying within the
picture. After enabling coordinate configuration, the function of line feed and space will be invalid, so you are
recommended to disable coordinate configuration-->
</startPosEnable>
<startPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture height, and the default value is 0-->
</startPosTop>
<startPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture width, and the default value is 0-->
</startPosLeft>
<overlayInfoText>
<!--dep, xs:string, overlay character string, which is valid when <itemType> is set to place, intersection No., device
No., direction No., direction description, lane information and camera. The maximum string length of place is 128
bytes, the maximum string length of intersection No., device No., direction No., direction description and lane
information is 32 bytes., the maximum string length of camera 1 is 44 bytes, and the maximum string length of
verification unit, verification certificate No., calibration expiration date is 128 bytes-->
</overlayInfoText>
<overlayInfoText2>
<!--dep, xs:string, overlay character string for camera 2, which is valid when <itemType> is set to camera, and the
maximum string length of camera 2 is 32 bytes-->
</overlayInfoText2>
</OverlayInfo>
</OverlayInfoList>
<linePercent min="0" max="100">
40
Intelligent Security API (ANPR) Developer Guide
<!--req, xs:integer, percentage of overlaying lines, which is between 0 and 100 and the default value is 100-->
</linePercent>
<itemsStlye opt="horizontal,vertical">
<!--req, xs:string, overlay mode: "horizontal" (default), "vertical"-->
</itemsStlye>
<charStyle>
<!--req, xs:string, font type-->
</charStyle>
<charSize min="0" max="3">
<!--req, xs:integer, character size: 0-16*16(Chinese)/8*16(English), 1-32*32(Chinese)/16*32(English), 2-48*48,
3-64*64(Chinese)/32*64(English)-->
</charSize>
<charPosition min="0" max="2">
<!--req, xs:integer, text position overlayed on the picture: 0-overlayed on the picture, 1-overlayed outside the top
edge of the picture, 2-overlayed outside the bottom edge of the picture-->
</charPosition>
<charInterval min="0" max="16">
<!--req, xs:integer, character separation distance, which is between 0 and 16 and the default value is 0, unit: pixel-->
</charInterval>
<foreColor min="0" max=" 0xffffff">
<!--req, xs:integer, foreground color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0xffffff (white)-->
</foreColor>
<backColor min="0" max=" 0xffffff">
<!--req, xs:integer, background color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0x0 (black)-->
</backColor>
<colorAdapt>
<!--dep, xs:boolean, whether to enable color self-adaption: 0-no, 1-yes-->
</colorAdapt>
<zeroizeEnable opt="true,false">
<!--dep, xs:boolean, whether to enable zero filling for OSD overlay, which is used to enable zero filling for vehicle
speed, speed limit, overspeed ratio and lane No. Zero filling is enabled by default-->
</zeroizeEnable>
<platePicOverlay>
<!--dep, xs:boolean, whether to enable overlaying license plate thumbnail-->
</platePicOverlay>
<platePicPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture height, and the default value is 0-->
</platePicPosTop>
<platePicPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture width, and the default value is 0-->
</platePicPosLeft>
<posPercentMode opt="true,false">
<!--opt, xs:boolean, whether to enable percentage mode instead of pixel value mode: "true"-yes, "false"-no-->
</posPercentMode>
<startPosTopPercent min="0" max="100">
<!--dep, xs:integer, this node is valid when <posPercentMode> is "true"-->
</startPosTopPercent>
<startPosLeftPercent min="0" max="100">
41
Intelligent Security API (ANPR) Developer Guide
B.7 XML_Cap_MergePicOverlays
MergePicOverlays capability message in XML format
<MergePicOverlays version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<overlayInfoEnabled>
<!--req, xs:boolean, whether to enable text overlay-->
</overlayInfoEnabled>
<OverlayInfoList size="50">
<!--req-->
<OverlayInfo>
<!--req-->
<itemType opt="0,1,2,3,…">
<!--req, xs:string, overlayed information type: 0-unknown, 1-place, 2-intersection No., 3-device No., 4-direction
No., 5-direction, 6-lane No., 7-lane, 8-capture time (without millisecond), 9-capture time (with millisecond), 10-license
plate number, 11-vehicle color, 12-vehicle type, 13-vehicle brand, 14-vehicle speed, 15-speed limit sign, 16-vehicle
length (between 1 and 99 meters), 17-violation code (traffic violation information is more useful than code, e.g.,
normal, low speed, overspeed, reverse driving, running the red light, occupying lane, driving over yellow lane line,
etc.), 18-camera information, 19-traffic violation, 20-overspeed ratio, 21-red light start time, 22-red light end time, 23-
red light time, 24-security code, 25-capture No., 26-seatbelt, 27-reserved, 28-sun visor, 29-lane direction, 30-license
plate color, 31-scene No., 32-scene name, 33-yellow label vehicle detection, 34-dangerous goods transport vehicle
detection, 35-vehicle sub-brand detection, 36-vehicle direction, 37-window hangings, 38-making a call, 39-confidence,
40-verification unit, 41-verification certificate No., 42-calibration expiration date, 43-longitude and latitude, 44-tissue
box detection, 45-baby in arm detection, 46-label detection, 47-decoration detection, 48-face score, 49-face No., 50-
violation description, 51-marked speed limit, 52-segment speed, 53-segment distance, 54-segment overspeed ratio,
55-segment name, 56-segment ID, 57-traffic accident detection, 58-smoking, 59-wearing helmet, 60-manned, 61-
congestion-->
</itemType>
<editAble opt="true,false">
<!--req, xs:boolean, whether the overlayed information is editable-->
</editAble>
<itemOverlayEnabled opt="true,false">
<!--req, xs:boolean, whether to overlay the item-->
</itemOverlayEnabled>
<customName min="0" max="32">
<!--req, xs:string, custom overlaying name, the maximum length is 32 bytes (including ’\0’). If this node is set to
none or NULL, the default name will be overlayed-->
</customName>
<changeLineNum min="0" max="100">
<!--req, xs:integer, number of line feeds, which is between 0 and 100 and the default value is 0-->
42
Intelligent Security API (ANPR) Developer Guide
</changeLineNum>
<spaceNum min="0" max="255">
<!--req, xs:integer, number of spaces, which is between 0 and 255 and the default value is 0-->
</spaceNum>
<startPosEnable opt="true,false">
<!--dep, xs:boolean, whether to enable coordinate configuration, which is only valid for overlaying within the
picture. After enabling coordinate configuration, the function of line feed and space will be invalid, so you are
recommended to disable coordinate configuration-->
</startPosEnable>
<startPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture height, and the default value is 0-->
</startPosTop>
<startPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture width, and the default value is 0-->
</startPosLeft>
<overlayInfoText>
<!--dep, xs:string, overlay character string, which is valid when <itemType> is set to place, intersection No., device
No., direction No., direction description, lane information and camera. The maximum string length of place is 128
bytes, the maximum string length of intersection No., device No., direction No., direction description and lane
information is 32 bytes., the maximum string length of camera 1 is 44 bytes, and the maximum string length of
verification unit, verification certificate No., calibration expiration date is 128 bytes-->
</overlayInfoText>
<overlayInfoText2>
<!--dep, xs:string, overlay character string for camera 2, which is valid when <itemType> is set to camera, and the
maximum string length of camera 2 is 32 bytes-->
</overlayInfoText2>
</OverlayInfo>
</OverlayInfoList>
<linePercent min="0" max="100">
<!--req, xs:integer, percentage of overlaying lines, which is between 0 and 100 and the default value is 100-->
</linePercent>
<itemsStlye opt=" horizontal,vertical">
<!--req, xs:string, overlay mode: "horizontal" (default), "vertical"-->
</itemsStlye>
<charStyle>
<!--req, xs:string, font type-->
</charStyle>
<charSize min="0" max="3">
<!--req, xs:integer, character size: 0-16*16(Chinese)/8*16(English), 1-32*32(Chinese)/16*32(English), 2-48*48,
3-64*64(Chinese)/32*64(English)-->
</charSize>
<charPosition min="0" max="2">
<!--req, xs:integer, text position overlayed on the picture: 0-overlayed on the picture, 1-overlayed outside the top
edge of the picture, 2-overlayed outside the bottom edge of the picture-->
</charPosition>
<charInterval min="0" max="16">
<!--req, xs:integer, character separation distance, which is between 0 and 16 and the default value is 0, unit: pixel-->
</charInterval>
<foreColor min="0" max=" 0xffffff">
<!--req, xs:integer, foreground color, which is the RGB value directly obtained by the palette, the value is between 0
43
Intelligent Security API (ANPR) Developer Guide
B.8 XML_Cap_PicParam
PicParam capability message in XML format
<PicParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<PictureCfg>
<mode opt="quality,size">
<!--req,xs:string-->
</mode>
<pictureQuality min="1" max="100">
<!--dep, xs:integer, picture quality, it is between 1 and 100. This node is required when <mode> is "quality"-->
</pictureQuality>
<pictureSize>
<!--dep, xs:integer, picture size, unit:kb. This node is required when <mode> is "size"-->
</pictureSize>
</PictureCfg>
<Overlap><!--OSD quick configuration, it is valid for captured pictures and combined pictures simultaneously. The
priority of <Overlap> is lower than that of <CapturePicOverlays> and <MergePicOverlays>-->
<enabled>
<!--req, xs:boolean-->
</enabled>
<OverlapItem
opt="positionNo,positionInfo,cameraNo,captureTime,plateNo,vehicleColor,sceneName,carType,vehicleLogo,sceneNo"
>
44
Intelligent Security API (ANPR) Developer Guide
<!--req, xs:string-->
</OverlapItem>
<fontColor>
<!--opt, xs:hexBinary, foreground color-->
</fontColor>
<backColor>
<!--opt, xs:hexBinary, background color-->
</backColor>
</Overlap>
<CapturePicOverlays><!--opt, professional OSD configuration for captured pictures, currently this configuration is
only supported by capture cameras--></CapturePicOverlays>
<MergePicOverlays><!--opt, professional OSD configuration for combined pictures, currently this configuration is only
supported by capture cameras--></MergePicOverlays>
<PlateEnhancement><!--opt, license plate enhancement on captured picture-->
<enabled opt="true,false" def="false"><!--opt, xs:boolean, whether to enable license plate enhancement on
captured picture, by default, it is set to false--></enabled>
<level min="0" max="100" def="50"><!--opt, xs:integer, license plate enhancement level range: [0,100], by default:
50--></level>
</PlateEnhancement>
</PicParam>
See Also
XML_Cap_CapturePicOverlays
XML_Cap_MergePicOverlays
B.9 XML_Cap_PlateRecognitionParam
PlateRecognitionParam capability message in XML format
<PlateRecognitionParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<isSupportdefaultCHN>
<!--req, xs:string, whether to support province/state abbreviation-->
</isSupportdefaultCHN>
<isSupportfrontPlateReco>
<!--opt, xs:boolean, whether to support front license plate recognition-->
</isSupportfrontPlateReco>
<isSupportrearPlateReco>
<!--opt, xs:boolean, whether to support rear license plate recognition-->
</isSupportrearPlateReco>
<isSupportsmallPlateReco>
<!--opt, xs:boolean, whether to support small license plate recognition-->
</isSupportsmallPlateReco>
<isSupportlargePlateReco>
<!--opt, xs:boolean, whether to support large license plate recognition-->
</isSupportlargePlateReco>
<isSupportfarmVehicle>
<!--opt, xs:boolean, whether to support agricultural vehicle recognition-->
</isSupportfarmVehicle>
<isSupportmotor>
<!--opt, xs:boolean, whether to support motorcycle recognition-->
45
Intelligent Security API (ANPR) Developer Guide
</isSupportmotor>
<isSupportfuzzyDisc>
<!--opt, xs:boolean, whether to support fuzzy recognition-->
</isSupportfuzzyDisc>
<isSupportmicroPlateReg>
<!--opt, xs:boolean, whether to support tiny license plate recognition-->
</isSupportmicroPlateReg>
<isSupportcAPlateRegEnabled>
<!--opt, xs:boolean, whether to support civil aviation license plate recognition-->
</isSupportcAPlateRegEnabled>
<isSupporttiltPlateRegEnabled>
<!--opt, xs:boolean, whether to support tilted license plate recognition-->
</isSupporttiltPlateRegEnabled>
<isSupportsuperPlateRecoEnabled>
<!--opt, xs:boolean, whether to support oversized license plate recognition-->
</isSupportsuperPlateRecoEnabled>
<isSupportEmbassyPlateRecoEnabled>
<!-- opt, xs: boolean, whether to support embassy license plate recognition-->
</isSupportEmbassyPlateRecoEnabled>
</PlateRecognitionParam>
B.10 XML_Cap_VehicleDetectCfg
Vehicle detection capability message in XML format
<VehicleDetectCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--required, xs:boolean--></enabled>
<nation opt="EU,ER,EUandCIS,ME"><!--optional, xs:string, country and region, "ER"-CIS Region, "EU"-Europe Region,
"ME"-Middle East, "AP"-Asia Pacific, "AfricaAndAmerica"-Africa and America, "All"-All Region--></nation>
<stateOrProvince opt=""><!--optional, xs:string--></stateOrProvince>
<VehicleDetectSceneList size="">
<VehicleDetectScene><!--list-->
<id><!--required, xs:integer--></id>
<enabled><!--required, xs:boolean--></enabled>
<LaneConfig>
<LaneList size="4">
<Lane>
<laneId min="1" max="4"><!--required, xs:integer--></laneId>
<RegionCoordinatesList size=""><!--list, required-->
<RegionCoordinates><!--minoccurs=2, maxoccurs=2-->
<positionX><!--required, xs:integer--></positionX>
<positionY><!--required, xs:integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
<lineType opt="laneBoundaryLine,laneLine" ><!--optional, xs:string, lane line type: "laneBoundaryLine"-lane
border line, "laneLine"-lane line--></lineType>
<carDriveDirect opt="unknow,up_to_down,down_to_up">
<!--optional, xs:string, vehicle driving direction: "unknow"-unknown, "up_to_down"-from top to bottom,
"down_to_up"-from bottom to top-->
</carDriveDirect>
46
Intelligent Security API (ANPR) Developer Guide
</Lane>
</LaneList>
</LaneConfig>
</VehicleDetectScene>
</VehicleDetectSceneList>
<countryIndex opt="1,2,3,4,5,6,7,8,12,14,17,18,19,20,23,39,44,55"><!--optional, xs:integer, country/region No.--></
countryIndex>
<supportCountryIndex opt="1,2,3,4,5,6,7,8,11,12,14,17,18,19,20,21,23,39,44,46,55,73"><!--optional, xs:integer,
country/region No.--></supportCountryIndex>
<!--compatibility between countryIndex and CRIndex-->
<!--device: both fields will be returned, when the value of CRIndex is smaller than or equal to 255, the value of
countryIndex is the same as that of CRIndex; when the value of CRIndex is larger than 255, the value of countryIndex
is 253 (the field countryIndex is invalid)-->
<!--integration flow: for new users, CRIndex has higher priority over countryIndex and the field countryIndex is used
only when countryIndex does not exist; when the value of countryIndex is 253, additional logic processing should be
adopted to use CRIndex field-->
<CRIndex
opt="0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,28,29,30,31,33,34,35,36,37,38,39,40,42,43,
44,45,46,47,49,51,53,55,59,60,62,65,68,70,71,72,73,76,77,84,87,89,90,94,95,91,104,107,108,110,114,115,130,137,13
9,140,144,145,146,151,156,157,169,174,175,177,180,181,188,206,210,215,216,217,218,219,220,221,222,227,228,25
6">
<!--optional, xs:integer, country/region No., when the value is 0, it indicates that no country/region is specified-->
</CRIndex>
</VehicleDetectCfg>
B.11 XML_CurVehicleDetectMode
CurVehicleDetectMode message in XML format
<CurVehicleDetectMode version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<CurMode><!--req, xs: string,"hvtVehicleDetection, vehicleDetection"--></CurMode>
</CurVehicleDetectMode>
B.12 XML_EntranceCap
XML message about the entrance and exit capability
<EntranceCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<supportEntrance>
<!--opt, xs:boolean-->
</supportEntrance>
<supportBarrierGateNum>
<!--opt, xs:integer-->
</supportBarrierGateNum>
<supportAlarmINNum>
<!--opt, xs:integer-->
</supportAlarmINNum>
<supportRelayNum>
<!--opt, xs:integer-->
47
Intelligent Security API (ANPR) Developer Guide
</supportRelayNum>
<isSupportWizardDeviceInfo>
<!--req, xs:boolean, whether to support configuring device information in wizard-->
</isSupportWizardDeviceInfo>
<isSupportWizardFirstLogin>
<!--req, xs:boolean, whether to support judging if it is login for the first time in wizard-->
</isSupportWizardFirstLogin>
<supportEntranceParam>
<!--opt, xs:integer-->
</supportEntranceParam>
</EntranceCap>
B.13 XML_EventNotificationAlert_ANPRMsg
XML message about ANPR results
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipAddress><!--dependent, xs:string, IPv4 address--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address--></ipv6Address>
<portNo><!--optional, xs:integer, device's communication port No.--></portNo>
<protocol><!--optional, xs:string, transport protocol type: HTTP, HTTPS, EHome--></protocol>
<macAddress><!--optional, xs:string, MAC address--></macAddress>
<dynChannelID><!--optional, xs:string, digital channel No.--></dynChannelID>
<channelID><!--dependent, xs:string, channel No.--></channelID>
<dateTime>
<!--required, xs:datetime, event occurred time, which is in IOS 8601 format, e.g., 2017-04-22T15:39:01+08:00-->
</dateTime>
<activePostCount><!--required, xs:integer, event occurred times--></activePostCount>
<eventType><!--required, xs:string, event types, here it should be set to "ANPR"--></eventType>
<eventState><!--required, xs:string, event status (for persistent event): active, inactive--></eventState>
<eventDescription><!--required, xs:string, event description--></eventDescription>
<channelName><!--optional, xs:string, channel name--></channelName>
<deviceID><!--optional, xs:string, device ID--></deviceID>
<ANPR><!--dependent, this node is valid only when <eventType> is "ANPR"-->
<region><!--optional, xs:string, region--></region>
<country><!--optional, xs:string, country--></country>
<area><!--optional, xs:string, province or state--></area>
<licensePlate><!--required, xs:string, license plate number, e.g., "123456"--></licensePlate>
<line><!--required, xs:integer, recognized lane No.--></line>
<direction><!--optional, xs:string, license plate recognition direction: "reverse", "forward", "unknown"--></
direction>
<confidenceLevel><!--required, xs:integer, confidence level, which ranges from 0 to 100--></confidenceLevel>
<plateType><!--optional, xs:string, license plate type: "unknown", "arm"-police vehicle, "upDownMilitay"-military
vehicle (top-bottom type), "leftRightMilitay"-military vehicle (left-right type), "embassy"-embassy vehicle, "motorola"-
motorcycle, "coach"-driver-training vehicle, "tempTravl"-vehicle with temporary license plate, "trailer"-trailer,
"consulate"-consular vehicle, "tempEntry"-temporary vehicle, "newEnergy"-new energy vehicle--></plateType>
<plateColor>
<!--optional, xs:string, license plate color: "white", "yellow", "blue", "black", "green", "newEnergyGreen"-new
energy green, "newEnergyYellowGreen"-new energy flavogreen, "other"-other color-->
</plateColor>
48
Intelligent Security API (ANPR) Developer Guide
<licenseBright>
<!--optional, xs:integer, license plate brightness, which ranges from 0 to 255-->
</licenseBright>
<Rect><!--optional, coordinates of the license plate thumbnail in the matched picture-->
<height><!--required, xs:float, height--></height>
<width><!--required, xs:float, width--></width>
<x><!--required, xs:float, x-coordinate of the upper-left point--></x>
<y><!--required, xs:float, Y-coordinate of the upper-left point--></y>
</Rect>
<pilotsafebelt>
<!--optional, xs:string, whether the driver is wearing safety belt: "unknown, yes, no"-->
</pilotsafebelt>
<vicepilotsafebelt>
<!--optional, xs:string, whether the co-driver is wearing safety belt: "unknown, yes, no"-->
</vicepilotsafebelt>
<pilotsunvisor>
<!--optional, xs:string, whether the driver room's sun visor is open: "unknown, yes, no"-->
</pilotsunvisor>
<vicepilotsunvisor>
<!--required, xs:string, whether the co-driver room's sun visor is open: "unknown, yes, no"-->
</vicepilotsunvisor>
<envprosign><!--optional, xs:string, whether it is a yellow-label vehicle: "unknown,yes,no"--></envprosign>
<dangmark>
<!--optional, xs:string, whether it is dangerous goods vehicle: "unknown, yes, no"-->
</dangmark>
<uphone>
<!--optional, xs:string, whether the driver is making call: "unknown, yes, no"-->
</uphone>
<pendant>
<!--optional, xs:string, whether there is window hangings detected: "unknown, yes, no"-->
</pendant>
<tissueBox>
<!--optional, xs:string, whether there is tissue box detected: "unknown, yes, no"-->
</tissueBox>
<frontChild>
<!--optional, xs:string, whether the co-driver is with baby in arm: "unknown, yes, no"-->
</frontChild>
<label>
<!--optional, xs:string, whether there is label detected: "unknown, yes, no"-->
</label>
<decoration>
<!--optional, xs:string, whether there is decoration detected: "unknown, yes, no"-->
</decoration>
<smoking>
<!--optional, xs:string, whether there is smoking detected: "unknown, yes, no"-->
</smoking>
<perfumeBox>
<!--optional, xs:string, whether there is perfume box detected: "unknown, yes, no"-->
</perfumeBox>
<pdvs>
<!--optional, xs:string, whether there is a person sticking out of sunroof: "unknown, yes, no"-->
</pdvs>
49
Intelligent Security API (ANPR) Developer Guide
<helmet>
<!--optional, xs:string, whether there is helmet detected: "unknown, yes, no"-->
</helmet>
<twoWheelVehicle>
<!--optional, xs:string, whether there is two-wheel detected: "unknown, yes, no"-->
</twoWheelVehicle>
<threeWheelVehicle>
<!--optional, xs:string, whether there is three-wheel detected: "unknown, yes, no"-->
</threeWheelVehicle>
<blackness>
<!--optional, xs:integer, Ringelmann emittance, which is used for smoke detection-->
</blackness>
<plateCharBelieve>
<!--optional, xs:string, confidence of each character in the recognized license plate-->
</plateCharBelieve>
<speedLimit>
<!--optional, xs:integer, maximum speed limit, this node is valid only when overspeeding occurred-->
</speedLimit>
<illegalInfo>
<!--optional, illegal action information-->
<illegalCode>
<!--required, xs:string, illegal action code-->
</illegalCode>
<illegalName>
<!--required, xs:string, illegal action name-->
</illegalName>
<illegalDescription>
<!--optional, xs:string, illegal action description-->
</illegalDescription>
</illegalInfo>
<vehicleType>
<!--optional, xs:string, vehicle type: "unknown, largeBus, truck, vehicle, van, buggy, pedestrian, twoWheelVehicle,
threeWheelVehicle, SUVMPV, mediumBus, motorVehicle, nonmotorVehicle, smallCar, miniCar, pickupTruck"-->
</vehicleType>
<postPicFileName>
<!--optional, xs:string, name of the picture selected as the checkpoint picture when illegal action occurs, "none"
refers to not selecting any picture-->
</postPicFileName>
<featurePicFileName>
<!--optional, xs:string, name of the picture selected as the close-up picture when running the red light in the
intersection violation system is detected, "none" refers to not selecting any picture-->
</featurePicFileName>
<detectDir>
<!--optional, xs:integer, detection direction: 1-upward, 2-downward, 3-bidirectional, 4-westward, 5-northward, 6-
eastward, 7-southward, 8-other-->
</detectDir>
<detectType>
<!--optional, xs:integer, detection type: 1-inductive loop trigger, 2-video trigger, 3-multiple-frame recognition, 4-
radar trigger-->
</detectType>
<barrierGateCtrlType>
<!--optional, xs:integer, whether to enable elapsed time: 0-enabled, 1-disabled-->
50
Intelligent Security API (ANPR) Developer Guide
</barrierGateCtrlType>
<alarmDataType>
<!--optional, xs:integer, 0-real-time data, 1-history data-->
</alarmDataType>
<dwIllegalTime>
<!--optional, xs:integer, illegal action duration, which is the difference between the capture time of the last picture
and the capture time of the first picture, unit: millisecond-->
</dwIllegalTime>
<vehicleInfo>
<index>
<!--required, xs:integer, vehicle No.-->
</index>
<vehicleType>
<!--optional, xs:integer, vehicle type: 0-other vehicle, 1-small-sized vehicle, 2-large-sized vehicle, 3-pedestrian
trigger, 4-two wheeler trigger, 5-tricycle trigger-->
</vehicleType>
<colorDepth>
<!--required, xs:integer, shade of the vehicle color: 0-deep color, 1-light color-->
</colorDepth>
<color>
<!--required, xs:string, vehicle color: "unknown", "white", "silver"-silvery, "gray", "blacks"-balck, "red",
"deepBlue"-dark blue, "blue", "yellow", "green", "brown", "pink", "purple", "deepGray"-dark gray, "cyan", "orange"-->
</color>
<speed>
<!--required, xs:integer, vehicle speed, unit: km/h-->
</speed>
<length>
<!--required, xs:integer, length of the former vehicle, unit: decimeter-->
</length>
<vehicleLogoRecog>
<!--required, xs:integer, vehicle parent brand-->
</vehicleLogoRecog>
<vehileSubLogoRecog>
<!--optional, xs:integer, vehicle sub-brand-->
</vehileSubLogoRecog>
<vehileModel>
<!--optional, xs:integer, time to market of the vehicle sub-brand-->
</vehileModel>
<vehicleTypeByWeight>
<!--optional, xs:integer, 1-class one vehicle (buses with seven or less seats, trucks with capacity of 2 tons or less),
2-class two vehicle (buses with 8 to 19 seats, trucks with capacity of 2 to 5 (included) tons), 3-class three vehicle
(buses with 20 to 39 seats, trucks with capacity of 5 to 10 (included) tons), 4-class four vehicle (buses with 40 or more
seats, trucks with capacity of 10 to 15 (included) tons), 5-class five vehicle (trucks with capacity of more than 15 tons)--
>
</vehicleTypeByWeight>
</vehicleInfo>
<EntranceInfo>
<!--optional-->
<parkingID>
<!--optional, xs:string, parking space No.-->
</parkingID>
<gateID>
51
Intelligent Security API (ANPR) Developer Guide
52
Intelligent Security API (ANPR) Developer Guide
53
Intelligent Security API (ANPR) Developer Guide
B.14 XML_EventTrigger
Linkage parameter message in XML format
<EventTrigger version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:string, ID--></id>
<eventType>
<!--required, xs:string, see details in the "Remarks" below-->
</eventType>
<eventDescription><!--optional, xs:string--></eventDescription>
<inputIOPortID><!--dependent, xs:string, alarm input ID--></inputIOPortID>
<dynInputIOPortID><!--dependent, xs:string, dynamic alarm input ID--></dynInputPortID>
<videoInputChannelID>
54
Intelligent Security API (ANPR) Developer Guide
<!--dependent, xs:string, video input channel ID, it is valid when <eventType> is "VMD, videoloss, tamperdetection,
regionEntrance, regionExiting, loitering, group, rapidMove, parking, unattendedBaggage, attendedBaggage"-->
</videoInputChannelID>
<dynVideoInputChannelID><!--dependent, xs:string, dynamic video input channel ID--></dynVideoInputChannelID>
<intervalBetweenEvents><!--optional, xs:integer, event time interval, unit: second--></intervalBetweenEvents>
<WLSensorID><!--dependent, xs:string, ID--></WLSensorID>
<EventTriggerNotificationList/><!--optional, alarm/event linkage actions, see details in the message of
XML_EventTriggerNotificationList-->
</EventTrigger>
Remarks
The node <eventType> can be the following values: IO, VMD, videoloss, raidfailure,
recordingfailure, badvideo, POS, analytics, fanfailure, overheat, tamperdetection, diskfull, diskerror,
nicbroken, ipconflict, illaccess, videomismatch, resolutionmismatch, radifailure, PIR, WLSensor,
spareException, poePowerException, heatmap, counting, linedetection, fielddetection,
regionEntrance, regionExiting, loitering, group,rapidMove, parking, unattendedBaggage,
attendedBaggage, HUMANATTRIBUTE, blackList, whitelist, peopleDetection, allVehicleList,
otherVehicleList, vehicledetection, storageDetection, shipsDetection, humanAttribute,
faceContrast, blackListFaceContrast, whiteListFaceContrast, faceSnap, faceLib,
personDensityDetection, personQueueDetecton, mixedTargetDetection, HVTVehicleDetection,
illegalParking, pedestrian, trafficAccident, construction, roadblock, abandonedObject,
parallelParking, parkingState, congestion, intersectionAnalysis, heatMap, thermometry,
shipsFlowDetection, dredgerDetection, reverseEntrance, luma, highHDTemperature,
lowHDTemperature, hdImpact, hdBadBlock, SevereHDFailure, safetyHelmetDetection,
vibrationDetection, HBDLib,TMPA,faceThermometry,noMaskDetection
See Also
XML_EventTriggerNotificationList
B.15 XML_EventTriggerCapType
XML message about capability of alarm linkage action types
<EventTriggerCapType version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportCenter><!--optional, xs:boolean--></isSupportCenter>
<isSupportRecord><!--optional, xs:boolean--></isSupportRecord>
<isSupportMonitorAlarm><!--optional, xs:boolean--></isSupportMonitorAlarm>
<isSupportBeep><!--optional, xs: boolean, whether it supports audible warning--></isSupportBeep>
<isSupportIO><!--optional, xs:boolean--></isSupportIO>
<isSupportFTP><!--optional, xs:boolean--></isSupportFTP>
<isSupportEmail><!--optional, xs:boolean--></isSupEmail>
<isSupportLightAudioAlarm><!--optional, xs:boolean--></isSupportLightAudioAlarm>
<isSupportFocus><!--optional, xs:boolean--></isSupportFocus>
<isSupportPTZ><!--optional, xs:boolean--></isSupportPTZ>
<maxPresetActionNum>
<!--dependent, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPresetActionNum>
55
Intelligent Security API (ANPR) Developer Guide
<maxPatrolActionNum>
<!--dependent, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPatrolActionNum>
<maxPatternActionNum>
<!--dependent, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPatternActionNum>
<isSupportTrack><!--optional, xs:boolean, whether it supports PTZ linked tracking--></isSupportTrack>
<isSupportWhiteLight>
<!--optional, xs: boolean, whether it supports supplement light alarm linkage-->
</isSupportWhiteLight>
<isSupportCloud><!--optional, xs:boolean, whether it supports upload to the cloud--></isSupportCloud>
<targetNotificationInterval max="1000" min="0" default="30"><!--xs:integer, range: [0, 1000], the default value is 30,
unit: seconds, this node is valid for <MotionDetectionTriggerCap> and <TamperDetectionTriggerCap> and this node is
valid when <isSupportPTZ> is "true"--></targetNotificationInterval>
<direction opt="both,forward,reverse"><!--xs:string, triggering direction, this node is valid for the node
<BlackListTriggerCap>, <WhiteListTriggerCap>, and <VehicleDetectionTriggerCap>--></direction>
<presetDurationTime min="" max=""><!--dependent, xs:integer--></presetDurationTime>
<isSupportSMS><!--optional, xs:boolean, whether to support SMS (Short Message Service)--></isSupportSMS>
<maxCellphoneNum><!--dependent, xs:integer, the maximum number of cellphones, which is node is valid only
when <isSupportSMS> is "true"--></maxCellphoneNum>
<isSupportOSD><!--optional, xs:boolean--></isSupportOSD>
<isSupportAudio><!--optional, xs:boolean, whether it supports setting audio alarm independently. If this node is set
to "true", audio alarm and buzzer alarm can be linked separately, and the linage method is audio--></isSupportAudio>
<AudioAction><!--dependent, this node is valid when <isSupportBeep> is "true" or <isSupportAudio> is "true"-->
<audioTypeList>
<audioType><!--list-->
<audioID><!--required, xs:integer, alarm sound type--></audioID>
<audioDescription><!--required, xs:string, alarm sound description, it should correspond to the alarm sound type--
></audioDescription>
</audioType>
</audioTypeList>
<alarmTimes opt="0,1,2,3,4,5,6,7,8,9,255"><!--required, xs:integer, alarm times, it is between 0 and 9, 255-
continuous alarm, unit: time--></alarmTimes>
</AudioAction>
<isSupportSMS><!--optional, xs:boolean --></isSupportSMS>
<maxCellphoneNum><!--dependent, if <isSupportSMS> is true, xs:integer--></maxCellphoneNum>
<isNotSupportCenterModify><!--optional, xs:boolean, whether editing configuration parameters of the surveillance
center is not supported: "true"-yes (configuration parameters of the surveillance center cannot be edited), "false" or
this node is not returned-no (configuration parameters of the surveillance center can be edited)--></
isNotSupportCenterModify>
<isSupportMessageConfig>
<!--optional, xs:boolean, whether it supports SMS configuration, if supports, set cellphoneNumber to null-->
</isSupportMessageConfig>
<isSupportAnalogOutput><!--optional, xs:boolean, whether it supports IO output of linkage analog channel--></
isSupportAnalogOutput>
<isSupportIOOutputUnify><!--optional, xs:boolean, whether it supports configuration of IO output--></
isSupportIOOutputUnify>
<isSupportFaceContrast><!--optional, xs:boolean, whether it supports face picture comparison linkage--></
isSupportFaceContrast>
<isSupportSiren><!--optional, xs:boolean, whether it supports siren linkage--></isSupportSiren>
<isSupportOutput><!--optional, xs:boolean, whether it supports relay linkage--></isSupportOutput>
</EventTriggerCapType>
56
Intelligent Security API (ANPR) Developer Guide
B.16 XML_EventTriggerNotification
Event linkage notification message in XML format
<EventTriggerNotification><!--opt-->
<id><!--required, xs:string, device ID--></id>
<notificationMethod>
<!--required, xs:string, linkage actions, opt="email,IM,IO,syslog,HTTP,FTP,beep,ptz,record, monitorAlarm, center,
LightAudioAlarm,focus,trace,cloud,SMS,whiteLight,audio,whiteLight,faceContrast,siren,output"-->
</notificationMethod>
<notificationRecurrence>
<!--optional, xs:string, "beginning,beginningandend,recurring"-->
</notificationRecurrence>
<notificationInterval><!--dependent, xs:integer, unit: millisecond--></notificationInterval>
<outputIOPortID><!--dependent, xs:string, video output No., it is required only when notificationMethod is "IO"--></
outputIOPortID>
<dynOutputIOPortID><!--dependent, xs:string, dynamic video output No., it is required only when
notificationMethod is "IO"--></dynOutputIOPortID>
<videoInputID><!--dependent, xs:string, video input No., it is required only when notificationMethod is "record"--></
videoInputID>
<dynVideoInputID><!--dependent, xs:string, dynamic video input No., it is required only when notificationMethod is
"record"--></dynVideoInputID>
<ptzAction><!--dependent, it is required only when notificationMethod is "ptz"-->
<ptzChannelID><!--required, xs:string, PTZ channel ID--></ptzChannelID>
<actionName><!--required, xs:string, PTZ control type: "preset", "pattern", "patrol"--></actionName>
<actionNum><!--dependent, xs:integer></actionNum>
</ptzAction>
<WhiteLightAction><!--dependent, white light linkage parameters, this node is valid when notificationMethod is
"whiteLight"-->
<whiteLightDurationTime><!--required, xs:integer, white light flashing duration, it is between 1 and 60, unit:
second--></whiteLightDurationTime>
</WhiteLightAction>
<cellphoneNumber><!--dependent, xs:string, min="0" max="11",cellphone number--></cellphoneNumber-->
</EventTriggerNotification>
B.17 XML_EventTriggerNotificationList
EventTriggerNotificationList message in XML format
<EventTriggerNotificationList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<EventTriggerNotification/><!--opt, see details in the message of XML_EventTriggerNotification-->
</EventTriggerNotificationList>
See Also
XML_EventTriggerNotification
57
Intelligent Security API (ANPR) Developer Guide
B.18 XML_EventTriggersCap
XML message about linkage capabilities of different alarm categories
<EventTriggersCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<DiskfullTriggerCap><!--optional, xs: EventTriggerCapType--></DiskfullTriggerCap>
<DiskerrorTriggerCap><!--optional, xs: EventTriggerCapType--></DiskerrorTriggerCap>
<NicbrokenTriggerCap><!--optional, xs: EventTriggerCapType--></NicbrokenTriggerCap>
<IpconflictTriggerCap><!--optional, xs: EventTriggerCapType--></IpconflictTriggerCap>
<IllaccesTriggerCap><!--optional, xs: EventTriggerCapType--></IllaccesTriggerCap>
<BadvideoTriggerCap><!--optional, xs: EventTriggerCapType--></BadvideoTriggerCap>
<VideomismatchTriggerCap><!--optional, xs: EventTriggerCapType--></VideomismatchTriggerCap>
<IOTriggerCap><!--optional, xs: EventTriggerCapType--></IOTriggerCap>
<LineDetectTriggerCap><!--optional, xs: EventTriggerCapType--></LineDetectTriggerCap>
<RegionEntranceTriggerCap><!--optional, xs: EventTriggerCapType--></RegionEntranceTriggerCap>
<RegionExitingTriggerCap><!--optional, xs: EventTriggerCapType--></RegionExitingTriggerCap>
<LoiteringTriggerCap><!--optional, xs: EventTriggerCapType--></LoiteringTriggerCap>
<GroupDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></GroupDetectionTriggerCap>
<RapidMoveTriggerCap><!--optional, xs: EventTriggerCapType--></RapidMoveTriggerCap>
<ParkingTriggerCap><!--optional, xs: EventTriggerCapType--></ParkingTriggerCap>
<UnattendedBaggageTriggerCap><!--optional, xs: EventTriggerCapType--></UnattendedBaggageTriggerCap>
<AttendedBaggageTriggerCap><!--optional, xs: EventTriggerCapType--></AttendedBaggageTriggerCap>
<FireDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></FireDetectionTriggerCap>
<FireDetectionCap><!--optional, xs: EventTriggerCapType--></FireDetectionCap>
<StorageDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></StorageDetectionTriggerCap>
<ShipsDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></ShipsDetectionTriggerCap>
<ThermometryCap><!--optional, xs: EventTriggerCapType--></ThermometryCap>
<VandalProofTriggerCap><!--optional, xs: EventTriggerCapType--></VandalProofTriggerCap>
<BlackListTriggerCap><!--opt, xs: EventTriggerCapType, configuration capability of blacklist arming linkage--></
BlackListTriggerCap>
<WhiteListTriggerCap><!--opt, xs: EventTriggerCapType, configuration capability of whitelist arming linkage--></
WhiteListTriggerCap>
<AllVehicleListTriggerCap><!--optional,xs:EventTriggerCapType, configuration capability of other list arming linkage--
></AllVehicleListTriggerCap>
<OtherVehicleListTriggerCap><!--optional,xs:EventTriggerCapType--></OtherVehicleListTriggerCap>
<PeopleDetectionTriggerCap><!--optional,xs:EventTriggerCapType--></PeopleDetectionTriggerCap>
<PIRAlarmCap><!--optional, xs: EventTriggerCapType--></PIRAlarmCap>
<TamperDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></TamperDetectionTriggerCap>
<DefocusDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></DefocusDetectionTriggerCap>
<FaceDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></FaceDetectionTriggerCap>
<SceneChangeDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></SceneChangeDetectionTriggerCap>
<VandalProofAlarmCap><!--optional, xs: EventTriggerCapType--></VandalProofAlarmCap>
<JudgmentTriggerCap><!--optional, xs: EventTriggerCapType--></JudgmentTriggerCap>
<FightingTriggerCap><!--optional, xs: EventTriggerCapType--></FightingTriggerCap>
<RisingTriggerCap><!--optional, xs: EventTriggerCapType--></RisingTriggerCap>
<DozingTriggerCap><!--optional, xs: EventTriggerCapType--></DozingTriggerCap>
<CountingTriggerCap><!--optional, xs: EventTriggerCapType--></CountingTriggerCap>
<VideoLossTriggerCap><!--optional, xs: EventTriggerCapType--></VideoLossTriggerCap>
<HideTriggerCap><!--optional, xs:EventTriggerCapType--></HideTriggerCap>
<AlarmInTriggerCap><!--optional, xs: EventTriggerCapType--></AlarmInTriggerCap>
<VehicleDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></VehicleDetectionTriggerCap>
58
Intelligent Security API (ANPR) Developer Guide
59
Intelligent Security API (ANPR) Developer Guide
LowHDTemperatureTriggerCap>
<HDImpactTriggerCap><!--optional, xs:EventTriggerCapType, HDD impact detection--></HDImpactTriggerCap>
<HDBadBlockTriggerCap><!--optional, xs:EventTriggerCapType, HDD bad sector detection--></
HDBadBlockTriggerCap>
<SevereHDFailureTriggerCap><!--optional, xs:EventTriggerCapType, HDD severe fault detection--></
SevereHDFailureTriggerCap>
<HUMANATTRIBUTECap><!--optional, xs:EventTriggerCapType--></HUMANATTRIBUTECap>
<HumanAttributeTriggerCap><!--optional, xs:EventTriggerCapType, human body attribute--></
HumanAttributeTriggerCap>
<BlackListFaceContrastTriggerCap><!--opt, xs:EventTriggerCapType, alarm linkage capability of blacklist face
comparison--></BlackListFaceContrastTriggerCap>
<FaceLibTriggerCap><!--optional, xs:EventTriggerCapType--></FaceLibTriggerCap>
<SafetyHelmetDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of hard hat
detection--></SafetyHelmetDetectionTriggerCap>
<VibrationDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of vibration detection--
></VibrationDetectionTriggerCap>
<RadarLineDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of radar line crossing
detection--></RadarLineDetectionTriggerCap>
<RadarFieldDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of radar intrusion
detection--></RadarFieldDetectionTriggerCap>
<HBDLibTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of human body picture library--></
HBDLibTriggerCap>
<FaceThermometryCap><!--optional, xs:EventTriggerCapType--></FaceThermometryCap>
<NoMaskDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of no wearing mask
detection--></NoMaskDetectionTriggerCap>
<TMPATriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of temperature measurement pre-
alarm--></TMPATriggerCap>
<FireEscapeDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of fire engine access
detection--></FireEscapeDetectionTriggerCap>
<TakingElevatorDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of elevator
detection--></TakingElevatorDetectionTriggerCap>
<RuleTriggerCap><!--optional, linkage capability of rule triggered alarm -->
<isSupportCityManagement>
<!--optional, xs:boolean, whether the city management supports setting linkage actions by area; if supports, the
value is true, otherwise, this node will not be returned-->
</isSupportCityManagement>
</RuleTriggerCap>
</EventTriggersCap>
See Also
XML_EventTriggerCapType
B.19 XML_ITCCap
XML message about intelligent traffic capability
<ITCCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportITCStatus>
<!--req, xs:boolean, whether it supports device status-->
</isSupportITCStatus>
60
Intelligent Security API (ANPR) Developer Guide
<isSupportIllegalDictionary>
<!--req, xs:boolean, whether it supports traffic violation dictionary-->
</isSupportIllegalDictionary>
<isSupportVehicleDetection>
<!--dep, xs: boolean, whether it supports vehicle detection-->
<isSupportEvidenceDictionary>
<!--req, xs: boolean, whether it supports traffic law enforcement dictionary-->
</isSupportEvidenceDictionary>
<isSupportITCSetUp>
<!--req, xs:boolean, whether it supports installation parameters-->
</isSupportITCSetUp>
<isSupportTrafficParam>
<!--req, xs:boolean, whether it supports vehicle counting statistics-->
</isSupportTrafficParam>
<isSupportManualCap>
<!--req, xs:boolean, whether it supports manual capture-->
</isSupportManualCap>
<isSupportIllegalUploadPic>
<!--req, xs:boolean, whether it supports uploading pictures-->
</isSupportIllegalUploadPic>
<isSupportContinueCap>
<!--req, xs:boolean, whether it supports continuous capture-->
</isSupportContinueCap>
<isSupportWiper>
<!--req, xs:boolean, whether it supports wiper-->
</isSupportWiper>
<isSupportEntranceCap>
<!--opt, whether it supports entrance and exit functions-->
</isSupportEntranceCap>
<isSupportPlateRecognitionParam>
<!--req, xs:boolean, whether it supports license plate recognition parameters-->
</isSupportPlateRecognitionParam>
<isSupportSyncSignalOutput>
<!--req, xs:boolean,whether it supports output parameters-->
</isSupportSyncSignalOutput>
<isSupportSyncPower>
<!--req, xs:boolean, whether it supports signal light synchronization-->
</isSupportSyncPower>
<isSupportImageMerge>
<!--req, xs:boolean, whether it supports picture composition-->
</isSupportImageMerge>
<isSupportCabinetParam>
<!--req, xs:boolean, whether it supports device cabinet alarm-->
</isSupportCabinetParam>
<isSupportCarFeatureParam>
<!--req, xs:boolean, whether it supports vehicle features-->
</isSupportCarFeatureParam>
<isSupportLightCorrect>
<!--req, xs:boolean, whether it supports exporting illegal action codes-->
</isSupportLightCorrect>
<isSupportSnapshot>
<!--req, xs:boolean, whether it supports image capture resolution-->
61
Intelligent Security API (ANPR) Developer Guide
</isSupportSnapshot>
<isSupportIllegalCodeData>
<!--req, xs:boolean, whether it supports signal light correction-->
</isSupportIllegalCodeData>
<isSupportNetStorage>
<!--req, xs:boolean, whether it supports network storage-->
</isSupportNetStorage>
<isSupportAlgorithmsVersion>
<!--req, xs:boolean, whether it supports getting algorithm library status-->
</isSupportAlgorithmsVersion>
<isSupportAlgorithmsState>
<!--req, xs:boolean, whether it supports getting algorithm library version-->
</isSupportAlgorithmsState>
<isSupportPlateCorrection>
<!--opt, xs:boolean, whether it supports manual license plate correction-->
</isSupportPlateCorrection>
<isSupportRadarSetUp>
<!--req, xs:boolean, whether it supports radar construction parameters-->
</isSupportRadarSetUp>
<isSupportRadarMeasurement>
<!--opt, xs:boolean, whether it supports radar measurement configuration-->
</isSupportRadarMeasurement>
</ITCCap>
B.20 XML_LPListAuditSearchDescription
LPListAuditSearchDescription message in XML format
<LPListAuditSearchDescription version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string--></searchID>
<searchResultPosition><!--req, xs: integer--></searchResultPosition>
<maxResults><!--req, xs: integer--></maxResults>
</LPListAuditSearchDescription>
B.21 XML_LPListAuditSearchResult
LPListAuditSearchResult message in XML format
<LPListAuditSearchResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string--></searchID>
<responseStatus></responseStatus>
<responseStatusStrg></responseStatusStrg>
<numOfMatches><!--req, xs: integer--></numOfMatches>
<totalMatches><!--req, xs: integer--></totalMatches>
<LicensePlateInfoList>
<LicensePlateInfo>
<id><!--req, xs: string --></id>
<LicensePlate><!--opt, xs: string--></LicensePlate>
<type><!--opt, xs: string, "blackList,whitelist,allVehicleList,otherVehicleList"--></type>
62
Intelligent Security API (ANPR) Developer Guide
B.22 XML_PicParam
PicParam message in XML format
<PicParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<PictureCfg>
<mode> <!--req, xs:string,"quality,size"--> </mode>
<pictureQuality> <!--dep, xs:integer,1-100 --> </pictureQuality>
<pictureSize> <!--dep, xs:integer,unit:kb --> </pictureSize>
</PictureCfg>
<Overlap>
<enabled> <!--req, xs: boolean> </enabled>
<OverlapItemList >
<OverlapItem>
<id><!--req, xs:interger --><id>
<item opt="">
<!--req, xs:string, "positionNo, positionInfo, cameraNo, captureTime, plateNo, vehicleColor, sceneName, carType,
vehicleLogo, sceneNo, direction, validity"-->
</item>
</OverlapItem>
</OverlapItemList >
<fontColor> <!--opt, xs: hexBinary;color --> </fontColor>
<backColor> <!--opt, xs: hexBinary;color --> </backColor>
</Overlap>
<PlateEnhancement><!--opt, license plate enhancement on captured picture-->
<enabled><!--opt, xs:boolean, whether to enable license plate enhancement on captured picture, by default, it is
set to false--></enabled>
<level><!--opt, xs:integer, license plate enhancement level range: [0,100], by default, it is set to 50--></level>
</PlateEnhancement>
</PicParam>
Note
The node pictureQulity is required when the node mode is set to "quality", and the node
pictureSize is required when the node mode is set to "size".
B.23 XML_PlateRecognitionParam
PlateRecognitionParam message in XML format
<PlateRecognitionParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<defaultCHN>
63
Intelligent Security API (ANPR) Developer Guide
B.24 XML_ResponseStatus
XML message about response status
<ResponseStatus version="2.0" xmlns="http://www.std-cgi.org/ver20/XMLSchema">
<requestURL>
<!--required, read-only, xs:string, request URL-->
</requestURL>
<statusCode>
<!--required, read-only, xs:integer, status code: 0,1-OK, 2-Device Busy, 3-Device Error, 4-Invalid Operation, 5-Invalid
64
Intelligent Security API (ANPR) Developer Guide
Note
See Response Codes of Text Protocol for details about sub status codes and corresponding error
codes.
B.25 XML_Schedule
Schedule message in XML format
<Schedule version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:string, ID--></id>
<eventType>
<!--optional, xs:string, alarm/event types, see details in the "Remarks" below-->
</eventType>
<inputIOPortID><!--read-only, dependent, xs:string, alarm input No.--></inputIOPortID>
<outputIOPortID><!--read-only, dependent, xs:string, alarm output No.--></inputIOPortID>
<videoInputChannelID><!--read-only, dependent, xs:string, video input channel ID--></videoInputChannelID>
<TimeBlockList size="8"><!--required-->
<TimeBlock><!--list-->
<dayOfWeek>
<!--optional, xs:integer, day of the week based on ISO8601, "1"=Monday, ...-->
</dayOfWeek>
<TimeRange><!--required-->
<beginTime><!--required, xs:time, ISO8601 time--></beginTime>
<endTime><!--required, xs:time, ISO8601 time--></endTime>
</TimeRange>
<CustomExtension>
<vehicleDetectSceneID>
<!--required, xs:interger-->
</vehicleDetectSceneID>
</CustomExtension>
</TimeBlock>
</TimeBlockList>
<HolidayBlockList><!--optional-->
<TimeBlock><!--list-->
<TimeRange><!--required-->
<beginTime><!--required, xs:time, ISO8601 time--></beginTime>
<endTime><!--required, xs:time, ISO8601 time--></endTime>
</TimeRange>
65
Intelligent Security API (ANPR) Developer Guide
</TimeBlock>
</HolidayBlockList>
</Schedule>
Remarks
The node <eventType> can be set to the following values: IO, VMD,videoloss, PIR,linedetection,
fielddetection, audioexception, facedetection, regionEntrance, regionExiting, loitering, group,
rapidMove, parking, unattendedBaggage,attendedBaggage, storageDetection, shipsDetection,
HUMANATTRIBUTE, humanAttribute, faceContrast, faceSnap, faceLib, whiteListFaceContrast,
personDensityDetection, personQueueDetection, mixedTargetDetection, fireDetection,
illegalParking, pedestrian, trafficAccident,construction, roadblock, abandonedObject,
parallelParking, parkingState, congestion, intersectionAnalysis, heatMap, reverseEntrance,
vehicledetect, safetyHelmetDetection, vibrationDetection, TMPA, faceThermometry, HBDLib.
B.26 XML_TrafficChannelCap
Traffic channel capability message in XML format
<TrafficChannelCap version="1.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<deviceTypeSupport>
<!--optional, xs: integer, device type: 0-video monitoring, 1-loop detection, 2-video analysis, 3-reserved, 4-video
analysis (event + traffic enforcement + traffic data collection), 5-video analysis + capture (event + traffic enforcement +
traffic data collection), 6-video structurization, 7-speed dome for dynamic tracking and capture, 8-speed dome for non-
dynamic tracking and capture-->
</deviceTypeSupport>
<isPTZSupport><!--optional, xs:boolean, whether it supports configuring PTZ type, PTZ address, PTZ control speed,
and zooming speed--><isPTZSupport>
<isEvidenceGettingSupport>
<!--optional, xs: boolean, whether it supports violation enforcement, setting scenes, and scene auto-switch-->
</isEvidenceGettingSupport>
<isBasicSupport>
<!--optional, xs: boolean, whether it supports setting basic parameters-->
</isBasicSupport>
<isImageMergeSupport>
<!--optional, xs: boolean, whether it supports picture overlay-->
</isImageMergeSupport>
<isOverlapSupport>
<!--optional, xs: boolean, whether it supports text overlay-->
</isOverlapSupport>
<isEdfAlgSupport>
<!--optional, xs: boolean, whether it supports setting analysis parameters-->
</isEdfAlgSupport>
<isAutoTraceSupport>
<!--required, xs: boolean, whether it supports auto-tracking-->
</isAutoTraceSupport>
<isEdfManualItsCapSupport>
<!--optional, xs: boolean, whether it supports setting manual enforcement parameters-->
</isEdfManualItsCapSupport>
<isViolationTypeStdSupport>
66
Intelligent Security API (ANPR) Developer Guide
67
Intelligent Security API (ANPR) Developer Guide
Example
TrafficChannelCap Message Example
<TrafficChannelCap version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<isEvidenceGettingSupport>false</isEvidenceGettingSupport>
<isBasicSupport>true</isBasicSupport>
<isImageMergeSupport>true</isImageMergeSupport>
<isOverlapSupport>true</isOverlapSupport>
<isEdfAlgSupport>true</isEdfAlgSupport>
<isEdfManualItsCapSupport>false</isEdfManualItsCapSupport>
<isEDFRemoteHostSupport>true</isEDFRemoteHostSupport>
<isANRSupport>true</isANRSupport>
<isvoiceTriggerSupport>false</isvoiceTriggerSupport>
<uploadDataTypesSupport></uploadDataTypesSupport>
<aidTypeSupport>wrongDirection,turnRound,vehicleexist,congestion,crossLane,laneChange,pedestrian,roadBlock,aba
ndonedObject,construction,trafficAccident,fogDetection</aidTypeSupport>
<isIntellMonitorSupport>false</isIntellMonitorSupport>
68
Intelligent Security API (ANPR) Developer Guide
<isVCRSupport>false</isVCRSupport>
<isEdfManualTrackSupport>false</isEdfManualTrackSupport>
<videoEvidenceTypeSupport></videoEvidenceTypeSupport>
<TFSEventSupport>wrongDirection,turnRound,vehicleexist,crossLane,laneChange</TFSEventSupport>
<AIDEventSupport>congestion,pedestrian,roadBlock,abandonedObject,construction,trafficAccident,fogDetection</
AIDEventSupport>
<isVehicleStatisticsSupport>true</isVehicleStatisticsSupport>
<isLaneRuleSupport>true</isLaneRuleSupport>
<isSupportPlateListEvidence>true</isSupportPlateListEvidence>
</TrafficChannelCap>
B.27 XML_TrafficEventTrigger
TrafficEventTrigger message in XML format.
<TrafficEventTrigger version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<EventType><!--req,-->
<allVehicleList><!--opt,xs:boolen--></allVehicleList>
</EventType>
</TrafficEventTrigger>
B.28 XML_VehicleDetectCfg
Vehicle detection configuration message in XML format
<VehicleDetectCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--required, xs:boolean--></enabled>
<nation><!--optional, xs:string, "ER"-CIS Region, "EU"-Europe Region, "ME"-Middle East, "AP"-Asia Pacific,
"AfricaAndAmerica"-Africa and America, "All"-All Region--></nation>
<stateOrProvince> <!--optional, xs:string--> </stateOrProvince>
<bestDetectionSize> <!--optional, xs:string--> </bestDetectionSize>
<VehicleDetectSceneList>
<VehicleDetectScene/>
</VehicleDetectSceneList>
<PlateDetectionRegion>
<PlateSize>
<minWidth> <!--optional, xs:interger--> </minWidth>
<maxWidth> <!--optional, xs:interger--> </maxWidth>
</PlateSize>
<plateMode><!--optional,xs:string, "small,large", License plate mode--></plateMode>
</PlateDetectionRegion>
<RodeType><!--optional-->
<type><!--optional, xs:string,"entrance,city,custom,alarmInput"--> </type>
<Custom><!--dependent, custom-->
<delayTime><!--optional, xs:interger,[0,15000]--></delayTime>
<delayTimeUnit><!--optional, xs:string, "ms"--></delayTimeUnit>
</Custom>
</RodeType>
<countryIndex><!--optional, xs:integer, country/region No.--></countryIndex>
69
Intelligent Security API (ANPR) Developer Guide
B.29 XML_VehicleDetectScheduleList
VehicleDetectScheduleList message in XML format
<VehicleDetectScheduleList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Schedule>
<id><!--req, xs:string; id --></id>
<inputIOPortID><!--ro, dep, xs:string; id--></inputIOPortID>
<outputIOPortID><!--ro, dep, xs:string; id--></inputIOPortID>
<videoInputChannelID><!--ro, dep, xs:string; id--></videoInputChannelID>
<TimeBlockList> <!--req-->
<TimeBlock>
<dayOfWeek>
<!--opt, xs:integer, ISO8601 weekday number, 1=Monday, … -->
</dayOfWeek>
<TimeRange><!--req-->
<beginTime><!--req, xs:time, ISO8601 time--></beginTime>
<endTime><!--req, xs:time, ISO8601 time--></endTime>
</TimeRange>
<CustomExtension>
<vehicleDetectSceneID><!--req, xs:interger--></vehicleDetectSceneID>
</CustomExtension>
</TimeBlock>
</TimeBlockList>
</Schedule>
</VehicleDetectScheduleList>
B.30 XML_WhiteListScheduleList
WhiteListScheduleList message in XML format
<WhiteListScheduleList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Schedule/><!--opt, see details in the message of XML_Schedule-->
</WhiteListScheduleList>
See Also
XML_Schedule
70
Intelligent Security API (ANPR) Developer Guide
B.31 JSON_EventNotificationAlert_Alarm/EventInfo
EventNotificationAlert message with alarm or event information in JSON format.
{
"ipAddress": "",
/*required, device IPv4 address , string, the maximum size is 32 bytes*/
"ipv6Address": "",
/*optional, device IPv6 address, string, the maximum size is 128 bytes*/
"portNo": ,
/*optional, device port No., integer32*/
"protocol": "",
/*optional, protocol type, "HTTP, HTTPS", string, the maximum size is 32 bytes*/
"macAddress": "",
/*optional, MAC address, string, the maximum size is 32 bytes, e.g., 01:17:24:45:D9:F4*/
"channelID": "",
/*optional, device channel No., integer32*/
"dateTime": "",
/*optional, string, alarm/event triggered or occurred time based on ISO8601, the maximum size is 32 bytes, e.g.,
2009-11-14T15:27Z*/
"activePostCount": "",
/*required, alarm/event frequency, integer32*/
"eventType": "",
/*required, alarm/event type, "captureResult, faceCapture,...", string, the maximum size is 128 bytes*/
"eventState": "",
/*required, string, the maximum size is 32 bytes, durative alarm/event status: "active"-valid, "inactive"-invalid*/
"eventDescription": "",
/*required, event description, string, the maximum size is 128 bytes*/
"deviceID":"",
/*string type, device ID*/
"uuid":"",
/*string type, event UUID, which is used to uniquely identify an event, the standard UUID format is xxxxxxxx-xxxx-xxxx-
xxxx-xxxxxxxxxxxx*/
...
/*optional, for different alarm/event types, the nodes are different, see the message examples in different
applications*/
}
B.32 XML_EventNotificationAlert_AlarmEventInfo
EventNotificationAlert message with alarm/event information in XML format.
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipAddress><!--dep, xs:string, device IPv4 address--></ipAddress>
<ipv6Address><!--dep, xs:string, device IPv6 address--></ipv6Address>
<portNo><!--opt, xs:integer, device port number--></portNo>
<protocol><!--opt, xs:string, protocol type for uploading alarm/event information, "HTTP,HTTPS"--></protocol>
<macAddress><!--opt, xs:string, MAC address--></macAddress>
<channelID><!--dep, xs:string, device channel No., starts from 1--></channelID>
71
Intelligent Security API (ANPR) Developer Guide
B.33 XML_EventNotificationAlert_HeartbeatInfo
EventNotificationAlert message with heartbeat information (when there is no alarm is triggered) in
XML format
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipv6Address><!--dep, xs:string, device IPv6 address--></ipv6Address>
<portNo><!--opt, xs:integer, device port number--></portNo>
<protocol><!--opt, xs:string, protocol type for uploading alarm/event information, "HTTP,HTTPS"--></protocol>
<macAddress><!--opt, xs:string, MAC address--></macAddress>
<channelID><!--dep, xs:string, device channel No., starts from 1--></channelID>
<dateTime><!--req, heartbeat uploaded time, format: 2017-07-19T10:06:41+08:00--></dateTime>
<activePostCount><!--req, xs:integer, heartbeat frequency, starts from 1--></activePostCount>
<eventType><!--req, xs:string, for heartbeat, it is "videoloss"--></eventType>
<eventState>
<!--req, xs:string, for heartbeat, it is "inactive"-->
</eventState>
<eventDescription><!--req, xs: string, description--></eventDescription>
</EventNotificationAlert>
Remarks
• For network camera or network speed dome with the version 5.5.0 and lower, the heartbeat
frequency is 300 ms per heartbeat.
• For network camera or network speed dome with the version 5.5.0 and higher, the heartbeat
frequency is 10 s per heartbeat. If no heartbeat received for continuous 30 s, it indicates that the
heartbeat is timed out.
Example
Message Example of Heartbeat
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.com/ver20/XMLSchema">
<ipAddress>10.17.133.46</ipAddress>
<portNo>80</portNo>
<protocol>HTTP</protocol>
<macAddress>44:19:b6:6d:24:85</macAddress>
<channelID>1</channelID>
72
Intelligent Security API (ANPR) Developer Guide
<dateTime>2017-05-04T11:20:02+08:00</dateTime>
<activePostCount>0</activePostCount>
<eventType>videoloss</eventType>
<eventState>inactive</eventState>
<eventDescription>videoloss alarm</eventDescription>
</EventNotificationAlert>
B.34 XML_HttpHostNotification
XML message about parameters of a HTTP listening server
<HttpHostNotification version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:string, ID--></id>
<url><!--required, xs:string, the absolute path, e.g., http://<ipAddress>:<portNo>/<uri>--></url>
<protocolType><!--required, xs:string, "HTTP,HTTPS,EHome"--></protocolType>
<parameterFormatType><!--required, xs:string, alarm/event information format, "XML,JSON"--></
parameterFormatType>
<addressingFormatType><!--required, xs:string, "ipaddress,hostname"--></addressingFormatType>
<hostName><!--dependent, xs:string--></hostName>
<ipAddress><!--dependent, xs:string--></ipAddress>
<ipv6Address><!--dependent, xs:string--></ipv6Address>
<portNo><!--optional, xs:integer--></portNo>
<userName><!--dependent, xs:string--></userName>
<password><!--dependent, xs:string--></password>
<httpAuthenticationMethod><!--required, xs:string, "MD5digest,none"--></httpAuthenticationMethod>
<ANPR><!--optional-->
<detectionUpLoadPicturesType>
<!--optional, xs:string, types of alarm picture to be uploaded: "all, licensePlatePicture, detectionPicture"-->
</detectionUpLoadPicturesType>
</ANPR>
<eventType optional="AID,TFS,TPS"><!--required, xs:string--></eventType>
<uploadImagesDataType>
<!--optional, xs:string, "URL", "binary" (default), for cloud storage, only "URL" is supported-->
</uploadImagesDataType>
<eventMode><!--optional, xs:string, "all,list"--></eventMode>
<EventList><!--dependent, it is valid only when eventMode is "list"-->
<Event><!--required-->
<type><!--required, xs:string--></type>
</Event>
</EventList>
<channels><!--optional, xs:string, "1,2,3,4…"--></channels>
<SubscribeEvent/><!--optional, event subscription parameters, see details in the message of XML_SubscribeEvent-->
</HttpHostNotification>
B.35 XML_HttpHostNotificationCap
XML message about capability of HTTP listening server
73
Intelligent Security API (ANPR) Developer Guide
74
Intelligent Security API (ANPR) Developer Guide
</StatusSub>
</ChangedUploadSub>
</SubscribeEventCap>
</HttpHostNotificationCap>
B.36 XML_HttpHostNotificationList
HttpHostNotificationList message in XML format
<HttpHostNotificationList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<HttpHostNotification>
<id><!--req, xs:string, ID--></id>
<url><!--req, xs:string--></url>
<protocolType><!--req, xs:string, "HTTP,HTTPS"--></protocolType>
<parameterFormatType><!--req, xs:string, alarm/event information format, "XML,JSON"--></parameterFormatType>
<addressingFormatType><!--req, xs:string, "ipaddress,hostname"--></addressingFormatType>
<hostName><!--dep, xs:string--></hostName>
<ipAddress><!--dep, xs:string--></ipAddress>
<ipv6Address><!--dep, xs:string--></ipv6Address>
<portNo><!--opt, xs:integer--></portNo>
<userName><!--dep, xs:string--></userName>
<password><!--dep, xs:string--></password>
<httpAuthenticationMethod><!--req, xs:string, "MD5digest,none"--></httpAuthenticationMethod>
<uploadImagesDataType>
<!--opt, xs:string, "URL", "binary" (default), for cloud storage, only "URL" is supported-->
</uploadImagesDataType>
<eventMode><!--opt, xs:string, "all,list"--></eventMode>
<EventList><!--dep, it is valid only when eventMode is "list"-->
<Event><!--req-->
<type><!--req, xs:string--></type>
</Event>
</EventList>
<channels><!--opt, xs:string, "1,2,3,4…"--></channels>
</HttpHostNotification>
</HttpHostNotificationList>
Example
HttpHostNotificationList Message Example
<HttpHostNotificationList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<HttpHostNotification>
<id>1</id>
<url></url>
<protocolType>HTTP</protocolType>
<parameterFormatType>XML</parameterFormatType>
<addressingFormatType>ipaddress</addressingFormatType>
<ipAddress>0.0.0.0</ipAddress>
<portNo>80</portNo>
<userName></userName>
<httpAuthenticationMethod>none</httpAuthenticationMethod>
75
Intelligent Security API (ANPR) Developer Guide
</HttpHostNotification>
</HttpHostNotificationList>
B.37 XML_HttpHostTestResult
HttpHostTestResult message in XML format.
<HttpHostTestResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<errorDescription>
<!--req, xs:string-->
</errorDescription>
</HttpHostTestResult>
76
Intelligent Security API (ANPR) Developer Guide
StatusCode=1
StatusCode=2
77
Intelligent Security API (ANPR) Developer Guide
StatusCode=3
78
Intelligent Security API (ANPR) Developer Guide
StatusCode=4
79
Intelligent Security API (ANPR) Developer Guide
80
Intelligent Security API (ANPR) Developer Guide
81
Intelligent Security API (ANPR) Developer Guide
82
Intelligent Security API (ANPR) Developer Guide
83
Intelligent Security API (ANPR) Developer Guide
84
Intelligent Security API (ANPR) Developer Guide
85
Intelligent Security API (ANPR) Developer Guide
86
Intelligent Security API (ANPR) Developer Guide
87
Intelligent Security API (ANPR) Developer Guide
88
Intelligent Security API (ANPR) Developer Guide
89
Intelligent Security API (ANPR) Developer Guide
90
Intelligent Security API (ANPR) Developer Guide
91
Intelligent Security API (ANPR) Developer Guide
92
Intelligent Security API (ANPR) Developer Guide
93
Intelligent Security API (ANPR) Developer Guide
94
Intelligent Security API (ANPR) Developer Guide
95
Intelligent Security API (ANPR) Developer Guide
96
Intelligent Security API (ANPR) Developer Guide
97
Intelligent Security API (ANPR) Developer Guide
98
Intelligent Security API (ANPR) Developer Guide
99
Intelligent Security API (ANPR) Developer Guide
100
Intelligent Security API (ANPR) Developer Guide
101
Intelligent Security API (ANPR) Developer Guide
102
Intelligent Security API (ANPR) Developer Guide
103
Intelligent Security API (ANPR) Developer Guide
StatusCode=5
StatusCode=6
104
Intelligent Security API (ANPR) Developer Guide
105
Intelligent Security API (ANPR) Developer Guide
106
Intelligent Security API (ANPR) Developer Guide
107
Intelligent Security API (ANPR) Developer Guide
108
Intelligent Security API (ANPR) Developer Guide
109
Intelligent Security API (ANPR) Developer Guide
StatusCode=7
110