0% found this document useful (0 votes)

9 views99 pages

Hik ISAPI

Uploaded by

ronald

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

9 views99 pages

Hik ISAPI

Uploaded by

ronald

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 99

Intelligent Security API (Metadata)

Developer Guide
Intelligent Security API (Metadata) Developer Guide

Legal Information
TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE DOCUMENT IS PROVIDED "AS IS"
AND “WITH ALL FAULTS AND ERRORS”. OUR COMPANY MAKES NO REPRESENTATIONS OR
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. IN NO EVENT
WILL OUR COMPANY BE LIABLE FOR ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL, OR INDIRECT
DAMAGES, INCLUDING, AMONG OTHERS, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS
INTERRUPTION OR LOSS OF DATA, CORRUPTION OF SYSTEMS, OR LOSS OF DOCUMENTATION,
WHETHER BASED ON BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, IN
CONNECTION WITH THE USE OF THE DOCUMENT, EVEN IF OUR COMPANY HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES OR LOSS.

i
Intelligent Security API (Metadata) Developer Guide

Contents
Chapter 1 Overview .................................................................................................................... 1
1.1 Introduction ........................................................................................................................... 1
1.2 Update History ....................................................................................................................... 1
Chapter 2 Display Metadata on Video ........................................................................................ 3
Chapter 3 Subscribe Metadata by Type ..................................................................................... 10
Appendix A. Request URIs ........................................................................................................ 12
A.1 /ISAPI/System/capabilities ................................................................................................... 12
A.2 /ISAPI/Streaming/channels/<ID>/metadata/capabilities .................................................... 12
A.3 /ISAPI/Streaming/channels/<ID>/metadata ........................................................................ 12
A.4 /ISAPI/Streaming/channels/<ID>/metadata/subscribeType?format=json .......................... 13
A.5 /ISAPI/Streaming/channels/<ID>/Metadata/<type> ........................................................... 14
A.6 rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID> ......................................................... 14
Appendix B. Request and Response Messages .......................................................................... 17
B.1 JSON_Metadata ................................................................................................................... 17
B.2 JSON_Metadata_HeatMap .................................................................................................. 18
B.3 JSON_Metadata_PeopleCounting ........................................................................................ 19
B.4 JSON_Metadata_PersonalTracking ...................................................................................... 20
B.5 JSON_ResponseStatus ......................................................................................................... 22
B.6 JSON_RTSPMetadataURI ..................................................................................................... 22
B.7 JSON_SubscribeType ............................................................................................................ 23
B.8 XML_Cap_MetadataCfg ....................................................................................................... 23
B.9 XML_DeviceCap ................................................................................................................... 23
B.10 XML_Metadata_ANPR ....................................................................................................... 33
B.11 XML_Metadata_BehaviorAnalysis ..................................................................................... 35
B.12 XML_Metadata_FaceCapture ............................................................................................ 39
B.13 XML_Metadata_QueueManagement ................................................................................ 42

ii
Intelligent Security API (Metadata) Developer Guide

B.14 XML_Metadata_RadarBehaviorAnalysis ............................................................................ 46

B.15 XML_Metadata_Thermal ................................................................................................... 50
B.16 XML_MetadataCfg ............................................................................................................. 56
B.17 XML_Radar_Metadata ....................................................................................................... 56
B.18 XML_ResponseStatus ......................................................................................................... 58
B.19 XML_SingleMetadataCfg .................................................................................................... 58
B.20 XML_Video_Metadata ....................................................................................................... 59
Appendix C. Response Codes of Text Protocol ........................................................................... 61

iii
Intelligent Security API (Metadata) Developer Guide

Chapter 1 Overview

1.1 Introduction
Metadata is the data that describes other data. In the video monitoring filed, metadata usually
contains intelligent structured information (e.g., real-time temperature measurement, fire source
detection, ship detection, behavior analysis, ANPR, queue management, and face capture) which
can help users to understand the videos.

1.2 Update History

Summary of Changes in Version 2.6_Mar., 2020

Related Product: iDS-2SR8141IXS-AB(40X) Radar PTZ Camera with Software Version 5.5.20
1. Extended the metadata configuration capability message XML_Cap_MetadataCfg :
added a value "radarDetection" (radar detection) to the node <type>;
added a node <isSupportSubscribeType> (whether the device supports subscribing metadata
by type).
2. Extended the metadata batch configuration message XML_MetadataCfg and metadata single
configuration message XML_SingleMetadataCfg :
added a value "radarDetection" (radar detection) to the node <type>
3. Added general metadata message of radar detection and radar behavior analysis metadata
message, i.e., XML_Radar_Metadata and XML_Metadata_RadarBehaviorAnalysis .
4. Added a response code 0x4000a016 (This metadata type is not supported to be subscribed) to
the status code 4 (Invalid Operation), see details in Response Codes of Text Protocol .
5. Added an API calling flow of subscribing metadata by type, see details in Subscribe Metadata by
Type .

Summary of Changes in Version 2.0_Jan., 2019

Related Product Type: Speed Dome V5.6.0 (H3)
1. Extended metadata message example of real-time target in behavior analysis ( ): added two
node <Property> (line crossing detection event type) and <ruleID> (rule ID).
2. Extended metadata message example of real-time target in ANPR ( ): added four nodes
<Property> (vehicle color, vehicle type, vehicle brand, and vehicle sub brand).
3. Added metadata message examples of waiting time detection rule, real-time target in waiting
time detection, people queuing-up rule, real-time target in people queuing-up, face capture
rule, and real-time target in face capture to .
4. Extended device capability ( XML_DeviceCap , related URL: GET /ISAPI/System/capabilities ):
added a sub node <isSupportMetadata> (whether supports metadata) to the node <SysCap>.

1
Intelligent Security API (Metadata) Developer Guide

5. Extended metadata configuration capability ( XML_Cap_MetadataCfg , related URL: GET /

ISAPI/Streaming/channels/<ID>/metadata/capabilities ): added three values "ANPR",
"personQueue", and "faceSnap" to the metadata type (<type>).
6. Extended the metadata configuration message ( XML_MetadataCfg and
XML_SingleMetadataCfg , related URLs: /ISAPI/Streaming/channels/<ID>/metadata and /
ISAPI/Streaming/channels/<ID>/Metadata/<type> ): added three values "ANPR",
"personQueue", and "faceSnap" to the metadata type (<type>).

Summary of Changes in Version 2.0_Mar., 2018

New document.

2
Intelligent Security API (Metadata) Developer Guide

Chapter 2 Display Metadata on Video

To upload and display metadata on the video without using Hikvision PlayCtrl SDK, we provide a
solution based on ISAPI integration and RTSP.

3
Intelligent Security API (Metadata) Developer Guide

Steps

Figure 2-1 API Calling Flow of Displaying Metadata on Video

4
Intelligent Security API (Metadata) Developer Guide

Note
RTSP is an international protocol, so for its definition, search for the related manuals or
specifications in the library or on the network for reference.
1. Optional: Call /ISAPI/System/capabilities by GET method to get the device capability for
checking whether the device supports metadata.
The device capability is returned in the message XML_DeviceCap .
If the node <isSupportMetadata> is returned in the message, it indicates that the device
supports metadata, and you can perform the following steps.
Otherwise, it indicates that metadata is not supported by device, please end this task.
2. Optional: Call /ISAPI/Streaming/channels/<ID>/metadata/capabilities by GET method to get
the metadata capability for getting the supported intelligent events and message formats.
3. Call /ISAPI/Streaming/channels/<ID>/metadata by PUT method to enable intelligent event and
set message format.

Note
You can also call /ISAPI/Streaming/channels/<ID>/Metadata/<type> by PUT method to
configure parameters for a specific metadata type.
4. Call rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID> by DESCRIBE RTSP method to request
for getting stream for live view.
Example
Sample URL for getting stream for live view by RTSP method: DESCRIBE rtsp://
10.10.36.212:554/ISAPI/Streaming/channels/101 RTSP/1.0
Stream information (see the example below) is returned by device if succeeded.
DESCRIBE rtsp://10.10.36.212:554/ISAPI/Streaming/channels/101 RTSP/1.0
CSeq:0
Accept:application/sdp
Authorization:
User-Agent:NKPlayer-VSPlayer1.0

RTSP/1.0 401 Unauthorized

CSeq: 0
WWW-Authenticate: Digest realm="IP Camera(51289)", nonce="9fe43f1322976c0aa218b0f23f554b44",
stale="FALSE"
Date: Mon, Dec 18 2017 04:37:30 GMT

DESCRIBE rtsp://10.10.36.212:554/ISAPI/Streaming/channels/101 RTSP/1.0

CSeq:0
Accept:application/sdp
Authorization:Digest username="admin", realm="IP Camera(51289)",
nonce="9fe43f1322976c0aa218b0f23f554b44",
uri="rtsp://10.10.36.212:554/ISAPI/Streaming/channels/101", response="99b683462210bd819c8d6bafb39dd262"
User-Agent:NKPlayer-VSPlayer1.0

5
Intelligent Security API (Metadata) Developer Guide

RTSP/1.0 200 OK
CSeq: 0
Content-Type: application/sdp
Content-Length: 737

v=0
o=- 1513571850040093 1513571850040093 IN IP4 10.10.36.212
s=Media Presentation
e=NONE
b=AS:5100
t=0 0
a=control:*
m=video 0 RTP/AVP 96
c=IN IP4 0.0.0.0
b=AS:5000
a=recvonly
a=x-dimensions:1920,1080
a=control:trackID=1
a=rtpmap:96 H264/90000
a=fmtp:96 profile-level-id=420029; packetization-mode=1;
sprop-parameter-sets=Z00AKp2oHgCJ+WbgICAoAAADAAgAAAMBlCA=,aO48gA==
m=audio 0 RTP/AVP 0
c=IN IP4 0.0.0.0
b=AS:50
a=recvonly
a=control:trackID=2
a=rtpmap:0 PCMU/8000
m=application 0 RTP/AVP 107
c=IN IP4 0.0.0.0
b=AS:50
a=recvonly
a=control:trackID=3
a=rtpmap:107 isapi.metadata/90000
a=Media_header:MEDIAINFO=494D4B48010200000400000110710110401F000000FA00000000000000000000000
0000000000000;
a=appversion:1.0

Note
The "a=rtpmap:107 isapi.metadata/90000" in the stream information indicates that the stream
contains metadata information, and the "trackID=3" refers to the metadata ID which is used to
get the detailed metadata information in step 7.
5. Parse the obtained stream data to judge whether the stream contains the metadata information
and get the trackID of metadata if contained.
6. Call rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID> by SETUP RTSP method to request
for getting detailed metadata information.

6
Intelligent Security API (Metadata) Developer Guide

Example
An example for getting detailed metadata information by SETUP method is shown below for
reference.
SETUP rtsp://10.10.36.212:554/ISAPI/Streaming/channels/101/trackID=3
RTSP/1.0
Seq:3
Authorization:Digest username="admin", realm="IP Camera(51289)",
nonce="9fe43f1322976c0aa218b0f23f554b44",
uri="rtsp://10.10.36.212:554/ISAPI/Streaming/channels/101",
response="46b39a563fd9977eff83067adc4e587b"
Session: 408703626
Transport: RTP/AVP/TCP;unicast;
User-Agent:NKPlayer-VSPlayer1.0

RTSP/1.0 200 OK Session:

408703626;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=6-7;ssrc=14b37590;mode="play"
Date: Mon, Dec 18 2017 04:37:30 GMT

Note
Metadata information can be sent with the stream, or alone in the response of RTSP request
(must be packaged by RTP), see the format and structure of metadata message to be uploaded
in XML_Video_Metadata or JSON_Metadata .
7. Call rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID> by PLAY RTSP method to start the live
view.
Example
Sample URL for starting live view by RTSP method: PLAY rtsp://10.10.36.160:554/ISAPI/
Streaming/channels/102 RTSP/1.0. And then device starts uploading the RTP packet which
contains stream data and metadata (see the message example below).
PLAY rtsp://10.10.36.160:554/ISAPI/Streaming/channels/102 RTSP/1.0
CSeq:4
Authorization:Digest username="admin", realm="IP Camera(51289)",
nonce="9fe43f1322976c0aa218b0f23f554b44",
uri="rtsp://10.10.36.160:554/ISAPI/Streaming/channels/102",
response="611cc58b1b42b8df909b57b737a7ad3a"
Session: 408703626
Range:npt=0.000000-
Scale:1.000
User-Agent:NKPlayer-VSPlayer1.0

RTSP/1.0 200 OK
CSeq: 4
Session: 408703626
RTP-Info:
url=trackID=1;seq=24874,url=trackID=2;seq=42360,url=trackID=3;seq=0
Date: Mon, Dec 18 2017 04:37:31 GMT

7
Intelligent Security API (Metadata) Developer Guide

[email protected].<?xml version="1.0" encoding="UTF-8"?>

<Metadata version="1.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTarget</type>
<subType>behaviorAnalysis</subType>
<time>2017-12-18T04:37:31.000+0800</time>
<DevInfo>
<ipAddress>10.10.36.212</ipAddress>
<portNo>554</portNo>
<macAddress>31:30:2e:31:30:2e</macAddress>
<channel>1</channel>
<domainName></domainName>
</DevInfo>
<TargetDetection>
<TargetList></TargetList>
</TargetDetection>
</Metadata>
8. Check whether the type value of uploaded RTP packet is 0x6b according to the description of
RTP packet or the value of parameter payload type in RTP packet header.

Figure 2-2 RTP Packet Description

Figure 2-3 RTP Packet Header

- If the type value of current RTP packet is 0x6b, it indicates that the packet contains metadata,
and perform the following steps.
- If the type value of current RTP packet is not 0x6b, get the next packet and judge again.
9. Parse the metadata information in the RTP packet and display the intelligent information on the
video.
10. Call rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID> by TEARDOW RTSP method to stop
the live view.
Example
An example for stopping live view by RTSP method is shown below for reference.
TEARDOWN rtsp://10.10.36.212:554/ISAPI/Streaming/channels/101 RTSP/1.0
CSeq:4
Authorization: Digest username="admin", realm="IP Camera(51289)",
nonce="9fe43f1322976c0aa218b0f23f554b44",
uri="rtsp://10.10.36.212:554/ISAPI/Streaming/channels/101",
response="2822238cec4028c34749cf3a48ce7519"
Session:408703626;timeout=60

8
Intelligent Security API (Metadata) Developer Guide

User-Agent:NKPlayer-VSPlayer1.0

9
Intelligent Security API (Metadata) Developer Guide

Chapter 3 Subscribe Metadata by Type

You can specify the metadata type (supports type combination) to subscribe the required
metadata details, and the details are returned in URI format over RTSP (Real-Time Streaming
Protocol).
Steps

Figure 3-1 API Calling Flow of Subscribe Metadata by Type

1. Call /ISAPI/Streaming/channels/<ID>/metadata/capabilities by GET method to get the
metadata configuration capability.
The capability is returned in the message XML_Cap_MetadataCfg .
2. Check whether the device supports subscribing metadata by type.
- When the node <isSupportSubscribeType> is returned in the message
XML_Cap_MetadataCfg , it indicates that the device supports metadata subscription and
you can continue to perform the following steps.

10
Intelligent Security API (Metadata) Developer Guide

- When the message XML_Cap_MetadataCfg does not contain node

<isSupportSubscribeType>, it indicates that the device does not support metadata
subscription and please end this task.
3. Optional: Call /ISAPI/Streaming/channels/<ID>/metadata by GET method to get the metadata
types that are supported to be subscribed.
4. Call /ISAPI/Streaming/channels/<ID>/metadata/subscribeType?format=json by POST method
to specify metadata type to be subscribed and get the crooesponding metadata details URI.

11
Intelligent Security API (Metadata) Developer Guide

Appendix A. Request URIs

A.1 /ISAPI/System/capabilities
Get device capability.

Request URI Definition

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

A.2 /ISAPI/Streaming/channels/<ID>/metadata/capabilities
Get metadata capability.

Request URI Definition

Table A-2 GET /ISAPI/Streaming/channels/<ID>/metadata/capabilities
Method GET
Description Get metadata capability.
Query None
Request None
Response XML_Cap_MetadataCfg

Remarks
The <ID> in the URI is the channel ID.

A.3 /ISAPI/Streaming/channels/<ID>/metadata
Get or set metadata parameters.

12
Intelligent Security API (Metadata) Developer Guide

Request URI Definitions

Table A-3 GET /ISAPI/Streaming/channels/<ID>/metadata
Method GET
Description Get metadata parameters.
Query None
Request None
Response XML_MetadataCfg
Table A-4 PUT /ISAPI/Streaming/channels/<ID>/metadata
Method PUT
Description Set metadata parameters.
Query None
Request XML_MetadataCfg
Response XML_ResponseStatus

Remarks
The <ID> in the URI is the channel ID.

A.4 /ISAPI/Streaming/channels/<ID>/metadata/subscribeType?
format=json
Specify metadata type to be subscribed and get the corresponding metadata details URI.

Request URI Definition

Table A-5 POST /ISAPI/Streaming/channels/<ID>/metadata/subscribeType?format=json
Method POST
Description Specify metadata type to be subscribed and get the corresponding
metadata details URI.
Query format: determine the format of request or response message.
Request JSON_SubscribeType
Response Succeeded: JSON_RTSPMetadataURI
Failed: JSON_ResponseStatus

13
Intelligent Security API (Metadata) Developer Guide

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

A.5 /ISAPI/Streaming/channels/<ID>/Metadata/<type>
Get or set parameters of a specific metadata type.

Request URI Definition

Table A-6 GET /ISAPI/Streaming/channels/<ID>/Metadata/<type>
Method GET
Description Get parameters of a specific metadata type.
Query None
Request None
Response XML_SingleMetadataCfg
Table A-7 PUT /ISAPI/Streaming/channels/<ID>/Metadata/<type>
Method PUT
Description Set parameters of a specific metadata type.
Query None
Request XML_SingleMetadataCfg
Response XML_ResponseStatus

Remarks
• The <ID> in the request URI refers to the channel ID.
• The <type> in the request URI refers to the metadata type, such as "thermometry",
"fireDetection", "shipsDetection", "behaviorAnalysis", "ANPR", "personQueue", and "faceSnap".

A.6 rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID>
Get basic parameter or session information for live view, or start and stop live view.

Request URL Definition

Table A-8 DESCRIBE rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID>
Method DESCRIBE
Description Get basic parameters for live view.

14
Intelligent Security API (Metadata) Developer Guide

Query None.
Request None.
Response None.
Table A-9 SETUP rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID>
Method SETUP
Description Get session information for live view.
Query None.
Request None.
Response None.
Table A-10 PLAY rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID>
Method PLAY
Description Start live view.
Query None.
Request None.
Response None.
Table A-11 TEARDOW rtsp://<host>[:port]/ISAPI/Streaming/channels/<ID>
Method TEARDOW
Description Stop live view.
Query None.
Request None.
Response None.

Remarks
The <ID> in the URL is defined as (channel No.)*100+(stream type value).
channel No.
For analog channel, the No. starts from 1, and for digital channel, the No. starts from the last
analog channel No.
E.g., if the device has 16 analog channels and 16 digital channels, the analog channel No. is
between 1 and 16, and the digital channel No. is between 17 and 32.
stream type value
The stream type values contain 1, 2, and 3. 1-main stream, 2-sub-stream, 3-third stream.

15
Intelligent Security API (Metadata) Developer Guide

E.g., if ID is 101, it indicates the main stream of channel No.1; if ID is 102, it indicates the sub-
stream of channel No. 2; if ID is 1601, it indicates the main stream of channel 16;...

16
Intelligent Security API (Metadata) Developer Guide

Appendix B. Request and Response Messages

B.1 JSON_Metadata
JSON message about general metadata
{
"Metadata":{
"type":"",
/*required, string, information type to be uploaded: "ruleTarget"-upload rules*/
"subType":"",
/*optional, string, event type: "heatmap"-heat map (crowd trend analysis), "framesPeopleCounting"-regional people
counting, "PeopleCounting"-people counting*/
"time":"",
/*required, string, time in ISO 8601 time format, e.g., "2017-01-01T00:00:00+08:00"*/
"DevInfo":{
/*optional, device information, it is used to distinguish devices across domains and multicasting*/
"ipAddress":"",
"portNo":"",
"macAddress":"",
"channel":""
},
"TargetDetection":{
/*optional, detected target information*/
"TargetList":[{
/*required, target information list*/
"ruleID":"",
/*optional, integer, detection rule ID*/
"RegionList":[{
/*optional, target position*/
"Point":[{
"x":"",
"y":""
}]
}]
}],
"PcitureList":[{
/*optional, picture list*/
"dataType":{ },
"data":""
}]
},
"Situation":{
/*optional*/
"personCount":
/*int, number of people, this field is valid when subType is "crowdSituationAnalysis" and "framesPeopleCounting"*/
}
}
}

17
Intelligent Security API (Metadata) Developer Guide

Remarks
For different detection types, the metadata details are different, see the table below.
Detection Type Metadata Details
Heat Map (Crowd Trend Analysis) JSON_Metadata_HeatMap
People Counting (includes Regional People JSON_Metadata_PeopleCounting
Counting)
Personal Tracking JSON_Metadata_PersonalTracking

B.2 JSON_Metadata_HeatMap
JSON message about heat map (or crowd trend analysis) metadata
{
"Metadata":{
"type":"ruleTarget",
"subType":"heatmap",
"time":"2017-01-01T00:00:00+08:00",
"DevInfo":{
"ipAddress":192.168.0.64,
"portNo":"554",
"macAddress":"28:57:be:ee:d1:5a",
"channel":"1"
},
"TargetDetection":{
"TargetList":[{
"ruleID":"1",
"RegionList":[{
"Point":[{
"x":"0",
"y":"0"
},
{
"x":"600",
"y":"0"
},
{
"x":"600",
"y":"600"
},
{
"x":"0",
"y":"600"
}]
}]
}],
"PcitureList":[{

18
Intelligent Security API (Metadata) Developer Guide

"dataType":{ },
"data":"xxxxxxxxxxx"
}]
},
"Situation":{
"personCount":0
}
}
}

dataType
Optional, string, picture data type: "url", "base64".
data
Optional, string, picture data.
personCount
Optional, int, number of people.

B.3 JSON_Metadata_PeopleCounting
JSON message about people counting metadata

Regional People Counting Metadata

{
"Metadata":{
"type":"ruleTarget",
"subType":"framesPeopleCounting",
"time":"2017-01-01T00:00:00+08:00",
"DevInfo":{
"ipAddress":192.168.0.64,
"portNo":"554",
"macAddress":"28:57:be:ee:d1:5a",
"channel":"1"
},
"Situation":{
"personCount":0
}
}
}

personCount
Optional, int, number of people in the region.

People Counting Metadata

{
"Metadata":{
"type":"ruleTarget",

19
Intelligent Security API (Metadata) Developer Guide

"subType":"PeopleCounting",
"time":"2017-01-01T00:00:00+08:00",
"DevInfo":{
"ipAddress":192.168.0.64,
"portNo":"554",
"macAddress":"28:57:be:ee:d1:5a",
"channel":"1"
},
"Situation":{
"enterRegionPeopleNum":0,
"leaveRegionPeopleNum":0
}
}
}

enterRegionPeopleNum
Optional, int, number of people entering the region. This field is required when subType is
"PeopleCounting".
leaveRegionPeopleNum
Optional, int, number of people leaving the region. This field is required when subType is
"PeopleCounting".

B.4 JSON_Metadata_PersonalTracking
JSON message about personal tracking metadata
{
"MetaData":{
"type":"ruleTarget",
"subType":"personalTrack",
"time":"2017-01-01T00:00:00+08:00",
"DevInfo":{
"ipAddress":192.168.0.64,
"portNo":"554",
"macAddress":"28:57:be:ee:d1:5a",
"channel":"1"
},
"CameraPoint": [{
"objId": "12498",
/*required, string, tracking target ID, which can contain up to 32 characters*/
"traComplete": false,
/*required, boolean, whether the tracking target has disappeared: false, true*/
"isvalid": 1,
/*required, int, whether target is valid: 1-yes, 0-no*/
"GesturePolygon": {
/*required, target features*/
"id": "12498",
/*optional, string, gesture ID, this node is valid only when there exist gesture features*/
"JoinMsg": [{

20
Intelligent Security API (Metadata) Developer Guide

"gestureType": 0,
/*required, int, feature category: 0-left wrist, 1-left elbow, 2-left shoulder, 3-head, 4-right shoulder, 5-right elbow, 6-
right wrist*/
"gestureScore": 0.572535,
/*required, float, feature score, value range: [0,1.000000]*/
"gestureValid": 1,
/*required, int, whether the gesture is valid: 1-yes, 0-no*/
"x": 3050.360351,
/*float, X-coordinate (space coordinates), which is accurate to 6 decimal places*/
"y": 6995.723632,
/*float, Y-coordinate (space coordinates), which is accurate to 6 decimal places*/
"z": 1082.0,
/*float, Z-coordinate (space coordinates), which is accurate to 6 decimal places*/
"x2d": 0.671052,
/*float, normalized X-coordinate (plane coordinates), which is accurate to 6 decimal places, value range: [0,1]*/
"y2d": 0.53125
/*float, normalized Y-coordinate (plane coordinates), which is accurate to 6 decimal places, value range: [0,1]*/
}]
},
"HeadPolygon": {
/*head and shoulder frame of target, target coordinates, and target pattern information, the values are accurate to 6
decimal places*/
"Rect": {
/*head and shoulder frame of target*/
"x": 0.660156,
"y": 0.388888,
"width": 0.089843,
"height": 0.125
},
"cct": {
/*target coordinates*/
"x": 3057.293212,
/*float, X-coordinate (space coordinates)*/
"y": 7205.725585,
/*float, Y-coordinate (space coordinates)*/
"z": 0.0
/*float, Z-coordinate (space coordinates)*/
},
"HeadModel": {
"modelNum": 1,
/*required, int, number of feature vectors on head and shoulder, it can be set to 0 if there is no vector*/
"Data":[{
"poseType": 7,
/*required, int, target direction or posture (vertical angle of view): 1-in image medium, 2-four image corners forward,
3-four image corners backward, 4-four image corners leftward, 5-four image corners rightward, 6-image center
forward, 7-image center backward, 8-image center leftward, 9-image center rightward, 0-unknown*/
"feaLen": 134,
/*required, int, length of feature vector*/
"feaData":""
/*required, string, feature data*/
}]
}

21
Intelligent Security API (Metadata) Developer Guide

},
"SuspList": {
/*tracking exception tag*/
"suspNum": 1,
/*required, int, number of abnormal patterns, it can be set to 0 if all patterns are normal*/
"Data":[{
"suspID": 5,
/*required, int, abnormal pattern ID*/
"timeStamp":1576657411095,
/*required, int, pattern exception occurred time*/
"confidence":0.567
/*required, float, exception confidence*/
}]
}
}]
}
}

B.5 JSON_ResponseStatus
JSON message about response status
{
"requestURL":"",
/*optional, string, request URL*/
"statusCode": ,
/*required, int, status code*/
"statusString":"",
/*required, string, status description*/
"subStatusCode":"",
/*required, string, sub status code*/
"errorCode": ,
/*optional, int, error code, which corresponds to subStatusCode, this field is required when statusCode is not 1. The
returned value is the transformed decimal number*/
"errorMsg":"",
/*optional, string, error details, this field is required when statusCode is not 1*/
}

Note
See Response Codes of Text Protocol for details about the status codes, sub status codes, error
codes, and error descriptions.

B.6 JSON_RTSPMetadataURI
JSON message about metadata details URI (over RTSP)
{
"rtspURI":""

22
Intelligent Security API (Metadata) Developer Guide

/*required, string, metadata details URI over RTSP, it can contain up to 128 characters*/
}

B.7 JSON_SubscribeType
JSON message about metadata types to be subscribed
{
"type":[""]
/*optional, array of string, type list of metadata to be subscribed: "thermometry"-real-time temperature
measurement, "fireDetection"-fire source detection, "shipsDetection"-ship detection, "behaviorAnalysis"-behavior
analysis, "ANPR", "personQueue"-queue management, "faceSnap"-face capture, "radarDetection"-radar detection,
"personalTrack"-personal tracking; it can contain multiple types, and each type string can contain up to 64 characters*/
}

B.8 XML_Cap_MetadataCfg
XML message about metadata configuration capability
<MetadataCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<MetadataList size="">
<Metadata>
<type opt="thermometry, fireDetection, shipsDetection, behaviorAnalysis, ANPR, personQueue, faceSnap,
radarDetection, personalTrack">

</type>
<enable></enable>
</Metadata>
</MetadataList>
<uploadDataFormat opt="xml,json">

</uploadDataFormat>
<isSupportSubscribeType></isSupportSubscribeType>
</MetadataCfg>

B.9 XML_DeviceCap
XML message about device capability
<DeviceCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SysCap>
<isSupportDst></isSupportDst>
<NetworkCap/>
<IOCap/>

23
Intelligent Security API (Metadata) Developer Guide

<SerialCap/>

24
Intelligent Security API (Metadata) Developer Guide

</isSupportPostUpdateFirmware>
<isSupportPostConfigData>

</isSupportPostConfigData>
<isSupportUserLock>

</isSupportUserLock>
<isSupportModuleLock></
isSupportModuleLock>
<isSupportSoundCfg></isSupportSoundCfg>
<isSupportMetadata>

</isSupportMetadata>
<isSupportShutdown></
isSupportShutdown>
<supportSmartOverlapChannles opt="1"/>
<isSupportConsumptionMode></isSupportConsumptionMode>
<isSupportManualPowerConsumption></isSupportManualPowerConsumption>
</SysCap>
<voicetalkNums></voicetalkNums>
<isSupportSnapshot></isSupportSnapshot>
<SecurityCap/>
<EventCap/>
<ITCCap></ITCCap>
<ImageCap/>
<RacmCap/>
<PTZCtrlCap>
<isSupportPatrols></isSupportPatrols>
</PTZCtrlCap>
<SmartCap/>
<isSupportEhome></isSupportEhome>
<isSupportStreamingEncrypt></isSupportStreamingEncrypt>
<TestCap>
<isSupportEmailTest></isSupportEmailTest>
</TestCap>
<ThermalCap/>
<WLAlarmCap/>
<SecurityCPCapabilities/>
<isSupportGIS>

</isSupportGIS>
<isSupportCompass>

</isSupportCompass>
<isSupportRoadInfoOverlays>

</isSupportRoadInfoOverlays>

25
Intelligent Security API (Metadata) Developer Guide

26
Intelligent Security API (Metadata) Developer Guide

</isSupportPEA>
<isSupportCurrentLock>

</isSupportCurrentLock>
<isSupportGuardAgainstTheft>

</isSupportGuardAgainstTheft>
<isSupportPicInfoOverlap>

</isSupportPicInfoOverlap>
<isSupportPlay>

</isSupportPlay>
<isSupportPlayback>

</isSupportPlayback>
<UHFRFIDReader>

<isSupportBasicInformation>

</isSupportBasicInformation>
<isSupportHardDiskStorageTest>

</isSupportHardDiskStorageTest>
</UHFRFIDReader>
<isSupportIntelligentStructureAnalysis>

</isSupportIntelligentStructureAnalysis>
<isSupportIntelligentAnalysisEngines>

</isSupportIntelligentAnalysisEngines>
<PreviewDisplayNum>

</PreviewDisplayNum>
<isSupportBoard opt="true,false">

</isSupportBoard>
<ResourceSwitch>
<workMode opt="4KPreview,educationRecord">

</workMode>
</ResourceSwitch>
<isSupportCustomStream></isSupportCustomStream>
<isSupportTriggerCapCheck>

</isSupportTriggerCapCheck>
<isSupportActiveMulticast>

</isSupportActiveMulticast>

27
Intelligent Security API (Metadata) Developer Guide

28
Intelligent Security API (Metadata) Developer Guide

</isSupportGPSCalibratation>
<isSupportChannelFullEventListCap>

</isSupportChannelFullEventListCap>
<isSupportAUXInfoCap>

</isSupportAUXInfoCap>
<isSupportCalibrationFile>

</isSupportCalibrationFile>
<isSupportDisplayTrajectory>

</isSupportDisplayTrajectory>
<maximumSuperPositionTime opt="5,10,20,30">

</maximumSuperPositionTime>
<isSupportUnitConfig>

</isSupportUnitConfig>
<isSupportAutoMaintenance>

</isSupportAutoMaintenance>
<isSupportGetLinkSocketIP>

</isSupportGetLinkSocketIP>
<isSupportIntelligentSearch>

</isSupportIntelligentSearch>
<IOTCap>
<supportChannelNum>

</supportChannelNum>
<startChannelNo>

</startChannelNo>
<isSupportlinkageChannelsSearch>

</isSupportlinkageChannelsSearch>
</IOTCap>
<isSupportEncryption>

</isSupportEncryption>
<AIDEventSupport opt="abandonedObject, pedestrian, congestion, roadBlock, construction, trafficAccident,
fogDetection, wrongDirection, illegalParking, SSharpDriving, lowSpeed, dragRacing">

</AIDEventSupport>

29
Intelligent Security API (Metadata) Developer Guide

<TFSEventSupport
opt="illegalParking ,wrongDirection,crossLane,laneChange,vehicleExist,turnRound,parallelParking,notKeepDistance,not
SlowZebraCrossing,overtakeRightSide,lowSpeed,dragRacing,changeLaneContinuously,SSharpDriving,largeVehicleOccup
yLine,jamCrossLine">

</TFSEventSupport>
<isVehicleStatisticsSupport>

</isVehicleStatisticsSupport>
<isSupportIntersectionAnalysis>

</isSupportIntersectionAnalysis>
<supportRemoteCtrl opt="up,down,left,right,enter,menu,num,power,esc,edit,F1,.prev,rec,play,stop,notSupport"/>
<isSptDiagnosis>

</isSptDiagnosis>
<isSptSerialLogCfg>

</isSptSerialLogCfg>
<isSptFileExport>

</isSptFileExport>
<isSptCertificationStandard>

</isSptCertificationStandard>
<isSptKeypadLock>

</isSptKeypadLock>
<MixedTargetDetection>
<isSupportFaceRecognition></
isSupportFaceRecognition>
<isSupportHumanRecognition></
isSupportHumanRecognition>
<isSupportVehicleRecognition></
isSupportVehicleRecognition>
</MixedTargetDetection>
<isSupportDiscoveryMode></isSupportDiscoveryMode>
<streamEncryptionType>

</streamEncryptionType>
<isSupportLms></isSupportLms>
<isSupportLCDScreen></isSupportLCDScreen>
<isSupportBluetooth></isSupportBluetooth>

30
Intelligent Security API (Metadata) Developer Guide

<isSupportAcsUpdate>

</isSupportAcsUpdate>
<isSupportAccessControlCap>

</isSupportAccessControlCap>
<isSupportIDCardInfoEvent></isSupportIDCardInfoEvent>
<OpenPlatformCap>
<isSupportInstallationAngleCalibration>

</isSupportInstallationAngleCalibration>
<isSupportZeroBiasCalibration>

</isSupportZeroBiasCalibration>
<isSupportDevStatus></
isSupportDevStatus>
<isSupportRadar></isSupportRadar>
<isSupportRadarChannels></
isSupportRadarChannels>
<radarIPDForm></radarIPDForm>
<isSupportRadarFieldDetection></
isSupportRadarFieldDetection>
<isSupportRadarLineDetection></
isSupportRadarLineDetection>
<mixedTargetDetectionWebNoDisplay></mixedTargetDetectionWebNoDisplay>
<SHMCap>
<isSupportHighHDTemperature></
isSupportHighHDTemperature>
<isSupportLowHDTemperature></
isSupportLowHDTemperature>
<isSupportHDImpact></isSupportHDImpact>
<isSupportHDBadBlock></
isSupportHDBadBlock>
<isSupportSevereHDFailure></
isSupportSevereHDFailure>
</SHMCap>
<isSupportBVCorrect></
isSupportBVCorrect>
<guideEventSupport opt="linkageCapture">

</guideEventSupport>
<isSupportAutoSwitch> true</isSupportAutoSwitch>
<isSupportDataPrealarm></
isSupportDataPrealarm>
<supportGISEvent opt="AID,TPS,ANPR,mixedTargetDetection">
<!--optional, xs:string, event types that support GIS information access: AID (corresponding SDK event:
COMM_ALARM_AID_V41), TPS (corresponding SDK event: COMM_ALARM_TPS_REAL_TIME), ANPR (corresponding

31
Intelligent Security API (Metadata) Developer Guide

SDK event: COMM_ITS_PLATE_RESULT), mixedTargetDetection-mixed targets detection-->

</supportGISEvent>
<isSupportIntelligentMode></isSupportIntelligentMode>
<isSupportCertificateCaptureEvent></
isSupportCertificateCaptureEvent>
<isSupportAlgorithmsInfo></isSupportAlgorithmsInfo>
<isSupportVibrationDetection></
isSupportVibrationDetection>
<isSupportFaceTemperatureMeasurementEvent></
isSupportFaceTemperatureMeasurementEvent>
<isSupportQRCodeEvent></isSupportQRCodeEvent>
<isSupportPersonArmingTrack></isSupportPersonArmingTrack>
<isSupportManualPersonArmingTrack></
isSupportManualPersonArmingTrack>
<isSupportGPSCalibrationMode></isSupportGPSCalibrationMode>
<isSupportGPSVerification></isSupportGPSVerification>
<isSupportHBDLib></isSupportHBDLib>
<isSupportFireEscapeDetection></
isSupportFireEscapeDetection>
<isSupportTakingElevatorDetection></
isSupportTakingElevatorDetection>
<isSupportSSDFileSystemUpgrade></isSupportSSDFileSystemUpgrade>
<isSupportSSDFileSystemFormat></isSupportSSDFileSystemFormat>
<isSupportSSDFileSystemCapacity></
isSupportSSDFileSystemCapacity>
<isSupportAIOpenPlatform></
isSupportAIOpenPlatform>
<isSupportPictureDownloadError></isSupportPictureDownloadError>
<characteristicCode min="1" max="128"></characteristicCode>
</DeviceCap>

32
Intelligent Security API (Metadata) Developer Guide

B.10 XML_Metadata_ANPR
XML message about ANPR metadata

Real-Time Target Metadata

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>ANPR</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<targetID>1</targetID>
<recognition>vehicle</recognition>
<ruleID>1</ruleID>
<RegionList>//vehicle position
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>direction</description>
<value>reverse</value>
</Property>
<Property>
<description>licensePlate</description>
<value>XA12345</value>
</Property>

33
Intelligent Security API (Metadata) Developer Guide

<Property>
<description>plateType</description>
<value>arm</value>
</Property>
<Property>
<description>plateColor</description>
<value>yellow</value>
</Property>
<Property>
<description>vehicleColor</description>
<value>yellow</value>
</Property>
<Property>
<description>vehicleType</description>
<value>largeBus</value>
</Property>
<Property>
<description>vehicleLogo</description>
<value>1026</value>
</Property>
<Property>
<description>vehicleSublogo</description>
<value>5</value>
</Property>
<Property>
<description>confidence</description>
<value>100</value>
</Property>
<Property>
<description>country</description>
<value>16</value>
</Property>
<Property>
<description>directionIndex</description>
<value>forward</value>
</Property>
<Property>
<description>vehicleConfidence</description>
<value>100</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

direction
Optional, license plate direction, including reverse (backward), forward, and unknown.
licensePlate
Optional, string, license plate number. When subType is ANPR, this field is required.

34
Intelligent Security API (Metadata) Developer Guide

plateType
Optional, string, license plate types.
plateColor
Optional, license plate color, including white, yellow, blue, black, green, and 0xff (other), string
type.
vehicleColor
Optional, string, vehicle color, including unknown, white, silver, gray, black, red, deepBlue (dark
blue), blue, yellow, green, brown, pink, purple, deepGray (dark gray), cyan, and orange.
vehicleType
Optional, string, vehicle types.
vehicleLogo
Optional, string, vehicle brand.
vehicleSublogo
Optional, string, vehicle sub brand.
confidence
Optional, string, license plate confidence, it is between 0 and 100.
country
Optional, xs:integer, country or region index.
directionIndex
Optional, string, driving direction: "unknown", "eastWest"-from east to west, "westEast"-from
west to east, "southNorth"-from south to north, "noerthSouth"-from north to south,
"southeastToNorthwest"-from southeast to northwest, "northwestToSoutheast"-from
northwest to southeast, "northeastToSouthwest"-from northeast to southwest,
"southwestToNortheast"-from southwest to northeast, "forward"-forward, "back"-backward
vehicleConfidence
Optional, string, vehicle confidence, it is between 0 and 100.

B.11 XML_Metadata_BehaviorAnalysis
XML message about behavior analysis metadata

Rule Metadata
When Behavior Analysis Alarm is Not Triggered
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTarget</type>
<subType>behaviorAnalysis</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>

35
Intelligent Security API (Metadata) Developer Guide

<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>100</x>
<y>100</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>eventType</description>
<value>linedetection</value>
</Property>
<Property>
<description>crossdirection</description>
<value>lefttoright</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>
When Behavior Analysis Alarm is Triggered
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTarget</type>
<subType>behaviorAnalysis</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<RegionList>

36
Intelligent Security API (Metadata) Developer Guide

<Region>
<Point>
<x>100</x>
<y>100</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>eventType</description>
<value>linedetection</value>
</Property>
<Property>
<description>triggerEvent</description>
<value>true</value>
</Property>
<Property>
<description>crossdirection</description>
<value>lefttoright</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

eventType
Required, behavior analysis alarm category, including linedetection (line crossing detection),
fielddetection (intrusion detection), regionEntrance (region entrance detection), regionExiting
(region exiting detection), parking (parking detection), loitering (loitering detection), group
(people gathering detection), rapidMove (fast moving detection), unattendedBaggage
(unattended baggage detection), attendedBaggage (object removal detection).
triggerEvent
Optional, the alarm is triggered or not, true-triggered, if not triggered, this field is invalid.
crossdirection
Optional, line crossing detection, including lefttoright (left to right), righttoleft (right to left),
bothdirection (bidirection). When the eventType is linedetection, this field is required.

Real-Time Target Metadata

When Behavior Analysis Alarm is Not Triggered
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>behaviorAnalysis</subType>
<time>2017-01-01T00:00:00+08:00</time>

37
Intelligent Security API (Metadata) Developer Guide

<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<targetID>1</targetID>
<recognition>human</recognition>
<RegionList>
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>50</x>
<y>0</y>
</Point>
<Point>
<x>50</x>
<y>50</y>
</Point>
<Point>
<x>0</x>
<y>50</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>triggerEvent</description>
<value>false</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>
When Behavior Analysis Alarm is Triggered
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>behaviorAnalysis</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>

38
Intelligent Security API (Metadata) Developer Guide

</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<targetID>1</targetID>
<recognition>human</recognition>
<RegionList>
<Region>
<Point>
<x>100</x>
<y>100</y>
</Point>
<Point>
<x>150</x>
<y>100</y>
</Point>
<Point>
<x>150</x>
<y>150</y>
</Point>
<Point>
<x>100</x>
<y>150</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>triggerEvent</description>
<value>true</value>
</Property>
<Property>
<description>eventType</description>
<value>linedetection</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

triggerEvent
Optional, alarm is triggered or not, true-trigered, if not triggered, this field is invalid.
recognition
Required, target type, including "human", "vehicle", and "zoology" (animal).

B.12 XML_Metadata_FaceCapture
XML message about face capture metadata

39
Intelligent Security API (Metadata) Developer Guide

Rule Metadata
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTarget</type>
<subType>faceSnap</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>
</RegionList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

ruleID
Rule ID
RegionList
Coordinates of region that configured with face capture rule.

Real-Time Target Metadata

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

40
Intelligent Security API (Metadata) Developer Guide

<subType>faceSnap</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<targetID>1</targetID>
<ruleID>1</ruleID>
<recognition>face</recognition>
<RegionList>
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>faceScore</description>
<value>100</value>
</Property>
<Property>
<description>ageGroup</description>
<value>100</value>
</Property>
<Property>
<description>gender</description>
<value>male</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

41
Intelligent Security API (Metadata) Developer Guide

targetID
Person target ID
ruleID
Rule ID
recognition
Recognition target type, here it is face.
RegionList
Coordinates of face target position

B.13 XML_Metadata_QueueManagement
XML message about queue management metadata

Rule Metadata of Waiting Time Detection

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTarget</type>
<subType>personQueueTime</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>

42
Intelligent Security API (Metadata) Developer Guide

</Region>
</RegionList>
<PropertyList>
<Property>
<description>regionColor</description>
<value>blue</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

Real-Time Target Metadata of Waiting Time Detection

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>personQueueTime</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<targetID>1</targetID>
<ruleID>1</ruleID>
<recognition>human</recognition>
<RegionList>
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>
</RegionList>
<PropertyList>

43
Intelligent Security API (Metadata) Developer Guide

<Property>
<description>waitTime</description>
<value>600</value>
<description>alarmTime</description>
<value>600</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

targetID
Person target ID
ruleID
Rule ID
recognition
The recognition target is person.
RegionList
Coordinates of person position.

Rule Metadata of People Queuing-up Detection

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTarget</type>
<subType>personQueueCounting</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>//rule ID
<RegionList>//rule frame coordinates
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>

44
Intelligent Security API (Metadata) Developer Guide

<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>regionColor</description>
<value>blue</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

ruleID
Rule ID
RegionList
Coordinates of region that configured with rule.

Real-Time Target Metadata of People Queuing-up Detection

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>personQueueCounting</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<PropertyList>
<Property>
<description>count</description>
<value>5</value>
<description>alarmCount</description>
<value>10</value>
</Property>
</PropertyList>
</Target>
</TargetList>

45
Intelligent Security API (Metadata) Developer Guide

</TargetDetection>
</Metadata>

B.14 XML_Metadata_RadarBehaviorAnalysis
XML message about radar behavior analysis metadata

Rule Metadata (Not Triggered)

<?xml version="1.0" encoding="utf-8"?>
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTargetRadar</type>
<subType>behaviorAnalysis</subType>
<time>2020-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
<radarChannel>1</radarChannel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<PolarCoordinatesList>
<Coordinate>
<angle>30</angle>
<distance>10</distance>
</Coordinate>
</PolarCoordinatesList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

Rule Metadata (Triggered)

46
Intelligent Security API (Metadata) Developer Guide

<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<PolarCoordinatesList>
<Coordinate>
<angle>30</angle>
<distance>10</distance>
</Coordinate>
</PolarCoordinatesList>
</Target>
</TargetList>
</TargetDetection>
<PropertyList>
<Property>
<description>eventType</description>
<value>linedetection</value>
</Property>
<Property>
<description>triggerEvent</description>
<value>true</value>
</Property>
<Property>
<description>crossdirection</description>
<value>lefttoright</value>
</Property>
</PropertyList>
</Metadata>

Detection Region Metadata

<?xml version="1.0" encoding="utf-8"?>
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTargetRadar</type>
<subType>behaviorAnalysis</subType>
<time>2020-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
<radarChannel>1</radarChannel>
</DevInfo>
<RadarDetectionRegion>
<angle>30.15</angle>
<distance>10.50</distance>
<towards>10.30</towards>
<VertexPoint>
<x>0.046</x>
<y>0.057</y>
</VertexPoint>

47
Intelligent Security API (Metadata) Developer Guide

</RadarDetectionRegion>
</Metadata>

Relative Region Metadata of Video Image

<?xml version="1.0" encoding="utf-8"?>
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTargetRadar</type>
<subType>behaviorAnalysis</subType>
<time>2020-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
<radarChannel>1</radarChannel>
</DevInfo>
<VideoDetectionRegion>
<angle>36.66</angle>
<fieldView>70.88</fieldView>
</VideoDetectionRegion>
</Metadata>

Real-Time Target Metadata (Not Triggered)

<?xml version="1.0" encoding="utf-8"?>
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTargetRadar</type>
<subType>behaviorAnalysis</subType>
<time>2020-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
<radarChannel>1</radarChannel>
</DevInfo>
<ActivityTargetList>
<Target>
<targetID>1</targetID>
<speed>30</speed>
<angle>50</angle>
<distance>30</distance>
</Target>
</ActivityTargetList>
</Metadata>

Real-Time Target Metadata (Triggered)

<?xml version="1.0" encoding="utf-8"?>
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>ruleTargetRadar</type>

48
Intelligent Security API (Metadata) Developer Guide

<subType>behaviorAnalysis</subType>
<time>2020-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
<radarChannel>1</radarChannel>
</DevInfo>
<ActivityTargetList>
<Target>
<targetID>1</targetID>
<speed>30</speed>
<angle>50</angle>
<distance>30</distance>
<PropertyList>
<Property>
<description>triggerEvent</description>
<value>true</value>
</Property>
<Property>
<description>eventType</description>
<value>linedetection</value>
</Property>
</PropertyList>
</Target>
</ActivityTargetList>
</Metadata>

Property Field Description

eventType
Required, xs: string, sub event type of behavior analysis: linedetection (line crossing detection),
fielddetection (intrusion detection).
triggerEvent
Optional, xs: boolean, whether the rule is triggered: true (yes), if it is not triggered, this field will
not be returned.
crossdirection
Optional, xs: string, line crossing direction: lefttoright (from left to right), righttoleft (from right
to left), bothdirection (bidirection). This field is only valid when the value of eventType is
"linedetection".
speed
Required, xs: integer, target speed.
distance
Required, xs: integer, target distance (relative to polar coordinate).
angle

49
Intelligent Security API (Metadata) Developer Guide

Required, xs: float, target angle (relative to polar coordinate).

triggerEvent
Optional, xs: boolean, whether the event has occurred: true (yes). If it does not occur, this field
will not be returned.

B.15 XML_Metadata_Thermal
XML message about thermal related (i.e., real-time temperature measurement, fire source
detection, and ship detection) metadata

Real-Time Temperature Metadata

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>thermometry</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target> //Average temperature of a line
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>100</x>
<y>100</y>
</Point>
<Point>
<x>200</x>
<y>200</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>tempValue</description>
<value>30</value>
</Property>
<Property>
<description>tempUnit</description>
<value>centigrade</value>
</Property>
<Property>
<description>tempProperty</description>

50
Intelligent Security API (Metadata) Developer Guide

<value>average</value>
</Property>
</PropertyList>
</Target>
<Target> //Lowest temperature point of a line
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>100</x>
<y>100</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>tempValue</description>
<value>20</value>
</Property>
<Property>
<description>tempUnit</description>
<value>centigrade</value>
</Property>
<Property>
<description>tempProperty</description>
<value>lowest</value>
</Property>
</PropertyList>
</Target>
<Target> //Highest temperature point of a line
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>200</x>
<y>200</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>tempValue</description>
<value>40</value>
</Property>
<Property>
<description>tempUnit</description>
<value>centigrade</value>
</Property>
<Property>
<description>tempProperty</description>
<value>highest</value>
</Property>

51
Intelligent Security API (Metadata) Developer Guide

</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

tempValue
Required, target temperature, float type.
tempUnit
Required, temperature unit, including centigrade, fahrenheit, and kelvin.
tempProperty
Optional, target temperature property, including highest (highest temperature), lowest (lowest
temperature), and average (average temperature). This field is invalid when measuring
temperature by point.

Fire Source Alarm Metadata

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>fireDetection</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<RegionList>
<Region> //Fire source frame
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>

52
Intelligent Security API (Metadata) Developer Guide

</RegionList>
<PropertyList>
<Property>
<description>distance</description>
<value>1000</value>
</Property>
</PropertyList>
</Target>
<Target>
<RegionList>
<Region>
<Point>
<x>300</x>
<y>300</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>tempValue</description>
<value>100</value>
</Property>
<Property>
<description>tempUnit</description>
<value>centigrade</value>
</Property>
<Property>
<description>tempProperty</description>
<value>highest</value>
</Property>
</PropertyList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

distance
Optional, fire source distance, unit: m, integer type.
tempValue
Optional, fire source temperature, float type.
tempUnit
Optional, fire source temperature unit, including centigrade, fahrenheit, and kelvin.
tempProperty
Optional, target temperature property, currently, only contains highest (highest temperature).

Rule Metadata of Ship Detection

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

53
Intelligent Security API (Metadata) Developer Guide

<subType>shipsDetection</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>
</RegionList>
</Target>
</TargetList>
</TargetDetection>
</Metadata>

Real-Time Target Metadata of Ship Detection

<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>activityTarget</type>
<subType>shipsDetection</subType>
<time>2017-01-01T00:00:00+08:00</time>
<DevInfo>
<ipAddress>192.168.0.64</ipAddress>
<portNo>554</portNo>
<macAddress>28:57:be:ee:d1:5a</macAddress>
<channel>1</channel>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>

54
Intelligent Security API (Metadata) Developer Guide

<targetID>1</targetID>
<recognition>ship</recognition>
<ruleID>1</ruleID>
<RegionList>
<Region>
<Point>
<x>0</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>0</y>
</Point>
<Point>
<x>600</x>
<y>600</y>
</Point>
<Point>
<x>0</x>
<y>600</y>
</Point>
</Region>
</RegionList>
<PropertyList>
<Property>
<description>direction</description>
<value>left</value>
</Property>
<Property>
<description>state</description>
<value>crossing</value>
</Property>
<Property>
<description>length</description>
<value>50</value>
</Property>
<Property>
<description>height</description>
<value>3</value>
</Property>
<Property>
<description>width</description>
<value>5</value>
</Property>
<Property>
<description>speed</description>
<value>4</value>
</Property>
</PropertyList>
</Target>
</TargetList>

55
Intelligent Security API (Metadata) Developer Guide

</TargetDetection>
</Metadata>

direction
Optional, ship direction, including up (forward), down (backward), left (leftward), and right
(rightward).
state
Optional, ship detection status, including crossing (crossing detection line), nose (prow
detection), and tail (stern detection).
length, height, width
Optional, ship length, height, and width, unit: m.
speed
Optional, ship speed, unit: m/s.

B.16 XML_MetadataCfg
XML message about batch configuration parameters of metadata
<MetadataCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<MetadataList>
<Metadata>
<type>

</type>
<enable></enable>
</Metadata>
</MetadataList>
<uploadDataFormat></uploadDataFormat>
</MetadataCfg>

B.17 XML_Radar_Metadata
XML message about general medata of radar detection
<?xml version="1.0" encoding="utf-8"?>
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>

</type>
<subType></subType>
<time></time>
<DevInfo>

56
Intelligent Security API (Metadata) Developer Guide

57
Intelligent Security API (Metadata) Developer Guide

Remarks
For different detection types, the metadata details of radar detection are different, see the table
below.
Detection Type Metadata Details
Radar Behavior Analysis XML_Metadata_RadarBehaviorAnalysis

B.18 XML_ResponseStatus
XML message about response status
<ResponseStatus version="2.0" xmlns="http://www.std-cgi.org/ver20/XMLSchema">
<requestURL>

</requestURL>
<statusCode>

</statusCode>
<statusString>

</statusString>
<subStatusCode>

</subStatusCode>
</ResponseStatus>

Note
See Response Codes of Text Protocol for details about sub status codes and corresponding error
codes.

B.19 XML_SingleMetadataCfg
XML message about single configuration parameters of metadata
<SingleMetadataCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Metadata>
<type>

</type>
<enable></enable>

58
Intelligent Security API (Metadata) Developer Guide

</Metadata>
</SingleMetadataCfg>

B.20 XML_Video_Metadata
XML message about general metadata of video
<Metadata version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<type>

</type>
<subType>

</subType>
<time></time>
<DevInfo>
<ipAddress></ipAddress>
<ipv6Address></ipv6Address>
<portNo></portNo>
<macAddress></macAddress>
<channel></channel>
<domainName></domainName>
</DevInfo>
<TargetDetection>
<TargetList>
<Target>
<targetID>

</targetID>
<recognition><!—optional,xs:string, "human, vehicle, ship"--></recognition>
<ruleID><!—optional,xs:integer, detection rule ID--></ruleID>
<RegionList>
<Region>
<Point>
<x></x>
<y></y>
</Point>
</Region>
</RegionList>
<PropertyList> 
<Property>
<description></description>

59
Intelligent Security API (Metadata) Developer Guide

Remarks
For different detection types, the metadata details are different, see the table below.
Detection Type Metadata Details
Thermal Related (Real-Time Temperature XML_Metadata_Thermal
Measurement, Fire Source Detection, and Ship
Detection)
Behavior Analysis XML_Metadata_BehaviorAnalysis
ANPR XML_Metadata_ANPR
Queue Management (Waiting Time Detection XML_Metadata_QueueManagement
and People Queuing-up Detection)
Face Capture XML_Metadata_FaceCapture

60
Intelligent Security API (Metadata) Developer Guide

Appendix C. Response Codes of Text Protocol

The response codes returned during the text protocol integration is based on the status codes of
HTTP. 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 response 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.

61
Intelligent Security API (Metadata) Developer Guide

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.

62
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

trafficException 0x30001008 Monitoring point big data
server exception.
faceException 0x30001009 Human face big data server
exception.
SSDFileSystemIsError 0x30001013 SSD file system error (Error
occurs when it is non-Ext4 file
system)
insufficientSSDCapacityForFPD 0x30001014 Insufficient SSD space for
person frequency detection
wifiException 0x3000100A Wi-Fi big data server exception
structException 0x3000100D Video parameters structure
server exception.
calibrationTimeout 0x30002051 Calibration timed out.
captureTimeout 0x30006000 Data collection timed out.
lowScore 0x30006001 Low quality of collected data.
uploadingFailed 0x30007004 Uploading failed.

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.
USBNotExist 0x40000010 USB device is not connected.

63
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

upgradePackageMoret 0x40001000 Up to 2GB upgrade package is allowed to be
han2GB 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.
backupnodeNotAllowe 0x40001009 Accessing to backup node is not allowed.
Log
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.
exportItemsExceedLimi 0x40001010 No more items can be exported.
t
noFiles 0x40001011 The file does not exist.
beingExportedByAnoth 0x40001012 Being exported by others.
erUser
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.

64
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

unitNotOnline 0x4000101B The data analysis server is offline.
unitInfoEror 0x4000101C Getting data analysis server information failed.
unitGetNodeInfoError 0x4000101D Getting node information failed.
unitGetNetworkInfoErr 0x4000101E Getting the network information of data
or analysis server failed
unitSetNetworkInfoErr 0x4000101F Setting the network information of data analysis
or server failed
setSmartNodeInfoError 0x40001020 Setting node information failed.
setUnitNetworkInfoErr 0x40001021 Setting data analysis server network
or 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.
uintVersionMismatche 0x40001026 Data analysis server version mismatches.
d
deviceMOdelMismatch 0x40001027 Adding failed. Device model mismatches.
ed
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.
getClientAddedNodeFa 0x4000102D Getting the added node information of data
iled analysis server failed.
taskExit 0x4000102E The task already exists.
taskInitError 0x4000102F Initializing task failed.
taskSubmitError 0x40001030 Submiting task failed.
taskDelError 0x40001031 Deleting task failed.

65
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

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.
unitLinksNoStorageNo 0x4000103D No node is linked with the data analysis server.
de Configure the node first.
searchFailed 0x4000103E Searching video files failed.
searchNull 0x4000103F No video clip.
userScheOffline 0x40001040 The task scheduler service is offline.
updateTypeUnmatche 0x40001041 The upgrade package type mismatches.
d
userExist 0x40001043 The user already exists.
userCannotDelAdmin 0x40001044 The administrator cannot be deleted.
userInexistence 0x40001045 The user name does not exist.
userCannotCreatAdmi 0x40001046 The administrator cannot be created.
n
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.

66
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

monitorParseFailed 0x4000104F Parsing camera information failed.
monitorCreatRootFaile 0x40001050 Creating resource node failed.
d
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.
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.
searchSerConnectFaile 0x4000105F Connecting to full-text search server failed.
d 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.

67
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

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.
serviceNumberReache 0x40001069 No more service can be added.
sLimit
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.
ipUsed 0x4000107A The virtual IP address has been occupied.

68
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

cloudAlalyseOnline 0x4000107B The cloud analytic server is online.
virIP&mainIPnotSame 0x4000107C The virtual IP address is not in the same
NetSegment network segment with the IP address of
master/slave node.
getNodeDispatchInfoFa 0x4000107D Getting node scheduler information failed.
iled
unableModifyManage 0x4000107E Editing management network interface failed.
mentNetworkIP 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.
ArmingSearchTimeErro 0x40001089 Invalid search time period.
r
armingRelationshipRea 0x4000108A No more relation can be created.
chesLimit
duplicateAarmingNam 0x4000108B The relation name already exists.
e
noMoreArmingListAdd 0x4000108C No more blacklist library can be armed.
ed
noMoreCamerasAdded 0x4000108D No more camera can be armed.
noMoreArmingListAdd 0x4000108E No more library can be linked to the camera.
edWithCamera
noMoreArmingPeriodA 0x4000108F No more time period can be added to the
dded arming schedule.

69
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

armingPeriodsOverlap 0x40001090 The time periods in the arming schedule are
ped overlapped.
noArmingAlarmInfo 0x40001091 The alarm information does not exist.
armingAlarmUnRead 0x40001092 Getting number of unread alarms failed.
getArmingAlarmError 0x40001093 Getting alarm information failed.
searchByPictureTimed 0x40001094 Searching picture by picture timeout. Search
Out again.
comparisonTimeRange 0x40001095 Comparison time period error.
Error
selectMonitorNumber 0x40001096 No more monitoring point ID can be filtered.
UpperLimit
noMoreComparisonTas 0x40001097 No more comparison task can be executed at
ksAdded the same time.
GetComparisonResultF 0x40001098 Getting comparison result failed.
ailed
comparisonTypeError 0x40001099 Comparison type error.
comparisonUnfinished 0x4000109A The comparison is not completed.
facePictureModelInvali 0x4000109B Invalid face model.
d
duplicateLibraryName. 0x4000109C The library name already exists.
noRecord 0x4000109D No record found.
countingRecordsFailed. 0x4000109E Calculate the number of records failed.
getHumanFaceFrameF 0x4000109F Getting face thumbnail from the picture failed.
ailed
modelingFailed. 0x400010A0 Modeling face according to picture URL failed.
1V1FacePictureCompar 0x400010A1 Comparison 1 VS 1 face picture failed.
isonFailed
libraryArmed 0x400010A2 The blacklist library is armed.
licenseExeedLimit 0x400010A3 Dongle limited.
licenseExpired 0x400010A4 Dongle expired.
licenseDisabled 0x400010A5 Unavailable dongle.

70
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

licenseNotExist 0x400010A6 The dongle does not exist.
SessionExpired 0x400010A7 Session expired .
beyondConcurrentLimi 0x400010A8 Out of concurrent limit.
t
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.
queryHistoryVideoFaile 0x400010B4 Searching history video failed.
d
addDeviceFailed 0x400010B5 Adding device failed.
addVideoFailed 0x400010B6 Adding video files failed.
deleteAllVideoFailed 0x400010B7 Deleting all video files failed.
createVideoIndexFailed 0x400010B8 Indexing video files failed.
videoCheckTypeFailed 0x400010B9 Verifying video files types failed.
configStructuredAddre 0x400010BA Configuring IP address of structured server
ssFailed failed.
configPictureServerAd 0x400010BB Configuring IP address of picture storaged
dressFailed server failed.
storageServiceIPNotExi 0x400010BD The storage server IP address does not exist.
st

71
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

syncBackupDatabaseFa 0x400010BE Synchronizing slave database failed. Try again.
iled
syncBackupNTPTimeFa 0x400010BF Synchronizing NTP time of slave server failed.
iled
clusterNotSelectLoopb 0x400010C0 Loopbacl address is not supported by the
ackAddress master or slave cluster.
addFaceRecordFailed 0x400010C1 Adding face record failed.
deleteFaceRecordFaile 0x400010C2 Deleting face record failed.
d
modifyFaceRecordFaile 0x400010C3 Editing face record failed.
d
queryFaceRecordFailed 0x400010C4 Searching face record failed.
faceDetectFailed 0x400010C5 Detecting face failed.
libraryNotExist 0x400010C6 The library does not exist.
blackListQueryExportin 0x400010C7 Exporting matched blacklists.
g
blackListQueryExporte 0x400010C8 The matched blacklists are exported.
d
blackListQueryStopExp 0x400010C9 Exporting matched blacklists is stopped.
orting
blackListAlarmQueryEx 0x400010CA Exporting matched blacklist alarms.
porting
blackListAlarmQueryEx 0x400010CB The matched blacklists alarms are exported.
ported
blackListAlarmQuerySt 0x400010CC Exporting matched blacklist alarms is stopped.
opExporting
getBigDataCloudAnalys 0x400010CD Getting big data cloud analytic information
isFailed failed.
setBigDataCloudAnalys 0x400010CE Configuring big data cloud analytic failed.
isFailed
submitMapSearchFaile 0x400010CF Submitting search by picture task failed.
d

72
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

controlRelationshipNot 0x400010D0 The relation does not exist.
Exist
getHistoryAlarmInfoFai 0x400010D1 Getting history alarm information failed.
led
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.
bigDataServerConnect 0x400010D8 Connecting to big data server failed.
Failed
microVideoCloudRequ 0x400010D9 Adding response information of micro video
estInfoBuildFailed cloud failed.
microVideoCloudRespo 0x400010DA Parsing response information of micro video
nseInfoBuildFailed cloud failed.
transcodingServerRequ 0x400010DB Adding response information of transcoding
estInfoBuildFailed server failed.
transcodingServerResp 0x400010DC Parsing response information of transcoding
onseInfoParseFailed server failed.
transcodingServerOffli 0x400010DD Transcoding server is offline.
ne
microVideoCloudOfflin 0x400010DE Micro video cloud is offline.
e
UPSServerOffline 0x400010DF UPS monitor server is offline.
statisticReportRequestI 0x400010E0 Adding response information of statistics report
nfoBuildFailed failed.
statisticReportRespons 0x400010E1 Parsing response information of statistics report
eInfoParseFailed failed.
DisplayConfigInfoBuild 0x400010E2 Adding display configuration information failed.
Failed
DisplayConfigInfoParse 0x400010E3 Parsing display configuration information failed.
Failed

73
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

DisplayConfigInfoSaveF 0x400010E4 Saving display configuration information failed.
ailed
notSupportDisplayConf 0x400010E5 The display configuration type is not supported.
igType
passError 0x400010E7 Incorrect password.
upgradePackageLarge 0x400010EB Too large upgrade package.
sesssionUserReachesLi 0x400010EC No more user can log in via session.
mit
ISO 0x400010ED Invalid ISO8601 time format.
8601TimeFormatError
clusterDissolutionFaile 0x400010EE Deleting cluster failed.
d
getServiceNodeInfoFail 0x400010EF Getting service node information failed.
ed
getUPSInfoFailed 0x400010F0 Getting UPS configuration information failed.
getDataStatisticsRepor 0x400010F1 Getting data statistic report failed.
tFailed
getDisplayConfigInfoFai 0x400010F2 Getting display configuration failed.
led
namingAnalysisBoardN 0x400010F3 Renaming analysis board is not allowed.
otAllowed
onlyDrawRegionsOfCo 0x400010F4 Only drawing convex polygon area is supported.
nvexPolygon
bigDataServerRespons 0x400010F5 Parsing response message of big data service
eInfoParseFailed failed.
bigDataServerReturnFa 0x400010F6 No response is returned by big data service.
iled
microVideoReturnFaile 0x400010F7 No response is returned by micro video cloud
d service.
transcodingServerRetu 0x400010F8 No response is returned by transcoding service.
rnFailed
UPSServerReturnFailed 0x400010F9 No response is returned by UPS monitoring
service.

74
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

forwardingServer 0x400010FA No response is returned by forwarding service.
ReturnFailed
storageServer 0x400010FB No response is returned by storage service.
ReturnFailed
cloudAnalysisServerRet 0x400010FC No response is returned by cloud analytic
urnFailed service.
modelEmpty 0x400010FD No model is obtained.
mainAndBackupNodeC 0x400010FE Editing the management interface IP address of
annotModifyManagem master node and backup node is not allowed.
entNetworkInterfaceIP
IDTooLong 0x400010FF The ID is too long.
pictureCheckFailed 0x40001100 Detecting picture failed.
pictureModelingFailed 0x40001101 Modeling picture failed.
setCloudAnalsisDefault 0x40001102 Setting default province of cloud analytic
ProvinceFailed service failed.
InspectionAreasNumbe 0x40001103 No more detection regions can be added.
rExceedLimit
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.
bigDataServerRequestI 0x40001108 Creating request message of big data service
nfoBuildFail failed.
analysiTimedOut 0x40001109 Analysis time out.
high- 0x4000110A Please enable high-performance mode.
performanceModeDisa
bled.
configuringUPSMonito 0x4000110B Configurating the UPS monitoring server time
ringServerTimedOut out. Check IP address.
cloudAnalysisRequestI 0x4000110C Creating request message of cloud analytic
nformationBuildFailed service failed.
cloudAnalysisResponse 0x4000110D Parsing response message of cloud analytic
InformationParseFailed service failed.

75
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

allCloudAnalysisInterfa 0x4000110E Calling API for cloud analytic service failed.
ceFailed
cloudAnalysisModelCo 0x4000110F Model comparison of cloud analytic service
mpareFailed failed.
cloudAnalysisFacePictu 0x40001110 Getting face quality grading of cloud analytic
reQualityRatingFailed service failed.
cloudAnalysisExtractFe 0x40001111 Extracting feature of cloud analytic service
aturePointsFailed failed.
cloudAnalysisExtractPr 0x40001112 Extracting property of cloud analytic service
opertyFailed failed.
getAddedNodeInformat 0x40001113 Getting the added nodes information of data
ionFailed analysis server failed.
noMoreAnalysisUnitsA 0x40001114 No more data analysis servers can be added.
dded
detectionAreaInvalid 0x40001115 Invalid detection region.
shieldAreaInvalid 0x40001116 Invalid shield region.
noMoreShieldAreasAd 0x40001117 No more shield region can be drawn.
ded
onlyAreaOfRectangleS 0x40001118 Only drawing rectangle is allowed in detection
hapeAllowed area.
numberReachedLlimit 0x40001119 Number reached the limit.
wait1~3MinutesGetIPAf 0x4000111A Wait 1 to 3 minutes to get IP address after
terSetupDHCP configuring DHCP.
plannedTimeMustbeH 0x4000111B Schedule must be half an hour.
alfAnHour
oneDeviceCannotBuild 0x4000111C Creating master and backup cluster requires at
Cluster least two devices.
updatePackageFileNot 0x4000111E Upgrade package is not uploaded.
Uploaded
highPerformanceTasks 0x4000111F Drawing detection area is not allowed under
NotSupportDrawingDe high-performance mode.
tectionRegions

76
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

controlCenterIDDoesN 0x40001120 The control center ID does not exist.
otExist
regionIDDoesNotExist 0x40001121 The area ID does not exist.
licensePlateFormatErro 0x40001122 Invalid license plate format.
r
managementNodeDoe 0x40001123 The operation is not supported.
sNotSupportThisOperat
ion
searchByPictureResour 0x40001124 The conditions for searching picture by picture
ceNotConfiged are not configured.
videoFileEncapsulation 0x40001125 The video container format is not supported.
FormatNotSupported
videoPackageFailure 0x40001126 Converting video container format failed.
videoCodingFormatNot 0x40001127 Video coding format is not supported.
Supported
monitorOfDeviceArmin 0x40001129 The camera is armed. Disarm it and try again.
gdeleteArmingInfo
getVideoSourceTypeFai 0x4000112A Getting video source type failed.
led
smartRulesBuildFailed 0x4000112B Creating VAC rule failed.
smartRulesParseFailed 0x4000112C Parsing VAC rule failed.
timeRulesBuildFailed 0x4000112D Creating time rule failed.
timeRulesParseFailed 0x4000112E Parsing time rule failed.
monitoInfoInvalid 0x4000112F Invalid camera information.
addingFailedVersionMi 0x40001130 Adding failed. The device version mismatches.
smatches
theInformationReturne 0x40001131 No response is returned by the cloud analytic
dAfterCloudAnalysisIsE service.
mpty
selectingIpAddressOfH 0x40001132 Setting IP address for master node and backup
ostAndSpareNodeFaile node failed. Check the node status.
dCheckTheStatus

77
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

theSearchIdDoesNotEx 0x40001133 The search ID does not exist.
ist
theSynchronizationIdD 0x40001134 The synchronization ID does not exist.
oesNotExist
theUserIdDoesNotExist 0x40001136 The user ID does not exist.
theIndexCodeDoesNot 0x40001138 The index code does not exist.
Exist
theControlCenterIdDoe 0x40001139 The control center ID does not exist.
sNotExist
theAreaIdDoesNotExist 0x4000113A The area ID does not exist.
theArmingLinkageIdDo 0x4000113C The arming relationship ID does not exist.
esNotExist
theListLibraryIdDoesNo 0x4000113D The list library ID does not exist.
tExist
invalidCityCode 0x4000113E Invalid city code.
synchronizingThePass 0x4000113F Synchronizing backup system password failed.
wordOfSpareServerFail
ed
editingStreamingTypeIs 0x40001140 Editing streaming type is not supported.
NotSupported
switchingScheduledTas 0x40001141 Switching scheduled task to temporary task is
kToTemporaryTaskIsNo not supported.
tSupported
switchingTemporaryTas 0x40001142 Switching temporary task to scheduled task is
kToScheduledTaskIsNot not supported.
Supported
theTaskIsNotDispatche 0x40001143 The task is not dispatched or is updating.
dOrItIsUpdating
thisTaskDoesNotExist 0x40001144 This task does not exist in the cloud analytic
serice.
duplicatedSchedule 0x40001145 Schedule period cannot be overlapped.
continuousScheduleWi 0x40001146 The continuous schedule periods with same
thSameAlgorithmType algorithm type should be merged.
ShouldBeMerged

78
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

invalidStreamingTimeR 0x40001147 Invalid streaming time period.
ange
invalidListLibraryType 0x40001148 Invalid list library type.
theNumberOfMatched 0x40001149 The number of search results should be larger
ResultsShouldBeLarger than 0.
Than0
invalidValueRangeOfSi 0x4000114A Invalid similarity range.
milarity
invalidSortingType 0x4000114B Invalid sorting type.
noMoreListLibraryCanB 0x4000114C No more lists can be added to one device.
eLinkedToTheDevice
InvalidRecipientAddres 0x4000114D Invalid address format of result receiver.
sFormat
creatingClusterFailedT 0x4000114E Insert the dongle before creating cluster.
heDongleIsNotPlugged
In
theURLIsTooLong 0x4000114F No schedule configured for the task.
noScheduleIsConfigure 0x40001150 No schedule configured for the task.
dForTheTask
theDongleIsExpiried 0x40001151 Dongle has expired.
dongleException 0x40001152 Dongle exception.
invalidKey 0x40001153 Invalid authorization service key.
decryptionFailed 0x40001154 Decrypting authorization service failed.
encryptionFailed 0x40001155 Encrypting authorization service failed.
AuthorizeServiceRespo 0x40001156 Authorization service response exception.
nseError
incorrectParameter 0x40001157 Authorization service parameters error.
operationFailed 0x40001158 Operating authorization service error.
noAnalysisResourceOr 0x40001159 No cloud analytic resources or no data in the list
NoDataInTheListLibrary library.
calculationException 0x4000115A Calculation exception.
allocatingList 0x4000115B Allocating list.

79
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

thisOperationIsNotSup 0x4000115C This operation is not supported by the cloud
portedByTheCloudAnal analytic serice.
ytics
theCloudAnalyticsIsInt 0x4000115D The operation of cloud analytic serice is
errupted interrupted.
theServiceIsNotReady 0x4000115E The service is not ready.
searchingForExternalA 0x4000115F Searching external interfaces failed.
piFailed
noOnlineNode 0x40001160 No node is online.
noNodeAllocated 0x40001161 No allocated node.
noMatchedList 0x40001162 No matched list.
allocatingFailedTooMa 0x40001163 Allocation failed. Too many lists of big data
nyFacePictureLists service.
searchIsNotCompleted 0x40001164 Current searching is not completed. Search
SearchAgain again.
allocatingListIsNotCom 0x40001165 Allocating list is not completed.
pleted
searchingForCloudAnal 0x40001166 Searching cloud analytic serice overtime.
yticsResultsFailed
noDataOfTheCurrentLi 0x40001167 No data in the current library. Make sure there
braryFound is data in the Hbase.
noFacePictureLibraryIs 0x40001168 No face picture library is armed for big data
Armed service.
noAvailableDataSlicing 0x40001169 Invalid standard version information.
VersionInformationAr
mFirstAndSliceTheData
duplicatedOperationDa 0x4000116A Slicing failed. Duplicated operation.
taSlicingIsExecuting
slicinDataFailedNoArm 0x4000116B Slicing failed. No arming information in the face
edFacePictureLibrary big data.
GenerateBenchmarkFil 0x4000116C Generating sliced file failed. Slice again.
eFailedSlicingAgain

80
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

NonprimaryNodeIsPro 0x4000116D Slicing is not allowed by the backup node.
hibitedFromSlcingData
NoReadyNodeToCluste 0x4000116E Creating the cluster failed. No ready node.
rServers
NodeManagementServ 0x4000116F The node management server is offline.
iceIsOffline
theCamera(s)OfTheCo 0x40001170 Some cameras in control center are already
ntrolCenterAreAlready armed. Disarm them and try again.
Armed.DisarmThemFir
st
theCamera(s)OfTheAre 0x40001171 Some cameras in this area are already armed.
aAreAlreadyArmed.Dis Disarm them and try again.
armThemFirst
configuringHigh- 0x40001172 Configuring high frequency people detection
frequencyPeopleDetect failed.
ionFailed
searchingForHigh- 0x40001173 Searching detection event logs of high-
frequencyPeopleDetect frequency people detection failed.
ionLogsFailed.
gettingDetailsOfSearch 0x40001174 Getting the search result details of high
edHigh- frequency alarms failed.
frequencyPeopleDetect
ionLogsFailed.
theArmedCamerasAlre 0x40001175 Some cameras in control center are already
adyExistInTheControlC armed.
enter
disarmingFailedTheCa 0x40001177 Disarming failed. The camera is not armed.
meraIsNotArmed
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.
analysisServicesDoNot 0x4000117B Not supported.
Support

81
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

commandAndDispatch 0x4000117C Scheduling service of cloud analytic serice error.
ServiceError
engineModuleError 0x4000117D Engine module of cloud analytic serice error.
streamingServiceError 0x4000117E Streaming component of cloud analytic serice
error.
faceAnalysisModuleErr 0x4000117F Face analysis module of cloud analytic serice
or error.
vehicleAnalysisModule 0x40001180 Vehicle pictures analytic module of cloud
Error analytic serice error.
videoStructuralAnalysis 0x40001181 Video structuring module of cloud analytic
ModuleError serice error.
postprocessingModule 0x40001182 Post-processing module of cloud analytic serice
Error error.
frequentlyAppearedPe 0x40001183 High frequency alarm is already armed for
rsonAlarmIsAlreadyCo blacklist library.
nfiguredForListLibrary
creatingListLibraryFaile 0x40001184 Creating list library failed.
d
invalidIdentiryKeyOfLis 0x40001185 Invalid identity key of list library.
tLibrary
noMoreDevicesCanBe 0x40001186 No more camera can be added.
Armed
settingAlgorithmTypeF 0x40001187 Allocating task resource failed.
orDeviceFailed
gettingHighFrequencyP 0x40001188 Setting high frequency alarm failed.
ersonDetectionAlarmIn
formationFailed
invalidSearchConfition 0x40001189 Invalid result.
theTaskIsNotComplete 0x4000118B The task is not completed.
d
resourceOverRemainLi 0x4000118C No more resource can be pre-allocated.
mit

82
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

frequentlyAppearedPe 0x4000118D The high frequency alarm of this camera is
rsonAlarmIs configured. Delete the arming information and
AlreadyConfiguredForT try again.
heCameraDisarmFirstA
ndTryAgain
switchtimedifflesslimit 0x4000123b Time difference between power on and off
should be less than 10 minutes.
associatedFaceLibNum 0x40001279 Maximum number of linked face picture
OverLimit libraries reached.
noMorePeopleNumCh 0x4000128A Maximum number of people number changing
angeRulesAdded rules reached.
noMoreViolentMotion 0x4000128D Maximum number of violent motion rules
RulesAdded reached.
noMoreLeavePositionR 0x4000128E Maximum number of leaving position rules
ulesAdded reached.
SMRDiskNotSupportRa 0x40001291 SMR disk does not support RAID.
id
OnlySupportHikAndCus 0x400012A3 IPv6 camera can only be added via Device
tomProtocol Network SDK or custom protocols.
vehicleEnginesNoReso 0x400012A6 Insufficient vehicle engine resources.
urce
noMoreRunningRulesA 0x400012A9 Maximum number of running rules reached.
dded
noMoreGroupRulesAd 0x400012AA Maximum number of people gathering rules
ded reached.
noMoreFailDownRules 0x400012AB Maximum number of people falling down rules
Added reached.
noMorePlayCellphone 0x400012AC Maximum number of playing cellphone rules
RulesAdded reached.
ruleEventTypeDuplicat 0x400012C8 Event type duplicated.
e
noMoreRetentionRules 0x400015AD Maximum number of people retention rules
Added reached.

83
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

noMoreSleepOnDutyR 0x400015AE Maximum number of sleeping on duty rules
ulesAdded reached.
polygonNotAllowCrossi 0x400015C2 Polygons are not allowed to cross.
ng
AITargetBPCaptureFail 0x400019C5 Capturing reference picture for AI target
comparison failed.
AITargetBPToDSPFail 0x400019C6 Sending reference picture to DSP for AI target
comparison failed.
AITargetBPDuplicateNa 0x400019C7 Duplicated name of reference picture for AI
me target comparison.
audioFileNameWrong 0x400019D0 Incorrect audio file name.
audioFileImportFail 0x400019D1 Importing audio file failed.
alreadyRunning 0x40002026 The application program is running.
notRunning 0x40002027 The application program is stopped.
packNotFound 0x40002028 The software packet does not exist.
alreadyExist 0x40002029 The application program already exists.
noMemory 0x4000202A Insufficient memory.
invalLicense 0x4000202B Invalid License.
noClientCertificate 0x40002036 The client certificate is not installed.
noCACertificate 0x40002037 The CA certificate is not installed.
authenticationFailed 0x40002038 Authenticating certificate failed. Check the
certificate.
clientCertificateExpired 0x40002039 The client certificate is expired.
clientCertificateRevocat 0x4000203A The client certificate is revoked.
ion
CACertificateExpired 0x4000203B The CA certificate is expired.
CACertificateRevocatio 0x4000203C The CA certificate is revoked.
n
connectFail 0x4000203D Connection failed.
loginNumExceedLimit 0x4000203F No more user can log in.

84
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

HDMIResolutionIllegal 0x40002040 The HDMI video resolution cannot be larger
than that of main and sub stream.
hdFormatFail 0x40002049 Formatting HDD failed.
formattingFailed 0x40002056 Formatting HDD failed.
encryptedFormattingFa 0x40002057 Formatting encrypted HDD failed.
iled
wrongPassword 0x40002058 Verifying password of SD card failed. Incorrect
password.
audioIsPlayingPleaseW 0x40002067 Audio is playing. Please wait.
ait
twoWayAudioInProgre 0x40002068 Two-way audio in progress. Please wait.
ssPleaseWait
calibrationPointNumFu 0x40002069 The maximum number of calibration points
ll reached.
completeTheLevelCalib 0x4000206A The level calibration is not set.
rationFirst
completeTheRadarCam 0x4000206B The radar-camera calibration is not set.
eraCalibrationFirst
pointsOnStraightLine 0x4000209C Calibrating failed. The calibration points cannot
be one the same line.
TValueLessThanOrEqua 0x4000209D Calibration failed. The T value of the calibration
lZero points should be larger than 0.
HBDLibNumOverLimit 0x40002092 The number of human body picture libraries
reaches the upper limit
theShieldRegionError 0x40002093 Saving failed. The shielded area should be the
ground area where the shielded object is
located.
theDetectionAreaError 0x40002094 Saving failed. The detection area should only
cover the ground area.
invalidLaneLine 0x40002096 Saving failed. Invalid lane line.
enableITSFunctionOfTh 0x400020A2 Enable ITS function of this channel first.
isChannelFirst
noCloudStorageServer 0x400020C5 No cloud storage server

85
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

NotSupportWithVideo 0x400020F3 This function is not supported.
Task
incorrectConsolePassw 0x40002106 Saving failed. Incorrect console command.
ord
noDetectionArea 0x400050df No detection area
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.
zoneFault 0x4000800E The zone is in fault status.
pwdConflict 0x4000800F Password conflicted.
audioTestEntryFailed 0x40008010 Enabling audio test mode failed.
audioTestRecoveryFaile 0x40008011 Disabling audio test mode failed.
d
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.

86
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

theNumberOfExDevLi 0x40008017 No peripheral can be added.
mited
sirenConfigFailed 0x40008018 Setting siren failed.
chanCannotRepeatedB 0x40008019 This channel is already linked by the zone.
inded
inProgramMode 0x4000801B The keypad is in programming mode.
inPaceTest 0x4000801C In pacing mode.
arming 0x4000801D Arming.
masterSlaveIsEnable 0x4000802c The master-slave relationship has taken effect,
the slave radar does not support this operation.
forceTrackNotEnabled 0x4000802d Mandatory tracking is disabled.
isNotSupportZoneConfi 0x4000802e This area does not support the zone type.
gByLocalArea
alarmLineCross 0x4000802f Trigger lines are overlapped.
zoneDrawingOutOfRan 0x40008030 The drawn zone is out of detection range.
ge
alarmLineDrawingOut 0x40008031 The drawn alarm trigger line is out of detection
OfRange range.
hasTargetInWarningAr 0x40008032 The warning zone already contains targets.
ea Whether to enable mandatory arming?
radarMoudleConnectF 0x40008033 Radar module communication failed.
ail
importCfgFilePassword 0x40008034 Incorrect password for importing configuration
Err files.
overAudioFileNumLimi 0x40008038 The number of audio files exceeds the limit.
t
audioFileNameIsLong 0x40008039 The audio file name is too long.
audioFormatIsWrong 0x4000803a The audio file format is invalid.
audioFileIsLarge 0x4000803b The size of the audio file exceeds the limit.
pircamCapTimeOut 0x4000803c Capturing of pircam timed out.
pircamCapFail 0x4000803d Capturing of pircam failed.
pircamIsCaping 0x4000803e The pircam is capturing.

87
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

audioFileHasExisted 0x4000803f The audio file already exists.
subscribeTypeErr 0x4000a016 This metadata type is not supported to be
subscribed.
startAppFail / Starting running application program failed.
yuvconflict / The raw video stream conflicted.
overMaxAppNum / No more application program can be uploaded.
noFlash / Insufficient flash.
noFlash / The platform mismatches.

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.
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.

88
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

badDevType 0x60000010 Device type mismatches.
badLanguage 0x60000011 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.
DetectionLineOutofDetectionR 0x60000085 The rule line is out of region.
egion
DetectionRegionError 0x60000086 Rule region error. Make sure
the rule region is convex
polygon.
DetectionRegionOutOfCountin 0x60000087 The rule region must be
gRegion marked as red frame.
PedalAreaError 0x60000088 The pedal area must be in the
rule region.
DetectionAreaABError 0x60000089 The detection region A and B
must be in the a rule frame.

89
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

ABRegionCannotIntersect 0x6000008a Region A and B cannot be
overlapped.
customHBPIDError 0x6000008b Incorrect ID of custom human
body picture library
customHBPIDRepeat 0x6000008c Duplicated ID of custom human
body picture library
dataVersionsInHBDLibMismatc 0x6000008d Database versions mismatches
hes of human body picture library
invalidHBPID 0x6000008e Invalid human body picture PID
invalidHBDID 0x6000008f Invalid ID of human body
picture library
humanLibraryError 0x60000090 Error of human body picture
library
humanLibraryNumError 0x60000091 No more human body picture
library can be added
humanImagesNumError 0x60000092 No more human body picture
can be added
noHumanInThePicture 0x60000093 Modeling failed, no human
body in the picture
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.

90
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

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.
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.

91
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

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.
eventNotSupport 0x60001024 Event subscription is not
supported.
invalidEZVIZSecretKey 0x60001034 Invalid verification code for Hik-
Connect.
needDoubleVerification 0x60001042 Double verification required
noDoubleVerificationUser 0x60001043 No double verification user
timeSpanNumOverLimit 0x60001044 Max. number of time buckets
reached
channelNumOverLimit 0x60001045 Max. number of channels
reached
noSearchIDResource 0x60001046 Insufficient searchID resources
noSupportDeleteStrangerLib 0x60001051 Deleting stranger library is not
supported
noSupportCreateStrangerLib 0x60001052 Creating stranger library is not
supported
behaviorAnalysisRuleInfoError 0x60001053 Behavior analysis rule
parameters error.

92
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

safetyHelmetParamError 0x60001054 Hard hat parameters error.
OneChannelOnlyCanBindOneE 0x60001077 No more engines can be
ngine bound.
engineTypeMismatch 0x60001079 Engine type mismatched.
badUpgradePackage 0x6000107A Invalid upgrade package.
AudioFileNameDuplicate 0x60001135 Duplicated audio file name.
CurrentAudioFileAIRuleInUseAl 0x60001136 The AI rule linkage related to
readyDelete current audio file has been
deleted.
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.
noSafetyHelmetRegion 0x60002023 The hard hat detection area is
not configured (if users save
their settings without
configuring the arming area,
they should be prompted to
configure one).
unclosedSafetyHelmet 0x60002024 The hard hat detection is
enabled (If users save their
settings after deleting the
arming area, they should be
prompted to disable hard hat
detection first and then delete
the arming area).
width/ 0x6000202C The width/height ratio of the
heightRatioOfPictureError uploaded picture should be in
the range from 1:2 to 2:1.
PTZNotInitialized 0x6000202E PTZ is not initialized.
PTZSelfChecking 0x6000202F PTZ is self-checking.
PTZLocked 0x60002030 PTZ is locked.

93
Intelligent Security API (Metadata) Developer Guide

Sub Status Code Error Code Description

advancedParametersError 0x60002031 Auto-switch interval in
advanced parameters cannot
be shorter than parking
tolerance for illegal parking
detection in speed dome rule
settings.
resolutionError 0x60005003 Invalid resolution
deployExceedMax 0x60006018 The arming connections exceed
the maximum number.
detectorTypeMismatch 0x60008000 The detector type mismatched.
nameExist 0x60008001 The name already exists.
uploadImageSizeError 0x60008016 The size of the uploaded
picture is larger than 5 MB.
laneAndRegionOverlap / The lanes are overlapped.
unitConfigurationNotInEffect / Invalid unit parameter.
ruleAndShieldingMaskConflict / The line-rule region overlaps
with the shielded area.
wholeRuleInShieldingMask / There are complete
temperature measurement
rules in the shielded area.
LogDiskNotSetReadOnlyInGrou 0x60001100 The log HDD in the HDD group
pMode cannot be set to read-only.
LogDiskNotSetReDundancyInGr 0x60001101 The log HDD in the HDD group
oupMode cannot be set to redundancy.

StatusCode=7

SubStatusCode Error Code Description

rebootRequired 0x70000001 Reboot to take effect.

Hyatt's Interpretation of Pulmonary Function Tests 5th Edition (FULL VERSION DOWNLOAD)
100% (10)
Hyatt's Interpretation of Pulmonary Function Tests 5th Edition (FULL VERSION DOWNLOAD)
15 pages
ISAPI Developer Guide - Network Video Recorders - Special Series - 2024!04!02
No ratings yet
ISAPI Developer Guide - Network Video Recorders - Special Series - 2024!04!02
1,193 pages
Sem 1 Jan'24 Batch-Date Sheet-End Semester Exams
No ratings yet
Sem 1 Jan'24 Batch-Date Sheet-End Semester Exams
3 pages
Facing The Interview
100% (1)
Facing The Interview
331 pages
Mock Drill Report
No ratings yet
Mock Drill Report
2 pages
E3a1 Guidelines AnnexJ en
No ratings yet
E3a1 Guidelines AnnexJ en
3 pages
TPP Document Download
No ratings yet
TPP Document Download
7 pages
Hikvision ISAPI Core Protocol PDF
0% (1)
Hikvision ISAPI Core Protocol PDF
795 pages
Minimum Wages Home Textiles 2024 - 2025
No ratings yet
Minimum Wages Home Textiles 2024 - 2025
1 page
ISAPI - Traffic
No ratings yet
ISAPI - Traffic
492 pages
ISAPI - General
No ratings yet
ISAPI - General
1,083 pages
Database Recovery Techniques
No ratings yet
Database Recovery Techniques
37 pages
Fuzzy Association Rule Mining For Web Usage Visualization: Suash Deb, Simon Fong, Cecilia Ho
No ratings yet
Fuzzy Association Rule Mining For Web Usage Visualization: Suash Deb, Simon Fong, Cecilia Ho
13 pages
Plexiglas G
No ratings yet
Plexiglas G
2 pages
ISAPI - Thermal
No ratings yet
ISAPI - Thermal
294 pages
Invoice FP25-009
No ratings yet
Invoice FP25-009
1 page
Sistema de Implantes TSX
No ratings yet
Sistema de Implantes TSX
32 pages
Social Emotional Learning Self-Regulation. Education Presentation Colorful Illustrative Style
No ratings yet
Social Emotional Learning Self-Regulation. Education Presentation Colorful Illustrative Style
23 pages
Project 2
No ratings yet
Project 2
3 pages
Fishing Conflict PDF
No ratings yet
Fishing Conflict PDF
197 pages
Brembo - P 50 067
No ratings yet
Brembo - P 50 067
4 pages
Economy of Eswatini
No ratings yet
Economy of Eswatini
7 pages
Ifrs 7 Financial Instruments Disclosures
No ratings yet
Ifrs 7 Financial Instruments Disclosures
70 pages
Free Trade Challenges To Indian Small Farmer
No ratings yet
Free Trade Challenges To Indian Small Farmer
30 pages
Choice, Transparency, Coordination, and Quality Among Direct-to-Consumer Telemedicine Websites and Apps Treating Skin Disease
No ratings yet
Choice, Transparency, Coordination, and Quality Among Direct-to-Consumer Telemedicine Websites and Apps Treating Skin Disease
8 pages
ISSN 1411 - 5247 Perancangan Produk Tempat Tisu Multifungsi Dengan Menggunakan Quality Function Deployment (QFD)
No ratings yet
ISSN 1411 - 5247 Perancangan Produk Tempat Tisu Multifungsi Dengan Menggunakan Quality Function Deployment (QFD)
9 pages
Cooperative Rural Bank V Ferrer-Calleja PDF
No ratings yet
Cooperative Rural Bank V Ferrer-Calleja PDF
5 pages
Anhvan12chuongtrinhglobalsuccess Thionlineunit9 Careerpaths
No ratings yet
Anhvan12chuongtrinhglobalsuccess Thionlineunit9 Careerpaths
3 pages
OD226071921943274000
No ratings yet
OD226071921943274000
1 page
Topacio v. Ong, G.R. No. 179895, December 18, 2008
No ratings yet
Topacio v. Ong, G.R. No. 179895, December 18, 2008
13 pages
HR Analytics at ScaleneWorks - Behavioral Modeling To Predict Renege IMB551
No ratings yet
HR Analytics at ScaleneWorks - Behavioral Modeling To Predict Renege IMB551
12 pages
Se Bits Unit Bit 5
No ratings yet
Se Bits Unit Bit 5
5 pages
Why Use MPC Based Contact For - Bonded - Connections
No ratings yet
Why Use MPC Based Contact For - Bonded - Connections
5 pages
Hardness Test
100% (1)
Hardness Test
8 pages
Nghi Son Refinery And Petrochemical Llc: Công Ty Tnhh Lọc Hóa Dầu Nghi Sơn
No ratings yet
Nghi Son Refinery And Petrochemical Llc: Công Ty Tnhh Lọc Hóa Dầu Nghi Sơn
1 page
Problem-Set Humidification
No ratings yet
Problem-Set Humidification
2 pages
The Art of Mac Malware, Volume 1: The Guide to Analyzing Malicious Software
From Everand
The Art of Mac Malware, Volume 1: The Guide to Analyzing Malicious Software
Patrick Wardle
4/5 (1)
IDS and IPS with Snort 3: Get up and running with Snort 3 and discover effective solutions to your security issues
From Everand
IDS and IPS with Snort 3: Get up and running with Snort 3 and discover effective solutions to your security issues
Ashley Thomas
No ratings yet
CISM Certified Information Security Manager Study Guide
From Everand
CISM Certified Information Security Manager Study Guide
Mike Chapple
4/5 (1)
Logstash Essentials: Definitive Reference for Developers and Engineers
From Everand
Logstash Essentials: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
ESP8266 Programming and Applications: Definitive Reference for Developers and Engineers
From Everand
ESP8266 Programming and Applications: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Tealium Integration and Implementation Guide: Definitive Reference for Developers and Engineers
From Everand
Tealium Integration and Implementation Guide: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Micropython Essentials: Definitive Reference for Developers and Engineers
From Everand
Micropython Essentials: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
NIST Cybersecurity Framework (CSF) For Information Systems Security: NIST Cybersecurity Framework (CSF), #1
From Everand
NIST Cybersecurity Framework (CSF) For Information Systems Security: NIST Cybersecurity Framework (CSF), #1
Bruce Brown, CISSP
No ratings yet
Backtrader Essentials: Building Successful Strategies with Python
From Everand
Backtrader Essentials: Building Successful Strategies with Python
Ali AZARY
No ratings yet
Wireless Security Architecture: Designing and Maintaining Secure Wireless for Enterprise
From Everand
Wireless Security Architecture: Designing and Maintaining Secure Wireless for Enterprise
Jennifer Minella
No ratings yet
Study Guide Cisco 300-735 SAUTO Automating and Programming Cisco Security Solutions Exam
From Everand
Study Guide Cisco 300-735 SAUTO Automating and Programming Cisco Security Solutions Exam
Anand Vemula
No ratings yet
Learning AirWatch
From Everand
Learning AirWatch
Mark Dunkerley
5/5 (1)
Tasmota Integration and Configuration Guide: Definitive Reference for Developers and Engineers
From Everand
Tasmota Integration and Configuration Guide: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
FineReport System Design and Implementation: Definitive Reference for Developers and Engineers
From Everand
FineReport System Design and Implementation: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
MSP360 Solutions and Administration: Definitive Reference for Developers and Engineers
From Everand
MSP360 Solutions and Administration: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Streamlit Development Essentials: Definitive Reference for Developers and Engineers
From Everand
Streamlit Development Essentials: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Fortify Security Analysis Essentials: Definitive Reference for Developers and Engineers
From Everand
Fortify Security Analysis Essentials: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Mastering Python Network Automation: Automating Container Orchestration, Configuration, and Networking with Terraform, Calico, HAProxy, and Istio
From Everand
Mastering Python Network Automation: Automating Container Orchestration, Configuration, and Networking with Terraform, Calico, HAProxy, and Istio
Tim Peters
No ratings yet
Observium Network Monitoring Solutions: Definitive Reference for Developers and Engineers
From Everand
Observium Network Monitoring Solutions: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Operational Monitoring with Datadog: Definitive Reference for Developers and Engineers
From Everand
Operational Monitoring with Datadog: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Configuring Smart Devices with ESPHome: Definitive Reference for Developers and Engineers
From Everand
Configuring Smart Devices with ESPHome: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Rollbar Implementation and Best Practices: Definitive Reference for Developers and Engineers
From Everand
Rollbar Implementation and Best Practices: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
(ISC)2 Certified Cloud Security Professional CCSP Realistic Practice Tests
From Everand
(ISC)2 Certified Cloud Security Professional CCSP Realistic Practice Tests
CertSquad Professional Trainers
No ratings yet
DataDog Operations and Monitoring Guide: Definitive Reference for Developers and Engineers
From Everand
DataDog Operations and Monitoring Guide: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Learn Penetration Testing with Python 3.x: Perform Offensive Pentesting and Prepare Red Teaming to Prevent Network Attacks and Web Vulnerabilities (English Edition)
From Everand
Learn Penetration Testing with Python 3.x: Perform Offensive Pentesting and Prepare Red Teaming to Prevent Network Attacks and Web Vulnerabilities (English Edition)
Yehia Elghaly
5/5 (1)
STM32 Embedded Systems Design: Definitive Reference for Developers and Engineers
From Everand
STM32 Embedded Systems Design: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Rekognition Programming Guide: Definitive Reference for Developers and Engineers
From Everand
Rekognition Programming Guide: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
BIRT Technical Reference: Definitive Reference for Developers and Engineers
From Everand
BIRT Technical Reference: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Hacking Connected Cars: Tactics, Techniques, and Procedures
From Everand
Hacking Connected Cars: Tactics, Techniques, and Procedures
Alissa Knight
No ratings yet
SteamOS Deployment and Configuration: Definitive Reference for Developers and Engineers
From Everand
SteamOS Deployment and Configuration: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Netdata in Practice: Definitive Reference for Developers and Engineers
From Everand
Netdata in Practice: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Veracode Essentials: Definitive Reference for Developers and Engineers
From Everand
Veracode Essentials: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Intelligence at the Edge: Using SAS with the Internet of Things
From Everand
Intelligence at the Edge: Using SAS with the Internet of Things
CSPtrade2
No ratings yet
Comprehensive Guide to Micro:bit Technology: Definitive Reference for Developers and Engineers
From Everand
Comprehensive Guide to Micro:bit Technology: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
BeagleBone Systems and Applications: Definitive Reference for Developers and Engineers
From Everand
BeagleBone Systems and Applications: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Programming NodeMCU for IoT Applications: Definitive Reference for Developers and Engineers
From Everand
Programming NodeMCU for IoT Applications: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
CISSP - Certified Information Systems Security Professional Exam Preparation Study Guide
From Everand
CISSP - Certified Information Systems Security Professional Exam Preparation Study Guide
Georgio Daccache
5/5 (1)
Mastering Zabbix - Second Edition
From Everand
Mastering Zabbix - Second Edition
Vacche Andrea Dalle
No ratings yet
Effective Dynatrace Deployment and Operations: Definitive Reference for Developers and Engineers
From Everand
Effective Dynatrace Deployment and Operations: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Study Guide: Cisco AppDynamics Professional Implementer
From Everand
Study Guide: Cisco AppDynamics Professional Implementer
Anand Vemula
No ratings yet
PIC Microcontroller Development Essentials: Definitive Reference for Developers and Engineers
From Everand
PIC Microcontroller Development Essentials: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
ESP32 Development and Applications: Definitive Reference for Developers and Engineers
From Everand
ESP32 Development and Applications: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Jetson Platform Development Guide: Definitive Reference for Developers and Engineers
From Everand
Jetson Platform Development Guide: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Learning RSLogix 5000 Programming
From Everand
Learning RSLogix 5000 Programming
Austin Scott
4.5/5 (2)
Comprehensive Guide to BusinessObjects: Definitive Reference for Developers and Engineers
From Everand
Comprehensive Guide to BusinessObjects: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Study Guide Cisco AppDynamics Professional Implementer (500-430 CAPI)
From Everand
Study Guide Cisco AppDynamics Professional Implementer (500-430 CAPI)
Anand Vemula
No ratings yet
CircuitPython in Practice: Definitive Reference for Developers and Engineers
From Everand
CircuitPython in Practice: Definitive Reference for Developers and Engineers
Richard Johnson
No ratings yet
Research And Development Of A Secure Mobile Software Ridesharing Application For United States Military And Department Of Defense Employees
From Everand
Research And Development Of A Secure Mobile Software Ridesharing Application For United States Military And Department Of Defense Employees
Colton Goodier
No ratings yet
JAVA PROGRAMMING FOR BEGINNERS: Master Java Fundamentals and Build Your Own Applications (2023 Crash Course)
From Everand
JAVA PROGRAMMING FOR BEGINNERS: Master Java Fundamentals and Build Your Own Applications (2023 Crash Course)
Theo Houle
No ratings yet
Basic Setup of FortiGate Firewall
From Everand
Basic Setup of FortiGate Firewall
Dr. Hidaia Mahmood Alassoulii
No ratings yet
The Datadog Handbook: A Guide to Monitoring, Metrics, and Tracing
From Everand
The Datadog Handbook: A Guide to Monitoring, Metrics, and Tracing
Robert Johnson
No ratings yet
Framework for SCADA Cybersecurity
From Everand
Framework for SCADA Cybersecurity
Richard Clark
5/5 (1)
Operationalizing Information Security: Putting the Top 10 SIEM Best Practices to Work
From Everand
Operationalizing Information Security: Putting the Top 10 SIEM Best Practices to Work
Scott Gordon
No ratings yet
SRS - How to build a Pen Test and Hacking Platform
From Everand
SRS - How to build a Pen Test and Hacking Platform
alasdair gilchrist
2/5 (1)