Heat Map Application

ISAPI User Manual

 Heat Map Application ISAPI User Manual

Legal Information

User Manual
©2019 Hangzhou Hikvision Digital Technology Co., Ltd.
About this Manual
This Manual is subject to domestic and international copyright protection. Hangzhou Hikvision
Digital Technology Co., Ltd. ("Hikvision") reserves all rights to this manual. This manual cannot be
reproduced, changed, translated, or distributed, partially or wholly, by any means, without the
prior written permission of Hikvision.
Please use this user manual under the guidance of professionals.
Trademarks
and other Hikvision marks are the property of Hikvision and are
registered trademarks or the subject of applications for the same by Hikvision and/or its affiliates.
Other trademarks mentioned in this manual are the properties of their respective owners. No right
of license is given to use such trademarks without express permission.
Disclaimer
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, HIKVISION MAKES NO WARRANTIES,
EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THIS MANUAL.
HIKVISION DOES NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE
USE OF THE MANUAL, OR THE CORRECTNESS, ACCURACY, OR RELIABILITY OF INFORMATION
CONTAINED HEREIN. YOUR USE OF THIS MANUAL AND ANY RELIANCE ON THIS MANUAL SHALL BE
WHOLLY AT YOUR OWN RISK AND RESPONSIBILITY.
REGARDING TO THE PRODUCT WITH INTERNET ACCESS, THE USE OF PRODUCT SHALL BE WHOLLY
AT YOUR OWN RISKS. HIKVISION SHALL NOT TAKE ANY RESPONSIBILITIES FOR ABNORMAL
OPERATION, PRIVACY LEAKAGE OR OTHER DAMAGES RESULTING FROM CYBER ATTACK, HACKER
ATTACK, VIRUS INSPECTION, OR OTHER INTERNET SECURITY RISKS; HOWEVER, HIKVISION WILL
PROVIDE TIMELY TECHNICAL SUPPORT IF REQUIRED.
SURVEILLANCE LAWS VARY BY JURISDICTION. PLEASE CHECK ALL RELEVANT LAWS IN YOUR
JURISDICTION BEFORE USING THIS PRODUCT IN ORDER TO ENSURE THAT YOUR USE CONFORMS
THE APPLICABLE LAW. HIKVISION SHALL NOT BE LIABLE IN THE EVENT THAT THIS PRODUCT IS USED
WITH ILLEGITIMATE PURPOSES.
IN THE EVENT OF ANY CONFLICTS BETWEEN THIS MANUAL AND THE APPLICABLE LAW, THE LATER
PREVAILS.

i
 Heat Map Application ISAPI User Manual

Contents
Chapter 1 Overview .................................................................................................................... 1
1.1 Introduction ........................................................................................................................... 1
1.2 Update History ....................................................................................................................... 1
Chapter 2 Configure Heat Map Alarm ......................................................................................... 3
Chapter 3 Configure Intersection Analysis Alarm ........................................................................ 5
Chapter 4 Alarm/Event Receiving ............................................................................................. 10
4.1 Receive Alarm/Event in Arming Mode ................................................................................. 10
4.2 Receive Alarm/Event in Listening Mode .............................................................................. 12
Chapter 5 Request URL ............................................................................................................. 15
5.1 /ISAPI/Event/capabilities ..................................................................................................... 15
5.2 /ISAPI/Event/channels/<ID>/capabilities ............................................................................. 15
5.3 /ISAPI/Event/schedules/heatMaps/<ID> ............................................................................. 16
5.4 /ISAPI/Event/schedules/intersectionAnalysis/<ID> ............................................................. 16
5.5 /ISAPI/Event/schedules/intersectionAnalysis ...................................................................... 17
5.6 /ISAPI/Event/triggers ........................................................................................................... 17
5.7 /ISAPI/Event/triggers/<ID> .................................................................................................. 18
5.8 /ISAPI/Event/triggersCap ..................................................................................................... 19
5.9 /ISAPI/Intelligent/channels/<ID>/capabilities ...................................................................... 19
5.10 /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/search?format=json .................... 20
5.11 /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis?format=json ................................ 20
5.12 /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/capabilities?format=json ............. 21
5.13 /ISAPI/System/capabilities ................................................................................................. 21
5.14 /ISAPI/System/Video/capabilities ...................................................................................... 22
5.15 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/capabilities .................................. 22
5.16 /ISAPI/System/Video/inputs/channels/<ID>/heatMap ..................................................... 22
5.17 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/pictureInfo .................................. 23

ii
 Heat Map Application ISAPI User Manual

5.18 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/picture ........................................ 24

5.19 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions ........................................ 24
5.20 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions/<ID> ............................... 25
5.21 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/search ......................................... 26
5.22 /ISAPI/Event/capabilities ................................................................................................... 27
5.23 /ISAPI/Event/notification/alertStream ............................................................................... 27
5.24 /ISAPI/Event/notification/httpHosts .................................................................................. 28
5.25 /ISAPI/Event/notification/httpHosts/<ID>/test ................................................................. 29
5.26 /ISAPI/Event/notification/httpHosts/capabilities .............................................................. 30
5.27 /ISAPI/Event/triggers ......................................................................................................... 30
5.28 /ISAPI/Event/triggersCap ................................................................................................... 30
5.29 /ISAPI/Event/triggers/<ID> ................................................................................................ 31
5.30 http://ipAddress:portNo/url .............................................................................................. 32
Chapter 6 Request and Response Message ............................................................................... 33
6.1 JSON_EventNotificationAlert_HeatMapAlarmMsg .............................................................. 33
6.2 JSON_IntersectionAnalysisSearchCond ................................................................................ 35
6.3 JSON_IntersectionAnalysisSearchResult .............................................................................. 36
6.4 JSON_IntersectionAnalysisCap ............................................................................................. 36
6.5 JSON_IntersectionAnalysis ................................................................................................... 37
6.6 JSON_ResponseStatus .......................................................................................................... 38
6.7 XML_Cap_HeatMap ............................................................................................................. 38
6.8 XML_ChannelEventCap ........................................................................................................ 39
6.9 XML_DeviceCap ................................................................................................................... 44
6.10 XML_EventCap ................................................................................................................... 49
6.11 XML_EventTrigger .............................................................................................................. 52
6.12 XML_EventTriggerList ......................................................................................................... 54
6.13 XML_EventTriggerNotification ........................................................................................... 58
6.14 XML_EventTriggerNotificationList ...................................................................................... 59

iii
 Heat Map Application ISAPI User Manual

6.15 XML_HeatMap ................................................................................................................... 59

6.16 XML_InputScheduleList ..................................................................................................... 61
6.17 XML_IntelliCap ................................................................................................................... 61
6.18 XML_Schedule ................................................................................................................... 62
6.19 XML_VideoCap ................................................................................................................... 78
6.20 XML_HeatMapPicInfo ........................................................................................................ 79
6.21 XML_HeatMapRegionList ................................................................................................... 79
6.22 XML_HeatMapRegion ........................................................................................................ 79
6.23 XML_HeatMapDataResult .................................................................................................. 80
6.24 XML_HeatMapDataDescription ......................................................................................... 80
6.25 XML_ResponseStatus ......................................................................................................... 81
6.26 JSON_EventNotificationAlert_Alarm/EventInfo ................................................................. 81
6.27 XML_EventCap ................................................................................................................... 82
6.28 XML_EventNotificationAlert_AlarmEventInfo ................................................................... 84
6.29 XML_EventNotificationAlert_HeartbeatInfo ...................................................................... 85
6.30 XML_EventTrigger .............................................................................................................. 86
6.31 XML_EventTriggerList ......................................................................................................... 88
6.32 XML_EventTriggerNotification ........................................................................................... 93
6.33 XML_EventTriggerNotificationList ...................................................................................... 93
6.34 XML_EventTriggersCap ...................................................................................................... 94
6.35 XML_EventTriggerCapType ................................................................................................ 96
6.36 XML_HttpHostNotification ................................................................................................. 97
6.37 XML_HttpHostNotificationCap ........................................................................................... 98
6.38 XML_HttpHostNotificationList ........................................................................................... 98
6.39 XML_HttpHostTestResult ................................................................................................. 100
6.40 XML_Schedule ................................................................................................................. 100
Appendix A. Error Codes in ResponseStatus ............................................................................ 117

iv
 Heat Map Application ISAPI User Manual

Chapter 1 Overview
This manual provides the integration methods and flows based on ISAPI protocol for heat map
applications.

1.1 Introduction
Heat map is a graphical representation of data represented by colors or other markers, and it is
usually used to analyze the visit times and dwell time of customers in a rule configured area.
Actually, the intersection analysis is an application of heat map at intersection. The heat map can
be classified as space heat map and time heat map according to statistics mode.
Space Heat Map
Shows the target activity pattern information, which is represented by color on picture of the rule
configured area, and the maximum and minimum values on the picture are given.
Time Heat Map
Shows the number of targets varying with dwell durations, which is represented by statistical
chart.

1.2 Update History

The update history shows the summary of changes during ISAPI integration according to different
products or projects, and the updated time.

Summary of Changes in Version 2.0_03/2019

Related Project Info: DS-9600NI Series, DS-7700NI Series, DS-7600NI Series, and DS-8600NI-K
Series Network Video Recorder V4.21.000
1. Extended heat map capability ( XML_Cap_HeatMap , related URL: /ISAPI/System/Video/
inputs/channels/<ID>/heatMap/capabilities ):
added four nodes, i.e., <FilterSize> (size filtering), <confidence> (whether supports setting
target picture confidence), <statisticalModel> (supported heat map statistics mode), and
<uploadHeatMapResultType> (heat map alarm type).
2. Extended parameter message of heat map configuration ( XML_HeatMap , related URL: /ISAPI/
System/Video/inputs/channels/<ID>/heatMap ):
added three nodes, i.e., <FilterSize> (size filtering), <confidence> (whether supports setting
target picture confidence), and <uploadHeatMapResultType> (heat map alarm type).
3. Extended condition message of heat map data search ( XML_HeatMapDataDescription , related
URLs: /ISAPI/System/Video/inputs/channels/<ID>/heatMap/search and /ISAPI/System/
Video/inputs/channels/<ID>/heatMap/pictureInfo ):
added a node, i.e., <statisticalModel> (supported heat map statistics mode).

1
 Heat Map Application ISAPI User Manual

4. Extended query parameters of heat map picture search (related URL: /ISAPI/System/Video/
inputs/channels/<ID>/heatMap/picture ):
added a parameter, i.e., statisticalModel (supported heat map statistics mode).
5. Extended device capability, intelligent channel capability, and event capability
( XML_DeviceCap , XML_IntelliCap , and XML_EventCap , related URLs: /ISAPI/System/
capabilities , /ISAPI/Intelligent/channels/<ID>/capabilities , and /ISAPI/Event/capabilities ):
added a node, i.e., <isSupportIntersectionAnalysis> (whether supports intersection analysis).
6. Extended device event channel capability ( XML_ChannelEventCap , related URL: /ISAPI/Event/
channels/<ID>/capabilities ):
added two values to event type node (<eventType>), i.e., "intersectionAnalysis" and "heatMap".
7. Extended alarm linkage action capability ( XML_EventTriggersCap , related URL: /ISAPI/Event/
triggersCap ):
added a node, i.e., <IntersectionAnalysisCap> (whether supports setting linkage action for
intersection analysis alarm).
8. Extended parameter message of alarm linkage action configuration ( XML_EventTrigger ,
related URL: /ISAPI/Event/triggers/<ID> ):
added two values to event type node (<eventType>), i.e., "intersectionAnalysis" and "heatMap".
9. Added URLs to configure arming schedule for an or multiple intersection analysis alarm(s):.
Get arming schedule of an intersection analysis alarm: GET /ISAPI/Event/schedules/
intersectionAnalysis/<ID>
Get arming schedules of multiple intersection analysis alarms: GET /ISAPI/Event/schedules/
intersectionAnalysis
Set arming schedule for an intersection analysis alarm: PUT /ISAPI/Event/schedules/
intersectionAnalysis/<ID>
Set arming schedules of multiple intersection analysis alarms: PUT /ISAPI/Event/schedules/
intersectionAnalysis
10. Added URL to get intersection analysis capability: GET /ISAPI/Intelligent/channels/<ID>/
intersectionAnalysis/capabilities?format=json
11. Added URL to configure intersection analysis:
Get intersection analysis parameters: GET /ISAPI/Intelligent/channels/<ID>/
intersectionAnalysis?format=json
Set intersection analysis parameters: PUT /ISAPI/Intelligent/channels/<ID>/
intersectionAnalysis?format=json
12. Added URL to search for intersection analysis results: POST /ISAPI/Intelligent/channels/<ID>/
intersectionAnalysis/search?format=json
13. Added alarm details message of different heat map alarms and intersection analysis alarm:
JSON_EventNotificationAlert_HeatMapAlarmMsg .

Summary of Changes in Version 2.0_02/2019

New document.

2
 Heat Map Application ISAPI User Manual

Chapter 2 Configure Heat Map Alarm

The heat map contains three types, i.e., standard heat map, heat map of dwell duration, and heat
map of people counting. For standard heat map, it calculates the dwell durations of all targets in a
rule configured area, and it supports statistics by space and time; for heat map of dwell duration,
the dwell durations of same target type are calculated by space or time; for heat map of people
counting, the number of dwell people and number of exited people are calculated by space or
time. You can configure heat map rules to start data statistics, and set linkage action or arming
schedule to regularly upload heat map as alarms to monitoring center for real-time analysis.
Steps

Figure 2-1 Programming Flow of Configuring Heat Map Alarm

1. Get device or channel capability by the request URL: GET /ISAPI/System/capabilities or /ISAPI/
System/Video/capabilities to check if heat map function is supported.
The device capability or channel capability is returned in the message XML_DeviceCap or
XML_VideoCap .

3
 Heat Map Application ISAPI User Manual

If the node <isSupportHeatmap> is returned in each capability message, it indicates that heat
map function is supported and you can perform the following steps; otherwise, this function is
not supported, please end this task.
2. Optional: Get configuration capability of heat map by the request URL: GET /ISAPI/System/
Video/inputs/channels/<ID>/heatMap/capabilities to check the supported configuration
parameters.
The heat map configuration capability is returned in the message XML_Cap_HeatMap .
3. Set heat map rule and region parameters by the request URL: PUT /ISAPI/System/Video/
inputs/channels/<ID>/heatMap .

Note
• The statistics region(s) of heat map can also be configured by the request URLs: /ISAPI/
System/Video/inputs/channels/<ID>/heatMap/regions/<ID> or /ISAPI/System/Video/
inputs/channels/<ID>/heatMap/regions .
• Before setting rule or region parameters, you can call the configuration URLs by GET method
to get default or configured parameters for reference.

4. Optional: Perform the following operation(s) to search heat map information.

Search Heat Map Report GET or POST /ISAPI/System/Video/inputs/channels/
<ID>/heatMap/search
Get Heat Map Picture GET /ISAPI/System/Video/inputs/channels/<ID>/
heatMap/picture
Get Heat Map Picture GET /ISAPI/System/Video/inputs/channels/<ID>/
Information heatMap/pictureInfo
5. Set linkage action of a heat map alarm by the request URL: PUT /ISAPI/Event/triggers/<ID> .

Note
To receive alarm in platform, the linkage action should be set to "center" (upload to center).
6. Set arming schedule of a heat map alarm by the request URL: PUT /ISAPI/Event/schedules/
heatMaps/<ID> .
7. Optional: Receive heat map alarm in arming mode (see Receive Alarm/Event in Arming Mode )
or listening mode (see Receive Alarm/Event in Listening Mode ) when the alarm is triggered.
The heat map alarm (including heat map of dwell duration and people counting) is returned by
the message JSON_EventNotificationAlert_HeatMapAlarmMsg , and the corresponding alarm
type (eventType) is "heatmap".

4
 Heat Map Application ISAPI User Manual

Chapter 3 Configure Intersection Analysis Alarm

Intersection analysis function helps to detect the targets' entry and exiting behaviors of the drawn
detection region (polygon, up to 10 edges are allowed and each edge will be marked from A to J) at
an intersection (more than two patterns intersected) and calculate the entered targets' number.
The number is accumulated when the region edges for entry and exiting of a target are different,
for example, if the target entered from edge A, and exited from edge B, the number will plus 1.
And the statistics result will be stored in SD card and uploaded to center per 60 minutes for
searching by time or intersection.

5
 Heat Map Application ISAPI User Manual

Steps

Figure 3-1 Programming Flow of Configuring Intersection Analysis Alarm

6
 Heat Map Application ISAPI User Manual

1. Get device or channel capability by the request URL: GET /ISAPI/System/capabilities or /ISAPI/
Intelligent/channels/<ID>/capabilities to check if intersection analysis is supported.
The device capability or channel capability is returned in the message XML_DeviceCap or
XML_IntelliCap .
If the node <isSupportIntersectionAnalysis> is returned in each capability message, it indicates
that intersection analysis is supported and you can perform the following steps; otherwise, this
function is not supported, please end this task.
2. Optional: Get configuration capability of intersection analysis rule by the request URL: GET /
ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/capabilities?format=json to check the
supported rule configuration parameters.
The rule configuration capability is returned in the message JSON_IntersectionAnalysisCap .
3. Set intersection analysis rule by the request URL: PUT /ISAPI/Intelligent/channels/<ID>/
intersectionAnalysis?format=json .

Note
Before setting rule, you'd better call the URL by GET method to get the default or configured
parameters for reference.
4. Get event capability by the request URL: GET /ISAPI/Event/capabilities to check if setting
intersection analysis alarm is supported.
The event capability is returned in the message XML_EventCap .
If the node <isSupportIntersectionAnalysis> is returned in the capability message, it indicates
that setting intersection analysis alarm is supported and you can perform the following steps;
otherwise, it is not supported, please end this task.
5. Set linkage action for intersection analysis alarm.
1) Optional: Get alarm linkage capability by the request URL: GET /ISAPI/Event/triggersCap to
get the supported linkage actions.
2) Optional: Get default or configured linkage action of an or multiple intersection analysis
alarm(s) by the request URL: GET /ISAPI/Event/triggers/<ID> or /ISAPI/Event/triggers for
reference.
3) Set linkage action of an intersection analysis alarm by the request URL: PUT /ISAPI/Event/
triggers/<ID> .

Note
To receive alarm in platform or system, the linkage action should be set to "center" (upload to
center).
6. Set arming schedule of an or multiple intersection analysis alarm(s) by the request URL: PUT /
ISAPI/Event/schedules/intersectionAnalysis/<ID> or /ISAPI/Event/schedules/
intersectionAnalysis .

7
 Heat Map Application ISAPI User Manual

Note
Before setting arming schedule, you'd better call the URLs by GET method to get the default or
configured parameters for reference.
7. Optional: Search for the uploaded intersection analysis results by the request URL: POST /
ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/search?format=json .
8. Optional: Receive the uploaded intersection analysis alarm in arming mode (see details in
Receive Alarm/Event in Arming Mode ) when the alarm is triggered.
The intersection analysis alarm is returned by the message
JSON_EventNotificationAlert_HeatMapAlarmMsg , and the corresponding alarm type
(eventType) is "heatmap".

Result

Figure 3-2 Intersection Analysis Rule Settings

8
Heat Map Application ISAPI User Manual

Figure 3-3 Intersection Analysis Rule Settings

9
 Heat Map Application ISAPI User Manual

Chapter 4 Alarm/Event Receiving

When the alarm is triggered or the event occurred, if you have configured alarm/event uploading
parameters, you can receive and process the alarm/event information in the third-party platform
or system by calling the request URLs of OPEN ISAPI Protocol. Two modes are available for
receiving alarms, including arming mode and listening mode.
Arming Mode
When the alarm is triggered or event occurred, the third-party platform or system can send the
request URL to the device for getting the alarm/event stream, and then the device uploads the
response message with alarm/event information. See details in Receive Alarm/Event in Arming
Mode .
Listening Mode
When alarm is triggered or event occurred, the device uploads the alarm information
automatically, and then the third-party platform or system can receives the alarm/event by
configuring listening port of HTTP host server. See details in .

4.1 Receive Alarm/Event in Arming Mode

When alarm is triggered or event occurred, and the alarm/event linkage is configured, you can
send request message to device for getting the alarm/event stream, and then the device uploads
the corresponding response message, which contains alarm/event information.
Before You Start
Configure alarm/event and trigger the alarm/event. For configuring alarm/event parameters, refer
to the some typical applications of alarm/event configuration.

10
 Heat Map Application ISAPI User Manual

Steps

Figure 4-1 Programming Flow of Receiving Alarm/Event in Arming Mode

1. Get the alarm/event stream by the URL: GET /ISAPI/Event/notification/alertStream .
2. Check if the heartbeat receiving timed out or network disconnected.
- If the heartbeat keeps alive and the network still connected, perform the following step to
continue.
- If the heartbeat receiving timed out or network disconnected, perform the above step
repeatedly until reconnected.
3. Receive the alarm/event information and process the received data.
Example
Interaction Example of Receiving Data in Arming Mode (without Binary Picture Data)
GET /ISAPI/Event/notification/alertStream HTTP/1.1
Host: data_gateway_ip
Connection: Keep-Alive

HTTP/1.1 401 Unauthorized

Date: Sun, 01 Apr 2018 18:58:53 GMT
Server:
Content-Length: 178
Content-Type: text/html
Connection: keep-alive
Keep-Alive: timeout=10, max=99
WWW-Authenticate: Digest qop="auth", realm="IP Camera(C2183)",
nonce="4e5468694e7a42694e7a4d364f4449354d7a6b354d54513d", stale="FALSE"

GET /ISAPI/Event/notification/alertStream HTTP/1.1

Authorization: Digest username="admin",realm="IP
Camera(C2183)",nonce="4e5468694e7a42694e7a4d364f4449354d7a6b354d54513d",uri="/
ISAPI/Event/notification/

11
 Heat Map Application ISAPI User Manual

alertStream",cnonce="3d183a245b8729121ae4ca3d41b90f18",nc=00000001,qop="auth",re
sponse="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".

4.2 Receive Alarm/Event in Listening Mode

When alarm is triggered or event occurred, and the alarm/event linkage is configured, the device
uploads the alarm/event information automatically, you can receive the alarm/event by
configuring the listening port of HTTP host server.
Before You Start
Configure alarm/event and trigger the alarm/event. For configuring alarm/event parameters, refer
to the some typical applications of alarm/event configuration.

12
 Heat Map Application ISAPI User Manual

Steps

Figure 4-2 Programming Manual of Receiving Alarm/Event in Listening Mode

1. Optional: Get the capability of HTTP listening server via the URL: GET /ISAPI/Event/
notification/httpHosts/capabilities .
2. Set the parameters (including listening address and listening port) of HTTP listening server via
the URL: PUT /ISAPI/Event/notification/httpHosts .

Note
Before setting the listening server, you'd better perform GET operation on the above URL to get
the existing or configured parameters for reference.
3. Send the request URL: POST /ISAPI/Event/notification/httpHosts/<ID>/test to the listening
server to check whether it is working normally.
4. Receive the alarm/event information from the listening server by the URL: POST http://
ipAddress:portNo/url .
Example
Interaction Example of Receiving Data in Listening Mode
• with Binary Picture Data
//Request
POST requestUrl HTTP/1.1
Host: data_gateway_ip:port
Accept-Language: en-US
Date: YourDate
Content-Type: multipart/form-data;boundary=<frontier>
Content-Length: text_length
Connection: keep-alive

--<frontier>

13
 Heat Map Application ISAPI User Manual

Content-Disposition: form-data; name="Event_Type"

Content-Type: text/xml

<EventNotificationAlert/>
--<frontier>
Content-Disposition: form-data; name="Picture_Name"
Content-Length: image_length
Content-Type: image/pjpeg

[binary picture data]

--<frontier>--

//Response
HTTP/1.1 HTTP statusCode
Date: YourDate
Connection: close
• without Binary Picture Data
//Request
POST requestUrl HTTP/1.1
Host: data_gateway_ip:port
Accept-Language: en-US
Date: YourDate
Content-Type: text/xml;
Content-Length: text_length
Connection: Close

<EventNotificationAlert/>

//Response
HTTP/1.1 HTTP statusCode
Date: YourDate
Connection: close

Note
• The Host is the HTTP server domain name or IP address and port number.
• Some alarm data is in JSON format, so the Content-Type may be "text/xml" or "text/json".

14
 Heat Map Application ISAPI User Manual

Chapter 5 Request URL

The request URLs of OPEN ISPAI Protocol for realizing the functions in this manual are listed here
for reference. You can search for the URLs and view their definitions.

5.1 /ISAPI/Event/capabilities
Get the device event capability set.

Request URL Definition

Table 5-1 GET /ISAPI/Event/capabilities
Method GET
Description Get the device event capability set.
Query None.
Request None.
Response XML_EventCap

5.2 /ISAPI/Event/channels/<ID>/capabilities
Get event capabilities supported by the channel.

Request URL Definition

Table 5-2 GET /ISAPI/Event/channels/<ID>/capabilities
Method GET
Description Get event capabilities supported by the channel.
Query None.
Request None.
Response XML_ChannelEventCap

Remarks
The <ID> in the URL indicates the channel ID.

15
 Heat Map Application ISAPI User Manual

5.3 /ISAPI/Event/schedules/heatMaps/<ID>
Operations about arming schedule configuration of a heat map alarm.

Request URL Definition

Table 5-3 GET /ISAPI/Event/schedules/heatMaps/<ID>
Method GET
Description Get arming schedule of a heat map alarm.
Query None.
Request None.
Response Succeeded: XML_Schedule
Failed: XML_ResponseStatus
Table 5-4 PUT /ISAPI/Event/schedules/heatMaps/<ID>
Method PUT
Description Set arming schedule of a heat map alarm.
Query None.
Request XML_Schedule
Response XML_ResponseStatus

Remarks
The <ID> in the request URL refers to the heat map alarm ID.

5.4 /ISAPI/Event/schedules/intersectionAnalysis/<ID>
Operations about arming schedule configuration of an intersection analysis alarm.

Request URL Definition

Table 5-5 GET /ISAPI/Event/schedules/intersectionAnalysis/<ID>
Method GET
Description Get arming schedule of an intersection analysis alarm.
Query None.
Request None.
Response Succeeded: XML_Schedule

16
 Heat Map Application ISAPI User Manual

Failed: XML_ResponseStatus
Table 5-6 PUT /ISAPI/Event/schedules/intersectionAnalysis/<ID>
Method PUT
Description Set arming schedule of an intersection analysis alarm.
Query None.
Request XML_Schedule
Response XML_ResponseStatus

Remarks
The <ID> in the request URL refers to the intersection analysis alarm ID.

5.5 /ISAPI/Event/schedules/intersectionAnalysis
Operations about arming schedule configuration of multiple intersection analysis alarms.

Request URL Definition

Table 5-7 GET /ISAPI/Event/schedules/intersectionAnalysis
Method GET
Description Get arming schedule of multiple intersection analysis alarms.
Query None.
Request None.
Response Succeeded: XML_InputScheduleList
Failed: XML_ResponseStatus
Table 5-8 PUT /ISAPI/Event/schedules/intersectionAnalysis
Method PUT
Description Set arming schedule for multiple intersection analysis alarms.
Query format: determine the format of request or response message.
Request XML_InputScheduleList
Response XML_ResponseStatus

5.6 /ISAPI/Event/triggers
Get linkage actions of multiple alarms.

17
 Heat Map Application ISAPI User Manual

Request URL Definition

Table 5-9 GET /ISAPI/Event/triggers
Method GET
Description Get linkage actions of multiple alarms.
Query None.
Request None.
Response XML_EventTriggerList

5.7 /ISAPI/Event/triggers/<ID>
Operations about linkage action configuration of an alarm.

Request URL Definition

Table 5-10 GET /ISAPI/Event/triggers/<ID>
Method GET
Description Get the linkage actions of an alarm.
Query None.
Request None.
Response XML_EventTrigger
Table 5-11 PUT /ISAPI/Event/triggers/<ID>
Method PUT
Description Set the linkage actions for an alarm.
Query None.
Request XML_EventTrigger
Response XML_ResponseStatus
Table 5-12 DELETE /ISAPI/Event/triggers/<ID>
Method DELETE
Description Delete the linkage actions of an alarm.
Query None.

18
 Heat Map Application ISAPI User Manual

Request None.
Response XML_ResponseStatus

Remarks
The <ID> in the request URL is defined as the No. of the alarm triggered channel. For example, if
the No. of the video input channel triggered by face capture alarm is 1, the <ID> is "faceSnap-1".

5.8 /ISAPI/Event/triggersCap
Get configuration capability of alarm linkage actions.

Request URL Definition

Table 5-13 GET /ISAPI/Event/triggersCap
Method GET
Description Get configuration capability of alarm linkage actions.
Query None.
Request None.
Response XML_EventTriggersCap

5.9 /ISAPI/Intelligent/channels/<ID>/capabilities
Get the intelligent function capability of device.

Request URL Definition

Table 5-14 GET /ISAPI/Intelligent/channels/<ID>/capabilities
Method GET
Description Get the intelligent function capability of device.
Query None.
Request None.
Response XML_IntelliCap

Remarks
The <ID> in the URL refers to the video input channel ID of device.

19
 Heat Map Application ISAPI User Manual

5.10 /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/search?
format=json
Search intersection analysis results.

Request URL Definition

Table 5-15 POST /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/search?format=json
Method POST
Description Search intersection analysis results.
Query format: determine the format of request or response message.
Request JSON_IntersectionAnalysisSearchCond
Response JSON_IntersectionAnalysisSearchResult

Remarks
The <ID> in the request URL refers to channel No.

5.11 /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis?format=json
Operations about rule configuration of intersection analysis.

Request URL Definition

Table 5-16 GET /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis?format=json
Method GET
Description Get rule parameters of intersection analysis.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_IntersectionAnalysis
Failed: JSON_ResponseStatus
Table 5-17 PUT /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis?format=json
Method PUT
Description Set rule for intersection analysis.
Query format: determine the format of request or response message.

20
 Heat Map Application ISAPI User Manual

Request JSON_IntersectionAnalysis
Response JSON_ResponseStatus

Remarks
The <ID> in the request URL refers to the channel No.

5.12 /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/capabilities?
format=json
Get intersection analysis capability.

Request URL Definition

Table 5-18 GET /ISAPI/Intelligent/channels/<ID>/intersectionAnalysis/capabilities?format=json
Method GET
Description Get intersection analysis capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_IntersectionAnalysisCap
Failed: JSON_ResponseStatus

Remarks
The <ID> in the request URL refers to the channel No.

5.13 /ISAPI/System/capabilities
Get device capability.

Request URL Definition

Table 5-19 GET /ISAPI/System/capabilities
Method GET
Description Get device capability.
Query None.
Request None.
Response Succeeded: XML_DeviceCap
Failed: XML_ResponseStatus

21
 Heat Map Application ISAPI User Manual

5.14 /ISAPI/System/Video/capabilities
Get device capability.

Request URL Definition

Table 5-20 GET /ISAPI/System/Video/capabilities
Method GET
Description Get the device video capability set.
Query None.
Request None.
Response XML_VideoCap

5.15 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/capabilities
Get configuration capability of heat map statistics.

Request URL Definition

Table 5-21 GET /ISAPI/System/Video/inputs/channels/<ID>/heatMap/capabilities
Method GET
Description Get configuration capability of heat map statistics.
Query None.
Request None.
Response Succeeded: XML_Cap_HeatMap
Failed: XML_ResponseStatus

Remarks
The <ID> in the request URL refers to channel No.

5.16 /ISAPI/System/Video/inputs/channels/<ID>/heatMap
Operations about configuration of heat map statistics.

22
 Heat Map Application ISAPI User Manual

Request URL Definition

Table 5-22 GET /ISAPI/System/Video/inputs/channels/<ID>/heatMap
Method GET
Description Get parameters of heat map statistics.
Query None.
Request None.
Response Succeeded: XML_HeatMap
Failed: XML_ResponseStatus
Table 5-23 PUT /ISAPI/System/Video/inputs/channels/<ID>/heatMap
Method PUT
Description Set parameters of heat map statistics.
Query None.
Request XML_HeatMap
Response XML_ResponseStatus

Remarks
The <ID> in the request URL refers to channel No.

5.17 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/pictureInfo
Get heat map picture information.

Request URL Definition

Table 5-24 GET /ISAPI/System/Video/inputs/channels/<ID>/heatMap/pictureInfo
Method GET
Description Get heat map picture information.
Query None.
Request XML_HeatMapDataDescription
Response Succeeded: XML_HeatMapPicInfo
Failed: XML_ResponseStatus

Remarks
The <ID> in the request URL refers to channel No.

23
 Heat Map Application ISAPI User Manual

5.18 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/picture
Get heat map picture.

Request URL Definition

Table 5-25 GET /ISAPI/System/Video/inputs/channels/<ID>/heatMap/picture
Method GET
Description Get heat map picture.
Query starttime: start time of heat map statistics, which should be in
ISO8601 time format.
endtime: end time of heat map statistics, which should be in ISO8601
time format.
statisticalModel: statistics type, which equals to "PDC" (people
counting statistics) or "duration" (stay duration statistics).
Request None.
Response Return a picture, which is transferred over HTTP.

Remarks
The <ID> in the request URL refers to channel No. The actual URL format is /ISAPI/System/Video/
inputs/channels/<ID>/heatMap/picture?starttime=&endtime=&statisticalModel=, e.g., "/ISAPI/
System/Video/inputs/channels/<ID>/heatMap/picture?
starttime=2014-01-11T11:00:00+08:00&endtime=2014-01-11T11:59:59+08:00&statisticalModel=d
uration".

5.19 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions
Operations about multiple statistics regions' configuration of heat map.

Request URL Definition

Table 5-26 GET /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions
Method GET
Description Get multiple statistics regions' parameters of heat map.
Query None.
Request None.
Response Succeeded: XML_HeatMapRegionList

24
 Heat Map Application ISAPI User Manual

Failed: XML_ResponseStatus
Table 5-27 PUT /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions
Method PUT
Description Set multiple statistics regions for heat map.
Query None.
Request XML_HeatMapRegionList
Response XML_ResponseStatus
Table 5-28 POST /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions
Method POST
Description Add a statistics region for heat map.
Query None.
Request XML_HeatMapRegion
Response XML_ResponseStatus
Table 5-29 DELETE /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions
Method DELETE
Description Delete multiple statistics regions of heat map.
Query None.
Request None.
Response XML_ResponseStatus

Remarks
The <ID> in the request URL refers to channel No.

5.20 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions/
<ID>
Operations about a statistics region configuration of heat map.

Request URL Definition

Table 5-30 GET /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions/<ID>
Method GET
Description Get a statistics region parameter of heat map.

25
 Heat Map Application ISAPI User Manual

Query None.
Request None.
Response Succeeded: XML_HeatMapRegion
Failed: XML_ResponseStatus
Table 5-31 PUT /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions/<ID>
Method GET
Description Set a statistics region for heat map.
Query None.
Request XML_HeatMapRegion
Response XML_ResponseStatus
Table 5-32 DELETE /ISAPI/System/Video/inputs/channels/<ID>/heatMap/regions/<ID>
Method GET
Description Delete a statistics region of heat map.
Query None.
Request None.
Response XML_ResponseStatus

Remarks
The first <ID> in the request URL refers to the channel No., and the second <ID> is the region ID.

5.21 /ISAPI/System/Video/inputs/channels/<ID>/heatMap/search
Search for heat map reports.

Request URL Definition

Table 5-33 GET or POST /ISAPI/System/Video/inputs/channels/<ID>/heatMap/search
Method GET or POST
Description Search for heat map reports.
Query None.
Request XML_HeatMapDataDescription
Response Succeeded: XML_HeatMapDataResult
Failed: XML_ResponseStatus

26
 Heat Map Application ISAPI User Manual

Remarks
The <ID> in the request URL refers to the channel No.

5.22 /ISAPI/Event/capabilities
Get the device event capability set.

Request URL Definition

Table 5-34 GET /ISAPI/Event/capabilities
Method GET
Description Get the device event capability set.
Query None.
Request None.
Response XML_EventCap

5.23 /ISAPI/Event/notification/alertStream
Get the uploaded heartbeat or alarm/event information.

Request URL Definition

Table 5-35 GET /ISAPI/Event/notification/alertStream
Method GET
Description Get the heartbeat or uploaded alarm/event information.
Query None.
Request None.
Response Option 1: XML_EventNotificationAlert_AlarmEventInfo or
XML_EventNotificationAlert_HeartbeatInfo
Option 2: JSON_EventNotificationAlert_Alarm/EventInfo

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.

27
 Heat Map Application ISAPI User Manual

Remarks
• After calling this URL, 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.

5.24 /ISAPI/Event/notification/httpHosts
Operations about configurations of all listening host servers.

Request URL Definition

Table 5-36 GET /ISAPI/Event/notification/httpHosts
Method GET
Description Get the configurations of all listening host servers.
Query security: the version No. of encryption scheme. When security does
not exist, it indicates that the data is not encrypted; when security is
1, it indicates that the nodes of sensitive information in the message
are encrypted in AES128 CBC mode; when security is 2, it indicates
that the nodes of sensitive information in the message are encrypted
in AES256 CBC mode.
Request None.
Response XML_HttpHostNotificationList
Table 5-37 PUT /ISAPI/Event/notification/httpHosts
Method PUT
Description Set the configurations of all listening host servers.
Query security: the version No. of encryption scheme. When security does
not exist, it indicates that the data is not encrypted; when security is
1, it indicates that the nodes of sensitive information in the message
are encrypted in AES128 CBC mode; when security is 2, it indicates
that the nodes of sensitive information in the message are encrypted
in AES256 CBC mode.
Request XML_HttpHostNotificationList
Response XML_ResponseStatus

28
 Heat Map Application ISAPI User Manual

Table 5-38 POST /ISAPI/Event/notification/httpHosts

Method POST
Description Add a listening host server.
Query security: the version No. of encryption scheme. When security does
not exist, it indicates that the data is not encrypted; when security is
1, it indicates that the nodes of sensitive information in the message
are encrypted in AES128 CBC mode; when security is 2, it indicates
that the nodes of sensitive information in the message are encrypted
in AES256 CBC mode.
Request XML_HttpHostNotification
Response XML_ResponseStatus
Table 5-39 DELETE /ISAPI/Event/notification/httpHosts
Method DELETE
Description Delete the configurations of all listening host servers.
Query None.
Request None.
Response XML_ResponseStatus

5.25 /ISAPI/Event/notification/httpHosts/<ID>/test
Detect whether the listening host server is working normally.

Request URL Definition

Table 5-40 POST /ISAPI/Event/notification/httpHosts/<ID>/test
Method POST
Description Detect whether the listening host server is working normally.
Query None.
Request XML_HttpHostNotification
Response XML_HttpHostTestResult

Remarks
The <ID> in the URL is the listening host server ID.

29
 Heat Map Application ISAPI User Manual

5.26 /ISAPI/Event/notification/httpHosts/capabilities
Get the configuration capabilities of all listening host servers.

Request URL Definition

Table 5-41 GET /ISAPI/Event/notification/httpHosts/capabilities
Method GET
Description Get the configuration capabilities of all listening host servers.
Query None.
Request None.
Response XML_HttpHostNotificationCap

5.27 /ISAPI/Event/triggers
Get linkage actions of multiple alarms.

Request URL Definition

Table 5-42 GET /ISAPI/Event/triggers
Method GET
Description Get linkage actions of multiple alarms.
Query None.
Request None.
Response XML_EventTriggerList

5.28 /ISAPI/Event/triggersCap
Get configuration capability of alarm linkage actions.

Request URL Definition

Table 5-43 GET /ISAPI/Event/triggersCap
Method GET
Description Get configuration capability of alarm linkage actions.
Query None.

30
 Heat Map Application ISAPI User Manual

Request None.
Response XML_EventTriggersCap

5.29 /ISAPI/Event/triggers/<ID>
Operations about linkage action configuration of an alarm.

Request URL Definition

Table 5-44 GET /ISAPI/Event/triggers/<ID>
Method GET
Description Get the linkage actions of an alarm.
Query None.
Request None.
Response XML_EventTrigger
Table 5-45 PUT /ISAPI/Event/triggers/<ID>
Method PUT
Description Set the linkage actions for an alarm.
Query None.
Request XML_EventTrigger
Response XML_ResponseStatus
Table 5-46 DELETE /ISAPI/Event/triggers/<ID>
Method DELETE
Description Delete the linkage actions of an alarm.
Query None.
Request None.
Response XML_ResponseStatus

Remarks
The <ID> in the request URL is defined as the No. of the alarm triggered channel. For example, if
the No. of the video input channel triggered by face capture alarm is 1, the <ID> is "faceSnap-1".

31
 Heat Map Application ISAPI User Manual

5.30 http://ipAddress:portNo/url
Listening host sever sends alarm information to alarm center.

Request URL Definition

Table 5-47 POST http://ipAddress:portNo/url
Method POST
Description Listening host sever sends alarm information to alarm center.
Query None.
Request None.
Response XML_EventNotificationAlert_AlarmEventInfo or
JSON_EventNotificationAlert_Alarm/EventInfo

Remarks
The default port number in the URL is 80, so the URL without port number is also valid.

32
 Heat Map Application ISAPI User Manual

Chapter 6 Request and Response Message

The request and response messages in XML or JSON format of each request URL are listed here for
reference. You can search for the parameters by the message name.

6.1 JSON_EventNotificationAlert_HeatMapAlarmMsg
The heat map statistics results are uploaded in the JSON format of EventNotificationAler message.
{
"ipAddress": "",
"ipv6Address: "",
"portNo": ,
"protocol": "",
"macAddress": "",
"channelID": ,
"dateTime": "",
"activePostCount": ,
"eventType": "",
"eventState": "",
"eventDescription": "",
/*refer to the message JSON_EventNotificationAlert_Alarm/EventInfo for
description details of the above nodes*/
"channelName": "",
/*required, string type, camera name*/
"deviceID": "",
/*optional, string type, device ID, which must be uploaded when communicating
based on EHome protocol*/
"HeatMapValueStatistics":{
/*required, heat map statistics*/
"startTime":"",
/*required, string type, start time of statistics, which is in iOS_8601 time
format, e.g., 2018-04-24T16:56:43.000+08:00*/
"endTime":"",
/*required, string type, end time of statistics, which is in iOS_8601 time
format, e.g., 2018-04-24T16:56:43.000+08:00*/
"statisticsType":"",
/*required, string type, statistics type, "PDC"-by number of people, "DURATION"-
by stay duration, "INTERSECTION"-by number of people at intersection*/
"HeatMapValue":[{
/*required, structured heat map information list*/
"heatmapDataType":"",
/*optional, string type, heat map type: "PDC_stayNum"-heat map for people stay
duration, "PDC_leaveNum"-heat map for exited people, this node is valid only
when statisticsType is "PDC"*/
"maxHeatMapValue": ,
/*required, 4-byte integer type, maximum value in heat map*/
"minHeatMapValue": ,

33
 Heat Map Application ISAPI User Manual

/*required, 4-byte integer type, minimum value in heat map*/

"timeHeatMapValue": ,
/*required, 4-byte integer type, average value in heat map*/
"lineValue": ,
/*required, 4-byte integer type, average pixel value of a row in heat map*/
"columnValue": ,
/*required, 4-byte integer type, average pixel value of a column in heat map*/
"curNumber": ,
/*optional, integer type, current number of people, this node is valid only
when statisticsType is "PDC"*/
"leaveNumber": ,
/*optional, integer type, number of exited people, this node is valid only when
statisticsType is "PDC"*/
"totalTime":
/*optional, integer type, total stay time duration, unit: second, this node is
valid only when statisticsType is "DURATION"*/
},
{
"heatmapDataType":"",
/*optional, string type, heat map type: "PDC_stayNum"-heat map for people stay
duration, "PDC_leaveNum"-heat map for exited people, this node is valid only
when statisticsType is "PDC"*/
"maxHeatMapValue": ,
/*required, 4-byte integer type, maximum value in heat map*/
"minHeatMapValue": ,
/*required, 4-byte integer type, minimum value in heat map*/
"timeHeatMapValue":,
/*required, 4-byte integer type, average value in heat map*/
"lineValue":,
/*required, 4-byte integer type, average pixel value of a row in heat map*/
"columnValue":
/*required, 4-byte integer type, average pixel value of a column in heat map*/
"curNumber": ,
/*optional, integer type, current number of people, this node is valid only
when statisticsType is "PDC"*/
"leaveNumber": ,
/*optional, integer type, number of exited people, this node is valid only when
statisticsType is "PDC"*/
"totalTime":
/*optional, integer type, total stay time duration, unit: second, this node is
valid only when statisticsType is "DURATION"*/
}]
}
}

See Also
JSON_EventNotificationAlert_Alarm/EventInfo
Example
Example of Heat Map Alarm Message

34
 Heat Map Application ISAPI User Manual

{
"ipAddress": "10.16.96.31",
"portNo": 80,
"protocol": "HTTP",
"macAddress": "18:68:cb:86:1c:5e",
"channelID": 1,
"dateTime": "2018-04-24T16:56:43.000+08:00",
"activePostCount": 1,
"eventType": "heatmap",
"eventState": "active",
"eventDescription": "HeatMap Value",
"channelName": "Channel Name",
"deviceID": "Device ID",
"HeatMapValueStatistics":{
"startTime":"2018-04-24T16:56:43.000+08:00",
"endTime":"2018-04-25T16:56:43.000+08:00",
"statisticsType":"PDC",
"HeatMapValue":[{
"heatmapDataType":"PDC_stayNum",
"maxHeatMapValue":,
"minHeatMapValue":,
"timeHeatMapValue":,
"lineValue":,
"columnValue":
},
{
"heatmapDataType":"PDC_leaveNum",
"maxHeatMapValue":,
"minHeatMapValue":,
"timeHeatMapValue":,
"lineValue":,
"columnValue":
}]
}
}

6.2 JSON_IntersectionAnalysisSearchCond
IntersectionAnalysisSearchCond message in JSON format
{
"searchID": "",
/*required, string type, search ID, which will not change if the conditions do
not change*/
"searchResultPosition": ,
/*required, integer32 type, the start position in the list of search results,
which is used to mark the search position when there are too many matched
results*/
"maxResultNumber": ,
/*required, integer32 type, maximum results can be searched for once*/

35
 Heat Map Application ISAPI User Manual

"maxResults": ,
"reportType": "",
/*required, report type: "daily, weekly, monthly, yearly"*/
"startTime": "",
/*required, string type, statistics start time, which is in iOS_8601 time
format*/
"endTime": "",
/*required, string type, statistics end time, which is in iOS_8601 time format*/
"entranceID": "",
/*required, edge ID of statistics region*/
}

6.3 JSON_IntersectionAnalysisSearchResult
IntersectionAnalysisSearchResult message in JSON format
{
"responseStatusStrg": "",
/*required, string type, search status desciption: "OK"-search ended, "MORE"-
searching, "NO_MATCHES"-no data found*/
"numOfMatches": ,
/*required, integer32 type, number of matched results that returned for once*/
"totalMatches": ,
/*required, integer32 type, total number of matched results*/
"Data": [{
"startID": "",
/*required, start ID, which is returned by device*/
"endID": "",
/*required, end ID, which is returned by device*/
"PDC":
}]
}

6.4 JSON_IntersectionAnalysisCap
IntersectionAnalysisCap message in JSON format
{
"IntersectionAnalysisCap":{
"enabled":{
/*required, boolean type, whether to enable, "true,false"*/
"@opt": ["true", "false"]
},
"intersectionsNum":{
/*required, number of detection region edges*/
"@min": 3,
"@max": 10
},
"TagID":{

36
 Heat Map Application ISAPI User Manual

"isSupportID":{
/*whether supports intersection ID's description tag, [A,Z]*/
"@opt": ["A", "B", "C", "D"]
},
"isSupportIDPoint": ,
/*whether supports intersection ID's coordinates tag*/
"isSupportIDDirection":
/*whether supports intersection ID's direction*/
},
"searchReportType":{
"@opt": ["daily", "weekly", "monthly", "yearly"]
}
}
}

6.5 JSON_IntersectionAnalysis
IntersectionAnalysis message in JSON format
{
"IntersectionAnalysis":{
"enabled": ,
/*required, boolean type, whether to enable, "true,false"*/
"Region": [{
/*detection region, the number of edges is between 3 and 10*/
"x": ,
/*required, float type, x-coordinate, which is between 0.000 and 1*/
"y":
/*required, float type, y-coordinate, which is between 0.000 and 1*/
}],
"TagID": [{
"ID": "",
/*tag ID, range: A,B,C,D,E,…,Z*/
"Point":{
/*displayed tag coordinates*/
"x": ,
/*required, float type, x-coordinate, which is between 0.000 and 1*/
"y":
/*required, float type, x-coordinate, which is between 0.000 and 1*/
},
"iconStartPoint":{
"x": ,
/*required, float type, x-coordinate, which is between 0.000 and 1*/
"y":
/*required, float type, x-coordinate, which is between 0.000 and 1*/
},
"iconEndPoint":{
"x": ,
/*required, float type, x-coordinate, which is between 0.000 and 1*/
"y":

37
 Heat Map Application ISAPI User Manual

/*required, float type, x-coordinate, which is between 0.000 and 1*/

}
}]
}
}

6.6 JSON_ResponseStatus
ResponseStatus message in JSON format.
{
"requestURL":"",
/*optional, string type, request URL*/
"statusCode": ,
/*required, integer type, status code*/
"statusString":"",
/*required, string type, status description*/
"subStatusCode":"",
/*required, string type, sub status code*/
"errorCode": ,
/*optional, integer type, error code, which corresponds to subStatusCode, this
field is required when statusCode is not 1*/
"errorMsg":"",
/*optional, string type, error details, this field is required when statusCode
is not 1*/
}

Note
See Error Codes in ResponseStatus for details about the status codes, sub status codes, error
codes, and error descriptions.

6.7 XML_Cap_HeatMap
HeatMap capability message in XML format
<HeatMap version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<enabled opt="true,false"><!--required, xs: boolean, whether to enable heat
map function--></enabled>
<normalizedScreenSize>
<normalizedScreenWidth>
<!--normalized width, for front-end device, it is 1000-->
</normalizedScreenWidth>
<normalizedScreenHeight>
<!--normalized height, for front-end device, it is 1000-->
</normalizedScreenHeight>
</normalizedScreenSize>
<sensitivityLevel min="1" max="100" default="50">
<!--opt, xs: integer, sensitivity level, which is between 1 and 100, and

38
 Heat Map Application ISAPI User Manual

the default value is 50-->

</sensitivityLevel>
<backgroundUpdateRate min="1" max="100" default="50">
<!--opt, xs: integer, background updating speed, which is between 1 and
100, and the default value is 50-->
</backgroundUpdateRate>
<sceneChangeLevel min="1" max="100" default="50">
<!--opt, xs: integer, scene change level, which is between 1 and 100, and
the default value is 50-->
</sceneChangeLevel>
<targetTracking opt="true,false">
<!--opt, xs: boolean, whether to enable target tracking function-->
</targetTracking>
<minObjectSize min="1" max="100" default="50">
<!--opt, xs: integer, minimum target size, which is between 1 and 100, and
the default value is 50-->
</minObjectSize>
<HeatMapRegionList size="8" ><!--statistics region list of heat map-->
<HeatMapRegion>
<id><!--required, region ID--></id>
<RegionCoordinatesList size="10" min="4"></RegionCoordinatesList>
</HeatMapRegion>
<FilterSize><!--opt, filter size-->
<height min="0.008700" max="0.250000" def="0.013000"/><!--req, float,
height-->
<width min="0.008700" max="0.250000" def="0.013000"/><!--req, float,
width-->
<x min="0.000000" max="1.000000"/><!--req, float, x-coordinate of upper-
left vertex-->
<y min="0.000000" max="1.000000"/><!--req, float, y-coordinate of upper-
left vertex-->
</FilterSize>
</HeatMapRegionList>
<isSupportHeatMapPicInfo opt="true,false">
<!--whether supports getting heat map picture information-->
</isSupportHeatMapPicInfo>
<confidence min="0.00" max="100.00"/><!--opt, whether supports target
confidence, and the supported value range-->
<statisticalModel opt="duration,PDC",def="duration"/><!--opt, supported
statistics mode-->
<uploadHeatMapResultType opt="normal,durationAndPDC" def="normal">
<!--opt, xs: string, heat map alarm type-->
<uploadHeatMapResultType>
</HeatMap>

6.8 XML_ChannelEventCap
ChannelEventCap message in XML format

39
 Heat Map Application ISAPI User Manual

<ChannelEventCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">

<eventType opt="VMD,motionDetection,shelteralarm,
tamperDetection,videoLoss,ROI,facedetection,faceDetection,intelliTrace,fielddete
ction,fieldDetection,defocus,defocusDetection,audioexception,audioDetection,scen
echangedetection,sceneChangeDetection,linedetection,lineDetection,regionEntrance
,regionExiting,loitering,group,rapidMove,parking,unattendedBaggage,attendedBagga
ge,peopleDetection,storageDetection,behavior,faceCapture,faceSnap,ANPR,vehicleDe
tection,fireDetection,shipsDetection,PIR,targetCapture,humanRecognition,alarmRes
ult,faceContrast,framesPeopleCounting,hide,audioLoss,cameraAngleAnormaly,violent
Motion,trial,humanEnter,operateOverTime,stickUp,installScanner,faceDetect,temper
ature,temperatureDetection,peopleCounting,personQueueDetection,heatmap,mixedTarg
etDetection,MTD_face,MTD_human,MTD_vehicle,MTD_nonMotor,faceSnapModeling,HVTVehi
cleDetection,PictureCaptureComparision,IO,smokeDetection,smokeAndFireDetection,d
iskfull,diskerror,nicbroken,ipconflict,illaccess,personDensityDetection,AID,vehi
cleControl,vehicleRcogResult,cardMatch,overSpeed,highTempAlarm,abnormalAccelerat
ion,failDown,leavePosition,peopleNumChange,retention,running,thermometry,heatmap
PDC,heatmapDuration,intersectionAnalysis,AID_abandonedObject,AID_pedestrian,AID_
congestion,AID_roadBlock,AID_construction,AID_trafficAccident,AID_fogDetection,T
FS_illegalParking,TFS_wrongDirection,TFS_crossLane,TFS_laneChange,TFS_vehicleExi
st,TFS_turnRound,TFS_parallelParking,TPS"/>
<!--req, xs:string, event types supported by the channel-->
<shieldEventType opt="behavior,faceSnap,humanRecognition,faceCapture,
targetCapture"/>
<!--req, xs:string, event types that support area shield-->
<id><!--req, xs:integer, channel No.--></id>
</ChannelEventCap>

Remarks
The node <eventType> can be set to the following values: VMD, motionDetection, shelteralarm,
tamperDetection, videoLoss, ROI, facedetection, faceDetection, intelliTrace, fielddetection,
fieldDetection, defocus, defocusDetection, audioexception, audioDetection,
scenechangedetection, sceneChangeDetection, linedetection, lineDetection, regionEntrance,
regionExiting, loitering, group, rapidMove, parking, unattendedBaggage, attendedBaggage,
peopleDetection, storageDetection, behavior, faceCapture, faceSnap, ANPR, vehicleDetection,
fireDetection, shipsDetection, PIR, targetCapture, humanRecognition, alarmResult, faceContrast,
framesPeopleCounting, hide, audioLoss, cameraAngleAnormaly, violentMotion, trial, humanEnter,
operateOverTime, stickUp, installScanner, faceDetect, temperature, temperatureDetection,
peopleCounting, personQueueDetection, heatmap, mixedTargetDetection, MTD_face,
MTD_human, MTD_vehicle, MTD_nonMotor, faceSnapModeling, HVTVehicleDetection,
PictureCaptureComparision, IO, smokeDetection, smokeAndFireDetection, diskfull, diskerror,
nicbroken, ipconflict, illaccess, personDensityDetection, AID, vehicleControl, vehicleRcogResult,
cardMatch, overSpeed, highTempAlarm, abnormalAcceleration, failDown, leavePosition,
peopleNumChange, retention, running, thermometry, heatmapPDC, heatmapDuration,
intersectionAnalysis, AID_abandonedObject, AID_pedestrian, AID_congestion, AID_roadBlock,
AID_construction, AID_trafficAccident, AID_fogDetection, TFS_illegalParking, TFS_wrongDirection,
TFS_crossLane, TFS_laneChange, TFS_vehicleExist, TFS_turnRound, TFS_parallelParking, TPS.

40
 Heat Map Application ISAPI User Manual

Event Type Description

VMD (motionDetection) Motion detection
Shelteralarm (tamperDetection) Video tampering alarm
videoLoss Video loss
ROI Region of interest
facedetection (faceDetection) Face detection
intelliTrace Auto-track
fielddetection (fieldDetection) Intrusion detection
defocus (defocusDetection) Defocus detection
audioexception (audioDetection) Audio exception detection
scenechangedetection Sudden scene change detection
(sceneChangeDetection)
linedetection (lineDetection) Line-crossing detection
regionEntrance Region entrance detection
regionExiting Region exiting detection
loitering Loitering detection
group People gathering detection
rapidMove Fast moving detection
parking Parking detection
unattendedBaggage Unattended baggage
attendedBaggage Object removal detection
peopleDetection Human detection
storageDetection HDD health detection
behavior Behavior analysis
faceCapture(faceSnap) Face capture
ANPR(vehicleDetection) Vehicle detection
fireDetection Fire detection
shipsDetection Ship detection
PIR PIR alarm
targetCapture (humanRecognition) Target capture

41
 Heat Map Application ISAPI User Manual

Event Type Description

alarmResult (faceContrast) Face comparison
framesPeopleCounting People counting in single frame
hide Tampering detection
audioLoss Audio loss
cameraAngleAnormaly Image exception
violentMotion Violent motion
trial Tailing
humanEnter Human entrance
operateOverTime Operation timed out
stickUp Sticking scrip
installScanner Installing scanner
faceDetect ATM face detection
temperature (temperatureDetection) Temperature difference detection
PeopleCounting People counting
personQueueDetection People queuing-up detection
heatmap Heat map
mixedTargetDetection Multi-target-type detection
MTD_face Supported face attributes of multi-target-type
detection (MTD)
MTD_human Supported human attributes of multi-target-type
detection (MTD)
MTD_vehicle Supported motor vehicle attributes of multi-target-
type detection (MTD)
MTD_nonMotor Supported non-motor vehicle attributes of multi-
target-type detection (MTD)
faceSnapModeling Face capture modeling
HVTVehicleDetection Mixed-traffic detection
PictureCaptureComparision N:1 face comparison
IO Sensor alarm
smokeDetection Smoke detection

42
 Heat Map Application ISAPI User Manual

Event Type Description

smokeAndFireDetection Smoke and fire detection
diskfull HDD is full
diskerror HDD error
nicbroken Network disconnected
ipconflict IP address conflicted
illaccess Illegal access
personDensityDetection People density detection
vehicleControl Upload alarm of vehicle in whitelist and blacklist
vehicleRcogResult Vehicle secondary recognition
cardMatch Authentication
overSpeed Overspeed alarm
highTempAlarm High temperature alarm
abnormalAcceleration Abnormal accelerated speed alarm
failDown People falling down
leavePosition Absence detection
peopleNumChange The number of people changed
retention Overstay detection
running Running
thermometry Temperature measurement
heatmapPDC Heat map people counting
heatmapDuration Heat map people staying duration
intersectionAnalysis Intersection analysis
AID_abandonedObject Thrown object in traffic events
AID_pedestrian Pedestrian detection in traffic events
AID_​congestion Congestion detection in traffic events
AID_roadBlock Roadblock detection in traffic events
AID_​construction Construction detection in traffic events
AID_​trafficAccident Traffic accident detection in traffic events
AID_​fogDetection Fog detection in traffic events

43
 Heat Map Application ISAPI User Manual

Event Type Description

TFS_illegalParking Illegal parking of enforcement events
TFS_​wrongDirection Wrong-way driving of enforcement events
TFS_crossLane Driving on lane line of enforcement events
TFS_laneChange Lane change of enforcement events
TFS_vehicleExist Vehicle existing of enforcement events
TFS_turnRound Turning round of enforcement events
TFS_parallelParking Parallel parking of enforcement events
TPS Traffic data collection configuration

Note
The following event type values are updated to new version: VMD (motionDetection), Shelteralarm
(tamperDetection), facedetection (faceDetection), fielddetection (fieldDetection), defocus
(defocusDetection), audioexception (audioDetection), scenechangedetection
(sceneChangeDetection), linedetection (lineDetection), faceCapture (faceSnap), ANPR
(vehicleDetection), targetCapture (humanRecognition), alarmResult (faceContrast), and
temperature (temperatureDetection). The value in the bracket is the old version, and considering
the compatibility, both new and old value shoud be returned.

6.9 XML_DeviceCap
DeviceCap capability message in XML format
<DeviceCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SysCap><!--optional-->
<isSupportDst><!--optional, xs: boolean, whether supports daylight saving
time--></isSupportDst>
<NetworkCap/><!--optional, xs: boolean, whether supports metadata display-->
<IOCap/><!--optional-->
<SerialCap/><!--optional-->
<VideoCap/><!--optional, see details in the message XML_VideoCap-->
<AudioCap/><!--optional-->
<isSupportExternalDevice><!--optional, xs:boolean--></
isSupportExternalDevice>
<isSupportChangedUpload>
<!--opt, xs: boolean, whether supports uploading status changes-->
</isSupportChangedUpload>
<isSupportSimpleDevStatus>
<!--opt, xs: boolean, whether supports getting device working status-->
</isSupportSimpleDevStatus>
<isSupportFlexible>
<!--opt, xs: boolean, whether supports getting channel status by

44
 Heat Map Application ISAPI User Manual

condition-->
</isSupportFlexible>
<isSupportSubscribeEvent>
<!--optional, xs:boolean, "true,false", whether supports alarm or event
subscription-->
</isSupportSubscribeEvent>
<isSupportDiagnosedData>
<!--optional, xs:boolean, "true,false", whether supports diagnosis data-->
</isSupportDiagnosedData>
<isSupportTimeCap>
<!--opt, xs:boolean, corresponds to URL: /ISAPI/System/time/capabilities--
>
</isSupportTimeCap>
<isSupportPostUpdateFirmware>
<!--optional,xs:boolean,"true,false", whether supports upgrading the
firmware-->
</isSupportPostUpdateFirmware>
<isSupportPostConfigData>
<!--optional, xs:boolean,"true,false", whether supports importing or
exporting the configuration file-->
</isSupportPostConfigData>
<isSupportUserLock>
<!--optional, xs:boolean,"true,false", whether supports locking user-->
</isSupportUserLock>
<isSupportSoundCfg><!--optional, xs:boolean--></isSupportSoundCfg>
<isSupportMetadata>
<!--optional, xs:boolean, if it is supported, return "true", otherwise,
this node will not be returned-->
</isSupportMetadata>
</SysCap>
<voicetalkNums><!--optional, xs:integer--></voicetalkNums>
<isSupportSnapshot><!--optional, xs:boolean, "true, false"--></
isSupportSnapshot>
<SecurityCap/><!--optional-->
<EventCap/><!--optional-->
<ImageCap/><!--optional-->
<RacmCap/><!--optional-->
<SmartCap/><!--optional-->
<ThermalCap/><!--optional-->
<WLAlarmCap/><!--opt, wireless alarm capability-->
<SecurityCPCapabilities/><!--opt, whether supports security capability-->
<isSupportGIS>
<!--opt, xs:boolean, whether supports GIS capability-->
</isSupportGIS>
<isSupportCompass>
<!--opt, xs:boolean-->
</isSupportCompass>
<isSupportRoadInfoOverlays>
<!--opt, xs:boolean-->
</isSupportRoadInfoOverlays>
<isSupportFaceCaptureStatistics>
<!--opt, xs:boolean-->

45
 Heat Map Application ISAPI User Manual

</isSupportFaceCaptureStatistics>
<isSupportElectronicsEnlarge>
<!--opt, xs:boolean, whether supports digital zoom-->
</isSupportElectronicsEnlarge>
<isSupportCloud>
<!--opt, xs:boolean-->
</isSupportCloud>
<isSupportRecordHost>
<!--opt, xs:boolean-->
</isSupportRecordHost>
<isSupportEagleEye>
<!--opt, xs:boolean, whether supports PanoVu series camera-->
</isSupportEagleEye>
<isSupportPanorama>
<!--opt, xs:boolean, whether supports panorama-->
</isSupportPanorama>
<isSupportFirmwareVersionInfo>
<!--opt, xs:boolean, whether supports displaying firmware version
information-->
</isSupportFirmwareVersionInfo>
<isSupportExternalWirelessServer>
<!--opt, xs: boolean-->
</isSupportExternalWirelessServer>
<isSupportSetupCalibration>
<!--opt, xs:boolean, whether supports setting calibration-->
</isSupportSetupCalibration>
<isSupportGetmutexFuncErrMsg>
<!--opt, xs:boolean, whether supports getting mutex information-->
</isSupportGetmutexFuncErrMsg>
<isSupportlaserSpotManual>
<!--opt, boolean, whether supports laser spot configuration-->
</isSupportlaserSpotManual>
<isSupportLaserSpotAdjustment>
<!--opt, boolean, whether supports adjusting laser spot size-->
</isSupportLaserSpotAdjustment>
<VideoIntercomCap/><!--optional, whether supports video intercom capability-->
<isSupportSafetyCabin>
<!--opt, xs:boolean-->
</isSupportSafetyCabin>
<isSupportPEA>
<!--opt, xs:boolean, whether supports one-touch security control panel
capability-->
</isSupportPEA>
<isSupportCurrentLock>
<!--opt, xs:boolean, whether supports locking current configuration-->
</isSupportCurrentLock>
<isSupportPicInfoOverlap>
<!--optional, xs:boolean, whether support picture information overlay-->
</isSupportPicInfoOverlap>
<isSupportPlay>
<!--opt, xs: boolean, whether supports live view: "true,false"-->
</isSupportPlay>

46
 Heat Map Application ISAPI User Manual

<isSupportPlayback>
<!--opt, xs: boolean, whether supports playback: "true,false"-->
</isSupportPlayback>
<UHFRFIDReader>
<!--opt-->
<isSupportBasicInformation>
<!--opt, xs:boolean-->
</isSupportBasicInformation>
<isSupportHardDiskStorageTest>
<!--opt, xs:boolean-->
</isSupportHardDiskStorageTest>
</UHFRFIDReader>
<isSupportIntelligentStructureAnalysis>
<!--opt, xs:boolean, whether supports structured VCA-->
</isSupportIntelligentStructureAnalysis>
<isSupportIntelligentAnalysisEngines>
<!--opt, xs:boolean, whether supports VCA engine configuration-->
</isSupportIntelligentAnalysisEngines>
<isSupportChannelEventCap>
<!--opt, xs:boolean, whether supports getting event capability by channel-->
</isSupportChannelEventCap>
<isSupportSensorCalibrating>
<!--opt, xs:boolean, whether supports double sensor calibration capability--
>
</isSupportSensorCalibrating>
<isSupportChannelEventListCap>
<!--opt, xs:boolean, whether supports getting event capability of all
channels-->
</isSupportChannelEventListCap>
<VCAResourceChannelsCap>
<!--opt, whether supports independently switching to another VCA resource
by channel-->
<ChannelsList>
<channelsID>
<!--req, xs:integer, channel No. supported by the device-->
</channelsID>
</ChannelsList>
</VCAResourceChannelsCap>
<SensorCap/><!--optional-->
<isSupportSecurityCP/>
<!--optional, xs:boolean,"true, false", whether supports the applications
of security control panel-->
</isSupportSecurityCP>
<isSupportClientProxyWEB/>
<!--optional, xs:boolean, "true, false", whether supports web page jumping--
>
</isSupportClientProxyWEB>
<isSupportTime/>
<!--optional, xs:boolean, "true, false", whether supports time
configuration-->
</isSupportTime>
<isSupportTimeZone/>

47
 Heat Map Application ISAPI User Manual

<!--optional, xs:boolean, "true, false", whether supports daylight saving

time (DST) configuration-->
</isSupportTimeZone>
<isSupportMixedTargetDetection>
<!--opt, xs:boolean, "true, false", whether supports mixed-target-type
detection-->
</isSupportMixedTargetDetection>
<isSupportFaceContrastMode>
<!--opt, xs:boolean, whether supports face picture comparison mode-->
</isSupportFaceContrastMode>
<isSupportPictureCaptureComparision>
<!--opt, xs:boolean, whether supports face picture N:1 comparison between
face pictures captured by the camera and imported face pictures-->
</isSupportPictureCaptureComparision>
<isSupportChannelFullEventListCap>
<!--opt, xs:boolean, whether supports getting event list capability of all
channels-->
</isSupportChannelFullEventListCap>
<isSupportAUXInfoCap>
<!--opt, xs:boolean, whether supports getting property capability of all
channels-->
</isSupportAUXInfoCap>
<isSupportActiveMulticast>
<!--opt, xs: boolean, whether supports active multicast-->
</isSupportActiveMulticast>
<isSupportAutoMaintenance>
<!--opt, xs:boolean, whether supports automatic maintenance. When this node
exists and values "true", it indicates support-->
</isSupportAutoMaintenance>
<isSupportGetLinkSocketIP>
<!--opt, xs: boolean, "true,false", whether supports getting the SoketIP of
current connection-->
</isSupportGetLinkSocketIP>
<isSupportIntelligentSearch>
<!--opt, xs:boolean, whether supports intelligent search-->
</isSupportIntelligentSearch>
<IOTCap><!--opt, xs:boolean, IoT device access capability-->
<supportChannelNum>
<!--req, xs:integer, number of supported channels of IoT device-->
</supportChannelNum>
<startChannelNo>
<!--opt, xs:integer, initial channel ID, if this node is not inputted, it
indicates that the initial channel ID is 1-->
</startChannelNo>
<isSupportlinkageChannelsSearch>
<!--opt, boolean, returns "true" if support, returns "false" if not
support. Corresponds to URL (POST /ISAPI/System/IOT/linkageChannels?
format=json)-->
</isSupportlinkageChannelsSearch>
</IOTCap>
<isSupportEncryption>
<!--opt, xs: boolean, stream encryption capability-->

48
 Heat Map Application ISAPI User Manual

</isSupportEncryption>
<AIDEventSupport opt="abandonedObject,
pedestrian,congestion,roadBlock,construction,trafficAccident,fogDetection">
<!--opt, xs:string, supported traffic incident type-->
</AIDEventSupport>
<TFSEventSupport
opt="illegalParking ,wrongDirection,crossLane,laneChange,vehicleExist,turnRound,
parallelParking">
<!--opt, xs:string, supported enforcement event type-->
</TFSEventSupport>
<isVehicleStatisticsSupport>
<!--opt, xs: boolean, whether supports setting parameters for traffic data
collection-->
</isVehicleStatisticsSupport>
<isSupportIntersectionAnalysis>
<!--opt, xs: boolean, whether supports intersection analysis-->
</isSupportIntersectionAnalysis>
<isSptDiagnosis>
<!--opt, xs:boolean, whether to support device diagnosis: "true", "false"-->
</isSptDiagnosis>
<isSptSerialLogCfg>
<!--opt, xs:boolean, whether to support configuring serial port log
redirection: "true", "false"-->
</isSptSerialLogCfg>
<isSptFileExport>
<!--opt, xs:boolean, whether to support exporting files from the device:
"true", "false"-->
</isSptFileExport>
<isSptCertificationStandard>
<!--opt, xs:boolean, whether to support configuring authentication standard
for security control panel: "true", "false"-->
</isSptCertificationStandard>
<isSptKeypadLock>
<!--opt, xs:boolean, whether to support locking keypad: "true", "false"-->
</isSptKeypadLock>
</DeviceCap>

6.10 XML_EventCap
EventCap capability message in XML format
<EventCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportHDFull><!--opt, xs:boolean, "true"-support, "false"-not support--></
isSupportHDFull>
<isSupportHDError><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportHDError>
<isSupportNicBroken><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportNicBroken>
<isSupportIpConflict><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportIpConflict>

49
 Heat Map Application ISAPI User Manual

<isSupportIllAccess><!--opt, xs:boolean, "true"-support, "false"-not support--

></isSupportIllAccess>
<isSupportViException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportViException>
<isSupportViMismatch><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportViMismatch>
<isSupportRecordException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRecordException>
<isSupportTriggerFocus><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportTriggerFocus>
<isSupportMotionDetection><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportMotionDetection>
<isSupportVideoLoss><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportVideoLoss>
<isSupportTamperDetection><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportTamperDetection>
<isSupportStudentsStoodUp><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportStudentsStoodUp>
<isSupportFramesPeopleCounting><!--opt, xs:boolean, "true"-support, "false"-
not support--></isSupportFramesPeopleCounting>
<isSupportRaidException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRaidException>
<isSupportSpareException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportSpareException>
<isSupportPoePowerException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportPoePowerException>
<isSupportRegionEntrance><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRegionEntrance>
<isSupportRegionExiting><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRegionExiting>
<isSupportLoitering><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportLoitering>
<isSupportGroup><!--opt, xs:boolean, "true"-support, "false"-not support--></
isSupportGroup>
<isSupportRapidMove><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportRapidMove>
<isSupportFireDetection><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportFireDetection>
<isSupportillegalParking><!--opt, xs:boolean, whether to support illegal
parking detection: "true"-support, "false"-not support--></
isSupportillegalParking>
<isSupportUnattendedBaggage><!--opt, xs:boolean --></
isSupportUnattendedBaggage>
<isSupportAttendedBaggage><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportAttendedBaggage>
<isSupportHumanAttribute><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportHumanAttribute>
<isSupportFaceContrast><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportFaceContrast>
<isSupportFaceLib><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportFaceLib>
<isSupportWhiteListFaceContrast><!--opt, xs:boolean, "true"-support, "false"-

50
 Heat Map Application ISAPI User Manual

not support--></isSupportWhiteListFaceContrast>
<isSupportHumanRecognition>><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportHumanRecognition>
<isSupportFaceSnap><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportFaceSnap>
<isSupportPersonDensityDetection><!--opt, xs:boolean, "true"-support, "false"-
not support--></isSupportPersonDensityDetection>
<isSupportMixedTargetDetection><!--opt, xs:boolean, whether to support mixed-
target-type detection alarm: "true"-support, "false"-not support--></
isSupportMixedTargetDetection>
<isSupportPedestrian><!--opt, xs:boolean, whether to support pedestrian
detection: "true"-support, "false"-not support--></isSupportPedestrian>
<isSupportTrafficAccident><!--opt, xs:boolean, whether to support traffic
accident detection: "true"-support, "false"-not support--></
isSupportTrafficAccident>
<isSupportConstruction><!--opt, xs:boolean, whether to support construction
detection: "true"-support, "false"-not support--></isSupportConstruction>
<isSupportRoadBlock><!--opt, xs:boolean, whether to support roadblock
detection: "true"-support, "false"-not support--></isSupportRoadBlock>
<isSupportAbandonedObject><!--opt, xs:boolean, whether to support thrown
object detection: "true"-support, "false"-not support--></
isSupportAbandonedObject>
<isSupportParallelParking><!--opt, xs:boolean, whether to support parallel
parking detection: "true"-support, "false"-not support--></
isSupportParallelParking>
<isSupportParkingState><!--opt, xs:boolean, whether to support parking space
status detection: "true"-support, "false"-not support, currently this node is
not supported--></isSupportParkingState>
<isSupportCongestion><!--opt, xs:boolean, whether to support congestion
detection: "true"-support, "false"-not support--></isSupportCongestion>
<isSupportVehicleStatistics><!--opt, xs:boolean, whether to support data
collection: "true"-support, "false"-not support--></isSupportVehicleStatistics>
<isSupportWrongDirection><!--opt, xs:boolean, whether to support wrong-way
driving detection: "true"-support, "false"-not support--></
isSupportWrongDirection>
<isSupportTrunRound><!--opt, xs:boolean, whether to support U-turning
detection: "true"-support, "false"-not support--></isSupportTrunRound>
<isSupportCrossLane><!--opt, xs:boolean, whether to support driving on the
lane line detection: "true"-support, "false"-not support--></isSupportCrossLane>
<isSupportLaneChange><!--opt, xs:boolean, whether to support illegal lane
change detection: "true"-support, "false"-not support--></isSupportLaneChange>
<isSupportVehicleExist><!--opt, xs:boolean, whether to support motor vehicle
on non-motor vehicle lane detection: "true"-support, "false"-not support--></
isSupportVehicleExist>
<isSupporFogDetection><!--opt, xs:boolean, whether to support fog detection:
"true"-support, "false"-not support--></isSupporFogDetection>
<isSupportIntersectionAnalysis><!--opt, xs: boolean, whether supports
configuring intersection analysis alarm: "true"-support, "false"-not support--
></isSupportIntersectionAnalysis>
</EventCap>

51
 Heat Map Application ISAPI User Manual

6.11 XML_EventTrigger
EventTrigger message in XML format
<EventTrigger version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs:string, ID--></id>
<eventType>
<!--req, xs:string, see details in the "Remarks" below-->
</eventType>
<eventDescription><!--opt, xs:string--></eventDescription>
<inputIOPortID><!--dep, xs:string, alarm input ID--></inputIOPortID>
<dynInputIOPortID><!--dep, xs:string, dynamic alarm input ID--></
dynInputPortID>
<videoInputChannelID>
<!--dep, 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><!--dep, xs:string, dynamic video input channel ID--
></dynVideoInputChannelID>
<intervalBetweenEvents><!--opt, xs:integer, unit: second--></
intervalBetweenEvents>
<WLSensorID><!--dep, xs:string, ID--></WLSensorID>
<EventTriggerNotificationList/><!--opt, 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,
personQueueDetecton, mixedTargetDetection, HVTVehicleDetection, illegalParking, pedestrian,
trafficAccident, construction, roadblock, abandonedObject, parallelParking, parkingState,
congestion, intersectionAnalysis, heatMap.
See Also
XML_EventTriggerNotificationList
Example
EventTrigger Message Example of Face Picture Comparison Alarm (Front-End Device)
<EventTrigger version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceLib-1</id>

52
 Heat Map Application ISAPI User Manual

<eventType>faceLib</eventType>
<eventDescription>faceLib Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

Example
EventTrigger Message Example of Face Picture Comparison Alarm (Rear-End Device)
<EventTrigger version="1.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceContrast-1</id>
<eventType>faceContrast</eventType>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>record-1</id>
<notificationMethod>record</notificationMethod>
<dynVideoInputID>1</dynVideoInputID>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

Example
EventTrigger Message Example of Mixed-Target-Type Detection
<?xml version="1.0" encoding="UTF-8"?>
<EventTrigger version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>mixedTargetDetection-1</id>
<eventType>mixedTargetDetection</eventType>
<eventDescription>Mixed-target-type detection</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

Example
EventTrigger Message Example of Illegal Parking Detection
<EventTrigger version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>illegalParking-1</id>

53
 Heat Map Application ISAPI User Manual

<eventType>illegalParking</eventType>
<eventDescription>illegalParking Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

6.12 XML_EventTriggerList
EventTriggerList message in XML format
<EventTriggerList version="2.0" xmlns="http://www.hikvision.com/ver20/
XMLSchema">
<EventTrigger/><!--opt, see details in the message of XML_EventTrigger-->
</EventTriggerList>

See Also
XML_EventTrigger
Example
XML_EventTriggerList Message Example of Linkage Configurations of Multiple Alarms
<EventTriggerList version="2.0" xmlns="http://www.hikvision.com/ver20/
XMLSchema">
<EventTrigger>
<id>VMD-1</id>
<eventType>VMD</eventType>
<eventDescription>VMD Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>tamper-1</id>
<eventType>tamperdetection</eventType>
<eventDescription>shelteralarm Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>diskfull</id>
<eventType>diskfull</eventType>
<eventDescription>exception Information</eventDescription>

54
 Heat Map Application ISAPI User Manual

<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>diskerror</id>
<eventType>diskerror</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>beep</id>
<notificationMethod>beep</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>nicbroken</id>
<eventType>nicbroken</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>ipconflict</id>
<eventType>ipconflict</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>illaccess</id>
<eventType>illaccess</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>videomismatch</id>
<eventType>videomismatch</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>beep</id>
<notificationMethod>beep</notificationMethod>

55
 Heat Map Application ISAPI User Manual

<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>badvideo</id>
<eventType>badvideo</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>storageDetection-1</id>
<eventType>storageDetection</eventType>
<eventDescription>storageDetection Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>illegalParking-1</id>
<eventType>illegalParking</eventType>
<eventDescription>illegalParking Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>pedestrian-1</id>
<eventType>pedestrian</eventType>
<eventDescription>pedestrian Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>trafficAccident-1</id>

56
 Heat Map Application ISAPI User Manual

<eventType>trafficAccident</eventType>
<eventDescription>trafficAccident Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>construction-1</id>
<eventType>construction</eventType>
<eventDescription>construction Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>roadBlock-1</id>
<eventType>roadBlock</eventType>
<eventDescription>roadBlock Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>abandonedObject-1</id>
<eventType>abandonedObject</eventType>
<eventDescription>abandonedObject Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>

57
 Heat Map Application ISAPI User Manual

<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>parallelParking-1</id>
<eventType>parallelParking</eventType>
<eventDescription>parallelParking Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>trafficJam-1</id>
<eventType>trafficJam</eventType>
<eventDescription>trafficJam Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
</EventTriggerList>

6.13 XML_EventTriggerNotification
EventTriggerNotification message in XML format
<EventTriggerNotification><!--opt-->
<id><!--req, xs:string, device ID--></id>
<notificationMethod>
<!--req, xs:string, linkage actions,
opt="email,IM,IO,syslog,HTTP,FTP,beep,ptz,record, monitorAlarm, center,
LightAudioAlarm,focus,trace,cloud,SMS,whiteLight,…"-->
</notificationMethod>
<notificationRecurrence>
<!--opt, xs:string, "beginning,beginningandend,recurring"-->
</notificationRecurrence>
<notificationInterval><!--dep, xs:integer, unit: millisecond--></

58
 Heat Map Application ISAPI User Manual

notificationInterval>
<outputIOPortID><!--dep, xs:string, video output No., it is required only
when notificationMethod is "IO"--></outputIOPortID>
<dynOutputIOPortID><!--dep, xs:string, dynamic video output No., it is
required only when notificationMethod is "IO"--></dynOutputIOPortID>
<videoInputID><!--dep, xs:string, video input No., it is required only when
notificationMethod is "record"--></videoInputID>
<dynVideoInputID><!--dep, xs:string, dynamic video input No., it is required
only when notificationMethod is "record"--></dynVideoInputID>
<ptzAction><!--dep, it is required only when notificationMethod is "ptz"-->
<ptzChannelID><!--req, xs:string, PTZ channel ID--></ptzChannelID>
<actionName><!--req, xs:string, PTZ control type: "preset", "pattern",
"patrol"--></actionName>
<actionNum><!--dep, xs:integer></actionNum>
</ptzAction>
</EventTriggerNotification>

6.14 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

6.15 XML_HeatMap
HeatMap message in XML format
<HeatMap version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<enabled>
<!--required, xs: boolean, whether to enable heat map function,
"true,false"-->
</enabled>
<normalizedScreenSize>
<normalizedScreenWidth><!--normalized width, for front-end device, it is
1000--></normalizedScreenWidth>
<normalizedScreenHeight><!--normalized height, for front-end device, it is
1000--></normalizedScreenHeight>
</normalizedScreenSize>
<sensitivityLevel>
<!--opt, xs: integer, sensitivity level, which is between 1 and 100, and
the default value is 50-->

59
 Heat Map Application ISAPI User Manual

</sensitivityLevel>
<backgroundUpdateRate>
<!--opt, xs: integer, background updating speed, which is between 1 and
100, and the default value is 50-->
</backgroundUpdateRate>
<sceneChangeLevel>
<!--opt, xs: integer, scene change level, which is between 1 and 100, and
the default value is 50-->
</sceneChangeLevel>
<targetTracking>
<!--opt, xs: boolean, whether to enable target tracking function, "true,
false"-->
</targetTracking>
<minObjectSize>
<!--opt, xs: integer, minimum target size, which is between 1 and 100, and
the default value is 50-->
</minObjectSize>
<HeatMapRegionList><!--statistics region list of heat map-->
<HeatMapRegion>
<id><!--required, region ID--></id>
<RegionCoordinatesList>
<RegionCoordinates><!--req-->
<positionX><!--req, xs: integer; x-coordinate--></positionX>
<positionY><!--req, xs: integer; y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
<FilterSize><!--opt, filter size-->
<MaxTargetRect><!--opt, maximum target frame-->
<height><!--req, float,height--></height>
<width><!--req, float,width--></width>
<x><!--req, float, x-coordinate of upper-left vertex--></x>
<y><!--req, float, y-coordinate of upper-left vertex--></y>
</MaxTargetRect>
<MinTargetRect><!--opt, minimum target frame-->
<height><!--req, float, height--></height>
<width><!--req, float, width--></width>
<x><!--req, float, x-coordinate of upper-left vertex--></x>
<y><!--req,float, y-coordinate of upper-left vertex--></y>
</MinTargetRect>
</FilterSize>
</HeatMapRegion>
</HeatMapRegionList>
<confidence>
<!--opt, xs: float, whether supports target confidence, and the supported
value range: [0.00,100.00]-->
</confidence>
<uploadHeatMapResultType>
<!--opt, xs: string, heat map alarm type, "normal,durationAndPDC"-->
<uploadHeatMapResultType>
</HeatMap>

60
 Heat Map Application ISAPI User Manual

6.16 XML_InputScheduleList
InputScheduleList message in XML format
<InputScheduleList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Schedule/><!--opt, see details in the message XML_Schedule-->
</InputScheduleList>

See Also
XML_Schedule

6.17 XML_IntelliCap
IntelliCap message in XML format
<IntelliCap version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<isFaceSupport><!--whether support face detection--></isFaceSupport>
<isBehaviorSupport><!--whether support behavior analysis--></
isBehaviorSupport>
<isLineDetectionSupport><!--whether support line crossing detection--></
isLineDetectionSupport>
<isFieldDetectionSupport><!--whether support intrusion detection--></
isFieldDetectionSupport>
<isRegionEntranceSupport><!--whether support region entrance detection--></
isRegionEntranceSupport>
<isRegionExitingSupport><!--whether support region exiting detection--></
isRegionExitingSupport>
<isLoiteringSupport><!--whether support loitering detection--></
isLoiteringSupport>
<isGroupSupport><!--whether support people gathering detection--></
isGroupSupport>
<isRapidMoveSupport><!--whether support fast moving detection--></
isRapidMoveSupport>
<isParkingSupport><!--whether support parking detection--></isParkingSupport>
<isUnattendedBaggageSupport><!--whether support unattended baggage detection--
></isUnattendedBaggageSupport>
<isAttendedBaggageSupport><!--whether support object removal detection--></
isAttendedBaggageSupport>
<isTeacherSupport><!--whether support teacher's behavior detection--></
isTeacherSupport>
<isStudentSupport><!--whether support student's behavior detection--></
isStudentSupport>
<isCombinedSupport><!--whether support combined detection--></
isCombinedSupport>
<isTrafficSupport><!--whether support traffic detection--></isTrafficSupport>
<isFaceCaptureStatisticsSupport><!--whether support face picture statistics--
></isFaceCaptureStatisticsSupport>
<isSupportPersonQueueDetection><!--whether support queue management--></

61
 Heat Map Application ISAPI User Manual

isSupportPersonQueueDetection>
<isSupportIntersectionAnalysis>
<!--opt, xs: boolean, whether supports intersection analysis-->
</isSupportIntersectionAnalysis>
</IntelliCap>

6.18 XML_Schedule
Schedule message in XML format
<Schedule version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs:string, ID--></id>
<eventType>
<!--opt, xs:string, alarm/event types, see details in the "Remarks" below-->
</eventType>
<inputIOPortID><!--ro, dep, xs:string, alarm input No.--></inputIOPortID>
<outputIOPortID><!--ro, dep, xs:string, alarm output No.--></inputIOPortID>
<videoInputChannelID><!--ro, dep, xs:string, video input channel ID--></
videoInputChannelID>
<TimeBlockList size="8"><!--req-->
<TimeBlock>
<dayOfWeek>
<!--opt, xs:integer, day of the week based on ISO8601, "1"=Monday, ...--
>
</dayOfWeek>
<TimeRange><!--req-->
<beginTime><!--req, xs:time, ISO8601 time--></beginTime>
<endTime><!--req, xs:time, ISO8601 time--></endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
<HolidayBlockList><!--opt-->
<TimeBlock>
<TimeRange><!--req-->
<beginTime><!--req, xs:time, ISO8601 time--></beginTime>
<endTime><!--req, xs:time, ISO8601 time--></endTime>
</TimeRange>
</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, mixedTargetDetection, fireDetection, illegalParking, pedestrian,

62
 Heat Map Application ISAPI User Manual

trafficAccident,construction, roadblock, abandonedObject, parallelParking, parkingState,

congestion, intersectionAnalysis, heatMap.
Example
Schedule Message Example of Face Picture Comparison Alarm (Front-End Device)
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceLib-1</id>
<eventType>faceLib</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8">
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>

63
 Heat Map Application ISAPI User Manual

</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
Schedule Message Example of Face Picture Comparison Alarm (Rear-End Device)
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceContrast-1</id>
<eventType>faceContrast</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8">
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>

64
 Heat Map Application ISAPI User Manual

</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
Schedule Message Example of Stranger Detection Alarm (Rear-End Device)
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>whiteListFaceContrast-1</id>
<eventType>whiteListFaceContrast</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8">
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>

65
 Heat Map Application ISAPI User Manual

<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
Schedule Message Example of Mixed-Target-Type Detection Alarm
<?xml version="1.0" encoding="UTF-8"?>
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>mixedTargetDetection-2</id>
<eventType>mixedTargetDetection</eventType>
<videoInputChannelID>2</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>

66
 Heat Map Application ISAPI User Manual

<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Illegal Parking Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>illegalParking-1</id>
<eventType>illegalParking</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>

67
 Heat Map Application ISAPI User Manual

<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Pedestrian Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>pedestrian-1</id>
<eventType>pedestrian</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >

68
 Heat Map Application ISAPI User Manual

<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

69
 Heat Map Application ISAPI User Manual

Example
XML_Schedule Message Example of Arming Schedule for Traffic Accident Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>trafficAccident-1</id>
<eventType>trafficAccident</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>

70
 Heat Map Application ISAPI User Manual

<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Construction Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>construction-1</id>
<eventType>construction</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>

71
 Heat Map Application ISAPI User Manual

<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Roadblock Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>roadBlock-1</id>
<eventType>roadBlock</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>

72
 Heat Map Application ISAPI User Manual

<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Thrown Object Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>abandonedObject-1</id>
<eventType>abandonedObject</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>

73
 Heat Map Application ISAPI User Manual

</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Congestion Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>congestion-1</id>
<eventType>congestion</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>

74
 Heat Map Application ISAPI User Manual

</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Fog Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>fogDetection-1</id>
<eventType>fogDetection</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>

75
 Heat Map Application ISAPI User Manual

<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Traffic Data Collection

76
 Heat Map Application ISAPI User Manual

<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">

<id>vehicleStatistics-1</id>
<eventType>vehicleStatistics</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>

77
 Heat Map Application ISAPI User Manual

</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

6.19 XML_VideoCap
VideoCap message in XML format
<VideoCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<videoInputPortNums><!--opt, xs: integer--><videoInputPortNums>
<videoOutputPortNums><!--opt, xs: integer--><videoOutputPortNums>
<isSupportHeatmap><!--opt, xs: boolean, whether supports heat map function--
></isSupportHeatmap>
<isSupportCounting><!--opt, xs: boolean--></isSupportCounting>
<countingType><!--dep, xs: string, "human,object"--></countingType>
<isSupportPreviewSwitch><!--opt, xs: boolean--></isSupportPreviewSwitch>
<isSupportRecodStatus>
<!--opt, xs: boolean, whether supports getting recording status-->
</isSupportRecodStatus>
<isSupportPrivacyMask>
<!--opt, xs: boolean, whether supports priavte mask function-->
</isSupportPrivacyMask>
<isSupportBinocularPreviewSwitch>
<!--opt, xs: boolean, whether supports auto-switch during the live view
of dual lens camera-->
</isSupportBinocularPreviewSwitch>
<isSupportCalibCheck>
<!--opt, xs: boolean, whether supports calibration verification-->
</isSupportCalibCheck>
<isSupportPIP><!--opt, xs: boolean, "true, false"--></isSupportPIP>
<channelFlexible opt ="name,enable,online,linknum">
<!--capability of getting channel status by condition-->
</channelFlexible >
<isSupportFocusVideoMode>
<!--opt, xs: boolean, video focus mode for installation and debug-->
</isSupportFocusVideoMode>
<isSupportExternalChannel>
<!--opt, xs: boolean, whether supports extending analog channel-->
</isSupportExternalChannel>
<isSupportMultiChannelCounting>
<!--opt, xs: boolean, whether supports people counting of multiple
channels-->
</isSupportMultiChannelCounting>
<isSupportCountingCollection>
<!--opt, xs:boolean, whether supports people counting data replenishment-->
</isSupportCountingCollection>
<isSupportHeatmapCollection>
<!--opt, xs:boolean, whether supports heat map data replenishment-->
</isSupportHeatmapCollection>

78
 Heat Map Application ISAPI User Manual

<OSDLanguage opt="GBK,EUC-KR" def="GBK"/>

</VideoCap>

6.20 XML_HeatMapPicInfo
HeatMapPicInfo message in XML format
<HeatMapPicInfo version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<MaxValue>
<!--opt, xs: integer, maximum value in heat map, which is between 0 and
365*24*60*60-->
</MaxValue>
<MinValue>
<!--opt, xs: integer, minimum value in heat map, which is between 0 and
365*24*60*60-->
</MinValue>
</HeatMapPicInfo>

6.21 XML_HeatMapRegionList
HeatMapRegionList message in XML format
<HeatMapRegionList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<HeatMapRegion/><!--opt, refer to the message XML_HeatMapRegion for details--
>
</HeatMapRegionList>

See Also
XML_HeatMapRegion

6.22 XML_HeatMapRegion
HeatMapRegion message in XML format
<HeatMapRegion version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs: integer--></id>
<sensitivityLevel>
<!--req, xs: integer, sensitivity, which is between 1 and 100, the default
value is 50-->
</sensitivityLevel>
<backgroundUpdateRate>
<!--opt, xs: integer, background updating speed, which is between 1 and
100, the default value is 50-->
</backgroundUpdateRate>
<sceneChangeLevel>
<!--opt, xs: integer, scene change level, which is between 1 and 100, the

79
 Heat Map Application ISAPI User Manual

default value is 50-->

</sceneChangeLevel>
<targetTracking><!--opt, xs: boolean, whether to enable target tracking
function--></targetTracking>
<minObjectSize>
<!--opt, xs: integer, minimum target size, which is between 1 and 100, the
default value is 50-->
</minObjectSize>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--req-->
<positionX><!--req, xs: integer; x-coordinate--></positionX>
<positionY><!--req, xs: integer; y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</HeatMapRegion>

6.23 XML_HeatMapDataResult
HeatMapDataResult message in XML format
<HeatMapDataResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<responseStatus><!--req, xs: boolean--></responseStatus>
<responseStatusStrg>
<!--req, xs: string, "NO MATCHES"-no matched, "MORE"-searching, "OK"-search
ended-->
</responseStatusStrg>
<numOfMatches><!--req, xs: integer, number of search results--></numOfMatches>
<matchList> <!--opt-->
<matchElement><!--opt-->
<timeSpan><!--opt, search time period-->
<startTime><!--req, xs: ISO8601 time--></startTime>
<endTime><!--req, xs: ISO8601 time--></endTime>
</timeSpan>
<value><!--req, xs: integer, target activate time duration--> </value>
</matchElement>
</matchList>
</HeatMapDataResult>

6.24 XML_HeatMapDataDescription
HeatMapDataDescription message in XML format
<HeatMapDataDescription version="2.0" xmlns="http://www.isapi.org/ver20/
XMLSchema">
<reportType>
<!--req, xs: string, report type: "daily", "weekly", "monthly", "yearly"-
annual report-->
</reportType>
<timeSpanList><!--search time period, time format: IOS8601-->

80
 Heat Map Application ISAPI User Manual

<timeSpan>
<startTime><!--req, xs: ISO8601 time--></startTime>
<endTIme><!-- req, xs: ISO8601 time --></endTime>
<timeSpan>
</timeSpanList>
<statisticalModel>
<!--opt, xs: string, statistics type, "duration"-stay duration statistics
(default), "PDC"-people counting statistics-->
</statisticalModel>
</HeatMapDataDescription>

6.25 XML_ResponseStatus
ResponseStatus message in XML format
<ResponseStatus version="2.0" xmlns="http://www.std-cgi.org/ver20/XMLSchema">
<requestURL>
<!--req, ro, xs:string, request URL-->
</requestURL>
<statusCode>
<!--req, ro, xs:integer, status code: 0,1-OK, 2-Device Busy, 3-Device
Error, 4-Invalid Operation, 5-Invalid XML Format, 6-Invalid XML Content, 7-
Reboot Required-->
</statusCode>
<statusString>
<!--req, ro, xs:string, status description: OK, Device Busy, Device Error,
Invalid Operation, Invalid XML Format, Invalid XML Content, Reboot-->
</statusString>
<subStatusCode>
<!--req, ro, xs:string, describe the error reason in detail-->
</subStatusCode>
</ResponseStatus>

Note
See Error Codes in ResponseStatus for details about sub status codes and corresponding error
codes.

6.26 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*/

81
 Heat Map Application ISAPI User Manual

"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*/
}

6.27 XML_EventCap
EventCap capability message in XML format
<EventCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportHDFull><!--opt, xs:boolean, "true"-support, "false"-not support--></
isSupportHDFull>
<isSupportHDError><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportHDError>
<isSupportNicBroken><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportNicBroken>
<isSupportIpConflict><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportIpConflict>
<isSupportIllAccess><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportIllAccess>
<isSupportViException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportViException>
<isSupportViMismatch><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportViMismatch>
<isSupportRecordException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRecordException>

82
 Heat Map Application ISAPI User Manual

<isSupportTriggerFocus><!--opt, xs:boolean, "true"-support, "false"-not

support--></isSupportTriggerFocus>
<isSupportMotionDetection><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportMotionDetection>
<isSupportVideoLoss><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportVideoLoss>
<isSupportTamperDetection><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportTamperDetection>
<isSupportStudentsStoodUp><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportStudentsStoodUp>
<isSupportFramesPeopleCounting><!--opt, xs:boolean, "true"-support, "false"-
not support--></isSupportFramesPeopleCounting>
<isSupportRaidException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRaidException>
<isSupportSpareException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportSpareException>
<isSupportPoePowerException><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportPoePowerException>
<isSupportRegionEntrance><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRegionEntrance>
<isSupportRegionExiting><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportRegionExiting>
<isSupportLoitering><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportLoitering>
<isSupportGroup><!--opt, xs:boolean, "true"-support, "false"-not support--></
isSupportGroup>
<isSupportRapidMove><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportRapidMove>
<isSupportFireDetection><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportFireDetection>
<isSupportillegalParking><!--opt, xs:boolean, whether to support illegal
parking detection: "true"-support, "false"-not support--></
isSupportillegalParking>
<isSupportUnattendedBaggage><!--opt, xs:boolean --></
isSupportUnattendedBaggage>
<isSupportAttendedBaggage><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportAttendedBaggage>
<isSupportHumanAttribute><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportHumanAttribute>
<isSupportFaceContrast><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportFaceContrast>
<isSupportFaceLib><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportFaceLib>
<isSupportWhiteListFaceContrast><!--opt, xs:boolean, "true"-support, "false"-
not support--></isSupportWhiteListFaceContrast>
<isSupportHumanRecognition>><!--opt, xs:boolean, "true"-support, "false"-not
support--></isSupportHumanRecognition>
<isSupportFaceSnap><!--opt, xs:boolean, "true"-support, "false"-not support--
></isSupportFaceSnap>
<isSupportPersonDensityDetection><!--opt, xs:boolean, "true"-support, "false"-
not support--></isSupportPersonDensityDetection>
<isSupportMixedTargetDetection><!--opt, xs:boolean, whether to support mixed-

83
 Heat Map Application ISAPI User Manual

target-type detection alarm: "true"-support, "false"-not support--></

isSupportMixedTargetDetection>
<isSupportPedestrian><!--opt, xs:boolean, whether to support pedestrian
detection: "true"-support, "false"-not support--></isSupportPedestrian>
<isSupportTrafficAccident><!--opt, xs:boolean, whether to support traffic
accident detection: "true"-support, "false"-not support--></
isSupportTrafficAccident>
<isSupportConstruction><!--opt, xs:boolean, whether to support construction
detection: "true"-support, "false"-not support--></isSupportConstruction>
<isSupportRoadBlock><!--opt, xs:boolean, whether to support roadblock
detection: "true"-support, "false"-not support--></isSupportRoadBlock>
<isSupportAbandonedObject><!--opt, xs:boolean, whether to support thrown
object detection: "true"-support, "false"-not support--></
isSupportAbandonedObject>
<isSupportParallelParking><!--opt, xs:boolean, whether to support parallel
parking detection: "true"-support, "false"-not support--></
isSupportParallelParking>
<isSupportParkingState><!--opt, xs:boolean, whether to support parking space
status detection: "true"-support, "false"-not support, currently this node is
not supported--></isSupportParkingState>
<isSupportCongestion><!--opt, xs:boolean, whether to support congestion
detection: "true"-support, "false"-not support--></isSupportCongestion>
<isSupportVehicleStatistics><!--opt, xs:boolean, whether to support data
collection: "true"-support, "false"-not support--></isSupportVehicleStatistics>
<isSupportWrongDirection><!--opt, xs:boolean, whether to support wrong-way
driving detection: "true"-support, "false"-not support--></
isSupportWrongDirection>
<isSupportTrunRound><!--opt, xs:boolean, whether to support U-turning
detection: "true"-support, "false"-not support--></isSupportTrunRound>
<isSupportCrossLane><!--opt, xs:boolean, whether to support driving on the
lane line detection: "true"-support, "false"-not support--></isSupportCrossLane>
<isSupportLaneChange><!--opt, xs:boolean, whether to support illegal lane
change detection: "true"-support, "false"-not support--></isSupportLaneChange>
<isSupportVehicleExist><!--opt, xs:boolean, whether to support motor vehicle
on non-motor vehicle lane detection: "true"-support, "false"-not support--></
isSupportVehicleExist>
<isSupporFogDetection><!--opt, xs:boolean, whether to support fog detection:
"true"-support, "false"-not support--></isSupporFogDetection>
<isSupportIntersectionAnalysis><!--opt, xs: boolean, whether supports
configuring intersection analysis alarm: "true"-support, "false"-not support--
></isSupportIntersectionAnalysis>
</EventCap>

6.28 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--></

84
 Heat Map Application ISAPI User Manual

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, alarm/event triggered or occurred time, format: 2017-07-19T10:06:41+08:00--></dateTime>
<activePostCount><!--req, xs:integer, alarm/event frequency, starts from 1--></activePostCount>
<eventType><!--req, xs:string, alarm/event type, "peopleCounting, ANPR,..."--></eventType>
<eventState> <!--req, xs:string, durative alarm/event status: "active"-valid, "inactive"-invalid, e.g.,
when a moving target is detected, the alarm/event information will be uploaded continuously unit
the status is set to "inactive"--> </eventState> <eventDescription><!--req, xs:string, alarm/event
description--></eventDescription> <...><!--opt, for different alarm/event types, the nodes are
different, see the message examples in different applications--></...> </EventNotificationAlert>

6.29 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

85
 Heat Map Application ISAPI User Manual

<EventNotificationAlert version="2.0" xmlns="http://www.hikvision.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>
<dateTime>2017-05-04T11:20:02+08:00</dateTime>
<activePostCount>0</activePostCount>
<eventType>videoloss</eventType>
<eventState>inactive</eventState>
<eventDescription>videoloss alarm</eventDescription>
</EventNotificationAlert>

6.30 XML_EventTrigger
EventTrigger message in XML format
<EventTrigger version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs:string, ID--></id>
<eventType>
<!--req, xs:string, see details in the "Remarks" below-->
</eventType>
<eventDescription><!--opt, xs:string--></eventDescription>
<inputIOPortID><!--dep, xs:string, alarm input ID--></inputIOPortID>
<dynInputIOPortID><!--dep, xs:string, dynamic alarm input ID--></
dynInputPortID>
<videoInputChannelID>
<!--dep, 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><!--dep, xs:string, dynamic video input channel ID--
></dynVideoInputChannelID>
<intervalBetweenEvents><!--opt, xs:integer, unit: second--></
intervalBetweenEvents>
<WLSensorID><!--dep, xs:string, ID--></WLSensorID>
<EventTriggerNotificationList/><!--opt, 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,

86
 Heat Map Application ISAPI User Manual

otherVehicleList, vehicledetection, storageDetection, shipsDetection, humanAttribute,

faceContrast, blackListFaceContrast, whiteListFaceContrast, faceSnap, faceLib,
personQueueDetecton, mixedTargetDetection, HVTVehicleDetection, illegalParking, pedestrian,
trafficAccident, construction, roadblock, abandonedObject, parallelParking, parkingState,
congestion, intersectionAnalysis, heatMap.
See Also
XML_EventTriggerNotificationList
Example
EventTrigger Message Example of Face Picture Comparison Alarm (Front-End Device)
<EventTrigger version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceLib-1</id>
<eventType>faceLib</eventType>
<eventDescription>faceLib Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

Example
EventTrigger Message Example of Face Picture Comparison Alarm (Rear-End Device)
<EventTrigger version="1.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceContrast-1</id>
<eventType>faceContrast</eventType>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>record-1</id>
<notificationMethod>record</notificationMethod>
<dynVideoInputID>1</dynVideoInputID>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

Example
EventTrigger Message Example of Mixed-Target-Type Detection
<?xml version="1.0" encoding="UTF-8"?>
<EventTrigger version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>mixedTargetDetection-1</id>
<eventType>mixedTargetDetection</eventType>
<eventDescription>Mixed-target-type detection</eventDescription>
<videoInputChannelID>1</videoInputChannelID>

87
 Heat Map Application ISAPI User Manual

<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

Example
EventTrigger Message Example of Illegal Parking Detection
<EventTrigger version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>illegalParking-1</id>
<eventType>illegalParking</eventType>
<eventDescription>illegalParking Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>

6.31 XML_EventTriggerList
EventTriggerList message in XML format
<EventTriggerList version="2.0" xmlns="http://www.hikvision.com/ver20/
XMLSchema">
<EventTrigger/><!--opt, see details in the message of XML_EventTrigger-->
</EventTriggerList>

See Also
XML_EventTrigger
Example
XML_EventTriggerList Message Example of Linkage Configurations of Multiple Alarms
<EventTriggerList version="2.0" xmlns="http://www.hikvision.com/ver20/
XMLSchema">
<EventTrigger>
<id>VMD-1</id>
<eventType>VMD</eventType>
<eventDescription>VMD Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>

88
 Heat Map Application ISAPI User Manual

<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>tamper-1</id>
<eventType>tamperdetection</eventType>
<eventDescription>shelteralarm Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>diskfull</id>
<eventType>diskfull</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>diskerror</id>
<eventType>diskerror</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>beep</id>
<notificationMethod>beep</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>nicbroken</id>
<eventType>nicbroken</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>ipconflict</id>
<eventType>ipconflict</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>illaccess</id>
<eventType>illaccess</eventType>

89
 Heat Map Application ISAPI User Manual

<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>videomismatch</id>
<eventType>videomismatch</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>beep</id>
<notificationMethod>beep</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>badvideo</id>
<eventType>badvideo</eventType>
<eventDescription>exception Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>storageDetection-1</id>
<eventType>storageDetection</eventType>
<eventDescription>storageDetection Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList></EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>illegalParking-1</id>
<eventType>illegalParking</eventType>
<eventDescription>illegalParking Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>

90
 Heat Map Application ISAPI User Manual

<id>pedestrian-1</id>
<eventType>pedestrian</eventType>
<eventDescription>pedestrian Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>trafficAccident-1</id>
<eventType>trafficAccident</eventType>
<eventDescription>trafficAccident Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>construction-1</id>
<eventType>construction</eventType>
<eventDescription>construction Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>roadBlock-1</id>
<eventType>roadBlock</eventType>
<eventDescription>roadBlock Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>

91
 Heat Map Application ISAPI User Manual

<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>abandonedObject-1</id>
<eventType>abandonedObject</eventType>
<eventDescription>abandonedObject Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>parallelParking-1</id>
<eventType>parallelParking</eventType>
<eventDescription>parallelParking Event trigger Information</
eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
<EventTrigger>
<id>trafficJam-1</id>
<eventType>trafficJam</eventType>
<eventDescription>trafficJam Event trigger Information</eventDescription>
<videoInputChannelID>1</videoInputChannelID>
<dynVideoInputChannelID>1</dynVideoInputChannelID>
<EventTriggerNotificationList>
<EventTriggerNotification>
<id>center</id>
<notificationMethod>center</notificationMethod>
<notificationRecurrence>beginning</notificationRecurrence>
</EventTriggerNotification>
</EventTriggerNotificationList>
</EventTrigger>
</EventTriggerList>

92
 Heat Map Application ISAPI User Manual

6.32 XML_EventTriggerNotification
EventTriggerNotification message in XML format
<EventTriggerNotification><!--opt-->
<id><!--req, xs:string, device ID--></id>
<notificationMethod>
<!--req, xs:string, linkage actions,
opt="email,IM,IO,syslog,HTTP,FTP,beep,ptz,record, monitorAlarm, center,
LightAudioAlarm,focus,trace,cloud,SMS,whiteLight,…"-->
</notificationMethod>
<notificationRecurrence>
<!--opt, xs:string, "beginning,beginningandend,recurring"-->
</notificationRecurrence>
<notificationInterval><!--dep, xs:integer, unit: millisecond--></
notificationInterval>
<outputIOPortID><!--dep, xs:string, video output No., it is required only
when notificationMethod is "IO"--></outputIOPortID>
<dynOutputIOPortID><!--dep, xs:string, dynamic video output No., it is
required only when notificationMethod is "IO"--></dynOutputIOPortID>
<videoInputID><!--dep, xs:string, video input No., it is required only when
notificationMethod is "record"--></videoInputID>
<dynVideoInputID><!--dep, xs:string, dynamic video input No., it is required
only when notificationMethod is "record"--></dynVideoInputID>
<ptzAction><!--dep, it is required only when notificationMethod is "ptz"-->
<ptzChannelID><!--req, xs:string, PTZ channel ID--></ptzChannelID>
<actionName><!--req, xs:string, PTZ control type: "preset", "pattern",
"patrol"--></actionName>
<actionNum><!--dep, xs:integer></actionNum>
</ptzAction>
</EventTriggerNotification>

6.33 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

93
 Heat Map Application ISAPI User Manual

6.34 XML_EventTriggersCap
EventTriggersCap capability message in XML format
<EventTriggersCap version="1.0" xmlns="http://www.hikvision.com/ver20/
XMLSchema">
<DiskfullTriggerCap><!--opt, xs: EventTriggerCapType--></DiskfullTriggerCap>
<DiskerrorTriggerCap><!--opt, xs: EventTriggerCapType--></DiskerrorTriggerCap>
<NicbrokenTriggerCap><!--opt, xs: EventTriggerCapType--></NicbrokenTriggerCap>
<IpconflictTriggerCap><!--opt, xs: EventTriggerCapType--></
IpconflictTriggerCap>
<IllaccesTriggerCap><!--opt, xs: EventTriggerCapType--></IllaccesTriggerCap>
<BadvideoTriggerCap><!--opt, xs: EventTriggerCapType--></BadvideoTriggerCap>
<VideomismatchTriggerCap><!--opt, xs: EventTriggerCapType--></
VideomismatchTriggerCap>
<IOTriggerCap><!--opt, xs: EventTriggerCapType--></IOTriggerCap>
<LineDetectTriggerCap><!--opt, xs: EventTriggerCapType--></
LineDetectTriggerCap>
<RegionEntranceTriggerCap><!--opt, xs: EventTriggerCapType--></
RegionEntranceTriggerCap>
<RegionExitingTriggerCap><!--opt, xs: EventTriggerCapType--></
RegionExitingTriggerCap>
<LoiteringTriggerCap><!--opt, xs: EventTriggerCapType--></LoiteringTriggerCap>
<GroupDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
GroupDetectionTriggerCap>
<RapidMoveTriggerCap><!--opt, xs: EventTriggerCapType--></RapidMoveTriggerCap>
<ParkingTriggerCap><!--opt, xs: EventTriggerCapType--></ParkingTriggerCap>
<UnattendedBaggageTriggerCap><!--opt, xs: EventTriggerCapType--></
UnattendedBaggageTriggerCap>
<AttendedBaggageTriggerCap><!--opt, xs: EventTriggerCapType--></
AttendedBaggageTriggerCap>
<FireDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
FireDetectionTriggerCap>
<FireDetectionCap><!--opt, xs: EventTriggerCapType--></FireDetectionCap>
<StorageDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
StorageDetectionTriggerCap>
<ShipsDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
ShipsDetectionTriggerCap>
<ThermometryCap><!--opt, xs: EventTriggerCapType--></ThermometryCap>
<VandalProofTriggerCap><!--opt, xs: EventTriggerCapType--></
VandalProofTriggerCap>
<BlackListTriggerCap><!--opt, xs: EventTriggerCapType--></BlackListTriggerCap>
<WhiteListTriggerCap><!--opt, xs: EventTriggerCapType--></WhiteListTriggerCap>
<AllVehicleListTriggerCap><!--opt,xs:EventTriggerCapType--></
AllVehicleListTriggerCap>
<OtherVehicleListTriggerCap><!--opt,xs:EventTriggerCapType--></
OtherVehicleListTriggerCap>
<PeopleDetectionTriggerCap><!--opt,xs:EventTriggerCapType--></
PeopleDetectionTriggerCap>
<PIRAlarmCap><!--opt, xs: EventTriggerCapType--></PIRAlarmCap>
<TamperDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></

94
 Heat Map Application ISAPI User Manual

TamperDetectionTriggerCap>
<DefocusDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
DefocusDetectionTriggerCap>
<FaceDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
FaceDetectionTriggerCap>
<SceneChangeDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
SceneChangeDetectionTriggerCap>
<VandalProofAlarmCap><!--opt, xs: EventTriggerCapType--></VandalProofAlarmCap>
<JudgmentTriggerCap><!--opt, xs: EventTriggerCapType--></JudgmentTriggerCap>
<FightingTriggerCap><!--opt, xs: EventTriggerCapType--></FightingTriggerCap>
<RisingTriggerCap><!--opt, xs: EventTriggerCapType--></RisingTriggerCap>
<DozingTriggerCap><!--opt, xs: EventTriggerCapType--></DozingTriggerCap>
<CountingTriggerCap><!--opt, xs: EventTriggerCapType--></CountingTriggerCap>
<VideoLossTriggerCap><!--opt, xs: EventTriggerCapType--></VideoLossTriggerCap>
<HideTriggerCap><!--opt, xs:EventTriggerCapType--></HideTriggerCap>
<AlarmInTriggerCap><!--opt, xs: EventTriggerCapType--></AlarmInTriggerCap>
<VehicleDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
VehicleDetectionTriggerCap>
<AudioExceptionCap><!--opt, xs: EventTriggerCapType--></AudioExceptionCap>
<FiledDetectTriggerCap><!--opt, xs: EventTriggerCapType--></
FiledDetectTriggerCap>
<MotionDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
MotionDetectionTriggerCap>
<TemperatureCap><!--opt, xs: EventTriggerCapType--></TemperatureCap>
<IntelligentTriggerCap><!--opt, xs: EventTriggerCapType--></
IntelligentTriggerCap>
<FaceContrastTriggerCap><!--opt, xs: EventTriggerCapType, face picture
comparison alarm linkage--></FaceContrastTriggerCap>
<WhiteListFaceContrastTriggerCap><!--opt, xs: EventTriggerCapType--></
WhiteListFaceContrastTriggerCap>
<HumanRecognitionTriggerCap><!--opt,xs: EventTriggerCapType--></
HumanRecognitionTriggerCap>
<FaceSnapTriggerCap><!--opt, xs: EventTriggerCapType--></FaceSnapTriggerCap>
<isSupportWhiteLightAction>
<!--dep, xs: boolean, see details in EventTriggerCapType, it is valid when
isSupportWhiteLight is "true"-->
</isSupportWhiteLightAction>
<isSupportAudioAction>
<!--dep, xs: boolean, see details in EventTriggerCapType, it is valid when
isSupportBeep is "true"-->
</isSupportAudioAction>
<HFPDTriggerCap><!--opt, xs: EventTriggerCapType--></HFPDTriggerCap>
<MixedTargetDetectionCap><!--opt, xs: EventTriggerCapType--></
MixedTargetDetectionCap>
<HVTVehicleDetectionTriggerCap><!--opt, xs: EventTriggerCapType--></
HVTVehicleDetectionTriggerCap>
<VCATriggerCap><!--opt, xs: EventTriggerCapType--></VCATriggerCap>
<PIRCap><!--opt, xs: EventTriggerCapType--></PIRCap>
<IllegalParkingTriggerCap><!--opt, xs: EventTriggerCapType, whether to
support illegal parking detection--></IllegalParkingTriggerCap>
<PedestrianTriggerCap><!--opt, xs: EventTriggerCapType, whether to support
pedestrian detection--></PedestrianTriggerCap>

95
 Heat Map Application ISAPI User Manual

<TrafficAccidentTriggerCap><!--opt, xs: EventTriggerCapType, whether to

support traffic accident detection--></TrafficAccidentTriggerCap>
<ConstructionTriggerCap><!--opt, xs: EventTriggerCapType, whether to support
construction detection--></ConstructionTriggerCap>
<RoadBlockTriggerCap><!--opt, xs: EventTriggerCapType, whether to support
roadblock detection--></RoadBlockTriggerCap>
<AbandonedObjectTriggerCap><!--opt, xs: EventTriggerCapType, whether to
support thrown object detection--></AbandonedObjectTriggerCap>
<ParallelParkingTriggerCap><!--opt, xs: EventTriggerCapType, whether to
support parallel parking detection--></ParallelParkingTriggerCap>
<ParkingStateTriggerCap><!--opt, xs: EventTriggerCapType, whether to support
parking space status detection, currently this node is not supported--></
ParkingStateTriggerCap>
<CongestionTriggerCap><!--opt, xs: EventTriggerCapType, whether to support
congestion detection--></CongestionTriggerCap>
<IntersectionAnalysisCap><!--opt, xs: EventTriggerCapType, whether to support
intersection analysis--></IntersectionAnalysisCap>
</EventTriggersCap>

See Also
XML_EventTriggerCapType

6.35 XML_EventTriggerCapType
EventTriggerCapType message in XML format
<EventTriggerCapType version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportCenter><!--opt, xs:boolean--></isSupportCenter>
<isSupportRecord><!--opt, xs:boolean--></isSupportRecord>
<isSupportMonitorAlarm><!--opt, xs:boolean--></isSupportMonitorAlarm>
<isSupportBeep><!--opt, xs: boolean, whether supports audible warning--></
isSupportBeep>
<isSupportIO><!--opt, xs:boolean--></isSupportIO>
<isSupportFTP><!--opt, xs:boolean--></isSupportFTP>
<isSupportEmail><!--opt, xs:boolean--></isSupEmail>
<isSupportLightAudioAlarm><!--opt, xs:boolean--></isSupportLightAudioAlarm>
<isSupportFocus><!--opt, xs:boolean--></isSupportFocus>
<isSupportPTZ><!--opt, xs:boolean--></isSupportPTZ>
<maxPresetActionNum>
<!--dep, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPresetActionNum>
<maxPatrolActionNum>
<!--dep, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPatrolActionNum>
<maxPatternActionNum>
<!--dep, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPatternActionNum>
<isSupportTrack><!--opt, xs:boolean--></isSupportTrack>
<isSupportWhiteLight>
<!--opt, xs: boolean, whether supports supplement light alarm linkage-->

96
 Heat Map Application ISAPI User Manual

</isSupportWhiteLight>
<isSupportCloud><!--opt, xs:boolean--></isSupportCloud>
</EventTriggerCapType>

6.36 XML_HttpHostNotification
HttpHostNotification message in XML format
<HttpHostNotification version="2.0" xmlns="http://www.isapi.org/ver20/
XMLSchema">
<id><!--req, xs:string, ID--></id>
<url><!--req, xs:string, the absolute path, e.g., http://<ipAddress>:<portNo>/
<uri>--></url>
<protocolType><!--req, xs:string, "HTTP,HTTPS,EHome"--></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>
<eventType opt="AID,TFS,TPS"><!--req, xs:string--></eventType>
<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>

Example
Message Example of HttpHostNotification
<HttpHostNotification version="2.0" xmlns="http://www.hikvision.com/ver20/
XMLSchema">
<id>1</id>
<url></url>
<protocolType>HTTP</protocolType>
<parameterFormatType>XML</parameterFormatType>
<addressingFormatType>ipaddress</addressingFormatType>
<ipAddress>0.0.0.0</ipAddress>

97
 Heat Map Application ISAPI User Manual

<portNo>80</portNo>
<userName></userName>
<httpAuthenticationMethod>none</httpAuthenticationMethod>
</HttpHostNotification>

6.37 XML_HttpHostNotificationCap
HttpHostNotificationCap capability message in XML format
<HttpHostNotificationCap version="2.0" xmlns="http://www.isapi.org/ver20/
XMLSchema">
<hostNumber><!--Listening host No.--></hostNumber>
<urlLen max=""/>
<protocolType opt="HTTP,HTTPS,EHome"/>
<parameterFormatType opt="XML,querystring,JSON"/>
<addressingFormatType opt="ipaddress,hostname"/>
<ipAddress opt="ipv4,ipv6"/>
<portNo min="" max=""/>
<userNameLen min="" max=""/>
<passwordLen min="" max=""/>
<httpAuthenticationMethod opt="MD5digest,none"/>
<!--req, if the digest authentication is supported, configuring user name
and password should be supported-->
<uploadImagesDataType opt="URL,binary"/>
</HttpHostNotificationCap>

Example
HttpHostNotificationCap Message Example
<HttpHostNotificationCap version="2.0" xmlns="http://www.hikvision.com/ver20/
XMLSchema">
<hostNumber>3</hostNumber>
<urlLen max="64" />
<protocolType opt="HTTP" />
<parameterFormatType opt="XML" />
<addressingFormatType opt="ipaddress,hostname" />
<ipAddress opt="ipv4,ipv6" />
<portNo min="1" max="65535" />
<userNameLen min="5" max="32" />
<passwordLen min="5" max="32" />
<httpAuthenticationMethod opt="none" />
<uploadImagesDataType opt="URL,binary" />
</HttpHostNotificationCap>

6.38 XML_HttpHostNotificationList
HttpHostNotificationList message in XML format

98
 Heat Map Application ISAPI User Manual

<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>
</HttpHostNotification>
</HttpHostNotificationList>

99
 Heat Map Application ISAPI User Manual

6.39 XML_HttpHostTestResult
HttpHostTestResult message in XML format.
<HttpHostTestResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<errorDescription>
<!--req, xs:string-->
</errorDescription>
</HttpHostTestResult>

6.40 XML_Schedule
Schedule message in XML format
<Schedule version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs:string, ID--></id>
<eventType>
<!--opt, xs:string, alarm/event types, see details in the "Remarks" below-->
</eventType>
<inputIOPortID><!--ro, dep, xs:string, alarm input No.--></inputIOPortID>
<outputIOPortID><!--ro, dep, xs:string, alarm output No.--></inputIOPortID>
<videoInputChannelID><!--ro, dep, xs:string, video input channel ID--></
videoInputChannelID>
<TimeBlockList size="8"><!--req-->
<TimeBlock>
<dayOfWeek>
<!--opt, xs:integer, day of the week based on ISO8601, "1"=Monday, ...--
>
</dayOfWeek>
<TimeRange><!--req-->
<beginTime><!--req, xs:time, ISO8601 time--></beginTime>
<endTime><!--req, xs:time, ISO8601 time--></endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
<HolidayBlockList><!--opt-->
<TimeBlock>
<TimeRange><!--req-->
<beginTime><!--req, xs:time, ISO8601 time--></beginTime>
<endTime><!--req, xs:time, ISO8601 time--></endTime>
</TimeRange>
</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,

100
 Heat Map Application ISAPI User Manual

rapidMove, parking, unattendedBaggage,attendedBaggage, storageDetection, shipsDetection,

HUMANATTRIBUTE, humanAttribute, faceContrast, faceSnap, faceLib, whiteListFaceContrast,
personDensityDetection, mixedTargetDetection, fireDetection, illegalParking, pedestrian,
trafficAccident,construction, roadblock, abandonedObject, parallelParking, parkingState,
congestion, intersectionAnalysis, heatMap.
Example
Schedule Message Example of Face Picture Comparison Alarm (Front-End Device)
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceLib-1</id>
<eventType>faceLib</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8">
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>

101
 Heat Map Application ISAPI User Manual

<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
Schedule Message Example of Face Picture Comparison Alarm (Rear-End Device)
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>faceContrast-1</id>
<eventType>faceContrast</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8">
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>

102
 Heat Map Application ISAPI User Manual

<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
Schedule Message Example of Stranger Detection Alarm (Rear-End Device)
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>whiteListFaceContrast-1</id>
<eventType>whiteListFaceContrast</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8">
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>

103
 Heat Map Application ISAPI User Manual

<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
Schedule Message Example of Mixed-Target-Type Detection Alarm
<?xml version="1.0" encoding="UTF-8"?>
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>mixedTargetDetection-2</id>
<eventType>mixedTargetDetection</eventType>
<videoInputChannelID>2</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>

104
 Heat Map Application ISAPI User Manual

</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>00:00</beginTime>
<endTime>24:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Illegal Parking Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>illegalParking-1</id>
<eventType>illegalParking</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>

105
 Heat Map Application ISAPI User Manual

</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Pedestrian Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>pedestrian-1</id>

106
 Heat Map Application ISAPI User Manual

<eventType>pedestrian</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>

107
 Heat Map Application ISAPI User Manual

</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Traffic Accident Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>trafficAccident-1</id>
<eventType>trafficAccident</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>

108
 Heat Map Application ISAPI User Manual

</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Construction Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>construction-1</id>
<eventType>construction</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>

109
 Heat Map Application ISAPI User Manual

</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Roadblock Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>roadBlock-1</id>
<eventType>roadBlock</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>

110
 Heat Map Application ISAPI User Manual

<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Thrown Object Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>abandonedObject-1</id>
<eventType>abandonedObject</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>

111
 Heat Map Application ISAPI User Manual

<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Congestion Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>congestion-1</id>
<eventType>congestion</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>

112
 Heat Map Application ISAPI User Manual

<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

Example
XML_Schedule Message Example of Arming Schedule for Fog Detection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>fogDetection-1</id>
<eventType>fogDetection</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>

113
 Heat Map Application ISAPI User Manual

<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

114
 Heat Map Application ISAPI User Manual

Example
XML_Schedule Message Example of Arming Schedule for Traffic Data Collection
<Schedule version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<id>vehicleStatistics-1</id>
<eventType>vehicleStatistics</eventType>
<videoInputChannelID>1</videoInputChannelID>
<TimeBlockList size="8" >
<TimeBlock>
<dayOfWeek>1</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>2</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>3</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>4</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>5</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>6</dayOfWeek>
<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
<TimeBlock>
<dayOfWeek>7</dayOfWeek>

115
 Heat Map Application ISAPI User Manual

<TimeRange>
<beginTime>08:00</beginTime>
<endTime>18:00</endTime>
</TimeRange>
</TimeBlock>
</TimeBlockList>
</Schedule>

116
 Heat Map Application ISAPI User Manual

Appendix A. Error Codes in ResponseStatus

The error classification returned by the ResponseStatus message is based on the status codes of
HTTP protocol. 7 kinds of status codes are predefined, including 1 (OK), 2 (Device Busy), 3 (Device
Error), 4 (Invalid Operation), 5 (Invalid Message Format), 6 (Invalid Message Content), and 7
(Reboot Required). Each kind of status code contains multiple sub status codes, and the error
codes are in a one-to-one correspondence with the sub status codes.

StatusCode=1

SubStatusCode Error Code Description

ok 0x1 Operation completed.
riskPassword 0x10000002 Risky password.
armProcess 0x10000005 Arming process.

StatusCode=2

Sub Status Code Error Code Description

noMemory 0x20000001 Insufficient memory.
serviceUnavailable 0x20000002 The service is not available.
upgrading 0x20000003 Upgrading.
deviceBusy 0x20000004 The device is busy or no
response.
reConnectIpc 0x20000005 The video server is
reconnected.
transferUpgradePackageFailed 0x20000006 Transmitting device upgrade
data failed.
startUpgradeFailed 0x20000007 Starting upgrading device
failed.
getUpgradeProcessfailed. 0x20000008 Getting upgrade status failed.
certificateExist 0x2000000B The Authentication certificate
already exists.

117
 Heat Map Application ISAPI User Manual

StatusCode=3

Sub Status Code Error Code Description

deviceError 0x30000001 Hardware error.
badFlash 0x30000002 Flash operation error.
28181Uninitialized 0x30000003 The 28181 configuration is not
initialized.
socketConnectError 0x30000005 Connecting to socket failed.
receiveError 0x30000007 Receive response message
failed.
deletePictureError 0x3000000A Deleting picture failed.
pictureSizeExceedLimit 0x3000000C Too large picture size.
clearCacheError 0x3000000D Clearing cache failed.
updateDatabasError 0x3000000F Updating database failed.
searchDatabaseError 0x30000010 Searching in the database
failed.
writeDatabaseError 0x30000011 Writing to database failed.
deleteDatabaseError 0x30000012 Deleting database element
failed.
searchDatabaseElementError 0x30000013 Getting number of database
elements failed.
cloudAutoUpgradeException 0x30000016 Downloading upgrade packet
from cloud and upgrading
failed.
HBPException 0x30001000 HBP exception.
UDEPException 0x30001001 UDEP exception
elasticSearchException 0x30001002 Elastic exception.
kafkaException 0x30001003 Kafka exception.
HBaseException 0x30001004 Hbase exception.
sparkException 0x30001005 Spark exception.
yarnException 0x30001006 Yarn exception.
cacheException 0x30001007 Cache exception.

118
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

trafficException 0x30001008 Monitoring point big data
server exception.
faceException 0x30001009 Human face big data server
exception.
wifiException 0x3000100A Wi-Fi big data server exception.
structException 0x3000100D Video parameters structure
server exception.

StatusCode=4

Sub Status Code Error Code Description

notSupport 0x40000001 Not supported.
lowPrivilege 0x40000002 No permission.
badAuthorization 0x40000003 Authentication failed.
methodNotAllowed 0x40000004 Invalid HTTP method.
notSetHdiskRedund 0x40000005 Setting spare HDD failed.
invalidOperation 0x40000006 Invalid operation.
notActivated 0x40000007 Inactivated.
hasActivated 0x40000008 Activated.
certificateAlreadyExist 0x40000009 The certificate already exists.
operateFailed 0x4000000F Operation failed.
upgradePackageMorethan2GB 0x40001000 Up to 2GB upgrade package is
allowed to be uploaded.
IDNotexist 0x40001001 The ID does not exist.
synchronizationError 0x40001003 Synchronization failed.
synchronizing 0x40001004 Synchronizing.
importError 0x40001005 Importing failed.
importing 0x40001006 Importing.
fileAlreadyExists 0x40001007 The file already exists.
invalidID 0x40001008 Invalid ID.
backupnodeNotAlloweLog 0x40001009 Accessing to backup node is
not allowed.

119
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

exportingError 0x4000100A Exporting failed.
exporting 0x4000100B Exporting.
exportEnded 0x4000100C Exporting stopped.
exported 0x4000100D Exported.
IPOccupied 0x4000100E The IP address is already
occupied.
IDAlreadyExists 0x4000100F The ID already exists.
exportItemsExceedLimit 0x40001010 No more items can be
exported.
noFiles 0x40001011 The file does not exist.
beingExportedByAnotherUser 0x40001012 Being exported by others.
needReAuthentication 0x40001013 Authentication is needed after
upgrade.
unitAddNotOnline 0x40001015 The added data analysis server
is offline.
unitControl 0x40001016 The data analysis server is
already added.
analysis unitFull 0x40001017 No more data analysis server
can be added.
unitIDError 0x40001018 The data analysis server ID
does not exist.
unitExit 0x40001019 The data analysis server
already exists in the list.
unitSearch 0x4000101A Searching data analysis server
in the list failed.
unitNotOnline 0x4000101B The data analysis server is
offline.
unitInfoEror 0x4000101C Getting data analysis server
information failed.
unitGetNodeInfoError 0x4000101D Getting node information
failed.

120
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

unitGetNetworkInfoError 0x4000101E Getting the network
information of data analysis
server failed
unitSetNetworkInfoError 0x4000101F Setting the network
information of data analysis
server failed
setSmartNodeInfoError 0x40001020 Setting node information
failed.
setUnitNetworkInfoError 0x40001021 Setting data analysis server
network information failed.
unitRestartCloseError 0x40001022 Rebooting or shutting down
data analysis server failed.
virtualIPnotAllowed 0x40001023 Adding virtual IP address is not
allowed.
unitInstalled 0x40001024 The data analysis server is
already installed.
badSubnetMask 0x40001025 Invalid subnet mask.
uintVersionMismatched 0x40001026 Data analysis server version
mismatches.
deviceMOdelMismatched 0x40001027 Adding failed. Device model
mismatches.
unitAddNotSelf 0x40001028 Adding peripherals is not
allowed.
noValidUnit 0x40001029 No valid data analysis server.
unitNameDuplicate 0x4000102A Duplicated data analysis server
name.
deleteUnitFirst 0x4000102B Delete the added data analysis
server of the node first.
getLocalInfoFailed 0x4000102C Getting the server information
failed.
getClientAddedNodeFailed 0x4000102D Getting the added node
information of data analysis
server failed.
taskExit 0x4000102E The task already exists.

121
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

taskInitError 0x4000102F Initializing task failed.
taskSubmitError 0x40001030 Submiting task failed.
taskDelError 0x40001031 Deleting task failed.
taskPauseError 0x40001032 Pausing task failed.
taskContinueError 0x40001033 Starting task failed.
taskSeverNoCfg 0x40001035 Full-text search server is not
configured.
taskPicSeverNoCfg 0x40001036 The picture server is not
configured.
taskStreamError 0x40001037 Streaming information
exception.
taskRecSDK 0x40001038 History recording is not
supported.
taskCasaError 0x4000103A Cascading is not supported.
taskVCARuleError 0x4000103B Invalid VCA rule.
taskNoRun 0x4000103C The task is not executed.
unitLinksNoStorageNode 0x4000103D No node is linked with the data
analysis server. Configure the
node first.
searchFailed 0x4000103E Searching video files failed.
searchNull 0x4000103F No video clip.
userScheOffline 0x40001040 The task scheduler service is
offline.
updateTypeUnmatched 0x40001041 The upgrade package type
mismatches.
userExist 0x40001043 The user already exists.
userCannotDelAdmin 0x40001044 The administrator cannot be
deleted.
userInexistence 0x40001045 The user name does not exist.
userCannotCreatAdmin 0x40001046 The administrator cannot be
created.

122
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

monitorCamExceed 0x40001048 Up to 3000 cameras can be
added.
monitorCunitOverLimit 0x40001049 Adding failed. Up to 5 lower-
levels are supported by the
control center.
monitorReginOverLimit 0x4000104A Adding failed. Up to 5 lower-
levels are supported by the
area.
monitorArming 0x4000104B The camera is already armed.
Disarm the camera and try
again.
monitorSyncCfgNotSet 0x4000104C The system parameters are not
configured.
monitorFdSyncing 0x4000104E Synchronizing. Try again after
completing the
synchronization.
monitorParseFailed 0x4000104F Parsing camera information
failed.
monitorCreatRootFailed 0x40001050 Creating resource node failed.
deleteArmingInfo 0x40001051 The camera is already . Disarm
the camera and try again.
cannotModify 0x40001052 Editing is not allowed. Select
again.
cannotDel 0x40001053 Deletion is not allowed. Select
again.
deviceExist 0x40001054 The device already exists.
IPErrorConnectFailed 0x40001056 Connection failed. Check the
network port.
cannotAdd 0x40001057 Only the capture cameras can
be added.
serverExist 0x40001058 The server already exists.
fullTextParamError 0x40001059 Incorrect full-text search
parameters.

123
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

storParamError 0x4000105A Incorrect storage server
parameters.
picServerFull 0x4000105B The storage space of picture
storage server is full.
NTPUnconnect 0x4000105C Connecting to NTP server
failed. Check the parameters.
storSerConnectFailed 0x4000105D Connecting to storage server
failed. Check the network port.
storSerLoginFailed 0x4000105E Logging in to storage server
failed. Check the user name
and password.
searchSerConnectFailed 0x4000105F Connecting to full-text search
server failed. Check the
network port.
searchSerLoginFailed 0x40001060 Logging in to full-text search
server failed. Check the user
name and password.
kafkaConnectFailed 0x40001061 Connecting to Kafka failed.
Check the network port.
mgmtConnectFailed 0x40001062 Connecting to system failed.
Check the network port.
mgmtLoginFailed 0x40001063 Logging in to system failed.
Check the user name and
password.
TDAConnectFailed 0x40001064 Connecting to traffic data
access server failed. Checking
the server status.
86sdkConnectFailed 0x40001065 Connecting to listening port of
iVMS-8600 System failed.
Check the parameters.
nameExist 0x40001066 Duplicated server name.
batchProcessFailed 0x40001067 Processing in batch failed.
IDNotExist 0x40001068 The server ID does not exist.
serviceNumberReachesLimit 0x40001069 No more service can be added.

124
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

invalidServiceType. 0x4000106A Invalid service type.
clusterGetInfo 0x4000106B Getting cluster group
information failed.
clusterDelNode 0x4000106C Deletion node failed.
clusterAddNode 0x4000106D Adding node failed.
clusterInstalling 0x4000106E Creating cluster…Do not
operate.
clusterUninstall 0x4000106F Reseting cluster…Do not
operate.
clusterInstall 0x40001070 Creating cluster failed.
clusterIpError 0x40001071 Invalid IP address of task
scheduler server.
clusterNotSameSeg 0x40001072 The master node and slave
node must be in the same
network segment.
clusterVirIpError 0x40001073 Automatically getting virtual IP
address failed. Enter manually.
clusterNodeUnadd 0x40001074 The specified master(slave)
node is not added.
clusterNodeOffline 0x40001075 The task scheduler server is
offline.
nodeNotCurrentIP 0x40001076 The analysis node of the
current IP address is required
when adding master and slave
nodes.
addNodeNetFailed 0x40001077 Adding node failed. The
network disconnected.
needTwoMgmtNode 0x40001078 Two management nodes are
required when adding master
and slave nodes.
ipConflict 0x40001079 The virtual IP address and data
analysis server's IP address
conflicted.

125
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

ipUsed 0x4000107A The virtual IP address has been
occupied.
cloudAlalyseOnline 0x4000107B The cloud analytic server is
online.
virIP&mainIPnotSameNetSegm 0x4000107C The virtual IP address is not in
ent the same network segment
with the IP address of master/
slave node.
getNodeDispatchInfoFailed 0x4000107D Getting node scheduler
information failed.
unableModifyManagementNet 0x4000107E Editing management network
workIP interface failed. The analysis
board is in the cluster.
notSpecifyVirtualIP 0x4000107F Virtual IP address should be
specified for master and slave
cluster.
armingFull 0x40001080 No more device can be armed.
armingNoFind 0x40001081 The arming information does
not exist.
disArming 0x40001082 Disarming failed.
getArmingError 0x40001084 Getting arming information
failed.
refreshArmingError 0x40001085 Refreshing arming information
failed.
ArmingPlateSame 0x40001086 The license plate number is
repeatedly armed.
ArmingParseXLSError 0x40001087 Parsing arming information file
failed.
ArmingTimeError 0x40001088 Invalid arming time period.
ArmingSearchTimeError 0x40001089 Invalid search time period.
armingRelationshipReachesLim 0x4000108A No more relation can be
it created.
duplicateAarmingName 0x4000108B The relation name already
exists.

126
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

noMoreArmingListAdded 0x4000108C No more blacklist library can be
armed.
noMoreCamerasAdded 0x4000108D No more camera can be armed.
noMoreArmingListAddedWithC 0x4000108E No more library can be linked
amera to the camera.
noMoreArmingPeriodAdded 0x4000108F No more time period can be
added to the arming schedule.
armingPeriodsOverlapped 0x40001090 The time periods in the arming
schedule are overlapped.
noArmingAlarmInfo 0x40001091 The alarm information does
not exist.
armingAlarmUnRead 0x40001092 Getting number of unread
alarms failed.
getArmingAlarmError 0x40001093 Getting alarm information
failed.
searchByPictureTimedOut 0x40001094 Searching picture by picture
timeout. Search again.
comparisonTimeRangeError 0x40001095 Comparison time period error.
selectMonitorNumberUpperLi 0x40001096 No more monitoring point ID
mit can be filtered.
noMoreComparisonTasksAdde 0x40001097 No more comparison task can
d be executed at the same time.
GetComparisonResultFailed 0x40001098 Getting comparison result
failed.
comparisonTypeError 0x40001099 Comparison type error.
comparisonUnfinished 0x4000109A The comparison is not
completed.
facePictureModelInvalid 0x4000109B Invalid face model.
duplicateLibraryName. 0x4000109C The library name already exists.
noRecord 0x4000109D No record found.
countingRecordsFailed. 0x4000109E Calculate the number of
records failed.

127
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

getHumanFaceFrameFailed 0x4000109F Getting face thumbnail from
the picture failed.
modelingFailed. 0x400010A0 Modeling face according to
picture URL failed.
1V1FacePictureComparisonFail 0x400010A1 Comparison 1 VS 1 face picture
ed failed.
libraryArmed 0x400010A2 The blacklist library is armed.
licenseExeedLimit 0x400010A3 Dongle limited.
licenseExpired 0x400010A4 Dongle expired.
licenseDisabled 0x400010A5 Unavailable dongle.
licenseNotExist 0x400010A6 The dongle does not exist.
SessionExpired 0x400010A7 Session expired .
beyondConcurrentLimit 0x400010A8 Out of concurrent limit.
stopSync 0x400010A9 Synchronization stopped.
getProgressFaild 0x400010AA Getting progress failed.
uploadExtraCaps 0x400010AB No more files can be uploaded.
timeRangeError 0x400010AC Time period error.
dataPortNotConnected 0x400010AD The data port is not connected.
addClusterNodeFailed 0x400010AE Adding to the cluster failed.
The device is already added to
other cluster.
taskNotExist 0x400010AF The task does not exist.
taskQueryFailed 0x400010B0 Searching task failed.
modifyTimeRuleFailed 0x400010B2 The task already exists. Editing
time rule is not allowed.
modifySmartRuleFailed 0x400010B3 The task already exists. Editing
VAC rule is not allowed.
queryHistoryVideoFailed 0x400010B4 Searching history video failed.
addDeviceFailed 0x400010B5 Adding device failed.
addVideoFailed 0x400010B6 Adding video files failed.
deleteAllVideoFailed 0x400010B7 Deleting all video files failed.

128
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

createVideoIndexFailed 0x400010B8 Indexing video files failed.
videoCheckTypeFailed 0x400010B9 Verifying video files types
failed.
configStructuredAddressFailed 0x400010BA Configuring IP address of
structured server failed.
configPictureServerAddressFail 0x400010BB Configuring IP address of
ed picture storaged server failed.
storageServiceIPNotExist 0x400010BD The storage server IP address
does not exist.
syncBackupDatabaseFailed 0x400010BE Synchronizing slave database
failed. Try again.
syncBackupNTPTimeFailed 0x400010BF Synchronizing NTP time of
slave server failed.
clusterNotSelectLoopbackAddr 0x400010C0 Loopbacl address is not
ess supported by the master or
slave cluster.
addFaceRecordFailed 0x400010C1 Adding face record failed.
deleteFaceRecordFailed 0x400010C2 Deleting face record failed.
modifyFaceRecordFailed 0x400010C3 Editing face record failed.
queryFaceRecordFailed 0x400010C4 Searching face record failed.
faceDetectFailed 0x400010C5 Detecting face failed.
libraryNotExist 0x400010C6 The library does not exist.
blackListQueryExporting 0x400010C7 Exporting matched blacklists.
blackListQueryExported 0x400010C8 The matched blacklists are
exported.
blackListQueryStopExporting 0x400010C9 Exporting matched blacklists is
stopped.
blackListAlarmQueryExporting 0x400010CA Exporting matched blacklist
alarms.
blackListAlarmQueryExported 0x400010CB The matched blacklists alarms
are exported.
blackListAlarmQueryStopExport 0x400010CC Exporting matched blacklist
ing alarms is stopped.

129
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

getBigDataCloudAnalysisFailed 0x400010CD Getting big data cloud analytic
information failed.
setBigDataCloudAnalysisFailed 0x400010CE Configuring big data cloud
analytic failed.
submitMapSearchFailed 0x400010CF Submitting search by picture
task failed.
controlRelationshipNotExist 0x400010D0 The relation does not exist.
getHistoryAlarmInfoFailed 0x400010D1 Getting history alarm
information failed.
getFlowReportFailed 0x400010D2 Getting people counting report
failed.
addGuardFailed 0x400010D3 Adding arming configuration
failed.
deleteGuardFailed 0x400010D4 Deleting arming configuration
failed.
modifyGuardFailed 0x400010D5 Editing arming configuration
failed.
queryGuardFailed 0x400010D6 Searching arming
configurations failed.
uploadUserSuperCaps 0x400010D7 No more user information can
be uploaded.
bigDataServerConnectFailed 0x400010D8 Connecting to big data server
failed.
microVideoCloudRequestInfoB 0x400010D9 Adding response information of
uildFailed micro video cloud failed.
microVideoCloudResponseInfo 0x400010DA Parsing response information
BuildFailed of micro video cloud failed.
transcodingServerRequestInfoB 0x400010DB Adding response information of
uildFailed transcoding server failed.
transcodingServerResponseInfo 0x400010DC Parsing response information
ParseFailed of transcoding server failed.
transcodingServerOffline 0x400010DD Transcoding server is offline.
microVideoCloudOffline 0x400010DE Micro video cloud is offline.

130
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

UPSServerOffline 0x400010DF UPS monitor server is offline.
statisticReportRequestInfoBuild 0x400010E0 Adding response information of
Failed statistics report failed.
statisticReportResponseInfoPar 0x400010E1 Parsing response information
seFailed of statistics report failed.
DisplayConfigInfoBuildFailed 0x400010E2 Adding display configuration
information failed.
DisplayConfigInfoParseFailed 0x400010E3 Parsing display configuration
information failed.
DisplayConfigInfoSaveFailed 0x400010E4 Saving display configuration
information failed.
notSupportDisplayConfigType 0x400010E5 The display configuration type
is not supported.
passError 0x400010E7 Incorrect password.
upgradePackageLarge 0x400010EB Too large upgrade package.
sesssionUserReachesLimit 0x400010EC No more user can log in via
session.
ISO 8601TimeFormatError 0x400010ED Invalid ISO8601 time format.
clusterDissolutionFailed 0x400010EE Deleting cluster failed.
getServiceNodeInfoFailed 0x400010EF Getting service node
information failed.
getUPSInfoFailed 0x400010F0 Getting UPS configuration
information failed.
getDataStatisticsReportFailed 0x400010F1 Getting data statistic report
failed.
getDisplayConfigInfoFailed 0x400010F2 Getting display configuration
failed.
namingAnalysisBoardNotAllow 0x400010F3 Renaming analysis board is not
ed allowed.
onlyDrawRegionsOfConvexPoly 0x400010F4 Only drawing convex polygon
gon area is supported.
bigDataServerResponseInfoPar 0x400010F5 Parsing response message of
seFailed big data service failed.

131
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

bigDataServerReturnFailed 0x400010F6 No response is returned by big
data service.
microVideoReturnFailed 0x400010F7 No response is returned by
micro video cloud service.
transcodingServerReturnFailed 0x400010F8 No response is returned by
transcoding service.
UPSServerReturnFailed 0x400010F9 No response is returned by UPS
monitoring service.
forwardingServer ReturnFailed 0x400010FA No response is returned by
forwarding service.
storageServer ReturnFailed 0x400010FB No response is returned by
storage service.
cloudAnalysisServerReturnFaile 0x400010FC No response is returned by
d cloud analytic service.
modelEmpty 0x400010FD No model is obtained.
mainAndBackupNodeCannotM 0x400010FE Editing the management
odifyManagementNetworkInte interface IP address of master
rfaceIP node and backup node is not
allowed.
IDTooLong 0x400010FF The ID is too long.
pictureCheckFailed 0x40001100 Detecting picture failed.
pictureModelingFailed 0x40001101 Modeling picture failed.
setCloudAnalsisDefaultProvince 0x40001102 Setting default province of
Failed cloud analytic service failed.
InspectionAreasNumberExceed 0x40001103 No more detection regions can
Limit be added.
picturePixelsTooLarge 0x40001105 The picture resolution is too
high.
picturePixelsTooSmall 0x40001106 The picture resolution is too
low.
storageServiceIPEmpty 0x40001107 The storage server IP address is
required.

132
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

bigDataServerRequestInfoBuild 0x40001108 Creating request message of
Fail big data service failed.
analysiTimedOut 0x40001109 Analysis time out.
high- 0x4000110A Please enable high-
performanceModeDisabled. performance mode.
configuringUPSMonitoringServ 0x4000110B Configurating the UPS
erTimedOut monitoring server time out.
Check IP address.
cloudAnalysisRequestInformati 0x4000110C Creating request message of
onBuildFailed cloud analytic service failed.
cloudAnalysisResponseInformat 0x4000110D Parsing response message of
ionParseFailed cloud analytic service failed.
allCloudAnalysisInterfaceFailed 0x4000110E Calling API for cloud analytic
service failed.
cloudAnalysisModelCompareFa 0x4000110F Model comparison of cloud
iled analytic service failed.
cloudAnalysisFacePictureQualit 0x40001110 Getting face quality grading of
yRatingFailed cloud analytic service failed.
cloudAnalysisExtractFeaturePoi 0x40001111 Extracting feature of cloud
ntsFailed analytic service failed.
cloudAnalysisExtractPropertyFa 0x40001112 Extracting property of cloud
iled analytic service failed.
getAddedNodeInformationFaile 0x40001113 Getting the added nodes
d information of data analysis
server failed.
noMoreAnalysisUnitsAdded 0x40001114 No more data analysis servers
can be added.
detectionAreaInvalid 0x40001115 Invalid detection region.
shieldAreaInvalid 0x40001116 Invalid shield region.
noMoreShieldAreasAdded 0x40001117 No more shield region can be
drawn.
onlyAreaOfRectangleShapeAllo 0x40001118 Only drawing rectangle is
wed allowed in detection area.

133
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

numberReachedLlimit 0x40001119 Number reached the limit.
wait1~3MinutesGetIPAfterSetu 0x4000111A Wait 1 to 3 minutes to get IP
pDHCP address after configuring DHCP.
plannedTimeMustbeHalfAnHou 0x4000111B Schedule must be half an hour.
r
oneDeviceCannotBuildCluster 0x4000111C Creating master and backup
cluster requires at least two
devices.
updatePackageFileNotUploade 0x4000111E Upgrade package is not
d uploaded.
highPerformanceTasksNotSupp 0x4000111F Drawing detection area is not
ortDrawingDetectionRegions allowed under high-
performance mode.
controlCenterIDDoesNotExist 0x40001120 The control center ID does not
exist.
regionIDDoesNotExist 0x40001121 The area ID does not exist.
licensePlateFormatError 0x40001122 Invalid license plate format.
managementNodeDoesNotSup 0x40001123 The operation is not supported.
portThisOperation
searchByPictureResourceNotCo 0x40001124 The conditions for searching
nfiged picture by picture are not
configured.
videoFileEncapsulationFormat 0x40001125 The video container format is
NotSupported not supported.
videoPackageFailure 0x40001126 Converting video container
format failed.
videoCodingFormatNotSupport 0x40001127 Video coding format is not
ed supported.
monitorOfDeviceArmingdelete 0x40001129 The camera is armed. Disarm it
ArmingInfo and try again.
getVideoSourceTypeFailed 0x4000112A Getting video source type
failed.
smartRulesBuildFailed 0x4000112B Creating VAC rule failed.

134
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

smartRulesParseFailed 0x4000112C Parsing VAC rule failed.
timeRulesBuildFailed 0x4000112D Creating time rule failed.
timeRulesParseFailed 0x4000112E Parsing time rule failed.
monitoInfoInvalid 0x4000112F Invalid camera information.
addingFailedVersionMismatche 0x40001130 Adding failed. The device
s version mismatches.
theInformationReturnedAfterCl 0x40001131 No response is returned by the
oudAnalysisIsEmpty cloud analytic service.
selectingIpAddressOfHostAndS 0x40001132 Setting IP address for master
pareNodeFailedCheckTheStatu node and backup node failed.
s Check the node status.
theSearchIdDoesNotExist 0x40001133 The search ID does not exist.
theSynchronizationIdDoesNotE 0x40001134 The synchronization ID does
xist not exist.
theUserIdDoesNotExist 0x40001136 The user ID does not exist.
theIndexCodeDoesNotExist 0x40001138 The index code does not exist.
theControlCenterIdDoesNotExi 0x40001139 The control center ID does not
st exist.
theAreaIdDoesNotExist 0x4000113A The area ID does not exist.
theArmingLinkageIdDoesNotExi 0x4000113C The arming relationship ID
st does not exist.
theListLibraryIdDoesNotExist 0x4000113D The list library ID does not
exist.
invalidCityCode 0x4000113E Invalid city code.
synchronizingThePasswordOfSp 0x4000113F Synchronizing backup system
areServerFailed password failed.
editingStreamingTypeIsNotSup 0x40001140 Editing streaming type is not
ported supported.
switchingScheduledTaskToTem 0x40001141 Switching scheduled task to
poraryTaskIsNotSupported temporary task is not
supported.

135
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

switchingTemporaryTaskToSche 0x40001142 Switching temporary task to
duledTaskIsNotSupported scheduled task is not
supported.
theTaskIsNotDispatchedOrItIsU 0x40001143 The task is not dispatched or is
pdating updating.
thisTaskDoesNotExist 0x40001144 This task does not exist in the
cloud analytic serice.
duplicatedSchedule 0x40001145 Schedule period cannot be
overlapped.
continuousScheduleWithSame 0x40001146 The continuous schedule
AlgorithmTypeShouldBeMerge periods with same algorithm
d type should be merged.
invalidStreamingTimeRange 0x40001147 Invalid streaming time period.
invalidListLibraryType 0x40001148 Invalid list library type.
theNumberOfMatchedResultsS 0x40001149 The number of search results
houldBeLargerThan0 should be larger than 0.
invalidValueRangeOfSimilarity 0x4000114A Invalid similarity range.
invalidSortingType 0x4000114B Invalid sorting type.
noMoreListLibraryCanBeLinked 0x4000114C No more lists can be added to
ToTheDevice one device.
InvalidRecipientAddressFormat 0x4000114D Invalid address format of result
receiver.
creatingClusterFailedTheDongl 0x4000114E Insert the dongle before
eIsNotPluggedIn creating cluster.
theURLIsTooLong 0x4000114F No schedule configured for the
task.
noScheduleIsConfiguredForThe 0x40001150 No schedule configured for the
Task task.
theDongleIsExpiried 0x40001151 Dongle has expired.
dongleException 0x40001152 Dongle exception.
invalidKey 0x40001153 Invalid authorization service
key.

136
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

decryptionFailed 0x40001154 Decrypting authorization
service failed.
encryptionFailed 0x40001155 Encrypting authorization
service failed.
AuthorizeServiceResponseError 0x40001156 Authorization service response
exception.
incorrectParameter 0x40001157 Authorization service
parameters error.
operationFailed 0x40001158 Operating authorization service
error.
noAnalysisResourceOrNoDataI 0x40001159 No cloud analytic resources or
nTheListLibrary no data in the list library.
calculationException 0x4000115A Calculation exception.
allocatingList 0x4000115B Allocating list.
thisOperationIsNotSupportedB 0x4000115C This operation is not supported
yTheCloudAnalytics by the cloud analytic serice.
theCloudAnalyticsIsInterrupted 0x4000115D The operation of cloud analytic
serice is interrupted.
theServiceIsNotReady 0x4000115E The service is not ready.
searchingForExternalApiFailed 0x4000115F Searching external interfaces
failed.
noOnlineNode 0x40001160 No node is online.
noNodeAllocated 0x40001161 No allocated node.
noMatchedList 0x40001162 No matched list.
allocatingFailedTooManyFacePi 0x40001163 Allocation failed. Too many lists
ctureLists of big data service.
searchIsNotCompletedSearchA 0x40001164 Current searching is not
gain completed. Search again.
allocatingListIsNotCompleted 0x40001165 Allocating list is not completed.
searchingForCloudAnalyticsRes 0x40001166 Searching cloud analytic serice
ultsFailed overtime.

137
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

noDataOfTheCurrentLibraryFou 0x40001167 No data in the current library.
nd Make sure there is data in the
Hbase.
noFacePictureLibraryIsArmed 0x40001168 No face picture library is armed
for big data service.
noAvailableDataSlicingVersionI 0x40001169 Invalid standard version
nformationArmFirstAndSliceTh information.
eData
duplicatedOperationDataSlicing 0x4000116A Slicing failed. Duplicated
IsExecuting operation.
slicinDataFailedNoArmedFacePi 0x4000116B Slicing failed. No arming
ctureLibrary information in the face big
data.
GenerateBenchmarkFileFailedS 0x4000116C Generating sliced file failed.
licingAgain Slice again.
NonprimaryNodeIsProhibitedFr 0x4000116D Slicing is not allowed by the
omSlcingData backup node.
NoReadyNodeToClusterServers 0x4000116E Creating the cluster failed. No
ready node.
NodeManagementServiceIsOffl 0x4000116F The node management server
ine is offline.
theCamera(s)OfTheControlCent 0x40001170 Some cameras in control center
erAreAlreadyArmed.DisarmThe are already armed. Disarm
mFirst them and try again.
theCamera(s)OfTheAreaAreAlr 0x40001171 Some cameras in this area are
eadyArmed.DisarmThemFirst already armed. Disarm them
and try again.
configuringHigh- 0x40001172 Configuring high frequency
frequencyPeopleDetectionFaile people detection failed.
d
searchingForHigh- 0x40001173 Searching detection event logs
frequencyPeopleDetectionLogs of high-frequency people
Failed. detection failed.

138
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

gettingDetailsOfSearchedHigh- 0x40001174 Getting the search result
frequencyPeopleDetectionLogs details of high frequency
Failed. alarms failed.
theArmedCamerasAlreadyExistI 0x40001175 Some cameras in control center
nTheControlCenter are already armed.
disarmingFailedTheCameraIsNo 0x40001177 Disarming failed. The camera is
tArmed not armed.
noDataReturned 0x40001178 No response is returned by the
big data service.
preallocFailure 0x40001179 Pre-​allocating algorithm
resource failed.
overDogLimit 0x4000117A Configuration failed. No more
resources can be pre-allocated.
analysisServicesDoNotSupport 0x4000117B Not supported.
commandAndDispatchServiceE 0x4000117C Scheduling service of cloud
rror analytic serice error.
engineModuleError 0x4000117D Engine module of cloud
analytic serice error.
streamingServiceError 0x4000117E Streaming component of cloud
analytic serice error.
faceAnalysisModuleError 0x4000117F Face analysis module of cloud
analytic serice error.
vehicleAnalysisModuleError 0x40001180 Vehicle pictures analytic
module of cloud analytic serice
error.
videoStructuralAnalysisModule 0x40001181 Video structuring module of
Error cloud analytic serice error.
postprocessingModuleError 0x40001182 Post-processing module of
cloud analytic serice error.
frequentlyAppearedPersonAlar 0x40001183 High frequency alarm is already
mIsAlreadyConfiguredForListLi armed for blacklist library.
brary
creatingListLibraryFailed 0x40001184 Creating list library failed.

139
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

invalidIdentiryKeyOfListLibrary 0x40001185 Invalid identity key of list
library.
noMoreDevicesCanBeArmed 0x40001186 No more camera can be added.
settingAlgorithmTypeForDevice 0x40001187 Allocating task resource failed.
Failed
gettingHighFrequencyPersonDe 0x40001188 Setting high frequency alarm
tectionAlarmInformationFailed failed.
invalidSearchConfition 0x40001189 Invalid result.
theTaskIsNotCompleted 0x4000118B The task is not completed.
resourceOverRemainLimit 0x4000118C No more resource can be pre-
allocated.
frequentlyAppearedPersonAlar 0x4000118D The high frequency alarm of
mIs this camera is configured.
AlreadyConfiguredForTheCame Delete the arming information
raDisarmFirstAndTryAgain and try again.
armingFailed 0x40008000 Arming failed.
disarmingFailed 0x40008001 Disarming failed.
clearAlarmFailed 0x40008002 Clearing alarm failed.
bypassFailed 0x40008003 Bypass failed.
bypassRecoverFailed 0x40008004 Bypass recovery failed.
outputsOpenFailed 0x40008005 Opening relay failed.
outputsCloseFailed 0x40008006 Closing relay failed.
registerTimeOut 0x40008007 Registering timed out.
registerFailed 0x40008008 Registering failed.
addedByOtherHost 0x40008009 The peripheral is already added
by other security control panel.
alreadyAdded 0x4000800A The peripheral is already
added.
armedStatus 0x4000800B The partition is armed.
bypassStatus 0x4000800C Bypassed.
zoneNotSupport 0x4000800D This operation is not supported
by the zone.

140
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

zoneFault 0x4000800E The zone is in fault status.
pwdConflict 0x4000800F Password conflicted.
audioTestEntryFailed 0x40008010 Enabling audio test mode
failed.
audioTestRecoveryFailed 0x40008011 Disabling audio test mode
failed.
addCardMode 0x40008012 Adding card mode.
searchMode 0x40008013 Search mode.
addRemoterMode 0x40008014 Adding keyfob mode.
registerMode 0x40008015 Registration mode.
exDevNotExist 0x40008016 The peripheral does not exist.
theNumberOfExDevLimited 0x40008017 No peripheral can be added.
sirenConfigFailed 0x40008018 Setting siren failed.
chanCannotRepeatedBinded 0x40008019 This channel is already linked
by the zone.
inProgramMode 0x4000801B The keypad is in programming
mode.
inPaceTest 0x4000801C Pacing mode.
arming 0x4000801D Armed.

StatusCode=5

Sub Status Code Error Code Description

badXmlFormat 0x50000001 Invalid XML format.

StatusCode=6

Sub Status Code Error Code Description

badParameters 0x60000001 Invalid parameter.
badHostAddress 0x60000002 Invalid host IP address.
badXmlContent 0x60000003 Invalid XML content.
badIPv4Address 0x60000004 Invalid IPv4 address.
badIPv6Address 0x60000005 Invalid IPv6 address.

141
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

conflictIPv4Address 0x60000006 IPv4 address conflicted.
conflictIPv6Address 0x60000007 IPv6 address conflicted.
badDomainName 0x60000008 Invalid domain name.
connectSreverFail 0x60000009 Connecting to server failed.
conflictDomainName 0x6000000A Domain name conflicted.
badPort 0x6000000B Port number conflicted.
portError 0x6000000C Port error.
exportErrorData 0x6000000D Importing data failed.
badNetMask 0x6000000E Invalid sub-net mask.
badVersion 0x6000000F Version mismatches.
badDevType 0x600000010 Device type mismatches.
badLanguage 0x600000011 Language mismatches.
incorrentUserNameOrPasswor 0x600000012 Incorrect user name or
d password.
invalidStoragePoolOfCloudServ 0x600000013 Invalid storage pool. The
er storage pool is not configured
or incorrect ID.
noFreeSpaceOfStoragePool 0x600000014 Storage pool is full.
riskPassword 0x600000015 Risky password.
UnSupportCapture 0x600000016 Capturing in 4096*2160 or
3072*2048 resolution is not
supported when H.264+ is
enabled.
userPwdLenUnder8 0x60000023 At least two kinds of
characters, including digits,
letters, and symbols, should be
contained in the password.
userPwdNameSame 0x60000025 Duplicated password.
userPwdNameMirror 0x60000026 The password cannot be the
reverse order of user name.
beyondARGSRangeLimit 0x60000027 The parameter value is out of
limit.

142
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

analysisEnginesNoResourceErr 0x60001000 No analysis engine.
or
analysisEnginesUsageExcced 0x60001001 The engine usage is
overloaded.
PicAnalysisNoResourceError 0x60001002 No analysis engine provided for
picture secondary recognition.
analysisEnginesLoadingError 0x60001003 Initializing analysis engine.
analysisEnginesAbnormaError 0x60001004 Analysis engine exception.
analysisEnginesFacelibImportin 0x60001005 Importing pictures to face
g picture library. Failed to edit
analysis engine parameters.
analysisEnginesAssociatedChan 0x60001006 The analysis engine is linked to
nel channel.
smdEncodingNoResource 0x60001007 Insufficient motion detection
encoding resources.
smdDecodingNoResource 0x60001008 Insufficient motion detection
decoding resources.
diskError 0x60001009 HDD error.
diskFull 0x6000100a HDD full.
facelibDataProcessing 0x6000100b Handling face picture library
data.
capturePackageFailed 0x6000100c Capturing packet failed.
capturePackageProcessing 0x6000100d Capturing packet.
noSupportWithPlaybackAbstra 0x6000100e This function is not supported.
ct Playback by video synopsis is
enabled.
insufficientNetworkBandwidth 0x6000100f Insufficient network
bandwidth.
tapeLibNeedStopArchive 0x60001010 Stop the filing operation of
tape library first.
identityKeyError 0x60001011 Incorrect interaction command.
identityKeyMissing 0x60001012 The interaction command is
lost.

143
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

noSupportWithPersonDensityD 0x60001013 This function is not supported.
etect The people density detection is
enabled.
ipcResolutionOverflow 0x60001014 The configured resolution of
network camera is invalid.
ipcBitrateOverflow 0x60001015 The configured bit rate of
network camera is invalid.
tooGreatTimeDifference 0x60001016 Too large time difference
between device and server.
noSupportWithPlayback 0x60001017 This function is not supported.
Playback is enabled.
channelNoSupportWithSMD 0x60001018 This function is not supported.
Motion detection is enabled.
channelNoSupportWithFD 0x60001019 This function is not supported.
Face capture is enabled.
illegalPhoneNumber 0x6000101a Invalid phone number.
illegalCertificateNumber 0x6000101b Invalid certificate No.
linkedCameraOutLimit 0x6000101c Connecting camera timed out.
achieveMaxChannelLimit 0x6000101e No more channels are allowed.
humanMisInfoFilterEnabledCha 0x6000101f No more channels are allowed
nNumError to enable preventing false
alarm.
humanEnginesNoResource 0x60001020 Insufficient human body
analysis engine resources.
taskNumberOverflow 0x60001021 No more tasks can be added.
collisionTimeOverflow 0x60001022 No more comparison duration
can be configured.
invalidTaskID 0x60001023 Invalid task ID.
invalidEZVIZSecretKey 0x60001034 Invalid verification code for Hik-
Connect.
needDoubleVerification 0x60001042 Double verification required
noDoubleVerificationUser 0x60001043 No double verification user

144
 Heat Map Application ISAPI User Manual

Sub Status Code Error Code Description

timeSpanNumOverLimit 0x60001044 Max. number of time buckets
reached
channelNumOverLimit 0x60001045 Max. number of channels
reached
noSearchIDResource 0x60001046 Insufficient searchID resources
TransitionUseEmmc 0x60002000 Starting device failed. The
EMMC is overused.
AdaptiveStreamNotEnabled 0x60002001 The stream self-​adaptive
function is not enabled .
AdaptiveStreamAndVariableBit 0x60002002 Stream self-​adptive and
rateEnabled variable bitrate function cannot
be enabled at the same time.
detectorTypeMismatch 0x60008000 The detector type mismatched.
nameExist 0x60008001 The name already exists.
laneAndRegionOverlap None. The lanes are overlapped.

StatusCode=7

SubStatusCode Error Code Description

rebootRequired 0x70000001 Reboot to take effect.

145
UD14175B