How does the ISAPI protocol aid in managing various access control elements?

The ISAPI protocol provides a structured framework for managing access control elements such as card credentials, QR codes, and person information. Through specific API calls, administrators can configure device capabilities, manage user credentials, and organize authentication processes. It supports various configurations like setting up anti-passback rules, handling card operations, and enabling multifactor authentication, making it a comprehensive tool for secure and flexible access control management .

Why is it important for a listening host to correctly configure and test its settings before enabling event reception?

Correct configuration and testing of a listening host are essential to ensure that it can properly receive and process event information from devices. This involves configuring appropriate parameters (security settings, host IDs), testing connectivity, and verifying the system's ability to handle the specific event formats and data (text or binary) that will be transmitted. Pre-testing helps in avoiding data loss, event misinterpretation, and system failures during critical moments .

In the context of network-based device management, how important is compatibility when configuring peripheral devices?

Compatibility is of utmost importance in network-based device management when configuring peripheral devices. It ensures that the devices can communicate effectively with the main system, share resources, and function as intended within the broader network infrastructure. Issues like mismatched protocol versions, unsupported modes, or incompatible data types can lead to reduced functionality or device failure. Therefore, verifying support for key functions like event notification and device communication through capabilities APIs is critical .

Why is it crucial for event systems to have well-defined event message parsers?

Having well-defined event message parsers is crucial in event systems to accurately interpret various data formats like XML and JSON, depending on the 'Content-Type' field. This clarity ensures that the system can effectively process, respond to, and act upon event messages in real-time, without errors that might arise from incorrect data interpretation. This is particularly important in environments where immediate response to events, such as security breaches, is critical .

How does the process of subscribing to event notifications work according to the provided sources?

The process of subscribing to event notifications starts with a client sending a subscription request to the device using POST /ISAPI/Event/notification/subscribeEvent. The device responds with an acknowledgment, establishing an arming connection through which it continuously sends event messages in a multipart/form-data format. Each message includes data units separated by a boundary, consisting of headers and bodies . If the arming link is not terminated properly, the client must manage the connection by monitoring heartbeats and errors .

What are the roles of Content-Type and boundary in HTTP multipart form-data requests?

In HTTP multipart form-data requests, 'Content-Type' specifies that the message is formatted as form-data, indicating that the data is divided into parts. The 'boundary' is a delimiter used to separate each part within the HTTP body, ensuring that the different units of data are clearly demarcated .

How can a device efficiently manage its resources during periods of low activity in an event monitoring system?

A device can manage its resources efficiently by minimizing active connections and prioritizing key alerts during low activity periods. Implementing a system that suspends unnecessary operations and ensures that only critical events trigger alerts can significantly enhance resource allocation. Utilizing smart configurations, such as non-anti-passback time periods and scheduling configurations, allows the system to balance its load and focus on necessary operations, reducing power and data usage when traffic is low .

What are the key steps in configuring a multi-factor authentication (MFA) system using API protocols?

The key steps in configuring an MFA system using API protocols include: verifying that the device supports MFA capabilities (e.g., isSupportMultiCardCfg), setting up necessary authentication parameters such as group configurations, and defining the authentication methods and order. Following this, users are added to groups with the required credentials, and the MFA mode is activated through the applicable APIs . Continuous management involves monitoring and adjusting parameters as necessary to maintain security .

What precautions should be taken when terminating an arming subscription in the event notification system?

When terminating an arming subscription, it is important to ensure that the connection is properly closed. Although calling PUT /ISAPI/Event/notification/unSubscribeEvent is optional, it is recommended to avoid leaving open connections that might strain resources. The termination process can be simplified by directly closing the connection without using the API, but care must be taken to monitor any missed events during brief disconnects .

What considerations are involved in implementing a QR code-based access control system?

Implementing a QR code-based access control system involves several considerations: evaluating device capabilities for QR code encryption and generation, configuring encryption parameters and testing compatibility, ensuring secure transmission of QR code data, and supporting device and user interfaces for QR code scanning and validation. Additionally, integrating with the existing access control framework, managing permissions, and synchronizing with mobile devices for QR generation and use are crucial for a seamless operation .

Open navigation menu

Upload

0% found this document useful (0 votes)

370 views995 pages

Face Recognition Dev Guide Clean

Uploaded by

Ajimenez.confremarca

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)

370 views995 pages

Face Recognition Dev Guide Clean

Uploaded by

Ajimenez.confremarca

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

Aj

im
Co en
ng ez
el .c
ad on
os fr
y ema
Fr rc
es a@
co gr
s up
Ma oc
ri on
no fr
s, em
C. arc
A a.
co
m
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.

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
1 Reading Guide
Chapter Description
Includes the ISAPI overview, applicable products, terms and definitions, abbreviations, and update
Overview
history.
ISAPI
Read the chapter to take a quick look at the ISAPI framework and basic functions.
Framework

m
Quick Start Read the chapter to quickly understand the programming process of basic functions such as

co
Guide authentication, message parsing, real-time live view, playback, and event uploading.

a.
API
Start programming according to API definitions.

C. arc
Reference

s, em
2 Overview

A
no fr
2.1 Introduction

ri on
Intelligent Security API (hereinafter referred to as ISAPI) is an application layer protocol based on HTTP (Hypertext

Ma oc
Transfer Protocol) and adopts the REST (Representational State Transfer) architecture for communication between
up
security devices (cameras, DVRs, NVRs, etc.) and the platform or client software.
Since established in 2013, ISAPI has included more than 11,000 APIs for different functions, including device
co gr

management, vehicle recognition, parking lot management, intelligent facial application, access control management,
es a@

interrogation management, and recording management. It is applicable to industries such as traffic, fire protection,
education, and security inspection.
Fr rc

2.1.1 Application Scenario

y ema

When you integrate devices via ISAPI, the device acts as the server to listen on the fixed port and the user's application
os fr

acts as the client to actively log in to the device for communication. To achieve the above goals, the device should be
configured with a fixed IP address and the requests from the client can reach the server.
ad on
el .c
ez
en
im
ng
Aj
Co

2.1.2 Layers in the Network Model

ISAPI is an application layer protocol based on HTTP, thereby it inherits all specifications and properties from HTTP.
Protocols frequently used along with ISAPI include SADP (Search Active Device Protocol) based on multicast for
discovering and activating devices, RTSP (Real-Time Streaming Protocol) based on TCP/UDP for live view and video
playback of devices, etc.

m
co
a.
C. arc
s, em
A
2.2 Product Scope

no fr
Face Recognition Terminals

ri on
Pro Series

Ma oc
DS-K1T607, DS-K1T607E, DS-K1T642, DS-K1T642E, DS-K1T642EF, DS-K1T642EFW, DS-K1T642EW, DS-
up
K1T642M, DS-K1T642MF, DS-K1T642MFW, DS-K1T642MW, DS-K1T643MWX-T, DS-K1T643MX-T, DS-
co gr

K1T670MFWX, DS-K1T670MWX-QR, DS-K1T670MX, DS-K1T670MX-QR, DS-K1T671, DS-K1T671AM, DS-

K1T671BM, DS-K1T671BMF, DS-K1T671BMFW, DS-K1T671BMW, DS-K1T671M, DS-K1T671MF, DS-
es a@

K1T673DWX, DS-K1T673DX, DS-K1T6Q-F71M, DS-K1T6QT-F72DWX, DS-K1T6QT-F72DX, DS-K1TA70MI-T

Fr rc

2.3 Terms And Definitions

y ema

2.3.3 Event
os fr

It refers to the information uploaded by the device. The event is uploaded by the device in real time for the immediate
ad on

response from the client or the platform. If the device is offline, the event will be stored in the cache first and then it will
be uploaded again when the connection is restored.
el .c

2.3.2 Arming
ez

Arming means that the client establishes connection with the device so that events can be uploaded to the client via the
en

connection. The client can subscribe to some event types, and the device will upload the specified events only,
im

otherwise the device will upload all types of events to the client.
ng
Aj

2.3.4 Listen
Co

After the platform starts listening service, when an event occurs, the event information will be sent to the listening port
of the platform based on the IP address and port No., then the connection will be closed.

2.3.5 Listening Host

The listening host service can be enabled to receive the event information from devices.

2.3.6 Center
A group of independent services, including at least one device access service and one or multiple application platforms.

2.3.7 Push Mode

In push mode, the device actively sends related information to the center.
2.3.8 Pull Mode
In pull mode, the center actively accesses the device to obtained related information.

2.3.20 Person-Based Access Control

The person ID is the unique identifier for person management. A person ID is linked to a person’s credentials (card,
fingerprint, and face picture) and permissions.

2.3.21 Access Permission

m
Users can set who can open which doors at what time. The access permission contains information about the person,

co
time, and door.

a.
2.3.11 Credential Type

C. arc
Credentials are the data which are used for recognizing specific persons. Cards, fingerprints, and face pictures can be
the credentials and linked to the specified persons. When the device detects the credential, it can recognize the person

s, em
whom the credential links to via the comparison algorithm.

A
no fr
2.3.12 Person Type

ri on
Persons can be divided into normal persons, visitors, and blocklist persons according to different areas. In the access
control system, normal persons have permanent permissions to access the specified areas, visitors have temporary

Ma oc
permissions to access the specified areas, and blocklist persons do not have the permissions to access the specified
up
areas.
co gr

2.3.13 Group
es a@

A group of persons which is used in multi-factor authentication. The same person can belong to different groups at the
same time. Up to 4 groups can be added at the same time.
Fr rc

s
y ema

2.3.14 Multi-Factor Authentication

Persons in the group can only open the door by the configured authentication rule, such as swiping card, authenticated
os fr

by fingerprint, face picture, or iris.

ad on

2.3.17 Remote Verification

el .c

The platform verifies the event uploaded by the device and applies the verification result to the device for controlling
the door after completing verification.
ez
en

2.3.22 Device ID
The device ID of the location of room. It is an 11-digit number contains the phase No., building No., unit No., floor No.,
im

serial No. and Community No. It is a unique ID of the device for calling and receiving.
ng
Aj
Co

2.3.23 New Device ID

The new device ID differs from device ID in other industry. It is a 16-digit number contains the industry, device type,
version, and device ID. Format: industry # device type # version # device ID. Devices will send and receive the new
device IDs in call signaling interaction.

2.4 Symbols And Acronyms

admin: administrator
HC: Connect Mobile Client
HPP: Partner Pro
ISAPI: Intelligent Security API.
ISUP: Intelligent Security Uplink Protocol.
HTTP: Hypertext Transfer Protocol
CMS: Central Management Server.
AMS: Alarm Management Server.
OSD: On-screen display
FDLib: Face Picture Library
FDID: Face Picture Library ID
PID: Face Picture ID in the Face Picture Library
RTSP: Real-Time Streaming Protocol.

m
co
SDP: Session Description Protocol.

a.
ACS: Access Control System. The access control system controls the entrance and exit channels. The system consists of
card readers, access controllers, electric locks, exit buttons, cards, application software, etc.

C. arc
None.
APK: Android Application Package

s, em
HEOP: Embedded Open Platform

A
no fr
HiCore: Core Applications

ri on
2.5 Update History
No update record
Ma oc
up
3 ISAPI Framework
co gr
es a@

3.1 Overview
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im

Notes:
ng
Aj

In general, ISAPI refers to the communication protocol based on the HTTP standard. As ISAPI is usually used along with
Co

RTSP (Real-Time Streaming Protocol), the RTSP standard is brought into the ISAPI system.
The metadata scheme for transmitting additional information of the stream is extended based on the RTSP standard to
transmit the video stream and the structured intelligent information of the stream simultaneously. It is compatible with
the RTSP standard.

3.2 Activation
The purpose of activation is to ensure that the user can set the password for the device and the password meets the
security requirement. After the device is activated, you can use the related functions.
ISAPI is a communication protocol running on the application layer. When activating the device via ISAPI, you should
know the device's IP address and make sure that the device is connected to the client.
The web application built in the device supports activating the device via ISAPI. When you enter the device's IP address
in the address bar of the web browser on the PC, you can activate the device according to the activation guide.
If you want to activate the device on your own application, you need to integrate the activation function via ISAPI. The
API calling flow and related APIs are shown below.

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema

Firstly, two operations are defined:

bytesToHexstring: it is used to convert a byte array (the length is N) to a hexadecimal string (the length is 2N). For
os fr

example, 127,10,23 -> 7f0a17

hexStringToBytes: it is used to convert a hexadecimal string (the length is 2N) to a byte array (the length is N). For
ad on

example, 7f0a17 -> 127,10,23

el .c

1. The client generates a public and private key pair (1024 bits), and gets the 128-byte modulus in the public key
ez

(hereinafter referred to as public key modulus). If the length is longer than 128, the leading 0 needs to be removed.
2. The client converts the public key modulus to a 256-byte public key string via bytesToHexstring and sends the
en

public key string to the device in XML message (related URI: POST /ISAPI/Security/challenge ) after being
im

encoded by Base64.
ng

3. The device parses the request to obtain a 256-byte public key string decoded by Base64 and converts it to a 128-
Aj

byte public key modulus via hexStringToBytes. The complete public key is the combination of obtained public key
Co

modulus and public exponent (the default value is '010001' ).

4. The device generates a 32-byte hexadecimal random string, calls the RSA API to encrypt the random string with
the private key, converts the encrypted data to a string via bytesToHexstring, encodes the string by Base64, and
then sends it to the client.
5. The client decodes the string from the device by Base64, converts it via hexStringToBytes to get the encrypted data,
decrypts the encrypted data with the private key via RSA to obtain a 32-byte hexadecimal random string, converts
the obtained string via hexStringToBytes to get a 16-byte AES key. Then the client uses the AES key to encrypt the
"string consisting of the first 16 characters of the random string and the real password" by AES128
ECB mode (with zero-padding method) to get a ciphertext, and converts the ciphertext via bytesToHexstring,
encodes it by Base64, and sends it to the device in XML message (related URI: PUT /ISAPI/System/activate ).
Note: If the first 16 characters of the random string are aaaabbbbccccdddd and the real password is Abc12345 , the
data before encryption is aaaabbbbccccddddAbc12345 . This can ensure that the client uses the random string as the
key for encryption.
6. The device decodes the string by Base64, converts it via hexStringToBytes to get the ciphertext, uses the AES key to
decrypt the ciphertext by AES128 ECB mode, and gets the real password via removing the first 16 characters.
7. The device verifies the password and returns the activation result.
Notes:
You can get the device's activation status by calling the URI GET /SDK/activateStatus which requires no
authentication.
Devices also support to be activated via SADP (Search Active Device Protocol) which is based on the
communication protocol of the data link layer. With SADP, you do not have to know the IP address of the device

m
but need to ensure that the device and the application running SADP are connected to the same router. SADP also

co
supports discovering devices in the LAN, changing the password of the devices, and so on. The HCSadpSDK is

a.
provided for SADP integration, including the developer guide, plug-in, and sample demo which can be used as a
simple SADP tool.

C. arc
3.3 Security Mechanism

s, em
A
3.3.1 Authentication

no fr
When the client applications send requests to devices, they need to use digest authentication (see details in RFC 7616)

ri on
for identity authentication.

Ma oc
Currently, all mainstream request class libraries of HTTP have encapsulated digest authentication. See details in
Authentication of Quick Start Guide.
up
3.3.2 User Permission
co gr

There are three kinds of users with different permissions for access control and management.
es a@

Administrator: Has the permission to access all supported resources and should keep activated all the time. It is also
Fr rc

known as "admin".
y ema

Operator: Has the permission to access general resources and a part of advanced resources.
Normal User: Only has the permission to access general resources.
os fr

3.3.3 Information Encryption

ad on

During ISAPI integration, the HTTPS service of devices is enabled by default. When the client applications communicate
el .c

with devices via HTTPS, the information can be transmitted securely.

3.4 Video Streaming

3.4.1 Audio and Video Stream

ISAPI supports getting and setting stream media parameters of the device, such as video resolution, encoding format,
ng
Aj

and stream.
Co

Cameras support standard RTSP (Real-Time Streaming Protocol, see details in RFC 7826). Client applications can get
the stream from devices via RTSP.
For details about real-time streaming and video playback, refer to Real-Time Live View and Playback in Quick Start
Guide.

3.4.2 Metadata
The metadata is the structured intelligent information generated by intelligent devices. When the client applications get
the audio and/or video stream from devices via RTSP, the metadata will be returned by the device at the same time. For
example, to display the face target frame, face information, vehicle target frame, license plate number, vehicle
information, and other information on the video stream, the client applications can overlay the above information on
the video image.
Before using the metadata, you need to enable the metadata function of the device and then get the stream from the
device via RTSP. Some devices support subscribing to the metadata by type. For details about the process of integrating
the metadata function, refer to Metadata Management.

4 Quick Start Guide

4.1 Authentication
When the client applications send requests to the devices, they need to use digest authentication (see details in RFC

m
7616) for identity authentication.

co
Client applications only need to call APIs of the class library to implement the digest authentication. The sample code is

a.
shown below.

C. arc
4.1.1 C/C++ (libcurl)

s, em
// #include <curl/curl.h>

A
// Callback Function

no fr
static size_t OnWriteData(void* buffer, size_t size, size_t nmemb, void* lpVoid)
{
std::string* str = dynamic_cast<std::string*>((std::string *)lpVoid);

ri on
if( NULL == str || NULL == buffer )
{
return -1;

Ma oc
} up
char* pData = (char*)buffer;
str->append(pData, size * nmemb);
return nmemb;
co gr

std::string strUrl = "http://192.168.18.84:80/ISAPI/System/deviceInfo";

es a@

std::string strResponseData;
CURL *pCurlHandle = curl_easy_init();
curl_easy_setopt(pCurlHandle, CURLOPT_CUSTOMREQUEST, "GET");
Fr rc

curl_easy_setopt(pCurlHandle, CURLOPT_URL, strUrl.c_str());

// Set the user name and password
y ema

curl_easy_setopt(pCurlHandle, CURLOPT_USERPWD, "admin:admin12345");

// Set the authentication method to the digest authentication
curl_easy_setopt(pCurlHandle, CURLOPT_HTTPAUTH, CURLAUTH_DIGEST);
// Set the callback function
os fr

curl_easy_setopt(pCurlHandle, CURLOPT_WRITEFUNCTION, OnWriteData);

// Set the parameters of the callback function to get the returned information
curl_easy_setopt(pCurlHandle, CURLOPT_WRITEDATA, &strResponseData);
ad on

// Timeout settings for receiving the data. If receiving data is not completed within 5 seconds, the application will exit directly
curl_easy_setopt(pCurlHandle, CURLOPT_TIMEOUT, 5);
// Set the redirection times to avoid too many redirections
el .c

curl_easy_setopt(pCurlHandle, CURLOPT_MAXREDIRS, 1);

// Connection timeout duration. If the duration is too short, the client application will be disconnected before the data request sent by the application
ez

reaches the device

curl_easy_setopt(pCurlHandle, CURLOPT_CONNECTTIMEOUT, 5);
CURLcode nRet = curl_easy_perform(pCurlHandle);
en

if (0 == nRet)
{
// Output the received message
im

std::cout << strResponseData << std::endl;

}
ng
Aj

curl_easy_cleanup(pCurlHandle);
Co

4.1.2 C# (WebClient)
// using System.Net;
// using System.Net.Security;
try
{
string strUrl = "http://192.168.18.84:80/ISAPI/System/deviceInfo";
WebClient client = new WebClient();
// Set the user name and password
client.Credentials = new NetworkCredential("admin", "admin12345");
byte[] responseData = client.DownloadData(strUrl);
string strResponseData = Encoding.UTF8.GetString(responseData);
// Output received information
Console.WriteLine(strResponseData);
}
catch (Exception ex)

m
{
Console.WriteLine(ex.Message);

co
}

a.
4.1.3 Java (HttpClient)

C. arc
// import org.apache.commons.httpclient.HttpClient;

s, em
String url = "http://192.168.18.84:80/ISAPI/System/deviceInfo";
HttpClient client = new HttpClient();

A
// Set the user name and password

no fr
UsernamePasswordCredentials creds = new UsernamePasswordCredentials("admin", "admin12345");
client.getState().setCredentials(AuthScope.ANY, creds);
GetMethod method = new GetMethod(url);

ri on
method.setDoAuthentication(true);
int statusCode = client.executeMethod(method);

Ma oc
byte[] responseData = method.getResponseBodyAsString().getBytes(method.getResponseCharSet());
String strResponseData = new String(responseData, "utf-8");
method.releaseConnection();
up
// Output received information
System.out.println(strResponseData);
co gr
es a@

4.1.4 Python (requests)

Fr rc

# - - coding: utf-8 --

y ema

import requests
request_url = 'http://192.168.18.84:80/ISAPI/System/deviceInfo'
# Set the authentication information
auth = requests.auth.HTTPDigestAuth('admin', 'admin12345')
os fr

# Send the request and receive response

response = requests.get(request_url, auth=auth)
# Output response content
ad on

print(response.text)
el .c

4.2 Message Parsing

ez
en

4.2.1 Message Format

During the process of communication and interaction via ISAPI, the request and response messages are often text data
ng

in XML or JSON format. Besides that, the data of firmware packages and configuration files is in binary format. A
Aj

request can also be in form format with multiple formats of data (multipart/form-data).
Co

4.2.1.1 XML
Generally, the Content-Type in the headers of the HTTP request is application/xml; charset="UTF-8" .
Request and response messages in XML format are all encoded with UTF-8 standards in ISAPI.
The namespace http://www.isapi.org/ver20/XMLSchema and ISAPI version number 2.0 of XML messages are
configured by default, see the example below.
<?xml version="1.0" encoding="UTF-8"?>
<NodeList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<Node>
<id>1</id>
<enabled>true</enabled>
<nodeName>nodeName</nodeName>
<level>level1</level>
</Node>
</NodeList>

4.2.1.2 JSON

m
The Content-Type in the headers of the HTTP request is often application/json .

co
To distinguish between APIs with XML messages and those with JSON messages, ISAPI adds the query parameter

a.
format=json to all request URLs with JSON messages, e.g.,
http://192.168.1.1:80/ISAPI/System/Sensor/thermometrySensor?format=json . Messages of request URLs without

C. arc
the query parameter format=json are usually in XML format. However, there may be some exceptions, and the message
format is subject to the API definition.

s, em
Request and response messages in JSON format are all encoded by UTF-8 in ISAPI.

A
no fr
4.2.1.3 Binary Data

ri on
For the firmware and configuration files, the Content-Type in the header of an HTTP request is often

Ma oc
application/octet-stream . up
4.2.1.4 Form (multipart/form-data)
co gr

When multiple pieces of data are submitted at the same time in an ISAPI request (e.g., the person information and face
picture need to be submitted at the same time when a face record is added to the face picture library), the Content-
es a@

Type in the header of the corresponding HTTP request is usually multipart/form-data, boundary=AaB03x , where the
boundary is a variable used to separate the entire HTTP body into multiple units and each unit is a piece of data with its
Fr rc

own headers and body. In Content-Disposition of form unit headers, the name property refers to the form unit name,
y ema

which is required for all form units; the filename property refers to the file name of form unit body, which is required
only when the form unit body is a file. In headers of form units, Content-Length refers to the body length, which starts
after CRLF( \r\n ) and ends before two hyphens ( -- ) of next form. There should be a CRLF used as the delimiter of two
os fr

form units before two hyphens ( -- ), and the Content-Length of previous form unit does not include the CRLF length.
ad on

For the detailed format description, refer to RFC 1867 (Form-Based File Upload in HTML). Pay attention to two hyphens
( -- ) before and after the boundary.
el .c

Notes
ez

In RFC specifications, it is strongly recommended to contain the field Content-Length in the entity header, and
en

there is no requirement that the field Content-Length should be contained in the header of each form element.
The absence of field Content-Length in the header should be considered when the client and device programs
im

parse the form data.

ng
Aj

To avoid the conflict between message content and boundary value, it is recommended to use a longer and more
Co

complex string as the boundary value.

The example of ISAPI form data submitted by a client to a device is as follows.
POST /ISAPI/Intelligent/FDLib/pictureUpload
Content-Type: multipart/form-data; boundary=e5c2f8c5461142aea117791dade6414d
Content-Length: 56789

--e5c2f8c5461142aea117791dade6414d
Content-Disposition: form-data; name="PictureUploadData";
Content-Type: application/xml
Content-Length: 1234

<PictureUploadData/>
--e5c2f8c5461142aea117791dade6414d
Content-Disposition: form-data; name="face_picture"; filename="face_picture.jpg";
Content-Type: image/jpeg
Content-Length: 34567

m
Picture Data

co
--e5c2f8c5461142aea117791dade6414d--

a.
The example of ISAPI form data responded from a device to a client is as follows.

C. arc
In ISAPI messages, when there are multiple form units, three nodes ( pid , contentid , and filename ) are used for linking
form units. The corresponding relations are as follows:

s, em
Node Form

A
Description

no fr
Name Field

ri on
pid in XML/JSON messages corresponds to the name property of Content-Disposition in
pid name
form headers.
Content-
Ma oc
up
contentid contentid in XML/JSON messages corresponds to Content-ID in form headers.
ID
co gr

filename in XML/JSON messages corresponds to filename property of Content-Disposition in

filename filename
form headers.
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
HTTP/1.1 200 OK
Content-Type: multipart/form-data; boundary=136a73438ecc4618834b999409d05bb9
Content-Length: 56789

--136a73438ecc4618834b999409d05bb9
Content-Disposition: form-data; name="mixedTargetDetection";
Content-Type: application/json
Content-Length: 811

{
"ipAddress": "172.6.64.7",
"macAddress": "01:17:24:45:D9:F4",
"channelID": 1,
"dateTime": "2009-11-14T15:27+08:00",

m
"eventType": "mixedTargetDetection",
"eventDescription": "Mixed target detection",

co
"deviceID": "123456789",
"CaptureResult": [{

a.
"targetID": 1,
"Human": {
"Rect": {

C. arc
"height": 1.0,
"width": 1.0,
"x": 0.0,
"y": 0.0

s, em
},
"contentID1": "humanImage", /*human body thumbnail*/

A
"contentID2": "humanBackgroundImage", /*human body background picture*/

no fr
"pId1": "9d48a26f7b8b4f2390c16808f93f3534", /*human body thumbnail ID */
"pId2": "5EE7078E07BB47CF860DE8E4E9A85F28" /*ID of human body background picture*/
}

ri on
}]
}

Ma oc
--136a73438ecc4618834b999409d05bb9
Content-Disposition: form-data; name="9d48a26f7b8b4f2390c16808f93f3534"; filename="humanImage.jpg";
Content-Type: image/jpeg
up
Content-Length: 34567
Content-ID: humanImage
co gr

Picture Data
--136a73438ecc4618834b999409d05bb9
es a@

Content-Disposition: form-data; name="5EE7078E07BB47CF860DE8E4E9A85F28"; filename="humanBackgroundImage.jpg";

Content-Type: image/jpeg
Content-Length: 345678
Fr rc

Content-ID: humanBackgroundImage

Picture Data
y ema

--136a73438ecc4618834b999409d05bb9--
os fr

4.2.2 Annotation
ad on

The field descriptions of ISAPI request and response messages are marked as annotations in the example messages as
shown below.
el .c
ez

<?xml version="1.0" encoding="UTF-8"?>

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

<Node>
im

<id>
ng

1

</id>
<enabled>
Co

true

</enabled>
<nodeName>
test
</nodeName>
<level>
level1
</level>
</Node>
</NodeList>
{
"name": "test",
/*ro, req, string, name, range:[1,32]*/
"type": "type1",
/*ro, req, enum, type, subType:string, [type1#type 1,type2#type 2]*/
"enabled": true,
/*ro, opt, bool, enable or not, desc:xxxxxxx*/
"NodeList": {
/*opt, object, node list, dep:and,{$.enabled,eq,true}*/
"scene": 1,
/*req, enum, scene, subType:int, [1#scene 1; 2#scene 2; 3#scene 3]*/
"ID": 1
/*req, int, No., range:[1,8], step:, unit:, unitType:*/
}

m
}

co
Key annotations are shown in the table below.

a.
Annotation Description Remark

C. arc
Attribute: Read-
ro This field can only be obtained and cannot be edited.
Only

s, em
A
Attribute: Write-

no fr
wo This field can only be edited and cannot be obtained.
Only

ri on
Attribute: This field is required for request messages sent to the device and response
req

Ma oc
Required up messages returned from the device.
Attribute: This field is optional for request messages sent to the device and response
opt
Optional messages returned from the device.
co gr

Attribute:
es a@

dep This field is valid and required when specific conditions are satisfied.
Dependent
Fr rc

object Field Type: Object The field of type object contains multiple sub-fields.
y ema

list Field Type: List The subType following it refers to the data type of sub-items in the list.
The range following it refers to the maximum and the minimum string size of the
os fr

subType Field Type: String

field.
ad on

int Field Type: Int The range following it refers to the maximum and the minimum value of the field.
el .c

float Field Type: Float The range following it refers to the maximum and the minimum value of the field.
ez

Field Type:
bool The value can be true or false.
en

Boolean
im

Field Type: The subType following it indicates that the enumerators are of type string or int.
enum
ng

Enumeration The [] following the subType contains all enumerators.

Aj
Co

When the type of field is list or enum, the value of subType is the data type of each
subType Sub-Type of Field
sub-object.
desc Field Description The detailed description of the field.

4.2.3 Capability Set

ISAPI has designed capability sets for almost all functions, APIs, and fields. URLs for getting the capability set end with
/capabilities . Some URLs may contain query parameters in the format: /capabilities?format=json&type=xxx .
There are two types of fields in the capability message of ISAPI: whether the device supports a function and the value
range of a field in an API.
Whether the device supports a function: it is often in the format isSupportXxxxxxxx , which indicates that whether
the device supports a function and a set of APIs for implementing this function.
{
"isSupportMap": true,
/*ro, opt, bool, whether it supports the e-map function, desc:/ISAPI/SDT/Management/map/capabilities?format=json*/
"isSupportAlgTrainResourceInfo": true,
/*ro, opt, bool, whether it supports only getting the resource information of the algorithm training platform,
desc:/ISAPI/SDT/algorithmTraining/ResourceInfo?format=json*/
"isSupportAlgTrainAuthInfo": true,
/*ro, opt, bool, whether it supports ony getting the authorization information of the algorithm training platform,
desc:/ISAPI/SDT/algorithmTraining/SoftLock/AuthInfo?format=json*/
"isSupportAlgTrainNodeList": true,
/*ro, opt, bool, whether it supports only getting the node information of the algorithm training platform, desc:/ISAPI/SDT/algorithmTraining/NodeList?
format=json*/
"isSupportNAS": true
/*ro, opt, bool, whether it supports mounting and unmounting NAS, desc:/ISAPI/SDT/Management/NAS/capabilities?format=json*/

m
}

co
The value range of the field: the maximum value, minimum value, the maximum size, the minimum size, options,

a.
and so on of each field of the API.

C. arc
{
"boolType": {
/*req, object, example of the capability of type bool*/

s, em
"@opt": [true, false]

A
/*req, array, options, subType: bool*/

no fr
},
"integerType": {
/*req, object, example of the capability of type integer*/

ri on
"@min": 0,
/*ro, req, int, the minimum value*/
"@max": 100

Ma oc
/*ro, req, int, the maximum value*/
},
up
"stringType": {
/*req, object, example of the capability of type string*/
"@min": 0,
co gr

/ro, req, int, the minimum string size/

"@max": 32
/*ro, req, int, the maximum string size*/
es a@

},
"enumType": {
Fr rc

/req, object, capability example of type enum/

"@opt": ["enum1", "enum2", "enum3"]

/*req, array, options, subType: string*/
y ema

}
}
os fr

Note: For the same capability set, devices of different models and versions may return different results. The values
shown in this document are only examples for reference. The capability set actually returned by the device takes
ad on

precedence.
el .c

4.2.4 Time Format

ISAPI adopts ISO 8601 Standard Time Format, which is the same as W3C Standard Date and Time Formats.
en

Format: YYYY-MM-DDThh:mm:ss.sTZD
im
ng

YYYY = the year consisting of four decimal digits

MM = the month consisting of two decimal digits (01-January, 02-February, and so forth)
DD = the day consisting of two decimal digits (01 to 31)
Co

hh = the hour consisting of two decimal digits (00 to 23, a.m. and p.m. are not allowed)
mm = the minute consisting of two decimal digits (00 to 59)
ss = the second consisting of two decimal digits (00 to 59)
s = one or more digits representing the fractional part of a second
TZD = time zone identifier (Z or +hh:mm or -hh:mm)

Example: 2017-08-16T20:17:06.123+08:00 refers to 20:17:06.123 on August 16, 2017 (local time which is 8 hours
ahead of UTC). The plus sign (+) indicates that the local time is ahead of UTC, and the minus sign (-) means that the
local time is behind UTC.
After the DST is enabled, the local time and time difference will change compared with UTC, and the values of related
fields also need to be changed. Disabling the DST will bring into the opposite effect.
Example: In 1986, the DST was in effect from May 4 at 2:00 a.m. (GMT+8). During the DST period, the clocks were
moved one hour ahead, which means that there was one less hour on that day. When the DST ends at 2:00 a.m. on
September 14, 1986, the clocks were moved one hour back and there was an extra hour on that day. The changes of the
time are as follows:
DST Starts: 1986-05-04T02:00:00+08:00 --> 1986-05-04T03:00:00+09:00
DST Ends: 1986-09-14T02:00:00+09:00 --> 1986-09-14T01:00:00+08:00
Notes:

m
The time difference cannot be simply used to determine the time zone. Because when the DST starts, the time

co
difference will change and it cannot represent the actual time zone.

a.
Both TZ (UTC time, e.g., 1986-05-03T18:00:00Z) and TD (local time and time difference, e.g., 1986-05-
04T02:00:00+08:00) meet the time format standards of ISO 8601. In ISAPI, the TD format is recommended to be

C. arc
used in messages sent from the user applications and the devices.
A few old-version devices will return the time in TZ format. For representing the time difference information and

s, em
forward compatibility, an extra field timeDiff is added as shown in the example below. User applications need to

A
support both TD format and TZ format when parsing the time in the messages returned by devices.

no fr
ri on
{
"dateTime": "1986-05-03T18:00:00Z", /*device time. The value in TZ format is the UTC time and the value in TD format is the time difference between the
device's local time and UTC*/

Ma oc
"timeDiff": "+08:00" /*optional, time difference between the local time and UTC time. If this field does not exist, the user application will convert
the dateTime into the local time for use*/
up
}
co gr

4.2.5 Character Set

es a@

To prevent characters not commonly used from resulting in exceptions in device programs and user applications, ISAPI
Fr rc

limits the valid field values of type string to a specific range of characters. Character sets allowed to be used in the fields
s

of type string in ISAPI are listed below.

y ema

Single-byte character set: lowercase letters ( a-z ), uppercase letters ( A-Z ), digits ( 0-9 ), and special characters (see
details in the table below).
os fr

Multi-byte character set: language characters based on Unicode and encoded by UTF-8 (UTF-8 encoding is a
ad on

transformation format of Unicode character set. For details, refer to RFC 2044).
el .c
ez
en
im
ng
Aj
Co
No. Name Special Character No. Name Special Character
1 Open Parenthesis ( 18 Dollar Sign $
2 Close Parenthesis ) 19 Percent Sign %
3 Plus Sign + 20 Ampersand &
4 Comma , 21 Close Single Quotation Mark '
5 Minus Sign - 22 Asterisk *

m
6 Period . 23 Slash /

co
7 Semicolon ; 24 Smaller Than <

a.
8 Equal Sign = 25 Greater Than >

C. arc
9 At Sign @ 26 Question Mark ?

s, em
10 Open Square Bracket [ 27 Caret ^

A
no fr
11 Close Square Bracket ] 28 Open Single Quotation Mark '

ri on
12 Underscore _ 29 Vertical Bar |

Ma oc
13 Open Brace { 30 Tilde ~
up
14 Close Brace } 31 Double Quotation Marks "
co gr

15 Space 32 Colon :
es a@

16 Exclamation Mark ! 33 Backslash |

Fr rc

17 Octothorpe #
y ema

The valid characters that can be used in some special fields are listed below.
User name: lowercase letters ( a-z ), uppercase letters ( A-Z ), digits ( 0-9 ), and characters from No. 1 to No. 30 in the
os fr

special character table.

ad on

Password: User Name: lowercase letters ( a-z ), uppercase letters ( A-Z ), digits ( 0-9 ), and characters from No. 1 to
No. 33 in the special character table.
el .c

Names displayed on the UI (device name, person name, face picture library name, etc.): lowercase letters ( a-z ),
ez

uppercase letters ( A-Z ), digits ( 0-9 ), characters from No. 1 to No. 15 in the special character table, and multi-byte
characters.
en

Normal fields of type string support lowercase letters ( a-z ), uppercase letters ( A-Z ), digits ( 0-9 ), characters from
im

No. 1 to No. 15 in the special character table, and multi-byte characters by default.
ng
Aj

4.2.6 Error Processing

When requesting via ISAPI failed (the HTTP status code is not 200), the device will return the HTTP status code and
ISAPI error code. For HTTP status codes, refer to 10 Status Code Definitions in RFC 2616. For ISAPI error codes, refer to
Error Code Dictionary.
Message Example:
HTTP/1.1 403 Forbidden
Content-Type: application/json; charset="UTF-8"
Date: Thu, 15 Jul 2021 20:43:30 GMT
Content-Length: 229
Connection: Keep-Alive

{
"requestURL": "/ISAPI/Event/triggers/notifications/channels/whiteLightAlarm",
"statusCode": 4,
"statusString": "Invalid Operation",
"subStatusCode": "notSupport",
"errorCode": 1073741825,
"errorMsg": "notSupport"
}

m
co
4.3 Real-Time Live View

a.
C. arc
4.3.1 Introduction to the Function
Supports getting and setting stream media parameters of devices such as resolution, coding format, and stream type.

s, em
Supports streaming from products via RTSP (Real Time Streaming Protocol, see details in RFC 7826).

A
no fr
4.3.2 API Calling Flow

ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. A client sends RTSP DESCRIBE commands such as DESCRIBE /ISAPI/Streaming/channels/101 RTSP/1.0 . Digest
authentication with devices is required before this step.
2. The client parses the media SDP information returned by the device.
3. Set RTSP play parameters, that is to set the track ID parsed from SDP information via SETUP commands. For
example, trackID=1 indicates videos while trackID=2 indicates audios.
4. The client sends an RTSP PLAY command, and the device will send audio stream, video stream, and metadata in
the format of PLAY /ISAPI/Streaming/channels/101 RTSP/1.0 .
5. The client receives the RTP packet sent by the device. Divided RTP packets should be assembled on the client
before being parsed.
6. The client sends the command RTSP TEARDOWN to stop streaming.
Notes:

m
Digest authentication is required in RTSP playback. The method is the same as that of ISAPI digest authentication.

co
The address format for streaming from devices is rtsp:// <host>[:port]/ISAPI/Streaming/channels/<ID> , of

a.
which <host> is the device IP address; [:port] is optional, and 554 by default; <ID> is the device channel ID * 100
+ stream type (1-main stream, 2-sub-stream, 3-third stream). For example, the IP address of the target device is

C. arc
172.7.203.11 , and the streaming address of main stream for channel 17 will be
rtsp://172.7.203.11:554/ISAPI/Streaming/channels/1701 .

s, em
RTSP also supports containing user names and passwords in URL. The format is

A
rtsp://username:password@[address]:[port]/Streaming/Channels/[id](?parm1=value1&parm2-=value2…) ,

no fr
such as /Streaming/Channels/101?transportmode=unicast .

ri on
4.3.3 Example

Ma oc
1. A client sends an RTSP DESCRIBE command.
up
DESCRIBE rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101 RTSP/1.0
co gr

CSeq:0
Accept:application/sdp
es a@

User-Agent:NKPlayer-1.00.00.081112
Fr rc

2. Server responds that authentication is required.

y ema

RTSP/1.0 401 Unauthorized

CSeq: 0
WWW-Authenticate: Digest realm="3521781c29acb312330dd668", nonce="026019333", algorithm="MD5"
os fr
ad on

3. The client sends an RTSP DESCRIBE request with authentication information again.
el .c

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

CSeq:1
Accept:application/sdp
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101",
en

response="76a2c9c5b8edbd49838013cf1cf27941"
User-Agent:NKPlayer-1.00.00.081112
im
ng

4. The device responds to SDP information.

Aj
Co
RTSP/1.0 200 OK
CSeq: 1
Content-Type: application/sdp
Content-Length: 571
Date: Tue, 17 Nov 2020 02:09:45 GMT

v=0
o=- 1109162014219182 0 IN IP4 0.0.0.0
s= Media Server V4.22.126
i= Media Server Session Description : standard
e=NONE
c=IN IP4 0.0.0.0
t=0 0
a=control:*

m
b=AS:6154
a=range:npt=now-

co
m=video 0 RTP/AVP 96
i=Video Media

a.
a=rtpmap:96 H264/90000
a=fmtp:96 profile-level-id=4D0014;packetization-mode=0
a=control:trackID=1

C. arc
b=AS:6144
m=audio 0 RTP/AVP 8
i=Audio Media
a=rtpmap:8 PCMA/8000

s, em
a=control:trackID=2
b=AS:10

A
a=Media_header:MEDIAINFO=494D4B48020100000200000111710110401F000000FA000000000000000000000000000000000000;

no fr
a=appversion:1.0

ri on
5. The client sends RTSP SETUP requests, and the server responds to them.

Ma oc
SETUP rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101/trackID=1 RTSP/1.0
up
CSeq:2
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101",
co gr

response="ff343f5ff82deb028dd9b4932cc44201"
Transport:RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=0
User-Agent:NKPlayer-1.00.00.081112
es a@
Fr rc

RTSP/1.0 200 OK
Session: 1127293610;timeout=60
y ema

Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=433122aa
CSeq: 2
Accept-Ranges: NPT
Media-Properties: No-Seeking, Time-Progressing, Time-Duration=0
os fr

Date: Tue, 17 Nov 2020 02:09:45 GMT

ad on

SETUP rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101/trackID=2 RTSP/1.0

el .c

CSeq:3
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101",
ez

response="ff343f5ff82deb028dd9b4932cc44201"
Session:1127293610;timeout=60
Transport:RTP/AVP/TCP;unicast;interleaved=2-3;ssrc=0
en

User-Agent:NKPlayer-1.00.00.081112
im
ng

RTSP/1.0 200 OK
Aj

Session: 1127293610;timeout=60
Co

Transport: RTP/AVP/TCP;unicast;interleaved=2-3;ssrc=433122ab
CSeq: 3
Accept-Ranges: NPT
Media-Properties: No-Seeking, Time-Progressing, Time-Duration=0
Date: Tue, 17 Nov 2020 02:09:45 GMT

6. The client sends an RTSP PLAY request.

PLAY rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101 RTSP/1.0

CSeq:4
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101",
response="24edf8a6ff3ef767f7c49d1c847200bd"
Session:1127293610;timeout=60
Range:npt=0.000000-0.000000
User-Agent:NKPlayer-1.00.00.081112

7. The server sends audio and video stream data.

RTSP/1.0 200 OK
Session: 1127293610
CSeq: 4
Date: Tue, 17 Nov 2020 02:09:45 GMT

$. .....d1.w....c....".T....g....).i.........a....7.S..~J............X....X.

8. The client sends an RTSP TEARDOWN request, and the server responds to it.

TEARDOWN rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101 RTSP/1.0

CSeq:5

m
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101",
response="24edf8a6ff3ef767f7c49d1c847200bd"

co
Session:1127293610;timeout=60
Range:npt=0.000000-0.000000

a.
User-Agent:NKPlayer-1.00.00.081112

C. arc
RTSP/1.0 200 OK
Session: 1127293610

s, em
CSeq: 5
Date: Tue, 17 Nov 2020 02:09:50 GMT

A
no fr
ri on
4.4 Playback
4.4.1 Introduction to the Function
Ma oc
up
Devices such as cameras and NVRs can store videos. Storage mediums such as SD card, TF card and HDDs are needed
before recording videos. The process of playback starts with searching for footages and then getting video stream via
co gr

RTSP (Real Time Streaming Protocol, see details in RFC 7826).

es a@

Below is an example of playback on a web client. The calendar in the bottom-left corner shows the results of searching
for videos. Dates with videos are shown on the calendar and you can click a date to play back searched videos of the
Fr rc

corresponding day.
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

4.4.2 API Calling Flow

1. (Optional) Check the calendar to find dates with stored videos: POST
/ISAPI/ContentMgmt/record/tracks/<trackStreamID>/dailyDistribution . <trackStreamID> = channel number
* 100 + stream type (1-main stream, 2-sub-stream, 3-third stream). For example, The rackStreamID of the main
stream for channel 17 is 1701.
2. Searching for videos by parsing the playbackURI of the device to get the RTSP address POST
/ISAPI/ContentMgmt/search .
3. Play videos back via RTSP. Steps of playback via RTSP is the same as that of real-time live view. Refer to streaming
via RTSP in real-time streaming. See details in RFC 7826 (Real Time Streaming Protocol).
Notes:
Playback via RTSP needs digest authentication. The method is the same as the one of ISAPI digest authentication.
Send PAUSE command to pause playback. Send PLAY command to continue. If you want to perform fast forward
and slow forward, you can send a PLAY command and set Scale in headers. See details in 10.6 PAUSE and 12.34
Scale in RFC 7826 (Real Time Streaming Protocol).

4.4.3 Example

m
co
4.4.3.1 Search for Videos According to Calendar

a.
Request from Client

C. arc
POST /ISAPI/ContentMgmt/record/tracks/101/dailyDistribution HTTP/1.1
Host: 10.14.97.40
Connection: keep-alive

s, em
Content-Length: 119
Cache-Control: max-age=0

A
no fr
Accept: */*
X-Requested-With: XMLHttpRequest
If-Modified-Since: 0

ri on
User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Origin: http://10.14.97.40

Ma oc
Referer: http://10.14.97.40/doc/index.html
Accept-Encoding: gzip, deflate
Accept-Language: zh-CN,zh;q=0.9
up
Cookie: WebSession_78aedfcc66=3b451c9d37cb637827da0815086e7ecfd9984b0095b3cb7198e8197a424a3279
co gr

<?xml version="1.0" encoding="utf-8"?>

<trackDailyParam>
<year>2021</year>
es a@

<monthOfYear>08</monthOfYear>
</trackDailyParam>
Fr rc

Response from Device

y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
HTTP/1.1 200 OK
Vary: Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Type: application/xml; charset="UTF-8"
X-Content-Type-Options: nosniff
Date: Wed, 18 Aug 2021 15:47:43 GMT
Content-Length: 2915
X-XSS-Protection: 1; mode=block
Connection: Keep-Alive
Accept-Ranges: bytes

<?xml version="1.0" encoding="UTF-8" ?>

m
<day><id>1</id><dayOfMonth>1</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>2</id><dayOfMonth>2</dayOfMonth><record>true</record><recordType>time</recordType></day>

co
<day><id>3</id><dayOfMonth>3</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>4</id><dayOfMonth>4</dayOfMonth><record>true</record><recordType>time</recordType></day>

a.
<day><id>5</id><dayOfMonth>5</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>6</id><dayOfMonth>6</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>7</id><dayOfMonth>7</dayOfMonth><record>true</record><recordType>time</recordType></day>

C. arc
<day><id>8</id><dayOfMonth>8</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>9</id><dayOfMonth>9</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>10</id><dayOfMonth>10</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>11</id><dayOfMonth>11</dayOfMonth><record>true</record><recordType>time</recordType></day>

s, em
<day><id>12</id><dayOfMonth>12</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>13</id><dayOfMonth>13</dayOfMonth><record>true</record><recordType>time</recordType></day>

A
<day><id>14</id><dayOfMonth>14</dayOfMonth><record>false</record></day>

no fr
<day><id>15</id><dayOfMonth>15</dayOfMonth><record>false</record></day>
<day><id>16</id><dayOfMonth>16</dayOfMonth><record>false</record></day>
<day><id>17</id><dayOfMonth>17</dayOfMonth><record>false</record></day>

ri on
<day><id>18</id><dayOfMonth>18</dayOfMonth><record>true</record><recordType>time</recordType></day>
<day><id>19</id><dayOfMonth>19</dayOfMonth><record>false</record></day>

Ma oc
<day><id>20</id><dayOfMonth>20</dayOfMonth><record>false</record></day>
<day><id>21</id><dayOfMonth>21</dayOfMonth><record>false</record></day>
<day><id>22</id><dayOfMonth>22</dayOfMonth><record>false</record></day>
up
<day><id>23</id><dayOfMonth>23</dayOfMonth><record>false</record></day>
<day><id>24</id><dayOfMonth>24</dayOfMonth><record>false</record></day>
<day><id>25</id><dayOfMonth>25</dayOfMonth><record>false</record></day>
co gr

<day><id>26</id><dayOfMonth>26</dayOfMonth><record>false</record></day>
<day><id>27</id><dayOfMonth>27</dayOfMonth><record>false</record></day>
es a@

<day><id>28</id><dayOfMonth>28</dayOfMonth><record>false</record></day>
<day><id>29</id><dayOfMonth>29</dayOfMonth><record>false</record></day>
<day><id>30</id><dayOfMonth>30</dayOfMonth><record>false</record></day>
Fr rc

<day><id>31</id><dayOfMonth>31</dayOfMonth><record>false</record></day>
</dayList>
</trackDailyDistribution>
y ema

4.4.3.2 Search for Videos

os fr

Request from Client

ad on
el .c

POST /ISAPI/ContentMgmt/search HTTP/1.1

Host: 10.14.97.40
Connection: keep-alive
ez

Content-Length: 486
Cache-Control: max-age=0
Accept: */*
en

X-Requested-With: XMLHttpRequest
If-Modified-Since: 0
im

User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
ng

Origin: http://10.14.97.40
Aj

Referer: http://10.14.97.40/doc/index.html
Accept-Encoding: gzip, deflate
Co

Accept-Language: zh-CN,zh;q=0.9
Cookie: WebSession_78aedfcc66=3b451c9d37cb637827da0815086e7ecfd9984b0095b3cb7198e8197a424a3279

<?xml version="1.0" encoding="utf-8"?>

<CMSearchDescription>
<searchID>88C2CD4D-D3FA-4AD4-BD80-555C18205DCC</searchID>
<trackList>
<trackID>101</trackID>
</trackList>
<timeSpanList>
<timeSpan>
<startTime>2021-08-16T00:00:00Z</startTime>
<endTime>2021-08-18T23:59:59Z</endTime>
</timeSpan>
</timeSpanList>
<maxResults>100</maxResults>
<searchResultPostion>0</searchResultPostion>
<metadataList>
<metadataDescriptor>//recordType.meta.std-cgi.com</metadataDescriptor>
</metadataList>
</CMSearchDescription>
Response from Device

HTTP/1.1 200 OK
Vary: Accept-Encoding
X-Frame-Options: SAMEORIGIN
Content-Type: application/xml; charset="UTF-8"
X-Content-Type-Options: nosniff
Date: Wed, 18 Aug 2021 15:19:13 GMT
Content-Length: 1021
X-XSS-Protection: 1; mode=block
Connection: Keep-Alive
Accept-Ranges: bytes

<?xml version="1.0" encoding="UTF-8" ?>

m
<CMSearchResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID>{88c2cd4d-d3fa-4ad4-bd80-555c18205dcc}</searchID>

co
<responseStatus>true</responseStatus>
<responseStatusStrg>OK</responseStatusStrg>

a.
<numOfMatches>1</numOfMatches>
<matchList>
<searchMatchItem>

C. arc
<sourceID>{00000000-0000-0000-0000-000000000000}</sourceID>
<trackID>101</trackID>
<timeSpan>
<startTime>2021-08-18T15:18:15Z</startTime>

s, em
<endTime>2021-08-18T15:19:08Z</endTime>
</timeSpan>

A
<mediaSegmentDescriptor>

no fr
<contentType>video</contentType>
<codecType>H.264-BP</codecType>

ri on
<playbackURI>rtsp://10.14.97.40/Streaming/tracks/101/?
starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788</playbackURI>
<lockStatus>unlock</lockStatus>

Ma oc
<name>00000004667000100</name>
</mediaSegmentDescriptor>
<metadataMatches>
up
<metadataDescriptor>recordType.meta..com/timing</metadataDescriptor>
</metadataMatches>
co gr

</searchMatchItem>
</matchList>
</CMSearchResult>
es a@
Fr rc

4.4.3.3 Playback via RTSP

y ema

1. A client sends an RTSP DESCRIBE command.

os fr

DESCRIBE rtsp://10.14.97.40:554/Streaming/tracks/101/?starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788 RTSP/1.0

CSeq: 4
Authorization: Digest username="", realm="323852ae0234c718f2d4198b", nonce="34e30476d", uri="rtsp://10.14.97.40:554/Streaming/tracks/101/?
ad on

starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788", response="883546f4c19dd156fb3a490266c99715"
User-Agent: LibVLC/3.0.3 (LIVE555 Streaming Media v2016.11.28)
el .c

2. The server responds that authentication is required.

ez
en

RTSP/1.0 401 Unauthorized

CSeq: 5
WWW-Authenticate: Digest realm="323852ae0234c718f2d4198b", nonce="55e5895b9", algorithm="MD5"
im
ng
Aj

3. The client sends an RTSP DESCRIBE request with authentication information again.
Co

DESCRIBE rtsp://10.14.97.40:554/Streaming/tracks/101/?starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788 RTSP/1.0

CSeq: 7
Authorization: Digest username="admin", realm="323852ae0234c718f2d4198b", nonce="55e5895b9", uri="rtsp://10.14.97.40:554/Streaming/tracks/101/?
starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788", response="cf33e4dc6b86a2fdd2e5b26d25e7b99d"
User-Agent: LibVLC/3.0.3 (LIVE555 Streaming Media v2016.11.28)
Accept: application/sdp

4. The server responds to SDP information.

RTSP/1.0 200 OK
CSeq: 7
Content-Type: application/sdp
Content-Length: 546
Date: Wed, 18 Aug 2021 07:29:25 GMT

v=0
o=- 1109162014219182 0 IN IP4 0.0.0.0
s= Media Server V4.60.000
i= Media Server Session Description : standard
e=NONE
c=IN IP4 0.0.0.0
t=0 0
a=control:*

m
b=AS:4106
a=range:clock=20210818T151815Z-20210818T151908Z

co
m=video 0 RTP/AVP 96
i=Video Media

a.
a=rtpmap:96 H265/90000
a=control:trackID=video
b=AS:4096

C. arc
m=audio 0 RTP/AVP 8
i=Audio Media
a=rtpmap:8 PCMA/8000
a=control:trackID=audio

s, em
b=AS:10
a=Media_header:MEDIAINFO=494D4B48020100000400050011710110401F000000FA000000000000000000000000000000000000;

A
a=appversion:1.0

no fr
ri on
5. The client sends RTSP SETUP commands two times, and the server responds to them.

Ma oc
SETUP rtsp://10.14.97.40:554/Streaming/tracks/101/?starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788/trackID=video
RTSP/1.0
up
CSeq: 8
Authorization: Digest username="admin", realm="323852ae0234c718f2d4198b", nonce="55e5895b9", uri="rtsp://10.14.97.40:554/Streaming/tracks/101/?
co gr

starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788", response="44d97a3758b7f19f1a31fe042b1464b5"
User-Agent: LibVLC/3.0.3 (LIVE555 Streaming Media v2016.11.28)
Transport: RTP/AVP;unicast;client_port=61048-61049
es a@
Fr rc

RTSP/1.0 200 OK
Session: 225263317;timeout=60
y ema

Transport: RTP/AVP;unicast;client_port=61048-61049;server_port=62000-62001;ssrc=d6d3ed5
CSeq: 8
Accept-Ranges: UTC
Media-Properties: Random-Access=1.0s, Unlimited, Immutable,Scales="-1, 0.5, 0.25, 0.125,:1, 2, 4"
os fr

Date: Wed, 18 Aug 2021 07:29:25 GMT

ad on

SETUP rtsp://10.14.97.40:554/Streaming/tracks/101/?starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788/trackID=audio
el .c

RTSP/1.0
CSeq: 9
ez

Authorization: Digest username="admin", realm="323852ae0234c718f2d4198b", nonce="55e5895b9", uri="rtsp://10.14.97.40:554/Streaming/tracks/101/?

starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788", response="44d97a3758b7f19f1a31fe042b1464b5"
User-Agent: LibVLC/3.0.3 (LIVE555 Streaming Media v2016.11.28)
en

Transport: RTP/AVP;unicast;client_port=61050-61051
Session: 225263317
im
ng
Aj

RTSP/1.0 200 OK
Co

Session: 225263317;timeout=60
Transport: RTP/AVP;unicast;client_port=61050-61051;server_port=62002-62003;ssrc=d6d3ed6
CSeq: 9
Accept-Ranges: UTC
Media-Properties: Random-Access=1.0s, Unlimited, Immutable,Scales="-1, 0.5, 0.25, 0.125,:1, 2, 4"
Date: Wed, 18 Aug 2021 07:29:25 GMT

6. The client sends an RTSP PLAY request, and the server starts to push streams for playback.

PLAY rtsp://10.14.97.40:554/Streaming/tracks/101/?starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788 RTSP/1.0

CSeq: 10
Authorization: Digest username="admin", realm="323852ae0234c718f2d4198b", nonce="55e5895b9", uri="rtsp://10.14.97.40:554/Streaming/tracks/101/?
starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788", response="4d8b7ceb301c06b40a9ae411189a909f"
User-Agent: LibVLC/3.0.3 (LIVE555 Streaming Media v2016.11.28)
Session: 225263317
Range: npt=0.000-
RTSP/1.0 200 OK
Range: clock=20210818T151815Z-20210818T151908Z
Session: 225263317
CSeq: 10
Date: Wed, 18 Aug 2021 07:29:25 GMT

7. The client sends an RTSP TEARDOWN request to stop playback.

TEARDOWN rtsp://10.14.97.40:554/Streaming/tracks/101/?starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788 RTSP/1.0

CSeq: 11
Authorization: Digest username="admin", realm="323852ae0234c718f2d4198b", nonce="55e5895b9", uri="rtsp://10.14.97.40:554/Streaming/tracks/101/?

m
starttime=20210818T151815Z&endtime=20210818T151908Z&name=00000004667000100&size=1400788", response="1d3f6f8d07d7087d341560b125445456"
User-Agent: LibVLC/3.0.3 (LIVE555 Streaming Media v2016.11.28)

co
Session: 225263317

a.
C. arc
RTSP/1.0 200 OK
CSeq: 11
Date: Wed, 18 Aug 2021 07:29:38 GMT
Session: 225263317

s, em
Connection: close

A
no fr
4.5 Event Uploading

ri on
When the rules configured on the device are triggered, the device will generate event messages (e.g., motion detection,

Ma oc
etc.) and actively upload them to the client. ISAPI supports three methods to receive event messages uploaded by the
up
device, that is, in arming mode, in listening mode, and via subscription.
co gr

4.5.1 Arming
es a@

The client establishes a HTTP persistent connection with the device to receive event messages from the device.
There are two methods (arming with subscription and arming without subscription) to receive events from the device.
Fr rc

The arming without subscription is to get all event messages from the device via HTTP GET method, while the arming
y ema

with subscription is to get messages of subscribed events via HTTP POST method.
Notes
os fr

ISAPI arming (with or without subscription) uses the HTTP/HTTPS persistent connection. Due to the simplex
channel communication mode of HTTP, after establishing the arming connection, the device will send event
ad on

messages continuously, while it's not supported for clients to send any message to the device via the connection.
el .c

When the heartbeat timed out and no message is received from the device, you should terminate the arming
connection and try establishing a new one.
ez
en

4.5.1.1 Arming without Subscription

1. Establish the connection of arming without subscription: GET /ISAPI/Event/notification/alertStream and keep
im

the connection alive via configuring Connection: keep-alive in HTTP headers on the client.
ng
Aj

2. Receive events sent by the device. The event message will be separated and parsed by boundary. For parsing
Co

details, see Event Message Parsing below.

3. Terminate the arming connection when no event message needs to be received.
Event Message Parsing:
GET /ISAPI/Event/notification/alertStream HTTP/1.1
Host: <data_gateway_ip>
Connection: Keep-Alive

HTTP/1.1 401 Unauthorized

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

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

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

co
",nc=00000001,qop="auth",response="f2e0728991bb031f83df557a8f185178"
Host: 10.6.165.192

a.
HTTP/1.1 200 OK
MIME-Version: 1.0

C. arc
Connection: close
Content-Type: multipart/mixed; boundary=<frontier>

--<frontier>

s, em
Content-Type: application/xml; charset="UTF-8"

A
Content-Length: text_length

no fr
<EventNotificationAlert/>
--<frontier>

ri on
Content-Disposition: form-data; name="Picture_Name"
Content-Type: image/pjpeg

Ma oc
Content-Length: image_length

[Picture Data]
up
--<frontier>
co gr

Note: <data_gateway_ip> and <frontier> are variables, [Picture Data] indicates the raw data of a picture.
es a@

4.5.1.2 Arming with Subscription

Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj

1. Get device system capabilities: GET /ISAPI/System/capabilities .

2. Check if event subscription is supported: isSupportSubscribeEvent exists and its value is true . When
isSupportSubscribeEvent does not exist or its value is false, the device does not support event subscription.

3. Get the capability of arming with subscription: GET /ISAPI/Event/notification/subscribeEventCap .

4. Establish a connection of arming with subscription: POST /ISAPI/Event/notification/subscribeEvent . You need
to set Connection: keep-alive in HTTP headers.
5. (Optional) Edit parameters of the existing subscription. You need to get the subscription parameters first: GET
/ISAPI/Event/notification/subscribeEvent/<subscribeEventID> . Then, edit the parameters based on the
existing subscription configurations: PUT /ISAPI/Event/notification/subscribeEvent/<subscribeEventID> .
6. Receive events sent by the device. The event messages will be separated and parsed by the boundary. For parsing
description, see Event Messages Parsing below.
7. (Optional) Terminate the connection of arming with subscription: PUT
/ISAPI/Event/notification/unSubscribeEvent?ID=<subscribeEventID> . When communicating with the device
via HTTP directly, there is no need to call this API. You can just terminate the connection.
Note：
Three types of data will be transmitted on the arming link: <SubscribeEventResponse/> , <EventNotificationAlert/> ,
and picture data. <SubscribeEventResponse/> is the data of first form sent by the device after arming established, see
the response parameters of URL ( POST /ISAPI/Event/notification/subscribeEvent ) for details; and
<EventNotificationAlert/> is the event content or heartbeat, you can identify the event type via field eventType , e.g.,
for heartbeat, the value of eventType is heartBeat .

m
co
Event Messages Parsing:

a.
Client Creates Arming with Subscription

C. arc
POST /ISAPI/Event/notification/subscribeEvent HTTP/1.1
Authorization: Digest username="admin",realm="IP
Camera(C2183)",nonce="4e5468694e7a42694e7a4d364f4449354d7a6b354d54513d",uri="/ISAPI/Event/notification/alertStream",cnonce="3d183a245b8729121ae4ca3d41b90f18
",nc=00000001,qop="auth",response="f2e0728991bb031f83df557a8f185178"

s, em
Host: device_ip

A
<SubscribeEvent/>

no fr
ri on
Server Responds to Request and Push Event Message

Ma oc
When the client sends a request to the device for establishing an arming connection, the device sends data in HTTP
form format (multipart/form-data). In HTTP request headers, the Content-Type is multipart/form-data,
up
boundary=AaB03x , of which the boundary is a variable used to divide the HTTP body into multiple units, and each unit
has its headers and body. For detailed format description, see RFC 1867 (Form-based File Upload in HTML). An example
co gr

is shown below. Please note two hyphens -- before and after boundary. In normal conditions, devices will not close the
es a@

arming link actively, and the end mark --AaB03x-- will not be sent on the arming link.
Fr rc

HTTP/1.1 200 OK
Content-Type: multipart/form-data; boundary=AaB03x
y ema

Connection: keep-alive
--AaB03x
Content-Disposition: form-data; name="ANPR.xml"; filename="ANPR.xml";
Content-Type: application/xml
os fr

Content-Length: 9

<ANPR/>
ad on

--AaB03x
Content-Disposition: form-data; name="licensePlatePicture.jpg"; filename="licensePlatePicture.jpg";
el .c

Content-Type: image/jpeg
Content-Length: 14
ez

Picture Data
--AaB03x--
en

The description of some keywords are as follows:

im
ng

Keyword Example Description

Aj
Co

Content- multipart/form-data; Content type. multipart/form-data means the message is in form

Type boundary=AaB03x format.
Delimiter of the form message. A form message which starts with --
boundary AaB03x
boundary and ends with --boundary-- .

Content- form-data; name=“ANPR.xml”;

Content description. form-data is a piece of form data.
Disposition filename=“ANPR.xml”;
name "ANPR.xml" Form name.
filename "ANPR.xml" File name of the form.
Content-
9 Content length, starting from the next \r\n to the next --boundary .
Length
4.5.2 Listening
After a client enables the listening service, when an event occurs, the device will send the event information actively to
the configured event receiving address. The event receiving address should be valid and configured on the device.

m
co
a.
C. arc
s, em
A
no fr
ri on
Notes: Ma oc
up
The client and event service can be the same program.
co gr

In listening mode, no heartbeat information is generated on devices.

es a@

4.5.2.1 API Calling Flow

Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

1. Check whether the device supports configuring listening host parameters.

Get the configuration capability of the listening host: GET /ISAPI/Event/notification/httpHosts/capabilities .

If the node <HttpHostNotificationCap> is returned and its value is true, it indicates that the device supports
en

configuring listening host parameters.

2. Configure parameters of the listening host.

ng
Aj

Configure parameters of all listening hosts: PUT /ISAPI/Event/notification/httpHosts?security=

<security>&iv=<iv> ;

Get parameters of all listening hosts: GET /ISAPI/Event/notification/httpHosts?security=<security>&iv=

<iv> ;

Configure parameters of a listening host: PUT /ISAPI/Event/notification/httpHosts/<hostID>?security=

<security>&iv=<iv> ;

Get parameters of a listening host: GET /ISAPI/Event/notification/httpHosts/<hostID>?security=

<security>&iv=<iv> .

3. Enable the listening service.

You need to enable the listening service of the listening host.
4. (Optional) Test the listening service.
4. (Optional) Test the listening service.
The platform applies the command to the device to test whether the listening host is available for the device: POST
/ISAPI/Event/notification/httpHosts/<hostID>/test .

5. The listening host receives event information from the device.

When an event occurs, the device creates an connection with the client and uploads alarm information actively.
Meanwhile, the listening host receives data from the device. See details in Event Messages.
Note: You can also configure the listening parameters such as the time out via URL

m
/ISAPI/Event/notification/httpHosts/<hostID>/uploadCtrl .

co
4.5.2.2 Event Messages

a.
When an event occurs or an alarm is triggered in listening mode, the event/alarm information can be uploaded with

C. arc
binary data (such as pictures) and without binary data.
1. Without Binary Data:

s, em
The Content-Type in headers of the HTTP request sent by the device is usually application/xml or application/json

A
no fr
as follows:

ri on
Alarm Message Sent by the Device

Ma oc
POST Request_URI HTTP/1.1 
Host: data_gateway_ip:port 
up
Accept-Language: en-us
Date: YourDate
Content-Type: application/xml; 
co gr

Content-Length: text_length
Connection: keep-alive 
es a@

<EventNotificationAlert/>
Fr rc

Response by the Listening Host

y ema

HTTP/1.1 200 OK
Date: YourDate
os fr

Connection: close
ad on

2. With Binary Data:

el .c

The format of the data sent by the device is HTTP form (multipart/form-data). The Content-Type in headers of the HTTP
request is usually multipart/form-data, boundary=<frontier> , of which boundary is a variable used to divide the
ez

HTTP body into multiple units, and each unit has its headers and body. See details in RFC 1867 (Form-based File
en

Upload in HTML). An example is shown below. Please note two hyphens -- before and after the boundary.
Alarm Message Sent by the Device
im
ng
Aj

POST Request_URI HTTP/1.1

Host: device_ip:port 
Co

Accept-Language: en-us
Date: YourDate
Content-Type: multipart/form-data;boundary=<frontier>
Content-Length: text_length
Connection: keep-alive

--<frontier>
Content-Disposition: form-data; name="Event_Type"
Content-Type: text/xml

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

[Picture Data]
--<frontier>--

Response by the Listening Host

HTTP/1.1 200 OK
Date: YourDate
Connection: close

The description of some keywords are as follows:

Keyword Example Description
Content- multipart/form-data;
Content type, multipart/form-data refers to data in form format.
Type boundary=frontier

m
Delimiter of the form message. A form message which starts with --

co
boundary frontier
boundary and ends with --boundary-- .

a.
Content- form-data;
Content description. form-data is a piece of form data.

C. arc
Disposition name="Picture_Name";
filename "Picture_Name" File name. The file refers to the form message.

s, em
A
Content-

no fr
10 Content length, starting from the next \r\n to the next --boundary .
Length

ri on
4.5.2.3 Exception Handling
Error Codes
Ma oc
up
statusCode statusString subStatusCode errorCode Description
co gr

6 Invalid Content eventNotSupport 0x60001024

es a@

5 Device Management (General)

Fr rc

s
y ema

5.1 . Search for Structured Logs

os fr

5.1.1 Introduction to the Function

ad on

The device will generate many logs during running. A type of logs are stored in the device database by structured data,
including:
el .c

Operation records of the device, such as startup, reboot, PTZ control, etc.
ez

Events generated by the device, such as the start of motion detection, the end of motion detection, face capture, etc.
en

Device status exception, such as network disconnection, network recovery, IP address conflict, etc.
Device triggering information, such as start recording, stop recording, and record HDD status information
im

regularly.
ng
Aj

Structured log search contains log search and security log search. The two methods share some features, and have
Co

differences:
Log search is used for searching for running status and operation records of the device.
Security log search is used for searching for the security-related status and operation records of the device, such as
user login/logout records, device SSH service enabling/shutdown records, etc.
Structured logs can be displayed on the device web page, remote client, and platform/software by structure tabs.

5.1.2 API Calling Flow

1. Search for log information: POST /ISAPI/ContentMgmt/logSearch .
2. Search for security logs: POST /ISAPI/ContentMgmt/security/logSearch .
5.2 . Upload Log to Syslog Server
5.2.1 Introduction to the Function
Syslog is a standard log transmission protocol that is widely applied to system logs, which is defined in RFC 5424 (The
Syslog Protocol). After configuring the device's Syslog service address and enabling the Syslog function, the device will
send the logs running in Syslog protocol to the Syslog server. Syslog server can manage logs of a large number of
devices in this way.

5.2.2 API Calling Flow

m
co
1. Get the capability of accessing syslog parameters, and check whether the device supports syslog function and set
the value range of parameters.

a.
2. Set log server parameters: PUT /ISAPI/System/logServer ; edit the device log server configuration, including IP

C. arc
address, port No., certificate, etc.;
3. Device logs will be sent to Syslog server through Syslog protocol. You can view device logs in Syslog server.

s, em
5.3 Arming and Subscription

A
no fr
5.3.1 Introduction to the Function

ri on
With arming and subscription, the client can establish HTTP persistent connection with the device, and continuously
receive the event messages from the device.
Ma oc
For ISAPI event arming, the client can receive all types of events by GET method, or receive the subscribed events only
up
by POST method.
co gr

5.3.2 API Calling Flow

es a@

5.3.2.1 Without Subscription

Fr rc

1. Establish a connection for arming: GET /ISAPI/Event/notification/alertStream . You need to set Connection:
y ema

keep-alive in HTTP Headers.

2. When receiving events sent by the device, the event messages can be separated and parsed by boundary. See
os fr

“Parsing Event Messages” below for details.

3. Disable the arming connection when you do not need to receive event messages.
ad on

5.3.2.2 Subscription
el .c

5.3.2.2.1 API Calling Flow

ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj

1. Get device system capabilities: GET /ISAPI/System/capabilities .

3. Get the capability of arming with subscription: GET /ISAPI/Event/notification/subscribeEventCap .

4. Establish a connection of arming with subscription: POST /ISAPI/Event/notification/subscribeEvent . You need
to set Connection: keep-alive in HTTP Headers.
5. (Optional) Edit parameters of the existing subscription. You need to get the subscription parameters first: GET
/ISAPI/Event/notification/subscribeEvent/<subscribeEventID> . Then, edit the parameters based on the
existing subscription configurations: PUT /ISAPI/Event/notification/subscribeEvent/<subscribeEventID> .
6. Receive events sent by the device. The event messages will be separated and parsed by boundary. For parsing
description, see Event Messages Parsing below.
7. (Optional) Terminate the connection of arming with subscription: PUT
/ISAPI/Event/notification/unSubscribeEvent?ID=<subscribeEventID> . When communicating with the device
via HTTP directly, there is no need to call this API. You can just terminate the connection.
Note：
Three types of data will be transmitted on the arming link: <SubscribeEventResponse/> , <EventNotificationAlert/> ,
and picture data. <SubscribeEventResponse/> is the data of first form sent by the device after arming established, see
the response parameters of URL ( POST /ISAPI/Event/notification/subscribeEvent ) for details; and
<EventNotificationAlert/> is the event content or heartbeat, you can identify the event type via field eventType , e.g.,
for heartbeat, the value of eventType is heartBeat .

m
co
5.3.2.2.2 Example

a.
POST /ISAPI/Event/notification/subscribeEvent HTTP/1.1

C. arc
Host: device_ip
Accept-Language: zh-cn
Date: YourDate
Content-Type: application/xml;

s, em
Content-Length: text_length
Connection: Keep-Alive

A
no fr
<SubscribeEvent/>
HTTP/1.1 401 Unauthorized

ri on
Date: Sun, 01 Apr 2018 18:58:53 GMT
Server:
Content-Length: 178

Ma oc
Content-Type: text/html
Connection: keep-alive
Keep-Alive: timeout=10, max=99
up
WWW-Authenticate: Digest qop="auth", realm="IP Camera(C2183)", nonce="4e5468694e7a42694e7a4d364f4449354d7a6b354d54513d", stale="FALSE"

POST /ISAPI/Event/notification/subscribeEvent HTTP/1.1

co gr

Authorization: Digest username="admin",realm="IP

Camera(C2183)",nonce="4e5468694e7a42694e7a4d364f4449354d7a6b354d54513d",uri="/ISAPI/Event/notification/alertStream",cnonce="3d183a245b8729121ae4ca3d41b90f18
es a@

",nc=00000001,qop="auth",response="f2e0728991bb031f83df557a8f185178"
Host: device_ip
Fr rc

<SubscribeEvent/>
HTTP/1.1 200 OK
MIME-Version: 1.0
y ema

Connection: close
Content-Type: multipart/mixed; boundary=<frontier>

--<frontier>
os fr

Content-Type: application/xml; charset="UTF-8" 
ad on

Content-Length: text_length

<SubscribeEventResponse/>
el .c

--<frontier>
Content-Type: application/xml; charset="UTF-8" 
ez

Content-Length: text_length
en

<EventNotificationAlert/>
--<frontier>
Content-Disposition: form-data; name="Picture_Name"
im

Content-Type: image/pjpeg
Content-Length: image_length
ng
Aj

[Picture Data]
--<frontier>
Co

5.3.2.3 Event Messages Parsing

After the arming connection with the device is established, the data sent by the device is in HTTP form format
(multipart/form-data). In an HTTP request, Content-Type in Headers is usually multipart/form-data,
boundary=AaB03x , and boundary is a variable used to divide HTTP Body into multiple units, each being a set of data and
has its own Headers and Body. For detailed format description, see RFC 1867 (Form-based File Upload in HTML). An
example is shown below. Note the dash -- before and after boundary.
HTTP/1.1 200 OK
Content-Type: multipart/form-data; boundary=AaB03x
Connection: keep-alive
--AaB03x
Content-Disposition: form-data; name="ANPR.xml"; filename="ANPR.xml";
Content-Type: application/xml
Content-Length: 9

<ANPR/>
--AaB03x
Content-Disposition: form-data; name="licensePlatePicture.jpg"; filename="licensePlatePicture.jpg";
Content-Type: image/jpeg
Content-Length: 14

m
Image Data
--AaB03x--

co
a.
The description of some keywords are as follows:

C. arc
Keyword Example Description
Content- multipart/form-data; Content type. multipart/form-data means the message is in form

s, em
Type boundary=AaB03x format.

A
no fr
Delimiter of the form message. --boundary is the start of a form. --
boundary AaB03x
boundary-- is the end of the whole HTTP form message.

ri on
Content- form-data; name="ANPR.xml";

Ma oc
Content description.
Disposition filename="ANPR.xml";
up
name "ANPR.xml" Form name.
co gr

filename "ANPR.xml" File name of the form.

es a@

Content-
9 Content length, starting from the next \r\n to the next --boundary.
Fr rc

Length
s
y ema

5.3.3 Restriction Description

Note that ISAPI arming (with or without subscription) uses HTTP/HTTPS persistent connection. Due to the simplex
os fr

channel communication mode of HTTP, after establishing the arming connection, the device will send out event
ad on

messages continuously, while you cannot send any message to the device via the connection.
After the heartbeat time, if you do not receive any message from the device, you should disable the arming connection
el .c

and try establishing a new one.

5.3.4 Sample Messages

5.3.4.1 Establish Arming Subscription

im
ng
Aj

POST /ISAPI/Event/notification/subscribeEvent HTTP/1.1

Authorization: Digest username="admin",realm="IP
Co

Camera(C2183)",nonce="4e5468694e7a42694e7a4d364f4449354d7a6b354d54513d",uri="/ISAPI/Event/notification/alertStream",cnonce="3d183a245b8729121ae4ca3d41b90f18
",nc=00000001,qop="auth",response="f2e0728991bb031f83df557a8f185178"
Host: device_ip

5.3.4.2 The Device Responses and Uploads an Event Message

HTTP/1.1 200 OK
MIME-Version: 1.0
Connection: close
Content-Type: multipart/mixed; boundary=<frontier>

--<frontier>
Content-Type: application/xml; charset="UTF-8" 
Content-Length: text_length

<SubscribeEventResponse/>
--<frontier>
Content-Type: application/xml; charset="UTF-8"

m
Content-Length: text_length

co
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipAddress>10.17.133.46</ipAddress>

a.
<portNo>80</portNo>
<protocol>HTTP</protocol>
<macAddress>44:19:b6:6d:24:85</macAddress>

C. arc
<channelID>1</channelID>
<dateTime>2017-05-04T11:20:02+08:00</dateTime>
<activePostCount>0</activePostCount>
<eventType>heartBeat</eventType>

s, em
<eventState>active</eventState>
<eventDescription>heartBeat</eventDescription>

A
</EventNotificationAlert>

no fr
--<frontier>
Content-Disposition: form-data; name="Picture_Name"
Content-Type: image/pjpeg

ri on
Content-Length: image_length
Content-ID: image_ID

[Picture Data]
--<frontier>
Ma oc
up
co gr

5.4 Device Hardware Asset Management

es a@

5.4.1 Introduction to the Function

Fr rc

Hardware assets: the host assets (CPU, memory, and HDD) and peripheral assets (hardware connected to the host
y ema

including camera, sensor, and USB flash drive).

Typical application: financial industry, where the head office needs to regularly count the security device assets of each
os fr

branch to collect the number, operation status, and other basic information of deployed host/storage/peripheral
cameras.
ad on

Extended application: management of industry-related service applications for assets customized by the industry
platform (e.g., information and software assets, person assets, and service assets) based on the hardware asset
el .c

integration.
ez

5.4.2 API Calling Flow

1. Get the search capability of the device hardware asset data via GET /ISAPI/System/deviceInfo/capabilities : when
im

isSupportSearchHardwareAssets is true, it indicates the device supports searching for asset data.
ng

2. Search for device hardware asset data via GET /ISAPI/System/deviceInfo/ExportDeviceAssets?format=json to get
Aj

the information of hardware assets on device including host assets, connected sub-device assets, HDD assets, etc.
Co

3. Export the device hardware asset information in binary data in Excel format.

5.5 Device Peripherals Upgrade

5.5.1 Introduction to the Function
The platform or client software or web client under the LAN upgrades device peripherals via ISAPI.

5.5.2 API Calling Flow

The sequence diagram of upgrading device peripherals by the platform is shown below.
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@

1. Get the device system capability GET /ISAPI/System/capabilities and check whether the device supports
Fr rc

upgrading peripherals. If the field isSupportAcsUpdate is returned and its value is true, it indicates that the device
supports this function, otherwise, the device does not support this function.
y ema

2. Get the capability of upgrading the peripherals module GET /ISAPI/System/AcsUpdate/capabilities , and get the
types and IDs of peripherals that support upgrading.
os fr

3. The platform sends the upgrade command POST /ISAPI/System/updateFirmware?type=<type>&moduleAddress=

ad on

<moduleAddress>&id=<indexID> . In the URL type refers to the peripheral type, moduleAddress refers to the
peripheral module address, and indexID refers to the ID of peripheral to be upgraded. The platform will apply the
el .c

upgrade peripheral package to the device.

4. Get the peripheral upgrade progress GET /ISAPI/System/upgradeStatus?type=<Type> .

5. Log in to the device again.
en

6. Get the peripheral latest version information.

5.6 Device Time Sync

ng
Aj

5.6.1 Introduction to the Function

Time sync is a method to synchronize the time of all devices connecting to the NTP server, so that all devices can share the same clock time for
providing related functions based on time. Supported time sync types: NTP time sync, manual sync, satellite time sync, platform time synchronization,
GB28181 time sync, etc. The following describes the method of NTP time sync.

5.6.1.1 NTP Time Sync

The local system of running NTP can receive sync from other clock sources (self as client), other clocks can sync from
the local system (self as server), and sync with other devices.
The basic working principle of NTP is shown in the picture. Device A and Device B are connected via the network, and
their systems follow their own independent system time. To auto sync their time, you can set device time auto sync via
NTP. For example:
Before time sync between Device A and Device B, the time of Device A is 10:00:00 am, and that of Device B is 11:00:00 am. Device B is set as the server of
NTP server, so that the time of Device A should be synchronized with that of Device B. The time of NTP message transmitted between Device A and Device B is
1 second.

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
The working process of system clock synchronization is as follows:
Device A sends an NTP message to Device B with a timestamp of 10:00:00 am (T1) that is when it leaves Device A.
co gr

When the NTP message reaches Device B. Device B will add its own timestamp, which is 11:00:01 am (T2).
es a@

Then the NTP message leaves Device B with Device B's timestamp, which is 11:00:02 am (T3).
Fr rc

Device A receives the response message, and the local time of Device A is 10:00:03 am (T4).
y ema

Above all, Device A can calculate two important parameters:

Round-trip delay of NTP message: Delay = (T4-T1) - (T3-T2) = 2 seconds.
os fr

Time difference between Device A and Device B: offset = ((T2-T1)+(T3-T4))/2=1 h.

Device A can sync its own time with that of Device B according to calculation results.
ad on
el .c

5.6.2 API Calling Flow

5.6.2.1 Time Sync Configuration

1. Get the Capability of Device Time synchronization Management

You can call this API to get the time sync types currently supported by the device, such as NTP time sync, manual time
im

sync, satellite time sync, Connect platform time sync, and GB28181 time sync.
ng
Aj

Get the capability: GET /ISAPI/System/time/capabilities .

2. Set device time synchronization management parameters

You can configure the time synchronization mode as follows.
NTP time synchronization: See 4.2.2 NTP Time Sync (Client).
Manual time synchronization: Set the value of timeMode to manual , and set the device local time in nodes localTime、
timeZone .
Satellite time synchronization: Set the value of timeMode to satellite , and set the device local time in nodes
satelliteInterval .
Platform time synchronization: Set the value of timeMode to platform .
GB28181 time synchronization: Set the value of timeMode to GB28181 . If there are two GB28181 platforms, you can
select platform No. via platformNo . it is the only ID, which is configured via platformNo in GB28181List , related URI:
/ISAPI/System/Network/SIP/<SIPServerID>
Get device time synchronization management parameters: GET /ISAPI/System/time ; Set device time synchronization
management parameters: PUT /ISAPI/System/time .

5.6.2.2 NTP Time Sync (Client)

The local system running the NTP server can receive sync information from other clock sources (self as client), sync
other clocks (self as server) as clock sources, and sync with other devices. Calling flow (self as client):

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Check whether the device supports synchronizing time via NTP server Get the capability of the device: GET
/ISAPI/System/time/capabilities ; and check whether timeMode supports NTP .
2. Set access parameters of the NTP server
Supports accessing the NTP server by IP address to synchronize the device time.
Get the access parameter capability of the NTP server: GET /ISAPI/System/time/ntpServers/capabilities
Set access parameters of the NTP server: PUT /ISAPI/System/time/ntpServers
Get access parameters of the NTP server: GET /ISAPI/System/time/ntpServers
3. Set the time mode of the device to NTP
Supports setting the value of timeMode to NTP .
Get device time synchronization management parameters: GET /ISAPI/System/time Set device time synchronization
management parameters: PUT /ISAPI/System/time

m
5.6.2.2 NTP Time Sync (Server Mode)

co
The local system running the NTP server can receive sync information from other clock sources (self as client), sync

a.
other clocks (self as server) as clock sources, and sync with other devices. Calling flow (self as server):

C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Check whether the device supports configuring NTP service Get the capability of device time synchronization
management: GET /ISAPI/System/time/capabilities ; If isSupportNtp is returned, it indicates that the device
supports time synchronization management.
2. Set NTP server to the server mode
Supports setting the value of mode to server .
Get the capability of server mode: GET /ISAPI/System/time/ntp/capabilities?format=json
Set NTP to server mode: PUT /ISAPI/System/time/ntp?format=json
Get parameters of NTP server mode: GET /ISAPI/System/time/ntp?format=json
3. Set the parameters of NTP server
Supports setting the IP address of the NTP server.
Get the capability of NTP server: GET /ISAPI/System/time/NTPService/capabilitis?format=json

m
co
Set the NTP server parameters: PUT /ISAPI/System/time/NTPService?format=json

a.
Get the parameters of the NTP server: GET /ISAPI/System/time/NTPService?format=json
4. Synchronize the device’s NTP service information with other devices

C. arc
Supports synchronizing the time information to the camera.
Get the capability set of synchronizing device’s NTP service information with the camera: GET

s, em
/ISAPI/System/time/SyncDeviceNTPInfoToCamera/capabilities?format=json

A
no fr
Synchronize device’s NTP service information with the camera: PUT

ri on
/ISAPI/System/time/SyncDeviceNTPInfoToCamera?format=json
Get the progress of synchronizing device’s NTP service information with the camera: GET

Ma oc
/ISAPI/System/time/SyncDeviceNTPInfoToCamera/Progress?format=json
up
Search for the results of synchronizing device’s NTP service information with the camera: POST
/ISAPI/System/time/SyncDeviceNTPInfoToCamera/SearchResult?format=json
co gr
es a@

5.7 Device Upgrade

Fr rc

5.7.1 Introduction to the Function

y ema

The platform or client software or web client under the LAN upgrades devices via ISAPI.

5.7.2 API Calling Flow

os fr

The sequence diagram of upgrading devices by the platform is shown below.

ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on

1. Upgrade devices.
el .c

Upgrade the device firmware: POST /ISAPI/System/updateFirmware .

2. Get the device upgrade progress.

Get the device upgrade progress: GET /ISAPI/System/upgradeStatus .

3. Reboot devices.
ng
Aj

Reboot devices: PUT /ISAPI/System/reboot .

5.8 Export Log File

5.8.1 Introduction to the Function
After device fault, you will need to export the detailed running logs of devices to locate the fault and find the cause. Log
files can be exported to the client via network, and to external storage media (USB, mobile HDD, etc.) via the USB
interface.

5.8.2 API Calling Flow

5.8.2.1 Export to Client
1. Export device log files: POST /ISAPI/ContentMgmt/logSearch/dataPackage ; The device will package the stored log
files.
2. Download log files via the URL returned by the device.

5.8.2.2 Export to USB Storage Media

1. Get the capability of exporting log files to USB storage media parameters: GET
/ISAPI/System/exportLogToUSB/capabilities?format=json ; check whether the device supports exporting log
files to USB storage media;
2. Set parameters of exporting log files to USB: PUT /ISAPI/System/exportLogToUSB/mode?format=json ;
3. Get the status of exporting log files to USB: GET /ISAPI/System/exportLogToUSB/status?format=json .

m
5.9 I/O Input

co
a.
5.9.1 Introduction to the Function

C. arc
Configure I/O input parameters of I/O input ports.

5.9.2 API Calling Flow

s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez

1. Check whether the device supports I/O input configuration:

Get device system capabilities: GET /ISAPI/System/capabilities . If the node <IOCap> and sub node
im

<IOInputPortNums> are returned in the response message, the device supports I/O input configuration.
ng
Aj

2. Set I/O input parameters:

Get the input configuration capabilities: GET /ISAPI/System/IO/inputs/capabilities

Set all input parameters: PUT /ISAPI/System/IO/inputs
Get all input parameters: GET /ISAPI/System/IO/inputs
Set parameters of a single input port: PUT /ISAPI/System/IO/inputs/<IOInputID>
Get parameters of a single input port: GET /ISAPI/System/IO/inputs/<IOInputID>
Note: There are two types of input ID <IOInputID> :
Device local I/O: The input ID is the alarm input ID, starting from 1.
I/O of the camera with digital channels: The input ID is the value of input channel No. × 100 + the alarm input
port ID. For example, for digital channel 2 with alarm input port 3, the input ID is 203.
3. Set I/O signal linkage parameters:
Set alarm input event linkage parameters: PUT /ISAPI/Event/triggers/IO-<channelID>
Get alarm input event linkage parameters: GET /ISAPI/Event/triggers/IO-<channelID>
Delete alarm input event linkage parameters: DELETE /ISAPI/Event/triggers/IO-<channelID>

m
4. Set I/O signal arming schedule:

co
Set the arming schedule of alarm inputs for all channels: PUT /ISAPI/Event/schedules/inputs

a.
Get the arming schedule of alarm inputs for all channels: GET /ISAPI/Event/schedules/inputs

C. arc
Set the arming schedule of alarm inputs for a specified channel: PUT

s, em
/ISAPI/Event/schedules/inputs/<alarmInID>

A
no fr
Get the arming schedule of alarm inputs for a specified channel: GET
/ISAPI/Event/schedules/inputs/<alarmInID>

ri on
5. Receive I/O alarm: When I/O input alarm is triggered within the arming schedule, the linked terminal will

Ma oc
response and the device will upload the alarm. The eventType is IO , and inputIOPortID or dynInputIOPortID is
up
valid.
co gr

5.10 Interactive Tools Upgrade Deployment Based on Localization

es a@

5.10.1 Introduction to the Function

Fr rc

This solution applies to the upgrade of devices and sub-devices connected via ISAPI. If the device is connected via ISAPI
y ema

protocols, it is required to set up HTTP(s) service to store device upgrade package and generate URL for downloading
upgrade package. If the device is connected via HCNetSDK, you can implement the device upgrade via transmitting
os fr

ISAPI.
ad on

5.10.2 API Calling Flow

el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Search for the device firmware ID: GET /ISAPI/System/firmwareCodeV2 .

2. Search for the device upgrade information by firmware ID on the SWMS/EZ Cloud, download upgrade package to
local storage, and apply the upgrade task to the device: POST /ISAPI/System/onlineUpgrade/task?format=json .
You can specify to upgrade device (e.g., NVR) or sub-device (e.g., camera) via the node <channel> .
3. During the upgrade, you can get the real-time upgrade progress: GET /ISAPI/System/onlineUpgrade/status .
4. After upgrade is completed, the device will upload the "onlineUpgradeStatus" (upgrade status), and reboot
automatically.
5. After the device rebooting, you can get the latest device version information.
Get the device (e.g., NVR) version information: GET /ISAPI/System/deviceInfo .
Get the sub-device (e.g., IPC) version information: GET /ISAPI/ContentMgmt/InputProxy/channels?security=
<security>&iv=<iv> .

5.11 Management of Devices Access Serial Port

5.11.1 Introduction to the Function
Information management of device accessed the serial are as follows: 1. Configure manufacturer, type, and model
information of the specific serial port access device. 2. Search for the device type or model supported by the specific
serial port.

m
5.11.2 API Calling Flow

co
1. Check whether the device supports information management of devices access the serial port: GET

a.
/ISAPI/System/Serial/capabilities ; If <isSupportDeviceInfo> is returned, it indicates that the device supports
information configuration of devices access the serial port.

C. arc
3. Set the information of devices access the serial port:

s, em
Get the capability of device information parameters of a single serial port: GET

A
/ISAPI/System/Serial/ports/<portID>/deviceInfo?format=json ;

no fr
Get device information parameters access single serial port: GET /ISAPI/System/Serial/ports/<portID>/deviceInfo?

ri on
format=json ;
Set device information parameter of single serial port: PUT /ISAPI/System/Serial/ports/<portID>/deviceInfo?
format=json ;
Ma oc
up
4. Check whether the device supports linking information of devices access the serial port: GET
/ISAPI/System/Serial/capabilities ; If <isSupportSearchDeviceInfoRelations> is returned, it indicates that the
co gr

device supports searching for linked information od devices access the serial port.
es a@

5. Search for linked information of devices access the serial port:

Fr rc

Get the capability of searching for linked parameters of information of devices access a single serial port: GET
/ISAPI/System/Serial/ports/<portID>/searchDeviceInfoRelations/capabilities?format=json ;
y ema

Search for linked parameters of information of devices access a single serial port:POST
/ISAPI/System/Serial/ports/<portID>/searchDeviceInfoRelations?format=json ;
os fr

5.12 Mutually Exclusive Functions

ad on
el .c

5.12.1 Introduction to the Function

Some functions are mutually exclusive due to the device performance (for example, function A and function B cannot
run at the same time, and only one of them is allowed at one time).
en

5.12.2 API Calling Flow

im
ng

The following three APIs are available for getting the mutually exclusive function information:
Aj
Co

1. Get the information of mutually exclusive functions: GET /ISAPI/System/mutexFunction/capabilities?

format=json . You can call this URL to get the list of existing mutually exclusive functions supported by the device.
Note: NVR devices only support setting exlusive function "perimeter" (perimeter protection), and do not support
"linedetection" (line crossing detection), "fielddetection" (intrusion detection), "regionEntrance" (region entrance),
and "regionExiting" (region exiting).
2. Search for the functions that are mutually exclusive with a specified function: POST
/ISAPI/System/mutexFunction?format=json . Based on the list of mutually exclusive functions returned by GET
/ISAPI/System/mutexFunction/capabilities?format=json , you can search for the mutual exclusion status of a
specified function.
3. Get the mutual exclusion information when device function exception occurs: GET
/ISAPI/System/mutexFunctionErrorMsg . After getting the error code, you can call this API to get the current
mutually exclusive functions.
5.13 Platform Upgrade Deployment Based on EZ 2.0
5.13.1 Introduction to the Function
Considering that the device is connected to EZ via EZ 2.0 Protocol, EZ OTA upgrade solution is not supported. This
solution applies to specified version upgrade.

5.13.2 API Calling Flow

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Search for the device firmware ID: GET /ISAPI/System/firmwareCodeV2 .

2. Search for the device upgrade information by its firmware ID. If there is an available new version, apply the
upgrade task to the device: POST /ISAPI/System/onlineUpgrade/task?format=json . You can specify to upgrade
device (e.g., NVR) or sub-device (e.g., IPC) via the node <channel> .
device (e.g., NVR) or sub-device (e.g., IPC) via the node <channel> .
3. During the device upgrade, you can get the real-time upgrade progress on the platform: GET
/ISAPI/System/onlineUpgrade/status .

4. After the device upgrade is finished, the device will upload the "onlineUpgradeStatus" and reboot automatically.
5. After both upgrade and reboot are finished, you can get the latest device version information on the platform.
Get the device (e.g., NVR) version information: GET /ISAPI/System/deviceInfo .
Get the sub-device (e.g., IPC) version information: GET /ISAPI/ContentMgmt/InputProxy/channels?security=

m
<security>&iv=<iv> .

co
5.14 Platform Upgrade Deployment Based on Localization

a.
C. arc
5.14.1 Introduction to the Function
This solution applies to the upgrade of devices and sub-devices connected via ISAPI and ISUP. If via ISAPI, it is required

s, em
to set up HTTP(s) service or transfer binary upgrade package files so as to store device upgrade package and generate

A
URL for downloading upgrade package. If via ISUP, it is required to set up FTP service to store device upgrade package

no fr
and generate URL for downloading upgrade package. If the device is connected via HCNetSDK protocols, you can

ri on
realize device upgrade via transmitting ISAPI.

5.14.2 API Calling Flow

Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr

1. Search for device firmware ID on the platform: GET /ISAPI/System/firmwareCodeV2 .

ad on

2. Search for the device upgrade information in DAC by device firmware ID on the platform. If there is an available
el .c

new version, DAC will trigger an upgrade task and apply it to the device: POST
/ISAPI/System/onlineUpgrade/task?format=json . You can specify to upgrade device (e.g., NVR) or sub-device
ez

(e.g., IPC) via the node <channel> .

3. During the upgrade, you can get the real-time upgrade progress on the platform: GET
im

/ISAPI/System/onlineUpgrade/status .
ng
Aj

4. After the device upgrade is finished, the device will upload the "onlineUpgradeStatus" (upgrade status), and will
Co

reboot automatically.
5. After the upgrade and reboot are finished, you can get the latest device version information on the platform.
Get the device (e.g., NVR) version information: GET /ISAPI/System/deviceInfo .
Get the sub-device (e.g., IPC) version information: GET /ISAPI/ContentMgmt/InputProxy/channels?security=
<security>&iv=<iv> .

5.15 Remote Online Upgrade Based on the WEB Client

5.15.1 Introduction to the Function
This solution applies to remote online upgrade of the devices and sub-devices connected to WEB client.

5.15.2 API Calling Flow

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Get device online upgrade capability: GET /ISAPI/System/onlineUpgrade/capabilities .

2. Manually trigger the device online upgrade inspection: POST /ISAPI/System/onlineUpgrade/PatrolInspection?
format=json . After it is enabled, the device will search for the available new version.

3. During the inspection, the WEB client can get the real-time inspection progress: GET
/ISAPI/System/onlineUpgrade/PatrolInspection/Status?format=json .

4. After the device inspection is finished, search for the device and sub-device upgrade information: GET
/ISAPI/System/onlineUpgrade/SearchDevInfo?format=json .

5. Apply the upgrade task: PUT /ISAPI/System/onlineUpgrade/upgrade?type=<type>&id=<indexID>&channelID =

<channelID> . You can upgrade a specified device via the node <channelID> in the URL. Specify sub-device
upgrade by configuring <type> .
6. You can search for online upgrade status during the upgrade: GET /ISAPI/System/onlineUpgrade/SearchStatus?
format=json .

7. You can cancel the upgrade during the upgrade: PUT /ISAPI/System/onlineUpgrade/CancelUpgrade?
format=json .

8. After the upgrade and reboot are finished, you can get the latest device version information.
Get the device (e.g., NVR) version information: GET /ISAPI/System/deviceInfo .
Get the sub-device (e.g., IPC) version information: GET /ISAPI/ContentMgmt/InputProxy/channels?security=

m
<security>&iv=<iv> .

co
5.16 Serial Port Data Transparent Transmission

a.
C. arc
5.16.1 Introduction to the Function
RS485, RS422 and RS232 serial ports external to the device are used as transparent channels to transmit serial port

s, em
data.

A
no fr
5.16.2 API Calling Flow

ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en

1. Check whether the device supports serial port data transmission:

Get the capability of the device serial port: GET /ISAPI/System/capabilities . If SerialCap is returned and the value is
ng

true, it indicates that the device supports the functions of the serial port.
Aj

2. Set parameters of the transmission channel list:

Get parameters of the specific transmission channel: GET

/ISAPI/System/Serial/ports/<portID>/Transparent/channels/<channelID> ;
Configure parameters of the specific transmission channel: GET
/ISAPI/System/Serial/ports/<portID>/Transparent/channels/<channelID> .
3. Open the transmission channel: PUT
/ISAPI/System/Serial/ports/<portID>/Transparent/channels/<channelID>/open ;
4. Transmit serial port data via transparent channel:
Receive data uploaded by device serial port through transmission channel: GET
/ISAPI/System/Serial/ports/<portID>/Transparent/channels/<channelID>/transData ;
Send data to device serial port through transmission channel: PUT
/ISAPI/System/Serial/ports/<portID>/Transparent/channels/<channelID>/transData ;
5. Close the transmission channel: PUT
/ISAPI/System/Serial/ports/<portID>/Transparent/channels/<channelID>/close ;

5.17 Serial Port Parameter Configuration

5.17.1 Introduction to the Function
Serial port parameter configuration.

5.17.2 API Calling Flow

m
co
1. Check whether the device supports configuring parameters of the serial port:
Get the capability of device serial port: GET /ISAPI/System/capabilities;如果报文返回节点 . If is returned and its value

a.
is true, it indicates that the device supports functions of serial port.

C. arc
3. Get parameters of all serial ports:
Get the capability of all serial ports: GET /ISAPI/System/Serial/capabilities ;

s, em
Get control parameters of all serial ports: GET /ISAPI/System/Serial/ports?permissionController=<indexID> ;

A
no fr
4. Set control parameters of single serial port:
Get control parameters of single serial port: GET /ISAPI/System/Serial/ports/<portID>?permissionController=

ri on
<indexID> ;

Ma oc
Configure control parameters of single serial port: PUT /ISAPI/System/Serial/ports/<portID>?
up
permissionController=<indexID> ;
5. Get the status of single serial port:GET /ISAPI/System/Serial/ports/<portID>/status
co gr
es a@

5.18 User Management

Fr rc

5.18.1 Introduction to the Function

y ema

When the device is activated, you can log in to it via the admin account and corresponding password, and manage users
as needed, including:
os fr

1. Change the password of the admin account. The user name cannot be edited.
2. Add, edit, and delete other users, including the user type, password, user name, and so on. A Non-admin user can
ad on

log in to and operate the device after being created.

el .c

Remarks
ez

1. Common user types:

Administrator ( admin ): has the permission of accessing all resources supported by the device, and can operate
en

all functions of the device. The admin account cannot be deleted.

Operator ( operator ): has the permission to view. Their operation permissions are assigned by admin .
ng

Operator accounts are created by the administrator only.

User ( viewer ): has the permission to view only. They have no operation permission. User accounts are created
Co

by the administrator only.

2. User types related to the installer:
Local Administrator ( localAdmin ) : Activated by the device owner on the local software side (e.g., WEB) that
accompanies the device. By default, a localAdmin has the permission to access the device and perform all
functions supported by the device.
Local Installer ( localInstaller ) : Activated by localAdmin . The identity can be given to the installer for device
installation and debugging on site. By default, a localInstaller has the permission to access and perform all
functions supported by the device.
Local Operator ( localOperator ) : Created by localAdmin or cloudAdmin . A password is required to be set by
localAdmin , cloudAdmin , localInstaller , installerAdmin , or installerEmployee before the local operator
can log in via the local keypad. A local operator’s business functions are limited, and cannot configure device
parameters. By default, only arming, disarming (including alarm clearing), and relay control operations are
allowed. According to the actual business needs, there can be two types of local operator: one-time local
operator (can only log in once and the identity will expire after logging out), and temporary local operator (can
log in within the validity period), both created by localAdmin or cloudAdmin .
Cloud Administrator ( cloudAdmin ) : Created by the device owner in the mobile software that accompanies the
device (e.g. HC over the cloud) and then synchronized to the device. By default, a CloudAdmin has the
permission to access and perform all functions supported by the device.
Cloud Operator ( cloudOperator ) : Created by cloudAdmin in the mobile software that accompanies the device
(e.g. HC over the cloud) and then synchronized to the device for ordinary mobile users. A cloud operator’s
business functions are limited, and cannot configure device parameters, access and view the device,

m
arm/disarm (including alarm clearing), or operate relays.

co
Installer Administrator ( installerAdmin ) : User on the installer business application, created on the business

a.
platform (e.g. HPC deployed in the cloud) and then synchronized to the device for remote device management
by the business platform’s admin. By default, an installerAdmin has the permission to access the device and

C. arc
perform all functions supported by the device. To facilitate installation management, when the business
platform sets installerAdmin as the highest authority and synchronizes to the device, installerAdmin is

s, em
allowed to modify user permissions of localAdmin and cloudAdmin .

A
Installer Employee ( installerEmployee ) : User on the installer business application, created on the business

no fr
platform (e.g. HPC deployed in the cloud) and then synchronized to the device for the employees on the

ri on
business platform to remotely install and debug the device. By default, an installerEmployee has the
permission to access the device and perform all functions supported by the device.
3. User password:
Ma oc
up
To ensure the security of account information, it is recommended to create a password using eight to sixteen
characters, including at least two kinds of the following categories: digits, lower case letters, upper case letters,
co gr

and special characters, and the user name is not allowed in the password.
es a@

Risky passwords include the following categories: less than 8 characters, containing only one type of
characters, same as the user name or reversed user name. To protect user data privacy and improve security,
Fr rc

it is recommended to use a strong password.

y ema

The password strength rule is as follows:

a. Strong password: including at least three kinds of the categories (digits, lower case letters, upper case
os fr

letters, and special characters).

b. Medium password: a combination of digits and special characters, lower case letters and special
ad on

characters, upper case letters and special characters, or lower case letters and upper case letters.
el .c

c. Weak password: a combination of digits and lower case letters or digits and upper case letters.
ez

5.18.2 API Calling Flow

1. Get the user management capability of devices on the client: GET

/ISAPI/Security/users/<indexID>/capabilities .
ng
Aj

2. Add device users on the client: POST /ISAPI/Security/users?security=<security>&iv=<iv> .

Remarks:
Only admin can create other types of users, and creating users requires login password verification
( <loginPassword> ) of admin .
If the user account is inactivated, it's required to log in to the account and change the user password ( PUT
/ISAPI/Security/users/<indexID>?security=<security>&iv=<iv> ). The account is activated when the
password is changed.
When the account is inactivated, it's not allowed to perform any operations except changing the user
password. Otherwise, an error ( 0x0020000f ) will be returned.
3. Edit the user information on the client: PUT /ISAPI/Security/users/<indexID>?security=<security>&iv=<iv> .
Remarks:
It requires password verification of admin when admin changes the user password. The account turns
inactivated when the user password is changed by admin . Once logging out, the user needs to change the
password first before the next login.
When non-admin users changed their passwords, the account remains activated.
4. Delete users on the client: DELETE /ISAPI/Security/users?loginPassword=<loginPassword>&security=
<security>&iv=<iv> .

Remarks:
Only admin can delete users, and deleting users requires login password verification of admin .

m
co
5. Get the user information, including user name, activation status ( <userActivationStatus> ), and so on.

a.
Get a single user information: GET /ISAPI/Security/users/<indexID>?security=<security>&iv=<iv> .

C. arc
Get the information of all users: GET /ISAPI/Security/users?security=<security>&iv=<iv> .
Get the information of online users: GET /ISAPI/Security/onlineUser . Online users refer to users who have

s, em
logged in to the device. The information such as user name, user type, and IP address can be obtained.

A
no fr
Remarks:

ri on
If multiple attempts of admin login password verification failed in the process of adding, editing, or deleting users,
the admin will be locked. The remaining attempts are defined by the field retryTimes in the response message.

Ma oc
The new password cannot be the same as the last password. Otherwise, an error ( 0x400010E8 ) will be returned.
up
5.18.3 Exception Handling
co gr

Error Code
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
statusCode statusString subStatusCode errorCode errorMsg Description
The account
Invalid
4 theAccountIsNotActivated 0x0020000f is not
Operation
activated.
Incorrect
Invalid
4 loginPasswordError 0x4000000C login
Operation
password.

m
The answer

co
to the user Please set a
Invalid
4 theAnswerToTheUserSecurityQuestionIsDuplicate 0x4000A0B6 security different

a.
Operation
question is answer.

C. arc
duplicate.
The answer

s, em
to the user Please set a
Invalid

A
4 theAnswerToTheUserSecurityQuestionIsTooShort 0x4000A0B7 security longer

no fr
Operation
question is answer.

ri on
too short.

Ma oc
New
password Please set a
up
Invalid
4 cannotSameAsOldPassword 0x400010E8 cannot be the different
Operation
co gr

same as the password.

old one.
es a@

Please enter
Fr rc

the correct
password. If
y ema

Incorrect you forgot

Invalid
6 administratorPasswordError 0x60000042 administrator the
os fr

Content
password. password,
you can
ad on

reset the
el .c

password.
ez
en

5.19 User Types Related to the Installer (supported by the security

control panel)
im
ng

For different application scenarios, e.g., local environment, cloud environment, and HPP installer environment, users
Aj

related to the installer can be classified into seven types: localAdmin , localInstaller , localOperator , cloudAdmin ,
Co

installerAdmin , installEmployee , and cloudOperator .

5.19.1 Create the User

5.19.1.1 Local Environment
In a local environment (LAN), three types of users are involved: localAdmin , localInstaller , and localOperator . By
default, two types of users exist on the device: localAdmin and localInstaller , but localInstaller is not enabled,
which means that although a user ID is created, but the user cannot log in as localInstaller before the user type is
enabled by localAdmin . localOperator is created by localAdmin , and can only log in via local keypad. Users who have
been set with the keypad password can log in via keypad.
m
co
a.
C. arc
s, em
A
no fr
ri on
5.19.1.2 Cloud Environment

Ma oc
In a cloud environment, four types of users are involved: cloudAdmin , cloudOperator , localInstaller , and
localOperator . After logging in to the device on HC application via cloud, a cloudAdmin can be created. Then, the
up
cloudAdmin can share the device to create a cloudOperator . Note that after a cloudAdmin is created, the existing
co gr

localAdmin will expire. Users who have been set with the keypad password can log via keypad.
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

5.19.1.3 HPP Installer Environment

In an HPP installer environment, five types of users are involved: cloudAdmin , cloudOperator , localOperator ,
installerAdmin , and installerEmployee . After a device is added to HPC, the user adding protocol will be applied, and
installerAdmin and installerEmployee can be created (batch creating is supported). Note that after an
installerAdmin is created, the existing localInstaller will expire. Users who have been set with the keypad
password can log via keypad.
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@

5.19.2 User Permissions

Fr rc

s
y ema

User Type / Local Local Cloud Cloud Installer Installer

Local Operator
Permission Admin Installer Admin Operator Admin Employee
os fr

Arming √ √ √ √ √ √ √
ad on

Disarming (Alarm
√ √ √ √ √ √ √
Clearing)
el .c

Bypass √ √ × √ √ √ √
ez

View logs and

√ √ × √ √ √ √
status
im

Configure
ng

√ √ × √ × √ √
Aj

parameters
Co

Manage partitions √ √ × √ × √ √
one-time local operator:
Operate relays √ √ × temporary local √ √ √ √
operator: √
Edit localAdmin's
√ √ × × × √ √
keypad password
Edit cloudAdmin's
× √ × √ × √ √
keypad password
Edit localInstaller's
× √ × × × × ×
keypad password
Edit
Edit
installerAdmin's × × × × × √ ×
keypad password
√ (only the
Edit
employee's
installerEmployee's × × × × × √
own
keypad password
password)
Edit
localOperator's √ √ × √ × √ √

m
keypad password

co
Edit √ (only the

a.
cloudOperator's × √ × √ operator's own √ √

C. arc
keypad password password)
Edit localAdmin's
× × × × × × ×

s, em
permission

A
no fr
Edit cloudAdmin's
× × × × × × ×
permission

ri on
Edit localInstaller's

Ma oc
√ × × √ × × ×
permission
up
Edit
co gr

installerAdmin's √ × × √ × × ×
permission
es a@

Edit
Fr rc

installerEmployee's √ × × √ × × ×
permission
y ema

Edit
os fr

localOperator's √ √ × √ × √ √
permission
ad on

Edit
el .c

cloudOperator's × √ × √ × √ √
permission
ez
en

Note: "Configure parameters" includes parameters of zones, sounders, keypads, card readers, keyfobs, cards, relays,
repeaters, transmitters, network cameras, partitions, and so on.
im
ng

5.19.3 Manage User Information

Aj
Co

5.19.3.1 Local User

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr

1. Get the configuration capability of a specific user: GET /ISAPI/Security/users//capabilities

2. (Optional) Add a user: POST /ISAPI/Security/users?security=&iv=. The nodes userName, password,
ad on

keypadPassword, and loginPassword in the message will be encrypted.

el .c

3. Get information of all users: GET /ISAPI/Security/users?security=&iv=. The nodes phoneNum, emailAddress,
password, duressPassword, keypadPassword, and loginPassword in the message will be encrypted.
ez

4. Get information of a single user: GET /ISAPI/Security/users/?security=&iv=. The index in the URL is the user ID.
en

5. Set permissions for a single user: PUT /ISAPI/Security/users/?security=&iv=. The index in the URL is the user ID.
im

6. (Optional) Set information of all users: PUT /ISAPI/Security/users?security=&iv=. This API can be called for batch
ng

configuring user information.

7. (Optional) Delete a single user: DELETE /ISAPI/Security/users/?loginPassword=&security=&iv=. Delete the user by

indexID, and loginPassword is required for deleting the user. The loginPassword should be encrypted.
8. (Optional) Delete all users: DELETE /ISAPI/Security/users?loginPassword=&security=&iv=. loginPassword should
be encrypted.

5.19.3.2 Cloud User

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Check whether the device supports cloud user management: GET /SDK/capabilities. If the node value of
isSupportCloudUserManage is true, cloud user management is supported in these URLs:
/ISAPI/Security/CloudUserManage/users/capabilities?format=json
/ISAPI/Security/CloudUserManage/users/?format=json
/ISAPI/Security/CloudUserManage/users?format=json
2. Get the capability of cloud user management: GET /ISAPI/Security/CloudUserManage/users/capabilities?
format=json. If the node value of isSupportAddCloudUserList is true, it supports batch adding cloud users.
3. Add a single cloud user: POST /ISAPI/Security/CloudUserManage/users?format=json. The following cloud users
need to create the user accounts on their own: coludAdmin, installerAdmin, installerEmployee, and cloudOperator,
which is different from localOperator who needs to be created by admin users. Enter information such as user
name, password, e-mail, and phone number to create a user account and put into use.
name, password, e-mail, and phone number to create a user account and put into use.
4. (Optional) Add cloud users in a batch: POST /ISAPI/Security/CloudUserManage/usersBatch?format=json. For
installerEmployee users that has been created on HPC, use this URL to apply them to the device and synchronize
user information.
5. Get information of all cloud users: GET /ISAPI/Security/CloudUserManage/users?format=json
6. Get information of a single cloud user: GET /ISAPI/Security/CloudUserManage/users/?format=json
7. Search for information of a single cloud user (by type): /ISAPI/Security/CloudUserManage/users/byType?

m
format=json. Support searching by e-mail, phone number, and user name.

co
a.
8. Set information of a single cloud user: PUT /ISAPI/Security/CloudUserManage/users/?format=json

C. arc
9. Delete a single cloud user: DELETE /ISAPI/Security/CloudUserManage/users/?format=json. Delete the user by
specifying the user's indexID.

s, em
10. Delete cloud users in a batch: PUT /ISAPI/Security/CloudUserManage/users/delete?format=json. Support batch

A
deleting by user names, user types, phone numbers, and e-mails.

no fr
ri on
5.19.4 Manage User Permissions

Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Check whether the device supports configuring permissions of a specific type of users: GET
/ISAPI/Security/capabilities?username=. If the node value of isSupportInstallerCap is true, the installer users'
permissions can be configured. There is no specific capability node for operator type users, and by default their
permissions can be configured.
2. Get the default permission capabilities of a specific type of users.
For installer users: GET /ISAPI/Security/UserPermission/installer/capabilities?format=json
For operator users: GET /ISAPI/Security/UserPermission/operatorCap
3. Get user permissions of all users: GET /ISAPI/Security/UserPermission
4. (Optional) Get user permissions of a single user: GET /ISAPI/Security/UserPermission/. The index in the URL is the
user ID.
5. Set user permissions of a single user: PUT /ISAPI/Security/UserPermission/
6. (Optional) Set user permissions of all users: PUT /ISAPI/Security/UserPermission

m
6 Network Configuration

co
a.
6.1 ISUP Multi-Center Management

C. arc
6.1.1 Introduction to the Function

s, em
When connected to the IoT, a device may be simultaneously connected to multiple centers. For example, the device may

A
no fr
be connected to a third-party business center and a device maintenance management center simultaneously as shown
in the figure below.

ri on
Note: A center is different from a platform. A center may contain more than one platform.

Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj

In pull mode, the center logs in to the device if the device is connected to the center via protocols like ISAPI, device
Co

network SDK, etc.

In push mode, the device registers to access the center if the device is connected to the center via EZ cloud, ISUP, etc
Here we mainly illustrate the integration process of connecting devices to ISUP multi-center via ISAPI.

6.1.2 API Calling Flow

6.1.2.1 Flow Example
The flow of the ISUP multi-center is as follows.
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr

6.1.2.2 CMS Address Configuration

es a@

Configure the address of CMS1 and CMS2 in ISUP multi-center via ISAPI.
Fr rc

1. Check whether the device supports ISUP: GET /ISAPI/System/Network/capabilities . If the node
y ema

isSupportCaptureFingerPrint is returned and its value is true, it indicates that the device supports ISUP.
2. Check whether the device supports multiple ISUP centers: GET /ISAPI/System/Network/Ehome/capabilities . If
os fr

the node ISUPID is returned, it indicates that the device supports multiple ISUP centers.
ad on

3. Configure the address of multiple ISUP centers: [GET/PUT] /ISAPI/System/Network/Ehome/<ISUPID> .

el .c

Note:
ez

ISUPID represents the ID of CMS 1 and CMS 2, and it is required to configure the address of each CMS respectively.
en

6.1.2.3 AMS Address Configuration

After the address configuration of CMS 1 and CMS 2 is finished and the device is connected to CMS 1 and
ng

CMS 2 via ISUP, configure the AMS address for CMS 1 and CMS 2 respectively via ISUP.
Aj

1. Call GET /ISAPI/Event/notification/httpHosts to get all configured HTTP/HTTPS listening center addresses and
Co

their AMS addresses via the corresponding communication link with the CMS.
Example:
(1) id=1 represents the AMS 1 address of the CMS 1 (the protocolType is EHome), id=2 represents the AMS 2 address
of the CMS 2 (the protocolType is EHome), and id=3 represents the address of HTTP listening center (protocolType is
HTTP).
(2) When the CMS 1 requests to get the address information, the device will return the AMS 1 address of the CMS 1
and the address of HTTP listening center.
(3) When the CMS 2 requests to get the address information, the device will return the AMS 2 address of the CMS 2
and the address of HTTP listening center.
2. For the obtained address list:
(1) If an AMS address already exists (the protocolType contains EHome), call PUT
/ISAPI/Event/notification/httpHosts/<ID> to edit the AMS address.
(2) If an AMS address does not exist (the protocolType does not contain EHome), call
POST /ISAPI/Event/notification/httpHosts to create an AMS address.
3. Connect the device to the AMS.
Note:
(1) When calling the API ( DELETE /ISAPI/Event/notification/httpHosts ) via ISAPI, delete the HTTP/HTTPS center
only and do not perform any operations on the ISUP AMS center.

m
co
(2) When calling the API ( PUT /ISAPI/Event/notification/httpHosts ) via ISUP, if there are two or above AMS
addresses (protocolType is EHome) in the list, it indicates that a parameter configuration error occurs and the API will

a.
report the error.

C. arc
(3) When calling the API ( PUT /ISAPI/Event/notification/httpHosts/<ID> ) via ISUP, and the protocolType is EHome,
the returned represents the AMS address of corresponding link.

s, em
6.1.2.4 Get ISUP Information

A
no fr
Get the CMS and AMS address for the device to access the ISUP multi-center via ISAPI.

ri on
1. Check whether the device supports getting ISUP information: GET /ISAPI/System/Network/Ehome/capabilities .
If isSupportISUPServerInfo is returned and its value is true, it indicates that the device supports getting ISUP
information.
Ma oc
up
2. Get ISUP information (including the address list of the configured CMS and AMS): GET
co gr

/ISAPI/System/Network/ISUPServerInfo?format=json .
es a@

6.1.3 Message Format and Example

Fr rc

URL: /ISAPI/System/Network/ISUPServerInfo?format=json .
y ema

Method: GET .
Message Example:
os fr

{
ad on

"ISUPServerInfoList":[{
"ID":1, //req, int, ID, range:[1,2]
"enabled":true, //req, boolean, whether it is enabled
el .c

"CMSInfo":{
"addressingFormatType":"ipaddress", //opt, string, address type: ("ipaddress, "hostname")
"hostName":"", //opt, string, domain name（it is valid when the addressingFormatType is hostname）
ez

"ipV4Address":"", //opt, string, IPv4 address（it is valid when the addressingFormatType is ipaddress）
"ipV6Address":"", //opt, string, IPv6 address（it is valid when the addressingFormatType is ipaddress）
en

"portNo":1, //opt, integer, port No., range:[0,65535]

"deviceID":"", //opt, string, device ID, range:[1,64]
"protocolVersion":"v5.0" //opt, string, protocol version（"v2.0"-v2.0 version, "v2.6"-v2.6 version, "v4.0"-v4.0 version, "v5.0"-v5.0 version）
im

},
"AMSInfo":{
ng

"addressingFormatType":"ipaddress", //opt, string, address type: ("ipaddress, "hostname")

"hostName":"", //opt, string, domain name（it is valid when the addressingFormatType is hostname）
"ipV4Address":"", //opt, string, IPv4 address（it is valid when the addressingFormatType is ipaddress）
Co

"ipV6Address":"", //opt, string, IPv6 address（it is valid when the addressingFormatType is ipaddress）
"portNo":1 //opt, integer, port No., range:[0,65535]
}
}]
}

6.2 Listening Service

6.2.1 Introduction to the Function
When an event occurs, the device creates connection with the client and uploads alarm information. Meanwhile, the
listening host receives data from the device. The IP address and the port No. of the listening host should be configured
for the device. The HTTP listening service supports subscribing to specific events when adding or editing the listening
host. Only the specified events will be uploaded by the device.(currently not available for the device)
Aj
im
Co en
ng ez

6.2.2.1 Listening Service

6.2.2 API Calling Flow
el .c
ad on
os fr
y ema
Fr rc
es a@
co gr
s up
Ma oc
ri on
no fr
s, em
C. arc
A a.
co
m
1. Check whether the device supports configuring listening host parameters:
Get the configuration capability of the listening host: GET /ISAPI/Event/notification/httpHosts/capabilities .
If the node <HttpHostNotificationCap> exists in the returned message and its value is true, it indicates that the
device supports configuring listening host parameters.
2. Configure the parameters of the listening host:
Configure the parameters of all listening hosts: PUT /ISAPI/Event/notification/httpHosts?security=
<security>&iv=<iv> ;

m
co
Get the parameters of all listening hosts: GET /ISAPI/Event/notification/httpHosts?security=<security>&iv=
<iv> ;

a.
Configure the parameters of a listening host: PUT /ISAPI/Event/notification/httpHosts/<hostID>?security=

C. arc
<security>&iv=<iv> ;

Get the parameters of a listening host: GET /ISAPI/Event/notification/httpHosts/<hostID>?security=

s, em
<security>&iv=<iv> ;

A
no fr
3. Enable the listening service:

ri on
The user needs to enable the listening service of the listening host.

Ma oc
4. (Optional) Test the listening service:
up
The platform applies the command to the device to test whether the listening host is available for the device: POST
co gr

/ISAPI/Event/notification/httpHosts/<hostID>/test .
es a@

5. The listening host receives event information from the device:

Fr rc

When an event occurs, the device creates connection with the client and uploads alarm information. Meanwhile,
y ema

the listening host receives data from the device. See details in Event Message Grammar.
Remark: You can also configure the listening parameters such as the timeout.
os fr

6.2.2.2 Event Message Grammar

ad on

When an event occurs or an alarm is triggered, the event/alarm information can be with binary data (such as pictures)
el .c

and without binary data.

1. Without Binary Data:

The Content-Type in the Headers of the HTTP request sent by the device is usually application/xml or
application/json as follows:
im

Alarm Message Sent by the Device

ng
Aj
Co

POST Request_URI HTTP/1.1

Host: data_gateway_ip:port 
Accept-Language: zh-cn
Date: YourDate
Content-Type: application/xml; 
Content-Length: text_length
Connection: keep-alive

Response by the Listening Host

HTTP/1.1 200 OK
Date: YourDate
Connection: close

2. With Binary Data

The format of the data sent by the device is HTTP form (multipart/form-data). The Content-Type in the Headers of the
HTTP request sent by the device is usually multipart/form-data, boundary=<frontier> : boundary is a variable, which
is used to divide the HTTP Body into multiple units and each unit has its Headers and Body. See details in RFC 1867
(Form-based File Upload in HTML). Please note the -- before and after the boundary.
Alarm Message Sent by the Device

POST Request_URI HTTP/1.1

Host: device_ip:port 
Accept-Language: zh-cn
Date: YourDate
Content-Type: multipart/form-data;boundary=<frontier>

m
Content-Length: text_length

co
Connection: keep-alive

--<frontier>

a.
Content-Disposition: form-data; name="Event_Type"
Content-Type: text/xml

C. arc
<EventNotificationAlert/>
--<frontier>
Content-Disposition: form-data; name="Picture_Name"
Content-Length: image_length

s, em
Content-Type: image/jpeg

A
no fr
[picture data]
--<frontier>--

ri on
Response by the Listening Host

HTTP/1.1 200 OK
Ma oc
up
Date: YourDate
Connection: close
co gr

Here are the descriptions of the main keywords.

es a@

keyword example description

Fr rc

multipart/form-data;
y ema

Content-Type Content type, multipart/form-data refers to data in form format.

boundary=frontier
os fr

Separator of the form message. A form message starts with --boundary

boundary frontier
and ends with --boundary--.
ad on

Content- form-data;
el .c

Content description. form-data refers to data in the form format.

Disposition name="Picture_Name";
ez

filename "Picture_Name" File name. The file refers to the form message.
en

Content- Content length. The length of the content which starts from \r\n to the
10
Length next --boundary.
im
ng
Aj

6.2.3 Exception Handling

6.2.3.1 Error Codes

statusCode statusString subStatusCode errorCode errorMsg Description Remarks
Invalid Event subscription is not
6 eventNotSupport 0x60001024
Content supported.

6.3 Wi-Fi Network Management

6.3.1 Introduction to the Function
The user can plug a network cable into a wireless router and sets the working mode of the router as AP mode to enable
Wi-Fi. The device under Wi-Fi network management is used as the AP to provide a wireless network for the Station. It
can provide functions include wireless server information management of internet APIs and device list information
accessed by the wireless server.

6.3.2 API Calling Flow

1. Wi-Fi parameter configuration:
Check whether the device supports configuring Wi-Fi parameters: GET /ISAPI/System/capabilities ; if the node is
returned and its value is true, it means the device supports wireless network and Wi-Fi parameter configuration.
Get the capability of configuring Wi-Fi parameters: GET
/ISAPI/System/Network/interfaces/<interfaceID>/wireless/capabilities ;

m
Get Wi-Fi parameters: GET /ISAPI/System/Network/interfaces/<interfaceID>/wireless ;

co
Configure Wi-Fi parameters: PUT /ISAPI/System/Network/interfaces/<interfaceID>/wireless ;

a.
Get Wi-Fi quality parameters: GET /ISAPI/System/Network/wifiQuality?format=json ;

C. arc
2. Wi-Fi area parameter configuration:
Check whether the device supports Wi-Fi area parameters: GET /ISAPI/System/capabilities ; if

s, em
<isSupportWifiRegion> is returned and its value is true, it indicates that device supports Wi-Fi area configuration.

A
Get the capability of configuring Wi-Fi area parameters: GET

no fr
/ISAPI/System/Network/wirelessServer/Region/Capabilities ;

ri on
Get Wi-Fi area parameters: GET /ISAPI/System/Network/wirelessServer/Region ;

Ma oc
Configure Wi-Fi area parameters: PUT /ISAPI/System/Network/wirelessServer/Region ;
3. Wi-Fi connection parameters:
up
Get the capability of configuring Wi-Fi connection parameters:GET
co gr

/ISAPI/System/Network/interfaces/<interfaceID>/wirelessStatus/capabilities ;
es a@

Get Wi-Fi connection parameters of single network interface: GET

/ISAPI/System/Network/interfaces/<interfaceID>/wirelessStatus ;
Fr rc

Configure Wi-Fi connection parameters of single network interface: PUT

y ema

/ISAPI/System/Network/interfaces/<interfaceID>/wirelessStatus ;
Get Wi-Fi connection status of single network interface: GET
os fr

/ISAPI/System/Network/interfaces/<interfaceID>/wireless/connectStatus ;
ad on

4. Wi-Fi transmission status:

el .c

Get Wi-Fi transmission status of single network interface: GET

/ISAPI/System/Network/interfaces/<interfaceID>/wireless/transmission/capabilities ;
ez

Get Wi-Fi transmission status of single network interface: GET

/ISAPI/System/Network/interfaces/<interfaceID>/wireless/transmission ;
Get the Wi-Fi transmission status of the specific network interface: GET
im

/ISAPI/System/Network/interfaces/<interfaceID>/wireless/transmission/<indexID> ;
ng
Aj

Get Wi-Fi transmission status of all network interfaces:GET

/ISAPI/System/Network/interfaces/<interfaceID>/wireless/transmissionList ;

7 Video (General)
7.1 . Compression of Stream Transcoding
7.1.1 Introduction to the Function
When a device is deployed in a single network access point and needs to access the platform through the mobile
network, the uplink network bandwidth of the device will be insufficient, which cannot meet the requirement of high-
definition live view. The above problem can be solved via stream transcoding. The bit rate of network transmitted video
stream is reduced to improve the resolution of the video stream, so as to achieve the high-definition live view.
7.1.2 API Calling Flow
1. Check whether the device supports compression configurations of stream transcoding: GET
/ISAPI/System/capabilities . If the field isSupportCompressedTranscode is returned and its value is true , it
indicates that the function is supported.
2. Get the capability of compression parameters of stream transcoding for a specified channel: GET
/ISAPI/Streaming/channels/<channelID>/TranscodeCfg/capabilities?format=json .

3. Get the compression parameters of stream transcoding for a specified channel: GET

m
/ISAPI/Streaming/channels/<channelID>/TranscodeCfg?format=json .

co
4. Set the compression parameters of stream transcoding for a specified channel: PUT

a.
/ISAPI/Streaming/channels/<channelID>/TranscodeCfg?format=json .

C. arc
Remarks:
The transcoding compression parameters of the live view stream and the playback stream can be different.

s, em
The compression parameters configuration of stream transcoding has no influence on encoding parameters

A
no fr
of normal videos/audios.

ri on
7.2 . OSD
7.2.1 Introduction to the Function
Ma oc
up
On-screen display is applied in the display interface of cameras, and is used to display some characters or graphics on
co gr

the video to provide some information to the audience. After OSD configurations on the client software, the configured
information text will be overlaid on the video stream of cameras and displayed on the screen.
es a@

The typical application scenarios of dynamic OSD: elevator floor number overlay for elevator monitoring, characters
Fr rc

overlay for toll stations on highway/road, notification information overlay during live video programs. The typical
application scenarios of static OSD: fixed information (such as camera position, date, time) overlay on the video signal.
y ema

7.2.2 API Calling Flow

os fr

7.2.2.1 OSD
ad on

1. The client software gets the OSD capability of a specified channel: GET
el .c

/ISAPI/System/Video/inputs/channels/<channelID>/overlays/capabilities .
ez

2. The client software configures OSD parameters, including whether to enable OSD, custom text overlay, time
overlay, and overlay format, for a specified channel.
en

Get: GET /ISAPI/System/Video/inputs/channels/<channelID>/overlays .

im
ng
Aj

Set: PUT /ISAPI/System/Video/inputs/channels/<channelID>/overlays .

Remarks:
The configuration URL supports various parameters, including custom text overlay, channel name overlay,
time overlay, overlay format, and so on. Some of these parameters can also be configured by other URLs, as
shown below: TextOverlayList can also be configured via URL of custom text overlay.
channelNameOverlay can also be configured via URL of channel name overlay.

DateTimeOverlay can also be configured via URL of channel time overlay.

The overlaid information alignment mode (defined by alignment ) refers to the alignment mode of custom
text:
customize : custom mode. The client software sends the overlay position coordinates of custom text to the
device, and the device will overlay the characters on the stream for display according to the position
coordinates.
alignRight : right align. The device will display custom text on the right boundary of screen.

alignLeft : left align. The device will display custom text on the left boundary of screen.

allRight : all right align. The device will display all overlay contents, including custom text, the channel name,
the time on the right boundary of screen.
allLeft ：all left align. The device will display all overlay contents, including custom text, the channel name,
the time on the left boundary of screen.

m
co
7.2.2.2 Custom Text Overlay

a.
1. The client software gets the OSD capability of a specified channel: GET

C. arc
/ISAPI/System/Video/inputs/channels/<channelID>/overlays/capabilities . If TextOverlayList is returned, it
indicates that custom text overlay is supported and size defines the maximum number of custom texts.

s, em
2. The client software configures custom text OSD. textID refers to the custom text No., and the value range is: [1,

A
no fr
size ]:

ri on
Create a custom text for a specified channel: POST
/ISAPI/System/Video/inputs/channels/<channelID>/overlays/text .

Ma oc
Get overlay parameters of a custom text for a specified channel: GET
up
/ISAPI/System/Video/inputs/channels/<channelID>/overlays/text/<textID> .
co gr

Set overlay parameters of a custom text for a specified channel: PUT

es a@

/ISAPI/System/Video/inputs/channels/<channelID>/overlays/text/<textID> .
Fr rc

Delete a custom text: DELETE /ISAPI/System/Video/inputs/channels/<channelID>/overlays/text/<textID> .

y ema

Get overlay parameters of all custom texts for a specified channel: GET
/ISAPI/System/Video/inputs/channels/<channelID>/overlays/text .
os fr

Set overlay parameters of all custom texts for a specified channel: PUT
ad on

/ISAPI/System/Video/inputs/channels/<channelID>/overlays/text .
el .c

Delete all custom texts for a specified channel: DELETE

/ISAPI/System/Video/inputs/channels/<channelID>/overlays/text .
ez

7.2.2.3 Channel Name Overlay

1. The client software gets the OSD capability of a specified channel: GET
im

/ISAPI/System/Video/inputs/channels/<channelID>/overlays/capabilities . If channelNameOverlay is
ng
Aj

returned, it indicates that channel name overlay is supported.

2. The client software configures the channel name overlay, including whether to enable channel name overlay,
overlay position, and so on.
Get channel name overlay parameters: GET
/ISAPI/System/Video/inputs/channels/<channelID>/overlays/channelNameOverlay .

Set channel name overlay parameters: PUT

/ISAPI/System/Video/inputs/channels/<channelID>/overlays/channelNameOverlay .

7.2.2.4 Channel Time Overlay

1. The client software gets the OSD capability of a specified channel: GET
/ISAPI/System/Video/inputs/channels/<channelID>/overlays/capabilities . If DateTimeOverlay is returned, it
indicates that channel time overlay is supported.
2. The client software configures the channel time overlay, including whether to enable channel time overlay, overlay
position, date format, and so on.
Get channel time overlay parameters: GET
/ISAPI/System/Video/inputs/channels/<channelID>/overlays/dateTimeOverlay .

Set channel time overlay parameters: PUT

/ISAPI/System/Video/inputs/channels/<channelID>/overlays/dateTimeOverlay .

7.3 Configuration of Video Encoding Service Plan

m
co
7.3.1 Introduction to the Function

a.
The existing video encoding parameters are complicated to some degree, and might not be user-friendly. Users' main
focus is on image quality and the required storage capacity. Therefore, video encoding service plan is introduced to

C. arc
facilitate user configuration by organizing the parameters into different plans. If you configure a plan, the previous
manual configurations will be overwritten. If you keep the previous manual configurations, they will be recognized as in

s, em
a custom plan.

A
no fr
7.3.2 API Calling Flow

ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Get the encoding parameter capability of a specific channel: GET

/ISAPI/Streaming/channels/<trackStreamID>/capabilities
2. Get the parameter capability of video encoding service plan: GET
/ISAPI/Streaming/channels/<channelID>/VideoCodeMealParams/capabilities?format=json
3. (Optional) Set video encoding service plan parameters: PUT
/ISAPI/Streaming/channels/<channelID>/VideoCodeMealParams?format=json . The client can select a service
plan. The parameters in the plans cannot be edited, except the custom plan.
4. Set the encoding parameters of a specific channel: PUT /ISAPI/Streaming/channels/<trackStreamID> . The
parameters in the custom plan can be edited.
Note:
Get the parameter content of the current video encoding service plan:
Get the parameters of the video encoding service plan: POST
/ISAPI/Streaming/channels/<channelID>/SearchVideoCodeMealParams?format=json .

Get the capability of getting video encoding service plan parameters: GET
/ISAPI/Streaming/channels/<channelID>/SearchVideoCodeMealParams/capabilities?format=json .

Restore to the default parameters: PUT /ISAPI/Streaming/RestoreDefaultParam?format=json . The parameters can be

restored to default in custom plan.

m
co
8 Facial Recognition

a.
8.1 Face Picture Library Management

C. arc
8.1.1 Face Picture Library Management

s, em
A
8.1.1.1 Introduction to the Function

no fr
This function is mainly used to manage operations on face picture libraries on the device, such as adding, deleting,

ri on
editing, or searching for the face picture libraries, importing face pictures and additional person information to the
libraries, editing, deleting, or searching for face pictures and additional person information in the libraries, and face
Ma oc
picture modeling. This function is also the prerequisite of other face picture library functions such as face picture library
up
comparison.
co gr

8.1.1.2 API Calling Flow

es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on

1. Get the capability of managing face picture libraries for checking functions supported by the device: GET
el .c

/ISAPI/Intelligent/FDLib/capabilities .
ez

2. Manage face picture libraries.

i. Create a face picture library: POST /ISAPI/Intelligent/FDLib . After the face picture library is created, the
im

device will automatically generate the face picture library ID (that is, FDID is returned in the message
ng

< FDLibInfoList >). If you need to manage the face picture library ID by yourself, you can configure the
Aj

custom face picture library ID ( customFaceLibID ) in the request message < CreateFDLibList > as needed.
Co

Afterwards, you can perform operations on the face picture library by the custom ID instead of FDID .
ii. Edit parameters of the face picture library: PUT /ISAPI/Intelligent/FDLib/<FDID> . If you have added the
custom face picture library ID in the above steps, you can also call PUT
/ISAPI/Intelligent/FDLib/<customFaceLibID>?FDType=custom to configure parameters using
customFaceLibID .

iii. Get parameters of the face picture library: GET /ISAPI/Intelligent/FDLib/<FDID> . Operations involved with
the custom face picture library ID are the same as those mentioned above.
iv. Delete the face picture library: DELETE /ISAPI/Intelligent/FDLib/<FDID> . Operations involved with the
custom face picture library ID are the same as those mentioned above.
3. Import data of the face picture library.
i. Import face picture data and automatically perform modeling, POST
/ISAPI/Intelligent/FDLib/pictureUpload . By repeatedly applying the previous API, you can import the face
picture data (including the face picture and additional face picture information FaceAppendData ) to the
corresponding face picture library; after it is successfully imported, the device will automatically model on the
picture which could take some time, then the a face picture ID will be automatically generated (i.e., PID is
returned in response parameters MaskInfo ) by device after modeling succeeds; if you want to manually
manage the face picture ID, you can add customized face picture ID ( customHumanID ) as needed when
applying the request parameter PictureUploadData . PID can be replaced with customized face picture ID for
subsequent face-picture-related operations.

m
ii. Import face picture library data in concurrent operation mode, POST

co
/ISAPI/Intelligent/FDLib/pictureUpload?type=concurrent . If you want to improve the import efficiency,
you can apply concurrent operation that the device will only store the picture not model on the picture. You

a.
will need to manually model on the picture (refer to Face Picture Library Data Modeling Management Flow for

C. arc
details). Note: Back-end DeepinMind devices will automatically perform modeling after data is imported even
though under concurrent operation circumstances; if you demand to manually perform modeling, you can still

s, em
apply modeling management.

A
no fr
4. (Optional) Manage face picture library data modeling. If you imported face picture library data in concurrent
operation mode, you can select a time for device data modeling management after importing completed:

ri on
i. Modeling on registered face pictures, GET /ISAPI/Intelligent/FDLib/manualModeling ;

Ma oc
ii. Search for modeling control results, GET /ISAPI/Intelligent/FDLib/manualModelingRangeTask ;
up
iii. Get modeling progress status, GET /ISAPI/Intelligent/FDLib/manualModeling/progressState .
co gr

5. (Optional) Manage data in the face picture library. You can search, edit, and delete data in the face picture library.
i. Search for face picture data: POST /ISAPI/Intelligent/FDLib/FDSearch ;
es a@

ii. Edit face picture data: PUT /ISAPI/Intelligent/FDLib/FDModify?format=json , it is for editing data of
Fr rc

imported pictures in binary format;

y ema

iii. Edit face picture data in the library: PUT /ISAPI/Intelligent/FDLib/FDSearch?format=json&FDID=

<FDID>&FPID=<FPID>&faceLibType=<faceLibType> , it is for editing data of imported pictures in URL format;
iv. Delete face picture data in the library: PUT /ISAPI/Intelligent/FDLib/FDSearch/Delete?format=json&FDID=
os fr

<FDID>&faceLibType=<FDType> .
ad on

8.1.1.3 Exception Handling

el .c

8.1.1.3.1 Error Code

statusCode statusString subStatusCode errorCode errorMsg Description Remarks

1 OK ok 0x00000001
im
ng

Not enough
2 Device Busy noMemory 0x20000001
Aj

memory.
Co

Invalid Not
4 notSupport 0x40000001
Operation supported.
Face picture
Invalid library
4 faceLibDiskFull 0x400020F4
Operation storage
media is full.
The face
Invalid picture
4 faceLibraryIDNotExis 0x400020FD
Operation library does
not exist.
The face
picture
picture
Invalid
4 faceLibInitializing 0x40002136 library is
Operation
initializing.
Please wait.
Face picture
Invalid
4 notMatchFacelib 0x4000a004 library is not
Operation
matched.
Face picture
Invalid library with

m
4 existSameNameFacelib 0x4000a00a

co
Operation duplicate
name exists.

a.
Deleting the

C. arc
Invalid face picture
4 delFacelibFailed 0x4000a00b
Operation library

s, em
failed.

A
no fr
Editing the
Invalid face picture

ri on
4 modifyFacelibFailed 0x4000a00c
Operation library
failed.
Ma oc Creating a
up
Invalid face picture
4 createFacelibFailed 0x4000a00d
co gr

Operation library
failed.
es a@

The face
Fr rc

Invalid picture
4 facelibAlreadyUsed 0x4000a010
y ema

Operation library has

been used.
os fr

Database
version of
ad on

Invalid
6 faceLibraryDatabaseError 0x60000032 face picture
Content
el .c

library
mismatch.
ez

Invalid Face picture

6 faceLibraryError 0x60000034
Content library error.
im

Multiple
ng
Aj

faces are
recognized
Co

in the
Invalid
6 multipleFaceObjectError 0x60000035 pictures to
Content
be imported
into the face
picture
library.
Importing
Invalid
6 faceLibPicImportingError 0x6000003A picture into
Content
library...
No data
Invalid found in
6 faceLibraryNoData 0x60000069
Content face picture
library.
There is no
data to be
Invalid modeled in
6 NoDataForModelingError 0x6000006B
Content the face
picture
library.
Duplicate ID

m
Invalid of custom

co
6 customFaceLibIDRepeat 0x6000006C
Content face picture
library.

a.
Deleting

C. arc
original
customized

s, em
face picture

A
no fr
library data...
The upper
Invalid

ri on
6 customFaceDataDeleteing 0x600000A1 level cannot
Content
duplicate

Ma oc the
up
customized
face picture
co gr

library of
es a@

this ID.
Fr rc

Importing
s

face picture
y ema

Invalid
6 analysisEnginesFacelibImporting 0x60001005 library to
Content
analysis
os fr

engine...
ad on

Processing
Invalid
6 facelibDataProcessing 0x6000100b face picture
el .c

Content
library data.
ez

Customized
tag for face
en

Invalid picture
6 personInfoExtendValueIsTooLong 0x60001083
im

Content library
ng

exceeded
Aj

limit.
Co

Customized
tag for face
picture
Invalid
6 personInfoExtendValueContainsInvalidChar 0x60001084 library
Content
contains
invalid
character(s).

8.1.1.4 Message Example

Import face pictures to face picture library in binary format and automatically perform modeling, POST
/ISAPI/Intelligent/FDLib/pictureUpload :
POST http://10.16.96.29/ISAPI/Intelligent/FDLib/pictureUpload HTTP/1.1
If-Modified-Since: 0
Accept: */*
X-Requested-With: XMLHttpRequest
Content-Type: multipart/form-data; boundary=---------------------------7e27010d1dba
Referer: http://10.16.96.29/doc/page/config.asp
Accept-Language: zh-CN
Accept-Encoding: gzip, deflate
User-Agent: Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; WOW64; Trident/6.0)
Connection: Keep-Alive
Content-Length: 903330
DNT: 1
Host: 10.16.96.29
Pragma: no-cache

m
Cookie: language=zh; WebSession=48b693ca2b7301e3119d; sdMarkMenu=14%3AfaceSnapLib; sdMarkTab_1_0=0%3AsettingBasic

co
-----------------------------7e27010d1dba
Content-Disposition: form-data; name="PictureUploadData"

a.
<?xml version='1.0' encoding='UTF-8'?
><PictureUploadData><FDID>55869AFEA1E840958120C97054720372</FDID><FaceAppendData><name>20171222103007395_2</name></FaceAppendData></PictureUploadData>

C. arc
-----------------------------7e27010d1dba
Content-Disposition: form-data; name="importImage"; filename="20171222103007395_2.jpeg"
Content-Type: image/jpeg

s, em
【Picture data in binary format】
-----------------------------7e27010d1dba--

A
no fr
ri on
9 Video Recognition
9.1 Face Picture Library Management Ma oc
up
co gr

9.1.1. Search via Picture Comparison in Face Capture Library

es a@

9.1.1.1 Introduction to the Function

Fr rc

Picture comparison with captured picture library

Scene application: Search for similar person in face picture library, which can be used for identity confirmation.
y ema

9.1.1.2 API Calling Flow

os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@

1. Check whether the device supports searching by picture synchronously.

Fr rc

Get the capability of searching via picture comparison: GET /ISAPI/Intelligent/FDLib/capabilities?

y ema

format=json . If the node isSuportFSSearchByPic is returned and its value is true , it indicates that searching via
picture comparison synchronously is supported.
os fr

Note: For some devices supporting searching via picture comparison synchronously, the API for getting the
ad on

capability is invalid, you can call POST /ISAPI/Intelligent/FDLib/searchByPic?format=json directly.

el .c

2. Three methods are supported when searching picture.

By URL:
en

Based on the picture storage server, picture can be uploaded and you can get the picture URL to download the
im

picture file via the URL.

ng
Aj

By model data:
Co

Get face picture capability: GET /ISAPI/SDT/Face/pictureAnalysis/capabilities ;

Analyze (model) face pictures: POSTT /ISAPI/SDT/Face/pictureAnalysis ; Return picture modeling data:
targetModelData .

By binary picture:
Read binary picture files.
3. Submit synced face picture library to use picture to search picture
Search via picture comparison in face capture library: POST /ISAPI/Intelligent/FDLib/searchByPic?
format=json ;
Note: Input parameter node dataType include three modes. Picture URL corresponds to faceURL , model data
corresponds to targetModelData , binary data mode is in form of form, and its JSON data is followed by binary
picture data.
The request message example of binary picture data is as follows:

POST /ISAPI/Intelligent/FDLib/searchByPic?format=json
Host: device_ip:port
Accept-Language: zh-cn
Date: YourDate
Content-Type: multipart/form-data;boundary=<frontier>
Content-Length: text_length

m
Connection: keep-alive

co
--<frontier>
Content-Disposition: form-data; name=""

a.
Content-Type: application/json

[JSON message]

C. arc
--<frontier>
Content-Disposition: form-data; name="Picture_Name"
Content-Length: image_length
Content-Type: image/jpeg

s, em
[Picture data]

A
no fr
--<frontier>--

ri on
10 Audio (General)
Ma oc
up
10.1 Real-Time Audio Streaming
co gr

10.1.1 Introduction to the Function

es a@

The client can get real-time audio data via RTSP to listen to the device.
Fr rc

10.1.2 API Calling Flow

y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Get system capabilities: GET /ISAPI/System/capabilities . If isSupportRTSPAudio is returned and its value is true,
then the device supports real-time audio streaming via RTSP.
2. Get audio streaming capabilities: GET /ISAPI/System/Audio/capabilities . If isSupportRTSPAudio is returned
and its value is true, the device supports RTSP real-time audio streaming.
3. (Optional) Send an RTSP OPTION command to get RTSP methods supported by the device: OPTION rtsp://IP
address/ISAPI/Streaming/audio/<audioID> RTSP/1.0 .

4. Send an RTSP DESCRIBE command: DESCRIBE rtsp://IP address/ISAPI/Streaming/audio/<audioID> RTSP/1.0 .

Digest-MD5 authentication is completed in this step.
5. Use the trackID parsed from SDP information to set RTSP playing parameters. trackID=1 indicates audio.
5. Use the trackID parsed from SDP information to set RTSP playing parameters. trackID=1 indicates audio.
6. Send an RTSP PLAY command: PLAY rtsp://IP address/ISAPI/Streaming/audio/<audioID> RTSP/1.0 , and the
device starts to push audio stream.
7. Receive the RTP packet sent by the device. Divided RTP packets should be assembled on the client before being
parsed.
8. Send an RTSP TEARDOWN command to stop streaming.
Note: <audioID> represents audio channel No.

m
co
10.1.3 Message Example

a.
10.1.3.1 Send an RTSP OPTION Request

C. arc
OPTIONS rtsp://10.17.114.136/ISAPI/Streaming/audio/1 RTSP/1.0
CSeq: 0

s, em
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)

A
no fr
Response from the device

ri on
RTSP/1.0 200 OK
CSeq: 0

Ma oc
Public: OPTIONS, DESCRIBE, PLAY, SETUP, TEARDOWN, SET_PARAMETER, GET_PARAMETER
up
10.1.3.2 Send an RTSP DESCRIBE Request
co gr
es a@

DESCRIBE rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1 RTSP/1.0

CSeq:1
Accept:application/sdp
Fr rc

User-Agent:NKPlayer-1.00.00.081112
y ema

The server responds that an authentication is required.

os fr

RTSP/1.0 401 Unauthorized

CSeq: 1
ad on

WWW-Authenticate: Digest realm="3521781c29acb312330dd668", nonce="026019333", algorithm="MD5"

el .c

The client resends an RTSP DESCRIBE request with the authentication information.
ez

DESCRIBE rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1 RTSP/1.0

CSeq:2
Accept:application/sdp
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1",
im

response="76a2c9c5b8edbd49838013cf1cf27941"
User-Agent:NKPlayer-1.00.00.081112
ng
Aj
Co

The device responds with SDP information.

RTSP/1.0 200 OK
CSeq: 2
Content-Type: application/sdp
Content-Length: 571
Date: Tue, 17 Nov 2020 02:09:45 GMT

v=0
o=- 1633703084091356 1633703084091356 IN IP4 10.17.114.136
s=Media Presentation
e=NONE
b=AS:5100
t=0 0
a=control:rtsp://10.17.114.136/ISAPI/Streaming/audio/1/
m=audio 0 RTP/AVP 8

m
c=IN IP4 0.0.0.0
b=AS:5000

co
a=recvonly
a=x-dimensions:2560,1440

a.
m=audio 0 RTP/AVP 8
c=IN IP4 0.0.0.0
b=AS:50

C. arc
a=recvonly
a=control:rtsp://10.17.114.136/ISAPI/Streaming/audio/1/trackID=1
a=rtpmap:8 PCMA/8000
a=Media_header:MEDIAINFO=494D4B48010300000400000111710110401F000000FA000000000000000000000000000000000000;

s, em
a=appversion:1.0

A
no fr
10.1.3.3 Send an RTSP SETUP Request

ri on
SETUP rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1/trackID=1 RTSP/1.0

Ma oc
CSeq:3
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1/",
up
response="ff343f5ff82deb028dd9b4932cc44201"
Transport:RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=0
User-Agent:NKPlayer-1.00.00.081112
co gr
es a@

Response from the device

Fr rc

RTSP/1.0 200 OK
Session: 1127293610;timeout=60
y ema

Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=433122aa
CSeq: 3
Accept-Ranges: NPT
Media-Properties: No-Seeking, Time-Progressing, Time-Duration=0
os fr

Date: Tue, 17 Nov 2020 02:09:45 GMT

ad on

10.1.3.4 Send an RTSP PLAY Request

el .c

PLAY rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1 RTSP/1.0

CSeq:4
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1",
en

response="24edf8a6ff3ef767f7c49d1c847200bd"
Session:1127293610;timeout=60
Range:npt=0.000000-0.000000
im

User-Agent:NKPlayer-1.00.00.081112
ng
Aj

The device pushes audio and video streams.

RTSP/1.0 200 OK
Session: 1127293610
CSeq: 4
Date: Tue, 17 Nov 2020 02:09:45 GMT

$. .....d1.w....c....".T....g....).i.........a....7.S..~J............X....X.

10.1.3.5 Send an RTSP TEARDOWN Request

TEARDOWN rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1 RTSP/1.0
CSeq:5
Authorization: Digest username="admin", realm="3521781c29acb312330dd668", nonce="026019333", uri="rtsp://10.21.84.147:554/ISAPI/Streaming/audio/1",
response="24edf8a6ff3ef767f7c49d1c847200bd"
Session:1127293610;timeout=60
Range:npt=0.000000-0.000000
User-Agent:NKPlayer-1.00.00.081112

Response from the device

RTSP/1.0 200 OK
Session: 1127293610

m
CSeq: 5

co
Date: Tue, 17 Nov 2020 02:09:50 GMT

a.
11 Two-Way Audio

C. arc
s, em
11.1 Two-Way Audio

A
no fr
11.1.1 Introduction to the Function

ri on
This function is for the two-way audio between the client and device. When you call the API to implement the two-way
audio, it requires the client to collect and encode the local audios and to decode the device audio data.

Ma oc
Note: Before starting two-way audio, check whether the way of collecting device audio data, audio encoding format,
up
volume, etc., is correct or not. The audio encoding format of the client should be consistent with the device audio
encoding format.
co gr
es a@

11.1.2 API Calling Flow

Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

1. Get the capability of configuring audio parameters for all two-way audio channels: GET
/ISAPI/System/TwoWayAudio/channels/capabilities . Check whether the device supports two-way audio. If the
ez

HTTP status code 200 OK is returned, then the device supports two-way audio.
en

2. Get the audio parameters of all two-way audio channels: GET /ISAPI/System/TwoWayAudio/channels . Get the No.
im

of two-way audio channel for response and parsing <id> , audio type <audioCompressionType> , frame rate
<audioBitRate> , sampling rate <audioSamplingRate> and so on, to ensure the consistent of audio format during
ng
Aj

the two-way audio process.

3. Set the audio parameters of one two-way audio channel: PUT /ISAPI/System/TwoWayAudio/channels/<audioID> .
This step is optional, and the <audioID> is the channel No. <id> responded and parsed in step 2.
4. Start two-way audio: PUT /ISAPI/System/TwoWayAudio/channels/<audioID>/open .
5. Create an HTTP persistent connection to receive the two-way audio data: GET
/ISAPI/System/TwoWayAudio/channels/<audioID>/audioData .
6. Create an HTTP persistent connection to send the two-way audio data: PUT
/ISAPI/System/TwoWayAudio/channels/<audioID>/audioData .
7. When the two-way audio ends, the client disables the persistent connections in steps 6 and 7 and sends the
message of stopping the two-way audio: PUT /ISAPI/System/TwoWayAudio/channels/<audioID>/close .
Note:
Two-way audio over ISAPI supports digest authentication.
It supports the two-way audio mode or sending only mode (the platform only call PUT
/ISAPI/System/TwoWayAudio/channels/<audioID>/audioData to send the audio data to devices).
The <audioID> in step 3, 4, 5, 6, and 7 is the two-way audio channel No. which starts from 1. It can be parsed from
the <id> in the device response message of the step 2.
The audio type <audioCompressionType> , frame rate <audioBitRate> , and sampling rate <audioSamplingRate>
can be parsed from the device response message of the step 2 for audio playing and collection in the step 5 and 6.
The step 6 and 7 use persistent connections. In the HTTP request headers, you don't need to set Content-Legth ,
but need to set the Connection: keep-alive and Content-Type: application/octet-stream .
When the encoding format of audio data in the step 5 and 6 is AAC/MP2L2/MP3, the audio data length is variable,

m
co
so the frame header should be lengthened by 4 bytes. When the encoding format is
G.722.1/G.711alaw/G.711ulaw/G.726/G.729/G.729a/G.729b/PCM/ADPCM/Opus, the audio data length is fixed,

a.
there is no need to lengthen the frame header. For example, if the content length of a frame of MP3 audio data is
576 bytes and the header length is 4 bytes, the big end data is 0x00000240, the total length is 580 bytes.

C. arc
The damaged audio file in the AC3 format is usually incompatible when using. Currently, the audio algorithm
library does not support this format.

s, em
A
Statistics of audio types with fixed lengths: |Audio Type |Fixed Length|Frame Interval | |---------|-------|---------| |G.722.1

no fr
|80 |40ms | |G.711alaw|160/320|20ms/40ms| |G.711ulaw|160/320|20ms/40ms| |G.726 |80 |40ms | |G.729 |10 |10ms |

ri on
|G.729a |10 |10ms | |G.729b |10 |10ms | |PCM |1920 |None | |ADPCM |80 |20ms | |Opus |32/64 |20ms/40ms|

Ma oc
11.1.3 Exception Handling up
11.1.3.1 Error Codes
co gr

statusCode statusString subStatusCode errorCode errorMsg Description Remarks

es a@

The
operation
Fr rc

is not
y ema

allowed.
Two-way
os fr

Two-way audio Two-way audio audio is

Invalid in in in
4 twoWayAudioInProgressPleaseWait 0x40002068
ad on

Operation progress...Please progress...Please progress.

wait. wait. Please try
el .c

again
ez

after
two-way
en

audio
im

stopped.
ng
Aj
Co

11.1.4 Message Format and Example

11.1.4.1 Receive Two-Way Audio Data

GET /ISAPI/System/TwoWayAudio/channels/1/audioData HTTP/1.1

Host: 10.17.115.128
Connection: keep-alive
Content-Type: application/octet-stream

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/octet-stream

//The following are the two-way audio data sent by the device.

11.1.4.2 Send Two-Way Audio Data

PUT /ISAPI/System/TwoWayAudio/channels/1/audioData HTTP/1.1
Host: 10.17.115.128
Connection: keep-alive
Content-Type: application/octet-stream

//The following are the two-way audio data sent by the client.

12 Access Control (General)

m
12.1 . Configure Parameters of Stand-Alone Anti-Passback

co
12.1.1 Introduction to the Function

a.
Anti-passback function allows person to pass entrance and exit by specific route. For areas with multiple entrance/exit,

C. arc
person need to authenticate and pass specific doors. Only one time of authentication and passing is allowed for each
door, that is the person need to follow the specific order to pass the doors. Stand-alone anti-passback is designed to

s, em
minimize the misuse or fraudulent use of access credentials such as passing back card to an unauthorized person, or

A
tailed access. It is applicable to exhibitions, scenic spots, or metro entrances where one card one person is required.

no fr
12.1.2 API Calling Flow

ri on
Calling Flow:

Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

ISAPI Protocol Calling Flow:

1. 1. Get the capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportAntiSneakCfg is returned and its value is "true", it indicates that the device supports configuring
parameters of stand-alone anti-passback.
2. Get the parameters of anti-passback configuration: GET /ISAPI/AccessControl/AntiSneakCfg?format=json ; Set
the anti-passing back parameters: PUT /ISAPI/AccessControl/AntiSneakCfg?format=json ; enable the anti-
passback function and the first card reader (first entrance), see details in GET
/ISAPI/AccessControl/AntiSneakCfg/capabilities?format=json .
3. Get the capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportCardReaderAntiSneakCfg is returned and its value is "true", it indicates that the device supports
configuring parameters of card readers.
4. Get the anti-passing back configuration parameters of a specified card reader: GET

m
/ISAPI/AccessControl/CardReaderAntiSneakCfg/<cardReaderID>?format=json ; Set anti-passing back

co
parameters of a card reader: PUT /ISAPI/AccessControl/CardReaderAntiSneakCfg/<cardReaderID>?

a.
format=json ; the node cardReaderID refers to the card reader No. The person's passing route will follow the card
reader No. in the API. Note: the anti-passback route should be closed-loop. Improper configuration will affect

C. arc
normal door opening. For example: card reader 1 -> card reader 2 -> card reader 3. The card reader 1 should be
set after card reader 3, or authentication in card reader 1 after one loop will fail. Get the configuration capability of

s, em
anti-passing back parameters of card readers: GET

A
/ISAPI/AccessControl/CardReaderAntiSneakCfg/capabilities?format=json .

no fr
5. Get the capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node

ri on
isSupportClearAntiSneakCfg is returned and its value is "true", it indicates that the device supports clearing
parameters of anti-passback.
6.
Ma oc
Clear anti-passing back parameters: PUT /ISAPI/AccessControl/ClearAntiSneakCfg?format=json ; Get the
up
capability of clearing anti-passback parameters: GET /ISAPI/AccessControl/ClearAntiSneakCfg/capabilities?
format=json , set the value of antiSneak to false to disable the anti-passback function.
co gr

7. Get the capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node

es a@

isSupportClearAntiSneak is returned and its value is "true", it indicates that the device supports clearing records of
anti-passback.
Fr rc

8. Clear anti-passback records in the device: PUT /ISAPI/AccessControl/ClearAntiSneak?format=json ; It supports

y ema

clearing anti-passback records by person ID. Get the capability of clearing anti-passback records: GET
/ISAPI/AccessControl/ClearAntiSneak/capabilities?format=json .
os fr

Note: clear the historic anti-passback parameters before configuring new parameters.
ad on

12.2 Arming Information

el .c

12.2.1 Introduction to the Function

The device supports getting the arming information, such as the armed device IP and port, arming type, and protocol
en

type.
im

12.2.2 API Calling Flow

ng
Aj

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
Co

isSupportDeployInfo is returned and its value is "true", it indicates that the device supports getting arming
information.
2. Get arming information capability: GET /ISAPI/AccessControl/DeployInfo/capabilities .
3. Get arming information: GET /ISAPI/AccessControl/DeployInfo .

12.3 Authentication Schedule Management

12.3.1 Introduction to the Function
By calling the following APIs, the entrance&exit time schedule and authentication mode can be applied to the card
reader. An access control terminal is controlled by two card readers. For example: access control terminal 1 is controlled
by entrance card reader 1 and exit card reader 2; access control terminal 2 is controlled by entrance card reader 3 and
exit card reader 4, etc. Card reader n is corresponding to schedule template n.
1 weekly schedule and 4 holiday groups can be added in each schedule template. The priority of holiday schedule is
higher than that of weekly schedule. A weekly schedule can be configured by date of a week and 8 different time
periods of a day. 16 holiday schedules can be added to a holiday group schedule. Each holiday schedule has its start
and end date, and the time period is same in the range (8 time periods can be added). The access control can follow the
schedule template to manage the time of person's permissions.

m
For Person Management of Person and Credential Management, the priority of the authentication method for person is

co
higher than that of the authentication schedule. If the authentication method (the node is userVerifyMode) is applied to

a.
a person, the person can access according to the authentication method for person.

C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr

12.3.2 API Calling Flow

es a@

12.3.2.1 Card Reader's Authentication Schedule Configuration

Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

The API calling flow is as follows:

1. Check whether the device supports configuring control schedules of card reader authentication mode: GET
/ISAPI/AccessControl/capabilities ; if the node isSupportCardReaderPlan is returned and its value is "true", it
en

indicates that the device supports configuring acontrol schedules of card reader authentication mode (and the
device also supports configuring schedule templates of the card reader authentication mode).
im
ng

2. Set control schedule parameters of card reader authentication mode: [GET/PUT]

/ISAPI/AccessControl/CardReaderPlan/<cardReaderID>?format=json ; the value of cardReaderID should be the

same as the value of templateNo.

3. If the node isSupportCardReaderPlan is returned and its value is "false", it indicates that the device does not
support configuring control schedules of card reader authentication mode.

12.3.2.2 Authentication Schedule Template Configuration

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

The API calling flow is as follows:

1. Check whether the device supports configuring schedule templates of the card reader authentication mode: GET
ez

/ISAPI/AccessControl/capabilities ; if the node isSupportVerifyPlanTemplate is returned and its value is "true",

it indicates that the device supports configuring schedule templates of the card reader authentication mode (and
the device also supports configuring weekly schedules of the card reader authentication mode).
im

2. Set the schedule template parameters of the card reader authentication mode: [GET/PUT]
ng
Aj

/ISAPI/AccessControl/VerifyPlanTemplate/<planTemplateID>?format=json .
Co

3. If the node isSupportVerifyPlanTemplate is returned and its value is "false", it indicates that the device does not
support configuring schedule templates of the card reader authentication mode.

12.3.2.3 Weekly Authentication Schedule Template Configuration

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

The API calling flow is as follows:

1. Check whether the device supports configuring weekly schedules of the card reader authentication mode: GET
/ISAPI/AccessControl/capabilities ; if the node isSupportCardRightWeekPlanCfg is returned and its value is
en

"true", it indicates that the device supports configuring weekly schedules of the card reader authentication mode.
im

2. Set the weekly schedule parameters of the card reader authentication mode: [GET/PUT]
ng

/ISAPI/AccessControl/VerifyWeekPlanCfg/<weekPlanID>?format=json .
Aj

3. If the node isSupportVerifyWeekPlanCfg is returned and its value is "false", it indicates that the device does not
Co

support configuring weekly schedules of the card reader authentication mode.

12.3.2.4 Holiday Authentication Group Configuration

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

The API calling flow is as follows:

1. Check whether the device supports configuring holiday groups of control schedule of card reader authentication
mode: GET /ISAPI/AccessControl/capabilities ; if the node isSupportVerifyHolidayGroupCfg is returned and its
en

value is "true", it indicates that the device supports configuring holiday groups of control schedule of card reader
authentication mode (and the device also supports configuring holiday schedules of card reader authentication
im

mode).
ng
Aj

2. Set holiday group parameters of control schedule of card reader authentication mode: [GET/PUT]
Co

/ISAPI/AccessControl/VerifyHolidayGroupCfg/<holidayGroupID>?format=json .
3. If the node isSupportVerifyHolidayGroupCfg is returned and its value is "false", it indicates that the device does not
support configuring holiday groups of control schedule of card reader authentication mode.

12.3.2.5 Holiday Authentication Schedule Configuration

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

The API calling flow is as follows:

1. Check whether the device supports configuring holiday schedules of card reader authentication mode: GET
ez

/ISAPI/AccessControl/capabilities ; if the node isSupportVerifyHolidayPlanCfg is returned and its value is

"true", it indicates that the device supports configuring holiday schedules of card reader authentication mode.
2. Set holiday schedule parameters of card reader authentication mode: [GET/PUT]
im

/ISAPI/AccessControl/VerifyHolidayPlanCfg/<holidayPlanID>?format=json .
ng
Aj

3. If the node isSupportVerifyHolidayPlanCfg is returned and its value is "false", it indicates that the device does not
Co

support configuring holiday schedules of card reader authentication mode.

12.4 Authentication via QR Code
12.4.1 Generate QR Code by Platform
12.4.1.1 Introduction to the Function
1. After an access control device is deployed, you should add it to the platform and set the QR code key which will be

m
saved to the database of the platform. Notes: For security, the QR code key should be encrypted before been

co
saved to the platform and the device; if you need to open multiple doors by scanning the QR codes, the

a.
device key of the multiple doors should be the same.

C. arc
2. The platform applies persons' permissions to the device via person-based function. The QR code is linked with
employee No., so the permission of opening a door is decided by whether a person's employee No. is
authenticated.

s, em
3. Before entering the controlled areas, the visitors need to register on the platform. The platform will generate QR

A
no fr
code strings according to the registered information, QR code key, and QR code protocol, for converting QR code
strings to QR code pictures, and sending to visitors' phones.

ri on
4. When the visitors enter the controlled areas, they can scan the QR codes via the devices. Then, the device can get

Ma oc
the encrypted data, decrypt the data by QR code key and protocol, and check whether the door can be opened. If
yes, the door will open; if no, the door will not open and the device will prompt the message "No permission".
up
12.4.1.2 API Calling Flow
co gr

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
es a@

isSupportQRCodeEncryption is returned and its value is "true", it indicates that the device supports QR code
Fr rc

encryption.
s

2. Get the capability of QR code encryption: GET /ISAPI/AccessControl/QRCodeEncryption/capabilities?

y ema

format=json .
3. Set the parameters of QR code encryption: PUT /ISAPI/AccessControl/QRCodeEncryption?
os fr

format=json&security=<security>&iv=<iv> , the parameters include encryption type, encryption key, and

initialization vector.
ad on

4. Get the related APIs of Person and Credential Management for applying certain persons' permissions to open the
el .c

doors. So the permission of opening a door is decided by whether a person's employee No. is authenticated.
ez

5. After generating QR code strings by Base64 and generating QR code pictures based on QR code strings, the
platform for sending the pictures to visitors' phones. The visitors can access the area after scanning the QR code
en

pictures.
im

12.4.2 Generate QR Code by Device

ng
Aj
Co

12.4.2.1 Introduction to the Function

1. After an access control device is deployed, you can log in to the device via the Web / iVMS-4200 client software,
and set a QR code key for the device (saving the QR code key is not necessary). Notes: to ensure security, the
QR code key should be encrypted before saving to the device; if multiple doors need to be opened via
the QR code, the devices of the multiple doors should be configured a same key.
2. By calling the APIs of person-based functions, the Web / iVMS-4200 client software applies persons' permission to
the device. So the permission of opening a door is decided by whether a person's employee No. is authenticated.

m
co
a.
C. arc
s, em
A
no fr
3. Before visitors enter the controlled areas, the inviters need to upload the visitor information to EZ and apply the
information to the device. The device will generate QR code strings according to the visitor information, QR code

ri on
key, and QR code protocol, and send back to the inviters. The inviters' phones will convert QR code strings to QR
code pictures, and forward the pictures to visitors' phones.
Ma oc
4. When the visitors enter the controlled areas, they can scan the QR codes via the devices. Then, the device can get
up
the encrypted data, decrypt the data by QR code key and protocol, and check whether the door can be opened. If
co gr

yes, the door will open; if no, the door will not open and prompt the message "No permission". Note: for
usability and security, APIs of generating QR codes by the platform are not accessible, only APIs of
es a@

generating QR code by device are provided.

Fr rc

12.4.2.2 API Calling Flow

y ema

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the nodes
isSupportQRCodeEncryption and isSupportQRCodeInfo are returned and the value is "true", it indicates that the
os fr

device supports QR code encryption and generating QR code.

2. Get the capability of QR code encryption: GET /ISAPI/AccessControl/QRCodeEncryption/capabilities?
ad on

format=json . Get the capability of generating QR code: GET /ISAPI/AccessControl/QRCodeInfo/capabilities?

el .c

format=json .
3. Set the parameters of QR code encryption: PUT /ISAPI/AccessControl/QRCodeEncryption?
ez

format=json&security=<security>&iv=<iv> , the parameters include encryption type, encryption key, and

initialization vector.
4. Get the related APIs of Person and Credential Management for applying certain persons' permissions to open the
im

doors. The permission of opening a door will be decided by whether a person's employee No. is authenticated.
ng
Aj

5. Generate QR code strings encoded via base64: POST /ISAPI/AccessControl/QRCodeInfo?format=json&security=

<security>&iv=<iv> ; then the device will send the QR code strings to the phones of the inviters.
6. Inviters' phones convert the QR code strings to QR code pictures, and send to visitors' phones.
7. The visitors can access the area by scanning the QR code pictures in their phones.

12.4.3 Remarks
The device will send AccessControllerEvent (contains QRCodeInfo) for QR code authentication. If the authentication
succeed, the returned event type will be 0x9c, if the authentication failed, the returned event type will be 0x9d.

12.5 Card Management

12.5.1 Introduction to the Function
Card management includes searching, applying, adding, editing, deleting, and collecting cards.
12.5.2 API Calling Flow
12.5.2.1 Check Whether the Device Supports Card Management

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez

Before calling the API for card management, make sure that the device supports card management.
en

1. Check whether the device supports card management: GET /ISAPI/AccessControl/capabilities ; if the node
im

isSupportCardInfo is returned and its value is “true”, it indicates that the device supports card management.
ng

2. Search, apply, add, edit, and delete cards.

3. If the node isSupportCardInfo is returned and its value is “false”, it indicates that the device does not support card
Co

management.
Note:
Before applying, adding, or editing cards on the device, make sure that the related person information linked to the
person ID has been applied to the device.
The value of the node numberPerPerson returned by calling GET
/ISAPI/AccessControl/CardInfo/capabilities?format=json is the maximum number of cards supported per
person. If the value returned is 255, it indicates that the number of cards per person is unlimited. If the node is not
returned, it indicates that the maximum number of cards can be applied is 5.
Manage cards of different card number lengths by calling [GET/PUT]
/ISAPI/AccessControl/CardVerificationRule?format=json .
Aj
im
Co en
12.5.2.2 Card Search

ng ez
el .c
ad on
os fr
y ema
Fr rc
es a@
co gr
s up
Ma oc
ri on
no fr
s, em
C. arc
A a.
co
m
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The card search function is for searching the number of cards and card information applied to the device.
1. Check whether the device supports card search: GET /ISAPI/AccessControl/CardInfo/capabilities?
format=json ; if the value of the node supportFunction contains “get”, it indicates that the device supports card
search.
2. Search the number of specified persons’ cards: GET /ISAPI/AccessControl/CardInfo/Count?
format=json&employeeNo=<employeeNo> ; the returned value of the node cardNumber is the number of the cards
added to the specified persons.
3. Search the number of all persons’ cards: GET /ISAPI/AccessControl/CardInfo/Count?format=json ; the returned
value of the node cardNumber is the number of the cards added to all persons.

m
4. Search card information: POST /ISAPI/AccessControl/CardInfo/Search?format=json ; the card information is

co
returned by page.
5. If the value of the node supportFunction does not contain “get”, it indicates that the device does not support card

a.
search.

C. arc
Note:
The value of the node maxRecordNum returned by calling GET /ISAPI/AccessControl/CardInfo/capabilities?

s, em
format=json is the maximum number of cards supported by the device.

A
no fr
12.5.2.3 Card Applying

ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng

Card information can be applied to the device via the card applying function. If the card has been added to
Aj

the device, the card information will be edited; if the card has not been added to the device, the card
Co

information will be added to the device.

1. Check whether the device supports card applying: GET /ISAPI/AccessControl/CardInfo/capabilities?
format=json ; if the value of the node supportFunction contains “setUp”, it indicates that the device supports card
applying.
2. Apply card information: PUT /ISAPI/AccessControl/CardInfo/SetUp?format=json .
3. If the value of the node supportFunction does not contain “setUp”, it indicates that the device does not support
card applying.
Note:
Check whether the card has been added to the device via the node cardNo returned after calling the API for card
applying.

12.5.2.4 Card Adding

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng

Card information can be added to the device via the card adding function. If the card has been added to the
Aj

device, the device will report an error; if the card has not been added to the device, the card information will
Co

be added to the device.

1. Check whether the device supports card adding: GET /ISAPI/AccessControl/CardInfo/capabilities?
format=json ; if the value of the node supportFunction contains “post”, it indicates that the device supports card
adding.
2. Add card information: POST /ISAPI/AccessControl/CardInfo/Record?format=json .
3. If the value of the node supportFunction does not contain “post”, it indicates that the device does not support card
adding.
Note:
Check whether the card has been added to the device via the node cardNo returned after calling the API for card
adding.

12.5.2.5 Card Information Editing

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj

Card information on the device can be edited via the card information editing function. If the card has been
Co

added to the device, the card information will be edited; if the card has not been added to the device, the
device will report an error.
1. Check whether the device supports card information editing: GET
/ISAPI/AccessControl/CardInfo/capabilities?format=json ; if the value of the node supportFunction contains
“put”, it indicates that the device supports card information editing.
2. Edit card information: PUT /ISAPI/AccessControl/CardInfo/Modify?format=json .
3. If the value of the node supportFunction does not contain “put”, it indicates that the device does not support card
information editing.
Note:
Check whether the card has been added to the device via the node cardNo returned after calling the API for card
information editing.

12.5.2.6 Card Deleting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The card information on the device can be deleted via the card deleting function. The device will not report
an error if the card information to be deleted is not added to the device.
1. Check whether the device supports card deleting: GET /ISAPI/AccessControl/CardInfo/capabilities?
format=json ; if the value of the node supportFunction contains “delete”, it indicates that the device supports card
deleting.
2. Delete cards: PUT /ISAPI/AccessControl/CardInfo/Delete?format=json ; if calling succeeded, it indicates that the
device has deleted the cards.
3. If the value of the node supportFunction does not contain “delete”, it indicates that the device does not support
card deleting.

12.5.2.7 Card Collecting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en

The card collecting function is for collecting the card No., card type, etc.
im
ng

1. Check whether the device supports card collecting: GET /ISAPI/AccessControl/capabilities ; if the node
Aj

isSupportCaptureCardInfo is returned and its value is “true”, it indicates that the device supports card collecting.
Co

2. Collect card information: GET /ISAPI/AccessControl/CaptureCardInfo?format=json .

3. If the node isSupportCaptureCardInfo is returned and its value is “false”, it indicates that the device does not
support card collecting.
12.6 Configure Non-anti-passback Time Period
Non-anti-passback time period: anti-passback is not triggered in the set time period. Application Scenarios: In rush
hour, anti-passback can always happens since the person might follow others in the people flow. Non-anti-passback
can help normal entry&exit in rush hour.

12.6.1 Introduction to the Function

12.6.2 API Calling Flow
Calling Flow:
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
ISAPI Protocol Calling Flow:
1. Get the capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
co gr

isSupportAntiPassbackTimeRange is returned and its value is "true", it indicates that the device supports
es a@

configuring time period of anti-passback.

2. Get time period parameters of non anti-passback: GET /ISAPI/AccessControl/AntiPassback/timeRange?
Fr rc

format=json ; configure time period parameters of non anti-passback: PUT

y ema

/ISAPI/AccessControl/AntiPassback/timeRange?format=json ; it can specify the time period of anti-passback;

Get the capacity of configuring time period of anti-passback: GET
/ISAPI/AccessControl/AntiPassback/timeRange/capabilities?format=json .
os fr
ad on

12.7 Daily Schedule of Voice Prompt

el .c

12.7.1 Introduction to the Function

You can configure TTS texts or audio files of access authentication for daily schedule. The priority of holiday schedule is
en

higher than that of daily schedule. If the current day is in holiday schedule, voice prompt for holiday schedule will be
played; if the current day is not in holiday schedule, voice prompt for daily schedule will be played.
im
ng

12.7.2 API Calling Flow

Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng

ISAPI Protocol Calling Flow: 1.Check whether the device supports daily schedule of voice prompt (get the capability
Aj

of access control): GET /ISAPI/AccessControl/capabilities?format=json ; if the node isSupportTTSText is returned

and its value is "true", it indicates that the device supports daily schedule management of voice prompt; 2.Get the
capability of daily schedule parameters of voice prompt: GET
/ISAPI/AccessControl/Verification/ttsText/capabilities?format=json ; 3.Get and configure daily schedule of
voice prompt: GET/PUT /ISAPI/AccessControl/Verification/ttsText?format=json ;

12.8 Door Control Schedule Management

12.8.1 Introduction to the Function
For doors of access control or floors of elevator control, you can set schedule templates. The schedule template
information include time period and status (remain open, remain closed, sleep, and normal). Configuring door control
schedule is not required. If it is not configured, No device configuration has permission for all the doors by default. The
priority of remote door control is higher than that of door control schedule. The operation of remote door control can
take effect when the door is in the status of remain open/closed, sleep, and normal.
Each schedule template can be linked to one week schedule and four holiday group schedules. Holiday schedule
priority is higher than that of weekly schedule. Weekly schedule can be configured with time periods from Monday to
Sunday, and 8 different time periods are supported each day. Holiday group schedule can be linked to 16 different
holiday schedules. Each holiday schedule can be configured with one start and end date of the holiday, and the access
time period is the same for each day (up to 8 different time periods can be configured). This schedule template is
configured to manage access control permission.

m
co
a.
C. arc
s, em
A
no fr
ri on
12.8.2 API Calling Flow
Ma oc
up
12.8.2.1 Configure Door Control Schedule
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c

The API calling flow is as follow:

1. Check whether the device supports configuring door control schedule: GET /ISAPI/AccessControl/capabilities ;
ez

if the node isSupportDoorStatusPlan is returned and its value is "true", it indicates that the device supports
en

configuring door control schedule (and the device also supports configuring schedule template of door control).
2. Set door control schedule: [GET/PUT] /ISAPI/AccessControl/DoorStatusPlan/<doorID>?format=json .
im

3. If the node isSupportDoorStatusPlan is returned and its value is "false", it indicates that the device does not
ng
Aj

support configuring door control schedule.

12.8.2.2 Configure Door Control Schedule Template

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on

The API calling flow is as follow:

el .c

1. Check whether the device supports configuring door control schedule template:GET
ez

/ISAPI/AccessControl/capabilities ; if the node isSupportDoorStatusPlanTemplate is returned and its value is

"true", it indicates that the device supports configuring door control schedule template (and the device should also
supports configuring door status schedule template).
im

2. Get and set parameters of door control schedule template: [GET/PUT]

ng
Aj

/ISAPI/AccessControl/DoorStatusPlanTemplate/<planTemplateID>?format=json .
Co

3. If the node isSupportDoorStatusPlanTemplate is returned and its value is "false", it indicates that the device does
not support configuring door control schedule template.

12.8.2.3 Configure Door Control Weekly Schedule

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on

The API calling flow is as follow:

el .c

1. Check whether the device supports configuring door control weekly schedule: GET
ez

/ISAPI/AccessControl/capabilities ; if the node isSupportDoorStatusWeekPlanCfg is returned and its value is

"true", it indicates that the device supports this function.

2. Set parameters of door control weekly schedule: [GET/PUT]
im

/ISAPI/AccessControl/DoorStatusWeekPlanCfg/<weekPlanID>?format=json .
ng
Aj

3. If the node isSupportDoorStatusWeekPlanCfg is returned and its value is "false", it indicates that the device does
Co

not support configuring this function.

12.8.2.4 Configure Door Control Holiday Group

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on

The API calling flow is as follow:

el .c

1. Check whether the device supports configuring door control holiday group: GET
ez

/ISAPI/AccessControl/capabilities ; if the node isSupportDoorStatusHolidayGroupCfg is returned and its value

is "true", it indicates that the device supports configuring door control holiday group (and the device also supports
configuring door control holiday schedule).
im

2. Set the holiday group configuration parameters of the door control schedule: [GET/PUT]
ng
Aj

/ISAPI/AccessControl/DoorStatusHolidayGroupCfg/<holidayGroupID>?format=json .
Co

3. If the node isSupportDoorStatusHolidayGroupCfg is returned and its value is "false", it indicates that the device
does not support this function.

12.8.2.5 Configure Door Control Holiday Schedule

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on

The API calling flow is as follow:

el .c

1. Check whether the device supports configuring door control holiday schedule: GET
ez

/ISAPI/AccessControl/capabilities ; if the node isSupportDoorStatusHolidayPlanCfg is returned and its value is

"true", it indicates that the device supports this function.

2. Set parameters of door control holiday schedule: [GET/PUT]
im

/ISAPI/AccessControl/DoorStatusHolidayPlanCfg/<holidayPlanID>?format=json .
ng
Aj

3. If the node isSupportDoorStatusHolidayPlanCfg is returned and its value is "false", it indicates that the device does
Co

not support this function.

12.9 Event and Card Linkage Parameters
12.9.1 Introduction to the Function
The device supports linking specific actions when access control events triggered. The linkage actions include event,
card No., MAC address, and employee No. Take event for example, if a person authenticated by the device, the door will
open for the person.

12.9.2 API Calling Flow

12.9.2.1 Configure Parameters of Event and Card Linkage
1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportEventCardLinkageCfg is returned and its value is "true", it indicates that the device supports configuring
the parameters of event and card linkage.
2. Get the configuration capability of the event and card linkage: GET
/ISAPI/AccessControl/EventCardLinkageCfg/capabilities?format=json .

3. Get and set the parameters of event and card linkage: GET|PUT
/ISAPI/AccessControl/EventCardLinkageCfg/<ACEID>?format=json .

m
12.9.2.2 Search for Parameters of Event and Card Linkage

co
1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node

a.
isSupportEventCardLinkageCfgSearch is returned and its value is "true", it indicates that the device supports

C. arc
searching for the parameters of event and card linkage.
2. Get the capability of searching for parameters of event and card linkage: GET

s, em
/ISAPI/AccessControl/EventCardLinkageCfg/search/capabilities?format=json .

A
no fr
3. Search for parameters of event and card linkage: POST /ISAPI/AccessControl/EventCardLinkageCfg/search?
format=json .

ri on
Ma oc
12.9.2.3 Delete Parameters of Specific Event and Card Linkage
up
1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportEventCardLinkageCfgDelete is returned and its value is "true", it indicates that the device supports
co gr

deleting parameters of event and card linkage.

es a@

2. Delete parameters of specific event and card linkage: PUT /ISAPI/AccessControl/EventCardLinkageCfgDelete?

Fr rc

format=json .
s
y ema

12.9.2.4 Get List of Event and Card Linkage ID

1. Call the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
os fr

isSupportEventCardNoList is returned and its value is true, it indicates that the device supports getting events and
the card linkage ID list.
ad on

2. Get the capability of the list of event and card linkage ID: GET
el .c

/ISAPI/AccessControl/EventCardNoList/capabilities?format=json .
ez

3. Get the list of event and card linkage ID: GET /ISAPI/AccessControl/EventCardNoList?format=json .
en

12.9.2.5 Optimize Event

im
ng

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
Aj

iisSupportEventOptimizationCfg is returned and its value is "true", it indicates that the device supports event
Co

optimization.
2. Get the configuration capability of event optimization: GET
/ISAPI/AccessControl/EventOptimizationCfg/capabilities?format=json .

3. Get the event optimization configuration parameters: GET|PUT /ISAPI/AccessControl/EventOptimizationCfg?

format=json .

12.10 Face Picture Management

12.10.1 Introduction to the Function
Face picture management includes searching, applying, adding, editing, deleting, and collecting face pictures.
12.10.2 API Calling Flow
12.10.2.1 Check Whether the Device Supports Face Picture Management

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez

Before calling the API for face picture management, make sure that the device supports face picture
en

management.
1. Check whether the device supports face picture management: GET /ISAPI/AccessControl/capabilities ; if the
im

node isSupportFDLib is returned and its value is “true”, it indicates that the device supports face picture
ng
Aj

management.
Co

2. Search, apply, add, edit, and delete face pictures.

3. If the node isSupportFDLib is returned and its value is “false”, it indicates that the device does not support face
picture management.
Note:
Before applying, adding, or editing face picture information on the device, make sure that the related person
information linked to the person ID has been applied to the device, and make sure that the device has its face
picture library by calling GET /ISAPI/Intelligent/FDLib?format=json (if the device has no face picture library,
then create the face picture library by calling POST /ISAPI/Intelligent/FDLib?format=json ), and the ID of the
library of face pictures captured in visible light (FDID) is 1.
If the value of the node mode returned by calling GET /ISAPI/AccessControl/FaceRecognizeMode/capabilities?
format=json contains “deepMode”, it indicates that the device supports the deep mode, which compares face
pictures captured in infrared light. For devices which support the deep mode, if the face picture library ID (FDID) is
2, face pictures captured in infrared light will be applied to the face picture library and be used for face picture
comparison; if the face picture library ID (FDID) is 1, face pictures captured in visible light will be applied to the face
picture library and be displayed on the device.
Switch between the deep mode and normal mode: [GET/PUT] /ISAPI/AccessControl/FaceRecognizeMode?
format=json ; the modes can be switched via the node mode.

12.10.2.2 Face Picture Search

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
The face picture search function is for searching the number of face pictures and face picture information
added to the device.

C. arc
1. Check whether the device supports face picture search: GET /ISAPI/Intelligent/FDLib/capabilities?
format=json ; if the value of the node supportFunction contains “get”, it indicates that the device supports face

s, em
picture search.

A
no fr
2. Search the number of face pictures in the specified face picture libraries: GET /ISAPI/Intelligent/FDLib/Count?
format=json&FDID=<FDID>&faceLibType=<faceLibType> ; the returned value of the node recordDataNumber is the

ri on
number of the added face pictures of the specified face picture libraries.

Ma oc
3. Search the number of face pictures in all face picture libraries: GET /ISAPI/Intelligent/FDLib/Count?
format=json ; the returned value of the node recordDataNumber is the number of face pictures in all face picture
up
libraries.
co gr

4. Search face picture information: POST /ISAPI/Intelligent/FDLib/FDSearch?format=json ; the face picture

information is returned by page.
es a@

5. If the value of the node supportFunction does not contain “get”, it indicates that the device does not support face
Fr rc

picture search.
y ema

Note:
The value of the node FDRecordDataMaxNum returned by calling GET /ISAPI/Intelligent/FDLib/capabilities?
os fr

format=json is the maximum number of face pictures supported by the device.

ad on

12.10.2.3 Face Picture Applying

el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en

Face picture information can be applied to the device via the face picture applying function. If the face
im

picture has been added to the device, the face picture information will be edited; if the face picture has not
ng
Aj

been added to the device, the face picture information will be added to the device.
Co

1. Check whether the device supports face picture applying: GET /ISAPI/Intelligent/FDLib/capabilities?
format=json ; if the value of the node supportFunction contains “setUp”, it indicates that the device supports face
picture applying.
2. Apply face picture information: PUT /ISAPI/Intelligent/FDLib/FDSetUp?format=json .
3. If the value of the node supportFunction does not contain “setUp”, it indicates that the device does not support face
picture applying.
Note:
Check whether the face picture has been added to the device via the node FPID returned by calling the API for face
picture applying, and link the face picture to the person information via the node FPID in face picture management and
the node employeeNo in person management.

12.10.2.4 Face Picture Adding

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en

Face picture information can be added to the device via the face picture adding function. If the face picture
im

has been added to the device, the device will report an error; if the face picture has not been added to the
ng

device, the face picture information will be added to the device.

Aj
Co

1. Check whether the device supports face picture adding: GET /ISAPI/Intelligent/FDLib/capabilities?
format=json ; if the value of the node supportFunction contains “post”, it indicates that the device supports face
picture adding.
2. Add face picture information: POST /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json .
3. If the value of the node supportFunction does not contain “post”, it indicates that the device does not support face
picture adding.
Note:
Check whether the face picture has been added to the device via the node FPID returned by calling the API for face
picture adding, and link the face picture to the person information via the node FPID in face picture management and
the node employeeNo in person management.

12.10.2.5 Face Picture Information Editing

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng

Face picture information on the device can be edited via the face picture information editing function. If the
Aj

face picture has been added to the device, the face picture information will be edited; if the face picture has
Co

not been added to the device, the device will report an error.
1. Check whether the device supports face picture information editing: GET
/ISAPI/Intelligent/FDLib/capabilities?format=json ; if the value of the node supportFunction contains “put”,
it indicates that the device supports face picture information editing.
2. Edit face picture information: PUT /ISAPI/Intelligent/FDLib/FDModify?format=json .
3. If the value of the node supportFunction does not contain “put”, it indicates that the device does not support face
picture information editing.
Note:
Check whether the face picture has been added to the device via the node FPID returned by calling the API for face
picture information editing, and link the face picture to the person information via the node FPID in face picture
management and the node employeeNo in person management.
12.10.2.6 Face Picture Deleting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj

The face picture information on the device can be deleted via the face picture deleting function. The device
Co

will not report an error if the face picture to be deleted is not added to the device.
1. Check whether the device supports face picture deleting: GET /ISAPI/Intelligent/FDLib/capabilities?
format=json ; if the value of the node supportFunction contains “delete”, it indicates that the device supports face
picture deleting.
2. Delete face pictures: PUT /ISAPI/Intelligent/FDLib/FDSearch/Delete?format=json&FDID=<FDID>&faceLibType=
<FDType> ; if calling succeeded, it indicates that the device has deleted the face pictures.
3. If the value of the node supportFunction does not contain “delete”, it indicates that the device does not support
face picture deleting.
Note:
All the face picture libraries and the face picture information in the libraries on the device can be deleted by calling
DELETE /ISAPI/Intelligent/FDLib?format=json .
12.10.2.7 Face Picture Collecting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

Face picture data, face picture quality grades, etc., can be collected via the face picture collecting function.
1. Check whether the device supports face picture collecting: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportCaptureFace is returned and its value is “true”, it indicates that the device supports face picture (captured
in visible light) collecting. If the node isSupportCaptureInfraredFace is returned and its value is “true”, it indicates
that the device supports face picture (captured in infrared light) collecting.
2. Collect face picture information: POST /ISAPI/AccessControl/CaptureFaceData .
If the node captureProgress is returned, and the value is 100, it indicates that the face picture has been collected,
and the binary data or URL of the collected face picture will be parsed.
If the node captureProgress is returned and the value is 0, it indicates that the face picture has not been collected,
and you need to get the progress of face picture collecting.
3. Get the progress of face picture collecting: GET /ISAPI/AccessControl/CaptureFaceData/Progress ; repeatedly
call this API to get the progress of face picture collecting.
Repeatedly call this API until the node captureProgress is returned and its value is 100, which indicates that the
face picture has been collected and the binary data and URL of the face picture will be parsed.
If the value of the node captureProgress is 0 and the value of the isCurRequestOver is true, which indicates that the
face picture collecting failed, stop calling the API.

m
4. If the node isSupportCaptureFace is returned and its value is “false”, it indicates that the device does not support

co
face picture collecting.

a.
12.11 Fingerprint Management

C. arc
12.11.1 Introduction to the Function
Fingerprint management includes searching, applying, deleting, and collecting fingerprints.

s, em
A
12.11.2 API Calling Flow

no fr
ri on
12.11.2.1 Check Whether the Device Supports Fingerprint Management

Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez

Before calling the API for fingerprint management, make sure that the device supports fingerprint
en

management.
im

1. Check whether the device supports fingerprint management: GET /ISAPI/AccessControl/capabilities ; if the
ng

node isSupportFingerPrintCfg is returned and its value is “true”, it indicates that the device supports fingerprint
Aj

management.
Co

2. Search, apply, add, and edit fingerprints.

3. If the node isSupportFingerPrintCfg is returned and its value is “false”, it indicates that the device does not support
fingerprint management.
Note:
Before applying the fingerprint information to the device, make sure that the related person information linked to
the person ID has been applied to the device.
The maximum number of fingerprints that can be applied to the device per person is 10 (the 10 fingerprints of a
person).

12.11.2.2 Fingerprint Search

Aj
im
Co en
ng ez
el .c
ad on
os fr
y ema
Fr rc
es a@
co gr
s up
Ma oc
ri on
no fr
s, em
C. arc
A a.
co
m
The fingerprint search function is for searching the number of fingerprints and fingerprint information
added to the device.
1. Check whether the device supports fingerprint search: GET
/ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json ; if calling succeeded, it indicates that the
device supports fingerprint search.
2. Search the number of the specified persons’ fingerprints: GET /ISAPI/AccessControl/FingerPrint/Count?
format=json&employeeNo=<employeeNo> ; the returned value of the node numberOfFP is the number of the added
fingerprints of the specified persons.
3. Search the number of fingerprints of all persons: GET /ISAPI/AccessControl/FingerPrint/Count?format=json ;

m
the returned value of the node numberOfFP is the number of the added fingerprints of all persons.

co
4. Search fingerprint information: POST /ISAPI/AccessControl/FingerPrintUpload?format=json ; the fingerprint

a.
information is returned by page. If the value of the child node status of the node FingerPrintInfo is “NoFP”, it
indicates that all fingerprint information are returned.

C. arc
5. If calling failed, it indicates that the device does not support fingerprint search.

s, em
Note:

A
no fr
The value of the node fingerPrintCapacity returned by calling GET
/ISAPI/AccessControl/CardReaderCfg/<cardReaderID>?format=json is the maximum number of fingerprints

ri on
supported by the card reader.

Ma oc
The value of the node fingerPrintNum returned by calling GET
up
/ISAPI/AccessControl/CardReaderCfg/<cardReaderID>?format=json is the number of fingerprints added to the
card reader.
co gr

12.11.2.3 Fingerprint Applying

es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng

Fingerprint information can be applied to the device via the fingerprint applying function. If the fingerprint
Aj

has been added to the device, the fingerprint information will be edited; if the fingerprint has not been
Co

added to the device, the fingerprint will be added to the device.

1. Check whether the device supports fingerprint applying: GET
/ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json ; if the node isSupportSetUp is returned and
its value is “true”, it indicates that the device supports fingerprint applying.
2. Apply fingerprint information: POST /ISAPI/AccessControl/FingerPrint/SetUp?format=json .
3. If the node isSupportSetUp is returned and its value is false, it indicates that the device does not support
fingerprint applying.
Note:
Check whether the fingerprint has been added to the device via the nodes employeeNo and fingerPrintID returned after
calling the API for fingerprint applying.

12.11.2.4 Fingerprint Adding

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

Fingerprint information can be added to the device via the fingerprint adding function. If the fingerprint has
been added to the device, the device will report an error; if the fingerprint has not been added to the device,
the fingerprint will be added to the device.
1. Check whether the device supports fingerprint adding: GET
/ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json ; if calling succeeded, it indicates that the
device supports fingerprint adding.
2. Add fingerprint information: POST /ISAPI/AccessControl/FingerPrintDownload?format=json ; if calling
succeeded, it indicates that the device has started to execute fingerprint adding, but it does not indicate that the
device has added the fingerprint.
3. Get the progress of fingerprint adding: GET /ISAPI/AccessControl/FingerPrintProgress?format=json ;
repeatedly call this API to get the progress of fingerprint adding.
4. If calling failed, it indicates that the device does not support fingerprint adding.
Note:
Check whether the fingerprint has been added to the device via the nodes employeeNo and fingerPrintID returned after
calling the API for fingerprint adding.

12.11.2.5 Fingerprint Information Editing

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The fingerprint information on the device can be edited via the fingerprint information editing function. If
the fingerprint has been added to the device, the fingerprint information will be edited; if the fingerprint
has not been added to the device, the device will report an error.
1. Check whether the device supports fingerprint information editing: GET
/ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json ; if calling succeeded, it indicates that the
device supports fingerprint information editing.
2. Edit fingerprint information: POST /ISAPI/AccessControl/FingerPrintModify?format=json .
3. If calling failed, it indicates that the device does not support fingerprint information editing.
Note:
Check whether the fingerprint has been added to the device via the nodes employeeNo and fingerPrintID returned
after calling the API for fingerprint information editing.
When the fingerprint information is edited, only the fingerprint parameters will be edited; the fingerprint data will
not be edited.

12.11.2.6 Fingerprint Deleting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The fingerprint information on the device can be deleted via the fingerprint deleting function. The device
will not report an error if the fingerprint information to be deleted is not added to the device.
1. Check whether the device supports fingerprint deleting: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportFingerPrintDelete is returned and its value is “true”, it indicates that the device supports fingerprint
deleting.
2. Delete fingerprint information: PUT /ISAPI/AccessControl/FingerPrint/Delete?format=json ; if calling
succeeded, it indicates that the device has started to execute fingerprint deleting, but it does not indicate that the
device has deleted the fingerprints.
3. Get the progress of fingerprint deleting: GET /ISAPI/AccessControl/FingerPrint/DeleteProcess?format=json ;
repeatedly call this API to get the progress of fingerprint deleting.
4. If the node isSupportFingerPrintDelete is returned and its value is “false”, it indicates that the device does not
support fingerprint deleting.

12.11.2.7 Fingerprint Collecting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The fingerprint collecting function is for collecting the fingerprint data, fingerprint quality, etc.
1. Check whether the device supports fingerprint collecting: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportCaptureFingerPrint is returned and its value is “true”, it indicates that the device supports fingerprint
collecting.
2. Collect fingerprint information: POST /ISAPI/AccessControl/CaptureFingerPrint .
3. If the node isSupportCaptureFingerPrint is returned and its value is “false”, it indicates that the device does not
support fingerprint collecting.
12.12 Holiday Schedule of Voice Prompt
12.12.1 Introduction to the Function
You can configure TTS texts or audio files of access authentication for holiday schedule.

12.12.2 API Calling Flow

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
Aj
im
Co en
ng ez
el .c
ad on
os fr
y ema
Fr rc
es a@
co gr
s up
Ma oc
ri on
no fr
s, em
C. arc
A a.
co
m
ISAPI Protocol Calling Flow: 1.Check whether the device supports holiday schedule of voice prompt (get the
capability of access control): GET /ISAPI/AccessControl/capabilities?format=json ; if the node
isSupportTTSTextHolidayPlan is returned and its value is "true", it indicates that the device supports holiday schedule
management of voice prompt; 2.Get the capability of holiday schedule parameters of voice prompt: GET
/ISAPI/AccessControl/Verification/ttsText/holidayPlan/capabilities?format=json ; 3.Get holiday schedule of
voice prompt: GET /ISAPI/AccessControl/Verification/ttsText/holidayPlan/<holidayPlanID>?format=json ;
configureholiday schedule of voice prompt: PUT
/ISAPI/AccessControl/Verification/ttsText/holidayPlan/<holidayPlanID>?format=json ; delete holiday schedule
of voice prompt: DELETE /ISAPI/AccessControl/Verification/ttsText/holidayPlan/<holidayPlanID>?

m
format=json ; 4.Check whether the device supports searching for holiday schedule of voice prompt (get the capability of

co
access control): GET /ISAPI/AccessControl/capabilities?format=json ; if the node
isSupportTTSTextSearchHolidayPlan is returned and its value is "true", it indicates that the device supports searching for

a.
holiday schedule parameters; 5.Get the capability of searching for holiday schedule parameters of voice prompt: GET

C. arc
/ISAPI/AccessControl/Verification/ttsText/holidayPlan/capabilities?format=json ; 6.Search for holiday
schedule of voice prompt: POST /ISAPI/AccessControl/Verification/ttsText/searchHolidayPlan?format=json ;

s, em
12.13 ID Card Allowlist Management

A
no fr
12.13.1 Introduction to the Function

ri on
The device supports importing, clearing, and verifying the ID card blocklist, which is used for verifying whether the card

Ma oc
holder is in the list, e.g., when people are checking-in to an examination, they can be verified by their ID cards since the
device of each examination hall is applied different list of ID cards.
up
co gr

12.13.2 API Calling Flow

es a@

12.13.2.1 Apply ID Card Allowlist

Fr rc

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the nodes
s

isSupportExportIDAllowListTemplateByURL, isSupportExportIDAllowListTemplateByBinary, and

y ema

isSupportIDAllowListTask are returned and the value is "true", it indicates that the device supports exporting the ID
card allowlist template in URL, exporting the ID card allowlist template in binary format, and importing the ID card
os fr

allowlist.
2. Get the ID card allowlist template in binary format: GET
ad on

/ISAPI/AccessControl/IDAllowList/ExportTemplateByBinary?format=json ; or get the parameters of the ID card

el .c

allowlist template in URL:GET /ISAPI/AccessControl/IDAllowList/ExportTemplateByURL/capabilities?

format=json , and then get the ID card allowlist template in URL: GET
ez

/ISAPI/AccessControl/IDAllowList/ExportTemplateByURL?format=json .
en

3. Get the parameters of importing the ID card allowlist: GET

/ISAPI/AccessControl/IDAllowList/Task/capabilities?format=json ; and get whether the device supports
im

creating tasks, searching task status, and searching task results, etc.
ng
Aj

4. Create the task of applying the ID card allowlist: POST /ISAPI/AccessControl/IDAllowList/Task?format=json .

5. Search the task status of importing the ID card allowlist: POST

/ISAPI/AccessControl/IDAllowList/SearchTaskProgress?format=json ; the task progress and status will be
returned by the device. Repeatedly calling this API until the value of the node "percent" returns 100%, and the
value of the node "taskExecutionStatus" returns "completed".
6. Search the task results of applying the ID card allowlist: POST
/ISAPI/AccessControl/IDAllowList/SearchTaskResult?format=json&security=<security>&iv=<iv> ;
information such a s name, address, and ID card No. should be encrypted. Note: the API calling flow of
applying ID card allowlist is the same as that of applying ID card blocklist by task.

12.13.2.2 Clear ID Card Blocklist

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the nodes
isSupportIDAllowListParamCfg is returned and its value is "true", it indicates that the device supports clearing the
ID card allowlist.
2. Clear the ID card allowlist: PUT /ISAPI/AccessControl/IDAllowListClear?format=json .

12.13.2.3 Configure Parameters of ID Card Allowlist:

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportIDAllowListParamCfg is returned and its value is "true", it indicates that the device supports configuring
the parameters of the ID card allowlist.
2. Get the parameters of applying the ID card allowlist: GET
/ISAPI/AccessControl/IDAllowList/ParamCfg/capabilities?format=json .
3. Get and configure the parameters of the ID card allowlist: GET|PUT

m
/ISAPI/AccessControl/IDAllowList/ParamCfg?format=json .

co
a.
12.14 ID Card Blocklist Management

C. arc
12.14.1 Introduction to the Function
The device supports importing, clearing, and verifying the ID card blocklist, which is used for verifying whether the card

s, em
holder is in the list, e.g., before a person registers in a hotel, his/her ID card need to be checked for verifying if the

A
no fr
person is in the wanted suspect list.

ri on
12.14.2 API Calling Flow
12.14.2.1 Apply ID Card Blocklist
Ma oc
up
12.14.2.1.1 Apply Single ID Card of Blocklist
co gr

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the nodes
isSupportIDBlackListTemplate and isSupportIDBlackListCfg are returned and the value is "true", it indicates that the
es a@

device supports exporting the ID card blocklist template and applying the ID card blocklist.
Fr rc

2. Get the ID card blocklist template: GET /ISAPI/AccessControl/IDBlackListCfg/template?format=json .

y ema

3. Get the capability of applying ID card blocklist: GET /ISAPI/AccessControl/IDBlackListCfg/capabilities .

4. Apply the ID card blocklist for each ID card: PUT /ISAPI/AccessControl/IDBlackListCfg?security=
<security>&iv=<iv> ; information such a s name, address, and ID card No. should be encrypted.
os fr

12.14.2.1.2 Apply ID Card of Blocklist by Task

ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the nodes
en

isSupportIDBlackListTemplate and isSupportIDBlackListCfg are returned and the value is "true", it indicates that the
device supports exporting the ID card blocklist template and applying the ID card blocklist.
im

2. Get the ID card blocklist template: GET /ISAPI/AccessControl/IDBlackListCfg/template?format=json .

ng
Aj

3. Get the capability of applying ID card blocklist: GET /ISAPI/AccessControl/IDBlockList/Task/capabilities?

format=json ; get whether the device supports creating tasks, searching task status, and searching task results, etc.
4. Create the task of importing the ID card blocklist: POST /ISAPI/AccessControl/IDBlockList/Task?format=json .
5. Search the task status of importing the ID card blocklist: POST
/ISAPI/AccessControl/IDBlockList/SearchTaskProgress?format=json ; the task progress and status will be
returned by the device. Repeatedly calling this API until the value of the node "percent" returns 100%, and the
value of the node "taskExecutionStatus" returns "completed".
6. Search for the task results of applying the ID card blocklist: POST
/ISAPI/AccessControl/IDBlockList/SearchTaskResult?format=json&security=<security>&iv=<iv> ;
information such a s name, address, and ID card No. should be encrypted.

12.14.2.2 Clear ID Card Blocklist

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportIDBlackListClear is returned and its value is "true", it indicates that the device supports clearing the ID
card blocklist.
2. Clear the ID card blocklist: PUT /ISAPI/AccessControl/IDBlackListClear?format=json .

12.14.2.3 Configure Parameters of ID Card Blocklist

1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportIDBlackListParamCfg is returned and its value is "true", it indicates that the device supports configuring
the parameters of the ID card blocklist.
2. Get the capability of applying ID card blocklist: GET /ISAPI/AccessControl/IDBlackListParamCfg/capabilities?
format=json .

m
co
3. Get and configure the parameters of the ID card blocklist: GET|PUT /ISAPI/AccessControl/IDBlackListParamCfg?
format=json .

a.
12.15 ID Card Software Decoding

C. arc
12.15.1 Introduction to the Function

s, em
If this function is enabled, the device can get information via the software decoding such as ID card No. and pictures; if

A
no fr
this function is disabled, the device can only get the card serial No.

ri on
12.15.2 API Calling Flow

Ma oc
1. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportIDCardSoftSolutionParams is returned and its value is "true", it indicates that the device supports
up
software decoding ID cards.
co gr

2. Get the parameters of software decoding ID cards: GET

/ISAPI/AccessControl/IDCardMgr/IDCardSoftSolutionParams/capabilities?format=json .
es a@

3. Get and configure the parameters of the software decoding ID cards: GET|PUT
Fr rc

/ISAPI/AccessControl/IDCardMgr/IDCardSoftSolutionParams?format=json .
y ema

12.16 Iris Data Management

os fr

12.16.1 Introduction to the Function

ad on

Iris data management includes searching, applying, adding, editing, deleting, and collecting iris data.
el .c

12.16.2 API Calling Flow

12.16.2.1 Check Whether the Device Supports Iris Data Management

en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on

Before calling the API for iris data management, make sure that the device supports iris data management:
el .c

1. Check whether the device supports iris data management: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportIrisInfo is returned and its value is true, it indicates that the device supports iris data management.
ez

2. Search, apply, add, edit, and delete iris data.

3. If the node isSupportIrisInfo is returned and its value is false, it indicates that the device does not support iris data
management.
im
ng

Note:
Aj
Co

Before applying, adding, and editing the iris data on the device, make sure that the related person information
linked to the person ID has been applied to the device.
Data for up to two irises of each person (two eyes of each person) can be applied to the device.

12.16.2.2 Iris Data Search

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The iris data search function is for searching the number of irises and iris information added to the device.
1. Check whether the device supports iris data search: GET /ISAPI/AccessControl/IrisInfo/capabilities?
format=json ; if the node supportFunction is returned, and the value contains “get”, it indicates that the device
supports iris data search.
2. Search the number of irises: GET /ISAPI/AccessControl/IrisInfo/count?format=json ; the value of the node
IrisNumber is the number of added irises on the device.
3. Search iris information: POST /ISAPI/AccessControl/IrisInfo/search?format=json ; the searched iris
information will be returned by page.
4. If the value of the node supportFunction does not contain “get”, it indicates that the device does not support iris
data search.
Note:
The value of the node maxRecordNum returned by calling GET /ISAPI/AccessControl/IrisInfo/capabilities?
format=json is the maximum number of irises supported by the device.

12.16.2.3 Iris Data Applying

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The iris data applying function is for applying iris information to the device. If the iris data has already been
applied to the device, the information about the iris will be edited; if the iris data has not been applied to
the device, the iris information will be added to the device.
1. Check whether the device supports iris data applying: GET /ISAPI/AccessControl/IrisInfo/capabilities?
format=json ; if the node supportFunction is returned and the value contains “setUp”, it indicates that the device
supports iris data applying.
2. Iris Data Applying: PUT /ISAPI/AccessControl/IrisInfo/setup?format=json .
3. If the value of the node supportFunction does not contain “setUp”, it indicates that the device does not support iris
data applying.
Note:
Check whether the iris data have been applied to the device via the nodes employeeNo and id returned by calling the
API for iris data applying.

12.16.2.4 Iris Data Adding

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The iris data adding function is for adding the iris data to the device. If the iris data have already been
added to the device, the device will report an error; if the iris data have not been added to the device, the
iris data will be added to the device.
1. Check whether the device supports iris data adding: GET /ISAPI/AccessControl/IrisInfo/capabilities?
format=json ; if the value of the node supportFunction contains “post”, it indicates that the device supports iris data
applying.
2. Add iris data: POST /ISAPI/AccessControl/IrisInfo/record?format=json .
3. If the value of the node supportFunction does not contain “post”, it indicates that the device does not support iris
data applying.
Note:
Check whether the iris data have been applied to the device via the nodes employeeNo and id returned by calling the
API for iris data adding.

12.16.2.5 Iris Data Editing

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The iris data editing function is for editing the applied iris information on the device. If the iris data have
already been added to the device, the iris information will be edited; if the iris data have not been added to
the device, the device will report an error.
1. Check whether the device supports iris data editing: GET /ISAPI/AccessControl/IrisInfo/capabilities?
format=json ; if the value of the node supportFunction contains “put”, it indicates that the device supports iris data
editing.
2. Edit iris information: PUT /ISAPI/AccessControl/IrisInfo/modify?format=json .
3. If the value of the node supportFunction does not contain “put”, it indicates that the device does not support iris
data editing.
Note:
Check whether the iris data have been applied to the device via the nodes employeeNo and id returned by calling the
API for iris data editing.

12.16.2.6 Iris Data Deleting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj

The iris data deleting function is for deleting the applied iris information on the device. If the iris data to be
Co

deleted have not been applied to the device, the device will not report an error.
1. Check whether the device supports iris data deleting: GET /ISAPI/AccessControl/IrisInfo/capabilities?
format=json ; if the value of the node supportFunction contains “delete”, it indicates that the device supports iris
data deleting.
2. Delete iris information: PUT /ISAPI/AccessControl/IrisInfo/delete?format=json ; if calling succeeded, it
indicates that the iris information has been deleted.
3. If the value of the node supportFunction does not contain “delete”, it indicates that the device does not support iris
data deleting.

12.16.2.7 Iris Data Collecting

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The iris data collecting function is for collecting iris data and information.
1. Check whether the device supports iris data collecting: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportCaptureIrisData is returned and its value is “true”, it indicates that the device supports iris data collecting.
2. Collect iris information: POST /ISAPI/AccessControl/captureIrisData?format=json ; if calling succeeded, it
indicates that the device has started to execute the collection.
3. Get the progress of iris data collecting: GET /ISAPI/AccessControl/captureIrisData/progress?format=json ;
repeatedly call this API until the value of captureProgress is returned and is 100, which indicates that the collecting
completed.
4. If the node isSupportCaptureIrisData is returned and its value is “false”, it indicates that the device does not
support iris data collecting.
12.17 Multi-Factor Authentication
12.17.1 Introduction to the Function
In some scenarios with higher security levels, you can set rules that the door will only open when different persons
authenticate in the access control point during fixed time.

m
For example, in a bank, a door will only open after two or more persons are authenticated (such as swiping card,

co
authenticated by fingerprint, face picture, iris, etc.). If a door is configured multi-factor authentication, the number
authentication persons, authentication order, and authentication methods should follow the rules.

a.
12.17.2 API Calling Flow

C. arc
12.17.2.1 Group Parameter Configuration

s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The API calling flow is as follow:

1. Check whether the device supports configuring group parameters: GET /ISAPI/AccessControl/capabilities ; if
the node isSupportGroupCfg is returned and its value is "true", it indicates that the device supports configuring
group parameters.
2. Set group parameters: [GET/PUT] /ISAPI/AccessControl/GroupCfg/<groupID>?format=json .
3. If the node isSupportGroupCfg is returned and its value is "false", it indicates that the device does not support
configuring group parameters.

12.17.2.2 Add Person to Group

After configuring the group parameters, the person and group will be linked through ****person management in the
process of person and credential management integration (through the belongGroup field). The corresponding
interface is as follows:
1. Set person information: PUT /ISAPI/AccessControl/UserInfo/SetUp?format=json
2. Add person information: POST /ISAPI/AccessControl/UserInfo/Record?format=json

m
co
3. Edit person information: PUT /ISAPI/AccessControl/UserInfo/Modify?format=json
No more than 4 groups can be linked to one person.

a.
C. arc
12.17.2.3 Multi-Factor Authentication Mode Configuration

s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The API calling flow is as follow:

1. Check whether the device supports configuring multi-factor authentication mode: GET
/ISAPI/AccessControl/capabilities ; if the node isSupportMultiCardCfg is returned and its value is "true", it
indicates that the device supports configuring multi-factor authentication mode (and the device also supports
configuring group parameters).
2. Set multi-factor authentication mode: [GET/PUT] /ISAPI/AccessControl/MultiCardCfg/<doorID>?format=json
3. If the node isSupportVerifyWeekPlanCfg is returned and its value is "false", it indicates that the device does not
support configuring multi-factor authentication mode.
12.18 Person and Credential Management
12.18.1 Introduction to the Function
The person and credential management function is person-based, and is for managing persons, credentials (cards,
fingerprints, face pictures, and iris data), and permission schedules which control the permissions for persons to enter
and exit the controlled areas. Its architecture is shown below.

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
This document mainly introduces the calling flows for person management and credential management (card,
fingerprint, face picture, iris data management). For details about the calling flow for permission schedule management,
co gr

refer to the “Management of Permission Schedules for Persons and Access Points”.
es a@

12.19 Person Management

Fr rc

12.19.1 Introduction to the Function

y ema

Person management includes searching, applying, adding, editing, and deleting persons.
os fr

12.19.2 API Calling Flow

ad on

12.19.2.1 Check Whether the Device Supports Person Management

el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez

Before calling the API for person management, make sure that the device supports person management.
en

1. Check whether the device supports person management: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportUserInfo is returned and its value is true, it indicates that the device supports person management.
im

2. Search, apply, add, and edit persons.

ng
Aj

3. If the node isSupportUserInfo is returned and its value is false, it indicates that the device does not support person
Co

management.
Note:
The person ID (EmployeeNo) is the unique identifier for person and credential management. After calling GET
/ISAPI/AccessControl/capabilities , through the child nodes of EmployeeNoInfo which are employeeNo,
characterType, and isSupportCompress, the maximum string length and character types of the person ID supported by
the device can be checked. Generally, devices support up to 32 bytes and any type of characters. But for access
controllers and distribution-type access control devices, check through the child nodes mentioned above.

12.19.2.2 Person Search

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The person search function is for searching the number of persons and person information added to the
device.
1. Check whether the device supports person search: GET /ISAPI/AccessControl/UserInfo/capabilities?
format=json ; if the value of the node supportFunction contains “get”, it indicates that the device supports person
search.
2. Search the number of persons: GET /ISAPI/AccessControl/UserInfo/Count?format=json ; the returned value of
the node userNumber is the number of the persons added to the device.
3. Search person information: POST /ISAPI/AccessControl/UserInfo/Search?format=json ; the person information
is returned by page.
4. If the value of the node supportFunction does not contain “get”, it indicates that the device does not support
person search.
Note:
The value of the node maxRecordNum returned by calling GET /ISAPI/AccessControl/UserInfo/capabilities?

m
format=json is the maximum number of persons supported by the device.

co
12.19.2.3 Person Applying

a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

Person information can be applied to the device via the person applying function. If the person has been
added to the device, the person information will be edited; if the person has not been added to the device,
the person information will be applied to the device.
1. Check whether the device supports person applying: GET /ISAPI/AccessControl/UserInfo/capabilities?
format=json ; if the value of the node supportFunction contains “setUp”, it indicates that the device supports
person applying.
2. Apply person information: PUT /ISAPI/AccessControl/UserInfo/SetUp?format=json .
3. If the value of the node supportFunction does not contain setUp, it indicates that the device does not support
person applying.
Note:
Check whether the person has been added to the device via the node employeeNo returned after calling the API for
person applying.

m
co
12.19.2.4 Person Adding

a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

Person can be added to the device via the person adding function. If the person has been added to the
device, the device will report an error; if the person has not been added to the device, the person will be
added to the device.
1. Check whether the device supports person adding: GET /ISAPI/AccessControl/UserInfo/capabilities?
format=json ; if the value of the node supportFunction contains “post”, it indicates that the device supports person
adding.
2. Add persons: POST /ISAPI/AccessControl/UserInfo/Record?format=json .
3. If the value of the node supportFunction does not contain “post”, it indicates that the device does not support
person adding.
Note:
Check whether the person has been added to the device via the node employeeNo returned after calling the API for

m
person adding.

co
12.19.2.5 Person Information Editing

a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
Person information added to the device can be edited via the person information editing function. If the
person has been added to the device, the person information will be edited; if the person has not been
added to the device, the device will report an error.
1. Check whether the device supports person information editing: GET
/ISAPI/AccessControl/UserInfo/capabilities?format=json ; if the value of the node supportFunction contains
“put”, it indicates that the device supports person information editing.
2. Edit Person Information: PUT /ISAPI/AccessControl/UserInfo/Modify?format=json .
3. If the value of the node supportFunction does not contain “put”, it indicates that the device does not support
person information editing.

m
co
Note:

a.
Check whether the person has been added to the device via the node employeeNo returned after calling the API for
person information editing.

C. arc
12.19.2.6 Person Deleting

s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

The person added to the device can be deleted via the person deleting function. The device will not report
an error if the person to be deleted is not added to the device.
1. Check whether the device supports person deleting: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportUserInfoDetailDelete is returned and its value is “true”, it indicates that the device supports person
deleting.
2. Delete persons: PUT /ISAPI/AccessControl/UserInfoDetail/Delete?format=json ; if calling succeeded, it
indicates that the device has started to execute person deleting, but it does not indicate that the device has deleted
the person.
3. Get the progress of deleting person information: GET /ISAPI/AccessControl/UserInfoDetail/DeleteProcess ;
repeatedly call this API to get the progress of person deleting.
4. If the node isSupportUserInfoDetailDelete is returned and its value is “false”, it indicates that the device does not
support person deleting.
Note:
When the person is deleted, the information on the credentials (the card, fingerprint, face picture, and iris data) linked
via the person ID will also be deleted.

12.20 Remote Verification

12.20.1 Introduction to the Function

m
For scenes with high-level security/protection requirements, it requires not only the device's local authentication but

co
also the platform's verification before enabling door controlling.

a.
For example, in scenes such as pandemic control and prevention, after completing authentication/temperature
measurement of the person, the device will upload the event to the platform, and the platform will search for the

C. arc
person's recent trip information according to the uploaded information and apply the verification result to the device
for controlling door after confirming the person's trip does not involve risk areas.

s, em
A
12.20.2 API Calling Flow

no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
The API calling flow is as follow:
up
1. Check whether the device supports remote verification: GET /ISAPI/AccessControl/capabilities . If the node
isSupportRemoteCheck is returned and its value is true, it indicates that the device supports remote verification.
co gr

2. Configure verification parameters: [GET/PUT] /ISAPI/AccessControl/AcsCfg?format=json ; configure the

es a@

verification parameters via the nodes including remoteCheckDoorEnabled, checkChannelType, channelIp and
needDeviceCheck.
Fr rc

3. Upload events to be verified: when the node remoteCheck of the following events (AccessControllerEvent/
y ema

IDCardInfoEvent/ QRCodeEvent/ FaceTemperatureMeasurementEvent) is returned and its value is true, it indicates

that this event requires remote verification.
os fr

4. Perform remote verification: PUT /ISAPI/AccessControl/remoteCheck?format=json . Apply remote verification

result.
ad on

5. Remote verification is not supported by this device.

el .c

12.21 Reset Anti-Passback Rule (Additional Function)

12.21.1 Introduction to the Function

Anti-passback rules which can be reset:

1. Reset by authentication interval. This function will take effect in specific time period after the anti-passbak is
ng

triggered. If the user trigger the function by swiping a card by route, the anti-passback flag will be reset in certain
Aj

time.
Co

2. Reset by time. The anti-passback flag will be reset automatically in certain time.
3. Invalid mode. The resetting rule is disabled.
Application scenarios: The anti-passback function will be help to reduce the cost of manual monitoring. Anti-passback
by time period and by time cannot set at the same time.

12.21.2 API Calling Flow

Calling Flow:
m
co
a.
C. arc
s, em
A
no fr
ri on
ISAPI Protocol Calling Flow: Ma oc
up
1. Get the capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
co gr

isSupportAntiPassbackResetRules is returned and its value is "true", it indicates that the device supports resetting
es a@

rules of anti-passback.
2. Get resetting rules of anti-passback: GET /ISAPI/AccessControl/AntiPassback/resetRules?format=json ;
Fr rc

configure resetting rules of anti-passback: PUT /ISAPI/AccessControl/AntiPassback/resetRules?format=json .

y ema

12.22 Schedules Management of Persons' Access Permission

os fr

12.22.1 Introduction to the Function

ad on

It is required to connect to door permission and schedule template of access permission related to each door before
applying permissions to persons. For applying permissions to persons, see calling flow of Person Management of
el .c

Person and Credential Management. Configuring schedules of persons' access permission is required, or the related
ez

persons cannot access.

1 weekly schedule and 4 holiday groups can be added in each schedule template. The priority of holiday schedule is
higher than that of weekly schedule. Weekly schedule can be configured by day of a week and 8 different time period of
im

a day. 16 holiday schedules can be added to a holiday group schedule. Each holiday schedule has its start and end day,
ng

and the time period is same in the holiday range (8 time periods can be added). The access control can follow the
Aj

schedule template to manage person's permissions by time.

Co
12.22.2 API Calling Flow
12.22.2.1 Schedule Template of Persons' Access Permission

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

Calling Flow:
1. Check whether the device supports schedule template configuration of person's permission: GET
/ISAPI/AccessControl/capabilities ; if the node isSupportUserRightPlanTemplate is returned and its value is
"true", it indicates that the device supports schedule template configuration of person's permission (if it supports, it
also supports weekly schedule configuration of persons' permission).
2. Schedule template configuration of persons' permission: [GET/PUT]
/ISAPI/AccessControl/UserRightPlanTemplate/<planTemplateID>?format=json .
3. Configuring schedule template of persons' access permission control for the device is not supported.
12.22.2.2 Weekly Schedule of Persons' Access Permission

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

Calling Flow:
1. Check whether the device supports weekly schedule configuration of persons' permissions: GET
/ISAPI/AccessControl/capabilities ; if the node isSupportCardRightWeekPlanCfg is returned and its value is
"true", it indicates that the device supports weekly schedule configuration of person's permissions.
2. Weekly schedule configuration of persons' permissions:[GET/PUT]
/ISAPI/AccessControl/UserRightWeekPlanCfg/<weekPlanID>?format=json .
3. Configuring weekly schedule of persons' access permission control for the device is not supported.

12.22.2.3 Holiday Groups of Persons' Access Permission

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj

Calling Flow:
Co

1. Check whether the device supports holiday group configuration of person's permissions: GET
/ISAPI/AccessControl/capabilities ; if the nodeisSupportUserRightHolidayGroupCfg is returned and its value is
"true", it indicates that the device supports holiday group configuration of person's permission (if it supports, it
also supports holiday schedule configuration of persons' permissions).
2. Holiday group configuration of persons' permissions:[GET/PUT]
/ISAPI/AccessControl/UserRightHolidayGroupCfg/<holidayGroupID>?format=json .
3. Configuring holiday groups of persons' access permission control for the device is not supported.

12.22.2.4 Holiday Schedule of Persons' Access Permission

m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

Calling Flow:
1. Check whether the device supports holiday schedule configuration of persons' permissions: GET
/ISAPI/AccessControl/capabilities ; if the node isSupportCardRightHolidayPlanCfg is returned and its value is
"true", it indicates that the device supports holiday schedule configuration of person's permissions.
2. Holiday schedule configuration of persons' permissions:[GET/PUT]
/ISAPI/AccessControl/UserRightHolidayPlanCfg/<holidayPlanID>?format=json .

3. Configuring holiday schedule of persons' access permission control for the device is not supported.
12.23 Search for QR Code Scanning Event
4. Get the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportQRCodeEvent is returned and its value is "true", it indicates that the device supports searching for QR
code scanning events.
5. Get the capability of searching for QR code scanning events: GET
/ISAPI/AccessControl/QRCodeEvent/capabilities?format=json .

6. Search for QR code scanning events: POST /ISAPI/AccessControl/QRCodeEvent?format=json . Notes: the device

m
displays QR code rather than authentication information.

co
12.24 Store and Search for Access Control Event

a.
C. arc
12.24.1 Introduction to the Function
The device supports configuring storage parameters of access control event, searching for access control events, and

s, em
searching for the amount of access control events. There are three storage modes: deleting old events periodically,

A
deleting old events by specified time and overwriting.

no fr
ri on
12.24.2 API Calling Flow

Ma oc
12.24.2.1 Configure Storage Parameters of Access Control Events
up
1. Call the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportEventStorageCfg is returned and its value is "true", it indicates that the device supports configuring the
co gr

storage parameters of access control events.

es a@

2. Get the configuration capability of storing access control events: GET

Fr rc

/ISAPI/AccessControl/AcsEvent/StorageCfg/capabilities?format=json .
y ema

3. Get and set storage parameters of access control events: GET|PUT /ISAPI/AccessControl/AcsEvent/StorageCfg?
format=json .
os fr

12.24.2.2 Search for Access Control Events

ad on

1. Call the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
el .c

isSupportAcsEvent is returned and its value is "true", it indicates that the device supports searching for access
control events.
ez

2. Get the capability of searching for access control events: GET /ISAPI/AccessControl/AcsEvent/capabilities?
en

format=json .
im

3. Search for access control events: POST /ISAPI/AccessControl/AcsEvent?format=json .

ng
Aj
Co

12.24.2.3 Get Total Number of Access Control Events

1. Call the functional capability of access control: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportAcsEventTotalNum is returned and its value is "true", it indicates that the device supports getting the total
number of access control events.
2. Get the capability of getting total number of access control events by specific conditions: GET
/ISAPI/AccessControl/AcsEventTotalNum/capabilities?format=json .

3. Get the total number of access control events by specific conditions: POST
/ISAPI/AccessControl/AcsEventTotalNum?format=json .

13 Video Intercom (General)

13.1 Call Signaling Interaction
13.1.1 Introduction to the Function
After the upper-layer platform or client software starts two-way audio with the device (refer to the API Calling Flow of
Two-Way Audio), once HiCore of the device receives the audio, it will send the voiceTalkEvent to the APK via HEOP
protocol. Once the APK received the event, it will send call signals back to HiCore.
Call Signaling Interaction can also be applied in devices' two-way audio via SIP protocol.
If you need to call a device by a main station which applies new device ID, the main station should be able to call both

m
device ID and new device ID.

co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im

13.1.2 API Calling Flow

ng
Aj

13.1.2.1 Call Signaling Interaction

Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Get the capability of the device: GET /ISAPI/System/capabilities ;

if the node isSupportVoiceTalkEvent is returned and its value is "true", it indicates that the device supports two-
way audio.
2. eventType: voiceTalkEvent;
3. Get the capability of two-way audio: GET /ISAPI/VideoIntercom/capabilities ;
if the node isSupportCallSignal is returned and its value is "true", it indicates that the device supports call
signaling interaction;
4. Get the capability set of call signaling interaction: GET /ISAPI/VideoIntercom/callSignal/capabilities?
format=json ;

5. Configure call signaling interaction: PUT /ISAPI/VideoIntercom/callSignal?format=json .

14 Digital Signage
14.1 Material Management

m
14.1.1 Introduction to the Function

co
Upload static materials to the device.

a.
14.1.2 API Calling Flow

C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1.Get the information release capability: GET /ISAPI/Publish/capabilities ; If isSupportMaterialMgr is returned, it

indicates that the device supports material management. 2.Apply material information: POST
/ISAPI/Publish/MaterialMgr/material ; the material information contains name, description, type, format, etc. The
material index <id> in the input message is required; if the device return material index in the request message, the
returned material index shall prevail; if the device does not return material index, the input material index shall prevail.
3.Get the capability of applying materials in packages: GET /ISAPI/Publish/capabilities , if
isSupportSubPackageUpload is returned, it indicates that the device supports uploading materials in packages; if the
size of the material file are larger than 2 GB, uploading materials in package is recommended. 4.Upload materials: POST
/ISAPI/Publish/MaterialMgr/material/<materialID>/upload ; details about materialID , refer to step 3. 5.Upload
materials in packages: POST/ISAPI/Publish/MaterialMgr/material/<materialID>/upload?format=json ; details about
materialID , refer to step 3. 6.Get the material uploading status: GET
/ISAPI/Publish/MaterialMgr/material/<materialID>/ uploadStatus 。

14.2 Schedule Release

14.2.1 Introduction to the Function
This function allows users to create schedules by combining multiple programs according to the scheduled time or
method (including playing by day, by week, by custom schedule, by loop schedule, by default schedule), and to apply

m
the schedule to the device. After the schedule is applied to the device, the device will play the specified program as

co
scheduled.

a.
14.2.2 API Calling Flow

C. arc
s, em
A
no fr
ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez
en
im
ng
Aj
Co

1. Apply schedule notification to the device: PUT /ISAPI/Publish/ScheduleMgr/release .

2. Apply schedule parameters to inform the device about the program arrangement time: POST
/ISAPI/Publish/ScheduleMgr/playSchedule .

3. The client applies program information to the device for each program, including program parameters, name, type,
etc. POST /ISAPI/Publish/ProgramMgr/program .
etc. POST /ISAPI/Publish/ProgramMgr/program .
4. Apply parameters for each page: POST /ISAPI/Publish/ProgramMgr/program/<programID>/page .
5. The client repeatedly applies material description information to the device. For materials stored in the local
storage: POST /ISAPI/Publish/MaterialMgr/material/<materialID>/upload . For materials stored in the storage
server, apply related material information (such as URL, IP address, etc.) to the information release terminal: POST
/ISAPI/Publish/MaterialMgr/material .

6. Upload the material document: POST /ISAPI/Publish/MaterialMgr/material/<materialID>/upload .

m
15 Zone Alarm

co
a.
15.1 Peripheral Management

C. arc
15.1.1 Peripheral No.

s, em
The peripheral No. is used to specify a certain peripheral (such as detector, network camera, relay, and sounder) when

A
no fr
you perform operations including configuring parameters and upgrading devices. For details about rules, see the
picture below:

ri on
Ma oc
up
co gr
es a@
Fr rc

s
y ema
os fr
ad on
el .c
ez

15.2 Topology of Detectors and Peripherals

en
im

15.2.1 Topology of Detectors

ng
Aj
Co
m
co
a.
C. arc
s, em
A
no fr
ri on
Ma oc
The hybrid security control panel can access detectors in the following ways:
up
1 (access wired detectors via onboard zones), 2 (access pircams via the RS-485 bus), 5 (access 1 to 2 detectors by
connecting the RS-485 bus with e-map fences), 6 (access 1 detector by enabling the function of extending zones for e-
co gr

map fences), 7 (access wireless detectors by connecting the RS-485 bus with R3/RX receivers), 8 (access wired
detectors via multi-channel wired zone modules), 10 (access wired detectors via keypads), 11 (access wired detectors
es a@

via network zone modules)

Fr rc

The wireless security control panel can access detectors in the following ways:
y ema

1 (access wired detectors via onboard transmitters), 3 (access wireless detectors via internal wireless receivers), 4
(access 1 to 2 wired detectors by enabling the function of extending zones for some magnetic contact detectors), 9
os fr

(access wired detectors by connecting wireless receivers with single-channel / multi-channel transmitters)
ad on

15.2.2 Topology of Peripherals

el .c
ez
en
im
ng
Aj
Co
The hybrid security control panel can access peripherals in the following ways:
1 (access keypads via the RS-485 bus), 2 (access wireless cards and keyfobs via keypads), 3 (access wired sounders via
onboard sounder modules), 4 (access wired relays via onboard relay modules), 5 (access wired relays via keypads), 11
(access wireless sounders, single-channel output modules (wireless relays), and keyfobs via the receivers connected to
the RS-485 bus), 12 (access wired relays via the wired output module connected to the RS-485 bus), 13 (access
network cameras by login via the network)

The wireless security control panel can access peripherals in the following ways:
1 (access keypas via wireless network), 3 (access wireless sounders via internal wireless receivers), 4 (access wired

m
relays via onboard transmitters), 6 (access card readers via wireless network), 7 (access repeaters via wireless network),

co
8 (access keyfobs via wireless network), 9 (access wired relays by connecting wireless receivers with single-channel /

a.
multi-channel transmitters), 10 (access wired relays by connecting wireless receivers with wireless output modules), 13
(access network cameras by login via the network)

C. arc
16 API Reference

s, em
A
no fr
16.1 Device Management (General)

ri on
16.1.1 Accessing via Protocol

Ma oc
16.1.1.1 Set the parameters of a specific protocol that supported by device
up
Request URL
co gr

PUT /ISAPI/Security/adminAccesses/<indexID>
es a@

Query Parameter
Fr rc

Parameter Name Parameter Type Description

s
y ema

indexID string --
Request Message
os fr
ad on
el .c
ez
en
im
ng
Aj
Co
<?xml version="1.0" encoding="UTF-8"?>

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

<id>
1
</id>
<enabled>
true
</enabled>
<protocol>
HTTP
</protocol>
<redirectToHttps>

m
true

co
</redirectToHttps>
<streamOverTls>

a.
true
</streamOverTls>
<portNo>

C. arc
80
</portNo>
<TLS1_1Enable>
<!--opt, bool, dep:and,{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,HTTPS},

s, em
{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,WebSocket},{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,WebSocketS},
{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,SDK_OVER_TLS}-->true

A
</TLS1_1Enable>

no fr
<TLS1_2Enable>
<!--opt, bool, dep:and,{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,HTTPS},
{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,WebSocket},{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,WebSocketS},

ri on
{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,SDK_OVER_TLS}-->true
</TLS1_2Enable>

Ma oc
<TLS1_3Enable>
true
</TLS1_3Enable>
</AdminAccessProtocol>
co gr
es a@

Response Message
Fr rc

<?xml version="1.0" encoding="UTF-8"?>

y ema

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

<requestURL>
null
os fr

</requestURL>
<statusCode>
<!--ro, req, enum, status code, subType:int, desc:0 (OK), 1 (OK), 2 (Device Busy), 3 (Device Error), 4 (Invalid Operation), 5 (Invalid XML Format), 6
ad on

(Invalid XML Content), 7 (Reboot Required)-->0

</statusCode>
el .c

<statusString>
OK
ez

</statusString>
<subStatusCode>
OK
en

</subStatusCode>
</ResponseStatus>
im
ng
Aj

16.1.1.2 Get security parameters of a single access protocol

Request URL
GET /ISAPI/Security/adminAccesses/<indexID>
Query Parameter
Parameter Name Parameter Type Description
indexID string
Request Message
None
Response Message
<?xml version="1.0" encoding="UTF-8"?>

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

<id>
1
</id>
<enabled>
true
</enabled>
<protocol>
HTTP
</protocol>
<redirectToHttps>

m
true
</redirectToHttps>

co
<streamOverTls>
true

a.
</streamOverTls>
<portNo>
80

C. arc
</portNo>
<TLS1_1Enable>
<!--ro, opt, bool, dep:and,{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,HTTPS},
{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,WebSocket},{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,WebSocketS},

s, em
{$.AdminAccessProtocolList.AdminAccessProtocol.protocol,eq,SDK_OVER_TLS}-->true
</TLS1_1Enable>

A
<TLS1_2Enable>

no fr
true

ri on
</TLS1_2Enable>
<TLS1_3Enable>

Ma oc
true
up
</TLS1_3Enable>
</AdminAccessProtocol>
co gr
es a@

16.1.1.3 Get device protocol capability

Request URL
Fr rc

GET /ISAPI/Security/adminAccesses/capabilities
y ema

Query Parameter
None
os fr

Request Message
ad on

None
el .c

Response Message
ez
en
im
ng
Aj
Co
<?xml version="1.0" encoding="UTF-8"?>

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

<AdminAccessProtocol>

<id>
test
</id>
<enabled opt="true,false">
true
</enabled>
<protocol opt="HTTP,HTTPS,SDK,RTSP,DEV_MANAGE,WebSocket,WebSocketS,SDK_OVER_TLS,MATRIX_GATEWAY,IOT,GB35114,104Proto,SRTP,ModbusTCP">
GB35114

m
</protocol>
<redirectToHttps opt="true,false">

co
true
</redirectToHttps>

a.
<streamOverTls opt="true,false">
true
</streamOverTls>

C. arc
<portNo min="1" max="65535" default="8443">
1
</portNo>
<TLS1_1Enable opt="true,false">

s, em
true
</TLS1_1Enable>

A
<TLS1_2Enable opt="true,false">

no fr
true
</TLS1_2Enable>
<TLS1_3Enable opt="true,false">

ri on
true
</TLS1_3Enable>

Ma oc
<TLS1_1SecurityPrompt opt="Only when the video output mode is Panorama, the device supports the VCA functions except Monitoring">
Only when the video output mode is Panorama, the device supports the VCA functions except Monitoring
</TLS1_1SecurityPrompt>
up
<connectTime min="1" max="999" def="10">
10
</connectTime>
co gr

</AdminAccessProtocol>
</AdminAccessProtocolList>
es a@
Fr rc

16.1.2 Device Basic Information Management

y ema

16.1.2.1 Get configuration capability of the device information parameters

Request URL
os fr

GET /ISAPI/System/deviceInfo/capabilities
ad on

Query Parameter
el .c

None
Request Message
ez

None
en

Response Message
im
ng

<?xml version="1.0" encoding="UTF-8"?>

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

Co

<deviceName min="1" max="128">

test
</deviceName>
<deviceID min="1" max="128">
123456
</deviceID>
<deviceDescription min="1" max="128">
test
</deviceDescription>
<deviceLocation opt="STD-CGI">
hangzhou
</deviceLocation>
<systemContact opt="STD-CGI">
test
</systemContact>
<model min="1" max="64">
iDS-9632NX-I8/X
</model>
<serialNumber min="1" max="48">
iDS-9632NX-I8/X1620181209CCRRC77605411WCVU
</serialNumber>
<macAddress min="1" max="64">
44:47:cc:c8:d9:e4
</macAddress>
</macAddress>
<firmwareVersion min="1" max="64">
V4.1.40
</firmwareVersion>
<firmwareReleasedDate min="1" max="64">
build 181129
</firmwareReleasedDate>
<encoderVersion min="1" max="64">
V7.3
</encoderVersion>
<encoderReleasedDate min="1" max="64">
build 20161223
</encoderReleasedDate>
<bootVersion min="1" max="16">
V1.3.4
</bootVersion>

m
<bootReleasedDate min="1" max="16">

co
100316
</bootReleasedDate>
<hardwareVersion min="1" max="16">

a.
0x0
</hardwareVersion>
<subDeviceType

C. arc
opt="accessControlTerminal,attendanceCheckDevice,multiChannelAccessController,personAndIdCardDevice,doorStation,mainStation,swingBarrier,flapBarrier,tripodT
urnstile">
accessControlTerminal
</subDeviceType>

s, em
<telecontrolID min="1" max="16">
8

A
</telecontrolID>

no fr
<subChannelEnabled>
true

ri on
</subChannelEnabled>
<thrChannelEnabled>
true

Ma oc
</thrChannelEnabled>
<powerOnMode opt="button,adapter" def="button">
button
up
</powerOnMode>
<customizedInfo min="0" max="128">
co gr

<!--ro, opt, string, device custom No., range:[0,128], attr:min{req, int},max{req, int}, desc:for baseline devices, returing this node is not required--
>test
</customizedInfo>
es a@

<languageType
opt="chinese,english,spanish,portuguese,italian,french,russian,turkish,greek,czech,brazilianPortuguese,slovenian,swedish,norwegian,romanian,danish,german,po
lish,dutch,hungarian,slovak,serbian,southAmericanSpanish,ukrainian,croatian,irish,bulgarian,hebrew,thai,indonesian,arabic,traditionalChinese,lithuanian,angl
Fr rc

icism,estonian">
<!--ro, opt, string, language type, range:[1,32], attr:opt{opt, string}, desc:"chinese", "english", "spanish", "portuguese", "italian", "french",
y ema

"russian", "turkish", "greek", "czech", "brazilianPortuguese", "slovenian", "swedish", "norwegian", "romanian", "danish", "german", "polish", "dutch",
"hungarian", "slovak", "serbian", "southAmericanSpanish", "ukrainian", "croatian", "irish", "bulgarian", "hebrew", "thai", "indonesian", "arabic",
"traditionalChinese"-->chinese
</languageType>
os fr

<localZoneNum min="0" max="16">

1
</localZoneNum>
ad on

<alarmOutNum min="0" max="16">

1
</alarmOutNum>
el .c

<relayNum min="0" max="16">

1
</relayNum>
ez

<electroLockNum min="0" max="16">

1
en

</electroLockNum>
<sirenNum min="0" max="16">
1
im

</sirenNum>
<alarmLamp min="0" max="16">
ng

1
Aj

</alarmLamp>
Co

<RS485Num min="0" max="16">

1
</RS485Num>
<DockStation>

<Platform>

<ip>
0.0.0.0
</ip>
<port>
1
</port>
<userName>
test
</userName>
<password>
test
</password>
</Platform>
<centralStorageBackupEnabled opt="true, false">
true
</centralStorageBackupEnabled>
<isSupportManufacturer>
true
</isSupportManufacturer>
</DockStation>
<webVersion>
1.0
</webVersion>
<deviceRFProgramVersion>
1.0
</deviceRFProgramVersion>
<securityModuleSerialNo>
1.0
</securityModuleSerialNo>

m
<securityModuleVersion>

co
1.0
</securityModuleVersion>
<securityChipVersion>

a.
1.0
</securityChipVersion>

C. arc
<securityModuleKeyVersion>
1.0
</securityModuleKeyVersion>
<UIDLampRecognition>

s, em

<enabled opt="true,false">

A
true

no fr
</enabled>
</UIDLampRecognition>
<confDeviceIdPrefix opt="true,false">

ri on
true
</confDeviceIdPrefix>

Ma oc
<simpleAlgorithmVersion min="0" max="10">
test
</simpleAlgorithmVersion>
up
<bootTime>
1970-01-01T00:00:00+08:00
</bootTime>
co gr

<isSupportNewVersionDevlanguageSwitch>
true
es a@

</isSupportNewVersionDevlanguageSwitch>
<intelligentAnalysisEngineModel>
K81
Fr rc

</intelligentAnalysisEngineModel>
s

<marketType opt="0,1,2">
0
y ema

</marketType>
<protocolFileURL min="1" max="32">
test
</protocolFileURL>
os fr

<recycleRecordEnabled opt="true,false">
false
</recycleRecordEnabled>
ad on

<decordChannelNums>
0
el .c

</decordChannelNums>
<VGANums>
0
ez

</VGANums>
<USBNums>
0
en

</USBNums>
<auxoutNums>
im

0

</auxoutNums>
ng

<expansionBoardVersion min="0" max="32">

test
</expansionBoardVersion>
Co

<initWizzardDisplay opt="true,false">
test
</beaconID>
<isResetDeviceLanguage opt="true,false">
false
</isResetDeviceLanguage>
<dispalyNum>
2
</dispalyNum>
<bspVersion min="1" max="1">
test
</bspVersion>
<dspVersion min="1" max="1">
test
</dspVersion>
<localUIVersion min="1" max="1">
test
</localUIVersion>
<OPCASubType opt="PDA,pump,column,autoSampler,SOC">
detector
</OPCASubType>
<wiegandOutNum min="0" max="1">
1
</wiegandOutNum>
<ChipVersionInfoList size="6">

<ChipVersionInfo>

<ID min="0" max="1">
1

m
</ID>

co
<firmwareVersion min="0" max="64">
1.0.0
</firmwareVersion>

a.
<chipName min="0" max="32">
test
</chipName>

C. arc
</ChipVersionInfo>
</ChipVersionInfoList>
<personBagLinkAlgoEngineVersion min="0" max="64">
<!--ro, opt, string, engine version of the person & package linkage module, range:[0,64], attr:min{req, int},max{req, int}, desc:this node is for

s, em
analyzer (security inspection)-->1.0.0

A
</personBagLinkAlgoEngineVersion>

no fr
<BIOSVersion min="0" max="16">
V1.3.4
</BIOSVersion>

ri on
<contactInformation min="0" max="64">
test
</contactInformation>

Ma oc
<PedestrianWarningModuleVersion>

up
<pedestrianWarningMCUVersion min="1" max="32">
V1.3.4
</pedestrianWarningMCUVersion>
co gr

<pedestrianWarningRadarVersion min="1" max="32">

V1.3.4
</pedestrianWarningRadarVersion>
es a@

<pedestrianRangingModuleVersion min="1" max="32">

V1.3.4
</pedestrianRangingModuleVersion>
Fr rc

</PedestrianWarningModuleVersion>
<encryptionModel min="0" max="16">
y ema

test
</encryptionModel>
<UWBVersion min="1" max="32">
os fr

V1.3.4

</UWBVersion>
<audioBoard>
ad on

<audioBoardModel min="0" max="32">
C8
el .c

</audioBoardModel>
<audioBoardVersion min="0" max="32">
ez

V1.0.0 build 211210
</audioBoardVersion>
</audioBoard>
en

<materialScanAlgorithmVersion min="0" max="64">

1.0.0
im

</materialScanAlgorithmVersion>
<productionDate>
ng
Aj

2022-04-02

</productionDate>
Co

<wifiModuleMACAddress min="1" max="48">

44:47:cc:c8:d9:e4
</wifiModuleMACAddress>
<isSupportExportDeviceFingerFile>
true
</isSupportExportDeviceFingerFile>
<isSupportPromptMessage>
true
</isSupportPromptMessage>
<shortSerialNumber min="1" max="9">
test
</shortSerialNumber>
<OSCoreVersionInfo>

<OSCoreVersion min="1" max="32">
1.0.0
</OSCoreVersion>
<minisysVersion min="1" max="32">
1.0.0
</minisysVersion>
<networkServiceVersion min="1" max="32">
1.0.0
</networkServiceVersion>
<upgradeServiceVersion min="1" max="32">
<upgradeServiceVersion min="1" max="32">
1.0.0
</upgradeServiceVersion>
</OSCoreVersionInfo>
<isSupportExportDeviceIcon>
true
</isSupportExportDeviceIcon>
<xTransVersion min="1" max="32">
1.0.0
</xTransVersion>
</DeviceInfo>

16.1.2.2 Get device information parameters

m
Request URL

co
GET /ISAPI/System/deviceInfo?serialNumber=<serialNumber>

a.
Query Parameter

C. arc
Parameter Name Parameter Type Description
serialNumber string --

s, em
A
Request Message

no fr
None

ri on
Response Message

Ma oc
<?xml version="1.0" encoding="UTF-8"?>
up
<DeviceInfo xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<deviceName>
co gr

test

</deviceName>
<deviceID>
es a@

test

</deviceID>
Fr rc

<deviceDescription>
s

test

</deviceDescription>
y ema

<deviceLocation>
hangzhou
</deviceLocation>
<deviceStatus>
os fr

normal

</deviceStatus>
<DetailAbnormalStatus>
ad on

<hardDiskFull>
el .c

true

</hardDiskFull>
<hardDiskError>
ez

true

</hardDiskError>
<ethernetBroken>
en

true

</ethernetBroken>
<ipaddrConflict>
im

true

</ipaddrConflict>
Aj

<illegalAccess>
true
Co

</illegalAccess>
<recordError>
true
</recordError>
<raidLogicDiskError>
true
</raidLogicDiskError>
<spareWorkDeviceError>
true
</spareWorkDeviceError>
</DetailAbnormalStatus>
<systemContact>
STD-CGI
</systemContact>
<model>
iDS-9632NX-I8/X
</model>
<serialNumber>
iDS-9632NX-I8/X1620181209CCRRC77605411WCVU
</serialNumber>
<macAddress>
44:47:cc:c8:d9:e4
</macAddress>
<firmwareVersion>
<firmwareVersion>
V4.1.40
</firmwareVersion>
<firmwareReleasedDate>
2019-11-01
</firmwareReleasedDate>
<encoderVersion>
V7.3
</encoderVersion>
<encoderReleasedDate>
2019-11-02
</encoderReleasedDate>
<bootVersion>
V1.3.4
</bootVersion>
<bootReleasedDate>

m
2019-11-03

co
</bootReleasedDate>
<panelVersion>
V1.0

a.
</panelVersion>
<hardwareVersion>
0x0

C. arc
</hardwareVersion>
<decoderVersion>
V1.0
</decoderVersion>

s, em
<decoderReleasedDate>
2019-01-01

A
</decoderReleasedDate>

no fr
<softwareVersion>
V1.23

ri on
</softwareVersion>
<capacity>
1

Ma oc
</capacity>
<usedCapacity>
1
up
</usedCapacity>
<subDeviceType>
co gr

<!--ro, opt, enum, device sub type, subType:string, desc:"accessControlTerminal" (access control terminal; it is valid when the value of deviceType is
"ACS"), "attendanceCheckDevice" (attendance check devices; it is valid when the value of deviceType is "ACS"), "multiChannelAccessController" (multi-channel
access controller; it is valid when the value of deviceType is "ACS"), "personAndIdCardDevice" (person and ID card device; it is valid when the value of
es a@

deviceType is "ACS"), "doorStation" (door station; it is valid when the value of deviceType is "VIS"), "indoor" (indoor station; it is valid when the value
of deviceType is "VIS"), "mainStation" (main station; it is valid when the value of deviceType is "VIS"), "dropGate" (swing barrier; it is valid when the
value of deviceType is "PersonnelChannel"), "wingGate" (flap barrier; it is valid when the value of deviceType is "PersonnelChannel"), "threeRollerGate"
Fr rc

(tripod turnstile; it is valid when the value of deviceType is "PersonnelChannel")-->accessControlTerminal

</subDeviceType>
y ema

<telecontrolID>
1
</telecontrolID>
<supportBeep>
true
os fr

</supportBeep>
<supportVideoLoss>
ad on

true

</supportVideoLoss>
<firmwareVersionInfo>
el .c

B-R-H5-0

</firmwareVersionInfo>
<actualFloorNum>
ez

1

</actualFloorNum>
en

<localZoneNum>
1
</localZoneNum>
im

<alarmOutNum>
1
ng

</alarmOutNum>
Aj

<alarmInNum>
Co

1

</alarmInNum>
<distanceResolution>
0.000
</distanceResolution>
<angleResolution>
0.000
</angleResolution>
<speedResolution>
0.000
</speedResolution>
<detectDistance>
0.000
</detectDistance>
<relayNum>
1
</relayNum>
<electroLockNum>
1
</electroLockNum>
<sirenNum>
1
</sirenNum>
<alarmLamp>
<alarmLamp>
1
</alarmLamp>
<RS485Num>
1
</RS485Num>
<radarVersion>
test
</radarVersion>
<cameraModuleVersion>
test
</cameraModuleVersion>
<mainversion>
1
</mainversion>
<subversion>
1

m
</subversion>

co
<upgradeversion>
1
</upgradeversion>

a.
<customizeversion>
1

C. arc
</customizeversion>
<companyName>
test
</companyName>

s, em
<copyright>
test

A
</copyright>

no fr
<systemName>
storageManagement

ri on
</systemName>
<systemStatus>

Ma oc
configured
</systemStatus>
<isLeaderDevice>
up
true
</isLeaderDevice>
<clusterVersion>
co gr

test
</clusterVersion>
<centralStorageVersion>
es a@

test

</centralStorageVersion>
Fr rc

<powerOnMode>
s

button
</powerOnMode>
y ema

<customizedInfo>
test
</customizedInfo>
os fr

<verificationCode>
test
</verificationCode>
ad on

<supportUrl>
test
el .c

</supportUrl>
<subSerialNumber>
test
ez

</subSerialNumber>
<languageType opt="chinese,english,spanish,portuguese,italian,french,russian,turkish,greek,czech,brazilianPortuguese">
<!--ro, opt, enum, language type, subType:string, attr:opt{req, string}, desc:"chinese", "english", "spanish", "portuguese", "italian", "french",
en

"traditionalChinese", "lithuanian", "anglicism", "estonian"-->chinese

</languageType>
ng

<DockStation>
Aj

<Platform>
Co

m
<confDeviceIdPrefix>

co
true
</confDeviceIdPrefix>
<OEMCode>

a.
1
</OEMCode>
<simpleAlgorithmVersion>

C. arc
test
</simpleAlgorithmVersion>
<bootTime>

s, em
1970-01-01T08:00:00+08:00
</bootTime>

A
no fr
<intelligentAnalysisEngineModel>
test
</intelligentAnalysisEngineModel>

ri on
<marketType>
0
</marketType>

Ma oc
<algorithmVersion>
test
</algorithmVersion>
up
<firmware>
test
co gr

</firmware>
<engineList>

es a@

<engine>
1
</engine>
Fr rc

</engineList>
<platform>
y ema

1
</platform>
<platformName>
<!--ro, opt, string, the platform where the algorithm runs, desc:"TX1/K81" (NVR), "KT" (data center), "H5" (front-end device), "H7" (front-end device),
os fr

"K82" (NVR), "G3" (front-end device)-->test

</platformName>
<touchScreenVersionInfo>
ad on

test

</touchScreenVersionInfo>
<protocolFileURL>
el .c

test

</protocolFileURL>
ez

<recycleRecordEnabled>
false
</recycleRecordEnabled>
en

<decordChannelNums>
0
</decordChannelNums>
im

<VGANums>
0
ng

</VGANums>
Aj

<USBNums>
Co

0

</USBNums>
<auxoutNums>
0
</auxoutNums>
<expansionBoardVersion>
test
</expansionBoardVersion>
<initWizzardDisplay>
true
</initWizzardDisplay>
<beaconID>
test
</beaconID>
<isResetDeviceLanguage>
false
</isResetDeviceLanguage>
<dispalyNum>
0
</dispalyNum>
<bspVersion>
test
test
</bspVersion>
<dspVersion>
test
</dspVersion>
<localUIVersion>
test
</localUIVersion>
<OPCASubType>
detector
</OPCASubType>
<wiegandOutNum>
1
</wiegandOutNum>
<ChipVersionInfoList>

m

<ChipVersionInfo>

co

<ID>

a.
1
</ID>

C. arc
<firmwareVersion>
1.0.0
</firmwareVersion>
<algorithmVersion>

s, em
1.0.0
</algorithmVersion>

A
<chipName>

no fr
test
</chipName>
</ChipVersionInfo>

ri on
</ChipVersionInfoList>
<personBagLinkAlgoEngineVersion>

Ma oc
1.0.0
</personBagLinkAlgoEngineVersion>
<BIOSVersion>
up
V1.3.4
</BIOSVersion>
<contactInformation>
co gr

test

</contactInformation>
es a@

<temperatureModuleVersionInfo>
test
</temperatureModuleVersionInfo>
Fr rc

<PedestrianWarningModuleVersion>

<pedestrianWarningMCUVersion>
y ema

V1.3.4

</pedestrianWarningMCUVersion>
<pedestrianWarningRadarVersion>
V1.3.4
os fr

</pedestrianWarningRadarVersion>
<pedestrianRangingModuleVersion>
ad on

V1.3.4
</pedestrianRangingModuleVersion>
</PedestrianWarningModuleVersion>
el .c

<encryptionModel>
test
</encryptionModel>
ez

<UWBVersion>
V1.3.0
</UWBVersion>
en

<audioBoard>

im

<audioBoardModel>
C8
ng

</audioBoardModel>
Aj

<audioBoardVersion>
V1.0.0 build 211210
Co

</audioBoardVersion>
</audioBoard>
<materialScanAlgorithmVersion>
test
</materialScanAlgorithmVersion>
<regionVersion>
basic
</regionVersion>
<productionDate>
2022-04-02
</productionDate>
<wifiModuleMACAddress>
44:47:cc:c8:d9:e4
</wifiModuleMACAddress>
<displayInterfaceSize>
0
</displayInterfaceSize>
<releaseRegion>
China
</releaseRegion>
<shortSerialNumber>
test
</shortSerialNumber>
<audioVersion>
test
</audioVersion>
<communicationFrequency>
433MHz
</communicationFrequency>
<OSCoreVersionInfo>

<OSCoreVersion>
1.0.0
</OSCoreVersion>
<minisysVersion>
1.0.0
</minisysVersion>
<networkServiceVersion>
1.0.0

m
</networkServiceVersion>

co
<upgradeServiceVersion>
1.0.0
</upgradeServiceVersion>

a.
</OSCoreVersionInfo>
<xTransVersion>
1.0.0

C. arc
</xTransVersion>
<deviceMaintenanceInfoQRCode>
http://support.hikvision.com:8085/?QD=02&SN=序列号"
</deviceMaintenanceInfoQRCode>

s, em
<batteryFirmwareVersion>

A
1.0.0

no fr
</batteryFirmwareVersion>
<radarVideoMapInfoList>

ri on
<radarVideoMapInfo>

<devIndex>

Ma oc
123456789
</devIndex>
up
<radarVideoMapVersion>
1.0.0
</radarVideoMapVersion>
co gr

</radarVideoMapInfo>
</radarVideoMapInfoList>
<screenVersionInfo>
es a@

<screenAndroidOSVersion>
Fr rc

1.2.0 build20230101

</screenAndroidOSVersion>
<screenAndroidAPPVersion>
y ema

1.0.0 build20230101

</screenAndroidAPPVersion>
</screenVersionInfo>
<isSupportBattery>
os fr

true

</isSupportBattery>
<networkConfigSettingEnabled>
ad on

true

</networkConfigSettingEnabled>
<ptzVersion>
el .c

test

</ptzVersion>
ez

<movementSoftVersion>
test
</movementSoftVersion>
en

<movementHardVersion>
test
</movementHardVersion>
im

</DeviceInfo>
ng
Aj
Co

16.1.2.3 Set the device information parameters

Request URL
PUT /ISAPI/System/deviceInfo?serialNumber=<serialNumber>
Query Parameter
Parameter Name Parameter Type Description
serialNumber string --
security string --
iv string --
Request Message
<?xml version="1.0" encoding="UTF-8"?>
<DeviceInfo xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<deviceName>
test
</deviceName>
<deviceID>
test
</deviceID>
<deviceDescription>
test
</deviceDescription>
<deviceLocation>
hangzhou
</deviceLocation>
<deviceStatus>

m
normal

co
</deviceStatus>
<DetailAbnormalStatus>

a.
<hardDiskFull>
true

C. arc
</hardDiskFull>
<hardDiskError>
true
</hardDiskError>

s, em
<ethernetBroken>
true

A
</ethernetBroken>

no fr
<ipaddrConflict>
true
</ipaddrConflict>

ri on
<illegalAccess>
true
</illegalAccess>

Ma oc
<recordError>
true
up
</recordError>
<raidLogicDiskError>
true
co gr

</raidLogicDiskError>
<spareWorkDeviceError>
true
es a@

</spareWorkDeviceError>
</DetailAbnormalStatus>
Fr rc

<systemContact>
s

STD-CGI

</systemContact>
y ema

<model>
iDS-9632NX-I8/X
</model>
<serialNumber>
os fr

iDS-9632NX-I8/X1620181209CCRRC77605411WCVU

</serialNumber>
<macAddress>
ad on

44:47:cc:c8:d9:e4

</macAddress>
el .c

<firmwareVersion>
V4.1.40
</firmwareVersion>
ez

<firmwareReleasedDate>
2019-11-01
</firmwareReleasedDate>
en

<encoderVersion>
V7.3
im

</encoderVersion>
<encoderReleasedDate>
ng

2019-11-02

</encoderReleasedDate>
<bootVersion>
Co

V1.3.4

</bootVersion>
<bootReleasedDate>
2019-11-03
</bootReleasedDate>
<panelVersion>
V1.0
</panelVersion>
<hardwareVersion>
0x0
</hardwareVersion>
<decoderVersion>
V1.0
</decoderVersion>
<decoderReleasedDate>
2019-01-01
</decoderReleasedDate>
<softwareVersion>
V1.23
</softwareVersion>
<capacity>
1
</capacity>
<usedCapacity>
<usedCapacity>
1
</usedCapacity>
<telecontrolID>
1
</telecontrolID>
<supportBeep>
true
</supportBeep>
<supportVideoLoss>
true
</supportVideoLoss>
<firmwareVersionInfo>
test
</firmwareVersionInfo>
<actualFloorNum>

m
1

co
</actualFloorNum>
<localZoneNum>
1

a.
</localZoneNum>
<alarmOutNum>
1

C. arc
</alarmOutNum>
<distanceResolution>
0.000
</distanceResolution>

s, em
<angleResolution>
0.000

A
</angleResolution>

no fr
<speedResolution>
0.000

ri on
</speedResolution>
<detectDistance>
0.000

Ma oc
</detectDistance>
<relayNum>
1
up
</relayNum>
<electroLockNum>
co gr

1

</electroLockNum>
<sirenNum>
es a@

1

</sirenNum>
<alarmLamp>
Fr rc

1

</alarmLamp>
y ema

<RS485Num>
1
</RS485Num>
<radarVersion>
os fr

test

</radarVersion>
<cameraModuleVersion>
ad on

test

</cameraModuleVersion>
<mainversion>
el .c

1

</mainversion>
<subversion>
ez

1

</subversion>
en

<upgradeversion>
1
</upgradeversion>
im

<customizeversion>
1
ng

</customizeversion>
Aj

<companyName>
Co

test

</companyName>
<copyright>
test
</copyright>
<systemName>
storageManagement
</systemName>
<systemStatus>
configured
</systemStatus>
<isLeaderDevice>
true
</isLeaderDevice>
<clusterVersion>
test
</clusterVersion>
<centralStorageVersion>
test
</centralStorageVersion>
<powerOnMode>
button
</powerOnMode>
</powerOnMode>
<customizedInfo>
test
</customizedInfo>
<verificationCode>
test
</verificationCode>
<supportUrl>
test
</supportUrl>
<subSerialNumber>
test
</subSerialNumber>
<languageType opt="chinese,english,spanish,portuguese,italian,french,russian,turkish,greek,czech,brazilianPortuguese">
<!--ro, opt, enum, language type, subType:string, attr:opt{req, string}, desc:"chinese", "english", "spanish", "portuguese", "italian", "french",
"russian", "turkish", "greek", "czech", "brazilianPortuguese", "slovenian", "swedish", "norwegian", "romanian", "danish", "german", "polish", "dutch",

m
"hungarian", "slovak", "serbian", "southAmericanSpanish", "ukrainian", "croatian", "irish", "bulgarian", "hebrew", "thai", "indonesian", "arabic",

co
"traditionalChinese"-->chinese
</languageType>
<DockStation>

a.

<Platform>

C. arc

<ip>
test
</ip>

s, em
<port>
1

A
</port>

no fr
<userName>
test
</userName>

ri on
<password>
test

Ma oc
</password>
</Platform>
<centralStorageBackupEnabled>
up
true
</centralStorageBackupEnabled>
</DockStation>
co gr

<webVersion>
test
es a@

</webVersion>
<deviceRFProgramVersion>
test
Fr rc

</deviceRFProgramVersion>
s

<securityModuleSerialNo>
test
y ema

</securityModuleSerialNo>
<securityModuleVersion>
test
</securityModuleVersion>
os fr

<securityChipVersion>
test
</securityChipVersion>
ad on

<securityModuleKeyVersion>
test
el .c

</securityModuleKeyVersion>
<UIDLampRecognition>

ez

<enabled>
true
</enabled>
en

</UIDLampRecognition>
<confDeviceIdPrefix>
im

true
</confDeviceIdPrefix>
ng

<OEMCode>
Aj

1
</OEMCode>
Co

m
false

co
</recycleRecordEnabled>
<decordChannelNums>
0

a.
</decordChannelNums>
<VGANums>
0

C. arc
</VGANums>
<USBNums>
0
</USBNums>

s, em
<auxoutNums>

A
0

no fr
</auxoutNums>
<expansionBoardVersion>
test

ri on
</expansionBoardVersion>
<initWizzardDisplay>
<!--ro, opt, bool, whether it displays initialization wizard, desc:it is only used for displaying configuration of applications integrated to the

Ma oc
wizard, such as local GUI and Hik-Connect app by default, the value is true. it is false after the local GUI configures the wizard-->true
</initWizzardDisplay>
up
<beaconID>
test
</beaconID>
co gr

<isResetDeviceLanguage>
<!--ro, opt, bool, whether it supports resetting the device language (only for Admin and Installer), desc:if the value is true, the Hik-Connect app and
the Web Client display device information in the target language; if the value is false, the Hik-Connect app and the Web Client display the original device
es a@

information-->false
</isResetDeviceLanguage>
<dispalyNum>
Fr rc

0

</dispalyNum>
y ema

<bspVersion>
test
</bspVersion>
<dspVersion>
os fr

test

</dspVersion>
<localUIVersion>
ad on

test

</localUIVersion>
<detectorType>
el .c

PDA

</detectorType>
ez

<wiegandOutNum>
1
</wiegandOutNum>
en

<ChipVersionInfoList>

<ChipVersionInfo>
im

<ID>
ng
Aj

1

</ID>
Co

<firmwareVersion>
1.0.0
</firmwareVersion>
</ChipVersionInfo>
</ChipVersionInfoList>
<personBagLinkAlgoEngineVersion>
1.0.0
</personBagLinkAlgoEngineVersion>
<BIOSVersion>
test
</BIOSVersion>
<contactInformation>
test
</contactInformation>
<materialScanAlgorithmVersion>
test
</materialScanAlgorithmVersion>
<audioVersion>
test
</audioVersion>
</DeviceInfo>
Response Message

<?xml version="1.0" encoding="UTF-8"?>

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

<requestURL>
null
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
<!--ro, req, enum, status description, subType:string, desc:"OK" (succeeded), "Device Busy", "Device Error", "Invalid Operation", "Invalid XML Format",

m
"Invalid XML Content", "Reboot" (reboot device)-->OK
</statusString>

co
<subStatusCode>
OK

a.
</subStatusCode>
<description>
badXmlFormat

C. arc
</description>
</ResponseStatus>

s, em
16.1.2.4 Get firmware code list

A
no fr
Request URL

ri on
GET /ISAPI/System/firmwareCodeV2?startIndex=<startIndex>&maxNumber=<maxNumber>

Ma oc
Query Parameter up
Parameter Parameter
Description
Name Type
co gr

To control the message size, the quantity of returned firmware IDs returned by device
es a@

depends on the client request. For example, if there are 100 firmware IDs of a device, and
startIndex string up to 32 IDs are allowed in every request, then the device returns only 32 IDs according to
Fr rc

the start index (startIndex). Examples: GET /ISAPI/System/firmwareCodeV2?

y ema

startIndex=1&maxNumber=32
To control the message size, the quantity of returned firmware IDs returned by device
os fr

depends on the client request. For example, if there are 100 firmware IDs of a device, and
maxNumber string up to 32 IDs are allowed in every request, then the device returns only 32 IDs according to
ad on

the start index (startIndex). Examples: GET /ISAPI/System/firmwareCodeV2?

el .c

startIndex=1&maxNumber=32
ez

Request Message
en

None
Response Message
im
ng
Aj
Co
<?xml version="1.0" encoding="UTF-8"?>

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

<FirmwareCode>

<index>
1
</index>
<code>
00000002000001000000000100000001000000010000000000000001ffffffff0001020307e1060100001000
</code>
<version>
V5.5.160 build 210416

m
</version>
<channel>

co
1
</channel>

a.
<devTypeName>
test
</devTypeName>

C. arc
<moduleType>
<!--ro, opt, enum, device component type, subType:string, desc:"cardReader" (card reader), "FPModule" (fingerprint module), "securityModule" (security
module), "extendModule" (I/O extended module), "channelController" (lane controller), "IRModule" (infrared module), "lampModule" (indicator module),
"elevatorController" (sub elevator controller), "FPAlgorithmProgram" (fingerprint algorithm programma of card reader), "dockStationHost" (dock station

s, em
host), "dockStationScreen" (dock station screen)-->cardReader
</moduleType>

A
<moduleID>

no fr
1
</moduleID>
</FirmwareCode>

ri on
</FirmwareCodeList>

16.1.3 Event Subscription Management Ma oc

up
co gr

16.1.3.1 Get the alarm/event subscription capability

Request URL
es a@

GET /ISAPI/Event/notification/subscribeEventCap
Fr rc

Query Parameter
y ema

None
Request Message
os fr

None
ad on

Response Message
el .c

<?xml version="1.0" encoding="UTF-8"?>

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

<format opt="xml,json">
en

xml

</format>
im

<heartbeat min="1" max="180">

1
ng

</heartbeat>
Aj

<channelMode opt="all,list">
<!--ro, opt, enum, channel subscription mode, subType:string, attr:opt{req, string}, desc:"all" (subscribe to all channels), "list" (subscribe to
Co

channels according to channel list)-->list

</channelMode>
<eventMode opt="all,list">
list
</eventMode>
<EventList>

<Event>

<type>
<!--ro, req, enum, event type, subType:string, desc:refer to event type list (eventType): "ADAS"(advanced driving assistance system), "ADASAlarm"
(advanced driving assistance alarm), "AID"(traffic incident detection), "ANPR"(automatic number plate recognition), "AccessControllerEvent" (access
controller event), "CDsStatus" (CD burning status), "DBD"(driving behavior detection) "GPSUpload" (GPS information upload), "HFPD"(frequently appeared
person detection), "IO"(I/O alarm), "IOTD" (IoT device detection), "LES" (logistics scanning event), "LFPD"(rarely appeared person detection), "PALMismatch"
(video standard mismatch), "PIR", "PeopleCounting" (people counting), "PeopleNumChange" (people number change detection), "Standup"(standing up detection),
"TMA"(thermometry alarm), "TMPA"(temperature measurement pre-alarm), "VMD"(motion detection), "abnormalAcceleration", "abnormalDriving", "advReachHeight",
"alarmResult", "attendance", "attendedBaggage", "audioAbnormal", "audioexception", "behaviorResult"(abnormal event detection), "blindSpotDetection"(blind
spot detection alarm), "cardMatch", "changedStatus", "collision", "containerDetection", "crowdSituationAnalysis", "databaseException", "defocus"(defocus
detection), "diskUnformat"(disk unformatted), "diskerror", "diskfull", "driverConditionMonitor"(driver status monitoring alarm); "emergencyAlarm",
"faceCapture", "faceSnapModeling", "facedetection", "failDown"(People Falling Down), "faultAlarm", "fielddetection"(intrusion detection), "fireDetection",
"fireEscapeDetection", "flowOverrun", "framesPeopleCounting", "getUp"(getting up detection), "group" (people gathering), "hdBadBlock"(HDD bad sector
detection event), "hdImpact"(HDD impact detection event), "heatmap"(heat map alarm), "highHDTemperature"(HDD high temperature detection event),
"highTempAlarm"(HDD high temperature alarm), "hotSpare"(hot spare exception), "illaccess"(invalid access), "ipcTransferAbnormal", "ipconflict"(IP address
"highTempAlarm"(HDD high temperature alarm), "hotSpare"(hot spare exception), "illaccess"(invalid access), "ipcTransferAbnormal", "ipconflict"(IP address
conflicts), "keyPersonGetUp"(key person getting up detection), "leavePosition"(absence detection), "linedetection"(line crossing detection),
"listSyncException"(list synchronization exception), "loitering"(loitering detection), "lowHDTemperature"(HDD low temperature detection event),
"mixedTargetDetection"(multi-target-type detection), "modelError", "nicbroken"(network disconnected), "nodeOffline"(node disconnected),
"nonPoliceIntrusion", "overSpeed"(overspeed alarm), "overtimeTarry"(staying overtime detection), "parking"(parking detection), "peopleNumChange",
"peopleNumCounting", "personAbnormalAlarm"(person ID exception alarm), "personDensityDetection", "personQueueCounting", "personQueueDetection",
"personQueueRealTime"(real-time data of people queuing-up detection), "personQueueTime"(waiting time detection), "playCellphone"(playing mobile phone
detection), "pocException"(video exception), "poe"(POE power exception), "policeAbsent", "radarAlarm", "radarFieldDetection", "radarLineDetection",
"radarPerimeterRule"(radar rule data), "radarTargetDetection", "radarVideoDetection"(radar-assisted target detection), "raidException", "rapidMove",
"reachHeight"(climbing detection), "recordCycleAbnormal"(insufficient recording period), "recordException", "regionEntrance", "regionExiting", "retention"
(people overstay detection), "rollover", "running"(people running), "safetyHelmetDetection"(hard hat detection), "scenechangedetection", "sensorAlarm"
(angular acceleration alarm), "severeHDFailure"(HDD major fault detection), "shelteralarm"(video tampering alarm), "shipsDetection", "sitQuietly"(sitting
detection), "smokeAndFireDetection", "smokeDetection", "softIO", "spacingChange"(distance exception), "sysStorFull"(storaging full alarm of cluster system),
"takingElevatorDetection"(elevator electric moped detection), "targetCapture", "temperature"(temperature difference alarm), "thermometry"(temperature
alarm), "thirdPartyException", "toiletTarry"(in-toilet overtime detection), "tollCodeInfo"(QR code information report), "tossing"(thrown object detection),
"unattendedBaggage", "vehicleMatchResult"(uploading list alarms), "vehicleRcogResult", "versionAbnormal"(cluster version exception), "videoException",

m
"videoloss", "violationAlarm", "violentMotion"(violent motion detection), "yardTarry"(playground overstay detection), "AccessControllerEvent",

co
"IDCardInfoEvent", "FaceTemperatureMeasurementEvent", "QRCodeEvent"(QR code event of access control), "CertificateCaptureEvent"(person ID capture comparison
event), "UncertificateCompareEvent", "ConsumptionAndTransactionRecordEvent", "ConsumptionEvent", "TFS" (traffic enforcement event),
"TransactionRecordEvent", "HealthInfoSyncQuery" (health information search event), "SetMealQuery"(searching consumption set meals), "ConsumptionStatusQuery"

a.
(searching the consumption status), "certificateRevocation" (certificate expiry), "humanBodyComparison" (human body comparison),
"regionTargetNumberCounting" (regional target statistics)-->mixedTargetDetection
</type>

C. arc
<minorAlarm opt="0x400,0x401,0x402,0x403">
<!--ro, opt, string, minor alarm type, attr:opt{req, string}, desc:"IDCardInfoEvent" is required when the type of event is "AccessControllerEvent"--
>0x400,0x401
</minorAlarm>

s, em
<minorException opt="0x400,0x401,0x402,0x403">
<!--ro, opt, string, minor exception type, attr:opt{req, string}, desc:"IDCardInfoEvent" is required when the type of event is

A
"AccessControllerEvent"-->0x400,0x401

no fr
</minorException>
<minorOperation opt="0x400,0x401,0x402,0x403">

ri on
0x400,0x401
</minorOperation>

Ma oc
<minorEvent opt="0x01,0x02,0x03,0x04">
<!--ro, opt, string, minor event type, attr:opt{req, string}, desc:"IDCardInfoEvent" is required when the type of event is "AccessControllerEvent"--
>0x400,0x401
up
</minorEvent>
<pictureURLType opt="binary,localURL,cloudStorageURL,multipart" def="cloudStorageURL">
co gr

cloudStorageURL
</pictureURLType>
es a@

<channels>
1,2,3,4
</channels>
Fr rc

<ConferenceIDList size="1">
<!--ro, opt, array, video conference ID list, subType:object, attr:size{req, int}, desc:when this node does not exist, it indicates to subscribe to
y ema

all conferences-->
<ConferenceID min="1" max="32">
test
</ConferenceID>
os fr

</ConferenceIDList>
<uploadAllTarget opt="true,false">
<!--ro, opt, bool, whether to upload all detected targets, attr:opt{req, string}, desc:the default value is false. In perimeter protection, this
ad on

node is used for NVR to get all targets detected by the network camera-->false
</uploadAllTarget>
<uploadMEFData opt="true,false">
el .c

true
</uploadMEFData>
<minorType opt="success,failed">
ez

<!--ro, opt, string, event sub-type, attr:opt{req, string},

desc:1. It is valid when the value of <type> is "CertificateCaptureEvent" or "ncertificateCompareEvent".
en

2. There is the requirement to only subscribe to the failure or success of an event, for example, security inspection at the railway station and the hotel
check-in.-->success
</minorType>
im

<childDevIDList min="1" max="8">

ng

<childDevID min="1" max="128">

test

</childDevID>
</childDevIDList>
<radarChannels>
1,2,3,4
</radarChannels>
<audioChannels>
1,2,3,4
</audioChannels>
</Event>
</EventList>
<channels>
1,2,3,4
</channels>
<pictureURLType opt="binary,localURL,cloudStorageURL,multipart" def="cloudStorageURL">
cloudStorageURL
</pictureURLType>
<ChangedUploadSub>

<interval>
300
</interval>
<StatusSub>
true
<all>
false
</all>
<channel>
true
</channel>
<hd>
true
</hd>
<capability>
true
</capability>

m
<ChanStatus>

co

a.
<online opt="true,false">
<!--ro, opt, bool, whether the channel online status is subscribed, attr:opt{req, string}, desc:if this node does not exist, it indicates there

C. arc
will be no related alarm-->true
</online>
<record opt="true,false">
<!--ro, opt, bool, whether the recording status (the device is recording) is subscribed, attr:opt{req, string}, desc:if this node does not exist,

s, em
it indicates there will be no related alarm-->true
</record>

A
<recordStatus opt="true,false">

no fr
true
</recordStatus>

ri on
<signal opt="true,false">
<!--ro, opt, bool, whether the signal status is subscribed, attr:opt{req, string}, desc:if this node does not exist, it indicates there will be no

Ma oc
related alarm-->true
</signal>
<arming opt="true,false">
up
true
</arming>
co gr

</ChanStatus>
</StatusSub>
es a@

</ChangedUploadSub>
<identityKey max="64">
test
Fr rc

</identityKey>
s

<ConferenceIDList size="1">

y ema

<ConferenceID min="1" max="32">

test
</ConferenceID>
</ConferenceIDList>
os fr

<isSupportModifySubscribeEvent>
<!--ro, opt, bool, whether the device supports the management of arming subscription, desc:related API: /ISAPI/Event/notification/subscribeEvent/<ID>--
>true
ad on

</isSupportModifySubscribeEvent>
<subscribeEventID min="1" max="128">
el .c

<!--ro, opt, string, custom subscription ID. The platform should guarantee the uniqueness of ID when applying it. The automatic network replenishment of
events will be enabled by default after the node is applied, range:[1,128], attr:min{req, int},max{req, int}, desc:when an event/alarm is subscribed
(related URL: POST /ISAPI/Event/notification/subscribeEvent), if this node is applied, it can be used to replace <id> (subscription ID) returned in message
ez

SubscribeEventResponse-->test
</subscribeEventID>
<level opt="high,middle,low">
en

high
</level>
im

<middleLevelPictureEnabeld opt="true,false">
true
ng

</middleLevelPictureEnabeld>
Aj

<deployID opt="1,2">
0
Co

</deployID>
<childDevIDList min="1" max="8">

<childDevID min="1" max="128">
test
</childDevID>
</childDevIDList>
<SubscribeISAPIMessage>

<eventType opt="AIOP_Video,AIOP_Polling_Video,AIOP_Picture,AIOP_Polling_Snap,TPS">
AIOP_Video
</eventType>
<eventPicUploadType opt="AIOP_Picture">
AIOP_Picture
</eventPicUploadType>
</SubscribeISAPIMessage>
<radarChannels>
1,2,3,4
</radarChannels>
<qosLevel>

<defaultLevel opt="0,1,2">
0
</defaultLevel>
<eventList>

<event>

<eventType>
test
</eventType>
<level opt="0,1,2">
1
</level>
<channels>
0,1,2
</channels>
</event>
</eventList>

m
</qosLevel>

co
<isSupportUnSubscribeEvent>
true
</isSupportUnSubscribeEvent>

a.
<audioChannels>
1,2,3,4
</audioChannels>

C. arc
</SubscribeEventCap>

s, em
16.1.3.2 Cancel subscribing alarm/event

A
no fr
Request URL

ri on
PUT /ISAPI/Event/notification/unSubscribeEvent?ID=<subscribeEventID>
Query Parameter

Ma oc
Parameter Name Parameter Type Description
up
subscribeEventID string --
co gr

Request Message
es a@

None
Fr rc

Response Message
y ema

<?xml version="1.0" encoding="UTF-8"?>

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

os fr

<requestURL>
ad on

null

</requestURL>
<statusCode>
el .c

0
</statusCode>
ez

<statusString>
<!--ro, req, enum, status information, subType:string, desc:"OK" (succeeded), "Device Busy", "Device Error", "Invalid Operation", "Invalid XML Format",
en

"Invalid XML Content", "Reboot" (reboot device)-->OK

</statusString>
<subStatusCode>
im

OK
</subStatusCode>
ng

</ResponseStatus>
Aj
Co

16.1.3.3 Event subscription heartbeat

EventType:heartBeat
<?xml version="1.0" encoding="UTF-8"?>

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

<ipAddress>
172.6.64.7
</ipAddress>
<ipv6Address>
1080:0:0:0:8:800:200C:417A
</ipv6Address>
<portNo>
80
</portNo>
<protocol>

m
<!--ro, opt, enum, transmission communication protocol type, subType:string, desc:when ISAPI protocol is transmitted via HCNetSDK, the channel No. is
the video channel No. of private protocol. When ISAPI protocol is transmitted via EZ protocol, the channel No. is the video channel No. of EZ protocol. When

co
ISAPI protocol is transmitted via ISUP, the channel No. is the video channel No. of ISUP-->HTTP
</protocol>

a.
<macAddress>
01:17:24:45:D9:F4
</macAddress>

C. arc
<channelID>
1
</channelID>
<dateTime>

s, em
2004-05-03T17:30:08+08:00
</dateTime>

A
<activePostCount>

no fr
1
</activePostCount>
<eventType>

ri on
heartBeat
</eventType>

Ma oc
<eventState>
active
</eventState>
up
<eventDescription>
heartBeat
</eventDescription>
co gr

<channelName>
test
es a@

</channelName>
<deviceID>
12345
Fr rc

</deviceID>
</EventNotificationAlert>
y ema

16.1.4 Input and Output Management

os fr

16.1.4.1 Get the alarm input and output information

ad on

Request URL
el .c

GET /ISAPI/System/IO
ez

Query Parameter
None
en

Request Message
im

None
ng
Aj

Response Message
Co

<?xml version="1.0" encoding="UTF-8"?>

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

<IOInputPortList>

<IOInputPort>

<id>
1
</id>
<enabled>
true
</enabled>
<triggering>
high
</triggering>
<name>
name
</name>
<IOUseType>
disable
disable
</IOUseType>
<inputType>
switch
</inputType>
<CombinationAlarm>

<channel>
1
</channel>
<EventTypeList>

<eventType>
VMD
</eventType>
</EventTypeList>

m
</CombinationAlarm>

co
</IOInputPort>
</IOInputPortList>
<IOOutputPortList>

a.

<IOOutputPort>

C. arc
<id>
1
</id>
<IODescriptor>

s, em

<userName>

A
name

no fr
</userName>
<addressingFormatType>

ri on
ipaddress
</addressingFormatType>
<hostName>

Ma oc
hostName
</hostName>
<ipAddress>
up
172.6.64.7
</ipAddress>
co gr

<ipv6Address>
1080:0:0:0:8:800:200C:417A
</ipv6Address>
es a@

<managePortNo>
1
</managePortNo>
Fr rc

<innerIOPortID>
1
y ema

</innerIOPortID>
</IODescriptor>
<PowerOnState>

os fr

<defaultState>
high
</defaultState>
ad on

<outputState>
high
</outputState>
el .c

<pulseDuration>
1000
</pulseDuration>
ez

</PowerOnState>
<name>
en

test

</name>
<IOUseType>
im

disable

</IOUseType>
ng

<normalStatus>
Aj

open

</normalStatus>
<enabled>
true
</enabled>
<IOType>
local
</IOType>
</IOOutputPort>
</IOOutputPortList>
</IOPortList>

16.1.4.2 Get device input and output capability

Request URL
GET /ISAPI/System/IO/capabilities
Query Parameter
None
Request Message
None
Response Message

<?xml version="1.0" encoding="UTF-8"?>

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

<IOInputPortNums>
0
</IOInputPortNums>
<IOOutputPortNums>

m
0

co
</IOOutputPortNums>
<isSupportStrobeLamp>
<!--ro, opt, bool, whether the device supports configuring the output of the gate's light, desc:whether the device supports configuring the output of

a.
the gate's light-->true
</isSupportStrobeLamp>
<SoftIOInputPortNums>

C. arc
0
</SoftIOInputPortNums>
<isSupportIOOutputAdvanceParameter>
<!--ro, opt, bool, whether supports configuration of alarm input advanced parameters, desc:related URI:

s, em
/ISAPI/System/IO/outputs/advanceParameter/capabilities?format=json-->true
</isSupportIOOutputAdvanceParameter>

A
no fr
<isSupportSetAllIOOutput>
true
</isSupportSetAllIOOutput>

ri on
<isSupportCombinationAlarm>
true
</isSupportCombinationAlarm>

Ma oc
<enabledIOOutputPortNums>
0
</enabledIOOutputPortNums>
up
<isSupportAlarmKeyParam>
<!--ro, opt, bool, whether supports configuring the physical keys of one-push alarm, desc:related URI:
co gr

/ISAPI/System/IO/inputs/<IOInputID>/AlarmKeyParam/capabilities?format=json-->true
</isSupportAlarmKeyParam>
</IOCap>
es a@
Fr rc

16.1.5 Input Management

y ema

16.1.5.1 Get the information of all I/O input ports

Request URL
os fr

GET /ISAPI/System/IO/inputs
ad on

Query Parameter
el .c

None
ez

Request Message
None
en

Response Message
im
ng
Aj
Co
<?xml version="1.0" encoding="UTF-8"?>

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

<IOInputPort>

<id>
1
</id>
<enabled>
true
</enabled>
<triggering>
<!--ro, req, enum, "high"-high electrical level, "low"-low electrical level, subType:string, desc:"high"-high electrical level, "low"-low electrical

m
level-->high
</triggering>

co
<name>
name

a.
</name>
<IOUseType>
disable

C. arc
</IOUseType>
<inputType>
switch
</inputType>

s, em
<CombinationAlarm>

A
<channel>

no fr
1
</channel>
<EventTypeList>

ri on

<eventType>

Ma oc
VMD
</eventType>
co gr

</EventTypeList>
</CombinationAlarm>
es a@

</IOInputPort>
</IOInputPortList>
Fr rc

16.1.6 Log Management

y ema

16.1.6.1 Search for log information

os fr

Request URL
ad on

POST /ISAPI/ContentMgmt/logSearch
el .c

Query Parameter
None
ez

Request Message
en
im
ng
Aj
Co
<?xml version="1.0" encoding="UTF-8"?>

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

<searchID>
test
</searchID>
<trackIDList>

<trackID>
1
</trackID>
</trackIDList>

m
<metaId>
<!--req, enum, log type, subType:string, desc:{log.std-cgi.com/<majorType>/<minorType>}, <majorType>-major type of log, <minorType>-minor type of log,

co
see remarks for detailed log type definitions; "log.std-cgi.com/Alarm/methaneConcentrationException", "log.std-
cgi.com/Alarm/methaneLightIntensityException", "log.std-cgi.com/Alarm/fishingShipDetection"-->log.std-cgi.com/Alarm/methaneConcentrationException

a.
</metaId>
<timeSpanList>

C. arc
<timeSpan>

<startTime>
1970-01-01T00:00:00Z

s, em
</startTime>
<endTime>

A
1970-01-01T01:00:00Z

no fr
</endTime>
</timeSpan>
</timeSpanList>

ri on
<searchResultPostion>
100

Ma oc
</searchResultPostion>
<maxResults>
0
up
</maxResults>
<onlySmart>
false
co gr

</onlySmart>
<logLevel>
es a@

emergency

</logLevel>
<alarmLevel>
Fr rc

high

</alarmLevel>
</CMSearchDescription>
y ema

Response Message
os fr

<?xml version="1.0" encoding="UTF-8"?>

ad on

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

el .c

<searchID>
<!--ro, req, string, search ID, range:[1,32], desc:UUID/GUID for record search. It is used to check whether the current search requester is the same as
ez

the previous one. If they are the same, the search record will be stored in the device for faster search next time-->test
</searchID>
<responseStatus>
en

true

</responseStatus>
im

<responseStatusStrg>
<!--ro, req, enum, search status string, subType:string, desc:"OK" (search completed), "NO MATCHES" (no matched data), "MORE" (more data waiting to be
ng

searched)-->OK
Aj

</responseStatusStrg>
<totalMatches>
Co

12

</totalMatches>
<numOfMatches>
24
</numOfMatches>
<matchList>

<searchMatchItem>

<logDescriptor>

<metaId>
log.std-cgi.com/Alarm/24HZoneAlarm
</metaId>
<StartDateTime>
1970-01-01T00:30:00Z
</StartDateTime>
<localID>
1
</localID>
<paraType>
test
</paraType>
<userName>
Admin
</userName>
<infoContent>
test
</infoContent>
<logInfo>

<OpenDoorRecord>

<type>
password
</type>
</OpenDoorRecord>

m
<VisAlarmRecord>

co

<type>
<!--ro, req, enum, alarm type, subType:string, desc:"zone" (zone alarm), "dismantle" (tampering alarm), "hijack" (duress alarm), "passwordErr"

a.
(password error alarm), "doorNotOpen" (unlocking-door-failed alarm), "doorNotClose" (locking-door-failed alarm), "SOS" (SOS alarm), "callReq" (device call
request alarm), "smartLockHijackFingerPrint" (smart lock duress alarm (fingerprint)), ‘smartLockHijackPassword" (smart lock duress alarm (password)),
"smartLockBreaking" (forced-open door alarm), "smartLockBeLocked" (lock-up door alarm), "smartLockLowBattery" (smart-lock-battery-low alarm)-->zone

C. arc
</type>
</VisAlarmRecord>
</logInfo>
<ipAddress>

s, em
10.20.30.10
</ipAddress>

A
no fr
<object>
network
</object>

ri on
<params>
test
</params>

Ma oc
<seq>
test
</seq>
up
<additionInformation>
test
co gr

</additionInformation>
<panelUser>
admin
es a@

</panelUser>
<diskNumber>
0
Fr rc

</diskNumber>
<alarmInPort>
y ema

0

</alarmInPort>
<alarmOutPort>
0
os fr

</alarmOutPort>
<remoteHostIPAddress>
10.12.25.23
ad on

</remoteHostIPAddress>
<logLevel>
emergency
el .c

</logLevel>
<alarmLevel>
ez

high

</alarmLevel>
<moduleName>
en

test

</moduleName>
</logDescriptor>
im

</searchMatchItem>
</matchList>
ng

</CMSearchResult>
Aj
Co

16.1.7 Online Upgrading Management

16.1.7.1 Get the device online upgrade capability
Request URL
GET /ISAPI/System/onlineUpgrade/capabilities
Query Parameter
None
Request Message
None
Response Message
<?xml version="1.0" encoding="UTF-8"?>

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

<firmwareNum max="10">
1
</firmwareNum>
<firmwareCode max="256">
1
</firmwareCode>
<firmwareVersion max="64">
1
</firmwareVersion>
<firmwareCodeNumOnce max="10">
1
</firmwareCodeNumOnce>

m
<upgradePercent min="0" max="100">

co
1
</upgradePercent>
<Version>

a.

<newVersion max="64">

C. arc
test
</newVersion>
<changeLog max="64">
test

s, em
</changeLog>
</Version>

A
<rebootAfterUpgrade>

no fr
auto
</rebootAfterUpgrade>
<DeviceParameter>

ri on

<isSupportAutoDownloadPackage>
true

Ma oc
</isSupportAutoDownloadPackage>
<notSupportAutoUpgrade>
up
true
</notSupportAutoUpgrade>
co gr

<isSupportTimingUpgrade>
true
</isSupportTimingUpgrade>
es a@

</DeviceParameter>
<ManualDownloadPackage>
Fr rc

<supportOperation opt="start,cancel,pause,resume">
start
y ema

</supportOperation>
</ManualDownloadPackage>
<isSupportIgnoreCurrentVersion>
true
os fr

</isSupportIgnoreCurrentVersion>
<UpgradePackageTask>
<!--ro, opt, object, whether the device supports applying upgrade tasks, desc:if this node is returned, it indicates that the following URLs are also
ad on

supported: /ISAPI/System/onlineUpgrade/task?format=json, /ISAPI/System/onlineUpgrade/status/<ID>-->

<isSupportUpgradeModules>
el .c

true
</isSupportUpgradeModules>
<isSupportUpgradeChannels>
ez

true
</isSupportUpgradeChannels>
<isSupportDownloadStrategy>
en

true
im

</isSupportDownloadStrategy>
<isSupportDelayedUpgradeByDateTime>
ng

<!--ro, opt, bool, whether the device supports delaying the upgrade by time, desc:corresponding filed is "delayedUpgradeDateTime" of URL
Aj

(/ISAPI/System/onlineUpgrade/task?format=json)-->true
</isSupportDelayedUpgradeByDateTime>
Co

<upgradePackageAddressType opt="URL, ftpIPAddress, ftpDomainAddress">

URL
</upgradePackageAddressType>
</UpgradePackageTask>
<isSupportPatrolInspection>
true
</isSupportPatrolInspection>
<isSupportBatchUpgrade>
true
</isSupportBatchUpgrade>
<isSupportCancelUpgrade>
true
</isSupportCancelUpgrade>
<isSupportPackagePause>
true
</isSupportPackagePause>
<isSupportPackageResume>
true
</isSupportPackageResume>
<isSupportCancelUpgradeByTaskID>
true
</isSupportCancelUpgradeByTaskID>
</OnlineUpgradeCap>
</OnlineUpgradeCap>

16.1.7.2 Get the online upgrade package downloading progress

Request URL
GET /ISAPI/System/onlineUpgrade/downloadPackage/status?format=json
Query Parameter
None
Request Message

m
co
None
Response Message

a.
C. arc
{
"DownloadPackageStatus": {
/*ro, req, object, upgrade package downloading status*/
"status": "notDownload",

s, em
/*ro, req, enum, download status, subType:string, desc:"notDownload", "downloading", "downloadFailed", "pause", "finish", "incorrectPackage"
(incorrect upgrade package format), "hdOperationFailed" (HD operation failed)*/

A
"total": 0.0,

no fr
/*ro, opt, float, upgrade package total size, desc:unit: MB, corrects to one decimal place*/
"remain": 0.0,
/*ro, opt, float, remaining space, desc:unit: MB, corrects to one decimal place*/

ri on
"speed": 0.0,
/*ro, opt, float, download speed, desc:unit: MB, corrects to one decimal place*/

Ma oc
"remainTime": 0,
/*ro, opt, int, estimated remaining time, unit:s*/
"progress": 0
up
/*ro, req, int, progress, range:[0,100]*/
}
}
co gr
es a@

16.1.7.3 Start to download upgrade package to device

Fr rc

Request URL
y ema

PUT /ISAPI/System/onlineUpgrade/downloadPackage?format=json
Query Parameter
os fr

None
ad on

Request Message
None
el .c

Response Message
ez

{
en

"statusCode": 1,
/*ro, opt, int, status code, desc:1 (succeeded). It is required when an error occurred*/
im

"statusString": "ok",
/*ro, opt, string, status description, range:[1,64], desc:"ok" (succeeded). It is required when an error occurred*/
ng

"subStatusCode": "ok",
Aj

/*ro, opt, string, sub status code, range:[1,64], desc:"ok" (succeeded). It is required when an error occurred*/
"errorCode": 1,
Co

/*ro, opt, int, error code, desc:it is required when the value of statusCode is not 1, it corresponds to subStatusCode*/
"errorMsg": "ok"
/*ro, opt, string, error information, desc:this node is required when the value of statusCode is not 1*/
}

16.1.7.4 Get the online upgrade progress of device

Request URL
GET /ISAPI/System/onlineUpgrade/status
Query Parameter
None
Request Message
None
Response Message

<?xml version="1.0" encoding="UTF-8"?>

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

<status>
notUpgrade
</status>
<percent>
1

m
</percent>
<onlineUpdateDevInfoList>

co

<onlineUpdateDevInfo>

a.

<moduleType>
<!--ro, req, enum, module type, subType:string, desc:"keypad", "detector", "cardReader" (card reader), "siren" (sounder), "relay", "transmitter"

C. arc
(transmitter), "remoteCtrl" (remote control),"repeater" (repeater), "SSD", "extensionModule" (extension module)-->keypad
</moduleType>
<moduleID>
1

s, em
</moduleID>
<model>

A
test

no fr
</model>
<status>

ri on
allowance
</status>

Ma oc
<percent>
1
</percent>
up
<updateTime>
2004-05-03T17:30:08+08:00
</updateTime>
co gr

</onlineUpdateDevInfo>
</onlineUpdateDevInfoList>
es a@

</OnlineUpgradeStatus>
Fr rc

16.1.8 Serial Port Management

y ema

16.1.8.1 Get the serial port capability of the device

os fr

Request URL
GET /ISAPI/System/Serial/capabilities
ad on

Query Parameter
el .c

None
ez

Request Message
en

None
Response Message
im
ng
Aj
Co
<?xml version="1.0" encoding="UTF-8"?>

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

<rs485PortNums>
0
</rs485PortNums>
<supportRS232Config>
true
</supportRS232Config>
<rs422PortNums>
0
</rs422PortNums>
<rs232PortNums>

m
0
</rs232PortNums>

co
<rs485WorkMode opt="Led, CaptureTrigger,transparent">
test

a.
</rs485WorkMode>
<rs232SerialNumber opt="1,2,3">
1

C. arc
</rs232SerialNumber>
<rs485SerialNumber opt="4,5,6">
1
</rs485SerialNumber>

s, em
<isSupportAuthenticationService>
true

A
</isSupportAuthenticationService>

no fr
<isSupportDeviceInfo>
true
</isSupportDeviceInfo>

ri on
<isSupportSearchDeviceInfoRelations>
true

Ma oc
</isSupportSearchDeviceInfoRelations>
</SerialCap>
up
16.1.8.2 Get the capability of a specific serial port
co gr

Request URL
es a@

GET /ISAPI/System/Serial/ports/<portID>/capabilities
Fr rc

Query Parameter
y ema

Parameter Name Parameter Type Description

portID string --
os fr
ad on

Request Message
None
el .c

Response Message
ez

<?xml version="1.0" encoding="UTF-8"?>

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

<id>
im

0

</id>
Aj

<enabled opt="true,false">
true
Co

</enabled>
<encryptKey min="0" max="10">
test
</encryptKey>
<serialNumber opt="1,2,3,4,5">
0
</serialNumber>
<serialPortType opt="RS485,RS422,RS232">
RS485
</serialPortType>
<serialAddress min="0" max="10">
1
</serialAddress>
<duplexMode opt="half,full">
half
</duplexMode>
<direction opt="monodirectional,bdirectional">
monodirectional
</direction>
<baudRate opt="1200,2400,4800,9600,19200,38400,57600,115200">
1200
</baudRate>
<dataBits opt="6,7,8">
6
6
</dataBits>
<parityType opt="none,even,odd,mark,space">
none
</parityType>
<stopBits opt="1,1.5,2">
1
</stopBits>
<workMode opt="console,transparent,audiomixe,screenCtrl,ptzCtrl,keyboard,matrix,audioMixers">
console
</workMode>
<flowCtrl opt="none,software,hardware">
none
</flowCtrl>
<deviceName min="0" max="32">
test

m
</deviceName>
<deviceProtocol min="0" max="10">

co
0
</deviceProtocol>

a.
<mode opt="readerMode,clientMode,externMode,stairsControl,accessControlHost,disabled,custom,cardReceiver,QRCodeReader">
readerMode
</mode>

C. arc
<modeChangeReboot>
true
</modeChangeReboot>
<outputDataType opt="cardNo,employeeNo,auto">

s, em
cardNo

A
</outputDataType>

no fr
<copyToAll opt="true,false">
true

ri on
</copyToAll>
<isVariable opt="true,false">
true

Ma oc
</isVariable>
<PTZInfo>

up
<bindChannelNo min="0" max="10">
0
co gr

</bindChannelNo>
<PTZProtocolList>

es a@

<PTZProtocol>

<id>
Fr rc

0

</id>
<protoDesc>
y ema

test

</protoDesc>
</PTZProtocol>
</PTZProtocolList>
os fr

</PTZInfo>
<ScreenCtrlInfo>
ad on

<ScreenCtrlProtoList>

el .c

<ScreenCtrlProto>

<id>
ez

0

</id>
en

<protoDesc>
test
</protoDesc>
im

</ScreenCtrlProto>
</ScreenCtrlProtoList>
ng

</ScreenCtrlInfo>
Aj

<MatrixCtrlInfo>

Co

m
<!--ro, opt, string, working mode of RS-485 serial port, dep:and,{$.SerialPortList.SerialPort.serialPortType,eq,RS485}, attr:opt{req, string},

co
desc:working mode of RS-485 serial port,which is used for LED display or triggering transmission of captured pictures. This node is valid only when
<serialPortType> is "RS485"-->sensor
</rs485WorkMode>

a.
<SensorCtrlList>

C. arc
<Sensor>

<id min="1" max="3">
1

s, em
</id>
<name min="1" max="32">

A
visibilitySensor

no fr
</name>
<enabled opt="true,false">
false

ri on
</enabled>
</Sensor>
</SensorCtrlList>

Ma oc
<stairsControl>

up
<outputDataType opt="floorNumber,cardNo">
floorNumber
co gr

</outputDataType>
</stairsControl>
<comMode opt="active,passive">
es a@

active
</comMode>
Fr rc

<ModbusRTU>
s

<ModbusRTUBaudRate opt="1200,2400,4800,9600,19200" def="9600">
y ema

9600

</ModbusRTUBaudRate>
<ModbusRTUDataBits opt="5,6,7,8" def="8">
6
os fr

</ModbusRTUDataBits>
<ModbusRTUParityType opt="none,even,odd" def="none">
none
ad on

</ModbusRTUParityType>
<ModbusRTUStopBits opt="1,2" def="1">
el .c

1

</ModbusRTUStopBits>
<ModbusRTUFlowCtrl opt="none,software,hardware">
ez

none

</ModbusRTUFlowCtrl>
<decoderAddress min="0" max="255" def="0">
en

1

</decoderAddress>
im

<online opt="true,false">
true
ng

</online>
Aj

</ModbusRTU>
<accessName min="1" max="32">
Co

test

</accessName>
<serialPortUse opt="acquAndCtrl,swipe,strongElectric">
acquisition
</serialPortUse>
<acquisitionProtocol opt="modbus,custom">
modbus
</acquisitionProtocol>
<serialProtocol opt="FECbus,GB26875">
GB26875
</serialProtocol>
<SupplementLightList size="5">

<SupplementLight>

<SupplementLightID min="1" max="5">
1
</SupplementLightID>
</SupplementLight>
</SupplementLightList>
<permissionController opt="0,1">
1
</permissionController>
<deviceModel min="0" max="32">
<deviceModel min="0" max="32">
test
</deviceModel>
<deviceSoftwareVersion min="0" max="32">
test
</deviceSoftwareVersion>
<audibleVisualAlarmType opt="CIRCLE,AFE80,AFE82,XY">
CIRCLE
</audibleVisualAlarmType>
<cardReaderType opt="K1108AM">
test
</cardReaderType>
<strongElectricType opt="19M04-RO/T,19M08-RO/T">
test
</strongElectricType>
<signalLampControl>

m

co
<protocolType opt="GB920,Hisense,LESER,JERE">
GB920
</protocolType>

a.
</signalLampControl>
</SerialPort>

C. arc
16.1.8.3 Set the parameters of a specific serial port supported by the device

s, em
Request URL

A
no fr
PUT /ISAPI/System/Serial/ports/<portID>?permissionController=<indexID>&childDevID=<childDevID>

ri on
Query Parameter
Parameter Name Parameter Type Description
portID string Ma oc --
up
indexID string --
co gr

childDevID string --
es a@
Fr rc

Request Message
s
y ema

<?xml version="1.0" encoding="UTF-8"?>

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

os fr

<id>
0
ad on

</id>
<enabled>
true
el .c

</enabled>
<encryptKey>
test
ez

</encryptKey>
<serialNumber>
0
en

</serialNumber>
<serialPortType>
im

RS485
</serialPortType>
ng

<serialAddress>
Aj

1
</serialAddress>
Co

<duplexMode>
half
</duplexMode>
<direction>
monodirectional
</direction>
<baudRate>
2400
</baudRate>
<dataBits>
6
</dataBits>
<parityType>
none
</parityType>
<stopBits>
1
</stopBits>
<workMode>
console
</workMode>
<flowCtrl>
none
</flowCtrl>
<rs485WorkMode>
sensor
</rs485WorkMode>
<copyToAll>
true
</copyToAll>
<audiomixerProtocolType>
test
</audiomixerProtocolType>
<deviceName>
test

m
</deviceName>

co
<deviceType>
1
</deviceType>

a.
<deviceProtocol>
1
</deviceProtocol>

C. arc
<mode>
readerMode
</mode>

s, em
<outputDataType>

A
<!--opt, enum, output data type, subType:string, dep:and,{$.SerialPort.mode,eq,accessControlHost}, desc:"cardNo,employeeNo", this node is valid when

no fr
<mode>is "accessControlHost”-->cardNo
</outputDataType>
<isVariable>

ri on
true
</isVariable>
<PTZInfo>

Ma oc

<bindChannelNo>
up
0
</bindChannelNo>
<PTZProtocolList>
co gr

<PTZProtocol>

es a@

<id>
0
</id>
Fr rc

<protoDesc>
test
y ema

</protoDesc>
</PTZProtocol>
</PTZProtocolList>
</PTZInfo>
os fr

<ScreenCtrlInfo>

<ScreenCtrlProtoList>
ad on

<ScreenCtrlProto>

el .c

<id>
0
ez

</id>
<protoDesc>
test
en

</protoDesc>
</ScreenCtrlProto>
</ScreenCtrlProtoList>
im

</ScreenCtrlInfo>
ng

<MatrixCtrlInfo>
Aj

<MatrixCtrlProtoList>
Co

<MatrixCtrlProto>

<id>
0
</id>
<protoDesc>
test
</protoDesc>
</MatrixCtrlProto>
</MatrixCtrlProtoList>
</MatrixCtrlInfo>
<KeyBoardCtrlInfo>

<KeyBoardCtrlProtoList>

<KeyBoardCtrlProto>

<id>
0
</id>
<protoDesc>
test
</protoDesc>
</protoDesc>
</KeyBoardCtrlProto>
</KeyBoardCtrlProtoList>
</KeyBoardCtrlInfo>
<ControlAddress>

<enabled>
true
</enabled>
<address>
1
</address>
</ControlAddress>
<SensorCtrlList>

<Sensor>

m

<id>

co
1
</id>

a.
<name>
visibilitySensor
</name>

C. arc
<enabled>
false
</enabled>
</Sensor>

s, em
</SensorCtrlList>
<stairsControl>

A
<!--opt, object, elevator control parameters, this node is valid when the value of the node <mode> is stairsControl, dep:and,

no fr
{$.SerialPort.mode,eq,stairsControl}-->
<outputDataType>

ri on
floorNumber
</outputDataType>
</stairsControl>

Ma oc
<comMode>
active
</comMode>
up
<ModbusRTU>

<ModbusRTUBaudRate>
co gr

9600

</ModbusRTUBaudRate>
es a@

<ModbusRTUDataBits>
6
</ModbusRTUDataBits>
Fr rc

<ModbusRTUParityType>
none
</ModbusRTUParityType>
y ema

<ModbusRTUStopBits>
1
</ModbusRTUStopBits>
<ModbusRTUFlowCtrl>
os fr

none

</ModbusRTUFlowCtrl>
ad on

<decoderAddress>
0
</decoderAddress>
el .c

</ModbusRTU>
<controlProtocol>
test
ez

</controlProtocol>
<accessName>
en

test

</accessName>
<serialPortUse>
im

acquisition

</serialPortUse>
ng

<acquisitionProtocol>
Aj

modbus

</acquisitionProtocol>
Co

Response Message
<?xml version="1.0" encoding="UTF-8"?>

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

<requestURL>
null
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
OK

m
</statusString>
<subStatusCode>

co
OK
</subStatusCode>

a.
</ResponseStatus>

C. arc
16.1.8.4 Get the parameters of a specific port supported by the device
Request URL

s, em
A
GET /ISAPI/System/Serial/ports/<portID>?permissionController=<indexID>&childDevID=<childDevID>

no fr
Query Parameter

ri on
Parameter Name Parameter Type Description
portID string
Ma oc --
up
indexID string --
co gr

childDevID string --
es a@

Request Message
Fr rc

None
y ema

Response Message

<?xml version="1.0" encoding="UTF-8"?>

os fr

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

ad on

<id>
0
el .c

</id>
<enabled>
true
ez

</enabled>
<encryptKey>
test
en

</encryptKey>
<serialNumber>
im

0

</serialNumber>
ng

<serialPortType>
Aj

RS485
</serialPortType>
Co

<serialAddress>
1
</serialAddress>
<duplexMode>
half
</duplexMode>
<direction>
monodirectional
</direction>
<baudRate>
2400
</baudRate>
<dataBits>
6
</dataBits>
<parityType>
none
</parityType>
<stopBits>
1
</stopBits>
<workMode>
console
</workMode>
<flowCtrl>
none
</flowCtrl>
<rs485WorkMode>
sensor
</rs485WorkMode>
<copyToAll>
true
</copyToAll>
<audiomixerProtocolType>
test
</audiomixerProtocolType>

m
<deviceName>

co
test
</deviceName>
<deviceType>

a.
1
</deviceType>
<deviceProtocol>

C. arc
1
</deviceProtocol>
<mode>
<!--ro, opt, enum, working mode, subType:string, desc:deq,working mode: "readerMode,clientMode,externMode,accessControlHost,disabled",this node is valid

s, em
only when <serialPortType> is "RS485"-->readerMode

A
</mode>

no fr
<outputDataType>
cardNo

ri on
</outputDataType>
<isVariable>
true

Ma oc
</isVariable>
<PTZInfo>
up

<bindChannelNo>
0
co gr

</bindChannelNo>
<PTZProtocolList>

es a@

<PTZProtocol>

<id>
Fr rc

0

</id>
y ema

<protoDesc>
test
</protoDesc>
</PTZProtocol>
os fr

</PTZProtocolList>
</PTZInfo>
<ScreenCtrlInfo>
ad on

<ScreenCtrlProtoList>

el .c

<ScreenCtrlProto>

ez

<id>
0
</id>
en

<protoDesc>
test
</protoDesc>
im

</ScreenCtrlProto>
</ScreenCtrlProtoList>
ng
Aj

</ScreenCtrlInfo>
<MatrixCtrlInfo>
Co

m

<Sensor>

co

<id>

a.
1
</id>
<name>

C. arc
visibilitySensor
</name>
<enabled>
false

s, em
</enabled>
</Sensor>

A
</SensorCtrlList>

no fr
<stairsControl>

<outputDataType>

ri on
<!--ro, opt, enum, output data type, subType:string, desc:output data type: "cardNo,employeeNo",this node is valid when <mode>is "accessControlHost"--
>floorNumber

Ma oc
</outputDataType>
</stairsControl>
<comMode>
up
active
</comMode>
<ModbusRTU>
co gr

<ModbusRTUBaudRate>
es a@

9600

</ModbusRTUBaudRate>
<ModbusRTUDataBits>
Fr rc

6

</ModbusRTUDataBits>
<ModbusRTUParityType>
y ema

none

</ModbusRTUParityType>
<ModbusRTUStopBits>
1
os fr

</ModbusRTUStopBits>
<ModbusRTUFlowCtrl>
ad on

none

</ModbusRTUFlowCtrl>
<decoderAddress>
el .c

0

</decoderAddress>
<online>
ez

true

</online>
</ModbusRTU>
en

<controlProtocol>
test
im

</controlProtocol>
<accessName>
ng

test

</accessName>
<serialPortUse>
Co

acquAndCtrl

</serialPortUse>
<serialProtocol>
GB26875
</serialProtocol>
<SupplementLightList>

<SupplementLight>

<SupplementLightID>
1
</SupplementLightID>
</SupplementLight>
</SupplementLightList>
<cardReaderType>
K1108AM
</cardReaderType>
<strongElectricType>
19M04-RO/T
</strongElectricType>
<signalLampControl>

<protocolType>
<protocolType>
GB920
</protocolType>
</signalLampControl>
</SerialPort>

16.1.8.5 Get the list of serial ports supported by the device

Request URL
GET /ISAPI/System/Serial/ports?permissionController=<indexID>
Query Parameter

m
Parameter Name Parameter Type Description

co
indexID string --

a.
Request Message

C. arc
None

s, em
Response Message

A
no fr
<?xml version="1.0" encoding="UTF-8"?>
<SerialPortList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

ri on

<SerialPort>

Ma oc
<id>
0
</id>
up
<enabled>
true
co gr

</enabled>
<encryptKey>
test
es a@

</encryptKey>
<serialNumber>
0
Fr rc

</serialNumber>
<serialPortType>
y ema

RS485

</serialPortType>
<serialAddress>
1
</serialAddress>
os fr

<duplexMode>
half
ad on

</duplexMode>
<direction>
monodirectional
el .c

</direction>
<baudRate>
2400
ez

</baudRate>
<dataBits>
en

6

</dataBits>
<parityType>
im

none

</parityType>
ng

<stopBits>
Aj

1

</stopBits>
<workMode>
console
</workMode>
<flowCtrl>
none
</flowCtrl>
<rs485WorkMode>
sensor
</rs485WorkMode>
<copyToAll>
true
</copyToAll>
<deviceName>
test
</deviceName>
<deviceProtocol>
1
</deviceProtocol>
<mode>
readerMode
</mode>
<outputDataType>
cardNo
cardNo
</outputDataType>
<isVariable>
true
</isVariable>
<PTZInfo>

<bindChannelNo>
0
</bindChannelNo>
<PTZProtocolList>

<PTZProtocol>

<id>
0
</id>

m
<protoDesc>

co
test
</protoDesc>
</PTZProtocol>

a.
</PTZProtocolList>
</PTZInfo>

C. arc
<ScreenCtrlInfo>

<ScreenCtrlProtoList>

s, em
<ScreenCtrlProto>

A
<id>

no fr
0
</id>
<protoDesc>

ri on
test
</protoDesc>

Ma oc
</ScreenCtrlProto>
</ScreenCtrlProtoList>
</ScreenCtrlInfo>
up
<MatrixCtrlInfo>

<MatrixCtrlProtoList>
co gr

<MatrixCtrlProto>

es a@

<id>
0
Fr rc

</id>
s

<protoDesc>
test
y ema

</protoDesc>
</MatrixCtrlProto>
</MatrixCtrlProtoList>
</MatrixCtrlInfo>
os fr

<KeyBoardCtrlInfo>

<KeyBoardCtrlProtoList>
ad on

<KeyBoardCtrlProto>
el .c

<id>
0
ez

</id>
<protoDesc>
test
en

</protoDesc>
</KeyBoardCtrlProto>
im

</KeyBoardCtrlProtoList>
</KeyBoardCtrlInfo>
ng

<ControlAddress>
Aj

<enabled>
Co

true

</enabled>
<address>
1
</address>
</ControlAddress>
<SensorCtrlList>

<Sensor>

<id>
1
</id>
<name>
visibilitySensor
</name>
<enabled>
false
</enabled>
</Sensor>
</SensorCtrlList>
<stairsControl>

<outputDataType>
floorNumber
</outputDataType>
</stairsControl>
<comMode>
active
</comMode>
<ModbusRTU>

<ModbusRTUBaudRate>
9600
</ModbusRTUBaudRate>
<ModbusRTUDataBits>
6
</ModbusRTUDataBits>
<ModbusRTUParityType>

m
none

co
</ModbusRTUParityType>
<ModbusRTUStopBits>
1

a.
</ModbusRTUStopBits>
<ModbusRTUFlowCtrl>
none

C. arc
</ModbusRTUFlowCtrl>
<decoderAddress>
0
</decoderAddress>

s, em
<online>
true

A
no fr
</online>
</ModbusRTU>
<accessName>

ri on
test
</accessName>
<serialPortUse>

Ma oc
acquAndCtrl
</serialPortUse>
<serialProtocol>
up
GB26875
</serialProtocol>
co gr

<SupplementLightList>

<SupplementLight>
es a@

<SupplementLightID>
1
Fr rc

</SupplementLightID>
</SupplementLight>
y ema

</SupplementLightList>
<cardReaderType>
K1108AM
</cardReaderType>
os fr

<strongElectricType>
19M04-RO/T
</strongElectricType>
ad on

</SerialPort>
</SerialPortList>
el .c
ez

16.1.9 System Maintenance

16.1.9.1 Get the storage capability of the device

Request URL
ng

GET /ISAPI/ContentMgmt/capabilities
Aj
Co

Query Parameter
None
Request Message
None
Response Message

<?xml version="1.0" encoding="UTF-8"?>

m
true

co
</isSupportTransCode>
<isSupportIpcImport>
<!--ro, opt, bool, whether the device supports importing the configuration file of the network camera, desc:related URI:

a.
/ISAPI/ContentMgmt/InputProxy/ipcConfig-->true
</isSupportIpcImport>

C. arc
<NasMountType>
true
<isNFSSupportAuthentication>
true

s, em
</isNFSSupportAuthentication>
<isCIFSSupportAuthentication>

A
true

no fr
</isCIFSSupportAuthentication>
</NasMountType>
<isSupportIpcStreamType>

ri on
true
</isSupportIpcStreamType>
<isSupportIOInputProxy>

Ma oc
true
</isSupportIOInputProxy>
up
<isSupportIOOutputProxy>
true
</isSupportIOOutputProxy>
co gr

<isSupportPTZRs485Proxy>
true
</isSupportPTZRs485Proxy>
es a@

<isSupportSrcIDSearch>
true
Fr rc

</isSupportSrcIDSearch>
s

<isSupportReversePlayback>
true
y ema

</isSupportReversePlayback>
<isSupportSMARTTest>
true
</isSupportSMARTTest>
os fr

<isSupportDownloadByTime>
true
</isSupportDownloadByTime>
ad on

<pictureSearchType
opt="AllEvent,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,Command,pir,wlsensor,callhelp,facedetection,FieldDetection,scenechangedetection,LineDetection,
el .c

regionEntrance,regionExiting,loitering,group,rapidMove,parking,unattendedBaggage,attendedBaggage,vehicleDetection,manual,manualSnapShot,playSnapShot,safetyH
elmet,
personQueueCounting,personQueueTime,violentMotion,leavePosition,advReachHeight,peopleNumChange,mixedTargetDetection,illegalParking,pedestrian,construction,r
ez

oadblock,
abandonedObject,trafficAccident,fogDetection,smokeDetection,personDensity,failDown,accessController,videoInterCom,GJD,Luminite,OPTEX,securityControlPanel,ge
tUp,toiletTarry,
en

playCellphone,vehicleMonitor,vibrationDetection,running,retention,spacingChange,yardTarry,keyPersonGetUp,sitQuietly,standUp,plateRecognition,smoking,onThePh
one,fatigueDriving,
im

notLookingStraightAhead,leaveThePost,seatBelt,sunglasses,identityAbnormal,ForwardCollisionWarning,LaneDepartureWarning,BlindSpotDetection,HeadwayMonitoringW
arning,
ng

PedestrianCollisionWarning,SuddenSpeedUp,SuddenSpeedDown,SuddenLeftTurn,SuddenRightTurn,Turnover,NotYieldToPedestrian,unregisteredStreetVendor,stallOutsideS
Aj

hop,stallOccupyingRoad, illegalHeap,illegalParkingofNon-
MotorVehicle,illegalOutdoorAdvertisement,packGarbage,stallUnderUmbrella,dustbinOverflow,exposeGarbage,hangClothingAlongStreet,allPic,ATMPanel,
Co

ATMSurround,ATMFace,ATMSafetyCabin,loitering,smokeDetectAlarm,temperatureIntervalMeasurement,AIOP,tail,abnormalFace,normalFace,multiFace,callFace,sunglasses
Face,humanEnter,operateOverTime,stickUp,installScanner,objectPlacedOrTaken,fakeCard,securityChecking,pothole,crack,roadMaint,imageCapture,methaneConcentrati
onException,methaneLightIntensityException,bannerDetection,variableDataEvent,shipChannelAbnormal,radarVideoDetection,smokeAndFireDetection,smokeDetection,se
nsorAlarm,alarmResult,AIOP_Video,AIOP_Polling_Snap,swipePatrol,BatteryCarInfoEvent,indoorPasswayBlock,detectorTemperatureAlarm,fireNoRegulation,detectorMoti
onAlarm,detectorShelterAlarm,detectorRunningStatus,faceCapture,UVPhotonDetection,DevPowerStatusReport,HFPD,audioAnalysis,IndoorPasswayRecovery,BatteryCarRec
overy,DetectorTemperatureRecovery,RadarFallenObjectsOnTracks,VegetationSpectrumDetection,personDensityDetection,ChannelClearEvent,channelOccupy,ChannelPassi
ngEvent,FallenObjectsOnTracksEvent,audioexception,CarWindow">
AllEvent
</pictureSearchType>
<recordSearchType
opt="AllEvent,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,Command,pir,wlsensor,callhelp,facedetection,FieldDetection,scenechangedetection,LineDetection,
regionEntrance,regionExiting,loitering,group,rapidMove,parking,unattendedBaggage,attendedBaggage,vehicleDetection,manual,manualSnapShot,playSnapShot,safetyH
elmet,
failDown,personDensityDetection,smokeDetection,vibrationDetection,unregisteredStreetVendor,stallOutsideShop,stallOccupyingRoad,illegalHeap,illegalParkingofN
on-MotorVehicle,
illegalOutdoorAdvertisement,packGarbage,stallUnderUmbrella,dustbinOverflow,exposeGarbage,hangClothingAlongStreet,ATMPanel,ATMSurround,ATMFace,ATMSafetyCabin
,temperatureIntervalMeasurement,AIOP,securityChecking,scheduledRecordUpload,variableDataEvent,smokeAndFireDetection,smokeDetection,AIOP_Video,AIOP_Polling_S
nap,BatteryCarInfoEvent,indoorPasswayBlock,detectorTemperatureAlarm,fireNoRegulation,detectorMotionAlarm,detectorShelterAlarm,detectorRunningStatus,faceCapt
ure,UVPhotonDetection,DevPowerStatusReport,ChannelClearEvent,channelOccupy,ChannelPassingEvent">
<!--ro, opt, enum, video search type, subType:string, attr:opt{req, string}, desc:"AllEvent", "CMR", "MOTION", "ALARM", "EDR", "ALARMANDMOTION", "pir",
"wlsensor", "callhelp", "facedetection", "FieldDetection", "scenechangedetection", "LineDetection", "regionEntrance", "regionExiting", "loitering", "group",
"rapidMove", "parking", "unattendedBaggage", "attendedBaggage", "vehicleDetection", "manual", "manualSnapShot", "playSnapShot", "safetyHelmet",

m
"personDensityDetection", "smokeDetection", "ATMPanel", "ATMSurround", "ATMFace", "ATMSafetyCabin", "temperatureIntervalMeasurement", "AIOP",

co
"securityChecking", "scheduledRecordUpload", "thermalVehicleDetection", "waterQualityDetection", "waterLevelDetection", "methaneConcentrationException",
"variableDataEvent", "smokeAndFireDetection", "smokeDetection", "sensorAlarm", "parallelParking", "parallelParkingContinuousRecord", "GasTankDetection",
"AIOP_Video", "AIOP_Polling_Snap", "BatteryCarInfoEvent", "indoorPasswayBlock", "detectorTemperatureAlarm", "fireNoRegulation", "detectorMotionAlarm",

a.
"detectorShelterAlarm", "detectorRunningStatus", ''faceCapture", "UVPhotonDetection", "DevPowerStatusReport"-->AllEvent
</recordSearchType>
<isSupportActivateIpc>

C. arc
true
</isSupportActivateIpc>
<isSupportCheckIpcSecurity>

s, em
<isSupportCheckPassword>
true

A
</isSupportCheckPassword>

no fr
</isSupportCheckIpcSecurity>
<isSupportMainAndSubRecord>

ri on
true
</isSupportMainAndSubRecord>
<isSupportSyncIPCPassword>

Ma oc
true
</isSupportSyncIPCPassword>
<isSupportTransferIPC>
up
true
</isSupportTransferIPC>
co gr

<isSupportSmartSearch>
true
</isSupportSmartSearch>
es a@

<isSupportPOS>
true
</isSupportPOS>
Fr rc

<isSupportLinkNum>
true
y ema

</isSupportLinkNum>
<isSupportPassBackBasicCfg>
true
os fr

</isSupportPassBackBasicCfg>
<PassBackTaskConfig>

ad on

<isSupportAddTask>
true
</isSupportAddTask>
el .c

<isSupportSearchTask>
true
</isSupportSearchTask>
ez

<isSupportControlTask>
<!--ro, opt, bool, whether the device supports controlling the task, desc:related URI: /ISAPI/ContentMgmt/record/passback/controlTask/capabilities--
en

>true
</isSupportControlTask>
<isSupportDeleteTask>
im

true
</isSupportDeleteTask>
ng

</PassBackTaskConfig>
Aj

<PassBackPlanConfig>
Co

<isSupportAddPlan>
true
</isSupportAddPlan>
<isSupportSearchPlan>

<isSupportIRAIDRapidConfiguration>
true
</isSupportIRAIDRapidConfiguration>
</IRAIDCap>
<isSupportStorageExtraInfo>
true
</isSupportStorageExtraInfo>
</isSupportStorageExtraInfo>
<isSupportRecordStatus>
true
</isSupportRacmChannelsCap>
<LockCap>

<LockByName>

<TrackId>
101
</TrackId>
<recordName min="1" max="100">

m
test

co
</recordName>
<command opt="lock,unlock">
lock

a.
</command>
<duration min="1" max="10">

C. arc
1
</duration>
<recorderCode min="1" max="100">
test

s, em
</recorderCode>
<policeCode min="1" max="100">

A
test

no fr
</policeCode>
</LockByName>
<LockByTime>

ri on

<TrackId>

Ma oc
101
</TrackId>
<recordType opt="ALL,MANUAL,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,COMMAND,SMART">
up
ALL
co gr

</recordType>
<startDateTime>
es a@

1970-01-01T00:00:00+08:00

</startDateTime>
<endDateTime>
Fr rc

1970-01-01T00:00:00+08:00

</endDateTime>
<command opt="lock,unlock">
y ema

lock
</command>
<duration min="1" max="10">
1
os fr

</duration>
</LockByTime>
</LockCap>
ad on

<isSupportForamtAll>
true
el .c

</isSupportForamtAll>
<isSupportExtendCabinetCfg>
true
ez

</isSupportExtendCabinetCfg>
<diskGroupNums>
0
en

</diskGroupNums>
<ExternalDevice>
im

<USB>
ng

<debugLogOutput>
true
Co

</debugLogOutput>
<isSupportCapturePackage>
true
</isSupportCapturePackage>
<isSupportStreamStorage>
true
</isSupportStreamStorage>
</USB>
</ExternalDevice>
<customProtocolNums>
0
</customProtocolNums>
<isSupportIPCTiming>
true
</isSupportIPCTiming>
<isSupportLogConfig>
true
</isSupportLogConfig>
<SecurityLog>

<isSupportSecurityLog>
true
</isSupportSecurityLog>
<isSupportLogServer>
true
</isSupportLogServer>
<isSupportLogServerTest>
true
</isSupportLogServerTest>
<SecurityLogTypeList>

<SecurityLogType>

<primaryType>
Event
</primaryType>

m
<secondaryType opt="test">

co
all
</secondaryType>
</SecurityLogType>

a.
</SecurityLogTypeList>
</SecurityLog>
<isSupportGetBackupDevice>

C. arc
true
</isSupportGetBackupDevice>
<isSupportAutoBackup>
<!--ro, opt, bool, whether the device supports automatic backup, desc:related URI: /ISAPI/ContentMgmt/Storage/backup/auto/capabilities?format=json--

s, em
>true

A
</isSupportAutoBackup>

no fr
<certificateValidationEnabled>
true

ri on
</certificateValidationEnabled>
<defaultAdminPortEnabled>
<!--ro, opt, bool, whether to enable the default communication port, desc:related to defaultAdminPortEnabled on the URI:

Ma oc
/ISAPI/ContentMgmt/InputProxy/channels/<ID>-->true
</defaultAdminPortEnabled>
up
<iSptInputProxyChanCap>
true
co gr

</iSptInputProxyChanCap>
<isSupportLogDataPackage>
true
es a@

</isSupportLogDataPackage>
<logSearchTimeSpanNums>
0
Fr rc

</logSearchTimeSpanNums>
<CloudStorageServerCap>
y ema

<isSupportCloudStorageParameter>
true
os fr

</isSupportCloudStorageParameter>
<isSupportCloudStoragePool>
<!--ro, opt, bool, whether the device supports configuring the cloud storage pool, desc:related URI:
ad on

/ISAPI/ContentMgmt/Storage/cloudServer/pool/capabilities?format=json-->true
</isSupportCloudStoragePool>
<supportChannelsNum>
el .c

0

</supportChannelsNum>
ez

<protocolType opt="videoStreamingOS">
videoStreamingOS
</protocolType>
en

</CloudStorageServerCap>
<isSupportWebPrivatePlaybackByUTC>
true
im

</isSupportWebPrivatePlaybackByUTC>
<isSupportFindCommonFileByUTC>
ng
Aj

true
</isSupportFindCommonFileByUTC>
Co

m
true
</isSupportCluster>

co
<supportAIDTFSType opt="illegalParking,wrongdirection,crosslane,vehicleexist,lanechange,turnround,evidence">
<!--ro, opt, enum, supported AIDTFS types, subType:string, attr:opt{req, string}, desc:"illegalParking", "wrongdirection" (wrong-way driving),

a.
"crosslane"(driving on the lane line), "vehicleexist" (vehicle on non-motor vehicle lane), "lanechange" (illegal lane change detection), "turnround"
(illegal U-turning detection), "evidence" (face picture collection)-->illegalParking
</supportAIDTFSType>

C. arc
<isSupportMisinfoStateSearch>
true
</isSupportMisinfoStateSearch>
<isSupportOneKeyOperationStorageData>

s, em
true

A
</isSupportOneKeyOperationStorageData>

no fr
<eventRecordSearch>

<eventType

ri on
opt="all,batch,alarmResult,faceSnap,vehicleMatchResult,hawkResult,VMD,alarmIn,inquestAlarm,behavior,posAlarm,accessControllerEvent,IOTD,trialAlarm,rapidMove
,defocus,scenechangedetection,PIR,fireSmartFireDetect,shipsDetection,TMA,TDA,framesPeopleCounting,personQueueTime,peopleDetection,safetyHelmetDetection,mixe

Ma oc
dTargetDetection,TMPA,smokeDetection,smokeAndFireDetection,abnormalReboot,audioexception,ANPR,objectsThrownDetection,audioAnalysis,HFPD,shelteralarm,cityMan
agement">
<!--ro, opt, enum, event type, subType:string, attr:opt{req, string}, desc:"all", "batch", "vehicleMatchResult" (vehicle comparison), "hawkResult"
up
(video analysis task), "faceContrast" (face picture comparison), "faceSnap" (face capture), "VMD", "alarmIn" (alarm input), "inquestAlarm", "behavior"
(abnormal event detection), "posAlarm", "accessControllerEvent", "IOTD", "trialAlarm", "rapidMove", "defocus", "scenechangedetection", "PIR",
"fireSmartFireDetect", "shipsDetection", "TMA", "TDA", "framesPeopleCounting", "personQueueTime", "peopleDetection", "safetyHelmetDetection",
co gr

"mixedTargetDetection", "TMPA", "smokeDetection", "smokeAndFireDetection", "abnormalReboot", "audioexception", "ANPR", "objectsThrownDetection" (object

thrown from heights detection), "audioAnalysis"-->alarmResult
es a@

</eventType>
<recordChannelListSize>
16
Fr rc

</recordChannelListSize>
<triggerChannelsSize>
16
y ema

</triggerChannelsSize>
<alarmResultAuxEventType opt="all,alarmResultFailure,alarmResultSuccess,whiteList">
<!--ro, opt, enum, sub-type of face picture comparison alarm, subType:string, dep:and,{$.RacmCap.eventRecordSearch.eventType,eq,alarmResult},
attr:opt{req, string}, desc:"alarmResultFailure" (face picture comparison failed), "alarmResultSuccess" (face picture comparison succeeded), "whiteList"
os fr

(allowlist alarm, i.e., strangers alarm)-->alarmResultFailure

</alarmResultAuxEventType>
ad on

<inquestParam>

<inquestEventType opt="any,inquestStart,inquestStop,inquestTag,inquestSegment">
el .c

any
</inquestEventType>
ez

<roomIndex min="1" max="65535">

1
</roomIndex>
en

</inquestParam>
<behavior>
im

<behaviorEventType
ng

opt="any,linedetection,regionEntrance,regionExiting,fielddetection,loitering,parking,violentMotion,group,unattendedBaggage,attendedBaggage,audioAbnormal">
Aj

<!--ro, req, enum, abnormal event detection event type, subType:string, attr:opt{req, string}, desc:"any", "linedetection" (line crossing
detection), "regionEntrance", "regionExiting", "fielddetection" (intrusion detection), "loitering" (loitering detectionparking), "parking" (parking
Co

detection), "violentMotion", "group" (people gathering), "unattendedBaggage", "attendedBaggage" (object removal), "audioAbnormal" (sudden change of sound
intensity detection)-->any
</behaviorEventType>
<falseAlarmType opt="all,falseAlarmFilterate" def="all">
all
</falseAlarmType>
</behavior>
<posAlarm>

<caseSensitive opt="true,false">
false
</caseSensitive>
<combinateMode opt="and,or">
and
</combinateMode>
<keyword size="3">
test
</keyword>
</posAlarm>
<trialParam>

<trialEventType opt="any,trialStart,trialStop,trialTag,trialSegment,trialJudge">
any
</trialEventType>
<caseNo min="0" max="56">
test
</caseNo>
<caseName>
test
</caseName>
<litigant1 min="0" max="32">
test
</litigant1>
<litigant2 min="0" max="32">
test
</litigant2>
<chiefJudge min="0" max="32">
test

m
</chiefJudge>

co
<caseType opt="0,1,2">
0
</caseType>

a.
</trialParam>
<accessControllerEvent>

C. arc
<majorEventType>
0
</majorEventType>
<subEventType>

s, em
0

A
</subEventType>

no fr
<cardNo min="0" max="32">
test
</cardNo>

ri on
<name min="0" max="32">
test
</name>

Ma oc
<MACAddr min="0" max="12">
test
up
</MACAddr>
</accessControllerEvent>
<IOTD>
co gr

<DeviceEventTypeList>

es a@

<DeviceEventType>

Fr rc

<subEventType>
s

test
</subEventType>
y ema

</DeviceEventType>
</DeviceEventTypeList>
<IoTchannelID size="256">
test
os fr

</IoTchannelID>
<caseSensitive opt="true,false">
false
ad on

</caseSensitive>
<combinateMode opt="and,or">
and
el .c

</combinateMode>
<keyword size="3">
ez

test

</keyword>
<zonNo min="0" max="32">
en

1
</zonNo>
</IOTD>
im

<AudioAnalysis>
ng

<targetType
opt="all,robbery,help,remittance,comment,fraud,cardNo,confirm,certificateID,certificateNumber,passWord,breakevenInterest,invest,noRisk,riskLow,riskSmall,tra
Co

nsfer,transferMoney,sureEarnNoLose,onlyEarnNoLose,financing,noLose,borrowMoney,hightReturn,highInterestRates,highYield">
all
</targetType>
</AudioAnalysis>
<objectsThrownDetection>

<alarmLevel opt="1,2,3">
1
</alarmLevel>
<floorID min="-100" max="100">
1
</floorID>
</objectsThrownDetection>
<HFPDSearch>

<conditionType opt="greaterThan,equal,lessThan,notEqual,greaterThanOrEqual,lessThanOrEqual">
greaterThan
</conditionType>
<occurrences min="0" max="100" def="1">
<occurrences min="0" max="100" def="1">
1
</occurrences>
</HFPDSearch>
<cityManagement>

<subEventType opt="unregisteredStreetVendor,stallOutsideShop,stallOccupyingRoad">
unregisteredStreetVendor
</subEventType>
</cityManagement>
</eventRecordSearch>
<isSupportManualRecord>
<!--ro, opt, bool, whether the device supports manual recording, desc:related URI: /ISAPI/ContentMgmt/record/control/manual/capabilities?format=json--
>true
</isSupportManualRecord>
<isSupportRemark>

m
true
</isSupportRemark>

co
<FileUpload>

a.
<enabled>
true
</enabled>

C. arc
</FileUpload>
<PoliceInfoUpload>

<enabled>

s, em
true
</enabled>

A
</PoliceInfoUpload>

no fr
<PoliceInfo>

ri on
<policeID>
true
</policeID>

Ma oc
<policeCode>
true
</policeCode>
up
<policeName>
true
co gr

</policeName>
<password>
true
es a@

</password>
<deviceID>
true
Fr rc

</deviceID>
<isSupportPoliceFacePicture>
<!--ro, opt, bool, whether the device supports managing the police face picture,
y ema

desc:related URL:
/ISAPI/ContentMgmt/police/<policeID>?format=json,
/ISAPI/ContentMgmt/police?format=json,
/ISAPI/ContentMgmt/police/deleteFacePicture?format=json-->true
os fr

</isSupportPoliceFacePicture>
</PoliceInfo>
ad on

<isSupportAssignChannelID>
true
el .c

</isSupportAssignChannelID>
<isSupportAssignStreamID>
<!--ro, opt, bool, whether the device supports specifying stream ID of the channel when adding the network camera, desc:related to streamID on URI:
ez

/ISAPI/ContentMgmt/InputProxy/channels/<ID>-->true
</isSupportAssignStreamID>
en

<PictureSearchSubTypeList>

<PictureSearchSubType>
im

<mainType>
ng

<!--ro, req, enum, main event type of the searched picture, subType:string, desc:"vehicleDetection", "HVTVehicleDetection" (mixed-traffic
Aj

detection)-->vehicleDetection
</mainType>
Co

<subType opt="all,motorVehicle,nonMotorVehicle,pedestrian">
all
</subType>
</PictureSearchSubType>
</PictureSearchSubTypeList>
<isSupportPlaybackStreamIDByUTC>
true
</isSupportPlaybackStreamIDByUTC>
<isSupportTimeLockStreamIDByUTC>
true
</isSupportTimeLockStreamIDByUTC>
<isSupportTimeSearch>
true
</isSupportTimeSearch>
<behaviorEventPicSearch opt="allBehaviorEvent,running,group,violentMotion,failDown,playCellphone,peopleNumChange,leavePosition,retention,sleepOnduty">
test
</behaviorEventPicSearch>
<perimeterEventPicSearch opt="allPerimeterEvent,linedetection,fielddetection,regionEntrance,regionExiting,loitering">
test
</perimeterEventPicSearch>
<isSupportSourceStatus>
<isSupportSourceStatus>
true
</isSupportSourceStatus>
<isSupportSSDSMARTTest>
true
</isSupportSSDSMARTTest>
<MobileStorage>

<isSupportGetFileTime>
true
</isSupportGetFileTime>
</MobileStorage>
<isSupportGetChannelList>
true
</isSupportGetChannelList>

m
<isSupportCascade>

co
true
</isSupportCascade>
<isSupportFileManagement>

a.
true

C. arc
</isSupportFileManagement>
<isSupportPictureInfo>
true
</isSupportPictureInfo>

s, em
<isSupportChanStatusPage>
<!--ro, opt, string, whether it supports searching the digital channel by page, desc:related URI:

A
/ISAPI/ContentMgmt/InputProxy/channels/statusPage/capabilities-->test

no fr
</isSupportChanStatusPage>
<isSupportRecordSearchByTargetType>
true

ri on
</isSupportRecordSearchByTargetType>
<storIpcStartNo>
0

Ma oc
</storIpcStartNo>
<maxRecordIpcNum>
up
0
</maxRecordIpcNum>
<maxConferenceIpcNum>
co gr

0
</maxConferenceIpcNum>
<decIpcStartNo>
es a@

0
</decIpcStartNo>
Fr rc

<maxDecodeIpcNum>
s

0
</maxDecodeIpcNum>
y ema

<pipIpcStartNo>
0
</pipIpcStartNo>
<maxPipIpcNum>
os fr

0
</maxPipIpcNum>
<isSupportLogSearch>
ad on

true

</isSupportLogSearch>
el .c

<isSupportRecordSearch>
true
</isSupportRecordSearch>
ez

<isSupportRecordDownload>
true
</isSupportRecordDownload>
en

<isSupportPnp opt="true,false">
true
im

</isSupportPnp>
<esataUseage>
ng

backup

</esataUseage>
<subType opt="all,leave,on,sleep">
Co

true
</isSupportManualBackup>
<isSupportLinkToIPCWeb>
true
</isSupportLinkToIPCWeb>
<isSupportIPCConfigCSV>
true
</isSupportIPCConfigCSV>
<isSupportExperimentExam>
true
</isSupportExperimentExam>
<isSupportPOSRecordSearch>
true
</isSupportPOSRecordSearch>
<isSupportSpare>
true
</isSupportTracksDates>
<isSupportRecordAudio>
true
</isSupportRecordAudio>
<isSupportSearchAudio>
<!--ro, opt, bool, whether the device supports searching the audio, desc:related URI: /ISAPI/ContentMgmt/recordAudio/search/capabilities?format=json--
>true
</isSupportSearchAudio>
<isSupportAudioDailyDistribution>
<!--ro, opt, bool, whether it supports searching for audio file information by monthly calendar, desc:related URI:

m
/ISAPI/ContentMgmt/recordAudio/<audioID>/searchDailyDistribution?format=json-->true

co
</isSupportAudioDailyDistribution>
<isSupportDownloadAudio>
<!--ro, opt, bool, whether it supports downloading audio files by file name, desc:related URI:

a.
/ISAPI/ContentMgmt/recordAudio/fileNameDownload/capabilities?format=json-->true
</isSupportDownloadAudio>
<isSupportDeleteAudio>

C. arc
true
</isSupportDeleteAudio>
<isSupportEventRecordCfg>

s, em
true
</isSupportEventRecordCfg>

A
<isSupportSearchRemoteAlbum>

no fr
true

ri on
</isSupportSearchRemoteAlbum>
<isNotSupportTracks>
<!--ro, opt, bool, whether it does not support recording schedule, desc:true will be returned if it is not supported NVR/CVRs support recording

Ma oc
schedule. This device does not support configuring recording schedule so the capability is added unsupported URI:
/ISAPI/ContentMgmt/record/tracks/<trackStreamID>/capabilities and /ISAPI/ContentMgmt/record/tracks and /ISAPI/ContentMgmt/record/tracks/<trackStreamID>--
>true
up
</isNotSupportTracks>
<isSupportTFCardConfig>
co gr

true
</isSupportTFCardConfig>
<isSupportDockStationFileStorageDuration>
es a@

true
</isSupportDockStationFileStorageDuration>
Fr rc

<isSupportDockStationFileAcquisitionMode>
<!--ro, opt, bool, whether the device supports configuring the file collection mode, desc:related URI:
y ema

/ISAPI/ContentMgmt/dockStationFile/DockStationFileAcquisitionMode?format=json-->true
</isSupportDockStationFileAcquisitionMode>
<isSupportSSDAbnormalCfg>
<!--ro, opt, bool, whether the device supports SSD exception detection parameters, desc:/ISAPI/ContentMgmt/Storage/ssd/SSDAbnormalCfg/capabilities?
os fr

format=json-->true
</isSupportSSDAbnormalCfg>
<isSupportAudioQuota>
ad on

true
</isSupportAudioQuota>
<targetRegionEventPicSearch opt="linedetection,fielddetection,regionEntrance,regionExiting,VMD">
el .c

test
</targetRegionEventPicSearch>
<isSupportAudioChanCap>
ez

true
en

</isSupportAudioChanCap>
<isSupportImportEnforcementWorkFile>
<!--ro, opt, bool, whether the device supports importing the law enforcement working file, desc:POST /ISAPI/ContentMgmt/ImportEnforcementWorkFile?
im

format=json-->true
</isSupportImportEnforcementWorkFile>
ng

<isSupportEnforcementProjectInfo>
Aj

<!--ro, opt, bool, whether the device supports getting the project information of the body camera for law enforcement, desc:GET/PUT
Co

/ISAPI/ContentMgmt/EnforcementProjectInfo?format=json-->true
</isSupportEnforcementProjectInfo>
<isSupportTriggerVoiceMonitoringHistoryEventRetrans>
true
</isSupportTriggerVoiceMonitoringHistoryEventRetrans>
<isSupportDockStationAudioFileToText>
true
</isSupportDockStationAudioFileToText>
<isSupportDockStationAudioFileAnalysisKeyWord>
true
</isSupportDockStationAudioFileAnalysisKeyWord>
<isSupportStartingUpRecordParams>
true
</isSupportStartingUpRecordParams>
<isSupportSendLawEnforcementFileUploadInfo>
true
</isSupportSendLawEnforcementFileUploadInfo>
<isSupportRecordAgeParams>
true
</isSupportRecordAgeParams>
<isSupportModifyRecordAgeParams>
<isSupportModifyRecordAgeParams>
true
</isSupportModifyRecordAgeParams>
<isSupportSearchRecordAgeParams>
true
</isSupportSearchRecordAgeParams>
<isSupportQuotaParams>
true
</isSupportQuotaParams>
<isSupportSearchAudioRecordPlan>
true
</isSupportSearchAudioRecordPlan>
<isSupportAddQuotaParams>
true
</isSupportAddQuotaParams>
<isSupportModifyQuotaParams>
true

m
</isSupportModifyQuotaParams>

co
<isSupportGetQuotaParams>
true
</isSupportGetQuotaParams>

a.
<isSupportDeleteQuotaParams>
true

C. arc
</isSupportDeleteQuotaParams>
<isSupportAddRecordAgeParams>
true
</isSupportAddRecordAgeParams>

s, em
<isSupportDeleteRecordAgeParams>
true

A
</isSupportDeleteRecordAgeParams>

no fr
<isSupportAutoRecordSynthesisParams>
true
</isSupportAutoRecordSynthesisParams>

ri on
<isSupportGetSSDSystemConfigRecoverProgress>
true

Ma oc
</isSupportGetSSDSystemConfigRecoverProgress>
<isSupportSSDSystemConfigRecover>
true
up
</isSupportSSDSystemConfigRecover>
<isSupportSSDSystemConfigState>
true
co gr

</isSupportSSDSystemConfigState>
</RacmCap>
es a@
Fr rc

16.1.9.2 Get the system security capability

y ema

Request URL
GET /ISAPI/Security/capabilities?username=<userName>
os fr

Query Parameter
ad on

Parameter Name Parameter Type Description

el .c

userName string user name

Request Message
None
en

Response Message
im
ng
Aj

<?xml version="1.0" encoding="UTF-8"?>

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

<supportUserNums>
0
</supportUserNums>
<userBondIpNums>
0
</userBondIpNums>
<userBondMacNums>
0
</userBondMacNums>
<isSupCertificate>
true
</isSupCertificate>
<issupIllegalLoginLock>
true
</issupIllegalLoginLock>
<isSupportOnlineUser>
true
</isSupportOnlineUser>
<isSupportAnonymous>
true
</isSupportAnonymous>
<isSupportStreamEncryption>
<isSupportStreamEncryption>
true
</isSupportStreamEncryption>
<securityVersion opt="1,2">
1
</securityVersion>
<keyIterateNum>
100
</keyIterateNum>
<isSupportUserCheck>
<!--ro, opt, bool, whether the device supports verifying the login password when editing (editing/adding/deleting) user parameters, dep:or,
{$.SecurityCap.securityVersion,eq,0},{$.SecurityCap.securityVersion,eq,1}, desc:it is an added capability, which indicates that whether supporting the login
password verification for editing/adding/deleting user parameters, this node depends on the node securityVersion, which means that it is only valid for the

m
versions that support encrypting the sensitive information-->true
</isSupportUserCheck>

co
<isSupportGUIDFileDataExport>
true

a.
</isSupportGUIDFileDataExport>
<isSupportSecurityQuestionConfig>
true

C. arc
</isSupportSecurityQuestionConfig>
<supportSecurityNode opt="wirelessServer,wirelessDial">
<!--ro, opt, string, additional node for supporting sensitive information encryption, attr:opt{req, string},
desc:in the earlier version of the solution for encrypting the sensitive information via ISAPI (i.e., the solution for transmitting plaintext via ISAPI),

s, em
some URIs containing sensitive information are left out now these URIs need to be encrypted for transmission, this capability node is added to be compatible
with old devices

A
if wirelessServer in this node is returned, it indicates that the following sensitive information should be encrypted

no fr
/ISAPI/System/Network/interfaces/<ID>/wirelessServer/capabilities, /ISAPI/System/Network/interfaces/<ID>/wirelessServer, if wirelessDial in this
node is returned, it indicates that the following sensitive information should be encrypted

ri on
/ISAPI/System/Network/WirelessDial/Interfaces,
/ISAPI/System/Network/WirelessDial/Interfaces/<ID>-->wirelessServer
</supportSecurityNode>

Ma oc
<isSupportGetOnlineUserListSC>
true
</isSupportGetOnlineUserListSC>
up
<SecurityLimits>

<LoginPasswordLenLimit min="1" max="16">
co gr

1
</LoginPasswordLenLimit>
es a@

<SecurityAnswerLenLimit min="1" max="128">

1
</SecurityAnswerLenLimit>
Fr rc

</SecurityLimits>
<RSAKeyLength opt="512,1024,2048" def="2048">
2048
y ema

</RSAKeyLength>
<isSupportONVIFUserManagement>
true
</isSupportONVIFUserManagement>
os fr

<WebCertificateCap>
<!--ro, opt, object, HTTP authentication capability, desc:if this node is not returned, it indicates that device supports basic and digest
ad on

authentication-->
<CertificateType opt="basic,digest,digest/basic">
<!--ro, req, enum, certificate type, subType:string, attr:opt{req, string}, desc:“basic” (basic authentication), “digest” (digest authentication),
el .c

“digest/basic” (digest/basic authentication)-->basic

</CertificateType>
<SecurityAlgorithm>
ez

<!--ro, opt, object, security algorithm, dep:or,{$.SecurityCap.WebCertificateCap.CertificateType,eq,digest},

{$.SecurityCap.WebCertificateCap.CertificateType,eq,digest/basic}-->
en

<algorithmType opt="MD5,SHA256,MD5/SHA256">
MD5
</algorithmType>
im

</SecurityAlgorithm>
</WebCertificateCap>
ng

<isSupportConfigFileImport>
Aj

true
</isSupportConfigFileImport>
Co

<isSupportConfigFileExport>
true
</isSupportConfigFileExport>
<cfgFileSecretKeyLenLimit min="0" max="16">
1
</cfgFileSecretKeyLenLimit>
<supportIPCActivatePassword>
true
</supportIPCActivatePassword>
<isIrreversible>
true
</isIrreversible>
<salt>
test
</salt>
<isSupportOnvifInfo>
true
</isSupportOnvifInfo>
<isSupportPictureURlCertificate opt="true,false">
true
returned, it indicates the digest authentication for picture URL by default-->true
</isSupportPictureURlCertificate>
<isSupportGB35114Certificate>
true
</isSupportGB35114Certificate>
<isSupportAuthenticationMode opt="uKey,private">
private
</isSupportAuthenticationMode>
<isSupportUnloggedUserPermissionConfig opt="true,false">
true
</isSupportUnloggedUserPermissionConfig>
<isSupportUserNamePasswordCheckUpgrade>
true
</isSupportUserNamePasswordCheckUpgrade>
<isSupportDeviceCertificatesManagement>
<!--ro, opt, bool, whether the device supports device certificate management, desc:if this node is not returned, it indicates that device does not

m
support this function-->true

co
</isSupportDeviceCertificatesManagement>
<isSupportSIPCertificatesManagement>
<!--ro, opt, bool, whether the device supports SIP certificate management, desc:this node is returned if the device supports this function and not

a.
returned if device does not support this function, related URI: /ISAPI/Security/SIPCertificate, additional node: <SIPCertificatesManagementCap>-->true
</isSupportSIPCertificatesManagement>

C. arc
<isSupportDeviceSelfSignCertExport>
true
</isSupportDeviceSelfSignCertExport>
<isSupportSecurityEmail>
<!--ro, opt, bool, whether the device supports configuring the security email, desc:if this node is not returned, it indicates that device does not

s, em
support this function-->true

A
</isSupportSecurityEmail>

no fr
<isSupportRTSPCertificate opt="true,false">
true
</isSupportRTSPCertificate>

ri on
<maxIllegalLoginTimes min="3" max="20" def="5">
<!--ro, opt, int, maximum failed illegal login attempts, range:[3,20], attr:min{req, int},max{req, int},def{req, int}, desc:this node is valid when the
value of the node issupportIllegalLoginLock is true and will be returned when the maximum failed attempts of illegally logging in to the device reach the

Ma oc
limit-->3
</maxIllegalLoginTimes>
up
<SecurityAdvanced>

<securityEnhanced>
co gr

true

</securityEnhanced>
<noOperationEnabled>
es a@

true
</noOperationEnabled>
Fr rc

<noOperationTime min="1" max="60" def="15">

15
</noOperationTime>
y ema

<isSupportDigestStatus>
true
</isSupportDigestStatus>
<passwordLimitLevel opt="middling,high">
os fr

<!--ro, opt, enum, password strength limit level, subType:string, attr:opt{req, string},
desc:the configured password is required by the following limit
“middling” (middle level), “high” (high level), middle level password contains 8 to 16 characters, including at least 2 types of the following characters:
ad on

digits, lower case letters, upper case letters, and special characters; high level password contains 8 to 16 characters, including at least 3 types of the
following characters: digits, lower case letters, upper case letters, and special characters-->middling
el .c

</passwordLimitLevel>
</SecurityAdvanced>
<LoginLinkNum>
ez

<maxLinkNum min="1" max="128" def="50">
50
en

</maxLinkNum>
</LoginLinkNum>
<isSupportCCClientCertificate>
im

true
ng

</isSupportCCClientCertificate>
Aj

<passwordValidity min="0" max="365">

<!--ro, opt, string, range of the password validity period, range:[0,365], attr:min{req, int},max{req, int}, desc:if this node is returned, it indicates
Co

that the device supports configuring the password validity period, and only the administrator can edit the configuration-->1
</passwordValidity>
<isSupportResetChannelPassword>
true
</isSupportResetChannelPassword>
<DoubleVerificationCap>

<isSupportUsersConfig>
true
</isSupportUsersConfig>
<isSupportUsersPermissionConfig>
true
</isSupportUsersPermissionConfig>
</DoubleVerificationCap>
<isSupportUserSearch>
true
</isSupportUserSearch>
<keypadPassword min="1" max="10">
1
</keypadPassword>
<installerKeypadPassword min="1" max="10">
1
1
</installerKeypadPassword>
<operatorKeypadPassword min="1" max="10">
1
</operatorKeypadPassword>
<userOperateType opt="1,2,3">
1
</userOperateType>
<isSptUserEnabled>
true
</isSptUserEnabled>
<isSptAdminCap>
true
</isSptAdminCap>
<isSupportBackLogCfg>
true

m
</isSupportBackLogCfg>
<isSupportBackLogExport>

co
true
</isSupportBackLogExport>

a.
<isSupportModifyInnerPassword opt="true,false">
true

C. arc
</isSupportModifyInnerPassword>
<isSupportEncryptCertificate>
true
</isSupportEncryptCertificate>

s, em
<maxIllegalLoginLockTime min="1" max="120" def="30.00">
1

A
</maxIllegalLoginLockTime>

no fr
<cloudSensitiveInfoEncryptType>
<!--ro, opt, string, encryption type of the cloud sensitive information, desc:the current device returns the value "2.1", which indicates that the

ri on
method of generating the key for encrypting the sensitive information is SHA256 (calc_sha256 (user, salt, SHA256 (user+salt2+SHA256 (user+salt+password))) +
AaBbCcDd1234!@#$)-->2.1
</cloudSensitiveInfoEncryptType>

Ma oc
<isSupportCertificateCustomID>
true
</isSupportCertificateCustomID>
up
<isSupportResetLANPassword>
<!--ro, opt, bool, whether the device supports resetting the device's password in the LAN, desc:related URI:
co gr

/ISAPI/Security/resetPassword/certification?format=json-->true
</isSupportResetLANPassword>
<isSupportPicHttpsCertificatesManagement>
es a@

true
</isSupportPicHttpsCertificatesManagement>
Fr rc

<isSupportAKSKImport>
true
y ema

</isSupportAKSKImport>
<isSupportAKSKExport>
true
</isSupportAKSKExport>
<isSupportAKSKReset>
os fr

true
</isSupportAKSKReset>
ad on

<ExportCertificateFile>

el .c

<type opt="GB35114,GB35114Service">
GB35114
ez

</type>
</ExportCertificateFile>
en

<isSupportGB351114FDWSFCertificate>
<!--ro, opt, bool, whether the device supports FDWSF certificate management, desc:true (support), this node is not returned (not support), related URIs:
/ISAPI/Security/GB351114/FDWSFCertificate/capabilities?format=json, POST /ISAPI/Security/GB351114/FDWSFCertificate?format=json, GET
im

/ISAPI/Security/GB351114/FDWSFCertificate?format=json, and DELETE /ISAPI/Security/GB351114/FDWSFCertificate?format=json-->true

</isSupportGB351114FDWSFCertificate>
ng

<isSupportMediaObjectEncryption>
Aj

<!--ro, opt, bool, whether supports setting encryption parameters of the private target in media data for the specified video channel, desc:if this
Co

function is supported, this node will be returned and its value is true; otherwise, this node will not be returned. Related URI:
/ISAPI/Security/MediaObjectEncryption/capabilities?format=json-->true
</isSupportMediaObjectEncryption>
<isSupportDisclaimer>
true
</isSupportDisclaimer>
<isSupportSoftwareLicense>
true
</isSupportSoftwareLicense>
<isSupportInstallerCap>
true
</isSupportInstallerCap>
<isSupportResetPasswordFile>
true
</isSupportResetPasswordFile>
<isNotSupportLogSeverCertificate>
true
</isNotSupportLogSeverCertificate>
<isSupportLocalLoginCfg>
true
true
</isSupportLocalLoginCfg>
<isSupportGetProtocolFirewallRulesFileImportStatus>
true
</isSupportGetProtocolFirewallRulesFileImportStatus>
<isSupportImportProtocolFirewallRulesFile>
true
</isSupportImportProtocolFirewallRulesFile>
<isSupportGetProtocolFirewallEngineUpgradeStatus>
true
</isSupportGetProtocolFirewallEngineUpgradeStatus>
<isSupportUpgradeProtocolFirewallEngine>
true
</isSupportUpgradeProtocolFirewallEngine>
<isSupportProtocolFirewallVersionInfo>
true
</isSupportProtocolFirewallVersionInfo>

m
<isSupportProtocolFirewallParams>

co
true
</isSupportProtocolFirewallParams>
<isSupportResetPasswordBySecurityPhoneNo>

a.
<!--ro, opt, bool, whether it supports resetting device password with phone number verification,
desc:1. attendance check devices support applying a preset phone number during device activation. The user can reset the device password with the preset

C. arc
phone number, which is similar with password reset via email. The phone number can be changed on the website or local UI of the device
2. if the node is not returned or the returned value is false, it indicates "no"-->true
</isSupportResetPasswordBySecurityPhoneNo>
<isSupportGetIntrusionPreventionEngineUpgradeStatus>

s, em
true
</isSupportGetIntrusionPreventionEngineUpgradeStatus>

A
<isSupportIntrusionPreventionEngineVersionInfo>

no fr
true
</isSupportIntrusionPreventionEngineVersionInfo>
<isSupportIntrusionPreventionParams>

ri on
true
</isSupportIntrusionPreventionParams>

Ma oc
<isSupportUpgradeIntrusionPreventionEngine>
true
</isSupportUpgradeIntrusionPreventionEngine>
up
<notSupportImportCertificateType opt="CA,CCClentCertificate,GB35114,GB35114Service">
test
</notSupportImportCertificateType>
co gr

</SecurityCap>
es a@

16.1.9.3 Get the device's system capability

Fr rc

Request URL
y ema

GET /ISAPI/System/capabilities
Query Parameter
os fr

None
ad on

Request Message
el .c

None
Response Message
ez
en

<?xml version="1.0" encoding="UTF-8"?>

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

im

<isSupportPreview>
ng

true

</isSupportPreview>
<isSupportSystemMaintain>
Co

true
</isSupportSystemMaintain>
<isSupportReboot>
true
</isSupportReboot>
<isSupportFactoryReset>
true
</isSupportFactoryReset>
<isSupportConfigurationData>
true
</isSupportConfigurationData>
<isSupportUpdatefirmware>
true
</isSupportUpdatefirmware>
<isSupportDeviceInfo>
true
</isSupportDeviceInfo>
<isSupportTime>
true
</isSupportTime>
<SysCap>


<isSupportDst>
true
</isSupportDst>
<NetworkCap>

<isSupportWireless>
true
</isSupportWireless>
<isSupportWAN>
true
</isSupportWAN>
<isSupportPPPoE>
true
</isSupportPPPoE>
<isSupportBond>

m
true
</isSupportBond>

co
<isSupport802_1x>
true

a.
</isSupport802_1x>
<isSupportNtp>
true

C. arc
</isSupportNtp>
<isSupportFtp>
true
</isSupportFtp>

s, em
<isSupportUpnp>
true

A
</isSupportUpnp>

no fr
<isSupportPNP>
true

ri on
</isSupportPNP>
<isSupportDdns>
true

Ma oc
</isSupportDdns>
<isSupportHttps>
true
up
</isSupportHttps>
<isSupport28181>
true
co gr

</isSupport28181>
<SnmpCap>
es a@

<isSupport>
true
Fr rc

</isSupport>
</SnmpCap>
<isSupportExtNetCfg>
y ema

true
</isSupportExtNetCfg>
<isSupportIPFilter>
true
os fr

</isSupportIPFilter>
<isSupportSSH opt="true,false">
ad on

true
</isSupportSSH>
<isSupportNetPreviewStrategy>
el .c

true
</isSupportNetPreviewStrategy>
<isSupportEZVIZ>
ez

true

</isSupportEZVIZ>
en

<isSupportEhome>
true
</isSupportEhome>
im

<isSupportWirelessDial>
true
ng

</isSupportWirelessDial>
Aj

<isSupportWirelessServer>
true
Co

</isSupportWirelessServer>
<isSupportWPS>
true
</isSupportWPS>
<isWirelessMutexWithWirelessServer>
true
</isWirelessMutexWithWirelessServer>
<isSupportMACFilter>
true
</isSupportMACFilter>
<GB28181Cap>

<isSupportGB28181Service>
true
</isSupportGB28181Service>
</GB28181Cap>
<WPS>

<NetworkInterfaceList size="2">

<NetworkInterface>

<id>
<id>
1
</id>
<enabled>
true
</enabled>
<isSupportAutoConnect>
true
</isSupportAutoConnect>
<isSupportDevicePinCode>
true
</isSupportDevicePinCode>
<isSupportDevicePinCodeUpdate>
true
</isSupportDevicePinCodeUpdate>
<ApPinCode>

m
<ssid min="1" max="1">

co
test
</ssid>
<pinCode min="1" max="1">

a.
test
</pinCode>

C. arc
</ApPinCode>
</NetworkInterface>
</NetworkInterfaceList>
</WPS>
<isSupportRFIDData>

s, em
true

A
</isSupportRFIDData>

no fr
<isSupportwifiProbeSSID>
true
</isSupportwifiProbeSSID>

ri on
<isSupportWifiProbe>
true
</isSupportWifiProbe>

Ma oc
<verificationCode min="1" max="1">
test
up
</verificationCode>
<WPSCap>

co gr

<isSupport>
true
</isSupport>
es a@

<isSupportAutoConnect>
true
Fr rc

</isSupportAutoConnect>
s

</WPSCap>
<NetWorkMode>
y ema

<workMode>
true
</workMode>
os fr

</NetWorkMode>
<VerificationCodeModification>

ad on

<verificationCodeType opt="normal,empty">
true
el .c

</verificationCodeType>
<isSupportDeclarationURL>
true
ez

</isSupportDeclarationURL>
<isSupportPrivacyPolicyURL>
true
en

</isSupportPrivacyPolicyURL>
<verificationCodeModify opt="true,false">
true
im

</verificationCodeModify>
ng

<Hyperlinks>
Aj

<declarationURL>
Co

test

</declarationURL>
<privacyPolicyURL>
test
</privacyPolicyURL>
</Hyperlinks>
<isSupportVerificationCodeCheck>
true
</isSupportVerificationCodeCheck>
<isSupportOldVerificationCode>
true
</isSupportOldVerificationCode>
</VerificationCodeModification>
<isSupportIntegrate>
true
</isSupportIntegrate>
<isSupportPlatformAccess>
true
</isSupportPlatformAccess>
<isSupportIntelligentBoost>
true
</isSupportIntelligentBoost>
<isSupportResourceStatistics>
<isSupportResourceStatistics>
true
</isSupportResourceStatistics>
<isSupportBandwidthLimit>
true
</isSupportBandwidthLimit>
<isSupportPOEPortsDisableAdaptiveServer>
true
</isSupportPOEPortsDisableAdaptiveServer>
<isSupportPOEConfiguration>
true
</isSupportPOEConfiguration>
<isSupportGetLinkSocketIP>
true
</isSupportGetLinkSocketIP>
<isSupportWebSocket>

m
true
</isSupportWebSocket>

co
<isSupportWebSocketS>
true

a.
</isSupportWebSocketS>
<Adaption>

C. arc
<streamType opt="0,1,2,3,4,5,7,8,9,10">
<!--ro, opt, string, stream type that supports network self-adaption during live view, attr:opt{opt, string}, desc:0 (main stream), 1 (sub-
stream), 2 (third stream), 3 (fourth stream/virtual stream), 4 (fifth stream), 5 (sixth stream), 7 (seventh stream), 8 (eighth stream), 9 (ninth stream), 10
(tenth stream), and so forth. The index value here is the same as that in the live view structure NET_DVR_PREVIEWINFO of Device Network SDK. Note that 6 is

s, em
an invalid value, and from the seventh stream (index value: 7), the index value is the same as that for live view via RTSP-->test
</streamType>

A
<isSupportPlayback>

no fr
true
</isSupportPlayback>

ri on
</Adaption>
<isSupportVideoImgDB>
true

Ma oc
</isSupportVideoImgDB>
<isSupportEventDataOverWebSocket opt="true,false">
true
up
</isSupportEventDataOverWebSocket>
<isSupportDynamicHostName>
co gr

true
</isSupportDynamicHostName>
<isSupportTCPAcceleration>
es a@

true

</isSupportTCPAcceleration>
<isSupportFlowControl>
Fr rc

true

</isSupportFlowControl>
y ema

<isSupportEZVIZTiming>
true
</isSupportEZVIZTiming>
<isSupportTrafficMonitor>
os fr

true
ad on

</isSupportTrafficMonitor>
<isSupportDMSAuthInfo>
true
el .c

</isSupportDMSAuthInfo>
<isSupportWiredandWirelessTrafficMonitor>
<!--ro, opt, bool, whether the device supports traffic monitoring (wireless NIC and wired NIC), desc:related URI:
ez

/ISAPI/System/Network/Interfaces/<ID>/trafficMonitor?format=json-->true
</isSupportWiredandWirelessTrafficMonitor>
en

<isSupport4G>
true
</isSupport4G>
im

<isSupport4GConfig>
true
ng

</isSupport4GConfig>
Aj

<isSupportGRIDServer>
Co

true

</isSupportGRIDServer>
<isSupportGRIDInfo>
true
</isSupportGRIDInfo>
<isSupportSipTransmit>
true
</isSupportSipTransmit>
<isSupportSip>
true
</isSupportSip>
<isSupportWifiCascade>
true
</isSupportRelativeInfo>
<isSupportEmailEncrypt>
true
</isSupportEmailEncrypt>
<isSupportPortFilter>
true
true
</isSupportPortFilter>
<isSupportPingDeny>
true
</isSupportPingDeny>
<isSupportDOSDeny>
true
</isSupportDOSDeny>
<isSupportNetworkStatus>
true
</isSupportNetworkStatus>
<isSupportEZVIZQRCode>
true
</isSupportEZVIZQRCode>
<isSupportEZVIZUnbind>
true
</isSupportEZVIZUnbind>

m
<isSupportPingTest>

co
true
</isSupportPingTest>
<isSupportMOTCloudPlateform>

a.
true

C. arc
</isSupportMOTCloudPlateform>
<isSupportSpectrumScan>
true

s, em
</isSupportSpectrumScan>
<isSupportFRP>

A
true

no fr
</isSupportFRP>
<isSupport5GModule>
<!--ro, opt, bool, whether the device supports 5G module configuration, desc:related URI: /ISAPI/System/Network/5GModule/capabilities?format=json--

ri on
>true
</isSupport5GModule>

Ma oc
<isSupportWirelessDialRoute>
true
up
</isSupportWirelessDialRoute>
<isSupportNPlusOne>
true
co gr

</isSupportNPlusOne>
<supportEnvironmentalStandards opt="HJ212">
true
es a@

</supportEnvironmentalStandards>
<isSupportIntranetSegment>
Fr rc

<!--ro, opt, bool, whether the device supports LAN segment configuration, desc:if this function is supported, this node will be returned and its
s

value is true; otherwise, this node will be returned and its value is true or not be returned. Related URI:
/ISAPI/System/Network/intranetSegment/capabilities?format=json-->true
y ema

</isSupportIntranetSegment>
<isSupportDHCPServer>
<!--ro, opt, bool, whether the device supports DHCP service configuration, desc:if this function is supported, this node will be returned and its
value is true; otherwise, this node will be returned and its value is true or not be returned. Related URI: /ISAPI/System/Network/DHCPServer/capabilities?
os fr

format=json-->true
</isSupportDHCPServer>
<isSupportClusterIntercom>
ad on

true
el .c

</isSupportClusterIntercom>
<isSupportHydrologicMonitoring>
<!--ro, opt, bool, whether the device supports hydrologic monitoring data communication, desc:if this function is supported, this node will be
ez

returned and its value is true; otherwise, this node will be returned and its value is true or not be returned. Related URI:
/ISAPI/System/Network/HydrologicMonitoring/capabilities?format=json-->true
</isSupportHydrologicMonitoring>
en

<isWirelessDialMutexWithWlanAndWifi>
<!--ro, opt, bool, whether the wireless dial-up is mutually exclusive with the WLAN hotspot and Wi-Fi, desc:before a function is enabled, another
im

one must be disabled first.-->true

</isWirelessDialMutexWithWlanAndWifi>
ng

<isSupportSpeechTranscription>
Aj

<!--ro, opt, bool, whether the device supports accessing the speech-to-text transcription platform, desc:if this function is supported, this node
will be returned and its value is true; otherwise, this node will be returned and its value is true or not be returned. Related URI:
Co

/ISAPI/System/Network/speechTranscriptionPlatform/capabilities?format=json-->true
</isSupportSpeechTranscription>
<isSupportAsynPingTest>
true
</isSupportAsynPingTest>
<isSupportBasebandCapture>
true
</isSupportBasebandCapture>
<isSupportCellularNetworkSpeedTest>
true
</isSupportCellularNetworkSpeedTest>
<isSupportCellularNetworkCellInfo>
true
</isSupportCellularNetworkCellInfo>
<isSupportMultiBandFrequencyScanning>
true
</isSupportMultiBandFrequencyScanning>
<isSupportCellularNetworkLockBand>
true
</isSupportCellularNetworkLockBand>
<isSupportRadioFrequencyFluctuation>
true
</isSupportRadioFrequencyFluctuation>
<isSupportBasebandBlock>
true
</isSupportBasebandBlock>
<isSupportRFIDTagCheckTest>
true
</isSupportRFIDTagCheckTest>

m
<isSupportQoSDSCPtoLoaclPriorityMapping>

co
true
</isSupportQoSDSCPtoLoaclPriorityMapping>

a.
<isSupportQoS802.1pto802.1pPriorityMapping>
true

C. arc
</isSupportQoS802.1pto802.1pPriorityMapping>
<isSupportLinkTestStart>
true

s, em
</isSupportLinkTestStart>
<isSupportLinkTestResult>

A
no fr
true
</isSupportLinkTestResult>

ri on
<isSupportNetworkModuleUpgrade>
<!--ro, opt, bool, whether it supports upgrading network module, desc:including importing upgrade package
(/ISAPI/System/Network/WirelessDial/ImportUpgradePackage?format=json), getting importing progress

Ma oc
(/ISAPI/System/Network/WirelessDial/GetUpgradePackageImportStatus?format=json), starting upgrade
(/ISAPI/System/Network/WirelessDial/StartUpgradeNetworkModule?format=json)-->true
</isSupportNetworkModuleUpgrade>
up
<isSupportNetworkModuleVersionInfo>
<!--ro, opt, bool, whether it supports getting the version information of network module, desc:GET
co gr

/ISAPI/System/Network/WirelessDial/NetworkModuleVersionInfo?format=json-->true
</isSupportNetworkModuleVersionInfo>
<isSupportGreenShieldPlatform>
es a@

true

</isSupportGreenShieldPlatform>
<isSupportFusionUniversalApplicationPlatCfg>
Fr rc

true

</isSupportFusionUniversalApplicationPlatCfg>
y ema

<isSupportModbusAccess>
true
</isSupportModbusAccess>
<isSupportModbusTestSubordinateStatus>
os fr

true

</isSupportModbusTestSubordinateStatus>
</NetworkCap>
ad on

<IOCap>

<IOInputPortNums>
el .c

true

</IOInputPortNums>
ez

<IOOutputPortNums>
true
</IOOutputPortNums>
en

<isSupportStrobeLamp>
true
im

</isSupportStrobeLamp>
<SoftIOInputPortNums>
ng

<!--ro, opt, int, number of soft input ports of the device, desc:this node depends on whether the URI /ISAPI/System/IO/softInputs/capabilities?
Aj

format=json is supported.-->true
Co

</SoftIOInputPortNums>
<isSupportIOOutputAdvanceParameter>
true
</isSupportIOOutputAdvanceParameter>
<isSupportSetAllIOOutput>
true
</isSupportSetAllIOOutput>
<isSupportCombinationAlarm>
true
</isSupportCombinationAlarm>
<isSupportAlarmKeyParam>
true
</isSupportAlarmKeyParam>
<isSupportWebDisplayAlarmStatus>
true
</isSupportWebDisplayAlarmStatus>
</IOCap>
<SerialCap>

<rs485PortNums>
true
true
</rs485PortNums>
<supportRS232Config>
true
</supportRS232Config>
<rs422PortNums>
true
</rs422PortNums>
<rs232PortNums>
true
</rs232PortNums>
<rs485WorkMode opt="Led,CaptureTrigger">
test
</rs485WorkMode>
<rs232SerialNumber opt="1,2,3">

m
test
</rs232SerialNumber>

co
<rs485SerialNumber opt="4,5,6">
test

a.
</rs485SerialNumber>
<isSupportAuthenticationService>
true

C. arc
</isSupportAuthenticationService>
<isSupportDeviceInfo>
true
</isSupportDeviceInfo>

s, em
<isSupportSearchDeviceInfoRelations>
true

A
</isSupportSearchDeviceInfoRelations>

no fr
</SerialCap>
<VideoCap>

ri on
<videoInputPortNums>
true

Ma oc
</videoInputPortNums>
<videoOutputPortNums>
true
up
</videoOutputPortNums>
<menuNums>
true
co gr

</menuNums>
<externalChannelNum>
es a@

true

</externalChannelNum>
<isSupportHeatmap>
Fr rc

true

</isSupportHeatmap>
<isSupportCounting>
y ema

true

</isSupportCounting>
<countingType>
test
os fr

</countingType>
<isSupportPicture>
true
ad on

</isSupportPicture>
<isSupportPreviewSwitch>
el .c

true
</isSupportPreviewSwitch>
<isSupportMultiChannelCounting>
ez

true

</isSupportMultiChannelCounting>
<isSupportCountingCollection>
en

true
</isSupportCountingCollection>
im

<isSupportHeatmapCollection>
true
ng

</isSupportHeatmapCollection>
Aj

<channelFlexible opt="name,online,linknum">
true
Co

</channelFlexible>
<isSupportMixedChannel>
true
</isSupportMixedChannel>
<isSupportMixedChannelStatus>
true
</isSupportMixedChannelStatus>
<isSupportRecodStatus>
true
</isSupportRecodStatus>
<isSupportPrivacyMask>
true
</isSupportPrivacyMask>
<isSupportBinocularPreviewSwitch>
true
</isSupportBinocularPreviewSwitch>
<isSupportCalibCheck>
true
</isSupportCalibCheck>
<isSupportPIP>
true
</isSupportPIP>
<isSupportFocusVideoMode>
true
</isSupportFocusVideoMode>
<isSupportExternalChannel>
true
</isSupportExternalChannel>
<isSupportCompressedTranscode>
true
</isSupportCompressedTranscode>
<isSupportLocalStreamCfg>
true
</isSupportLocalStreamCfg>
<isSupportMenuStatus>
true
</isSupportMenuStatus>

m
</VideoCap>

co
<AudioCap>

<audioInputNums>

a.
1
</audioInputNums>
<audioOutputNums>

C. arc
1
</audioOutputNums>
<mixAudioInSet>
true

s, em
</mixAudioInSet>

A
<mixAudioOutSet>

no fr
true
</mixAudioOutSet>
<isSupportAudioMixing>

ri on
true
</isSupportAudioMixing>
<isSupportRemoveFrequencyPoint>

Ma oc
true
</isSupportRemoveFrequencyPoint>
up
<isSupportAudioInConfig>
true
co gr

</isSupportAudioInConfig>
<muteDuringPanTilt opt="MicIn">
<!--ro, opt, string, whether the device supports muting during motion, attr:opt{opt, string}, desc:muteDuringPanTilt in
es a@

/ISAPI/System/TwoWayAudio/channels/ID-->true
</muteDuringPanTilt>
<isSupportAudioOutConfig>
Fr rc

true
y ema

</isSupportAudioOutConfig>
<isSupportSAIP>
true
</isSupportSAIP>
os fr

<SAIPChannelsNum>
1
</SAIPChannelsNum>
ad on

<isSupportDataStorage>
true
</isSupportDataStorage>
el .c

<isSupportDataRelease>
true
ez

</isSupportDataRelease>
<isSupportAudioPlan>
true
en

</isSupportAudioPlan>
<isSupportAudioTask>
true
im

</isSupportAudioTask>
ng

<isSupportaudioCollection>
Aj

true
Co

</isSupportaudioCollection>
<isSupportWirelessPickUp>
true
</isSupportWirelessPickUp>
<audioOutputBroadcastNums opt="1,2,3,4">
0
</audioOutputBroadcastNums>
<isSupportAudioOutMixing>
true
</isSupportRTSPAudio>
<isSupportRTSPAudioPlaybackByFile>
true
</isSupportRTSPAudioPlaybackByFile>
</isSupportRTSPAudioPlaybackByFile>
</AudioCap>
<isSupportHolidy>
true
</isSupportHolidy>
<RebootConfigurationCap>

<Genetec>
true
</Genetec>
<ONVIF>
true
</ONVIF>
<RTSP>
true

m
</RTSP>
<HTTP>

co
true
</HTTP>

a.
<SADP>

<ISDiscoveryMode>

C. arc
true
</ISDiscoveryMode>
<PcapMode>
true

s, em
</PcapMode>
</SADP>

A
<IPCAddStatus>

no fr
true
</IPCAddStatus>

ri on
</RebootConfigurationCap>
<isSupportExternalDevice>
<!--ro, opt, bool, whether the device supports connecting to peripherals: true (support), desc:related URI: /ISAPI/System/externalDevice/capabilities-

Ma oc
->true
</isSupportExternalDevice>
<isSupportSoundCfg>
up
true
</isSupportSoundCfg>
<isSupportSubscribeEvent>
co gr

true
</isSupportSubscribeEvent>
es a@

<isSupportSubscribeIOTInfo>
true
</isSupportSubscribeIOTInfo>
Fr rc

<isSupportDiagnosedData>
true
y ema

</isSupportDiagnosedData>
<isSupportChangedUpload>
true
</isSupportChangedUpload>
os fr

<isSupportGettingWorkingStatus>
true
ad on

</isSupportGettingWorkingStatus>
<isSupportGettingChannelInfoByCondition>
true
el .c

</isSupportGettingChannelInfoByCondition>
<isSupportDiagnosedDataParameter>
true
ez

</isSupportDiagnosedDataParameter>
<isSupportSimpleDevStatus>
en

true
</isSupportSimpleDevStatus>
<isSupportFlexible>
im

<!--ro, opt, bool, whether the device supports the flexible combination configuration. Related URI: /ISAPI/System/Video/inputs/channels?format=json--
>true
ng

</isSupportFlexible>
Aj

<isSupportPTZChannels>
true
Co

</isSupportPTZChannels>
<isSupportMetadata>
true
</isSupportMetadata>
<isSupportTimeCap>
true
</isSupportTimeCap>
<isSupportThermalStreamData>
true
</isSupportThermalStreamData>
<isSupportShutdown>
true
</isSupportShutdown>
<isSupportConsumptionMode>
true
</isSupportConsumptionMode>
<isSupportManualPowerConsumption>
true
</isSupportManualPowerConsumption>
<isSupportPostUpdateFirmware>
true
</isSupportPostUpdateFirmware>
</isSupportPostUpdateFirmware>
<isSupportPostConfigData>
true
</isSupportPostConfigData>
<isSupportUserLock>
true
</isSupportUserLock>
<isSupportModuleLock>
true
</isSupportModuleLock>
<supportSmartOverlapChannles opt="1">
true
</supportSmartOverlapChannles>
<isSupportNetworkCapture>
true

m
</isSupportNetworkCapture>

co
<isSupportOperationRecord>
true

a.
</isSupportOperationRecord>
<isSupportSearchModuleLock>

C. arc
true
</isSupportSearchModuleLock>
</SysCap>
<voicetalkNums>
2

s, em
</voicetalkNums>

A
<isSupportSnapshot>

no fr
true
</isSupportSnapshot>
<SecurityCap>

ri on

<supportUserNums>
1

Ma oc
</supportUserNums>
<userBondIpNums>
up
1
</userBondIpNums>
<userBondMacNums>
co gr

1
</userBondMacNums>
<isSupCertificate>
es a@

true

</isSupCertificate>
Fr rc

<issupIllegalLoginLock>
s

true

</issupIllegalLoginLock>
y ema

<isSupportOnlineUser>
true
</isSupportOnlineUser>
<isSupportAnonymous>
os fr

true

</isSupportAnonymous>
<isSupportStreamEncryption>
ad on

true

</isSupportStreamEncryption>
el .c

<securityVersion opt="1,2,3,4,7">
<!--ro, opt, string, encryption capability, attr:opt{opt, string}, desc:the encryption capability of each version consists of two parts: encryption
algorithm and the range of encrypted nodes. Currently 1 refers to AES128 encryption and 2 refers to AES256 encryption. The range of encrypted nodes is
ez

described in each protocol-->test

</securityVersion>
<keyIterateNum>
en

100
</keyIterateNum>
<isSupportUserCheck>
im

<!--ro, opt, bool, whether the device supports verifying the login password when editing (editing/adding/deleting) user parameters, desc:this node
ng

depends on the node <securityVersion>, which means that it is only valid for the versions that support encrypting the sensitive information-->true
Aj

</isSupportUserCheck>
<isSupportGUIDFileDataExport>
Co

true
</isSupportGUIDFileDataExport>
<isSupportSecurityQuestionConfig>
true
</isSupportSecurityQuestionConfig>
<supportSecurityNode opt="wirelessServer,wirelessDial">
test
</supportSecurityNode>
<isSupportGetOnlineUserListSC>
true
</isSupportGetOnlineUserListSC>
<SecurityLimits>

<LoginPasswordLenLimit min="1" max="16">
test
</LoginPasswordLenLimit>
<SecurityAnswerLenLimit min="1" max="128">
test
</SecurityAnswerLenLimit>
</SecurityLimits>
<RSAKeyLength opt="512,1024,2048" def="2048">
2048
2048
</RSAKeyLength>
<isSupportONVIFUserManagement>
true
</isSupportONVIFUserManagement>
<WebCertificateCap>

<CertificateType opt="basic,digest,digest/basic">
test
</CertificateType>
<SecurityAlgorithm>

<algorithmType opt="MD5,SHA256,MD5/SHA256">
test
</algorithmType>

m
</SecurityAlgorithm>
</WebCertificateCap>

co
<isSupportConfigFileImport>
true

a.
</isSupportConfigFileImport>
<isSupportConfigFileExport>
true

C. arc
</isSupportConfigFileExport>
<cfgFileSecretKeyLenLimit min="0" max="16">
0
</cfgFileSecretKeyLenLimit>

s, em
<supportIPCActivatePassword>
true

A
</supportIPCActivatePassword>

no fr
<isIrreversible>
<!--ro, opt, bool, whether the device supports irreversible password storage, desc:if this function is not supported, the plaintext password of the

ri on
user information will be stored in the device; otherwise, the password will be hashed for storage in the device-->true
</isIrreversible>
<salt>

Ma oc
test
</salt>
<isSupportOnvifInfo>
up
true
</isSupportOnvifInfo>
co gr

<isSupportUserNamePasswordCheckUpgrade>
true
</isSupportUserNamePasswordCheckUpgrade>
es a@

<isSupportDeviceCertificatesManagement>
true
</isSupportDeviceCertificatesManagement>
Fr rc

<isSupportSIPCertificatesManagement>
true
y ema

</isSupportSIPCertificatesManagement>
<isSupportDeviceSelfSignCertExport>
true
</isSupportDeviceSelfSignCertExport>
<isSupportSecurityEmail>
os fr

true
</isSupportSecurityEmail>
ad on

<isSupportRTSPCertificate opt="true,false">
true
</isSupportRTSPCertificate>
el .c

<isSupportPictureURlCertificate opt="true,false">
true
</isSupportPictureURlCertificate>
ez

<isSupportGB35114Certificate>
true
en

</isSupportGB35114Certificate>
<isSupportAuthenticationMode opt="uKey,private">
private
im

</isSupportAuthenticationMode>
<isSupportUnloggedUserPermissionConfig opt="true,false">
ng

true
Aj

</isSupportUnloggedUserPermissionConfig>
Co

<maxIllegalLoginTimes min="3" max="20" def="5">

1
</maxIllegalLoginTimes>
<SecurityAdvanced>

<securityEnhanced>
true
</securityEnhanced>
<noOperationEnabled>
true
</noOperationEnabled>
<noOperationTime min="1" max="60" def="15">
1
</noOperationTime>
<isSupportDigestStatus>
true
</isSupportDigestStatus>
</SecurityAdvanced>
<LoginLinkNum>

<maxLinkNum min="1" max="128" def="50">
64
64
</maxLinkNum>
</LoginLinkNum>
<isSupportCCClientCertificate>
true
</isSupportCCClientCertificate>
<passwordValidity min="0" max="365">
1
</passwordValidity>
<isSupportResetChannelPassword>
true
</isSupportResetChannelPassword>
<DoubleVerificationCap>

<isSupportUsersConfig>
true

m
</isSupportUsersConfig>

co
<isSupportUsersPermissionConfig>
true
</isSupportUsersPermissionConfig>

a.
<isSupportFactoryReset>
true

C. arc
</isSupportFactoryReset>
</DoubleVerificationCap>
<isSupportUserSearch>
true

s, em
</isSupportUserSearch>
<keypadPassword min="1" max="10">

A
<!--ro, opt, int, keypad password length, attr:min{req, int},max{req, int}, desc:When the password length of different user types is different, this

no fr
node only indicates the keypad password length of the administrator; otherwise, the keypad password length of all user types is the same and defined by the
value of this node.-->1
</keypadPassword>

ri on
<installerKeypadPassword min="1" max="10">
1

Ma oc
</installerKeypadPassword>
<operatorKeypadPassword min="1" max="10">
1
up
</operatorKeypadPassword>
<userOperateType opt="1,2,3">
<!--ro, opt, enum, user type: 1 (network user), subType:int, attr:opt{req, string}, desc:1 (network user), 2 (keypad user), 3 (network user and keypad
co gr

user)-->1
</userOperateType>
<isSptUserEnabled>
es a@

true
</isSptUserEnabled>
Fr rc

<isSptAdminCap>
s

true
</isSptAdminCap>
y ema

<isSupportBackLogCfg>
true
</isSupportBackLogCfg>
<isSupportBackLogExport>
os fr

true
</isSupportBackLogExport>
<isSupportModifyInnerPassword opt="true,false">
ad on

true
el .c

</isSupportModifyInnerPassword>
<isSupportEncryptCertificate>
true
ez

</isSupportEncryptCertificate>
<maxIllegalLoginLockTime min="1" max="120" def="30.00">
1
en

</maxIllegalLoginLockTime>
<cloudSensitiveInfoEncryptType>
im

<!--ro, opt, string, encryption type of the cloud sensitive information, desc:the current device returns the value "2.1", which means that the method
of generating the key for encrypting the sensitive information is SHA256(calc_sha256(user, salt, SHA256(user+salt2+SHA256(user+salt+password)))+
ng

AaBbCcDd1234!@#$).-->2.1
Aj

</cloudSensitiveInfoEncryptType>
<isSupportCertificateCustomID>
Co

true
</isSupportCertificateCustomID>
<isSupportResetLANPassword>
true
</isSupportResetLANPassword>
<isSupportPicHttpsCertificatesManagement>
true
</isSupportPicHttpsCertificatesManagement>
<isSupportAKSKImport>
true
</isSupportAKSKImport>
<isSupportAKSKExport>
true
</isSupportAKSKExport>
<isSupportAKSKReset>
true
</isSupportAKSKReset>
<ExportCertificateFile>

</ExportCertificateFile>
<isSupportGB351114FDWSFCertificate>
true
</isSupportGB351114FDWSFCertificate>
<isSupportMediaObjectEncryption>
true
</isSupportMediaObjectEncryption>
<isSupportDisclaimer>
<!--ro, opt, bool, whether support configuring the product disclaimer, desc:if this function is supported, this node will be returned and its value is

m
true; otherwise, this node will not be returned. Related URI: /ISAPI/Security/disclaimer/capabilities?format=json-->true

co
</isSupportDisclaimer>
<isSupportSoftwareLicense>
<!--ro, opt, bool, whether support configuring the product open source statement, desc:if this function is supported, this node will be returned and

a.
its value is true; otherwise, this node will not be returned. Related URI: /ISAPI/Security/softwareLicense?format=json-->true
</isSupportSoftwareLicense>
<isSupportInstallerCap>

C. arc
true
</isSupportInstallerCap>
<isSupportResetPasswordFile>

s, em
true

A
no fr
</isSupportResetPasswordFile>
<isNotSupportLogSeverCertificate>
true

ri on
</isNotSupportLogSeverCertificate>
<isSupportLocalLoginCfg>
true

Ma oc
</isSupportLocalLoginCfg>
<isSupportGetProtocolFirewallRulesFileImportStatus>
true
up
</isSupportGetProtocolFirewallRulesFileImportStatus>
<isSupportImportProtocolFirewallRulesFile>
co gr

true

</isSupportImportProtocolFirewallRulesFile>
<isSupportGetProtocolFirewallEngineUpgradeStatus>
es a@

true

</isSupportGetProtocolFirewallEngineUpgradeStatus>
<isSupportUpgradeProtocolFirewallEngine>
Fr rc

true

</isSupportUpgradeProtocolFirewallEngine>
y ema

<isSupportProtocolFirewallVersionInfo>
true
</isSupportProtocolFirewallVersionInfo>
<isSupportProtocolFirewallParams>
os fr

true

</isSupportProtocolFirewallParams>
<isSupportResetPasswordBySecurityPhoneNo>
ad on

<!--ro, opt, bool, whether it supports resetting device password with phone number verification,
desc:1. attendance check devices support applying a preset phone number during device activation. The user can reset the device password with the preset
phone number, which is similar with password reset via email. The phone number can be changed on the website or local UI of the device
el .c

2. if the node is not returned or the returned value is false, it indicates "no"-->true
</isSupportResetPasswordBySecurityPhoneNo>
ez

<isSupportGetIntrusionPreventionEngineUpgradeStatus>
true
en

</isSupportGetIntrusionPreventionEngineUpgradeStatus>
<isSupportIntrusionPreventionEngineVersionInfo>
<!--ro, opt, bool, whether the device supports version information of intrusion prevention engine, desc:GET
im

/ISAPI/Security/IntrusionPreventionEngineVersionInfo?format=json-->true
</isSupportIntrusionPreventionEngineVersionInfo>
ng

<isSupportIntrusionPreventionParams>
Aj

<!--ro, opt, bool, whether the device supports intrusion prevention parameters, desc:GET/PUT /ISAPI/Security/IntrusionPreventionParams?format=json--
Co

>true
</isSupportIntrusionPreventionParams>
<isSupportUpgradeIntrusionPreventionEngine>
true
</isSupportUpgradeIntrusionPreventionEngine>
<notSupportImportCertificateType opt="CA,CCClentCertificate,GB35114,GB35114Service">
test
</notSupportImportCertificateType>
<isSupportPasswordProtection>
true
</isSupportPasswordProtection>
</SecurityCap>
<EventCap>

<isSupportHDFull>
true
</isSupportHDFull>
<isSupportHDError>
true
</isSupportHDError>
<isSupportNicBroken>
true
true
</isSupportNicBroken>
<isSupportIpConflict>
true
</isSupportIpConflict>
<isSupportIllAccess>
true
</isSupportIllAccess>
<isSupportViException>
true
</isSupportViException>
<isSupportViMismatch>
true
</isSupportViMismatch>
<isSupportRecordException>
true

m
</isSupportRecordException>
<isSupportRaidException>

co
true
</isSupportRaidException>
<isSupportViResMismatch>

a.
true
</isSupportViResMismatch>

C. arc
<isSupportPOCException>
true
</isSupportPOCException>
<isSupportSmartDetection>

s, em
true
</isSupportSmartDetection>

A
<isSupportSpareException>

no fr
true
</isSupportSpareException>
<isSupportPoePowerException>

ri on
true
</isSupportPoePowerException>

Ma oc
<isSupportTriggerFocus>
true
</isSupportTriggerFocus>
up
<isSupportMotionDetection>
true
</isSupportMotionDetection>
co gr

<isSupportVideoLoss>
true
es a@

</isSupportVideoLoss>
<isSupportTamperDetection>
true
Fr rc

</isSupportTamperDetection>
<isSupportFireDetection>
true
y ema

</isSupportFireDetection>
<isSupportRegionEntrance>
true
</isSupportRegionEntrance>
os fr

<isSupportRegionExiting>
true
</isSupportRegionExiting>
ad on

<isSupportLoitering>
true
el .c

</isSupportLoitering>
<isSupportGroup>
true
ez

</isSupportGroup>
<isSupportRapidMove>
true
en

</isSupportRapidMove>
<isSupportParking>
im

true
</isSupportParking>
ng

<isSupportUnattendedBaggage>
Aj

true
</isSupportUnattendedBaggage>
Co

m
<isSupportParallelParking>

co
true
</isSupportParallelParking>
<isSupportParkingState>

a.
true
</isSupportParkingState>
<isSupportTrafficJam>

C. arc
true
</isSupportTrafficJam>
<isSupportCongestion>
true

s, em
</isSupportCongestion>

A
<isSupportStudentsStoodUp>

no fr
true
</isSupportStudentsStoodUp>
<isSupportFramesPeopleCounting>

ri on
true
</isSupportFramesPeopleCounting>
<isSupportFaceSnap>

Ma oc
true
</isSupportFaceSnap>
up
<isSupportPersonDensityDetection>
true
</isSupportPersonDensityDetection>
co gr

<HFPD>
true
</HFPD>
es a@

<isSupportPersonQueueDetection>
true
</isSupportPersonQueueDetection>
Fr rc

<isSupportVehicleStatistics>
true
y ema

</isSupportVehicleStatistics>
<isSupportFaceThermometry>
true
</isSupportFaceThermometry>
os fr

<isSupportSafetyHelmetDetection>
true
</isSupportSafetyHelmetDetection>
ad on

<isSupportPowerSupplyCabinet>
true
</isSupportPowerSupplyCabinet>
el .c

<isSupportSensorDetection>
true
ez

</isSupportSensorDetection>
<isSupportSignAbnormal>
true
en

</isSupportSignAbnormal>
<isSupportTeacherBehaviorDetect>
true
im

</isSupportTeacherBehaviorDetect>
ng

<isSupportCityManagement>
Aj

true
</isSupportCityManagement>
Co

m
true
</isSupportBlock>

co
<isSupportFlowers>
true

a.
</isSupportFlowers>
<isSupportNoise>
true

C. arc
</isSupportNoise>
<isSupportGhost>
true
</isSupportGhost>

s, em
<isSupportPurple>
true

A
</isSupportPurple>

no fr
<isSupportICR>
true

ri on
</isSupportICR>
<isSupportProtectiveFilm>
true

Ma oc
</isSupportProtectiveFilm>
<isSupportVoltageInstable>
true
up
</isSupportVoltageInstable>
<isSupportCertificateRevocation>
true
co gr

</isSupportCertificateRevocation>
<isSupportSysStorFull>
es a@

true
</isSupportSysStorFull>
<isSupportVersionAbnormal>
Fr rc

true
</isSupportVersionAbnormal>
<isSupportNodeOffline>
y ema

true
</isSupportNodeOffline>
<isSupportRecordCycleAbnormal>
true
os fr

</isSupportRecordCycleAbnormal>
<isSupportIpcTransferAbnormal>
ad on

true
</isSupportIpcTransferAbnormal>
<isSupportDrivingBehaviorDetect>
el .c

true
</isSupportDrivingBehaviorDetect>
<isSupportWasteGasDetection>
ez

true
</isSupportWasteGasDetection>
en

<isSupportGreyScaleAlarm>
true
</isSupportGreyScaleAlarm>
im

<isSupportPTLocking>
true
ng

</isSupportPTLocking>
Aj

<isSupportNoMaskDetection>
true
Co

</isSupportNoMaskDetection>
<isSupportTMPA>
true
</isSupportTMPA>
<RuleScheduleCap>

<isSupportCityManagement>
true
</isSupportCityManagement>
</RuleScheduleCap>
<RegionScheduleCap>

<isSupportPersonDensityDetection>
true
</isSupportPersonDensityDetection>
<isSupportPersonQueueDetection>
true
</isSupportPersonQueueDetection>
</RegionScheduleCap>
<isSupportThermalCalibrationFileException>
true
</isSupportThermalCalibrationFileException>
<isSupportTemperatureIntervalMeasurement>
<isSupportTemperatureIntervalMeasurement>
true
</isSupportTemperatureIntervalMeasurement>
<isSupportThermalVehicleDetection>
true
</isSupportThermalVehicleDetection>
<isSupportWaterQualityDetection>
true
</isSupportWaterQualityDetection>
<isSupportWaterLevelDetection>
true
</isSupportWaterLevelDetection>
<isSupportDeviceTemperatureAbnormal>
true
</isSupportDeviceTemperatureAbnormal>
<isSupportObjectAccumulationDetection>
true

m
</isSupportObjectAccumulationDetection>

co
<isSupportAppAbnormal>
true
</isSupportAppAbnormal>

a.
<isSupportLensTemperatureException>
true

C. arc
</isSupportLensTemperatureException>
<isSupportPTZFXYFinish>
true
</isSupportPTZFXYFinish>
<isSupportNormalTemperatureAlarm>

s, em
true

A
</isSupportNormalTemperatureAlarm>

no fr
<isSupportLowTemperatureAlarm>
true
</isSupportLowTemperatureAlarm>

ri on
<isSupportLowCoolerLifeEvent>
true
</isSupportLowCoolerLifeEvent>

Ma oc
<isSupportObstacleAvoidanceAlarm>
true
up
</isSupportObstacleAvoidanceAlarm>
<isSupportPTZRotationAbnormal>
true
co gr

</isSupportPTZRotationAbnormal>
</EventCap>
<ITCCap>
es a@

<isSupportITC>
Fr rc

true

</isSupportITC>
<isSupportIllegalDictionary>
y ema

true
</isSupportIllegalDictionary>
<isSupportVehicleDetection>
true
os fr

</isSupportVehicleDetection>
<isSupportHVTVehicleDetection>
true
ad on

</isSupportHVTVehicleDetection>
<isSupportlicencePlateAuditData>
el .c

true
</isSupportlicencePlateAuditData>
<isSupportSearchLPListAudit>
ez

true
</isSupportSearchLPListAudit>
<isSupportVehicleDetectionManualTrigger opt="false,true">
en

true
</isSupportVehicleDetectionManualTrigger>
<isSupportSyncSignalOutput>
im

true
ng

</isSupportSyncSignalOutput>
Aj

</ITCCap>
<ImageCap>
Co

<isSupportRegionalExposure>
true
</isSupportRegionalExposure>
<isSupportRegionalFocus>
true
</isSupportRegionalFocus>
</ImageCap>
<RacmCap>

<isSupportZeroChan>
true
</isSupportZeroChan>
<inputProxyNums>
1
</inputProxyNums>
<eSATANums>
1
</eSATANums>
<miniSASNums>
1
</miniSASNums>
<nasNums>
1
1
</nasNums>
<ipSanNums>
1
</ipSanNums>
<isSupportRaid>
true
</isSupportRaid>
<isSupportExtHdCfg>
true
</isSupportExtHdCfg>
<isSupportTransCode>
true
</isSupportTransCode>
<isSupportIpcImport>
<!--ro, opt, bool, whether the device supports importing the configuration file of the network camera, desc:related URI:

m
/ISAPI/ContentMgmt/InputProxy/ipcConfig-->true
</isSupportIpcImport>

co
<NasMountType>

a.
<isNFSSupportAuthentication>
true
</isNFSSupportAuthentication>

C. arc
<isCIFSSupportAuthentication>
true
</isCIFSSupportAuthentication>
</NasMountType>

s, em
<isSupportIpcStreamType>
true

A
</isSupportIpcStreamType>

no fr
<isSupportIOInputProxy>
true

ri on
</isSupportIOInputProxy>
<isSupportIOOutputProxy>
true

Ma oc
</isSupportIOOutputProxy>
<isSupportPTZRs485Proxy>
true
up
</isSupportPTZRs485Proxy>
<isSupportSrcIDSearch>
co gr

true

</isSupportSrcIDSearch>
<isSupportReversePlayback>
es a@

true

</isSupportReversePlayback>
<isSupportSMARTTest>
Fr rc

true
</isSupportSMARTTest>
y ema

<isSupportDownloadByTime>
true
</isSupportDownloadByTime>
<pictureSearchType
opt="AllEvent,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,Command,pir,wlsensor,callhelp,facedetection,FieldDetection,scenechangedetection,LineDetection,
os fr

regionEntrance,regionExiting,loitering,group,rapidMove,parking,unattendedBaggage,attendedBaggage,vehicleDetection,manual,manualSnapShot,playSnapShot,safetyH
elmet,
ad on

personQueueCounting,personQueueTime,violentMotion,leavePosition,advReachHeight,peopleNumChange,mixedTargetDetection,illegalParking,pedestrian,construction,r
oadblock,
abandonedObject,trafficAccident,fogDetection,smokeDetection,personDensity,failDown,accessController,videoInterCom,GJD,Luminite,OPTEX,securityControlPanel,ge
el .c

tUp,toiletTarry,
playCellphone,vehicleMonitor,vibrationDetection,running,retention,spacingChange,yardTarry,keyPersonGetUp,sitQuietly,standUp,plateRecognition,smoking,onThePh
one,fatigueDriving,
ez

notLookingStraightAhead,leaveThePost,seatBelt,sunglasses,identityAbnormal,ForwardCollisionWarning,LaneDepartureWarning,BlindSpotDetection,HeadwayMonitoringW
arning,
en

PedestrianCollisionWarning,SuddenSpeedUp,SuddenSpeedDown,SuddenLeftTurn,SuddenRightTurn,Turnover,NotYieldToPedestrian,unregisteredStreetVendor,stallOutsideS
hop,stallOccupyingRoad, illegalHeap,illegalParkingofNon-
MotorVehicle,illegalOutdoorAdvertisement,packGarbage,stallUnderUmbrella,dustbinOverflow,exposeGarbage,hangClothingAlongStreet,allPic,ATMPanel,
im

ATMSurround,ATMFace,ATMSafetyCabin,loitering,smokeDetectAlarm,alarmResult">
test
ng

</pictureSearchType>
Aj

<recordSearchType
Co

opt="AllEvent,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,Command,pir,wlsensor,callhelp,facedetection,FieldDetection,scenechangedetection,LineDetection,
regionEntrance,regionExiting,loitering,group,rapidMove,parking,unattendedBaggage,attendedBaggage,vehicleDetection,manual,manualSnapShot,playSnapShot,safetyH
elmet,
failDown,personDensityDetection,smokeDetection,vibrationDetection,unregisteredStreetVendor,stallOutsideShop,stallOccupyingRoad,illegalHeap,illegalParkingofN
on-MotorVehicle,
illegalOutdoorAdvertisement,packGarbage,stallUnderUmbrella,dustbinOverflow,exposeGarbage,hangClothingAlongStreet,ATMPanel,ATMSurround,ATMFace,ATMSafetyCabin
">
test
</recordSearchType>
<isSupportActivateIpc>
true
</isSupportActivateIpc>
<isSupportCheckIpcSecurity>

<isSupportCheckPassword>
true
</isSupportCheckPassword>
</isSupportCheckIpcSecurity>
<isSupportMainAndSubRecord>
true
</isSupportMainAndSubRecord>
</isSupportMainAndSubRecord>
<isSupportSyncIPCPassword>
true
</isSupportSyncIPCPassword>
<isSupportTransferIPC>
true
</isSupportTransferIPC>
<isSupportSmartSearch>
true
</isSupportSmartSearch>
<isSupportPOS>
true
</isSupportPOS>
<isSupportLinkNum>
<!--ro, opt, bool, whether the device supports getting the number of links, desc:related URI: /ISAPI/ContentMgmt/InputProxy/channels/<ID>/linkNum--
>true
</isSupportLinkNum>

m
<isSupportPassBackBasicCfg>

co
true
</isSupportPassBackBasicCfg>

a.
<PassBackTaskConfig>

C. arc
<isSupportAddTask>
true
</isSupportAddTask>
<isSupportSearchTask>

s, em
true
</isSupportSearchTask>

A
<isSupportControlTask>

no fr
<!--ro, opt, bool, whether the device supports controlling the task, desc:related URI: /ISAPI/ContentMgmt/record/passback/controlTask/capabilities--
>true
</isSupportControlTask>

ri on
<isSupportDeleteTask>
<!--ro, opt, bool, whether the device supports deleting the task, desc:related URI: /ISAPI/ContentMgmt/record/passback/deleteTask/capabilities--

Ma oc
>true
</isSupportDeleteTask>
</PassBackTaskConfig>
up
<PassBackPlanConfig>

<isSupportAddPlan>
co gr

true
</isSupportAddPlan>
<isSupportSearchPlan>
es a@

<!--ro, opt, bool, whether the device supports searching schedules, desc:related URI: /ISAPI/ContentMgmt/record/passback/searchPlan/capabilities--
>true
Fr rc

</isSupportSearchPlan>
s

<isSupportDeletePlan>
<!--ro, opt, bool, whether the device supports deleting the schedule, desc:related URI: /ISAPI/ContentMgmt/record/passback/deletePlan/capabilities--
y ema

>true
</isSupportDeletePlan>
</PassBackPlanConfig>
<IRAIDCap>
os fr

<isSupportIRAIDRapidConfiguration>
<!--ro, opt, bool, whether the device supports the rapid IRAID configuration, desc:related URI:
ad on

/ISAPI/ContentMgmt/Storage/IRAID/RapidConfiguration/capabilities-->true
</isSupportIRAIDRapidConfiguration>
el .c

</IRAIDCap>
<isSupportStorageExtraInfo>
<!--ro, opt, bool, whether the device supports configuring additional storage information, desc:related URI:
ez

/ISAPI/ContentMgmt/Storage/ExtraInfo/capabilities-->true
</isSupportStorageExtraInfo>
<isSupportRecordStatus>
en

<!--ro, opt, bool, whether the device supports getting the recording status, desc:related URI: /ISAPI/ContentMgmt/channels/<ID>/record/capabilities--
>true
im

</isSupportRecordStatus>
<isSupportRacmChannelsCap>
ng

true
Aj

</isSupportRacmChannelsCap>
<LockCap>
Co

</LockCap>
<isSupportForamtAll>
true
</isSupportForamtAll>
<isSupportExtendCabinetCfg>
true
</isSupportExtendCabinetCfg>
<diskGroupNums>
1
</diskGroupNums>
<ExternalDevice>

<USB>

<debugLogOutput>
true
</debugLogOutput>
<isSupportCapturePackage>
true
</isSupportCapturePackage>
<isSupportStreamStorage>
true
</isSupportStreamStorage>
</USB>
</ExternalDevice>
<customProtocolNums>
1
</customProtocolNums>
<isSupportIPCTiming>
true
</isSupportIPCTiming>
<isSupportLogConfig>
true

m
</isSupportLogConfig>

co
<SecurityLog>

<isSupportSecurityLog>

a.
true
</isSupportSecurityLog>
<isSupportLogServer>

C. arc
true
</isSupportLogServer>
<isSupportLogServerTest>
true

s, em
</isSupportLogServerTest>
<SecurityLogTypeList>

A

no fr
<SecurityLogType>

ri on
<primaryType>
test
</primaryType>

Ma oc
<secondaryType opt="all">
test
</secondaryType>
up
</SecurityLogType>
</SecurityLogTypeList>
co gr

<isSupportLogServerList>
true
</isSupportLogServerList>
es a@

</SecurityLog>
<isSupportGetBackupDevice>
<!--ro, opt, bool, whether the device supports getting the backup device, desc:related URI: /ISAPI/ContentMgmt/Storage/backup/device?format=json--
Fr rc

>true
</isSupportGetBackupDevice>
y ema

<isSupportAutoBackup>
<!--ro, opt, bool, whether the device supports automatic backup, desc:related URI: /ISAPI/ContentMgmt/Storage/backup/auto/capabilities?format=json--
>true
</isSupportAutoBackup>
os fr

<certificateValidationEnabled>
true
ad on

</certificateValidationEnabled>
<defaultAdminPortEnabled>
<!--ro, opt, bool, whether to enable the default communication port, desc:related URI: /ISAPI/ContentMgmt/InputProxy/channels/<ID>. In this protocol,
el .c

whether the <defaultAdminPortEnabled> node supports-->true

</defaultAdminPortEnabled>
ez

<isSupportLogDataPackage>
true
</isSupportLogDataPackage>
en

<logSearchTimeSpanNums>
1
im

</logSearchTimeSpanNums>
<CloudStorageServerCap>
ng

<isSupportCloudStorageParameter>
Co

true
</isSupportCloudStorageParameter>
<isSupportCloudStoragePool>
true
</isSupportCloudStoragePool>
<supportChannelsNum>
1
</supportChannelsNum>
</CloudStorageServerCap>
<isSupportWebPrivatePlaybackByUTC>
true
</isSupportWebPrivatePlaybackByUTC>
<isSupportFindCommonFileByUTC>
true
</isSupportFindCommonFileByUTC>
<isSupportFindEventFileByUTC>
true
</isSupportFindEventFileByUTC>
<isSupportSmartSearchRecordByUTC>
true
true
</isSupportSmartSearchRecordByUTC>
<isSupportMRDSearchByTimeZone>
true
</isSupportMRDSearchByTimeZone>
<isSupportSearchRecordLabelByUTC>
true
</isSupportSearchRecordLabelByUTC>
<isSupportSearchPictureByUTC>
true
</isSupportSearchPictureByUTC>
<isSupportSmartSearchPictureByUTC>
true
</isSupportSmartSearchPictureByUTC>
<isSupportFindLogByUTC>
true

m
</isSupportFindLogByUTC>
<isSupportUploadRecordByUTC>

co
true
</isSupportUploadRecordByUTC>
<isSupportPlaybackByUTC>

a.
true
</isSupportPlaybackByUTC>

C. arc
<isSupportFaceDetecttionAlarmByTimeZone>
true
</isSupportFaceDetecttionAlarmByTimeZone>
<isSupportSourceModify>

s, em
true

A
</isSupportSourceModify>

no fr
<isSupportCountingSearchByUTC>
true
</isSupportCountingSearchByUTC>

ri on
<isSupportCluster>
true

Ma oc
</isSupportCluster>
<supportAIDTFSType opt="illegalParking,wrongdirection,crosslane,vehicleexist,lanechange,turnround,evidence">
test
up
</supportAIDTFSType>
<isSupportMisinfoStateSearch>
true
co gr

</isSupportMisinfoStateSearch>
<isSupportOneKeyOperationStorageData>
es a@

true
</isSupportOneKeyOperationStorageData>
Fr rc

<eventRecordSearch>

<eventType opt="faceContrast,faceSnap,vehicleMatchResult,hawkResult">
y ema

test

</eventType>
<auxEventType opt="faceContrastFailure,faceContrastSuccess">
test
os fr

</auxEventType>
</eventRecordSearch>
<isSupportManualRecord>
ad on

<!--ro, opt, bool, whether the device supports manual recording, desc:related URI: /ISAPI/ContentMgmt/record/control/manual/capabilities?format=json--
>true
el .c

</isSupportManualRecord>
<isSupportRemark>
true
ez

</isSupportRemark>
<FileUpload>

en

<enabled>
true
im

</enabled>
</FileUpload>
ng

<PoliceInfoUpload>
Aj

<enabled>
Co

true

</enabled>
</PoliceInfoUpload>
<PoliceInfo>

<policeID>
true
</policeID>
<policeCode>
true
</policeCode>
<policeName>
true
</policeName>
<password>
true
</password>
<deviceID>
true
</deviceID>
</PoliceInfo>
<isSupportAssignChannelID>
true
</isSupportAssignChannelID>
<isSupportAssignStreamID>
true
</isSupportAssignStreamID>
<PictureSearchSubTypeList>

<PictureSearchSubType>

<mainType>
test
</mainType>
<subType opt="all,motorVehicle,nonMotorVehicle,pedestrian">
test
</subType>

m
</PictureSearchSubType>

co
</PictureSearchSubTypeList>
<isSupportPlaybackStreamIDByUTC>
true

a.
</isSupportPlaybackStreamIDByUTC>
<isSupportTimeLockStreamIDByUTC>
true

C. arc
</isSupportTimeLockStreamIDByUTC>
<isSupportTimeSearch>
true

s, em
</isSupportTimeSearch>

A
<behaviorEventPicSearch opt="allBehaviorEvent,running,group,violentMotion,failDown,playCellphone,peopleNumChange,leavePosition,retention,sleepOnduty">

no fr
test
</behaviorEventPicSearch>
<perimeterEventPicSearch opt="allPerimeterEvent,linedetection,fielddetection,regionEntrance,regionExiting,loitering">

ri on
test
</perimeterEventPicSearch>
<isSupportSourceStatus>

Ma oc
true
</isSupportSourceStatus>
up
<isSupportSSDSMARTTest>
<!--ro, opt, bool, whether the device supports S.M.A.R.T. detection on SSD, desc:related URI: /ISAPI/ContentMgmt/Storage/ssd/<ID>/SMARTTest/start--
>true
co gr

</isSupportSSDSMARTTest>
<MobileStorage>

es a@

<isSupportGetFileTime>
true
Fr rc

</isSupportGetFileTime>
</MobileStorage>
y ema

<isSupportGetChannelList>
true
</isSupportGetChannelList>
os fr

<isSupportCascade>
true
</isSupportCascade>
ad on

<isSupportPictureInfo>
true
</isSupportPictureInfo>
el .c

<isSupportCloudStorageModel>
<!--ro, opt, bool, whether the device supports configuring the cloud storage mode,
ez

desc:/ISAPI/ContentMgmt/Storage/CloudStorageModel/<channelID>/capabilities?format=json-->true
</isSupportCloudStorageModel>
<isSupportCloudStorageModelList>
en

true
</isSupportCloudStorageModelList>
im

<isSupportRecordAudio>
ng

<!--ro, opt, bool, whether the device supports recording the audio, desc:only the audio will be recorded and the video will not be recorded. Related
Aj

URI: /ISAPI/ContentMgmt/recordAudio/<audioID>/capabilities?format=json-->true
</isSupportRecordAudio>
Co

<isSupportSearchAudio>
true
</isSupportSearchAudio>
<isSupportAudioDailyDistribution>
true
</isSupportAudioDailyDistribution>
<isSupportDownloadAudio>
true
</isSupportDownloadAudio>
<isSupportDeleteAudio>
true
</isSupportDeleteAudio>
<isSupportSearchRemoteAlbum>
true
</isSupportSearchRemoteAlbum>
<isSupportStreamParam>
true
</isSupportStreamParam>
</isSupportStreamParam>
<isSupportFusionChan>
true
</isSupportFusionChan>
<isSupportRecordMultipleDownload>
true
</isSupportRecordMultipleDownload>
</RacmCap>
<PTZCtrlCap>

<isSupportPatrols>
true

m
</isSupportPatrols>
<isSupportCombinedPath>

co
true
</isSupportCombinedPath>

a.
<isSupportRailwayRobot>
true
</isSupportRailwayRobot>

C. arc
</PTZCtrlCap>
<SmartCap>

<isSupportROI>

s, em
true
</isSupportROI>

A
<isSupportFaceDetect>

no fr
true
</isSupportFaceDetect>

ri on
<isSupportIntelliTrace>
true
</isSupportIntelliTrace>

Ma oc
<isSupportFieldDetection>
true
</isSupportFieldDetection>
up
<isSupportDefocusDetection>
true
</isSupportDefocusDetection>
co gr

<isSupportAudioDetection>
true
es a@

</isSupportAudioDetection>
<isSupportSceneChangeDetection>
true
Fr rc

</isSupportSceneChangeDetection>
<isSupportLineDetection>
true
y ema

</isSupportLineDetection>
<isSupportRegionEntrance>
true
</isSupportRegionEntrance>
os fr

<isSupportRegionExiting>
true
ad on

</isSupportRegionExiting>
<isSupportLoitering>
true
el .c

</isSupportLoitering>
<isSupportGroup>
true
ez

</isSupportGroup>
<isSupportRapidMove>
en

true
</isSupportRapidMove>
<isSupportParking>
im

true

</isSupportParking>
ng

<isSupportUnattendedBaggage>
Aj

true
</isSupportUnattendedBaggage>
Co

m
<isSupportLFPD>

co
true
</isSupportLFPD>
<isSupportSmartOverlapParams>

a.
true
</isSupportSmartOverlapParams>

C. arc
</SmartCap>
<isSupportEhome>
true
</isSupportEhome>
<isSupportStreamingEncrypt>

s, em
true

A
</isSupportStreamingEncrypt>

no fr
<TestCap>

<isSupportEmailTest>

ri on
true
</isSupportEmailTest>
</TestCap>

Ma oc
<ImageMiscCap>

up
<isSupportDPC>
true
</isSupportDPC>
co gr

</ImageMiscCap>
<PanoramaCap>

es a@

<isSupportGeneratePanorama>
true
Fr rc

</isSupportGeneratePanorama>
s

<isSupportPanoramaPosition3D>
true
y ema

</isSupportPanoramaPosition3D>
<isSupportPreset>
true
</isSupportPreset>
os fr

</PanoramaCap>
<ThermalCap>

ad on

<isSupportFireDetection>
true
el .c

</isSupportFireDetection>
<isFireFocusZoomSupport>
true
ez

</isFireFocusZoomSupport>
<isSupportThermometry>
true
en

</isSupportThermometry>
<isSupportRealtimeThermometry>
true
im

</isSupportRealtimeThermometry>
ng

<isSupportThermIntell>
Aj

true
Co

</isSupportThermIntell>
<isSupportNVR>
true
</isSupportNVR>
<isSupportThermometrySchedule>
true
</isSupportFireDetectionSchedule>
<isSupportPower>
true
</isSupportPower>
<isSupportRealtimeTempHumi>
true
</isSupportRealtimeTempHumi>
<ManualThermCap>


<manualThermRuleNum>
true
</manualThermRuleNum>
</ManualThermCap>
<isSupportManualThermBasic>
true
</isSupportManualThermBasic>
<isSupportFireShieldMask>
true
</isSupportFireShieldMask>
<isSupportSmokeShieldMask>
<!--ro, opt, bool, whether the device supports configuring the parameters of smoke shielded regions, desc:related URI:

m
/ISAPI/Thermal/channels/<ID>/smokeShieldMask/capabilities-->true
</isSupportSmokeShieldMask>

co
<isSupportThermometryMode>
<!--ro, opt, bool, whether the device supports configuring temperature measurement mode, desc:related URI:

a.
/ISAPI/Thermal/channels/<ID>/thermometryMode/capabilities-->true
</isSupportThermometryMode>
<isSupportThermalPip>

C. arc
true
</isSupportThermalPip>
<isSupportThermalIntelRuleDisplay>
<!--ro, opt, bool, whether the device supports the PIP configuration, desc:related URI: /ISAPI/Thermal/channels/<ID>/IntelRuleDisplay/capabilities--

s, em
>true
</isSupportThermalIntelRuleDisplay>

A
<AlgVersionInfo>

no fr

ri on
<thermometryAlgName min="1" max="128">
test
</thermometryAlgName>

Ma oc
<shipsAlgName min="1" max="128">
test
</shipsAlgName>
up
<fireAlgName min="1" max="128">
test
co gr

</fireAlgName>
<smokeAlgName min="1" max="128">
test
es a@

</smokeAlgName>
<wasteGasAlgName min="1" max="128">
test
Fr rc

</wasteGasAlgName>
<greyScaleAlarmAlgName min="1" max="128">
y ema

test
</greyScaleAlarmAlgName>
</AlgVersionInfo>
<isSupportFaceThermometry>
<!--ro, opt, bool, whether supports temperature screening configuration, desc:related URI: /ISAPI/Thermal/channels/<ID>/faceThermometry/capabilities--
os fr

>true
</isSupportFaceThermometry>
ad on

<isSupportThermalBlackBody>
true
el .c

</isSupportThermalBlackBody>
<isSupportThermalStreamParam>
<!--ro, opt, bool, whether the device supports configuring stream parameters of thermal imaging, desc:related URI:
ez

/ISAPI/Thermal/channels/<ID>/streamParam/capabilities-->true
</isSupportThermalStreamParam>
en

<isSupportBodyTemperatureCompensation>
true
im

</isSupportBodyTemperatureCompensation>
<isSupportClickToThermometry>
ng

<!--ro, opt, bool, whether the device supports click-to-thermometry, desc:related URI: ISAPI/Thermal/channels/<ID>/clickToThermometry/initialization--
Aj

>true
Co

</isSupportClickToThermometry>
<isSupportThermometryHistorySearch>
true
</isSupportThermometryHistorySearch>
<isSupportThermometryShieldMask>
true
</isSupportThermometryShieldMask>
<isSupportTemperatureCorrection>
true
</isSupportTemperatureCorrection>
<isSupportBurningPrevention>
true
</isSupportBurningPrevention>
<isSupportTemperatureCollection>
true
</isSupportTemperatureCollection>
<isSupportJpegPicWithAppendData>
true
</isSupportJpegPicWithAppendData>
<isSupportRealTimethermometryForHTTP>
<isSupportRealTimethermometryForHTTP>
true
</isSupportRealTimethermometryForHTTP>
<isSupportthermometryOffLineCapture>
true
</isSupportthermometryOffLineCapture>
<isSupportShipsDetectionWithScene>
true
</isSupportShipsDetectionWithScene>
<isSupportWasteGasDetection>
true
</isSupportWasteGasDetection>
<isSupportGreyScaleAlarm>
true

m
</isSupportGreyScaleAlarm>

co
<isSupportFaceSnapThermometry>
true
</isSupportFaceSnapThermometry>

a.
<isSupportThermalTemperatureCorrect>
<!--ro, opt, bool, whether device supports temperature calibration, desc:related URI: /ISAPI/Thermal/channels/<ID>/temperatureCorrect?format=json--

C. arc
>true
</isSupportThermalTemperatureCorrect>
<isSupportThermalVehicleDetection>
true

s, em
</isSupportThermalVehicleDetection>
<isSupportSensorParam>

A
<!--ro, opt, bool, whether the device supports configuring the sensor temperature measurement parameters, desc:related URI:

no fr
/ISAPI/Thermal/channels/<channelID>/thermometry/sensorParam/capabilities?format=json-->true
</isSupportSensorParam>
<isSupportTemperatureIntervalMeasurement>

ri on
true
</isSupportTemperatureIntervalMeasurement>

Ma oc
<isSupportIndustryThermometryTemperatureRise>
true
up
</isSupportIndustryThermometryTemperatureRise>
<isSupportThermalDataLinkInfo>
<!--ro, opt, bool, whether the device supports getting the temperature data link information, desc:related URI: /ISAPI/Thermal/thermalDataLinkInfo?
co gr

format=json; /ISAPI/Thermal/thermalDataLinkStatus?format=json-->true
</isSupportThermalDataLinkInfo>
<isSupportTemperatureCompensationCalib>
es a@

true
Fr rc

</isSupportTemperatureCompensationCalib>
s

<isSupportWebDisplayPixelToPixelParam>
<!--ro, opt, bool, whether the web needs to display full-screen temperature parameters, desc:related URI:
y ema

/ISAPI/Thermal/channels/<channelID>/thermometry/pixelToPixelParam/capabilities-->true
</isSupportWebDisplayPixelToPixelParam>
<isSupportThermalInspection>
true
os fr

</isSupportThermalInspection>
<isSupportBlackBodyTemperature>
<!--ro, opt, bool, whether the device supports searching for black body center point temperature, desc:related URI:
ad on

/ISAPI/Thermal/channels/<channelID>/blackBodyTemperature?format=json-->true
</isSupportBlackBodyTemperature>
el .c

<isSupportExportThermalCalibrationFile>
true
ez

</isSupportExportThermalCalibrationFile>
<isSupportSearchSmokeAndFireDetection>
<!--ro, opt, bool, whether the device supports searching for history records of smoke and fire detection, desc:POST
en

/ISAPI/Thermal/fireDetection/SearchSmokeAndFireDetection?format=json-->true
</isSupportSearchSmokeAndFireDetection>
im

<isSupportColumnOven>
true
ng

</isSupportColumnOven>
Aj

<isSupportImportThermalCalibrationFile>
<!--ro, opt, bool, whether the device supports importing the temperature calibration file, desc:POST /ISAPI/Thermal/ImportThermalCalibrationFile?
Co

format=json-->true
</isSupportImportThermalCalibrationFile>
<isSupportThermalCalibrationFileCreatParam>
true
</isSupportThermalCalibrationFileCreatParam>
<isSupportNormalRuleParams>
true
</isSupportNormalRuleParams>
<isSupportEnvironmentTemperatureMonitorScheduleParams>
true
</isSupportEnvironmentTemperatureMonitorScheduleParams>
<isSupportEnvironmentTemperatureMonitorParam>
true
</isSupportEnvironmentTemperatureMonitorParam>
<isSupportEnvironmentTemperatureMonitorTriggerParams>
true
</isSupportEnvironmentTemperatureMonitorTriggerParams>
<isSupportSearchAsynThermalInspectionTaskTestPoint>
true
</isSupportSearchAsynThermalInspectionTaskTestPoint>
<isSupportSearchAsynThermalInspectionTask>
true
</isSupportSearchAsynThermalInspectionTask>
<isSupportAddAsynThermalInspectionTaskTestPoint>
true
</isSupportAddAsynThermalInspectionTaskTestPoint>
<isSupportAddAsynThermalInspectionTask>
true
</isSupportAddAsynThermalInspectionTask>
<isSupportImportAsynThermalInspectionTaskBaseMap>

m
<!--ro, opt, bool, whether the device supports importing asynchronous thermal inspection task base map, desc:POST

co
/ISAPI/Thermal/ImportAsynThermalInspectionTaskBaseMap?format=json-->true
</isSupportImportAsynThermalInspectionTaskBaseMap>
<isSupportShutterFreeze>

a.
true
</isSupportShutterFreeze>
</ThermalCap>

C. arc
<WLAlarmCap>

<isSupportTeleControl>
true

s, em
</isSupportTeleControl>
<isSupportPIR>

A
true

no fr
</isSupportPIR>
<isSupportWLSensors>

ri on
true
</isSupportWLSensors>
<isSupportCallHelp>

Ma oc
true
</isSupportCallHelp>
<WLSensorsNum>
up
1
</WLSensorsNum>
co gr

</WLAlarmCap>
<isSupportGIS>
true
es a@

</isSupportGIS>
<isSupportCompass>
true
Fr rc

</isSupportCompass>
<isSupportRoadInfoOverlays>
y ema

true
</isSupportRoadInfoOverlays>
<isSupportFaceCaptureStatistics>
<!--ro, opt, bool, whether the device supports face capture statistics, desc:related URI:
os fr

/ISAPI/Intelligent/channels/<ID>/faceCaptureStatistics/search-->true
</isSupportFaceCaptureStatistics>
<isSupportElectronicsEnlarge>
ad on

true

</isSupportElectronicsEnlarge>
<isSupportRemoveStorage>
el .c

true

</isSupportRemoveStorage>
ez

<isSupportCloud>
true
</isSupportCloud>
en

<isSupportRecordHost>
true
</isSupportRecordHost>
im

<isSupportViewshedOverlay>
<!--ro, opt, bool, whether the device supports overlaying viewshed camera target, desc:related URI:
ng

/ISAPI/System/Video/inputs/channels/<ID>/viewshedOverlay-->true
Aj

</isSupportViewshedOverlay>
Co

<isSupportGPSLabelTracking>
true
</isSupportGPSLabelTracking>
<isSupportEagleEye>
true
</isSupportEagleEye>
<isSupportPanorama>
true
</isSupportPanorama>
<isSupportFirmwareVersionInfo>
true
</isSupportFirmwareVersionInfo>
<isSupportExternalWirelessServer>
true
</isSupportExternalWirelessServer>
<isSupportSetupCalibration>
true
</isSupportSetupCalibration>
<isSupportGetmutexFuncErrMsg>
true
</isSupportGetmutexFuncErrMsg>
<isSupportTokenAuthenticate>
true
</isSupportTokenAuthenticate>
</isSupportTokenAuthenticate>
<isSupportStreamDualVCA>
true
</isSupportStreamDualVCA>
<isSupportLaserSpotManual>
true
</isSupportLaserSpotManual>
<isSupportRTMP>
true
</isSupportRTMP>
<isSupportTraffic>
true
</isSupportTraffic>
<isSupportLaserSpotAdjustment>
true

m
</isSupportLaserSpotAdjustment>
<VideoIntercomCap>

co

<isSupportSceneManage>
true

a.
</isSupportSceneManage>
<isSupportDeviceId>

C. arc
true
</isSupportDeviceId>
<isSupportOperationTime>
true

s, em
</isSupportOperationTime>
<isSupportCallerInfo>

A
true

no fr
</isSupportCallerInfo>
<isSupportCallSignal>
true

ri on
</isSupportCallSignal>
<isSupportCallStatus>

Ma oc
true
</isSupportCallStatus>
<isSupportCallElevator>
up
true
</isSupportCallElevator>
<isSupportRelatedDeviceAdress>
co gr

true
</isSupportRelatedDeviceAdress>
es a@

<isSupportCardSectorCheck>
true
</isSupportCardSectorCheck>
Fr rc

<isSupportKeyCfg>
true
</isSupportKeyCfg>
y ema

<isSupportWorkModeCfg>
true
</isSupportWorkModeCfg>
<isSupportSystemSwitchCfg>
os fr

true

</isSupportSystemSwitchCfg>
<isSupportPrivilegePasswordStatus>
ad on

true
</isSupportPrivilegePasswordStatus>
el .c

<isSupportSmartHomeRoomsCfg>
true
</isSupportSmartHomeRoomsCfg>
ez

<isSupportSmartHomeDevices>
true
</isSupportSmartHomeDevices>
en

<isSupportScenesCfg>
true
im

</isSupportScenesCfg>
<isSupportNameModify>
ng

true
Aj

</isSupportNameModify>
<isSupportElevatorControlCfg>
Co

true

</isSupportElevatorControlCfg>
<isSupportPrivilegePassword>
true
</isSupportPrivilegePassword>
<isSupportSubModules>
true
</isSupportSubModules>
<isSupportIssueCards>
true
</isSupportIssueCards>
<isSupportSendCardCfg>
true
</isSupportSendCardCfg>
<isSupportRingBackTone>
true
</isSupportRingBackTone>
<isSupportCallPriority>
true
</isSupportCallPriority>
<isSupportPhoneCfg>
true
</isSupportPhoneCfg>
<isSupportWatchPoint>
true
</isSupportWatchPoint>
<isSupportVoiceConfiguration>
true
</isSupportVoiceConfiguration>
<isSupportSubModulesCfg>
true
</isSupportSubModulesCfg>
<isSupportDisplayRegion>
true
</isSupportDisplayRegion>
<isSupportUpdateData>
true
</isSupportUpdateData>
<isSupportUpdateStrategy>

m
true

co
</isSupportUpdateStrategy>
<isSupportMetaInfo>
true

a.
</isSupportMetaInfo>
<isSupportStreamAbility>
true

C. arc
</isSupportStreamAbility>
<platform opt="R0,R1,S29">
R0
</platform>

s, em
<isSupportSecurityMode>

A
true

no fr
</isSupportSecurityMode>
<isSupportDeviceCommunication>
true

ri on
</isSupportDeviceCommunication>
<isSupportAutoSync>
true

Ma oc
</isSupportAutoSync>
<isSupportDifferentKeystrokes>
up
true
</isSupportDifferentKeystrokes>
<isSupportKeyCfgWeekPlan>
co gr

true
</isSupportKeyCfgWeekPlan>
<isSupportKeyCfgHolidayPlan>
es a@

true
</isSupportKeyCfgHolidayPlan>
<isSupportKeyCfgHolidayGroup>
Fr rc

true
</isSupportKeyCfgHolidayGroup>
y ema

<isSupportKeyCfgPlanTemplate>
true
</isSupportKeyCfgPlanTemplate>
<isSupportCallCfg>
os fr

true

</isSupportCallCfg>
<isSupportAccessParams>
ad on

true

</isSupportAccessParams>
<isSupportTransmitRequestEventConfirm>
el .c

true

</isSupportTransmitRequestEventConfirm>
ez

<isSupportIncomingCallLinkage>
true
</isSupportIncomingCallLinkage>
en

<isSupportAdbControl>
true
</isSupportAdbControl>
im

<isSupportProtocolFileManage>
ng

<!--ro, opt, bool, whether the device supports the management of the protocol notice files, desc:/ISAPI/VideoIntercom/protocolFileManage/capabilities?
Aj

format=json-->true
</isSupportProtocolFileManage>
Co

<isSupportStreamSwitch>
true
</isSupportStreamSwitch>
<isSupportKeywordAudioRecognition>
true
</isSupportOneWaySpeaking>
<isSupportPositionInfo>
true
</isSupportPositionInfo>
<isSupportElevatorControlDisplay>
true
</isSupportRingManage>
<isSupportPasswordAuthentication>
true
/ISAPI/VideoIntercom/passwordAuthentication/capabilitie-->true
</isSupportPasswordAuthentication>
<isSupportAlarmControlByPhone>
true
</isSupportAlarmControlByPhone>
<isSupportZoneCfgByScene>
true
</isSupportZoneCfgByScene>
<isSupportAppKeyConfiguration>
true
</isSupportAppKeyConfiguration>
<isSupportIntercomProtocolChange>
true
</isSupportIntercomProtocolChange>

m
<isSupportGetAnnouncementMessage>
<!--ro, opt, bool, whether the device supports getting announcement message, desc:related URI: /ISAPI/VideoIntercom/AnnouncementMessage/capabilities--

co
>true
</isSupportGetAnnouncementMessage>

a.
<isSupportGetDeployInfo>
true
</isSupportGetDeployInfo>

C. arc
<detectorType opt="panicButton,magneticContact,smokeDetector,activeInfraredDetector,passiveInfraredDetector,combustibleGasDetector,doorbell">
test

s, em
</detectorType>
<isSupportBroadcastRealtime>

A
true

no fr
</isSupportBroadcastRealtime>
<isSupportOrganizationNodes>

ri on
true
</isSupportOrganizationNodes>
<isSupportAudioPlayStatus>

Ma oc
true
</isSupportAudioPlayStatus>
<isSupportDeviceIdAnalysisRuleCfg>
up
true
</isSupportDeviceIdAnalysisRuleCfg>
co gr

<isSupportOperationTimeByChannel>
true
es a@

</isSupportOperationTimeByChannel>
<isSupportCallAuthorization>
<!--ro, opt, bool, whether the device supports configuring permission for incoming calls, desc:related URI:
Fr rc

/ISAPI/VideoIntercom/CallAuthorization/capbilities?format=json-->true
</isSupportCallAuthorization>
<isSupportRecordControl>
y ema

<!--ro, opt, bool, whether the device supports audio/video control, desc:related URI: /ISAPI/VideoIntercom/recordControl/capabilities?format=json--
>true
</isSupportRecordControl>
<isSupportTrusteeship>
os fr

<!--ro, opt, bool, whether the device supports configuring trusteeship, desc:related URI: /ISAPI/VideoIntercom/trusteeship/capabilities?format=json--
>true
ad on

</isSupportTrusteeship>
<isSupportAnalogIndoorStation>
<!--ro, opt, bool, whether the device supports the management of the analog indoor station, desc:related URI:
el .c

/ISAPI/VideoIntercom/analogIndoorStation/capabilities?format=json-->true
</isSupportAnalogIndoorStation>
<isSupportImportPartitions>
ez

true
en

</isSupportImportPartitions>
<isSupportBroadcastPlan>
<!--ro, opt, bool, whether the device supports full application of schedule broadcast, desc:related URI:
im

ISAPI/VideoIntercom/broadcast/plan/capabilities?format=json-->true
</isSupportBroadcastPlan>
ng

<isSupportBroadcastPlanSearch>
Aj

true
Co

</isSupportBroadcastPlanSearch>
<isSupportBroadcastPlanPause>
true
</isSupportBroadcastPlanPause>
<isSupportBroadcastPlanResume>
true
</isSupportBroadcastPlanResume>
<isSupportBroadcastPlanTest>
true
</isSupportBroadcastPlanTest>
<isSupportBroadcastPlanEx>
true
</isSupportBroadcastPlanEx>
<isSupportBroadcastPlanExSearch>
true
</isSupportBroadcastPlanExSearch>
<isSupportBroadcastPlanModify>
true
true
</isSupportBroadcastPlanModify>
<isSupportBroadcastPlanDelete>
true
</isSupportBroadcastPlanDelete>
<isSupportAudioInPlayCfg>
true
</isSupportAudioInPlayCfg>
<isSupportSearchWardBedInfo>
true
</isSupportSearchWardBedInfo>
<isSupportPatient>
true

m
</isSupportPatient>

co
<isSupportIntroduction>
true

a.
</isSupportIntroduction>
<isSupportConstantVoltage>

C. arc
true
</isSupportConstantVoltage>
<isSupportRecordMode>
<!--ro, opt, bool, whether it supports configuring recording mode, desc:URI for getting the capability: /ISAPI/VideoIntercom/RecordMode/capabilities?

s, em
format=json-->true

A
</isSupportRecordMode>

no fr
<isSupportCallForwarding>
true

ri on
</isSupportCallForwarding>
<isSupportMediaLibrary>
<!--ro, opt, bool, whether the device supports applying media library information, desc:URI for getting the capability:

Ma oc
/ISAPI/VideoIntercom/broadcast/MediaLibrary/capabilities?format=json-->true
</isSupportMediaLibrary>
up
<isSupportBroadcastControl>
true
co gr

</isSupportBroadcastControl>
<isSupportGetImportPartitions>
true
es a@

</isSupportGetImportPartitions>
<isSupportSearchMediaLibrary>
Fr rc

true
s

</isSupportSearchMediaLibrary>
<isSupportImportPartitionsBatch>
y ema

true
</isSupportImportPartitionsBatch>
<isSupportMediaLibraryBatch>
os fr

true
</isSupportMediaLibraryBatch>
ad on

<isSupportPlanScheme>
true
el .c

</isSupportPlanScheme>
<isSupportRealTimeInsertion>
true
ez

</isSupportRealTimeInsertion>
</VideoIntercomCap>
<SecurityCPCapabilities>
en

true

</SecurityCPCapabilities>
<isSupportSafetyCabin>
im

true

</isSupportSafetyCabin>
Aj

<isSupportAcsUpdate>
true
Co

</isSupportAcsUpdate>
<isSupportSecurityCP>
true
</isSupportSecurityCP>
<isSupportPEA>
true
</isSupportPEA>
<isSupportCurrentLock>
true
</isSupportCurrentLock>
<isSupportGuardAgainstTheft>
true
</isSupportPicInfoOverlap>
<isSupportPlay>
true
</isSupportPlay>
<isSupportPlayback>
true
</isSupportPlayback>
<UHFRFIDReader>
<UHFRFIDReader>

<isSupportBasicInformation>
true
</isSupportBasicInformation>
<isSupportHardDiskStorageTest>
true
</isSupportHardDiskStorageTest>
<isSupportCarReaderConfig>
true
</isSupportCarReaderConfig>
</UHFRFIDReader>
<isSupportMasterSlaveConfig>
true
</isSupportMasterSlaveConfig>

m
<isSupportIntelligentStructureAnalysis>
<!--ro, opt, bool, whether the device supports intelligent structuralization analysis, desc:related URI:

co
/ISAPI/Intelligent/structureAnalysis/capabilities-->true
</isSupportIntelligentStructureAnalysis>

a.
<isSupportIntelligentAnalysisEngines>
<!--ro, opt, bool, whether the device supports configuring the intelligent engine, desc:related URI: /ISAPI/Intelligent/analysisEngines/capabilities--
>true

C. arc
</isSupportIntelligentAnalysisEngines>
<PreviewDisplayNum>
1
</PreviewDisplayNum>

s, em
<isSupportBoard opt="true,false">
true

A
</isSupportBoard>

no fr
<ResourceSwitch>

ri on
<workMode opt="4KPreview,educationRecord">
test
</workMode>

Ma oc
</ResourceSwitch>
<isSupportCustomStream>
true
up
</isSupportCustomStream>
<isSupportTriggerCapCheck>
co gr

true
</isSupportTriggerCapCheck>
<isSupportChannelEventCap>
es a@

true
</isSupportChannelEventCap>
<SensorCap>
Fr rc

<SensorNums>
y ema

1
</SensorNums>
<isSupportSensorPortConfiguration>
true
</isSupportSensorPortConfiguration>
os fr

<isSupportSensorPortControl>
true
ad on

</isSupportSensorPortControl>
<isSupportAcquireSensorStatus>
true
el .c

</isSupportAcquireSensorStatus>
<isSupportSearchSensorData>
true
ez

</isSupportSearchSensorData>
</SensorCap>
en

<isSupportEncryption>
true
</isSupportEncryption>
im

<isSupportTrial>
true
ng

</isSupportTrial>
Aj

<isSupportSignInstrument>
Co

true

</isSupportSignInstrument>
<isSupportLocate>
true
</isSupportLocate>
<isSupportVibration>
true
</isSupportVibration>
<isSupportMixedTargetDetection>
true
</isSupportMixedTargetDetection>
<SDCardCtrlCap>

<isSupportIOCtrl>
true
</isSupportIOCtrl>
<isSupportReadCardStatus>
true
</isSupportReadCardStatus>
<isSupportStartUpdate>
true
</isSupportStartUpdate>
<isSupportEndUpdate>
true
true
</isSupportEndUpdate>
<isSupportPowerCtrl>
true
</isSupportPowerCtrl>
</SDCardCtrlCap>
<isSupportMutiChannelCalibration>
true
</isSupportMutiChannelCalibration>
<isSupportElevatorFloorCalibration>
true
</isSupportElevatorFloorCalibration>
<isSupportPictureCaptureComparision>
true
</isSupportPictureCaptureComparision>
<isSupportGPSCalibratation>
true

m
</isSupportGPSCalibratation>

co
<isSupportCityManagement>
true
</isSupportCityManagement>

a.
<isSupportBVCorrect>
true

C. arc
</isSupportBVCorrect>
<isSupportSteamingCodingModeSwitch>
true
</isSupportSteamingCodingModeSwitch>

s, em
<supportImageChannel opt="1,2,3,4">
<!--ro, opt, string, whether the device supports configuring the image channel, attr:opt{req, string},

A
desc:the configuration of actual image channel supported by the device (URI for picture parameters: /ISAPI/Image/channels/<channelID>), if this node is not

no fr
returned, the image channel is the same with the encoding channel (/ISAPI/Streaming/channels) by default
this node is mainly for the situation when the image channel is inconsistent with the actual stream channel. For example, some device, which altogether
has four sensors and they are all spliced into one encoding channel for output. Every sensor supports configuring image parameters; by default, the image

ri on
channel 1 is only valid for the images of sensor1-->test
</supportImageChannel>

Ma oc
<isSupportPanoramaCalibration>
true
</isSupportPanoramaCalibration>
up
<isSupportPanoramaMode>
true
</isSupportPanoramaMode>
co gr

<supportSnapshotChannel opt="1">
test
</supportSnapshotChannel>
es a@

<isSupportPanoramaCorrections>
true
Fr rc

</isSupportPanoramaCorrections>
s

<isSupportActiveMulticast>
true
y ema

</isSupportActiveMulticast>
<isSupportChannelEventListCap>
true
</isSupportChannelEventListCap>
os fr

<VCAResourceChannelsCap>

<ChannelsList>
ad on

<channelsID>
el .c

1

</channelsID>
</ChannelsList>
ez

</VCAResourceChannelsCap>
<isSupportTimerVCAResource>
true
en

</isSupportTimerVCAResource>
<MixedTargetDetection>
im

<isSupportFaceRecognition>
ng

true

</isSupportFaceRecognition>
<isSupportHumanRecognition>
Co

true
</isSupportHumanRecognition>
<isSupportVehicleRecognition>
true
</isSupportVehicleRecognition>
</MixedTargetDetection>
<isSupportDiscoveryMode>
true
</isSupportDiscoveryMode>
<isSupportDumpData>
true
</isSupportDumpData>
<isSupportCameraAccessConfiguration>
true
</isSupportCameraAccessConfiguration>
<isSupportIntelligentSearch>
true
</isSupportAutoMaintenance>
<isSupportRtspOverHTTPS>
true
</isSupportRtspOverHTTPS>
<isSupportIntersectionAnalysis>
true
</isSupportIntersectionAnalysis>
<isSupportAudioInteract>
true
</isSupportAudioInteract>
<isSupportChannelFullEventListCap>
true
</isSupportChannelFullEventListCap>
<isSupportAUXInfoCap>
true
</isSupportAUXInfoCap>

m
<supportPanoramaChannel opt="2">

co
test
</supportPanoramaChannel>
<regionClip>

a.

<channels opt="101">
test

C. arc
</channels>
</regionClip>
<AIDEventSupport
opt="abandonedObject,pedestrian,congestion,roadBlock,construction,trafficAccident,fogDetection,wrongDirection,illegalParking,SSharpDriving,lowSpeed,dragRaci

s, em
ng,obstacle,vehNoYieldPedest,illegalMannedVeh,illegalMannedNonMotorVeh,umbrellaTentInstall,nonMotorVehOnVehLane,wearingNoHelmet,pedestRedLightRunning,pedest
OnNonMotorVehLane,pedestOnVehLane,conflagration,smoke,VehicleSpeedDrop,lowVisibility,animalsOccupy,targetSpeedDetection,emergencyLane,gasser,changeLaneConti

A
nuously">

no fr
test
</AIDEventSupport>

ri on
<TFSEventSupport opt="illegalParking
,wrongDirection,crossLane,laneChange,vehicleExist,turnRound,parallelParking,notKeepDistance,notSlowZebraCrossing,overtakeRightSide,lowSpeed,dragRacing,chang
eLaneContinuously,SSharpDriving,largeVehicleOccupyLine,jamCrossLine,obstacle,blackSmokeVehicle,turnRightStop,occupyDedicatedLane,notDriveInDedicatedLane,TFS

Ma oc
_nonZipperMerge,overSpeed,emergencyLane,gasser">
test
</TFSEventSupport>
up
<isVehicleStatisticsSupport>
true
co gr

</isVehicleStatisticsSupport>
<isSupportElevatorFloorName>
true
es a@

</isSupportElevatorFloorName>
<isSupportVehicleFaceRecognition>
<!--ro, opt, bool, whether the device supports checkpoint vehicle recognition, desc:background: the traffic devices support "facial recognition"
Fr rc

(driver), however, the corresponding node is not added to the device to notify the integration of this capability-->true
</isSupportVehicleFaceRecognition>
y ema

<VQDEventSupport opt="luma,chroma,snow,streak,freeze,sigLose,clarity,jitter,block,flowers,noise,ghost,purple,ICR,protectiveFilm,blur,contrast">
<!--ro, opt, string, VQD event list, attr:opt{opt, string}, desc:"Luma" (brightness exception); "Chroma" (image color cast); "Snow" (snow noise);
"Streak" (strip noise); "Freeze" (frozen screen); "SigLose" (signal loss); "Clarity" (resolution exception); "JItter" (image flutter); "Block"
(video tampering); "Flowers" (blurred screen); "Noise" (image noise); "Ghost" (ghost image); "Purple" (purple fringing); "ICR" (ICP); "protectiveFilm"
os fr

(protective film unremoved)-->test

</VQDEventSupport>
<IOTCap>
ad on

<supportChannelNum opt="1024">
1
el .c

</supportChannelNum>
<startChannelNo>
ez

1

</startChannelNo>
<isSupportlinkageChannelsSearch>
en

true

</isSupportlinkageChannelsSearch>
<isSupportIOTChannelCap>
im

true
</isSupportIOTChannelCap>
ng

<satusSearchTaskCap>
Aj

<maxResults>
1
</maxResults>
<filterType opt="all,online,offline,updateFailed,notPartitioned">
all
</filterType>
<deviceStatus opt="calling,noCall,medicationChangePrompt,alarming,offline,free,callWaiting">
and
</logicRelationship>
<alarmType opt="SOS,toilet">
test
</alarmType>
<callWaitingType opt="normal,cisit">
test
</callWaitingType>
</satusSearchTaskCap>
</satusSearchTaskCap>
<channelConfigList>

<channelConfig>

<unitType>
outdoor
</unitType>
<floorNumber min="0" max="65535">
0
</floorNumber>
<roomNumber min="0" max="65535">
0

m
</roomNumber>
<isSupportSlaveDevice>

co
true
</isSupportSlaveDevice>
<isSupportZeroFloorNumber>

a.
true
</isSupportZeroFloorNumber>

C. arc
<periodNumber min="1" max="65535">
0
</periodNumber>
<buildingNumber min="1" max="65535">

s, em
0
</buildingNumber>

A
<unitNumber min="0" max="65535">

no fr
0
</unitNumber>
<deviceIndex min="1" max="15">

ri on
test
</deviceIndex>

Ma oc
<industryType opt="builidings,prison,medicalTreatment,broadcasting,general">
test
up
</industryType>
<alarmEnabled opt="true,false">
<!--ro, opt, bool, whether to enable the arming function of IoT devices, attr:opt{req, string}, desc:this field is used to check if arming is
co gr

supported when adding devices. (Related field: alarmEnabled; related URI: /ISAPI/System/IOT/channels?format=json)-->true
</alarmEnabled>
es a@

<priority min="1" max="100">

0
</priority>
Fr rc

<transportType opt="unicast,multicast">
s

test

</transportType>
y ema

<audioVolume min="0" max="15">

0
</audioVolume>
<callForwardingEnabled>
os fr

true
</callForwardingEnabled>
<callForwardingType opt="unconditional,busy,noReply,noReachable,calling">
ad on

<!--ro, opt, string, call transfer type, range:[0,32], attr:opt{req, string}, desc:"unconditional" (call transfer under any condition), "busy"
(call transfer when busy), "noReply" (call transfer when there is no reply), "noReachable" (call transfer when it is unreachable), "calling" (call transfer
el .c

when calling)-->test
</callForwardingType>
<isSupportCallTerminalNumbe>
ez

true
</isSupportCallTerminalNumbe>
<customCommunicationName min="0" max="128">
en

test
im

</customCommunicationName>
<isSupportMoreFeatures>
ng

true
Aj

</isSupportMoreFeatures>
<isNotSupportRegPassword>
Co

true
</isNotSupportRegPassword>
<mappingRoomNumber min="0" max="5">
0
</mappingRoomNumber>
<deviceID min="0" max="64">
test
</deviceID>
<ISUPkey min="1" max="32">
test
</ISUPkey>
<dialUpAddress min="1" max="1024">
test
</dialUpAddress>
</channelConfig>
</channelConfigList>
<isSupportConfigTemplate>
true
</isSupportConfigTemplate>
<isSupportConfigReport>
true
</isSupportConfigReport>
<unitType
opt="indoor,villa,confirm,outdoor,fence,doorbell,manage,acs,interactive,wardStation,bedheadExtension,bedsideExtension,analogIndoor,decoder,networkFireAlarmM
atrix,amplifier,pagingMicrophone,PDA,netSwitch,entrywayStation">
test
</unitType>
<serialNumber min="1" max="32">
test
</serialNumber>
<isSupportAsyncStatus>
true
</isSupportAsyncStatus>
<isSupportAddIOTChannelList>
<!--ro, opt, bool, whether the device supports batch adding channels of IoT devices, desc:URI for batch adding channels of IoT devices: POST

m
/ISAPI/System/IOT/channels/AddIOTChannelList?format=json-->true

co
</isSupportAddIOTChannelList>
<isSupportSearchMoreIOTSource>
<!--ro, opt, bool, whether the device supports searching for the IoT devices which can be added (by multiple conditions), desc:related URI: POST

a.
/ISAPI/System/IOT/channels/AddIOTChannelList?format=json-->true
</isSupportSearchMoreIOTSource>
<channelConfigReportMode>

C. arc
cover
</channelConfigReportMode>

s, em
</IOTCap>

A
<isSupportLCDScreen>

no fr
true
</isSupportLCDScreen>
<isSupportBluetooth>

ri on
true
</isSupportBluetooth>
<isSupportNetScreen>

Ma oc
true
</isSupportNetScreen>
up
<isSupportLocation>
true
</isSupportLocation>
co gr

<isSupportDebugInfoExport>
true
es a@

</isSupportDebugInfoExport>
<isSupportIoTGateway>
true
Fr rc

</isSupportIoTGateway>
<isSupportImageCap>
y ema

true
</isSupportImageCap>
<isSupportLogToUSB opt="true,false">
<!--ro, opt, bool, whether the device supports exporting logs to USB, attr:opt{opt, string}, desc:related URI:
os fr

/ISAPI/System/exportLogToUSB/capabilities?format=json-->true
</isSupportLogToUSB>
<isSupportWiresharkToUSB opt="true,false">
ad on

true
</isSupportWiresharkToUSB>
el .c

<CDBurningStreamEncryptionChannels opt="1,2">
<!--ro, opt, string, return the capability of device recording stream encryption channel, attr:opt{opt, string}, desc:related URI:
ez

/ISAPI/Streaming/channels/<ID>/capabilities-->true
</CDBurningStreamEncryptionChannels>
<isSupportOCR>
en

true
</isSupportOCR>
<isSupportInstallationAngleCalibration>
im

<!--ro, opt, bool, whether the device supports the capability of installation angle calibration, desc:related URI:
ng

/ISAPI/System/installationAngleCalibration/channels/<ID>/capabilities-->true
Aj

</isSupportInstallationAngleCalibration>
<isSupportZeroBiasCalibration>
Co

true
</isSupportZeroBiasCalibration>
<isSupportCalibrationFile>
true
</isSupportCalibrationFile>
<isSupportDisplayTrajectory>
true
</isSupportDisplayTrajectory>
<maximumSuperPositionTime opt="5,10,20,30">
true
</isSupportUnitConfig>
<isSupportShipsDetectionWithScene>
true
</isSupportShipsDetectionWithScene>
<isSupportPictureServer>
true
</isSupportPictureServer>
<isSupportEmmcInfo>
<isSupportEmmcInfo>
true
</isSupportEmmcInfo>
<isSupportVehicleIllegalType opt="1,2...29">
test
</isSupportVehicleIllegalType>
<isSupportRFIDChannels>
true
</isSupportRFIDChannels>
<isSupportRfidCollection>
true

m
</isSupportRfidCollection>
<DevInfoSearch opt="tiltAngle">

co
test

a.
</DevInfoSearch>
<isSupportAIOpenPlatform>
<!--ro, opt, bool, whether the device supports AI open platform device capability, desc:related URI: /ISAPI/Intelligent/AIOpenPlatform/capabilities?

C. arc
format=json-->true
</isSupportAIOpenPlatform>
<isSupportPictureDownloadError>
true

s, em
</isSupportPictureDownloadError>
<isSupportStudentBehavior>

A
true

no fr
</isSupportStudentBehavior>
<guideEventSupport opt="linkageCapture">

ri on
test
</guideEventSupport>

Ma oc
<supportRemoteCtrl opt="up,down,left,right,enter,menu,num,power,esc,edit,F1,.prev,rec,play,stop,notSupport">
test
</supportRemoteCtrl>
up
<isSupportSSDFileSystemUpgrade>
true
</isSupportSSDFileSystemUpgrade>
co gr

<isSupportSSDFileSystemFormat>
true
es a@

</isSupportSSDFileSystemFormat>
<FaceCounting>

Fr rc

<ChannelsList>

<channelsID>
y ema

1

</channelsID>
</ChannelsList>
</FaceCounting>
os fr

<isSupportCluster>
true
ad on

</isSupportCluster>
<DeviceConfigurationSupport opt="time,network,accessProtocol,recordSchedule,channel,customProtocol">
<!--ro, opt, string, content supported by device parameters configuration, attr:opt{opt, string}, desc:related URI: /ISAPI/System/deviceConfiguration--
el .c

>test
</DeviceConfigurationSupport>
<behaviorEventSupport opt="getUp,toiletTarry,playCellphone">
ez

test

</behaviorEventSupport>
en

<isSupportBVCorrectPassthrough>
true
im

</isSupportBVCorrectPassthrough>
<VehiclePositionControl>
ng

Aj

<license min="0" max="16">

test
Co

</license>
<intervalTime min="0" max="65535" def="1">
1
</intervalTime>
</VehiclePositionControl>
<supportGISEvent opt="AID,TPS,ANPR,mixedTargetDetection">
test
</supportGISEvent>
<isSupportGPSPTZCalibratation>
true
</isSupportGPSPTZCalibratation>
<isSupportRadar>
true
</isSupportRadar>
<isSupportISUPHttpPassthrough>
true
</isSupportISUPHttpPassthrough>
<isSupportMaterialListQuery>
true
</isSupportMaterialListQuery>
<isSupportDebugLogAsync>
true
true
</isSupportDebugLogAsync>
<isSupportAlgorithmsInfo>
true
</isSupportAlgorithmsInfo>
<isSupportSecurityChecking>
true
</isSupportSecurityChecking>
<isSupportSecurityCheckException>
true
</isSupportSecurityCheckException>
<isSupportPictureManage>
true
</isSupportPictureManage>
<isSupportAutoSwitch>
<!--ro, opt, bool, whether the device supports automatically powering on and powering off, desc:related URI: /ISAPI/System/autoSwitch/capabilities?

m
format=json-->true

co
</isSupportAutoSwitch>
<SHMCap>

a.
<isSupportHighHDTemperature>
true

C. arc
</isSupportHighHDTemperature>
<isSupportLowHDTemperature>
true
</isSupportLowHDTemperature>
<isSupportHDImpact>

s, em
true

A
</isSupportHDImpact>

no fr
<isSupportHDBadBlock>
true
</isSupportHDBadBlock>

ri on
<isSupportSevereHDFailure>
true
</isSupportSevereHDFailure>

Ma oc
</SHMCap>
<isSupportLinkStatusEvent>
up
true
</isSupportLinkStatusEvent>
<isSupportVideoDealStatus>
co gr

true
</isSupportVideoDealStatus>
<isSupportAudioDealStatus>
es a@

true
</isSupportAudioDealStatus>
Fr rc

<isSupportNetPackLossStatus>
s

true
</isSupportNetPackLossStatus>
y ema

<isSupportVideoConferenceStatus>
true
</isSupportVideoConferenceStatus>
<isSupportDataPrealarm>
os fr

true
</isSupportDataPrealarm>
<isSupportClearCache>
ad on

true
</isSupportClearCache>
el .c

<isSupportIntelligentMode>
true
</isSupportIntelligentMode>
ez

<isSupportFaceTemperatureMeasurementEvent>
true
</isSupportFaceTemperatureMeasurementEvent>
en

<isSupportQRCodeEvent>
true
</isSupportQRCodeEvent>
im

<isSupportVisitorEvent>
ng

true
Aj

</isSupportVisitorEvent>
<isSupportEmployeeAuthEvent>
Co

true
</isSupportEmployeeAuthEvent>
<isSupportVisitorInfoSearchEvent>
true
</isSupportVisitorInfoSearchEvent>
<isSupportConsumptionEvent>
true
</isSupportConsumptionEvent>
<isSupportTransactionRecordEvent>
true
</isSupportTransactionRecordEvent>
<isSupportFaceContrastResultDisplay>
true
</isSupportFaceContrastResultDisplay>
<isSupportPatchUpgrade>
true
</isSupportPatchUpgrade>
<isSupportSnapshotAsync>
true
</isSupportSnapshotAsync>
<isSupportLogExportByUSB>
true
true
</isSupportLogExportByUSB>
<isSupportShellCmd>
true
</isSupportShellCmd>
<faceMonitor opt="dailyFaceMonitor,dailyFaceTracking,VCAFaceMonitor,VCAFaceTracking,manualFaceMonitor,advanceConfiguration,">
true
</faceMonitor>
<isSupportRelatedVCAResource>
true
</isSupportRelatedVCAResource>
<isSupportVehicleMonitor>
true

m
</isSupportVehicleMonitor>
<isSupportManualVehicleMonitor>

co
true

a.
</isSupportManualVehicleMonitor>
<isSupportDailyVehicleMonitor>
<!--ro, opt, bool, whether the device supports daily arming and tracking of vehicles, desc:related URI:

C. arc
/ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities-->true
</isSupportDailyVehicleMonitor>
<isSupportInputProxyDeviceInfo>
<!--ro, opt, bool, whether the device supports getting the information of the devices added to the proxy device channel, desc:related URI:

s, em
/ISAPI/ContentMgmt/InputProxy/channels/<ID>/capabilities-->true
</isSupportInputProxyDeviceInfo>

A
<isSupportAccessControlCap>

no fr
true
</isSupportAccessControlCap>

ri on
<isSupportDebugLog>
true
</isSupportDebugLog>

Ma oc
<isSupportFaceAppear>
true
</isSupportFaceAppear>
up
<isSupportFaceDisappear>
true
co gr

</isSupportFaceDisappear>
<isSupportTeacherBehavior>
true
es a@

</isSupportTeacherBehavior>
<isSupportHeadRiseRate>
true
Fr rc

</isSupportHeadRiseRate>
<isSupportIPCUpgrade>
<!--ro, opt, bool, whether the device supports upgrading IPC via NVR and other devices, desc:related URI: /ISAPI/System/IPCUpgrade/<ID>?format=json--
y ema

>true
</isSupportIPCUpgrade>
<isSupportFaceLibRebuildEvent>
<!--ro, opt, bool, whether the device supports uploading the modeling rebuilding of the face picture library event, desc:eventType: faceLibRebuild--
os fr

>true
</isSupportFaceLibRebuildEvent>
ad on

<isSupportCalibrationStream>
true
</isSupportCalibrationStream>
el .c

<isSupportChannelOccupy>
true
</isSupportChannelOccupy>
ez

<isSupportOffDuty>
true
en

</isSupportOffDuty>
<isSupportNoCertificate>
true
im

</isSupportNoCertificate>
<isSupportSmokeAlarm>
ng

true
Aj

</isSupportSmokeAlarm>
Co

m
true

co
</isSupportFireControlData>
<isSupportFireNoRegulation>
true

a.
</isSupportFireNoRegulation>
<isSupportSmokeFireRecognize>

C. arc
true
</isSupportSmokeFireRecognize>
<isSupportClientProxyWEB>
<!--ro, opt, bool, whether to support WEB page jumping,

s, em
desc:the function of going to the web page
package the web program and plug-in into the client (for example, iVMS-4200) for going to the web page it is mainly used in such a scenario: the device

A
removes the web-related resources as the limit of resources, so it does not support operations on the web browser-->true

no fr
</isSupportClientProxyWEB>
<WEBLocation>
<!--ro, opt, string, WEB page placement location, range:[1,32], desc:local-local server, remote-remote server; (if this node is not returned, the WEB

ri on
page will be placed in the local server by default)-->local
</WEBLocation>

Ma oc
<isSupportWEBLocalPlug>
true
up
</isSupportWEBLocalPlug>
<deviceId>
<!--ro, opt, string, device ID, range:[1,32], desc:if WEBLocation is "remote", the unique device ID should be returned to identify the unique
co gr

corresponding web package. This device ID is managed by the Web configuration package. For a specified device of different versions, the same deviceID will
be returned-->test
</deviceId>
es a@

<isSupportTimeZone>
true
Fr rc

</isSupportTimeZone>
s

<isSptHealthDetection>
true
y ema

</isSptHealthDetection>
<isSptDiagnosis>
true
</isSptDiagnosis>
os fr

<isSptSerialLogCfg>
true
ad on

</isSptSerialLogCfg>
<isSptFileExport>
el .c

true
</isSptFileExport>
<isSptCertificationStandard>
ez

true
</isSptCertificationStandard>
<isSptKeypadLock>
en

true
</isSptKeypadLock>
im

<isSupportVibrationDetection>
<!--ro, opt, bool, whether the device supports the vibration detection, desc:related URI: /ISAPI/System/channels/<ID>/vibrationDetection?format=json--
ng

>true
Aj

</isSupportVibrationDetection>
<isSupportSmokingDetectAlarm>
Co

true
</isSupportSmokingDetectAlarm>
<isSupportRadarChannels>
true
</isSupportRadarChannels>
<radarIPDForm>
single
</radarIPDForm>
<isSupportRadarFieldDetection>
true
</isSupportRadarFieldDetection>
<isSupportRadarLineDetection>
true
</isSupportRadarLineDetection>
<mixedTargetDetectionWebNoDisplay>
true
</mixedTargetDetectionWebNoDisplay>
<isSupportRemovePlaybackRecord>
true
</isSupportRemovePlaybackRecord>
<isSupportAudioUpload>
true
</isSupportAudioUpload>
<VCAResourceList>

<VCAResource>

<VCAResourceType>
test
</VCAResourceType>
<ChannleVCAResourceList>

<ChannleVCAResource>

m
<channel>

co
1
</channel>
<channleVCAResourceType>

a.
test
</channleVCAResourceType>
</ChannleVCAResource>

C. arc
</ChannleVCAResourceList>
</VCAResource>
</VCAResourceList>
<isSupportSlotInsertion>

s, em
true
</isSupportSlotInsertion>

A
<isSupportNetworkLoop>

no fr
true
</isSupportNetworkLoop>

ri on
<isSupportApOnOffLine>
true
</isSupportApOnOffLine>

Ma oc
<isSupportAbnormalWANPort>
true
</isSupportAbnormalWANPort>
up
<isSupportAPException>
true
co gr

</isSupportAPException>
<isSupportACException>
true
es a@

</isSupportACException>
<isSupportCartridgeCapacity>
<!--ro, opt, bool, whether the device supports the configuration of notifying cartridge capacity, desc:related URL:
Fr rc

/ISAPI/System/printer/cartridgeCapacity/capabilities?format=json-->true
</isSupportCartridgeCapacity>
y ema

<isSupportCDCakeBoxCapacity>
true
</isSupportCDCakeBoxCapacity>
os fr

<isSupportSleep>
true
</isSupportSleep>
ad on

<isSupportContainerDetection>
<!--ro, opt, bool, whether the device supports container detection, desc:/ISAPI/Intelligent/containerDetection/capabilities?format=json (for devices
that does not return this node, you can check according to the node returned by the following protocol:
el .c

/ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>/ocrScene/capabilities)-->true
</isSupportContainerDetection>
ez

<isSupportRadarVideoDetection>
true
en

</isSupportRadarVideoDetection>
<isSupportRadarVideoDetectionRealtime>
<!--ro, opt, bool, whether the device supports radar video detection, desc:related URI:
im

/ISAPI/Intelligent/channels/<ID>/radarVideoDetection/capabilities?format=json-->true
</isSupportRadarVideoDetectionRealtime>
ng

<isSupportBatteryStatusUpload>
Aj

true
Co

</isSupportBatteryStatusUpload>
<isSupportPowerConsumptionStatusUpload>
true
</isSupportPowerConsumptionStatusUpload>
<isSupportOnlineUpgradeTask>
true
</isSupportOnlineUpgradeTask>
<isSupportPersonArmingTrack>
true
</isSupportPersonArmingTrack>
<isSupportManualPersonArmingTrack>
true
</isSupportManualPersonArmingTrack>
<isSupportGPSVerification>
true
</isSupportGPSVerification>
<isSupportHBDLib>
true
</isSupportHBDLib>
<isSupportDisinfectionInfo>
true
true
</isSupportDisinfectionInfo>
<isSupportTempQueryDelete>
true
</isSupportTempQueryDelete>
<isSupportMobilePayment>
true
</isSupportMobilePayment>
<isSupportFileSearch>
true
</isSupportFileSearch>
<isSupportFileExportAsync>
true
</isSupportFileExportAsync>
<isSupportSSDFileSystemCapacity>
<!--ro, opt, bool, whether the device supports getting the capacity distribution of the SSD system, desc:related URI:

m
/ISAPI/System/SSDFileSystem/capacity?format=json-->true
</isSupportSSDFileSystemCapacity>

co
<isSupport4GSafetyHelmetInfo>
true
</isSupport4GSafetyHelmetInfo>

a.
<isSupportICCID>
true

C. arc
</isSupportICCID>
<isSupportFireEscapeDetection>
true

s, em
</isSupportFireEscapeDetection>
<isSupportTakingElevatorDetection>

A
<!--ro, opt, bool, whether the device supports taking elevator detection, desc:related URI:

no fr
/ISAPI/Intelligent/channels/<ID>/takingElevatorDetection/capabilities?format=json-->true
</isSupportTakingElevatorDetection>
<isSupportVehicleMatchResult>

ri on
true

Ma oc
</isSupportVehicleMatchResult>
<isSupportDataAware>
true
up
</isSupportDataAware>
<isSupportAbnormalReboot>
true
co gr

</isSupportAbnormalReboot>
<isSupportVehicleThermometry>
es a@

true
</isSupportVehicleThermometry>
Fr rc

<AssociationScenesList>
s

<!--ro, opt, array, the list of scene adaptive linkage, subType:object, desc:it indicates the device supports the scene adaptive linkage between
channels. The current device has two channels: main channel (box camera) and sub channel (radar camera), however, the device only opens a main channel to
y ema

users for scene configuration; the scene configuration of the sub channel is not open for the users; the scene of the sub channel is automatically connected
to the main channel scene; currently, the front-end returns this capability-->
<AssociationScenes>

os fr

<channelID>
1
</channelID>
ad on

<isSupportScene>
<!--ro, opt, bool, whether the device supports the scene configuration, desc:whether the current channel is the main channel and supports scene
el .c

configuration , true (main channel and support), this node is not returned (sub channel and not support)-->true
</isSupportScene>
</AssociationScenes>
ez

</AssociationScenesList>
<supportRelationVideoEvent opt="PIR,cityManagement,roadMaint">
<!--ro, opt, string, supports uploading the video of linking triggering event, attr:opt{req, string}, desc:PIR#PIR event, cityManagement#city management
en

event, roadMaint#road maintenance event-->test

</supportRelationVideoEvent>
im

<isSupportVCAResourceList>
<!--ro, opt, bool, whether the device supports configuring intelligent resources in a batch, desc:related URI:
ng

/ISAPI/System/Video/inputs/channels/VCAResourceList?format=json-->true
Aj

</isSupportVCAResourceList>
<isSupportConvergenceCloud>
Co

true
</isSupportConvergenceCloud>
<isSupportInterconnection>
true
</isSupportInterconnection>
<isSupportHPVehicleStatus>
true
</isSupportHPVehicleStatus>
<isSupportHPWorkingStatus>
true
</isSupportHPWorkingStatus>
<isSupportHPPeopleDetection>
true
</isSupportHPPeopleDetection>
<isSupportHPVehicleDoorDetection>
true
</isSupportHPVehicleDoorDetection>
<isSupportRoadMaint>
true
</isSupportRoadMaint>
<isSupportDockStationInfo>
true
</isSupportDockStationInfo>
<isSupportBodyCameraManualForensics>
true
</isSupportBodyCameraManualForensics>
<isSupportBodyCameraLogin>
true
</isSupportBodyCameraLogin>
<isSupportBodyCameraRunStatus>
true
</isSupportBodyCameraRunStatus>

m
<isSupportBodyCameraSignIn>

co
true
</isSupportBodyCameraSignIn>

a.
<isSupportAlertDistribution>
<!--ro, opt, bool, whether the device supports the alert distribution, desc:eventType: alertDistribution; this node is not returned if not supported--
>true

C. arc
</isSupportAlertDistribution>
<isSupportImageCapture>
true

s, em
</isSupportImageCapture>

A
<isSupportScheduledRecordUpload>

no fr
true
</isSupportScheduledRecordUpload>

ri on
<isSupportTargetPatternCollect>
true
</isSupportTargetPatternCollect>

Ma oc
<isSupportAudioAnalysis>
<!--ro, opt, bool, whether the device supports the audio analysis event, desc:eventType: audioAnalysis; this node is not returned if not supported--
up
>true
</isSupportAudioAnalysis>
<isSupportDebuggingDataExport>
co gr

true
</isSupportDebuggingDataExport>
es a@

<isSupportInternalParaAdjust>
true
Fr rc

</isSupportInternalParaAdjust>
<isSupportManualImageCapture>
y ema

true
</isSupportManualImageCapture>
<characteristicCode min="1" max="128">
os fr

test
</characteristicCode>
ad on

<isSupportSIMCardStatus>
<!--ro, opt, bool, whether the device supports getting the information of SIM card status, desc:related URI: /ISAPI/System/SIMCardStatus?format=json--
>true
el .c

</isSupportSIMCardStatus>
<OpenPlatformCap>
ez

<isSupportOpenPlatform>
true
en

</isSupportOpenPlatform>
<maxAPPNum>
0
im

</maxAPPNum>
ng

</OpenPlatformCap>
Aj

<isSupportLogException>
true
Co

</isSupportLogException>
<isSupportMEF>
true
</isSupportMEF>
<manualEvent opt="fielddetection,linedetection,ANPR,faceCapture,mixedTargetDetection,studentsStoodUp,headRiseRate,teacherBehavior">
test
</manualEvent>
<isSupportAppCfg>
true
</isSupportAppCfg>
<isSupportCleanUp>
true
</isSupportCleanUp>
<isSupportEndUserCheckMsg opt="sleep,reboot,factoryReset,cleanup,parentPickUpQuery,schoolAttendanceQuery,screenShare,screenMirror">
true
</isSupportEndUserCheckMsg>
<isSupportScreenConfig>
true
</isSupportTemperatureMonitor>
<isSupportObjectServer>
true
</isSupportObjectServer>
<isSupportCDsStatus>
true
</isSupportCDsStatus>
<isSupportCoalGangueDetection>
true
</isSupportCoalGangueDetection>
<isSupportVacantSeatRate>

m
true

co
</isSupportVacantSeatRate>
<isSupportObjectsThrownDetection>

a.
true

C. arc
</isSupportObjectsThrownDetection>
<isSupportBVCorrectDataSearch>
true

s, em
</isSupportBVCorrectDataSearch>
<isSupportSlagTruckWashingDetection>

A
true

no fr
</isSupportSlagTruckWashingDetection>
<isSupportWOL>

ri on
true
</isSupportWOL>

Ma oc
<isSupportPersonQueueTimingStatistics>
true
</isSupportPersonQueueTimingStatistics>
up
<isSupportLensParamFile>
true
</isSupportLensParamFile>
co gr

<isSupportVehiclePassingInParkingLot>
<!--ro, opt, bool, whether the device supports the detection of vehicle passing in parking lot entrance and exit, desc:eventType:
es a@

vehiclePassingInParkingLot-->true
</isSupportVehiclePassingInParkingLot>
<isSupportPowerOutput>
Fr rc

true
</isSupportPowerOutput>
<isSupportIPCUpgradeByFTP>
y ema

true
</isSupportIPCUpgradeByFTP>
<isSupportMethaneConcentrationException>
os fr

true
</isSupportMethaneConcentrationException>
ad on

<isSupportMethaneLightIntensityException>
true
</isSupportMethaneLightIntensityException>
el .c

<isSupportLocalButtonPermission>
true
ez

</isSupportLocalButtonPermission>
<isSupportLocalButtonRecord>
en

true
</isSupportLocalButtonRecord>
<isSupportLocalButtonSnapshot>
im

true
</isSupportLocalButtonSnapshot>
ng

<isSupportVoiceTalkEvent>
Aj

true
</isSupportVoiceTalkEvent>
Co

<isSupportPowerSupply>
true
</isSupportPowerSupply>
<isSupportbarrierGateStatus>
true
</isSupportbarrierGateStatus>
<DeployCap>

<deployID opt="1,2">
0
</deployID>
</DeployCap>
<isSupportSignalControllerStatus>
true
</isSupportSignalControllerStatus>
<isSupportSignalControllerFault>
true
</isSupportSignalControllerFault>
<isSupportNTPConfig>
true
</isSupportNTPConfig>
<isSupportConsumptionQuery>
true
true
</isSupportConsumptionQuery>
<StreamingCodingRegionPositionCap>

<ChannelsList>

<channelsID>
1
</channelsID>
</ChannelsList>
</StreamingCodingRegionPositionCap>
<isSupportLowPowerPlan>
true
</isSupportLowPowerPlan>
<isSupportPlateQuaAlarm>

m
true

co
</isSupportPlateQuaAlarm>
<isSupportWiegand>
true

a.
</isSupportWiegand>
<zoomFocusWebDisplay

C. arc
opt="ROI,roadTrafficDetection,SMD,mixedTargetDetection,faceCapture,personCounting,multidimensionalPeopleCounting,AIOP,heelPDC,packingSpaceRecognition,tunnel
Detection,cityManagement">
ROI

s, em
</zoomFocusWebDisplay>

A
<isSupportInternalParamsAdjustment>

no fr
true
</isSupportInternalParamsAdjustment>

ri on
<isSupportDiagnosticReport>
true

Ma oc
</isSupportDiagnosticReport>
<isSupportWaterQualitySearch>
up
true
</isSupportWaterQualitySearch>
co gr

<isSupportExhaustDetection>
true
es a@

</isSupportExhaustDetection>
<isSupportTPMSecretKey>
Fr rc

<!--ro, opt, bool, whether the device supports enable stream encryption on all TPM keys lists, desc:true (support), false or this node is not returned
s

(not support). Related URI: /ISAPI/Streaming/encryption/TPMSecretKeyList?format=json&security=<security>&iv=<iv>-->true

</isSupportTPMSecretKey>
y ema

<isSupportWeatherStation>
true
</isSupportWeatherStation>
os fr

<isSupportRoadVisibilityAnalysis>
true
ad on

</isSupportRoadVisibilityAnalysis>
<isSupportRoadWeatherAnalysis>
<!--ro, opt, bool, whether the device supports road weather detection analysis, desc:eventType: roadWeatherAnalysis; this node is not returned if not
el .c

supported-->true
</isSupportRoadWeatherAnalysis>
ez

<isSupportRoadVisibilityAbnormal>
true
en

</isSupportRoadVisibilityAbnormal>
<isSupportRoadWeatherAbnormal>
<!--ro, opt, bool, whether the device supports uploading road weather detection exception, desc:eventType: roadWeatherAbnormal; this node is not
im

returned if not supported-->true

</isSupportRoadWeatherAbnormal>
Aj

<isSupportChannelsTimeSync>
<!--ro, opt, bool, whether the device supports batch device time synchronization of the IPC/IOT channel, desc:related URL:
Co

/ISAPI/System/time/channelsTimeSync/capabilities?format=json-->true
</isSupportChannelsTimeSync>
<isSupport433Sensor>
true
</isSupport433Sensor>
<isSupportSignalSource>
true
</isSupportSignalSource>
<isSupportUSBConfig>
true
</isSupportUSBConfig>
<isSupportStandbyStrategy>
true
</isSupportStandbyStrategy>
<isSupportWakeupStrategy>
true
format=json-->true
</isSupportWakeupStrategy>
<isSupportSeachMutexFunction>
true
</isSupportSeachMutexFunction>
<isSupportMultiDeviceID>
true
</isSupportMultiDeviceID>
<isNotSupportMultiDeviceIDCustomName>
true
</isNotSupportMultiDeviceIDCustomName>
<isSupportMixedSecurityChecking>
true

m
</isSupportMixedSecurityChecking>
<isSupportVisiblePackageEvent>

co
true
</isSupportVisiblePackageEvent>

a.
<isSupportBarCodeEvent>
true
</isSupportBarCodeEvent>

C. arc
<isSupportGaugeReading>
true
</isSupportGaugeReading>

s, em
<isSupportUncertificateCompareEvent>
<!--ro, opt, bool, whether the device supports the UncertificateCompareEvent event, desc:eventType: UncertificateCompareEvent; this node is not returned

A
if not supported-->true

no fr
</isSupportUncertificateCompareEvent>
<isSupportAudioDiacritical>

ri on
true
</isSupportAudioDiacritical>

Ma oc
<isSupportMEFReportSearch>
true
up
</isSupportMEFReportSearch>
<isSupportBroadcastTriggerEvent>
co gr

true
es a@

</isSupportBroadcastTriggerEvent>
<isSupportFishingShipDetection>
<!--ro, opt, bool, whether the device supports fishing ship detection event, desc:eventType: fishingShipDetection; related URL:
Fr rc

/ISAPI/Thermal/channels/<channelID>/fishingShipDetection/<SID>?format=json-->true
</isSupportFishingShipDetection>
<isSupportHPVehicleLoadingRate>
y ema

true
</isSupportHPVehicleLoadingRate>
<isSupportVideoBarrierGateDetection>
os fr

true
ad on

</isSupportVideoBarrierGateDetection>
<isSupportLogicalResource>
<!--ro, opt, bool, whether the device supports camera organization and management, desc:related URL: /ISAPI/System/LogicalResource/capabilities?
el .c

format=json, this node is not returned if not supported-->true

</isSupportLogicalResource>
<isSupportSlagTruckCoverPlate>
ez

true
en

</isSupportSlagTruckCoverPlate>
<isSupportTrainDetection>
true
im

</isSupportTrainDetection>
<isNotSupportVideoOverlays>
ng

<!--ro, opt, bool, whether the device supports configuring OSD overlaying of web display, desc:this node is only valid for checking whether the OSD
Aj

overlaying configuration of the image menu of the security inspection system is supported or not (this configuration is supported by default in the protocol
Co

and it does not have node control capability). If true is returned, it indicates that the OSD overlay is not supported; if false or no node is returned, it
indicates the OSD overlay function is supported-->true
</isNotSupportVideoOverlays>
<isSupportScheduledCaptureTask>
true
</isSupportScheduledCaptureTask>
<isSupportGuideCfg>
true
</isSupportGuideCfg>
<isSupportCameraGroupPeopleCounting>
true
</isSupportCameraGroupPeopleCounting>
<isSupportAngleDeviationDetection>
true
</isSupportAngleDeviationDetection>
<isSupportCityCode>
true
</isSupportCityCode>
<isSupportAlcoholDetectionResult>
<isSupportAlcoholDetectionResult>
true
</isSupportAlcoholDetectionResult>
<isSupportAlcoholDetectionRodBind>
true
</isSupportAlcoholDetectionRodBind>
<isSupportAlcoholDetectionRodBindQuery>
true
</isSupportAlcoholDetectionRodUnbind>
<isSupportAbnormalDriving>
true
</isSupportAbnormalDriving>
<isSupportEmanationsEvent>

m
<!--ro, opt, bool, whether the device supports the event of emanation test, desc:eventType: emanationsEvent; the security inspection system is equipped

co
with an emanation tester, and when the emanation exceeds the threshold, an alarm event will be uploaded currently, this event is only triggered by the
emanation tester, and its configuration is not required-->true
</isSupportEmanationsEvent>

a.
<isSupportClientUpdatePackage>
<!--ro, opt, bool, whether the device supports the client upgrade package management, desc:related URL: /ISAPI/System/clientUpdatePackage/capabilities?

C. arc
format=json-->true
</isSupportClientUpdatePackage>
<isSupportDeviceStatusUploadStrategy>
<!--ro, opt, bool, whether the device supports configuring the parameters of device status uploading strategy, desc:related URL:

s, em
/ISAPI/System/status/uploadStrategy/capabilities?format=json-->true
</isSupportDeviceStatusUploadStrategy>

A
<isSupportDialIndicatorReading>

no fr
true

ri on
</isSupportDialIndicatorReading>
<isNotSupportAudioVideoCompress>

Ma oc
true
co gr

</isSupportUPLCExceptionEvent>
<isSupportUrgentTurn>
true
es a@

</isSupportUrgentTurn>
<isSupportUrgentBrake>
Fr rc

true
s

</isSupportUrgentBrake>
<isSupportUrgentAcceleration>
y ema

true
</isSupportUrgentAcceleration>
<isSupportVehiclePanicButton>
true
os fr

</isSupportVehiclePanicButton>
<isSupportOverSpeed>
true
ad on

</isSupportOverSpeed>
<isSupportAbnormalAcceleration>
el .c

true
</isSupportAbnormalAcceleration>
<isSupportRollover>
ez

true
</isSupportRollover>
<isSupportCollision>
en

true
</isSupportCollision>
im

<isSupportVehicleOBUInfo>
true
ng

</isSupportVehicleOBUInfo>
Aj

<isSupportPowerUpPicture>
<!--ro, opt, bool, whether the device supports importing and exporting pictures displayed during startup,
Co

desc:/ISAPI/System/powerUpPicture/capabilities?format=json-->true
</isSupportPowerUpPicture>
<isSupportPowerUpPictureCfg>
true
</isSupportPowerUpPictureCfg>
<isSupportAlgoPackageScheduling>
true
</isSupportAlgoPackageScheduling>
<isSupportVoiceTalkRequestingAlarm>
true
</isSupportVoiceTalkRequestingAlarm>
<isSupportSetupStructure>
true
</isSupportSetupStructure>
<isSupportPassNumInfoEvent>
true
</isSupportPassNumInfoEvent>
<isShowClientRemote>
true
</isShowClientRemote>
<isSupportUserManualQRCode>
true
</isSupportUserManualQRCode>
<isSupportUnclosedFrontPanel>
true
</isSupportUnclosedFrontPanel>
<isSupportVehicleWeight>
true

m
</isSupportVehicleWeight>

co
<isSupportWeightInterface>
true
</isSupportWeightInterface>

a.
<isSupportSecurityPanicEvent>
true
</isSupportSecurityPanicEvent>

C. arc
<isSupportTrafficLightMalfunction>
true
</isSupportTrafficLightMalfunction>
<isSupportTOFShelterAlarm>

s, em
<!--ro, opt, bool, whether the device supports TOF tampering alarm, desc:/ISAPI/Event/channels/<channelID>/TOFShelterAlarm/capabilities?format=json--
>true

A
</isSupportTOFShelterAlarm>

no fr
<isSupportSetMealQuery>
true

ri on
</isSupportSetMealQuery>
<isSupportMultiScreenControlAlarm>
true

Ma oc
</isSupportMultiScreenControlAlarm>
<isSupportKeyFrameLoss>
true
</isSupportKeyFrameLoss>
co gr

<isSupportWorkStatusCfg>
true
</isSupportWorkStatusCfg>
es a@

<isSupportHealthInfoSyncQuery>
true
</isSupportHealthInfoSyncQuery>
Fr rc

<isSupportVisitorPictureSearchEvent>
true
y ema

</isSupportVisitorPictureSearchEvent>
<isSupportEZVIZParameterTest>
true
</isSupportEZVIZParameterTest>
os fr

<isSupportUnattendedPackageEvent>
true
</isSupportUnattendedPackageEvent>
ad on

<isSupportPackageFragmentEvent>
true
</isSupportPackageFragmentEvent>
el .c

<isSupportPackageBarcodeMismatchEvent>
true
ez

</isSupportPackageBarcodeMismatchEvent>
<isSupportCheckingModeSwitchEvent>
true
en

</isSupportCheckingModeSwitchEvent>
<FaceSnapPrivacyMask>
<!--ro, opt, object, whether the device supports privacy mask on faces, desc:based on face picture capture, all faces will be masked to protect the
im

privacy. Related URI: /ISAPI/Intelligent/channels/<channelID>/faceSnap/privacyMask/capabilities?format=json-->

<ChannelsList>
ng

<channelsID>
Co

1

</channelsID>
</ChannelsList>
</FaceSnapPrivacyMask>
<FaceContrastPrivacyMask>

<ChannelsList>

<channelsID>
1
</channelsID>
</ChannelsList>
</FaceContrastPrivacyMask>
<isSupportHumanBodyComparison>
true
</isSupportHumanBodyComparison>
<isSupportMedicalInfoSearchEvent>
true
</isSupportMedicalInfoSearchEvent>
<isSupportConsumptionStatusQuery>
true
</isSupportConsumptionStatusQuery>
</isSupportConsumptionStatusQuery>
<isSupportShipChannelAbnormal>
true
</isSupportShipChannelAbnormal>
<isSupportDepositRetrieveEvent>
true
</isSupportDepositRetrieveEvent>
<isSupportDepositTimeoutEvent>
true
</isSupportDepositTimeoutEvent>
<isSupportCabinetStatusEvent>
true
</isSupportCabinetStatusEvent>
<isSupportCabinetAuthorityExpired>
true
</isSupportCabinetAuthorityExpired>

m
<isSupportT1Test>
true

co
</isSupportT1Test>
<isSupportDrivingDirectionAtIntersection>
<!--ro, opt, bool, whether the device supports intersection driving direction detection, desc:eventType: drivingDirectionAtIntersection; this node is

a.
not returned if not supported-->true
</isSupportDrivingDirectionAtIntersection>

C. arc
<isSupportPlaceSceneExecuteStatus>
true
</isSupportPlaceSceneExecuteStatus>

s, em
<isSupportSceneRecordingCtrl>
<!--ro, opt, bool, whether the device supports the event of controlling scene recording, desc:eventType: sceneRecordingCtrl; this node is not returned

A
if not supported-->true

no fr
</isSupportSceneRecordingCtrl>
<isSupportStreamRecordStatus>
true

ri on
</isSupportStreamRecordStatus>
<isSupportManualSnapPicture>

Ma oc
true
</isSupportManualSnapPicture>
up
<isSupportVerificationResultEvent>
true
</isSupportVerificationResultEvent>
co gr

<OTAP>

es a@

<isSupportOTAPModel>
true
Fr rc

</isSupportOTAPModel>
s

</OTAP>
<isSupportForeignObjectInRoadDetection>
y ema

true
</isSupportForeignObjectInRoadDetection>
<isSupportUPLCMethodOperatingStatus>
true
os fr

</isSupportUPLCMethodOperatingStatus>
<isSupportMaterialScanTaskStatus>
true
ad on

</isSupportMaterialScanTaskStatus>
<isSupportSearchInputProxy>
el .c

true
ez

</isSupportSearchInputProxy>
<isSupportPostureDetection>
true
en

</isSupportPostureDetection>
<isSupportFans>
im

true
</isSupportFans>
ng

<pickUpCalibration>
Aj

Co

<ChannelsList>

<channelsID>
1
</channelsID>
</ChannelsList>
</pickUpCalibration>
<isSupportSerialLogUpload>
true
</isSupportSerialLogUpload>
<isSupportLiquidDetectionEvent>
true
</isSupportLiquidDetectionEvent>
<isSupportETCRSU>
true
</isSupportETCRSU>
<isSupportVideoCodeConvertTool>
true
</isSupportVideoCodeConvertTool>
<supportQuickConfigType opt="icr,dayNightGate,syncSignalOutput">
syncSignalOutput
</supportQuickConfigType>
<isSupportVisualLocation>
true
</isSupportVisualLocation>
<isSupportVideoAccessAbnormal>
true
</isSupportSubSystemAbnormal>
<isSupportSearchFileList>

m
<!--ro, opt, bool, whether the device supports searching for list of device files, desc:related URI: /ISAPI/System/fileExport/SearchFileList?

co
format=json-->true
</isSupportSearchFileList>
<isSupportDistanceDetectionEvent>

a.
true
</isSupportDistanceDetectionEvent>

C. arc
<isSupportMeetingQueryEvent>
true
</isSupportMeetingQueryEvent>
<isSupportMeetingLockEvent>

s, em
true

A
</isSupportMeetingLockEvent>

no fr
<isSupportMeetingAddEvent>
true
</isSupportMeetingAddEvent>

ri on
<isSupportMeetingModifyEvent>
true
</isSupportMeetingModifyEvent>

Ma oc
<isSupportMeetingCancelEvent>
true
up
</isSupportMeetingCancelEvent>
<isSupportScreenBindIPCEvent>
true
co gr

</isSupportScreenBindIPCEvent>
<isSupportSensorDetection>
true
es a@

</isSupportSensorDetection>
<isSupportClearLogCache>
true
Fr rc

</isSupportClearLogCache>
<isSupportRoadOccupyDetection>
y ema

true
</isSupportRoadOccupyDetection>
<isSupportMeetingRoomSignInEvent>
os fr

true
</isSupportMeetingRoomSignInEvent>
<isSupportMeetingRoomSignOutEvent>
ad on

true
</isSupportMeetingRoomSignOutEvent>
<isSupportTimeTypeSTD>
el .c

<!--ro, opt, bool, whether the device supports the time type of ISO8601, desc:if "true" is returned, it indicates that all the devices containing
ISO8601 parameters support adding the timeType=STD, such as /ISAPI/ContentMgmt/search?timeType=STD; the time will be implemented according to the standard--
ez

>true
</isSupportTimeTypeSTD>
<isSupportScanner>
en

true
</isSupportScanner>
im

<isSupportRegionTargetNumberCounting>
ng

<!--ro, opt, bool, whether the device supports the region target counting, desc:related URI:
Aj

/ISAPI/Event/channels/<channelID>/RegionTargetNumberCounting/Capabilities?format=json-->true
</isSupportRegionTargetNumberCounting>
Co

<depthMapMaintainMode>

<ChannelsList>

<channelID>
1
</channelID>
</ChannelsList>
</depthMapMaintainMode>
<isSupportExportPipCalibrationFile>
true
</isSupportExportPipCalibrationFile>
<isSupportCourseUploadInfo>
true
</isSupportCourseUploadInfo>
<isSupportPresetSwitchingInformation>
true
</isSupportPresetSwitchingInformation>
<isSupportCabinetChargingQuery>
true
</isSupportCabinetChargingQuery>
</isSupportCabinetChargingQuery>
<isSupportSearchVoltageAndPowerConsumptionReport>
true
</isSupportSearchVoltageAndPowerConsumptionReport>
<isSupportDeviceDrop>
true
</isSupportDeviceDrop>
<isSupportDeviceNotMoved>
true
</isSupportDeviceNotMoved>
<isSupportWalkWrongWayOnEscalator>
true
</isSupportWalkWrongWayOnEscalator>
<isSupportFallOnEscalator>
true

m
</isSupportFallOnEscalator>
<isSupportCarryLargeLuggageOnEscalator>

co
true
</isSupportCarryLargeLuggageOnEscalator>

a.
<isSupportPushStrollerOnEscalator>
true
</isSupportPushStrollerOnEscalator>

C. arc
<isSupportTeachingSpeechDetection>
true
</isSupportTeachingSpeechDetection>
<updatefirmwareType opt="warningScreenFirmware,warningScreenFont,warningScreenVoice">

s, em
<!--ro, opt, string, RS-485 working modes supported by the device, attr:opt{opt, string}, desc:corresponding to <type> in /ISAPI/System/updateFirmware?
type=<type>; "warningScreenFirmware", "warningScreenFont", "warningScreenVoice"; note that <isSupportUpdatefirmware> is supported when this node is

A
supported-->warningScreenFirmware

no fr
</updatefirmwareType>
<isSupportPaymentQRCodeQuery>

ri on
true
</isSupportPaymentQRCodeQuery>
<isSupportTopUpEvent>

Ma oc
true
</isSupportTopUpEvent>
<isSupportTopUpRequest>
up
true
</isSupportTopUpRequest>
<isSupportTopUpStatusQuery>
co gr

true
</isSupportTopUpStatusQuery>
es a@

<isSupportLogOffRefundRequest>
true
</isSupportLogOffRefundRequest>
Fr rc

<isSupportLogOffRefundStatusQuery>
<!--ro, opt, bool, whether the device supports searching for the refund status of logged-off persons, desc:corresponding event: logOffRefundStatusQuery-
->true
y ema

</isSupportLogOffRefundStatusQuery>
<isSupportAuthenticationTimeoutEvent>
true
</isSupportAuthenticationTimeoutEvent>
os fr

<isSupportCertificateCapture>
true
ad on

</isSupportCertificateCapture>
<isSupportDeviceBatchActivation>
true
el .c

</isSupportDeviceBatchActivation>
<isSupportPlaceEnvironmentMonitoringRule>
<!--ro, opt, bool, whether the device supports place environment monitoring rule parameters,
ez

desc:/ISAPI/Event/channels/<channelID>/PlaceEnvironmentMonitoringRule?format=json-->true
</isSupportPlaceEnvironmentMonitoringRule>
en

<isSupportEngineResource>
true
</isSupportEngineResource>
im

<isSupportPTModulePowerCfg>
<!--ro, opt, bool, whether the device supports modifying the power supply parameters of PTZ base, desc:PUT /ISAPI/System/ModifyPTModulePowerCfg?
ng

format=json POST /ISAPI/System/GetPTModulePowerCfg?format=json-->true

</isSupportPTModulePowerCfg>
<isSupportGetBoxDoorDetectionCfg>
Co

true
</isSupportGetBoxDoorDetectionCfg>
<isSupportModifyBoxDoorDetectionCfg>
true
</isSupportModifyBoxDoorDetectionCfg>
<isSupportSmartBoxStatus>
true
</isSupportSmartBoxStatus>
<isSupportBatteryStatusCtrl>
true
</isSupportBatteryStatusCtrl>
<isSupportCooler>
true
</isSupportCooler>
<isSupportBoxDoorDetectionCfg>
true
</isSupportBoxDoorDetectionCfg>
<isSupportBoxDoorStatus>
true
</isSupportBoxDoorStatus>
<isSupportLightningProtectionStatus>
<isSupportLightningProtectionStatus>
true
</isSupportLightningProtectionStatus>
<isSupportDeviceVisualLocalizationDetectionEvent>
true
</isSupportDeviceVisualLocalizationDetectionEvent>
<isSupportDeviceVisualLocalizationAnalysisEvent>
true
</isSupportDeviceVisualLocalizationAnalysisEvent>
<isSupportGetPowerPortWorkParamList>
true
</isSupportGetPowerPortWorkParamList>
<isSupportUsersLoginNotification>
true

m
</isSupportUsersLoginNotification>

co
<isSupportLiquidLevelDetectorInfo>
true
</isSupportLiquidLevelDetectorInfo>

a.
<isSupportWaterPressureDetectorInfo>
true

C. arc
</isSupportWaterPressureDetectorInfo>
<isSupportEncryptionFileUpgradeMgr>
true
</isSupportEncryptionFileUpgradeMgr>

s, em
<isSupportInformedConsentTextParam>

A
<!--ro, opt, bool, whether the device supports text parameters of consent confirmation document,

no fr
desc:/ISAPI/System/InformedConsentMgr/InformedConsentTextParam?format=json-->true
</isSupportInformedConsentTextParam>
<isSupportSendConsolePassword>

ri on
true
</isSupportSendConsolePassword>
<isSupportAutoLaserRanging>

Ma oc
true
</isSupportAutoLaserRanging>
up
<isSupportDelayedReboot>
true
</isSupportDelayedReboot>
co gr

<isSupportFalseAlarmMaterialLibMgr>
true
es a@

</isSupportFalseAlarmMaterialLibMgr>
<isSupportGetServerRandom>
Fr rc

<!--ro, opt, bool, whether the device supports getting random number of Chinese cryptographic server, desc:POST
s

/ISAPI/Security/ProtocolCertificate/GetServerRandom?format=json-->true
</isSupportGetServerRandom>
y ema

<isSupportSendTelnetTestCmd>
true
</isSupportSendTelnetTestCmd>
os fr

<isSupportTelnetTestCmdStatus>
true
ad on

</isSupportTelnetTestCmdStatus>
<isSupportImportUSBKeyAuthInfo>
<!--ro, opt, bool, whether the device supports Chinese cryptographic USBKey authentication information, desc:POST
el .c

/ISAPI/Security/ProtocolCertificate/ImportUSBKeyAuthInfo?format=json-->true
</isSupportImportUSBKeyAuthInfo>
ez

<isSupportSendSupervisionRecordCollection>
true
en

</isSupportSendSupervisionRecordCollection>
<isSupportSearchPersonnelOperationSupervisionTask>
<!--ro, opt, bool, whether it supports searching for operation supervision tasks, desc:POST
im

/ISAPI/Intelligent/channels/<channelID>/SearchPersonnelOperationSupervisionTask?format=json-->true
ng

</isSupportSearchPersonnelOperationSupervisionTask>
Aj

<isSupportDeletePersonnelOperationSupervisionTask>
<!--ro, opt, bool, whether it supports deleting operation supervision tasks, desc:POST
Co

/ISAPI/Intelligent/channels/<channelID>/DeletePersonnelOperationSupervisionTask?format=json-->true
</isSupportDeletePersonnelOperationSupervisionTask>
<isSupportAddPersonnelOperationSupervisionTask>
true
</isSupportAddPersonnelOperationSupervisionTask>
<isSupportUserLoginStatusChangeEvent>
true
</isSupportUserLoginStatusChangeEvent>
<isSupportObstacleAvoidance>
true
</isSupportObstacleAvoidance>
<isSupportManualSnapFishEyeWallPanoramaView>
true
</isSupportManualSnapFishEyeWallPanoramaView>
<isSupportPreviewSplitSwitchCfg>
true
</isSupportPreviewSplitSwitchCfg>
<isSupportCountingTargetParam>
true
</isSupportCountingTargetParam>
</isSupportCountingTargetParam>
<isSupportDebugLogModuleType opt="playService,communicationService,attendanceService,faceService">
true
</isSupportDebugLogModuleType>
<isSupportLoginPasswordCfg>
true
</isSupportLoginPasswordCfg>
<isSupportUserDataFile>
true
</isSupportUserDataFile>
<isSupportNtripAccessCfg>
<!--ro, opt, bool, whether the device supports NTRIP protocol access parameters, desc:GET/PUT /ISAPI/System/Network/Ntrip/NtripAccessCfg?format=json--
>true
</isSupportNtripAccessCfg>
<isSupportNetworkWatchdogParams>

m
true

co
</isSupportNetworkWatchdogParams>
<isSupportAudioRecordPlan>

a.
true
</isSupportAudioRecordPlan>
<isSupportStartVoiceMonitor>

C. arc
true
</isSupportStartVoiceMonitor>
<isSupportWebPTZCfg>

s, em
<!--ro, opt, bool, whether it supports displaying the web page for PTZ configuration, desc:this node is to determine whether to display the web page for
PTZ configuration and is irrelevant to whether PTZ is supported; default process logic: when this node does not exist, whether to display the web page for

A
PTZ configuration is subject to the device type-->true

no fr
</isSupportWebPTZCfg>
<isSupportGaugeReadingEvent>

ri on
true
</isSupportGaugeReadingEvent>
<isSupportVNCServerCfg>

Ma oc
true
</isSupportVNCServerCfg>
<isSupportResources>
up
true
</isSupportResources>
co gr

<isSupportDeviceGroupMgr>
<!--ro, opt, bool, whether it supports device application resources group management, desc:GET /ISAPI/System/DeviceGroupMgr/capabilities?format=json--
>true
es a@

</isSupportDeviceGroupMgr>
<isSupportAsyncResetSubDevicePassword>
<!--ro, opt, bool, whether the device supports resetting the password of sub-device asynchronously,
Fr rc

desc:/ISAPI/Security/resetPassword/AsyncResetSubDevicePassword?format=json-->true
</isSupportAsyncResetSubDevicePassword>
<isSupportAsyncResetSubDevicePasswordStatusList>
y ema

true
</isSupportAsyncResetSubDevicePasswordStatusList>
<isSupportEDRAccessList>
os fr

true
ad on

</isSupportEDRAccessList>
<isSupportBatteryCarInfoEvent>
true
el .c

</isSupportBatteryCarInfoEvent>
<isSupportChildmanage>
<!--ro, opt, bool, whether the device supports gateway sub-device topology management, desc:GET /ISAPI/IoTGateway/Childmanage/capabilities?format=json--
ez

>true
</isSupportChildmanage>
en

<isSupportSearchResources>
true
</isSupportSearchResources>
im

<isSupportResetPasswordPhoneNo>
<!--ro, opt, bool, whether the device supports the phone No. for resetting password, desc:GET/PUT /ISAPI/Security/resetPassword/ResetPasswordPhoneNo?
ng

format=json-->true
Aj

</isSupportResetPasswordPhoneNo>
Co

<isSupportGetPhoneNoQRCode>
true
</isSupportGetPhoneNoQRCode>
<isSupportResetPasswordByPhoneNoSecurityCode>
true
</isSupportResetPasswordByPhoneNoSecurityCode>
<isSupportGaugeReadingOverlapParams>
true
</isSupportGaugeReadingOverlapParams>
<isSupportGaugeReadingRainfallEvent>
true
</isSupportGaugeReadingRainfallEvent>
<isSupportSearchTrafficLightMalfunctionResult>
true
</isSupportSearchTrafficLightMalfunctionResult>
<isSupportCheckPhoneNoSecurityCode>
true
</isSupportCheckPhoneNoSecurityCode>
<isSupportUserValidExpired>
<isSupportUserValidExpired>
true
</isSupportUserValidExpired>
<isSupportSearchWaterLevelData>
true
</isSupportSearchWaterLevelData>
<isSupportSearchRecommendPerspective>
true
</isSupportSearchRecommendPerspective>
<isSupportGetLegendaryPerspectiveInfo>
true
</isSupportGetLegendaryPerspectiveInfo>
<configurationDataType opt="OSD,MODE,IMAGE,IOOUT,OTHERS">
<!--ro, opt, string, "OSD"-import video and image OSD settings, "MODE"-import application mode, "IMAGE"-import image parameters, "IOONT"-import

m
supplement Light Parameters, "OTHERS", attr:opt{req, string}-->test

co
</configurationDataType>
<isSupportRestoreVideoAdjustmentParam>
<!--ro, opt, bool, whether the device supports restoring video image setting parameters, desc:GET/PUT

a.
/ISAPI/System/Video/channels/<channelID>/RestoreVideoAdjustmentParam?format=json-->true
</isSupportRestoreVideoAdjustmentParam>

C. arc
<isSupportWeatherStationInfo>
true
</isSupportWeatherStationInfo>

s, em
<isSupportRadarPerimeterAlgCap>
<!--ro, opt, bool, whether the device supports the capability of radar perimeter algorithm parameters, desc:GET

A
/ISAPI/Smart/RadarPerimeterAlg/capabilities?format=json-->true

no fr
</isSupportRadarPerimeterAlgCap>
<isSupportBodyCameraOneKeyAlarmEvent>
<!--ro, opt, bool, whether the device supports the BodyCameraOneKeyAlarmEvent event, desc:eventType: BodyCameraOneKeyAlarmEvent; this node is not

ri on
returned if not supported-->true
</isSupportBodyCameraOneKeyAlarmEvent>

Ma oc
<isSupportGetOnlineTrafficLight>
true
up
</isSupportGetOnlineTrafficLight>
<isSupportTrafficLightMalfunctionDefaultParams>
<!--ro, opt, bool, whether the device supports default parameters of traffic light fault detection rules, desc:GET/PUT
co gr

/ISAPI/Event/TrafficLightMalfunctionDetection/TrafficLightMalfunctionDefaultParams?format=json-->true
</isSupportTrafficLightMalfunctionDefaultParams>
<isSupportFallenObjectsOnTracksDetection>
es a@

true
Fr rc

</isSupportFallenObjectsOnTracksDetection>
s

<isSupportMonitorAuthorization>
<!--ro, opt, bool, whether the device supports device service monitoring authorization information, desc:GET
y ema

/ISAPI/Security/DeviceServiceMonitor/MonitorAuthorization?format=json-->true
</isSupportMonitorAuthorization>
<isSupportBodyCameraTakeEvent>
<!--ro, opt, bool, whether the device supports the BodyCameraTakeEvent event, desc:eventType: BodyCameraTakeEvent; this node is not returned if not
os fr

supported-->true
</isSupportBodyCameraTakeEvent>
<isSupportCollaborationModeCfg>
ad on

true
el .c

</isSupportCollaborationModeCfg>
<isSupportAudioChannelVCAResource>
<!--ro, opt, bool, whether the device supports switching intelligent resources running on audio channels, desc:GET/PUT
ez

/ISAPI/System/VCAResource/channels/<audioID>/AudioChannelVCAResource?format=json-->true
</isSupportAudioChannelVCAResource>
<isSupportGasTankMonitoringEvent>
en

true
</isSupportGasTankMonitoringEvent>
im

<isSupportChannelClearEvent>
true
ng

</isSupportChannelClearEvent>
Aj

<isSupportBackDuty>
true
Co

</isSupportBackDuty>
<isSupportSleepDuty>
true
</isSupportSleepDuty>
<isSupportSearchChildDevResourcesStatus>
true
</isSupportSearchChildDevResourcesStatus>
<isSupportDeleteResources>
true
</isSupportDeleteResources>
<isSupportMenuFunctionList>
true
</isSupportMenuFunctionList>
<isSupportKeyFunctionList>
true
</isSupportKeyFunctionList>
<isSupportKeyValueList>
true
</isSupportKeyValueList>
<isSupportGetPseudoColorBackgroundPic>
true
</isSupportGetPseudoColorBackgroundPic>
<isSupportElevatorRunningDetection>
true
</isSupportElevatorRunningDetection>
<isSupportSearchPersonQueueRealTimeResult>
true
</isSupportSearchPersonQueueRealTimeResult>
<isSupportSearchLeavePositionEventResult>
true
</isSupportSearchLeavePositionEventResult>
<isSupportImportElectronicBadgeBackgroundImage>
true

m
</isSupportImportElectronicBadgeBackgroundImage>

co
<isSupportVoiceMonitoringEvent>
true
</isSupportVoiceMonitoringEvent>

a.
<isSupportPseudoColorBackgroundParam>
true

C. arc
</isSupportPseudoColorBackgroundParam>
<isSupportGotoPerimeterShieldMaskScene>
true

s, em
</isSupportGotoPerimeterShieldMaskScene>
<isSupportSearchPersonQueueTimingStatistics>

A
<!--ro, opt, bool, whether the device supports the SearchPersonQueueTimingStatistics event, desc:POST

no fr
/ISAPI/Intelligent/personQueueDetection/SearchPersonQueueTimingStatistics?format=json-->true
</isSupportSearchPersonQueueTimingStatistics>

ri on
<isSupportLocalUserChange>
true
</isSupportLocalUserChange>

Ma oc
<isSupportSendClientTask>
true
up
</isSupportSendClientTask>
<isSupportGetCurrentClientTaskStatus>
co gr

true
</isSupportGetCurrentClientTaskStatus>
es a@

<isSupportTestEDRServerConnect>
true
Fr rc

</isSupportTestEDRServerConnect>
<isSupportRealTimeStreamInfo>
y ema

true
</isSupportRealTimeStreamInfo>
<isSupportIrcutFilterStatusChange>
true
os fr

</isSupportIrcutFilterStatusChange>
<isSupportSendRoadMaintPictureAnalysisTask>
<!--ro, opt, bool, whether the device supports applying tasks of road maintenance picture analysis, desc:POST
ad on

/ISAPI/Intelligent/SendRoadMaintPictureAnalysisTask?format=json-->true
</isSupportSendRoadMaintPictureAnalysisTask>
<isSupportFDRemoveDuplicateParams>
el .c

true
ez

</isSupportFDRemoveDuplicateParams>
<isSupportRadarMixedTargetSensitivityParams>
<!--ro, opt, bool, whether the device supports sensitivity parameters of multi-target-type detection via radar, desc:GET/PUT
en

/ISAPI/Smart/RadarMixedTargetAlg/RadarMixedTargetSensitivityParams?format=json-->true
</isSupportRadarMixedTargetSensitivityParams>
<isSupportMixedTargetRadarSensitivityParams>
im

true
ng

</isSupportMixedTargetRadarSensitivityParams>
Aj

<isSupportMixedTargetRadarDebugParams>
Co

true
</isSupportMixedTargetRadarDebugParams>
<isSupportHttpPreview>
true
</isSupportHttpPreview>
<isSupportGetRecordThumbnail>
true
</isSupportProxyAIOP>
<isSupportStaticObjectPositionOffsetComparison>
<isSupportStaticObjectPositionOffsetComparison>
true
</isSupportStaticObjectPositionOffsetComparison>
<isSupportClearFDRemoveDuplicateFDLib>
true
</isSupportClearFDRemoveDuplicateFDLib>
<isSupportDevPowerStatusReportCtrl>
true
</isSupportDevPowerStatusReportCtrl>
<isSupportIndicatorLight>
true
</isSupportIndicatorLight>
<isSupportEnvironmentTemperatureMonitorEvent>

m
true
</isSupportEnvironmentTemperatureMonitorEvent>

co
<isSupportPhysicalTraining>
true

a.
</isSupportPhysicalTraining>
<isSupportPullUp>

C. arc
true
</isSupportPullUp>
<isSupportSitUpWithHandsBehindHead>
true

s, em
</isSupportSitUpWithHandsBehindHead>
<isSupportSitUpWithArmsOnChest>

A
true

no fr
</isSupportSitUpWithArmsOnChest>
<isSupportPushUp>
true

ri on
</isSupportPushUp>
<isSupportPullUpHold>

Ma oc
true
</isSupportPullUpHold>
<isSupportVerificationPlatformParams>
up
true
</isSupportVerificationPlatformParams>
co gr

<isSupportVehicleMaintenanceDetection>
<!--ro, opt, bool, whether the device supports vehicle maintenance detection, desc:GET /ISAPI/Intelligent/VehicleMaintenanceDetection/capabilities?
es a@

format=json; detects the status of vehicles in the maintenance shop and triggers the alarm when the vehicle is lifted (when detecting chassis) or lowered,
or the hood is opened-->true
</isSupportVehicleMaintenanceDetection>
Fr rc

<isSupportPhysicalTrainingStatus>
s

true
</isSupportPhysicalTrainingStatus>
y ema

<isSupportDeviceAbnormalDebug>
<!--ro, opt, bool, whether the device supports device operation exception debugging, desc:GET /ISAPI/System/DeviceAbnormalDebug/capabilities?
format=json; during device operation exception, the device operation debugging data (debugging log, dump file, etc.) will be collected by technical support-
->true
os fr

</isSupportDeviceAbnormalDebug>
<isSupportSetWaterLevelResetOfWaterTank>
<!--ro, opt, bool, whether the device supports manually filling up the water tank and uploading the filled tank information for calculating remaining
ad on

water via lens wiper usage, desc:PUT /ISAPI/System/Hardware/SetWaterLevelResetOfWaterTank?format=json-->true

</isSupportSetWaterLevelResetOfWaterTank>
el .c

<isSupportGetRemoteAlbumPicture>
<!--ro, opt, bool, whether the device supports getting pictures from the remote album, desc:POST /ISAPI/ContentMgmt/GetRemoteAlbumPicture?format=json--
>true
ez

</isSupportGetRemoteAlbumPicture>
<isSupportUltravioletImagingFusionParams>
<!--ro, opt, bool, whether the device supports UV imaging fusion parameters, desc:GET/PUT
en

/ISAPI/System/Video/channels/<channelID>/UltravioletImagingFusionParams?format=json-->true
</isSupportUltravioletImagingFusionParams>
im

<isSupportAudioAnalysisCfg>
<!--ro, opt, bool, whether it supports audio analysis parameters, desc:GET/PUT
ng

/ISAPI/Intelligent/SensitiveInfoAnalysis/AudioIn/<AudioInID>/AudioAnalysisCfg?format=json-->true
Aj

</isSupportAudioAnalysisCfg>
<isSupportRuningLogPlan>
Co

true
</isSupportRuningLogPlan>
<isSupportSearchRuningLogData>
true
</isSupportExportRuningLogData>
<isSupportCertificateCaptureEvent>
true
</isSupportCertificateCaptureEvent>
<isSupportUpgradeKeywordModel>
true
</isSupportUpgradeKeywordModel>
<isSupportGetKeywordModelStatus>
true
</isSupportGetKeywordModelStatus>
<isSupportCloseLensPrivacyCover>
true
</isSupportCloseLensPrivacyCover>
<isSupportOpenLensPrivacyCover>
true
</isSupportOpenLensPrivacyCover>
<isSupportLensPrivacyCoverModeParams>
true
</isSupportLensPrivacyCoverModeParams>
<isSupportOTAPService>
true
</isSupportOTAPService>
<isSupportGetPlaybackStreamInfo>
<!--ro, opt, bool, whether the device supports getting video playback stream information, desc:GET /ISAPI/Streaming/GetPlaybackStreamInfo?format=json--
>true
</isSupportGetPlaybackStreamInfo>

m
<isSupportNBIoTPlateformAccessStatus>

co
<!--ro, opt, bool, whether the device supports the NB-IoT platform access status, desc:GET /ISAPI/System/Network/NBIoTPlateformAccessStatus?format=json-
->true
</isSupportNBIoTPlateformAccessStatus>

a.
<isSupportScannedListEvent>
true
</isSupportScannedListEvent>

C. arc
<isSupportDownloadAudioRecordByTime>
true
</isSupportDownloadAudioRecordByTime>

s, em
<isSupportBackUpConfigurationFile>

A
true

no fr
</isSupportBackUpConfigurationFile>
<isSupportRestoreConfigurationFile>
<!--ro, opt, bool, whether the device supports restoring the device local configuration file, desc:PUT /ISAPI/System/RestoreConfigurationFile?

ri on
format=json-->true
</isSupportRestoreConfigurationFile>
<isSupportGetCfgFileBackUpInfo>

Ma oc
true
up
</isSupportGetCfgFileBackUpInfo>
<isSupportSearchVideoCodeMealParams>
<!--ro, opt, bool, whether the device supports searching for video encoding plan parameters, desc:POST
co gr

/ISAPI/Streaming/channels/<channelID>/SearchVideoCodeMealParams?format=json-->true
</isSupportSearchVideoCodeMealParams>
<isSupportVideoCodeMealParams>
es a@

true
</isSupportVideoCodeMealParams>
Fr rc

<isSupportFlameCombustionStatusRuleParams>
<!--ro, opt, bool, whether the device supports flame burning status detection rule parameters, desc:GET/PUT
y ema

/ISAPI/Intelligent/channels/<channelID>/FlameCombustionStatusRuleParams?format=json-->true
</isSupportFlameCombustionStatusRuleParams>
<isSupportFlameCombustionStatusOverlapParams>
<!--ro, opt, bool, whether the device supports flame burning status detection information overlay parameters, desc:GET/PUT
os fr

/ISAPI/Intelligent/channels/<channelID>/FlameCombustionStatusOverlapParams?format=json-->true
</isSupportFlameCombustionStatusOverlapParams>
<isSupportAcousticLeakDetection>
ad on

true
</isSupportAcousticLeakDetection>
el .c

<isSupportFlameCombustionStatusSceneList>
<!--ro, opt, bool, whether the device supports flame burning status detection scene list, desc:GET
ez

/ISAPI/Intelligent/channels/<channelID>/FlameCombustionStatusSceneList?format=json-->true
</isSupportFlameCombustionStatusSceneList>
<isSupportGasLeakageDetection>
en

true
</isSupportGasLeakageDetection>
<isSupportDischargeDetection>
im

true
ng

</isSupportDischargeDetection>
Aj

<isSupportSearchBaseMapIDList>
true
Co

</isSupportSearchBaseMapIDList>
<isSupportRestoreDefaultParam>
true
</isSupportRestoreDefaultParam>
<isSupportSearchEventTargetInfo>
true
</isSupportSearchEventTargetInfo>
<isSupportElevatorRunningDetectionEvent>
true
</isSupportElevatorRunningDetectionEvent>
<isSupportElevatorOperationStatistics>
true
</isSupportElevatorOperationStatistics>
<isSupportStandingLongJump>
true
</isSupportStandingLongJump>
<isSupportJumpRope>
true
</isSupportJumpRope>
<isSupportUserAvailablePwQuery>
true
</isSupportUserAvailablePwQuery>
<isSupportAddHistoryEventSubscribeCfg>
<isSupportAddHistoryEventSubscribeCfg>
true
</isSupportAddHistoryEventSubscribeCfg>
<isSupportHistoryEventSubscribeUploadCtrl>
true
</isSupportHistoryEventSubscribeUploadCtrl>
<isSupportHLSStreamCfg>
true
</isSupportHLSStreamCfg>
<isSupportGetKeywordModelVersionInfo>
true
</isSupportGetKeywordModelVersionInfo>

m
<isSupportManualTriggerRemoteAlbumSnapshot>
<!--ro, opt, bool, whether the device supports manually triggering remote album capture, desc:PUT /ISAPI/ContentMgmt/ManualTriggerRemoteAlbumSnapshot?

co
format=json-->true
</isSupportManualTriggerRemoteAlbumSnapshot>

a.
<isSupportRadarVideoAssistedFocusParams>
true

C. arc
</isSupportRadarVideoAssistedFocusParams>
<isSupportCollectionResultUpload>
true
</isSupportCollectionResultUpload>

s, em
<isSupportDeveloperMode>
true

A
</isSupportDeveloperMode>

no fr
<isSupportGetDetailsFunction>
<!--ro, opt, bool, whether the device supports getting detailed functions supported in T1 test, desc:GET /ISAPI/System/T1Test/DetailsFunction?

ri on
format=json-->true
</isSupportGetDetailsFunction>
<isSupportSearchDeviceIANAList>

Ma oc
true
</isSupportSearchDeviceIANAList>
<isSupportModifySpecificROIStreamJointParams>
up
true
</isSupportModifySpecificROIStreamJointParams>
co gr

<isSupportDeviceTamperParams>
true
es a@

</isSupportDeviceTamperParams>
<isSupportDeviceTamperEvent>
true
Fr rc

</isSupportDeviceTamperEvent>
<isSupportRoadVariableLaneCtrlParams>
<!--ro, opt, bool, whether the device supports dynamic management parameters of changeable lane, desc:GET/PUT
y ema

/ISAPI/Traffic/RoadVariableLaneCtrl/channels/<channelID>/RoadVariableLaneCtrlParams?format=json-->true
</isSupportRoadVariableLaneCtrlParams>
<isSupportImportModelFile>
<!--ro, opt, bool, whether the device supports importing the water quality detection model file, desc:POST
os fr

/ISAPI/Event/waterQualityDetection/ImportModelFile?format=json-->true
</isSupportImportModelFile>
ad on

<isSupportSearchImportStatus>
true
el .c

</isSupportSearchImportStatus>
<isSupportSafetyWorkwearDetectionOverlapParams>
<!--ro, opt, bool, whether the device supports parameters of wearing safety work clothes detection information overlay, desc:GET/PUT
ez

/ISAPI/Intelligent/channels/<channelID>/SafetyWorkwearDetectionOverlapParams?format=json-->true
</isSupportSafetyWorkwearDetectionOverlapParams>
en

<isSupportSafetyWorkwearDetectionRuleParams>
true
im

</isSupportSafetyWorkwearDetectionRuleParams>
<isSupportUpdateFirmwareMode>
ng

true
Aj

</isSupportUpdateFirmwareMode>
<isSupportIndoorPasswayRecovery>
Co

true
</isSupportIndoorPasswayRecovery>
<isSupportBatteryCarRecovery>
true
</isSupportBatteryCarRecovery>
<isSupportDetectorTemperatureRecovery>
true
</isSupportDetectorTemperatureRecovery>
<isSupportGetRFIDReaderWorkStatus>
true
</isSupportGetRFIDReaderWorkStatus>
<isSupportRFIDReaderWorkStatusCtrl>
true
</isSupportRFIDReaderWorkStatusCtrl>
<isSupportFlameCombustionStatusAlgorithmsVersion>
true
</isSupportFlameCombustionStatusAlgorithmsVersion>
<isSupportTestResultUpload>
true
</isSupportTestResultUpload>
</isSupportTestResultUpload>
<isSupportAutoTestParams>
true
</isSupportAutoTestParams>
<isSupportExportATInstructRecord>
true
</isSupportExportATInstructRecord>
<isSupportOfflineVideoFileManagement>
true
</isSupportOfflineVideoFileManagement>
<isSupportChannelOccupySceneList>
true
</isSupportChannelOccupySceneList>
<isSupportChannelOccupyAlgorithmsVersion>
<!--ro, opt, bool, whether the device supports getting the algorithm version of fire escape occupation, desc:GET

m
/ISAPI/Intelligent/channels/<channelID>/ChannelOccupyAlgorithmsVersion?format=json-->true

co
</isSupportChannelOccupyAlgorithmsVersion>
<isSupportChannelOccupyOverlapParams>
<!--ro, opt, bool, whether the device supports overlay parameters of fire escape occupation, desc:GET/PUT

a.
/ISAPI/Intelligent/channels/<channelID>/ChannelOccupyOverlapParams?format=json-->true
</isSupportChannelOccupyOverlapParams>

C. arc
<isSupportChannelOccupyRuleParams>
true
</isSupportChannelOccupyRuleParams>
<isSupportGotoChannelOccupyScene>

s, em
<!--ro, opt, bool, whether the device supports jumping to the specified fire escape occupation scene, desc:PUT

A
/ISAPI/Intelligent/channels/<channelID>/GotoChannelOccupyScene?format=json-->true

no fr
</isSupportGotoChannelOccupyScene>
<isSupportChannelPassingEvent>
true

ri on
</isSupportChannelPassingEvent>
<isSupportGunsHandoverRuleParams>
<!--ro, opt, bool, whether the device supports object handover rule parameters, desc:GET/PUT

Ma oc
/ISAPI/Intelligent/channels/<channelID>/GunsHandoverRuleParams?format=json-->true
</isSupportGunsHandoverRuleParams>
up
<isSupportBulkUpgradeChildDevice>
true
</isSupportBulkUpgradeChildDevice>
co gr

<isSupportSearchBulkUpgradeChildDeviceProgress>
true
es a@

</isSupportSearchBulkUpgradeChildDeviceProgress>
<isSupportDash>
Fr rc

true
s

</isSupportDash>
<isSupportStopRadarVideoAssistedFocusCalibrating>
y ema

true
</isSupportStopRadarVideoAssistedFocusCalibrating>
<isSupportRadarVideoAssistedFocusCalibrating>
os fr

true
</isSupportRadarVideoAssistedFocusCalibrating>
ad on

<isSupportRadarVideoAssistedFocusCalibratingStatus>
true
el .c

</isSupportRadarVideoAssistedFocusCalibratingStatus>
<isSupportETCMatchResultUpload>
ez

true
</isSupportETCMatchResultUpload>
<isSupportPartsLifeRemind>
en

true
</isSupportPartsLifeRemind>
<isSupportAuthorizeMicAcquisitionParam>
im

<!--ro, opt, bool, whether the device supports audio authorization information, desc:GET/PUT
ng

/ISAPI/System/InformedConsentMgr/AuthorizeMicAcquisitionParam?format=json-->true
Aj

</isSupportAuthorizeMicAcquisitionParam>
<isSupportTOFDetectEvent>
Co

true
</isSupportTOFDetectEvent>
<isSupportAudioAnalysisResultOSDOverlay>
true
</isSupportAudioAnalysisResultOSDOverlay>
<isSupportChildPasswordStatus>
true
</isSupportChildPasswordStatus>
<isSupportMutexFunctionClose>
true
</isSupportMutexFunctionClose>
<isSupportFirePointAlarmRecovery>
true
</isSupportFirePointAlarmRecovery>
<isSupportSmokeAlarmRecovery>
true
</isSupportSmokeAlarmRecovery>
<isSupportTemperatureMeasurementPreviewAlarmRecovery>
true
</isSupportTemperatureMeasurementAlarmRecovery>
<isSupportUVPhotonDetection>
true
</isSupportUVPhotonDetection>
<isSupportUVPhotonTimeDetection>
true
</isSupportUVPhotonTimeDetection>
<isSupportPatientExpensesInfoQuery>
true
</isSupportPatientExpensesInfoQuery>
<isSupportReinforcementCallEvent>
true
</isSupportReinforcementCallEvent>
<isSupportChargeMode>

m
true
</isSupportChargeMode>

co
<isSupportCombinationRuleParams>
<!--ro, opt, bool, whether the device supports combination rule parameters of perimeter detection, desc:GET/PUT

a.
/ISAPI/Intelligent/channels/<channelID>/PerimeterCombinationDetection/CombinationRuleParams?format=json-->true
</isSupportCombinationRuleParams>
<isSupportSwitchHolidayPlanCfg>

C. arc
<!--ro, opt, bool, whether the device supports the regular startup/shutdown on holiday, desc:GET/PUT /ISAPI/System/SwitchHolidayPlanCfg?format=json--
>true
</isSupportSwitchHolidayPlanCfg>
<isSupportSwitchIrregularHolidayPlanCfg>

s, em
true

A
</isSupportSwitchIrregularHolidayPlanCfg>

no fr
<isSupportSearchPresetConfigInfo>
<!--ro, opt, bool, whether the device supports searching for the configuration of specified presets, desc:POST

ri on
/ISAPI/Intelligent/channels/<channelID>/SearchPresetConfigInfo?format=json-->true
</isSupportSearchPresetConfigInfo>
<isSupportSwitchPlanCfg>

Ma oc
true
</isSupportSwitchPlanCfg>
<isSupportVegetationSpectrumDetection>
up
true
</isSupportVegetationSpectrumDetection>
co gr

<isSupportCaptureResultAttributeSearch>
true
es a@

</isSupportCaptureResultAttributeSearch>
<isSupportHealthEducationInfoReadStatus>
<!--ro, opt, bool, whether the device supports the event of uploading the reading status of health education information,
Fr rc

desc:eventType:HealthEducationInfoReadStatus-->true
</isSupportHealthEducationInfoReadStatus>
<isSupportNurseLocationEvent>
y ema

true
</isSupportNurseLocationEvent>
<isSupportModifyChildDevResource>
<!--ro, opt, bool, whether the device supports editing gateway resource information, desc:POST /ISAPI/System/DynamicResource/ModifyChildDevResource?
os fr

format=json-->true
</isSupportModifyChildDevResource>
ad on

<isSupportDiagnosisDataCollectionParams>
true
el .c

</isSupportDiagnosisDataCollectionParams>
<isSupportServicePlatformAccountAuth>
<!--ro, opt, bool, whether the device supports platform account authentication, desc:GET /ISAPI/Security/ServicePlatformAccountAuth/capabilities?
ez

format=json-->true
</isSupportServicePlatformAccountAuth>
en

<isSupportSyncPatientInfoEvent>
true
</isSupportSyncPatientInfoEvent>
im

<isSupportAuthenticationNetworkCfg>
<!--ro, opt, bool, whether the device supports the authentication parameters of networking method, desc:GET/PUT
ng

/ISAPI/Security/ProtocolCertificate/AuthenticationNetworkCfg?format=json-->true
Aj

</isSupportAuthenticationNetworkCfg>
Co

<isSupportPersonnelChannelLogParams>
true
</isSupportPersonnelChannelLogParams>
<isSupportElectricSaveModeParams>
true
</isSupportElectricSaveModeParams>
<isSupportChannelOccupyPOSParams>
true
</isSupportChannelOccupyPOSParams>
<isSupportChildPowerTimePlanParams>
true
</isSupportChildPowerTimePlanParams>
<isSupportPowerIndicatorLightCtrlParams>
true
</isSupportPowerIndicatorLightCtrlParams>
<isSupportRadarVideoMapDetectionParams>
true
</isSupportRadarVideoMapDetectionParams>
<isSupportRadarPOSParams>
<isSupportRadarPOSParams>
true
</isSupportRadarPOSParams>
<isSupportVideoIntercomModeEvent>
true
</isSupportVideoIntercomModeEvent>
<isSupportSoftwareAndHardwareCtrlParams>
true
</isSupportSoftwareAndHardwareCtrlParams>
<isSupportUserLoginAbnormal>
true
</isSupportUserLoginAbnormal>
<isSupportIndustryThermometryAdvancedParam>
true

m
</isSupportIndustryThermometryAdvancedParam>

co
<isSupportGotoVideoRecheckScene>
true

a.
</isSupportGotoVideoRecheckScene>
<isSupportVideoRecheckRuleParams>

C. arc
true
</isSupportVideoRecheckRuleParams>
<isSupportVideoRecheckSceneList>

s, em
true

A
</isSupportVideoRecheckSceneList>

no fr
<isSupportPeopleSedentary>
true
</isSupportPeopleSedentary>

ri on
<isSupportPeopleFallingDownDetection>
true

Ma oc
</isSupportPeopleFallingDownDetection>
<isSupportBridgeDeflectionTargetCalibration>
true
</isSupportBridgeDeflectionTargetCalibration>
<isSupportGetBridgeDeflectionTargetCalibrationStatus>
co gr

true
</isSupportGetBridgeDeflectionTargetCalibrationStatus>
es a@

<isSupportBridgeDeflectionMonitoringRuleParams>
<!--ro, opt, bool, whether the device supports the rule parameters of bridge deflection monitoring, desc:GET/PUT
Fr rc

/ISAPI/Intelligent/channels/<channelID>/BridgeDeflectionMonitoringRuleParams?format=json-->true
s

</isSupportBridgeDeflectionMonitoringRuleParams>
<isSupportHardwareReboot>
y ema

true
</isSupportHardwareReboot>
<isSupportSearchSceneCalibrationStatus>
<!--ro, opt, bool, whether the device supports searching for calibration status of multiple channels by scene, desc:POST
os fr

/ISAPI/System/setupCalibration/channels/<channelID>/SearchSceneCalibrationStatus?format=json-->true
</isSupportSearchSceneCalibrationStatus>
<isSupportSearchSceneCalibration>
ad on

true
el .c

</isSupportSearchSceneCalibration>
<isSupportSoundSourceLocationRuleParams>
<!--ro, opt, bool, whether the device supports rule parameters of sound source locating, desc:GET/PUT
ez

/ISAPI/System/SoundSourceLocation/AudioIn/<AudioInID>/SoundSourceLocationRuleParams?format=json-->true
</isSupportSoundSourceLocationRuleParams>
<isSupportPersonnelChannelLogDebug>
en

true
im

</isSupportPersonnelChannelLogDebug>
<isSupportCheckDeviceExistNUCFile>
ng

<!--ro, opt, bool, whether the device supports checking the locally stored the NUC file, desc:GET
Aj

/ISAPI/System/VideoQualityMeasurementCollection/channels/<channelID>/CheckDeviceExistNUCFile?format=json-->true
</isSupportCheckDeviceExistNUCFile>
Co

<isSupportExportSmartDataData>
true
</isSupportExportSmartDataData>
<isSupportGetCollectImageCalculateResult>
true
</isSupportGetCollectImageCalculateResult>
<isSupportAIOPAlarmTrans>
true
</isSupportAIOPAlarmTrans>
<isSupportLongDistanceRace>
true
</isSupportLongDistanceRace>
<isSupportIndicatorLightAbnormal>
true
</isSupportIndicatorLightAbnormal>
<isSupportVideoLostPictureStatus>
true
</isSupportVideoLostPictureStatus>
<DualVCA>

<isSupportdualVCAList>
true
</isSupportdualVCAList>
<enabled opt="true,false" def="true">
true
</enabled>
</DualVCA>
<isSupportGetScopeCalibrationStatus>
true
</isSupportGetScopeCalibrationStatus>

m
<isSupportSearchShootTableUserGroupParams>

co
true
</isSupportSearchShootTableUserGroupParams>

a.
<isSupportModifyCurrentShootTableParams>
true

C. arc
</isSupportModifyCurrentShootTableParams>
<isSupportCalibrateScopeTargetPointPosition>
true

s, em
</isSupportCalibrateScopeTargetPointPosition>
<isSupportGetCurrentShootTableParams>

A
<!--ro, opt, bool, whether the device supports getting the information of the current valid zeroing profiles, desc:GET

no fr
/ISAPI/Intelligent/channels/<channelID>/GetCurrentShootTableParams?format=json-->true
</isSupportGetCurrentShootTableParams>

ri on
<isSupportVideoGunsightRuleParam>
true

Ma oc
</isSupportVideoGunsightRuleParam>
<isSupportFinishCollectImageData>
true
</isSupportFinishCollectImageData>
co gr

<isSupportStartCollectImageData>
true
es a@

</isSupportStartCollectImageData>
<isSupportSearchBridgeDeflectionMonitoringEvent>
true
Fr rc

</isSupportSearchBridgeDeflectionMonitoringEvent>
<isSupportGetAllPIPCofigParams>
y ema

true

</isSupportGetAllPIPCofigParams>
<isSupportManualDetectionCarriageClearStatus>
true
os fr

</isSupportManualDetectionCarriageClearStatus>
<isSupportGetCarriageClearCalibrationStatus>
true
ad on

</isSupportGetCarriageClearCalibrationStatus>
<isSupportModifyCarriageClearCalibration>
true
el .c

</isSupportModifyCarriageClearCalibration>
<isSupportCarriageClearRuleParams>
ez

true

</isSupportCarriageClearRuleParams>
<isSupportRadarFallenObjectsOnTracks>
en

true

</isSupportRadarFallenObjectsOnTracks>
<isSupportTemperatureRiseCalibrationParams>
im

true

</isSupportTemperatureRiseCalibrationParams>
ng

<isSupportStartTemperatureRiseCalibration>
Aj

true

</isSupportStartTemperatureRiseCalibration>
<isSupportGetTemperatureRiseCalibrationStatus>
true
</isSupportGetTemperatureRiseCalibrationStatus>
<isSupportExportTemperatureRiseCalibrationFile>
true
</isSupportExportTemperatureRiseCalibrationFile>
<isSupportGetTemperatureRiseCorrectionVersion>
true
</isSupportGetTemperatureRiseCorrectionVersion>
<isSupportSearchImportDeviceDataTaskProgress>
true
</isSupportSearchImportDeviceDataTaskProgress>
<isSupportSearchExportDeviceDataTaskProgress>
true
</isSupportSearchExportDeviceDataTaskProgress>
<isSupportAddImportDeviceDataTask>
true
</isSupportAddImportDeviceDataTask>
<isSupportAddExportDeviceDataTask>
true
</isSupportAddExportDeviceDataTask>
<isSupportSearchRecordStorage>
true
true
</isSupportSearchRecordStorage>
<isSupportDetectionPathRuleParams>
true
</isSupportDetectionPathRuleParams>
<isSupportSearchObjectDistanceFocusInfoList>
true
</isSupportSearchObjectDistanceFocusInfoList>
<isSupportMoveObjectDistanceFocusLocation>
true
</isSupportMoveObjectDistanceFocusLocation>
<isSupportAddObjectDistanceFocusInfo>
true
</isSupportAddObjectDistanceFocusInfo>
<isSupportModifyObjectDistanceFocusInfo>
true

m
</isSupportModifyObjectDistanceFocusInfo>
<isSupportObjectDistanceCalibrateAutoFocusParams>

co
true
</isSupportObjectDistanceCalibrateAutoFocusParams>
<isSupportExpresswayNetworkTollAccessParams>

a.
true
</isSupportExpresswayNetworkTollAccessParams>

C. arc
<isSupportControlCameraDetectAction>
true
</isSupportControlCameraDetectAction>
<isSupportObjectDistanceAccessWay>

s, em
true
</isSupportObjectDistanceAccessWay>

A
<isSupportCancelTemperatureRiseCalibration>

no fr
true
</isSupportCancelTemperatureRiseCalibration>
<isSupportRTCTimeTrigger>

ri on
true
</isSupportRTCTimeTrigger>

Ma oc
<isSupportChargingGunAbnormalEvent>
true
</isSupportChargingGunAbnormalEvent>
up
<isSupportVideoChannelEnhance>
true
</isSupportVideoChannelEnhance>
co gr

<isSupportDeleteObjectDistanceFocusInfo>
true
es a@

</isSupportDeleteObjectDistanceFocusInfo>
<isSupportGetStartTemperatureRiseCalibrationParams>
true
Fr rc

</isSupportGetStartTemperatureRiseCalibrationParams>
s

<isSupportSearchAudioRecordPlan>
true
y ema

</isSupportSearchAudioRecordPlan>
<isSupportCleanerDetectionOverlapParams>
true
</isSupportCleanerDetectionOverlapParams>
os fr

<isSupportWaterLevelVerticalAreaDisplayParams>
true
</isSupportWaterLevelVerticalAreaDisplayParams>
ad on

<isSupportGetRecordStatusList>
true
el .c

</isSupportGetRecordStatusList>
<isSupportWiperClean>
true
ez

</isSupportWiperClean>
<isSupportGetNATStatus>
true
en

</isSupportGetNATStatus>
<isSupportRestoreSensitivityDefaultParams>
im

true

</isSupportRestoreSensitivityDefaultParams>
ng

<isSupportCarryPassengersPricingStatus>
Aj

true

</isSupportCarryPassengersPricingStatus>
Co

m
<isSupportGetRadarVideoTargetTrackingStatus>

co
true
</isSupportGetRadarVideoTargetTrackingStatus>
<isSupportStartRadarVideoTargetTracking>

a.
true
</isSupportStartRadarVideoTargetTracking>
<isSupportBatteryChargeCtrl>

C. arc
true
</isSupportBatteryChargeCtrl>
<isUpgrageAuxDevice opt="true,false">
true

s, em
</isUpgrageAuxDevice>

A
<isSupportClearFile>

no fr
true
</isSupportClearFile>
<isSupportRestoreDefaultParamByChannel>

ri on
true
</isSupportRestoreDefaultParamByChannel>
<isSupportGetMultispectralCalibrationParams>

Ma oc
true
</isSupportGetMultispectralCalibrationParams>
up
<isSupportGetThermometryCalibrationData>
true
</isSupportGetThermometryCalibrationData>
co gr

<isSupportImportEncryptedComponentFile>
true
</isSupportImportEncryptedComponentFile>
es a@

<isSupportGetFrameMeanValue>
true
</isSupportGetFrameMeanValue>
Fr rc

<isSupportGetBaffleImage>
true
y ema

</isSupportGetBaffleImage>
<isSupportThermometryGainMode>
true
</isSupportThermometryGainMode>
os fr

<isSupportGetChannelEnhancePreOperationTips>
true
</isSupportGetChannelEnhancePreOperationTips>
ad on

<isSupportGetDeviceNetworkLinkStatus>
true
</isSupportGetDeviceNetworkLinkStatus>
el .c

<isSupportManualRefreshOnlineUserList>
true
ez

</isSupportManualRefreshOnlineUserList>
<isSupportVCAAlarmTrans>
true
en

</isSupportVCAAlarmTrans>
<isSupportHumidityEvent>
true
im

</isSupportHumidityEvent>
ng

<isSupportHumidityDetectionParams>
Aj

true

</isSupportHumidityDetectionParams>
Co

m
<isSupportPosOverlayTest>
true

co
</isSupportPosOverlayTest>
<isSupportFullScreenPosOverlay>

a.
true
</isSupportFullScreenPosOverlay>
<isSupportVCAOptimizeDisplay>

C. arc
true
</isSupportVCAOptimizeDisplay>
<isSupportAddInsulatorGroup>
true

s, em
</isSupportAddInsulatorGroup>
<isSupportSearchInsulatorParams>

A
true

no fr
</isSupportSearchInsulatorParams>
<isSupportSetInsulatorParams>

ri on
true
</isSupportSetInsulatorParams>
<isSupportInsulatorAbnormalAlarm>

Ma oc
true
</isSupportInsulatorAbnormalAlarm>
<isSupportGetFlashLifespanInfo>
up
true
</isSupportGetFlashLifespanInfo>
<isSupportCrowdDispersing>
co gr

true

</isSupportCrowdDispersing>
es a@

<isSupportPeripheralAbnormalEvent>
true
</isSupportPeripheralAbnormalEvent>
Fr rc

<isSupportPeripheralAbnormalTrigger>
true
</isSupportPeripheralAbnormalTrigger>
y ema

<isSupportBodyCameraAbnormalEvent>
true
</isSupportBodyCameraAbnormalEvent>
<isSupportDeviceWorkModeAsyncStatusEvent>
os fr

true

</isSupportDeviceWorkModeAsyncStatusEvent>
ad on

<isSupportDeviceUserAsyncStatusEvent>
true
</isSupportDeviceUserAsyncStatusEvent>
el .c

<isSupportVideoCodingAsyncStatusEvent>
true
</isSupportVideoCodingAsyncStatusEvent>
ez

<isSupportRecordAsyncStatusEvent>
true
en

</isSupportRecordAsyncStatusEvent>
<isSupportISUPAccessAsyncStatusEvent>
true
im

</isSupportISUPAccessAsyncStatusEvent>
<isSupportWirelessConfigListAsyncStatusEvent>
ng

true

</isSupportWirelessConfigListAsyncStatusEvent>
<isSupportDeviceLocationAsyncStatusEvent>
Co

true

</isSupportDeviceLocationAsyncStatusEvent>
<isSupportVideoCodingAsyncParams>
true
</isSupportVideoCodingAsyncParams>
<isSupportMoveShield>
true
</isSupportMoveShield>
<isSupportStopAutoGenerateShield>
true
</isSupportStopAutoGenerateShield>
<isSupportStartGenerateParams>
true
</isSupportStartGenerateParams>
<isSupportIntelligentShieldAlgorithmsVersion>
true
</isSupportIntelligentShieldAlgorithmsVersion>
<isSupportConvertShield>
true
</isSupportConvertShield>
<isSupportDeleteShield>
true
</isSupportDeleteShield>
</isSupportDeleteShield>
<isSupportGetGenerateParams>
true
</isSupportGetGenerateParams>
<isSupportManualAddShield>
true
</isSupportManualAddShield>
<isSupportIntelligentShieldParams>
true
</isSupportIntelligentShieldParams>
<isSupportIntelligentShieldListParams>
true
</isSupportIntelligentShieldListParams>
<isSupportDeicingCfg>
true
</isSupportDeicingCfg>
</DeviceCap>

m
co
16.1.9.4 Get the languages supported by the device

a.
Request URL

C. arc
GET /ISAPI/System/DeviceLanguage
Query Parameter

s, em
A
None

no fr
Request Message

ri on
None

Ma oc
Response Message up
<?xml version="1.0" encoding="UTF-8"?>
co gr

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

<language>
es a@

<!--ro, req, enum, language, subType:string, desc:"SimChinese" (simplified Chinese), "TraChinese" (traditional Chinese), "English", "Russian",
"Bulgarian", "Hungarian", "Greek", "German", "Italian", "Czech", "Slovakia", "French", "Polish", "Dutch", "Portuguese", "Spanish", "Romanian", "Turkish",
"Japanese", "Danish", "Swedish", "Norwegian", "Finnish", "Korean", "Thai", "Estonia", "Vietnamese", "Hebrew", "Latvian", "Arabic", "Sovenian"-Slovenian,
Fr rc

"Croatian", "Lithuanian", "Serbian", "BrazilianPortuguese"-Brazilian Portuguese, "Indonesian", "Ukrainian", "EURSpanish", "Sovenian", "Uzbek", "Kazak",
"Kirghiz", "Farsi", "Azerbaidzhan", "Burmese", "Mongolian"-->SimChinese
y ema

</language>
</DeviceLanguage>
os fr

16.1.9.5 Set device language parameters

ad on

Request URL
el .c

PUT /ISAPI/System/DeviceLanguage
Query Parameter
ez

None
en

Request Message
im
ng

<?xml version="1.0" encoding="UTF-8"?>

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

<language>
SimChinese
</language>
</DeviceLanguage>

Response Message
<?xml version="1.0" encoding="UTF-8"?>

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

<requestURL>
null
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
OK

m
</statusString>
<subStatusCode>

co
OK
</subStatusCode>
</ResponseStatus>

a.
C. arc
16.1.9.6 Get the capability of configuring the device language
Request URL

s, em
A
GET /ISAPI/System/DeviceLanguage/capabilities

no fr
Query Parameter

ri on
None

Ma oc
Request Message
None
up
Response Message
co gr

<?xml version="1.0" encoding="UTF-8"?>

es a@

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

Fr rc

<language
opt="SimChinese,TraChinese,English,Russian,Bulgarian,Hungarian,Greek,German,Italian,Czech,Slovakia,French,Polish,Dutch,Portuguese,Spanish,Romanian,Turkish,J
y ema

apanese,Danish,Swedish,Norwegian,Finnish,Korean,Thai,Estonia,Vietnamese,Hebrew,Latvian,Arabic,Sovenian,Croatian,Lithuanian,Serbian,BrazilianPortuguese,Indon
esian,Ukrainian,EURSpanish,Uzbek,Kazak,Kirghiz,Farsi,Azerbaidzhan,Burmese,Mongolian,Anglicism,Estonian">
<!--ro, req, enum, language, subType:string, attr:opt{req, string}, desc:"SimChinese" (simplified Chinese), "TraChinese" (traditional Chinese),
"English", "Russian", "Bulgarian", "Hungarian", "Greek", "German", "Italian", "Czech", "Slovakia", "French", "Polish", "Dutch", "Portuguese", "Spanish",
os fr

"Romanian", "Turkish", "Japanese", "Danish", "Swedish", "Norwegian", "Finnish", "Korean", "Thai", "Estonia", "Vietnamese", "Hebrew", "Latvian", "Arabic",
"Sovenian"-Slovenian, "Croatian", "Lithuanian", "Serbian", "BrazilianPortuguese"-Brazilian Portuguese, "Indonesian", "Ukrainian", "EURSpanish", "Sovenian",
"Uzbek", "Kazak", "Kirghiz", "Farsi", "Azerbaidzhan", "Burmese", "Mongolian"-->SimChinese
ad on

</language>
<upgradeFirmWareEnabled>
true
el .c

</upgradeFirmWareEnabled>
</DeviceLanguage>
ez
en

16.1.9.7 Set restoring devices' default parameters

Request URL
ng

PUT /ISAPI/System/factoryReset?mode=<mode>&childDevID=<devIndex>&loginPassword=<loginPassword>
Aj
Co

Query Parameter
Parameter Name Parameter Type Description
mode enum --
devIndex string --
loginPassword string --
security string --
iv string --
Request Message
None
Response Message

<?xml version="1.0" encoding="UTF-8"?>

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

m
OK

co
</statusString>
<subStatusCode>

a.
OK
</subStatusCode>
</ResponseStatus>

C. arc
16.1.9.8 Get the network service capability

s, em
A
Request URL

no fr
GET /ISAPI/System/Network/capabilities

ri on
Query Parameter

Ma oc
None
Request Message
up
None
co gr

Response Message
es a@

<?xml version="1.0" encoding="UTF-8"?>

Fr rc

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

y ema

<isSupportWireless>
true
</isSupportWireless>
<isSupportWired>
os fr

true

</isSupportWired>
<isSupportMobileNetwork>
ad on

true

</isSupportMobileNetwork>
el .c

<isSupportWAN>
true
</isSupportWAN>
ez

<isSupportPPPoE>
true
</isSupportPPPoE>
en

<isSupportBond>
true
im

</isSupportBond>
<isSupport802_1x>
ng

true

</isSupport802_1x>
<isSupportNtp>
Co

true
</isSupportNtp>
<isSupportFtp>
true
</isSupportFtp>
<isSupportUpnp>
true
</isSupportUpnp>
<isSupportPNP>
true
</isSupportPNP>
<isSupportDdns>
true
</isSupportDdns>
<isSupportHttps>
true
</isSupportHttps>
<isSupport28181>
true
</isSupport28181>
<SnmpCap>

<isSupport>
true
</isSupport>
</SnmpCap>
<isSupportExtNetCfg>
true
</isSupportExtNetCfg>
<isSupportIPFilter>
true
</isSupportIPFilter>
<isSupportSSH>
true
</isSupportSSH>
<isSupportNetPreviewStrategy>
true
</isSupportNetPreviewStrategy>
<isSupportEZVIZ>

m
true

co
</isSupportEZVIZ>
<isSupportEhome>
true

a.
</isSupportEhome>
<isSupportWirelessDial>
true

C. arc
</isSupportWirelessDial>
<isSupportWirelessServer>
true
</isSupportWirelessServer>

s, em
<isSupportWPS>
true

A
</isSupportWPS>

no fr
<isWirelessMutexWithWirelessServer>
true

ri on
</isWirelessMutexWithWirelessServer>
<isSupportMACFilter>
true

Ma oc
</isSupportMACFilter>
<GB28181Cap>

up
<isSupportGB28181Service>
true
co gr

</isSupportGB28181Service>
</GB28181Cap>
<WPS>
es a@

<NetworkInterfaceList size="2">

Fr rc

<NetworkInterface>

y ema

<id>
test
</id>
<enabled>
os fr

true

</enabled>
<isSupportAutoConnect>
ad on

true

</isSupportAutoConnect>
<isSupportDevicePinCode>
el .c

true

</isSupportDevicePinCode>
ez

<isSupportDevicePinCodeUpdate>
true
</isSupportDevicePinCodeUpdate>
en

<ApPinCode>

<ssid min="1" max="10">
im

test
</ssid>
ng

<pinCode min="1" max="10">

test

</pinCode>
</ApPinCode>
</NetworkInterface>
</NetworkInterfaceList>
</WPS>
<isSupportRFIDData>
true
</isSupportRFIDData>
<isSupportwifiProbeSSID>
true
</isSupportwifiProbeSSID>
<isSupportWifiProbe>
true
</isSupportWifiProbe>
<verificationCode min="1" max="10">
test
</verificationCode>
<WPSCap>

<isSupport>
true
</isSupport>
<isSupportAutoConnect>
true
true
</isSupportAutoConnect>
</WPSCap>
<NetWorkMode>

<workMode>
close
</workMode>
</NetWorkMode>
<VerificationCodeModification>

<verificationCodeType opt="normal,empty">
test
</verificationCodeType>
<isSupportDeclarationURL>
true

m
</isSupportDeclarationURL>
<isSupportPrivacyPolicyURL>

co
true
</isSupportPrivacyPolicyURL>
<verificationCodeModify opt="true,false">

a.
true
</verificationCodeModify>

C. arc
<Hyperlinks>

<declarationURL>
test

s, em
</declarationURL>
<privacyPolicyURL>

A
test

no fr
</privacyPolicyURL>
</Hyperlinks>
<isSupportVerificationCodeCheck>

ri on
true
</isSupportVerificationCodeCheck>

Ma oc
<isSupportOldVerificationCode>
<!--ro, opt, bool, whether the device supports the EZ password configuration of old version (the password of old version consists of six characters)--
>true
up
</isSupportOldVerificationCode>
</VerificationCodeModification>
<isSupportIntegrate>
co gr

true
</isSupportIntegrate>
es a@

<isSupportPlatformAccess>
true
</isSupportPlatformAccess>
Fr rc

<isSupportIntelligentBoost>
s

true

</isSupportIntelligentBoost>
y ema

<WifiRegionConfiguration>

<isSupportWifiRegion>
<!--ro, opt, bool, whether the device supports wifi area configuration, desc:supported by overseas devices; true (support), this node is not returned
os fr

(not support)-->true
</isSupportWifiRegion>
<isSupportWifiEnhancement>
ad on

true
</isSupportWifiEnhancement>
el .c

</WifiRegionConfiguration>
<isSupportResourceStatistics>
true
ez

</isSupportResourceStatistics>
<isSupportBandwidthLimit>
true
en

</isSupportBandwidthLimit>
<isSupportPOEPortsDisableAdaptiveServer>
im

true
</isSupportPOEPortsDisableAdaptiveServer>
ng

<isSupportPOEConfiguration>
Aj

true
</isSupportPOEConfiguration>
Co

m
true

co
</isSupportTrafficMonitor>
<isSupportPingWatchdog>
true

a.
</isSupportPingWatchdog>
<isSupportAutoFrequencyHop>
true

C. arc
</isSupportAutoFrequencyHop>
<isSupportTDMACfg>
true
</isSupportTDMACfg>

s, em
<isSupportDynamicChannel>

A
true

no fr
</isSupportDynamicChannel>
<isSupportSIMCardSwitch>
<!--ro, opt, bool, whether the device supports configuring scheduled SIM card switch, desc:Related URI:

ri on
/ISAPI/System/Network/WirelessDial/SIMCardSwitch?format=json-->true
</isSupportSIMCardSwitch>
<isSupportDMSAuthInfo>

Ma oc
true
</isSupportDMSAuthInfo>
up
<isSupportWiredandWirelessTrafficMonitor>
true
</isSupportWiredandWirelessTrafficMonitor>
co gr

<isSupport4G>
true
</isSupport4G>
es a@

<isSupport4GConfig>
true
</isSupport4GConfig>
Fr rc

<isSupportGRIDServer>
true
y ema

</isSupportGRIDServer>
<isSupportGRIDInfo>
true
</isSupportGRIDInfo>
os fr

<isSupportSipTransmit>
true
</isSupportSipTransmit>
ad on

<isSupportSip>
true
</isSupportSip>
el .c

<isSupportWifiCascade>
true
ez

</isSupportWifiCascade>
<isSupportRelativeInfo>
true
en

</isSupportRelativeInfo>
<isSupportANR>
true
im

</isSupportANR>
ng

<isSupportEmailEncrypt>
Aj

true
</isSupportEmailEncrypt>
Co

<isSupportPortFilter>
true
</isSupportPortFilter>
<isSupportPingDeny>
true
</isSupportPingDeny>
<isSupportDOSDeny>
true
</isSupportDOSDeny>
<isSupportNetworkStatus>
true
</isSupportNetworkStatus>
<isSupportEZVIZQRcode>
true
</isSupportEZVIZQRcode>
<isSupportEZVIZUnbind>
true
</isSupportEZVIZUnbind>
<isSupportPingTest>
true
</isSupportPingTest>
<isSupportMOTCloudPlateform>
true
/ISAPI/System/Network/Traffic/MOTCloudPlateform/capabilities?format=json-->true
</isSupportMOTCloudPlateform>
<isSupportSpectrumScan>
true
</isSupportSpectrumScan>
<isSupportFRP>
true
</isSupportFRP>
<isSupport5GModule>
true
</isSupport5GModule>
<isSupportWirelessDialRoute>
true
</isSupportWirelessDialRoute>

m
<isSupportNPlusOne>
true

co
</isSupportNPlusOne>
<supportEnvironmentalStandards opt="HJ212">

a.
true
</supportEnvironmentalStandards>
<isSupportIntranetSegment>

C. arc
true
</isSupportIntranetSegment>

s, em
<isSupportDHCPServer>
<!--ro, opt, bool, whether the device supports DHCP service configuration, desc:if this function is supported, this node will be returned and its value

A
is true; otherwise, this node will be returned and its value is false or not be returned. Related URI: /ISAPI/System/Network/DHCPServer/capabilities?

no fr
format=json-->true
</isSupportDHCPServer>

ri on
<isSupportClusterIntercom>
<!--ro, opt, bool, whether the 7200 intercom protocol is transmitted, desc:if this function is supported, this node will be returned and its value is
true; otherwise, this node will be returned and its value is false or not be returned. Related URI: /ISAPI/System/Network/clusterIntercom/capabilities?

Ma oc
format=json-->true
</isSupportClusterIntercom>
<isSupportHydrologicMonitoring>
up
true
co gr

</isSupportHydrologicMonitoring>
<isSupportGantryETCServer>
es a@

true

</isSupportGantryETCServer>
<RoutePolicy>
Fr rc

<isSupportRoutePolicy>
true
y ema

</isSupportRoutePolicy>
<isRebootHint>
true
</isRebootHint>
os fr

</RoutePolicy>
<isWirelessDialMutexWithWlanAndWifi>
ad on

true
</isWirelessDialMutexWithWlanAndWifi>
<isSupportDMZCfg>
el .c

true
</isSupportDMZCfg>
<isSupportSpeechTranscription>
ez

<!--ro, opt, bool, whether the device supports accessing the speech-to-text transcription platform, desc:if this function is supported, this node will
be returned and its value is true; otherwise, this node will be returned and its value is false or not be returned. Related URI:
en

/ISAPI/System/Network/speechTranscriptionPlatform/capabilities?format=json-->true
</isSupportSpeechTranscription>
<isSupportAsynPingTest>
im

<!--ro, opt, bool, whether the device supports asynchronous network detection, desc:network detection means testing the network stability and packet
loss rate of the network using the ping command for knowing about the network condition. Related URI: /ISAPI/System/Network/asynPingTest/capabilities?
ng

format=json-->true
Aj

</isSupportAsynPingTest>
<isSupportBasebandCapture>
Co

true
</isSupportBasebandCapture>
<isSupportCellularNetworkSpeedTest>
true
</isSupportCellularNetworkSpeedTest>
<isSupportCellularNetworkCellInfo>
true
</isSupportCellularNetworkCellInfo>
<isSupportMultiBandFrequencyScanning>
true
</isSupportMultiBandFrequencyScanning>
<isSupportCellularNetworkLockBand>
true
</isSupportCellularNetworkLockBand>
<isSupportRadioFrequencyFluctuation>
true
</isSupportRadioFrequencyFluctuation>
</isSupportRadioFrequencyFluctuation>
<isSupportBasebandBlock>
true
</isSupportBasebandBlock>
<isSupportWifiQuality>
true
</isSupportWifiQuality>
<isSupportWiredNetworkQuality>
true
</isSupportWiredNetworkQuality>
<isSupportQoSBehaviorCfg>
true
</isSupportQoSBehaviorCfg>

m
<isSupportQoSClassifierCfg>

co
true
</isSupportQoSClassifierCfg>

a.
<isSupportQoSPolicyCfg>
<!--ro, opt, bool, whether the device supports configuring QoS policy, desc:Related URI: /ISAPI/System/Network/qos/PolicyCfg/capabilities?format=json--
>true

C. arc
</isSupportQoSPolicyCfg>
<isSupportQoSPolicyVLANCfg>
true

s, em
</isSupportQoSPolicyVLANCfg>

A
<isSupportQoSPortRateLimiting>

no fr
true
</isSupportQoSPortRateLimiting>

ri on
<isSupportQoSQueueAlgorithmCfg>
true

Ma oc
</isSupportQoSQueueAlgorithmCfg>
<isSupportQoSPortPriorityCfg>
up
true
</isSupportQoSPortPriorityCfg>
co gr

<isSupportQoS802.1pPriorityMapping>
true
es a@

</isSupportQoS802.1pPriorityMapping>
<isSupportQoSDSCPPriorityMapping>
Fr rc

<!--ro, opt, bool, whether the device supports DSCP mapping priority configuration, desc:Related URI:
s

/ISAPI/System/Network/qos/DSCPPriorityMapping/capabilities?format=json-->true
</isSupportQoSDSCPPriorityMapping>
y ema

<isSupportQoSLoaclPriorityMapping>
true
</isSupportQoSLoaclPriorityMapping>
os fr

<isSupportStopPingtest>
true
</isSupportStopPingtest>
ad on

<isSupportSNMPView>
true
</isSupportSNMPView>
el .c

<isSupportSNMPUserGroup>
true
ez

</isSupportSNMPUserGroup>
<isSupportSNMPBasicInfo>
<!--ro, opt, bool, whether the device supports the basic information of SNMP, desc:Related URI: /ISAPI/System/Network/SNMP/BasicInfo/capabilities?
en

format=json-->true
</isSupportSNMPBasicInfo>
<isSupportRFIDTagCheckTest>
im

<!--ro, opt, bool, whether the device supports the RFID tag disk storage performance test, desc:Related URI:
ng

/ISAPI/System/Network/RFIDData/GetTagCheckTestInfo?format=json-->true
Aj

</isSupportRFIDTagCheckTest>
<isSupportQoSDSCPtoLoaclPriorityMapping>
Co

true
</isSupportQoSDSCPtoLoaclPriorityMapping>
<isSupportQoS802.1pto802.1pPriorityMapping>
true
</isSupportQoS802.1pto802.1pPriorityMapping>
<isSupportNFCAllowList>
true
</isSupportNFCAllowList>
<isSupportLinkTestStart>
true
</isSupportLinkTestStart>
<isSupportLinkTestResult>
true
</isSupportLinkTestResult>
<isSupportGetAsynTestEmailResult>
true
</isSupportGetAsynTestEmailResult>
<isSupportTestAsynEmail>
<isSupportTestAsynEmail>
true
</isSupportTestAsynEmail>
<isSupportModbusAccess>
true
</isSupportModbusAccess>
<isSupportNetworkModuleUpgrade>
true
</isSupportNetworkModuleUpgrade>
<isSupportNetworkModuleVersionInfo>
true

m
</isSupportNetworkModuleVersionInfo>
<isSupportGreenShieldPlatform>

co
true
</isSupportGreenShieldPlatform>

a.
<isSupportFusionUniversalApplicationPlatCfg>
true
</isSupportFusionUniversalApplicationPlatCfg>

C. arc
<isSupportNPQControlStrategy>
true
</isSupportNPQControlStrategy>
<isSupportNAT>

s, em
true
</isSupportNAT>

A
<isSupportGetCurrentlyUsingNetworkCardInfo>

no fr
true

ri on
</isSupportGetCurrentlyUsingNetworkCardInfo>
<isSupportAutoRecampParams>
<!--ro, opt, bool, whether the device supports parameters of auto re-camping on a regular basis, desc:GET/PUT

Ma oc
/ISAPI/System/Network/WirelessDial/AutoRecampParams?format=json-->true
</isSupportAutoRecampParams>
<isSupportDSTPServerCfg>
up
true
co gr

</isSupportDSTPServerCfg>
<isSupportJTT1008ServerParams>
true
es a@

</isSupportJTT1008ServerParams>
<isSupportImportNARIKeyFile>
true
Fr rc

</isSupportImportNARIKeyFile>
<isSupportExportNARIKeyFile>
true
y ema

</isSupportExportNARIKeyFile>
<isSupportNARIEncryptionParams>
true
</isSupportNARIEncryptionParams>
os fr

<isSupportDSTPProtocolsCap>
true
ad on

</isSupportDSTPProtocolsCap>
<isSupportIPAdaptiveParams>
<!--ro, opt, bool, whether the device supports self-adaptive IP address parameters, desc:GET/PUT /ISAPI/System/Network/IPAdaptiveParams?format=json--
el .c

>true
</isSupportIPAdaptiveParams>
<isSupportPowerCenterPlatform>
ez

true

</isSupportPowerCenterPlatform>
en

<isSupportTestPowerCenterPlatformConnect>
true
</isSupportTestPowerCenterPlatformConnect>
im

<isSupportModbusTestSubordinateStatus>
<!--ro, opt, bool, whether the device supports Modbus testing the status of the specified client., desc:POST
ng

/ISAPI/System/Network/ModbusTestSubordinateStatus?format=json-->true
Aj

</isSupportModbusTestSubordinateStatus>
Co

16.1.9.9 Set SSH parameters

Request URL
PUT /ISAPI/System/Network/ssh?readerID=<readerID>
Query Parameter
Parameter Name Parameter Type Description

m
co
readerID string --

a.
Request Message

C. arc
<?xml version="1.0" encoding="UTF-8"?>

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

s, em

<enabled>

A
true

no fr
</enabled>
<port>

ri on
22
</port>
</SSH>

Ma oc
up
Response Message
co gr

<?xml version="1.0" encoding="UTF-8"?>

es a@

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

<requestURL>
Fr rc

null

</requestURL>
<statusCode>
y ema

<!--ro, req, enum, read-only,status description: OK,Device Busy,Device Error,Invalid Operation,Invalid XML Format,Invalid XML Content,Reboot,Additional
Error, subType:string, desc:"OK" (succeeded), "Device Busy", "Device Error", "Invalid Operation", "Invalid XML Format", "Invalid XML Content", "Reboot"
ad on

(reboot device)-->OK
</statusString>
<subStatusCode>
el .c

OK
</subStatusCode>
</ResponseStatus>
ez
en

16.1.9.10 Reboot device

Request URL
ng
Aj

PUT /ISAPI/System/reboot?childDevID=<devIndex>&module=<module>
Co

Query Parameter
Parameter Name Parameter Type Description
devIndex string --
module string --
Request Message
None
Response Message
<?xml version="1.0" encoding="UTF-8"?>

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

m
</statusString>
<subStatusCode>

co
OK
</subStatusCode>
</ResponseStatus>

a.
C. arc
16.1.9.11 Get the video analysis task capability
Request URL

s, em
A
GET /ISAPI/System/Video/capabilities

no fr
Query Parameter

ri on
None

Ma oc
Request Message
None
up
Response Message
co gr

<?xml version="1.0" encoding="UTF-8"?>

es a@

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

Fr rc

<videoInputPortNums>
0
y ema

</videoInputPortNums>
<videoOutputPortNums>
0
</videoOutputPortNums>
os fr

<menuNums>
0
</menuNums>
ad on

<externalChannelNum>
true
</externalChannelNum>
el .c

<isSupportHeatmap>
true
ez

</isSupportHeatmap>
<isSupportCounting>
true
en

</isSupportCounting>
<countingType>
human
im

</countingType>
ng

<isSupportPicture>
Aj

<!--ro, opt, bool, whether the device supports OSD picture overlay, desc:related URI: /ISAPI/System/Video/inputs/channels/<channelID>/image/picture--
>true
Co

</isSupportPicture>
<isSupportPreviewSwitch>
true
</isSupportPreviewSwitch>
<isSupportRecodStatus>
true
</isSupportRecodStatus>
<isSupportPrivacyMask>
true
</isSupportPrivacyMask>
<isSupportBinocularPreviewSwitch>
true
</isSupportBinocularPreviewSwitch>
<isSupportCalibCheck>
true
</isSupportCalibCheck>
<isSupportPIP>
true
</isSupportPIP>
<isSupportFocusVideoMode>
true
</isSupportFocusVideoMode>
<isSupportExternalChannel>
true
true
</isSupportExternalChannel>
<isSupportMultiChannelCounting>
true
</isSupportMultiChannelCounting>
<isSupportCountingCollection>
true
</isSupportCountingCollection>
<isSupportHeatmapCollection>
true
</isSupportHeatmapCollection>
<channelFlexible opt="name,enable,online,linknum">
name
</channelFlexible>
<isSupportOutputsResource>
<!--ro, opt, bool, related URI: /ISAPI/System/Video/outputs/resource?format=json, desc:related URI: /ISAPI/System/Video/outputs/resource?format=json--

m
>true
</isSupportOutputsResource>

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

a.
</OSDLanguage>
<isSupportMixedChannel>
true

C. arc
</isSupportMixedChannel>
<isSupportMixedChannelStatus>
true
</isSupportMixedChannelStatus>

s, em
<isSupportOutputCourseware>
<!--ro, opt, bool, related URI: /ISAPI/System/Video/outputs/courseware/capabilities?format=json, desc:related URI:

A
/ISAPI/System/Video/outputs/courseware/capabilities?format=json-->true

no fr
</isSupportOutputCourseware>
<isSupportVideoInputMode>

ri on
true
</isSupportVideoInputMode>
<isSupportVideoOutputMode>

Ma oc
<!--ro, opt, bool, related URI: /ISAPI/System/Video/outputs/mode/capabilities?format=json, desc:related URI:
/ISAPI/

Face Recognition Dev Guide Clean

Uploaded by

Face Recognition Dev Guide Clean

Uploaded by

Aj

2.1.1 Application Scenario

2.1.2 Layers in the Network Model

K1T670MFWX, DS-K1T670MWX-QR, DS-K1T670MX, DS-K1T670MX-QR, DS-K1T671, DS-K1T671AM, DS-

K1T673DWX, DS-K1T673DX, DS-K1T6Q-F71M, DS-K1T6QT-F72DWX, DS-K1T6QT-F72DX, DS-K1TA70MI-T

2.3 Terms And Definitions

2.3.5 Listening Host

2.3.7 Push Mode

2.3.20 Person-Based Access Control

2.3.21 Access Permission

2.3.14 Multi-Factor Authentication

by fingerprint, face picture, or iris.

2.3.17 Remote Verification

2.3.23 New Device ID

2.4 Symbols And Acronyms

Firstly, two operations are defined:

example, 127,10,23 -> 7f0a17

example, 7f0a17 -> 127,10,23

modulus and public exponent (the default value is '010001' ).

3.3.3 Information Encryption

with devices via HTTPS, the information can be transmitted securely.

3.4 Video Streaming

3.4.1 Audio and Video Stream

4 Quick Start Guide

std::string strUrl = "http://192.168.18.84:80/ISAPI/System/deviceInfo";

curl_easy_setopt(pCurlHandle, CURLOPT_URL, strUrl.c_str());

curl_easy_setopt(pCurlHandle, CURLOPT_USERPWD, "admin:admin12345");

curl_easy_setopt(pCurlHandle, CURLOPT_WRITEFUNCTION, OnWriteData);

curl_easy_setopt(pCurlHandle, CURLOPT_MAXREDIRS, 1);

reaches the device

std::cout << strResponseData << std::endl;

4.1.4 Python (requests)

# - *- coding: utf-8 -*-

# Send the request and receive response

4.2 Message Parsing

4.2.1 Message Format

parse the form data.

complex string as the boundary value.

filename in XML/JSON messages corresponds to filename property of Content-Disposition in

Content-Disposition: form-data; name="5EE7078E07BB47CF860DE8E4E9A85F28"; filename="humanBackgroundImage.jpg";

<?xml version="1.0" encoding="UTF-8"?>

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

1

true

subType Field Type: String

Enumeration The [] following the subType contains all enumerators.

4.2.3 Capability Set

/*ro, req, int, the minimum string size*/

/*req, object, capability example of type enum*/

"@opt": ["enum1", "enum2", "enum3"]

4.2.4 Time Format

YYYY = the year consisting of four decimal digits

4.2.5 Character Set

of type string in ISAPI are listed below.

16 Exclamation Mark ! 33 Backslash |

special character table.

4.2.6 Error Processing

2. Server responds that authentication is required.

RTSP/1.0 401 Unauthorized

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

4. The device responds to SDP information.

Date: Tue, 17 Nov 2020 02:09:45 GMT

SETUP rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101/trackID=2 RTSP/1.0

6. The client sends an RTSP PLAY request.

PLAY rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101 RTSP/1.0

7. The server sends audio and video stream data.

TEARDOWN rtsp://10.21.84.147:554/ISAPI/Streaming/channels/101 RTSP/1.0

RTSP (Real Time Streaming Protocol, see details in RFC 7826).

4.4.2 API Calling Flow

<?xml version="1.0" encoding="utf-8"?>

Response from Device

<?xml version="1.0" encoding="UTF-8" ?>

4.4.3.2 Search for Videos

Request from Client

POST /ISAPI/ContentMgmt/search HTTP/1.1

# - - coding: utf-8 --

/ro, req, int, the minimum string size/

/req, object, capability example of type enum/