ISAPI Developer Guide - Access Control - Face Recognition Terminals - 2022!07!01

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.
1 Overview
1.1 Introduction
Intelligent Security API (hereinafter referred to as ISAPI) is an application layer protocol based on HTTP (Hypertext
Transfer Protocol) and adopts the REST (Representational State Transfer) architecture for communication between
security devices (cameras, DVRs, NVRs, etc.) and the platform or client software. Since established in 2013, ISAPI has
had more than 11,000 APIs for different functions, including device management, vehicle recognition, parking lot
management, intelligent facial application, access control management, interrogation management, and recording
management. It is applicable to industries such as traffic, fire protection, education, and security inspection.
1.2 Product Scope

Access Control
Face Recognition Terminals
ACT-T1331RU、ACT-T1331WRU、ACT-T1341MFRU、ACT-T1341MRU、DS-K1A330、DS-K1A330W、DS-
K1A340FWX、DS-K1A340FX、DS-K1A340WX、DS-K1A340WX#India、DS-K1A340X、DS-K1T331、DS-
K1T331W、DS-K1T341A、DS-K1T341AM、DS-K1T341AM-S 、DS-K1T341AMF、DS-K1T341AMF-S 、DS-
K1T341AMHUN#India、DS-K1T341B、DS-K1T341BMI-T、DS-K1T341BMW、DS-K1T341BMWI-T、DS-
K1T341CM、DS-K1T341CMF、DS-K1T341CMFW、DS-K1T341CMW、DS-K1T341M、DS-K1T342DWX、DS-
K1T342DX、DS-K1T342EFWX、DS-K1T342EWX、DS-K1T342EX、DS-K1T342MFWX、DS-K1T342MFX、DS-
K1T342MWX、DS-K1T342MX、DS-K1T343EFWX、DS-K1T343EFX、DS-K1T343EWX、DS-K1T343EX、DS-
K1T343MFWX、DS-K1T343MFX、DS-K1T343MFX#India、DS-K1T343MWX、DS-K1T343MX、DS-K1T607、
DS-K1T607E、DS-K1T607TEF#India、DS-K1T642、DS-K1T642E、DS-K1T642EF、DS-K1T642EFW、DS-
K1T642EW、DS-K1T642M、DS-K1T642MF、DS-K1T642MFW、DS-K1T642MW、DS-K1T643MWX-T、DS-
K1T643MX-T、DS-K1T671、DS-K1T671AM、DS-K1T671AMW、DS-K1T671BM、DS-K1T671BMF、DS-
K1T671BMFW、DS-K1T671BMW、DS-K1T671BTM、DS-K1T671BTMF、DS-K1T671BTMFW、DS-
K1T671BTMW、DS-K1T671M、DS-K1T671M#RUBB、DS-K1T671M#turkey、DS-K1T671M-L、DS-
K1T671MF、DS-K1T671MF-L、DS-K1T671T、DS-K1T671TM、DS-K1T671TM-3XF、DS-K1T671TMF、DS-
K1T671TMFW、DS-K1T671TMW、DS-K1T672、DS-K1T672DWX-T、DS-K1T672DX-T、DS-K1T672E、DS-
K1T672M、DS-K1T672MW、DS-K1T673DWX、DS-K1T673DX、DS-K1T673TDGX、DS-K1T673TDWX、DS-
K1T673TDX、DS-K1T680D、DS-K1T680D-E1、DS-K1T680DF、DS-K1T680DF-E1、DS-K1T680DFG、DS-
K1T680DFW、DS-K1T680DG、DS-K1T680DW、DS-K1T690M-E1、DS-K1T690M-T、DS-K1T690MF-X、DS-
K1T690MW、DS-K1T6Q-F71M、DS-K1T6QT-F72DWX、DS-K1T6QT-F72DX、DS-K1T6QT-F72TDGX、DS-
K1T6QT-F72TDWX、DS-K1T6QT-F72TDX、DS-K1TA70MI-T、DS-K1TV41MF#Asia、DS-K5604A-3XF/V、DS-
K5671-3XF/ZU、DS-K5671-W、DS-K5671-ZH、DS-K5671-ZU、DS-K5671-ZV、DS-K5671-ZV(B)#IN、DS-
K5671A-ZU、DS-K5671B-ZH、DS-K5671B-ZU、DS-K5671B-ZV、DS-K5672MW-Z、VDP-T331#CATC、
VDP-T341#CATC
1.3 Terms And Definitions

1.3.1 Access Permission
Users can set who can open which doors at what time. The access permission contains information about the person,
time, and door.
1.3.2 Person Type

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
permissions to access the specified areas, and blocklist persons do not have the permissions to access the specified
areas.
1.3.3 Credential Type

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
whom the credential links to via the comparison algorithm.
1.3.4 EZVIZ Cloud Storage

The cloud storage service provided by EZVIZ.
1.3.5 Event
It refers to the information uploaded by the device. The event is uploaded by the device in real time for the immediate
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.
1.3.6 Listen
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.
1.3.7 Listening Host

The listening host service can be enabled to receive the event information from devices.
1.3.8 Person-Based Access Control

The person ID is the unique identifier for person management, and the card, fingerprint, face picture are the person’s
credentials which are linked via the person ID. Permissions are also linked via the person ID.
1.4 Symbols And Acronyms

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.
EZVIZ: EZVIZ (Easy View/Vision).
admin: administrator
HTTP: Hypertext Transfer Protocol
1.5 Update History

No update record
2 Application Scenario
When you integrate devices via ISAPI, the device acts as the server to listen on the fixed port and the user's application
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.
3 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 the devices, etc.
4 ISAPI Framework
4.1 Overview
Note:
In general, ISAPI refers to the communication protocol based on the HTTP standard. As ISAPI is usually used along with
RTSP (Real-Time Streaming Protocol), the RTSP standard is brought into the ISAPI system.
The meta data 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.
4.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 in 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.
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
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
example, 7f0a17 -> 127,10,23
The basic interaction flow between the client and device is shown below.
1. The client generates a public and private key pair (1024 bits), and gets the 128-byte modulus in the public key
(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
public key string to the device in XML message (related URI: POST /ISAPI/Security/challenge ) after being
encoded by Base64.
3. The device parses the request to obtain a 256-byte public key string decoded by Base64 and converts it to a 128-
byte public key modulus via hexStringToBytes. The complete public key is the combination of obtained public key
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, 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.
Note:
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
but need to ensure that the device and the application running SADP are connected to the same router. SADP also
supports discovering devices in the LAN, changing the password of the devices, and so on. The HCSadpSDK is
provided for SADP integration, including the developer guide, plug-in, and sample demo which can be used as a
simple SADP tool.
4.3 Security Mechanism

4.3.1 Authentication
When the client applications send requests to the devices, they need to use digest authentication (see details in RFC
7616) for identity authentication.
Currently, all mainstream request class libraries of HTTP have encapsulated digest authentication. The client
applications only need to call APIs of the class library to implement the digest authentication. The sample code is shown
below.
4.3.1.1 C/C++ (libcurl)
// #include <curl/curl.h>
// Callback Function
static size_t OnWriteData(void* buffer, size_t size, size_t nmemb, void* lpVoid)
{
std::string* str = dynamic_cast<std::string*>((std::string *)lpVoid);
if( NULL == str || NULL == buffer )
{
return -1;
}
char* pData = (char*)buffer;

str->append(pData, size * nmemb);
return nmemb;
}
std::string strUrl = "http://192.168.18.84:80/ISAPI/System/deviceInfo";

std::string strResponseData;
CURL *pCurlHandle = curl_easy_init();
curl_easy_setopt(pCurlHandle, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(pCurlHandle, CURLOPT_URL, strUrl.c_str());
// Set the user name and password
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
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);
// 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
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
reaches the device
curl_easy_setopt(pCurlHandle, CURLOPT_CONNECTTIMEOUT, 5);
CURLcode nRet = curl_easy_perform(pCurlHandle);
if (0 == nRet)
{
// Output the received message
std::cout << strResponseData << std::endl;
}
curl_easy_cleanup(pCurlHandle);
4.3.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();
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)
{
Console.WriteLine(ex.Message);
}
4.3.1.3 Java (HttpClient)
// import org.apache.commons.httpclient.HttpClient;
String url = "http://192.168.18.84:80/ISAPI/System/deviceInfo";
HttpClient client = new HttpClient();
UsernamePasswordCredentials creds = new UsernamePasswordCredentials("admin", "admin12345");
client.getState().setCredentials(AuthScope.ANY, creds);
GetMethod method = new GetMethod(url);
method.setDoAuthentication(true);
int statusCode = client.executeMethod(method);
byte[] responseData = method.getResponseBodyAsString().getBytes(method.getResponseCharSet());
String strResponseData = new String(responseData, "utf-8");
method.releaseConnection();
// Output received information
System.out.println(strResponseData);
4.3.1.4 Python (requests)
# - *- coding: utf-8 -*-
import requests
request_url = 'http://192.168.18.84:80/ISAPI/System/deviceInfo'
# Set the authentication information
auth = requests.auth.HTTPDigestAuth('admin', 'admin12345')
# Send the request and receive response
response = requests.get(request_url, auth=auth)
# Output response content
print(response.text)
4.3.2 User Permission

There are three kinds of users with different permissions for access control and management.
Administrator: Has the permission to access all supported resources and should keep activated all the time. It is also
known as "admin".
Operator: Has the permission to access general resources and a part of advanced resources.
Normal User: Only has the permission to access general resources.
4.3.3 Stream Encryption

To enhance the security of the real-time or historical stream from the devices and comply with the laws and regulations
of international markets, ISAPI provides the function of encrypting the stream based on the AES algorithm.
Before enabling the stream encryption function, firstly you need to check whether the device supports stream
encryption and set the stream encryption key and PlayCtrl library decryption key. The interaction process is shown in
the figure below.
Note: After the stream encryption is enabled, you can only decode the stream using the PlayCtrl library .
4.3.4 Information Encryption
During ISAPI integration, some sensitive information, such as the user name and password, in the message needs to be
encrypted to enhance the security for transmission.
There are two methods to encrypt the information for transmission: HTTPS and sensitive information encryption (AES
encryption).
HTTPS (Recommended): Firstly you can enable the HTTPS service of the device. When the client applications
communicate with devices via HTTPS, the information can be transmitted securely.
Sensitive Information Encryption: Sensitive information, such as the user name and password, in the message is
encrypted for transmission. The core of the encryption algorithm is AES. The interaction process is shown below.
4.4 Video Streaming
4.4.1 Audio and Video Stream
ISAPI supports getting and setting stream media parameters of the device, such as video resolution, encoding format,
and stream.
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 Streaming and Playback.
4.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.5 Message Parsing

4.5.1 Message Format
During the process of communication and interaction via ISAPI, the request and response messages are often text data
in XML or JSON format. Besides that, the data of firmware packages and configuration files is in binary format. A
request can also be in form format with multiple formats of data (multipart/form-data).
4.5.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.
4.5.1.2 JSON
The Content-Type in the Headers of the HTTP request is often application/json .
To distinguish between APIs with XML messages and those with JSON messages, ISAPI adds the query parameter
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
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.
Request and response messages in JSON format are all encoded by UTF-8 in ISAPI.
4.5.1.3 Binary Data

For the firmware and configuration files, the Content-Type in the Headers of an HTTP request is often
application/octet-stream .
4.5.1.4 Form (multipart/form-data)

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-
Type in the Headers 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
own Headers. For the detailed format description, refer to RFC 1867 (Form-Based File Upload in HTML). The example is
as follows. Pay attention to the horizontal lines before and after the boundary.
POST /ISAPI/Intelligent/FDLib/pictureUpload
Content-Type: multipart/form-data; boundary=AaB03x
Content-Length: 56789
--AaB03x
Content-Disposition: form-data; name="PictureUploadData";
Content-Type: text/xml
<PictureUploadData/>
--AaB03x
Content-Disposition: form-data; name="face_picture"; filename="face_picture.jpg";
Content-Type: image/jpeg
Picture Data
--AaB03x--
Note:
In RFC specifications, it is strongly recommended to contain the field Content-Length in the entity header, and 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 parse the form data.
4.5.2 Annotation
The field descriptions of ISAPI request and response messages are marked as annotations in the example messages as
shown 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>
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:*/
}
}
Key annotations are shown in the table below.

Annotation Description Remark
Attribute: Read-
ro This field can only be obtained and cannot be edited.
Only
Attribute: Write-
wo This field can only be edited and cannot be obtained.
Only
Attribute: This field is required for request messages sent to the device and response
req
Required 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.
Attribute:
dep This field is valid and required when specific conditions are satisfied.
Dependent
object Field Type: Object The field of type object contains multiple sub-fields.
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
subType Field Type: String
field.
int Field Type: Int The range following it refers to the maximum and the minimum value of the field.
float Field Type: Float The range following it refers to the maximum and the minimum value of the field.
Field Type:
bool The value can be true or false.
Boolean
Field Type: The subType following it indicates that the enumerators are of type string or int.
enum
Enumeration The [] following the subType contains all enumerators.
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.5.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*/
}
The value range of the field: the maximum value, minimum value, the maximum size, the minimum size, options,
and so on of each field of the API.
{
"boolType": {
/*req, object, example of the capability of type bool*/
"@opt": [true, false]
/*req, array, options, subType: bool*/
},
"integerType": {
/*req, object, example of the capability of type integer*/
"@min": 0,
/*ro, req, int, the minimum value*/
"@max": 100
/*ro, req, int, the maximum value*/
},
"stringType": {
/*req, object, example of the capability of type string*/
"@min": 0,
/*ro, req, int, the minimum string size*/
"@max": 32
/*ro, req, int, the maximum string size*/
},
"enumType": {
/*req, object, capability example of type enum*/
"@opt": ["enum1", "enum2", "enum3"]
/*req, array, options, subType: string*/
}
}
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
precedence.
4.5.4 Time Format

ISAPI adopts ISO 8601 Standard Time Format, which is the same as W3C Standard Date and Time Formats.
Format: YYYY-MM-DDThh:mm:ss.sTZD
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)
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:
The time difference cannot be simply used to determine the time zone. Because when the DST starts, the time
difference will change and it cannot represent the actual time zone.
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
used in messages sent from the user applications and the devices.
For representing the time difference information and forward compatibility, an extra field timeDiff is added as
shown in the example below. User applications need to support both TD format and TZ format when parsing the
time in the messages returned by devices.
A few old-version devices will return the time in TZ format.
{
"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*/
"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*/
}
4.5.5 Character Set

To prevent characters not commonly used from resulting in exceptions in device programs and user applications, ISAPI
limits the valid field values of type string to a specific range of characters. Character sets allowed to be used in the fields
of type string in ISAPI are listed below.
Single-byte character set: lowercase letters ( a-z ), uppercase letters ( A-Z ), digits ( 0-9 ), and special characters (see
details in the table below).
Multi-byte character set: language characters based on Unicode and encoded by UTF-8 (UTF-8 encoding is a
transformation format of Unicode character set. For details, refer to RFC 2044).
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 *
6 Period . 23 Slash /
7 Semicolon ; 24 Smaller Than <
8 Equal Sign = 25 Greater Than >
9 At Sign @ 26 Question Mark ?
10 Open Square Bracket [ 27 Caret ^
11 Close Square Bracket ] 28 Open Single Quotation Mark '
12 Underscore _ 29 Vertical Bar |
13 Open Brace { 30 Tilde ~
14 Close Brace } 31 Double Quotation Marks "
15 Space 32 Colon :
16 Exclamation Mark ! 33 Backslash |
17 Octothorpe #
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
special character table.
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.
Names displayed on the UI (device name, person name, face picture library name, etc.): lowercase letters ( a-z ),
uppercase letters ( A-Z ), digits ( 0-9 ), characters from No. 1 to No. 15 in the special character table, and multi-byte
characters.
Normal fields of type string support lowercase letters ( a-z ), uppercase letters ( A-Z ), digits ( 0-9 ), characters from
No. 1 to No. 15 in the special character table, and multi-byte characters by default.
4.5.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
the 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"
}
4.6 Event Uploading

When the rules configured on the device are triggered, the device will generate event messages (e.g., motion detection,
face capture, vehicle capture, etc.) and actively upload them to the client. ISAPI supports three methods to receive event
messages uploaded by the device, that is, in arming mode, in listening mode, and via subscription.
4.6.1 Arming
Arming via ISAPI depends on the HTTP persistent connection. The client sends a request to establish the arming
connection with the device by calling GET /ISAPI/Event/notification/alertStream and keeps the connection alive.
Then the device will send event messages to the client through the connection.
Note:
The devices' responses are in form format (multipart/form-data). Depending on whether the event message
consists of multiple pieces of data, each subpart in the form corresponds to an event or a part of an event. For
example, the face capture event contains the face information in JSON format and the face picture data in binary
format, which means that there will be multiple subparts in the form.
When the device does not generate any event message within 5 seconds, the device will send a heartbeat message
to the client for checking the status of the arming connection.
4.6.2 Subscription
Subscription via ISAPI is basically the same as the arming. The difference is that the API for establishing the subscription
connection is POST /ISAPI/Event/notification/subscribeEvent . After the connection is established, you can
subscribe to specific video channels, event types, and so on by the request Body. Then the device will only send event
messages in the subscription list to the client.
For details about the API calling flow and related APIs, refer to Event Arming and Subscription Management.
4.6.3 Listening
In the listening mode, when an alarm is triggered or an event occurred, the device will actively upload the alarm/event
message to the address specified for receiving alarms/events. You need to configure the address on the device for
receiving the alarm/event notification and make sure that the device is valid.
Note:
The client and the event service can be the same program.
In the listening mode, the device will not upload the heartbeat message.
For details about the APIs of setting the address for receiving the event message, refer to HTTP Alarm Receiving Host
Management.
5 User Management
5.1 Introduction to the Function
When the device is activated, you can log in to it via the admin account and corresponding password, and manage users
as needed, including:
1. Change the password of an 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
log in to and operate the device after being created.
Note:
1. The common user types:
Administrator ( admin ): has the permission of accessing all resources supported by the device, and can operate
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 .
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
by the administrator only.
2. User password:
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,
and special characters, and the user name is not allowed in the password.
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,
it is recommended to use a strong password.
The password strength rule is as follows:
a. Strong password: including at least three kinds of the categories (digits, lower case letters, upper case
letters, and special characters).
b. Medium password: a combination of digits and special characters, or lower case letters and special
characters, or upper case letters and special characters, or lower case letters and upper case letters.
c. Weak password: a combination of digits and lower case letters or digits and upper case letters.
5.2 API Calling Flow

1. Get the user management capability of devices on the client software: GET
/ISAPI/Security/users/<indexID>/capabilities .
2. Add device users on the client software: 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 software: PUT /ISAPI/Security/users/<indexID>?security=
<security>&iv=<iv> .
Remarks:
It requires login 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 for the next login.
When non-admin users changed their passwords, the account remains activated.
4. Delete users on the client software: 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 .
5. Get the user information, including user name, activation status ( <userActivationStatus> ), and so on.
Get a single user information: GET /ISAPI/Security/users/<indexID>?security=<security>&iv=<iv> .
Get the information about all users: GET /ISAPI/Security/users?security=<security>&iv=<iv> .
Get the information about online users: GET /ISAPI/Security/onlineUser . Online users refer to users who logged
in to the device. The information such as user name, user type, and IP address can be obtained.
Remarks:
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.
The new password cannot be the same as the last password. Otherwise, an error ( 0x400010E8 ) will be returned.
5.3 Exception Handling

Error Code
statusCode statusString subStatusCode errorCode errorMsg Description Remarks
New password
New cannot be the
password same as the old
Invalid
4 cannotSameAsOldPassword 0x400010E8 cannot be the one. Please
Operation
same as the change the
old one. password and try
again.
The account
Invalid The account is not
4 theAccountIsNotActivated 0x0020000f is not
Operation activated.
activated.
Incorrect
Invalid Incorrect login
4 loginPasswordError 0x4000000C login
Operation password.
password.
Please enter the
correct password.
Incorrect
Invalid If you forgot the
6 administratorPasswordError 0x60000042 administrator
Content password, you can
password.
reset the
password.
6 EZVIZ Access Services

Configure EZVIZ access service parameters, including whether to enable EZVIZ services, the server address, and the
verification code, etc.

1. Get the capability of configuring EZVIZ access services: GET /ISAPI/System/Network/EZVIZ/capabilities .
2. Get the parameters of EZVIZ access service: GET /ISAPI/System/Network/EZVIZ?security=<security>&iv=<iv> .
3. Set the parameters of EZVIZ access service: PUT /ISAPI/System/Network/EZVIZ?security=<security>&iv=<iv> .
Note: The verification code is used when device are added to the EZVIZ App. It can also be used as the stream
encryption key.
7 EZVIZ Storage Configuration

Devices can access the EZVIZ storage services based on the configured parameters.
Note:
1. The storage services are based on the access services. After registration, the access services will be automatically
connected to the storage services. Therefore, configuring the service address for the cloud services is not required.
2. Here we only configure the parameters for videos related to events. You can configure the parameters for pictures
to be uploaded during alarm subscription (via pictureURLType in /ISAPI/Event/notification/subscribeEvent )
and alarm receiving in arming mode.
1. Get the capability of configuring EZVIZ access services: GET /ISAPI/System/Network/EZVIZ/capabilities . If

isSupportEZVIZCloud exists and its value is "true", it indicates that this function is supported.
2. Get the capability of configuring EZVIZ storage services: GET

/ISAPI/System/Network/EZVIZ/cloudStorage/capabilities?format=json .
3. (Optional) Configure the channel's encoding parameters according to the capability returned in the previous step.
4. (Optional) Get the parameters of EZVIZ storage service: GET /ISAPI/System/Network/EZVIZ/cloudStorage?
format=json .
5. Configure the parameters of EZVIZ storage service: PUT /ISAPI/System/Network/EZVIZ/cloudStorage?

format=json .
6. Configuring the parameters of EZVIZ storage service is not supported currently.

Note: When the device uploads videos to EZVIZ, stream of 5-second video to be uploaded will be retained in the cache
of the device, which may affect its performance. You can configure the encoding parameters to improve the fluency of
the video. Otherwise, the stream to be uploaded may have shuttering frames.
8 Subscribe to Videos Related to Events
Supports subscribing to videos (to be uploaded) related to specific events (by channel or by event).
Scenario: Storage can be saved if only videos related to specific events are required. And for the same storage space,
more clients can be provided with storage services.

isSupportRecordsSubscribe or isSupportChannelRecordsSubscribe exists and the value is "true", it indicates that
this function is supported.
2. Get the capability of subscribing to the videos related to specific events: GET
/ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe/capabilities?format=json .
3. (Optional) Get the parameters of subscribing to the videos related to specific events: GET
/ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe?format=json .
4. Configure the parameters for subscribing to the videos related to specific events: PUT
/ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe?format=json .
5. Get the capability of subscribing to the videos related to specific events (a single channel): GET
/ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe/channels/<channelID>/capabilities?
format=json .
6. (Optional) Get the parameters of subscribing to the videos related to specific events: GET
/ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe/channels/<channelID>?format=json .
7. Configure the parameters for subscribing to the videos related to specific events (a single channel): PUT
/ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe/channels/<channelID>?format=json .
9 Check the Statistics of Videos Uploaded/to be Uploaded
After subscribing to the videos related to specific events, users may be concerned with the number of videos that have
been uploaded or videos to be uploaded. Users can select the videos to be uploaded or check the network when
exception occurs.

isSupportRecordsSubscribeStatistics exists and its value is "true", it indicates that this function is supported.
2. Get the capability of checking the statistics of videos: GET

/ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe/statistics/capabilities?format=json .
3. Get the statistics of videos: POST /ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe/statistics?

format=json .
10 Listening Service
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)

10.2.1 Listening Service
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> ;
Get the parameters of all listening hosts: GET /ISAPI/Event/notification/httpHosts?security=<security>&iv=

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

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

3. Enable the listening service:

The user needs 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 connection with the client and uploads alarm information. Meanwhile,
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.
10.2.2 Event Message Grammar

When an event occurs or an alarm is triggered, the event/alarm information can be with binary data (such as pictures)
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:
Alarm Message Sent by the Device
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 
<EventNotificationAlert/>
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>
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
Here are the descriptions of the main keywords.

keyword example description
multipart/form-data;
Content-Type Content type, multipart/form-data refers to data in form format.
boundary=frontier
Separator of the form message. A form message starts with --boundary
boundary frontier
and ends with --boundary--.
Content- form-data;
Content description. form-data refers to data in the form format.
Disposition name="Picture_Name";
filename "Picture_Name" File name. The file refers to the form message.
Content- Content length. The length of the content which starts from \r\n to the
10
Length next --boundary.
10.3 Exception Handling

10.3.1 Error Codes
statusCode statusString subStatusCode errorCode errorMsg Description Remarks
Invalid Event subscription is not
6 eventNotSupport 0x60001024
Content supported.
11 Device Upgrade
The platform or client software or web client under the LAN upgrades devices via ISAPI.

The sequence diagram of upgrading devices by the platform is shown below.
1. Upgrade devices.
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.
Reboot devices: PUT /ISAPI/System/reboot .
12 Device Peripherals Upgrade

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

The sequence diagram of upgrading device peripherals by the platform is shown below.
1. Get the device system capability GET /ISAPI/System/capabilities and check whether the device supports
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.
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.
3. The platform sends the upgrade command POST /ISAPI/System/updateFirmware?type=<type>&moduleAddress=
<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
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.
6. Get the peripheral latest version information.
13 Person and Credential Management
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.
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,
refer to the “Management of Permission Schedules for Persons and Access Points”.
14 Person Management
Person management includes searching, applying, adding, editing, and deleting persons.

14.2.1 Check Whether the Device Supports Person Management
Before calling the API for person management, make sure that the device supports person management.
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.
2. Search, apply, add, and edit persons.
3. If the node isSupportUserInfo is returned and its value is false, it indicates that the device does not support person
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.
14.2.2 Person Search

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?
format=json is the maximum number of persons supported by the device.
14.2.3 Person Applying
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.
14.2.4 Person Adding
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:
person adding.
14.2.5 Person Information Editing

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.
Note:
person information editing.
14.2.6 Person Deleting

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.
15 Card Management
Card management includes searching, applying, adding, editing, deleting, and collecting cards.

15.2.1 Check Whether the Device Supports Card Management
Before calling the API for card management, make sure that the device supports card management.
1. Check whether the device supports card management: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportCardInfo is returned and its value is “true”, it indicates that the device supports card management.
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
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 .
15.2.2 Card Search

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.
4. Search card information: POST /ISAPI/AccessControl/CardInfo/Search?format=json ; the card information is
returned by page.
5. If the value of the node supportFunction does not contain “get”, it indicates that the device does not support card
search.
Note:
The value of the node maxRecordNum returned by calling GET /ISAPI/AccessControl/CardInfo/capabilities?
format=json is the maximum number of cards supported by the device.
15.2.3 Card Applying

Card information can be applied to the device via the card applying function. If the card has been added to
the device, the card information will be edited; if the card has not been added to the device, the card
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.
15.2.4 Card Adding

Card information can be added to the device via the card adding function. If the card has been added to the
device, the device will report an error; if the card has not been added to the device, the card information will
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:
adding.
15.2.5 Card Information Editing

Card information on the device can be edited via the card information editing function. If the card has been
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:
information editing.
15.2.6 Card Deleting
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.
15.2.7 Card Collecting

The card collecting function is for collecting the card No., card type, etc.
1. Check whether the device supports card collecting: GET /ISAPI/AccessControl/capabilities ; if the node
isSupportCaptureCardInfo is returned and its value is “true”, it indicates that the device supports card collecting.
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.
16 Fingerprint Management
Fingerprint management includes searching, applying, deleting, and collecting fingerprints.

16.2.1 Check Whether the Device Supports Fingerprint Management
Before calling the API for fingerprint management, make sure that the device supports fingerprint
management.
1. Check whether the device supports fingerprint management: GET /ISAPI/AccessControl/capabilities ; if the
node isSupportFingerPrintCfg is returned and its value is “true”, it indicates that the device supports fingerprint
management.
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).
16.2.2 Fingerprint Search
The fingerprint search function is for searching the number of fingerprints and fingerprint information
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 ;
the returned value of the node numberOfFP is the number of the added fingerprints of all persons.
4. Search fingerprint information: POST /ISAPI/AccessControl/FingerPrintUpload?format=json ; the fingerprint
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.
5. If calling failed, it indicates that the device does not support fingerprint search.
Note:
The value of the node fingerPrintCapacity returned by calling GET
/ISAPI/AccessControl/CardReaderCfg/<cardReaderID>?format=json is the maximum number of fingerprints
supported by the card reader.
The value of the node fingerPrintNum returned by calling GET
/ISAPI/AccessControl/CardReaderCfg/<cardReaderID>?format=json is the number of fingerprints added to the
card reader.
16.2.3 Fingerprint Applying

Fingerprint information can be applied to the device via the fingerprint applying 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 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.
16.2.4 Fingerprint Adding

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
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.
16.2.5 Fingerprint Information Editing
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
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.
16.2.6 Fingerprint Deleting

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.
16.2.7 Fingerprint Collecting
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.
17 Face Picture Management
Face picture management includes searching, applying, adding, editing, deleting, and collecting face pictures.

17.2.1 Check Whether the Device Supports Face Picture Management
Before calling the API for face picture management, make sure that the device supports face picture
management.
1. Check whether the device supports face picture management: GET /ISAPI/AccessControl/capabilities ; if the
node isSupportFDLib is returned and its value is “true”, it indicates that the device supports face picture
management.
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.
17.2.2 Face Picture Search

The face picture search function is for searching the number of face pictures and face picture information
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
picture search.
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
number of the added face pictures of the specified face picture libraries.
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
libraries.
4. Search face picture information: POST /ISAPI/Intelligent/FDLib/FDSearch?format=json ; the face picture
information is returned by page.
5. If the value of the node supportFunction does not contain “get”, it indicates that the device does not support face
picture search.
Note:
The value of the node FDRecordDataMaxNum returned by calling GET /ISAPI/Intelligent/FDLib/capabilities?
format=json is the maximum number of face pictures supported by the device.
17.2.3 Face Picture Applying

Face picture information can be applied to the device via the face picture applying function. If the face
picture has been added to the device, the face picture information will be edited; if the face picture has not
been added to the device, the face picture information will be added to the device.
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.
17.2.4 Face Picture Adding

Face picture information can be added to the device via the face picture adding function. If the face picture
has been added to the device, the device will report an error; if the face picture has not been added to the
device, the face picture information will be added to the device.
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:
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.
17.2.5 Face Picture Information Editing

Face picture information on the device can be edited via the face picture information editing function. If the
face picture has been added to the device, the face picture information will be edited; if the face picture has
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:
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.
17.2.6 Face Picture Deleting
The face picture information on the device can be deleted via the face picture deleting function. The device
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 .
17.2.7 Face Picture Collecting
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.
4. If the node isSupportCaptureFace is returned and its value is “false”, it indicates that the device does not support
face picture collecting.
18 Iris Data Management

Iris data management includes searching, applying, adding, editing, deleting, and collecting iris data.

18.2.1 Check Whether the Device Supports Iris Data Management
Before calling the API for iris data management, make sure that the device supports iris data management:
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.
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.
Note:
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.
18.2.2 Iris Data Search

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.
18.2.3 Iris Data Applying
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.
18.2.4 Iris Data Adding
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:
API for iris data adding.
18.2.5 Iris Data Editing
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:
API for iris data editing.
18.2.6 Iris Data Deleting
The iris data deleting function is for deleting the applied iris information on the device. If the iris data to be
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.
18.2.7 Iris Data Collecting

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.
19 Holiday Schedule of Voice Prompt
You can configure TTS texts or audio files of access authentication for holiday schedule.

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>?
format=json ; 4.Check whether the device supports searching for holiday schedule of voice prompt (get the capability of
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
holiday schedule parameters; 5.Get the capability of searching for holiday schedule parameters of voice prompt: GET
/ISAPI/AccessControl/Verification/ttsText/holidayPlan/capabilities?format=json ; 6.Search for holiday
schedule of voice prompt: POST /ISAPI/AccessControl/Verification/ttsText/searchHolidayPlan?format=json ;
20 Daily Schedule of Voice Prompt

You can configure TTS texts or audio files of access authentication for daily schedule. The priority of holiday schedule is
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.

ISAPI Protocol Calling Flow: 1.Check whether the device supports daily schedule of voice prompt (get the capability
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 ;
21 API Reference
21.1 Device Basic Information Management
21.1.1 Set the device information parameters
Request URL
PUT /ISAPI/System/deviceInfo
Query Parameter
None
Request Message
<DeviceInfo xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<deviceName>
test
</deviceName>
<deviceID>
test
</deviceID>
<deviceDescription>
test
</deviceDescription>
<deviceLocation>
hangzhou
</deviceLocation>
<deviceStatus>
normal
</deviceStatus>
<DetailAbnormalStatus>

<hardDiskFull>
true
</hardDiskFull>
<hardDiskError>
true
</hardDiskError>
<ethernetBroken>
true
</ethernetBroken>
<ipaddrConflict>
true
</ipaddrConflict>
<illegalAccess>
true
</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>
V4.1.40
</firmwareVersion>
<firmwareReleasedDate>
2019-11-01
</firmwareReleasedDate>
<encoderVersion>
V7.3
</encoderVersion>
<encoderReleasedDate>
2019-11-02
</encoderReleasedDate>
<bootVersion>
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>
1
</usedCapacity>
<deviceType>
Blade
</deviceType>
<telecontrolID>
1
</telecontrolID>
<supportBeep>
true
</supportBeep>
<supportVideoLoss>
true
</supportVideoLoss>
<firmwareVersionInfo>
test
</firmwareVersionInfo>
<actualFloorNum>
1
</actualFloorNum>
<localZoneNum>
1
</localZoneNum>
<alarmOutNum>
1
</alarmOutNum>
<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>
1
</alarmLamp>
<RS485Num>
1
</RS485Num>
<radarVersion>
test
</radarVersion>
<cameraModuleVersion>
test
</cameraModuleVersion>
<mainversion>
1
</mainversion>
<subversion>
1
</subversion>
<upgradeversion>
1
</upgradeversion>
<customizeversion>
1
</customizeversion>
<companyName>
test
</companyName>
<copyright>
test
</copyright>
<systemName>
storageManagement
</systemName>
<systemStatus>
configured
</systemStatus>
<isLeaderDevice>
true
</isLeaderDevice>
<clusterVersion>
test
</clusterVersion>
<manufacturer>
hikvision
</manufacturer>
<centralStorageVersion>
test
</centralStorageVersion>
<powerOnMode>
button
</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">
chinese
</languageType>
<DockStation>

<Platform>

<type>
none
</type>
<ip>
test
</ip>
<port>
1
</port>
<userName>
test
</userName>
<password>
test
</password>
</Platform>
<centralStorageBackupEnabled>
true
</centralStorageBackupEnabled>
</DockStation>
<webVersion>
test
</webVersion>
<deviceRFProgramVersion>
test
</deviceRFProgramVersion>
<securityModuleSerialNo>
test
</securityModuleSerialNo>
<securityModuleVersion>
test
</securityModuleVersion>
<securityChipVersion>
test
</securityChipVersion>
<securityModuleKeyVersion>
test
</securityModuleKeyVersion>
<UIDLampRecognition>

<enabled>
true
</enabled>
</UIDLampRecognition>
<confDeviceIdPrefix>
true
</confDeviceIdPrefix>
<OEMCode>
1
</OEMCode>
<simpleAlgorithmVersion>
test
</simpleAlgorithmVersion>
<bootTime>
1970-01-01T00:00:00+08:00
</bootTime>
<intelligentAnalysisEngineModel>
test
</intelligentAnalysisEngineModel>
<marketType>
0
</marketType>
<algorithmVersion>
test
</algorithmVersion>
<firmware>
test
</firmware>
<engineList>

<engine>
1
</engine>
</engineList>
<platform>
1
</platform>
<platformName>
test
</platformName>
<touchScreenVersionInfo>
test
</touchScreenVersionInfo>
<protocolFileURL>
test
</protocolFileURL>
<recycleRecordEnabled>
false
</recycleRecordEnabled>
<decordChannelNums>
0
</decordChannelNums>
<VGANums>
0
</VGANums>
<USBNums>
0
</USBNums>
<auxoutNums>
0
</auxoutNums>
<expansionBoardVersion>
test
</expansionBoardVersion>
<initWizzardDisplay>
true
</initWizzardDisplay>
<beaconID>
test
</beaconID>
<isResetDeviceLanguage>
false
</isResetDeviceLanguage>
<dispalyNum>
0
</dispalyNum>
<bspVersion>
test
</bspVersion>
<dspVersion>
test
</dspVersion>
<localUIVersion>
test
</localUIVersion>
<detectorType>
PDA
</detectorType>
<wiegandOutNum>
1
</wiegandOutNum>
<ChipVersionInfoList>

<ChipVersionInfo>

<ID>
1
</ID>
</ID>
<type>
MCU
</type>
<firmwareVersion>
1.0.0
</firmwareVersion>
</ChipVersionInfo>
</ChipVersionInfoList>
<personBagLinkAlgoEngineVersion>
1.0.0
</personBagLinkAlgoEngineVersion>
<BIOSVersion>
test
</BIOSVersion>
<contactInformation>
test
</contactInformation>
<materialScanAlgorithmVersion>
test
</materialScanAlgorithmVersion>
</DeviceInfo>
Response Message
<ResponseStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<requestURL>
null
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.1.2 Get device information parameters

Request URL
GET /ISAPI/System/deviceInfo
Query Parameter
None
Request Message
None
Response Message

<deviceName>
test
</deviceName>
<deviceID>
test
</deviceID>
<deviceDescription>
test
<deviceLocation>
hangzhou
</deviceLocation>
<deviceStatus>
normal
</deviceStatus>
<DetailAbnormalStatus>

<hardDiskFull>
true
</hardDiskFull>
<hardDiskError>
true
true
</hardDiskError>
<ethernetBroken>
true
</ethernetBroken>
<ipaddrConflict>
true
</ipaddrConflict>
<illegalAccess>
true
</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>
V4.1.40
</firmwareVersion>
<firmwareReleasedDate>
2019-11-01
<encoderVersion>
V7.3
</encoderVersion>
<encoderReleasedDate>
2019-11-02
<bootVersion>
V1.3.4
</bootVersion>
<bootReleasedDate>
2019-11-03
</bootReleasedDate>
<panelVersion>
V1.0
</panelVersion>
<hardwareVersion>
0x0
</hardwareVersion>
<decoderVersion>
V1.0
</decoderVersion>
2019-01-01
</decoderReleasedDate>
<softwareVersion>
V1.23
</softwareVersion>
<capacity>
1
</capacity>
<usedCapacity>
1
</usedCapacity>
<deviceType>
Blade
</deviceType>
<subDeviceType>
accessControlTerminal
</subDeviceType>
<telecontrolID>
1
</telecontrolID>
<supportBeep>
true
</supportBeep>
<supportVideoLoss>
true
</supportVideoLoss>
<firmwareVersionInfo>
B-R-H5-0
<actualFloorNum>
1
</actualFloorNum>
<localZoneNum>
1
</localZoneNum>
<alarmOutNum>
1
</alarmOutNum>
<alarmInNum>
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>
1
</alarmLamp>
<RS485Num>
1
</RS485Num>
<radarVersion>
test
</radarVersion>
<cameraModuleVersion>
test
</cameraModuleVersion>
<mainversion>
1
</mainversion>
<subversion>
1
</subversion>
<upgradeversion>
1
</upgradeversion>
<customizeversion>
1
</customizeversion>
<companyName>
test
</companyName>
<copyright>
test
</copyright>
<systemName>
storageManagement
</systemName>
<systemStatus>
configured
</systemStatus>
<isLeaderDevice>
true
</isLeaderDevice>
<clusterVersion>
test
</clusterVersion>
<manufacturer>
hikvision
</manufacturer>
<centralStorageVersion>
test
</centralStorageVersion>
<powerOnMode>
button
</powerOnMode>
<customizedInfo>
test
</customizedInfo>
<verificationCode>
test
</verificationCode>
<supportUrl>
<supportUrl>
test
</supportUrl>
<subSerialNumber>
test
</subSerialNumber>
<languageType opt="chinese,english,spanish,portuguese,italian,french,russian,turkish,greek,czech,brazilianPortuguese">
chinese
</languageType>
<DockStation>

<Platform>

<type>
none
</type>
<ip>
test
</ip>
<port>
1
</port>
<userName>
test
</userName>
</Platform>
<centralStorageBackupEnabled>
true
</DockStation>
<webVersion>
test
</webVersion>
test
test
test
test
test
<enabled>
true
</enabled>
<confDeviceIdPrefix>
true
<OEMCode>
1
</OEMCode>
test
<bootTime>
1970-01-01T08:00:00+08:00
</bootTime>
test
<marketType>
0
</marketType>
<algorithmVersion>
test
</algorithmVersion>
<firmware>
test
</firmware>
<engineList>

<engine>
1
</engine>
</engineList>
<platform>
1
</platform>
<platformName>
test
</touchScreenVersionInfo>
<protocolFileURL>
test
</protocolFileURL>
<recycleRecordEnabled>
false
<decordChannelNums>
<VGANums>
</VGANums>
<USBNums>
</USBNums>
<auxoutNums>
</auxoutNums>
<expansionBoardVersion>
test
<initWizzardDisplay>
true
<beaconID>
test
</beaconID>
<isResetDeviceLanguage>
false
<dispalyNum>
0
</dispalyNum>
<bspVersion>
test
</bspVersion>
<dspVersion>
test
</dspVersion>
<localUIVersion>
test
</localUIVersion>
<OPCASubType>
detector
</OPCASubType>
<wiegandOutNum>
1
</wiegandOutNum>
<ChipVersionInfoList>

<ChipVersionInfo>
<ID>
1
</ID>
<type>
MCU
</type>
<firmwareVersion>
1.0.0
</firmwareVersion>
</ChipVersionInfo>
<personBagLinkAlgoEngineVersion>
1.0.0
<BIOSVersion>
V1.3.4
</BIOSVersion>
<contactInformation>
test
<temperatureModuleVersionInfo>
test
</temperatureModuleVersionInfo>
<PedestrianWarningModuleVersion>

<pedestrianWarningMCUVersion>
V1.3.4
</pedestrianWarningMCUVersion>
<pedestrianWarningRadarVersion>
V1.3.4
</pedestrianWarningRadarVersion>
<pedestrianRangingModuleVersion>
V1.3.4
V1.3.4
</pedestrianRangingModuleVersion>
</PedestrianWarningModuleVersion>
<encryptionModel>
test
</encryptionModel>
<UWBVersion>
V1.3.0
</UWBVersion>
<audioBoard>

<audioBoardModel>
C8
</audioBoardModel>
<audioBoardVersion>
V1.0.0 build 211210
</audioBoardVersion>
</audioBoard>
<materialScanAlgorithmVersion>
test
<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>
</DeviceInfo>
21.1.3 Get configuration capability of the device information parameters

Request URL
GET /ISAPI/System/deviceInfo/capabilities
Query Parameter
None
Request Message
None
Response Message

<deviceName min="1" max="128">
test
</deviceName>
<deviceID min="1" max="128">
123456
</deviceID>
<deviceDescription min="1" max="128">
test
<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>
<firmwareVersion min="1" max="64">
V4.1.40
</firmwareVersion>
<firmwareReleasedDate min="1" max="64">
<firmwareReleasedDate min="1" max="64">
build 181129
<encoderVersion min="1" max="64">
V7.3
</encoderVersion>
<encoderReleasedDate min="1" max="64">
build 20161223
<bootVersion min="1" max="16">
V1.3.4
</bootVersion>
<bootReleasedDate min="1" max="16">
100316
</bootReleasedDate>
<hardwareVersion min="1" max="16">
0x0
</hardwareVersion>
<deviceType
opt="IPCamera,IPDome,DVR,HybirdNVR,NVR,DVS,IPZoom,CVR,DockStation,RFID,InfoReleaseSys,MCU,SipServer,PHA,PWA,InfoTerminal,Switch,Visitor,PHAPro,ACS,VIS,FaceP
aymentTerminal,InteractiveTerminal,Cabinet,VoiceSpeaker,PowerAmplifier,FireControlMatrix,PagingMicrophone,ElevatorControl,conferencePlat,OPCA,NetworkReceive
r,PanicAlarmPanel,videoMatrix,EmbeddedCentralController,networkMic,PersonnelChannel,MediaComponentGateway,ImagingRadarPanel,TrafficTerminalServer,securityRa
dar">
IPCamera
</deviceType>
<subDeviceType opt="accessControlTerminal,attendanceCheckDevice,multiChannelAccessController,personAndIdCardDevice,doorStation,mainStation">
accessControlTerminal
</subDeviceType>
<telecontrolID min="1" max="16">
8
</telecontrolID>
<subChannelEnabled>
true
</subChannelEnabled>
<thrChannelEnabled>
true
</thrChannelEnabled>
<powerOnMode opt="button,adapter" def="button">
button
</powerOnMode>
<customizedInfo min="0" max="128">
chinese
</languageType>
<localZoneNum min="0" max="16">
1
</localZoneNum>
<alarmOutNum min="0" max="16">
1
</alarmOutNum>
<relayNum min="0" max="16">
1
</relayNum>
<electroLockNum min="0" max="16">
1
</electroLockNum>
<sirenNum min="0" max="16">
1
</sirenNum>
<alarmLamp min="0" max="16">
1
</alarmLamp>
<RS485Num min="0" max="16">
1
</RS485Num>
<DockStation>

<Platform>

<type opt="none, 9533, 8618, ISAPI">
0.0.0.0
</ip>
<port>
1
</port>
<userName>
</userName>
<password>
test
</password>
</Platform>
<centralStorageBackupEnabled opt="true, false">
true
<isSupportManufacturer>
true
</isSupportManufacturer>
</DockStation>
<webVersion>
1.0
</webVersion>
1.0
1.0
1.0
1.0
1.0
<enabled opt="true,false">
true
</enabled>
<confDeviceIdPrefix opt="true,false">
true
<simpleAlgorithmVersion min="0" max="10">
test
<bootTime>
1970-01-01T00:00:00+08:00
</bootTime>
<isSupportNewVersionDevlanguageSwitch>
true
</isSupportNewVersionDevlanguageSwitch>
K81
<marketType opt="0,1,2">
0
</marketType>
<protocolFileURL min="1" max="32">
test
</protocolFileURL>
<recycleRecordEnabled opt="true,false">
false
<decordChannelNums>
<VGANums>
</VGANums>
<USBNums>
</USBNums>
<auxoutNums>
</auxoutNums>
<expansionBoardVersion min="0" max="32">
test
<initWizzardDisplay opt="true,false">
test
</beaconID>
<isResetDeviceLanguage opt="true,false">
false
<dispalyNum>
2
</dispalyNum>
<bspVersion min="1" max="1">
test
</bspVersion>
</bspVersion>
<dspVersion min="1" max="1">
test
</dspVersion>
<localUIVersion min="1" max="1">
test
</localUIVersion>
<OPCASubType opt="PDA,pump,column,autoSampler">
detector
</OPCASubType>
<wiegandOutNum min="0" max="1">
1
</wiegandOutNum>
<ChipVersionInfoList size="6">

<ChipVersionInfo>
<ID min="0" max="1">
1
</ID>
<type opt="MCU,FPGA,MSTAR">
MCU
</type>
<firmwareVersion min="0" max="64">
1.0.0
</firmwareVersion>
</ChipVersionInfo>
<personBagLinkAlgoEngineVersion min="0" max="64">
1.0.0
<BIOSVersion min="0" max="16">
V1.3.4
</BIOSVersion>
<contactInformation min="0" max="64">
test
<PedestrianWarningModuleVersion>

<pedestrianWarningMCUVersion min="1" max="32">
V1.3.4
</pedestrianWarningMCUVersion>
<pedestrianWarningRadarVersion min="1" max="32">
V1.3.4
</pedestrianWarningRadarVersion>
<pedestrianRangingModuleVersion min="1" max="32">
V1.3.4
</pedestrianRangingModuleVersion>
</PedestrianWarningModuleVersion>
<encryptionModel min="0" max="16">
test
</encryptionModel>
<UWBVersion min="1" max="32">
V1.3.4
</UWBVersion>
<audioBoard>

<audioBoardModel min="0" max="32">
C8
</audioBoardModel>
<audioBoardVersion min="0" max="32">
V1.0.0 build 211210
</audioBoardVersion>
</audioBoard>
<materialScanAlgorithmVersion min="0" max="64">
1.0.0
<productionDate>
2022-04-02
</productionDate>
<wifiModuleMACAddress min="1" max="48">
44:47:cc:c8:d9:e4
</wifiModuleMACAddress>
<isSupportExportDeviceFingerFile>
true
</isSupportExportDeviceFingerFile>
<isSupportPromptMessage>
</isSupportPromptMessage>
<shortSerialNumber min="1" max="9">
test
</shortSerialNumber>
</DeviceInfo>
21.2 User Management

21.2.1 Log in to the device by digest
Request URL
GET /ISAPI/Security/userCheck
Query Parameter
None
Request Message
None
Response Message
<userCheck xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<statusValue>
200
</statusValue>
<statusString>
OK
</statusString>
<isDefaultPassword>
</isDefaultPassword>
<isRiskPassword>
</isRiskPassword>
<isActivated>
</isActivated>
<residualValidity>
1
</residualValidity>
<lockStatus>
unlock
</lockStatus>
<unlockTime>
1
</unlockTime>
<retryLoginTime>
1
</retryLoginTime>
</userCheck>
21.2.2 Set information for a single user

Request URL
PUT /ISAPI/Security/users/<indexID>?security=<security>&iv=<iv>
Query Parameter
Parameter Name Parameter Type Description
indexID string --
security string --
iv string --
Request Message
<User xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
1
</id>
<enabled>
true
</enabled>
<userName>
test
</userName>
<phoneNum>
test
</phoneNum>
</phoneNum>
<emailAddress>
test
</emailAddress>
<password>
test
</password>
<duressPassword>
test
</duressPassword>
<keypadPassword>
test
</keypadPassword>
<singleKeypadEnable>
true
</singleKeypadEnable>
<invalidkeypadPassword>
true
</invalidkeypadPassword>
<userOperateType>
1
</userOperateType>
<bondIpAddressList>

<bondIpAddress>

<id>
1
</id>
<ipAddress>
test
</ipAddress>
<ipv6Address>
</ipv6Address>
</bondIpAddress>
</bondIpAddressList>
<bondMacAddressList>

<bondMacAddress>

<id>
1
</id>
<macAddress>
test
</macAddress>
</bondMacAddress>
</bondMacAddressList>
<userLevel>
Administrator
</userLevel>
<attribute>

<inherent>
true
</inherent>
</attribute>
<loginPassword>
King726014
</loginPassword>
<cardList>

<card>

<id>
1
</id>
<name>
test
</name>
</card>
</cardList>
<remoteCtrlList>

<remoteCtrl>

<id>
1
</id>
<name>
</name>
</remoteCtrl>
</remoteCtrlList>
<PasswordPeriodPrompt>

<passwordPeriodType>
permanent
</passwordPeriodType>
<passwordPeriodbyDate>
90
</passwordPeriodbyDate>
</PasswordPeriodPrompt>
</User>
Response Message

<requestURL>
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
OK
</subStatusCode>
<lockStatus>
lock
</lockStatus>
<retryTimes>
1
</retryTimes>
</ResponseStatus>
21.2.3 Get information about a single user

Request URL
GET /ISAPI/Security/users/<indexID>?security=<security>&iv=<iv>
Query Parameter
indexID string --
security string --
iv string --
Request Message
None
Response Message


<id>
1
</id>
<enabled>
true
</enabled>
<userName>
</userName>
<phoneNum>
test
</phoneNum>
<emailAddress>
test
</emailAddress>
<duressPassword>
<duressPassword>
test
</duressPassword>
<keypadPassword>
test
</keypadPassword>
true
true
<userOperateType>

<bondIpAddress>

<id>
1
</id>
<ipAddress>
test
</ipAddress>
<ipv6Address>
</ipv6Address>
</bondIpAddress>

<bondMacAddress>

<id>
1
</id>
<macAddress>
test
</macAddress>
</bondMacAddress>
<userLevel>
Administrator
</userLevel>
<attribute>

<inherent>
true
</inherent>
</attribute>
<cardList>

<card>

<id>
1
</id>
<name>
test
</name>
</card>
</cardList>
<remoteCtrlList>

<remoteCtrl>

<id>
</id>
<name>
</name>
</remoteCtrl>
</remoteCtrlList>
<userNo>
501
</userNo>
<adminType>
Cloud
</adminType>
<installerType>

permanent
true
</userActivationStatus>
<invalidDuressPassword>
true
</invalidDuressPassword>
</User>
21.2.4 Get the configuration capability of a specific user

Request URL
GET /ISAPI/Security/users/<indexID>/capabilities
Query Parameter
indexID string --
Request Message
None
Response Message


<id min="1" max="64">
1
</id>
true
</enabled>
<userName min="1" max="32">
test
</userName>
<phoneNum min="1" max="11">
test
</phoneNum>
<emailAddress min="1" max="32">
test
</emailAddress>
<oldPassword min="1" max="16">
null
</password>
<duressPassword min="1" max="16">
null
</duressPassword>
<keypadPassword min="1" max="16">
null
</keypadPassword>
<singleKeypadEnable opt="true,false">
true
<invalidkeypadPassword opt="true,false">
true
<userOperateType opt="1,2,3">
1
</userOperateType>
</userOperateType>
<bondIpAddressList>

<bondIpAddress>
<id>
1
</id>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
</bondIpAddress>

<bondMacAddress>

<id>
1
</id>
<macAddress>
test
</macAddress>
</bondMacAddress>
<userLevel opt="Administrator,Operator,Viewer,installer,manufacturer,single,installerAdmin,installEmployee,Employee,DepartmentManager">
Administrator
</userLevel>
<attribute>
<inherent>
true
</inherent>
</attribute>
<belongUserId>
1
</belongUserId>
<belongOrgNo>
1
</belongOrgNo>
<cardList>
<card>
<id>
</id>
<name>
</name>
</card>
</cardList>
<remoteCtrlList>

<remoteCtrl>
<id>
</id>
<name>
</name>
</remoteCtrl>
</remoteCtrlList>
<userNo min="501" max="null">
1
</userNo>
<adminType opt="Cloud,LAN">
Cloud
</adminType>
<installerType opt="Cloud,LAN">
Cloud
</installerType>
expired shall be prompted during logging-in. password changing is not required in using-->
<passwordPeriodType opt="permanent,byDate" def="permanent">
permanent
effect by day: notification of password expired shall be prompted in time, but password changing is not required in using-->permanent
<passwordPeriodbyDate min="1" max="1200" def="90">
{$.User.PasswordPeriodPrompt.passwordPeriodType,eq,byDate}, attr:min{req, int},max{req, int},def{req, int}-->90
<userActivationStatus opt="true,false">
true
<invalidDuressPassword opt="true,false">
true
<userID min="1" max="64">
test
</userID>
</User>
21.2.5 Get information about all users

Request URL
GET /ISAPI/Security/users?security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
None
Response Message
<UserList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<User>

<id>
1
</id>
<enabled>
true
</enabled>
<userName>
</userName>
<phoneNum>
test
</phoneNum>
<emailAddress>
test
</emailAddress>
<duressPassword>
test
</duressPassword>
<keypadPassword>
true
true
<userOperateType>

<bondIpAddress>
<id>
1
</id>
<ipAddress>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
</bondIpAddress>

<bondMacAddress>

<id>
1
</id>
<macAddress>
test
</macAddress>
</bondMacAddress>
<userLevel>
Administrator
</userLevel>
<attribute>
<inherent>
true
</inherent>
</attribute>
<cardList>
<card>
<id>
</id>
<name>
</name>
</card>
</cardList>
<remoteCtrlList>

<remoteCtrl>
<id>
</id>
<name>
</name>
</remoteCtrl>
</remoteCtrlList>
<userNo>
501
</userNo>
<adminType>
permanent
<userActivationStatus>
true
<invalidDuressPassword>
true
<userID>
test
</userID>
</User>
</UserList>
21.2.6 Set information about all users
Request URL
PUT /ISAPI/Security/users?security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
<UserList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<User>

<id>
1
</id>
<enabled>
true
</enabled>
<userName>
test
</userName>
<password>
test
</password>
<keypadPassword>
1
</userOperateType>
<bondIpAddressList>

<bondIpAddress>

<id>
1
</id>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
</bondIpAddress>

<bondMacAddress>

<id>
1
</id>
<macAddress>
test
</macAddress>
</bondMacAddress>
<userLevel>
Administrator
</userLevel>
<attribute>

<inherent>
true
</inherent>
</attribute>
<loginPassword>
King726014
</loginPassword>
permanent
test
</userID>
</User>
</UserList>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
OK
</subStatusCode>
<lockStatus>
lock
</lockStatus>
<retryTimes>
1
</retryTimes>
</ResponseStatus>
21.2.7 Set the user permission of the device

Request URL
PUT /ISAPI/Security/UserPermission
Query Parameter
None
Request Message
<UserPermissionList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<UserPermission>

<id>
test
</id>
<userID>
test
</userID>
<userType>
admin
</userType>
<localPermission>

<backup>
true
</backup>
<record>
true
</record>
<playBack>
true
</playBack>
<preview>
true
</preview>
<videoChannelPermissionList>

<videoChannelPermission>

<id>
test
</id>
<playBack>
true
</playBack>
<preview>
true
</preview>
<record>
true
</record>
<backup>
true
</backup>
</backup>
<playBackDoubleVerification>
true
</playBackDoubleVerification>
<backupDoubleVerification>
true
</backupDoubleVerification>
</videoChannelPermission>
</videoChannelPermissionList>
<ptzControl>
true
</ptzControl>
<ptzChannelPermissionList>

<ptzChannelPermission>

<id>
</id>
<ptzControl>
true
</ptzControl>
</ptzChannelPermission>
</ptzChannelPermissionList>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
</restartOrShutdown>
<upgrade>
true
</upgrade>
<manageChannel>
true
</manageChannel>
<AIModelManagement>
true
</AIModelManagement>
<AITaskManagement>
true
</AITaskManagement>
<subSysOrZoneArm>
true
</subSysOrZoneArm>
<subSysOrZoneDisarm>
true
</subSysOrZoneDisarm>
<operateOutput>
true
</operateOutput>
<subSystemList>

<subSystem>
1
</subSystem>
</subSystemList>
<localFileMgr>
true
</localFileMgr>
<LEDConfig>
</LEDConfig>
<logMgr>
</logMgr>
<TIPConfig>
</TIPConfig>
<securityFunctionCfg>
</securityFunctionCfg>
<netWorkCfg>
</netWorkCfg>
<ISUPAccess>
</ISUPAccess>
<timeMgr>
</timeMgr>
<HDDMgr>
</HDDMgr>
<securitySystemMaintenance>
</securitySystemMaintenance>
<securityCheckingPicExport>
</securityCheckingPicExport>
<securityCheckingPicDelete>
</securityCheckingPicDelete>
<operationScheduleList>

<operationSchedule>

<operationScheduleEnabled>
</operationScheduleEnabled>
<operationDetailItem>
arm
</operationDetailItem>
<timeRange>

<beginTime>
00:00:00
</beginTime>
<endTime>
00:00:00
</endTime>
</timeRange>
</operationSchedule>
</operationScheduleList>
</localPermission>
<remotePermission>

<record>
</record>
<playBack>
</playBack>
<preview>
</preview>
<id>
</id>
<preview>
</preview>
<playBack>
</playBack>
<record>
</record>
<ptzControl>
true
</ptzControl>

<id>
test
</id>
<ptzControl>
</ptzControl>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
<upgrade>
true
</upgrade>
<upgradeNotShow>
true
</upgradeNotShow>
<voiceTalk>
true
</voiceTalk>
<transParentChannel>
true
</transParentChannel>
<contorlLocalOut>
<contorlLocalOut>
true
</contorlLocalOut>
<manageChannel>
true
</manageChannel>
<alarmOutOrUpload>
true
</alarmOutOrUpload>
<IRAID>

<rapidConfiguration>
true
</rapidConfiguration>
<reset>
true
</reset>
</IRAID>
<LEDConfig>
true
</LEDConfig>
<AIModelManagement>
true
<AITaskManagement>
true
</AITaskManagement>
<materialReview>
true
</materialReview>
<programReview>
true
</programReview>
<uploadMaterial>
true
</uploadMaterial>
<addProgram>
true
</addProgram>
<addSchedule>
true
</addSchedule>
<programPlay>
true
</programPlay>
<terminalMgr>
true
</terminalMgr>
<shopSmart>
true
</shopSmart>
<materialReplace>
true
</materialReplace>
<scheduleRelease>
true
</scheduleRelease>
<scheduleReview>
true
</scheduleReview>
<addTerminal>
true
</addTerminal>
<terminalDispatch>
true
</terminalDispatch>
<addUser>
true
</addUser>
<addOrg>
true
</addOrg>
<logMgr>
true
</logMgr>
<dataUpdate>
true
</dataUpdate>
<insertMessage>
true
</insertMessage>
<notReview>
true
</notReview>
<MgrTerminal>

<TerminalNoList>

<terminalNo>
1
</terminalNo>
</TerminalNoList>
<TerminalGroupNoList>


<terminalGroupNo>
1
</terminalGroupNo>
</TerminalGroupNoList>
</MgrTerminal>
<subSysOrZoneArm>
</subSysOrZoneArm>
<subSysOrZoneClearArm>
true
</subSysOrZoneClearArm>
<zoneBypass>
true
</zoneBypass>
<zoneBypassRecover>
true
</zoneBypassRecover>
<operateOutput>
</operateOutput>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<factoryReset>
true
</factoryReset>
<arm>
true
</arm>
<disarm>
true
</disarm>
<LPListAudit>
true
</LPListAudit>
<applicationWarehouse>
true
</applicationWarehouse>
<subSystemManagement>
true
</subSystemManagement>
<userOfModifyKeypadPasswordList>

<userOfModifyKeypadPassword>

<subUserType>
cloudAdmin
</subUserType>
</userOfModifyKeypadPassword>
</userOfModifyKeypadPasswordList>
<userOfModifyUserPermissionList>

<userOfModifyUserPermission>

<subUserType>
</subUserType>
</userOfModifyUserPermission>
</userOfModifyUserPermissionList>
<falseAlarmMaterialLibMgr>
true
</falseAlarmMaterialLibMgr>
<TIPConfig>
</TIPConfig>
<netWorkCfg>
</netWorkCfg>
<ISUPAccess>
</ISUPAccess>
<timeMgr>
</timeMgr>
<HDDMgr>
</HDDMgr>
</remotePermission>
<passwordValidity>
1
</passwordValidity>
<subUserType>
</subUserType>
</UserPermission>
</UserPermissionList>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
</subStatusCode>
<AttachInfo>

<StatusList>

<Status>

<index>
0
</index>
<statusCode>
0
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
ok
</subStatusCode>
</Status>
</StatusList>
</AttachInfo>
</ResponseStatus>
21.2.8 Get all users' permission

Request URL
GET /ISAPI/Security/UserPermission
Query Parameter
None
Request Message
None
Response Message


<UserPermission>

<id>
test
</id>
<userID>
test
</userID>
</userID>
<userType>

<backup>
true
</backup>
<record>
true
</record>
<playBack>
true
</playBack>
<preview>
true
</preview>


<id>
test
</id>
<playBack>
true
</playBack>
<preview>
true
</preview>
<record>
true
</record>
<backup>
true
</backup>
true
<ptzControl>
true
</ptzControl>


<id>
</id>
<ptzControl>
true
</ptzControl>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
<upgrade>
true
</upgrade>
<manageChannel>
true
</manageChannel>
<AIModelManagement>
true
<AITaskManagement>
true
</AITaskManagement>
<subSysOrZoneArm>
true
</subSysOrZoneArm>
true
<operateOutput>
true
</operateOutput>
<supportLinkageSubSystemList>

<subSystem>
1
</subSystem>
</supportLinkageSubSystemList>
<subSystemList>

<subSystem>
1
</subSystem>
</subSystemList>
</localPermission>
<remotePermission>

<record>
</record>
<playBack>
</playBack>
<preview>
</preview>
<id>
test
</id>
<preview>
</preview>
<playBack>
</playBack>
<record>
</record>
>true
<ptzControl>
true
</ptzControl>

<id>
test
</id>
<ptzControl>
</ptzControl>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
<upgrade>
true
</upgrade>
<upgradeNotShow>
true
</voiceTalk>
true
<contorlLocalOut>
true
</contorlLocalOut>
<manageChannel>
true
</manageChannel>
<alarmOutOrUpload>
true
</alarmOutOrUpload>
<IRAID>

true
<reset>
true
</reset>
</IRAID>
<LEDConfig>
true
</LEDConfig>
<AIModelManagement>
true
<AITaskManagement>
true
</AITaskManagement>
<materialReview>
true
</materialReview>
<programReview>
true
</programReview>
<uploadMaterial>
true
</uploadMaterial>
<addProgram>
true
</addProgram>
<addSchedule>
true
</addSchedule>
<programPlay>
true
</programPlay>
<terminalMgr>
true
</terminalMgr>
<shopSmart>
true
</shopSmart>
<materialReplace>
true
</materialReplace>
<scheduleRelease>
true
</scheduleRelease>
<scheduleReview>
true
</scheduleReview>
<addTerminal>
true
</addTerminal>
<terminalDispatch>
true
</terminalDispatch>
<addUser>
true
</addUser>
<addOrg>
true
</addOrg>
<logMgr>
true
</logMgr>
<dataUpdate>
true
</dataUpdate>
<insertMessage>
true
</insertMessage>
<notReview>
true
</notReview>
<MgrTerminal>

<TerminalNoList>

<terminalNo>
1
</terminalNo>
</TerminalNoList>
<TerminalGroupNoList>

<terminalGroupNo>
1
</terminalGroupNo>
</MgrTerminal>
<subSysOrZoneArm>
</subSysOrZoneArm>
true
<zoneBypass>
true
</zoneBypass>
<zoneBypassRecover>
true
<operateOutput>
</operateOutput>
<subSystem>
</subSystem>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<factoryReset>
true
</factoryReset>
<arm>
true
</arm>
<disarm>
true
</disarm>
<accessControl>
true
</accessControl>
<restoreTamper>
true
</restoreTamper>
<restoreConfirmedAlarm>
true
</restoreConfirmedAlarm>
<LPListAudit>
true
true


<subUserType>


<subUserType>
</subUserType>
true
</remotePermission>
<passwordValidity>
1
</passwordValidity>
<subUserType>
</subUserType>
</UserPermission>
21.2.9 Set permissions for a single user
Request URL
PUT /ISAPI/Security/UserPermission/<indexID>
Query Parameter
indexID string --
Request Message
<UserPermission xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
test
</id>
<userID>
test
</userID>
<userType>

<backup>
true
</backup>
<record>
</record>
<playBack>
</playBack>
<preview>
</preview>
<id>
</id>
<playBack>
</playBack>
<preview>
</preview>
<record>
</record>
<backup>
true
</backup>
true
<ptzControl>
true
</ptzControl>

<id>
</id>
<ptzControl>
</ptzControl>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
<upgrade>
true
</upgrade>
<upgradeNotShow>
</upgradeNotShow>
<manageChannel>
true
</manageChannel>
<AIModelManagement>
true
<AITaskManagement>
true
</AITaskManagement>
<subSysOrZoneArm>
</subSysOrZoneArm>
<operateOutput>
</operateOutput>

<subSystem>
1
</subSystem>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<localFileMgr>
</localFileMgr>
<LEDConfig>
</LEDConfig>
<logMgr>
</logMgr>
<TIPConfig>
</TIPConfig>
<netWorkCfg>
</netWorkCfg>
<ISUPAccess>
</ISUPAccess>
<timeMgr>
</timeMgr>
<HDDMgr>
</HDDMgr>

<operationSchedule>

arm
<timeRange>

<beginTime>
00:00:00
</beginTime>
<endTime>
00:00:00
00:00:00
</endTime>
</timeRange>
</localPermission>
<remotePermission>

<record>
</record>
<playBack>
</playBack>
<preview>
</preview>
<id>
</id>
<preview>
</preview>
<playBack>
</playBack>
<record>
</record>
<ptzControl>
true
</ptzControl>

<id>
test
</id>
<ptzControl>
</ptzControl>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
<upgrade>
true
</upgrade>
<upgradeNotShow>
true
</voiceTalk>
true
<contorlLocalOut>
true
</contorlLocalOut>
<manageChannel>
true
</manageChannel>
<alarmOutOrUpload>
true
</alarmOutOrUpload>
<IRAID>

true
<reset>
true
</reset>
</IRAID>
<LEDConfig>
<LEDConfig>
true
</LEDConfig>
<AIModelManagement>
true
<AITaskManagement>
true
</AITaskManagement>
<materialReview>
true
</materialReview>
<programReview>
true
</programReview>
<uploadMaterial>
true
</uploadMaterial>
<addProgram>
true
</addProgram>
<addSchedule>
true
</addSchedule>
<programPlay>
true
</programPlay>
<terminalMgr>
true
</terminalMgr>
<shopSmart>
true
</shopSmart>
<materialReplace>
true
</materialReplace>
<scheduleRelease>
true
</scheduleRelease>
<scheduleReview>
true
</scheduleReview>
<addTerminal>
true
</addTerminal>
<terminalDispatch>
true
</terminalDispatch>
<addUser>
true
</addUser>
<addOrg>
true
</addOrg>
<logMgr>
true
</logMgr>
<dataUpdate>
true
</dataUpdate>
<insertMessage>
true
</insertMessage>
<notReview>
true
</notReview>
<MgrTerminal>

<TerminalNoList size="10">

<terminalNo>
1
</terminalNo>
</TerminalNoList>
<TerminalGroupNoList size="10">

<terminalGroupNo>
1
</terminalGroupNo>
</MgrTerminal>
<subSysOrZoneArm>
</subSysOrZoneArm>
true
<zoneBypass>
true
</zoneBypass>
<zoneBypassRecover>
true
<operateOutput>
</operateOutput>

<subSystem>
1
</subSystem>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<factoryReset>
true
</factoryReset>
<arm>
true
</arm>
<disarm>
true
</disarm>
<accessControl>
</accessControl>
<restoreTamper>
true
</restoreTamper>
true
<LPListAudit>
true
true


<subUserType>
</subUserType>


<subUserType>
</subUserType>
true
<TIPConfig>
</TIPConfig>
<netWorkCfg>
</netWorkCfg>
<ISUPAccess>
</ISUPAccess>
<timeMgr>
</timeMgr>
<HDDMgr>
</HDDMgr>
</remotePermission>
<passwordValidity>
1
</passwordValidity>
<subUserType>
cloudAdmin
</subUserType>
</UserPermission>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.2.10 Get the permission of a single user

Request URL
GET /ISAPI/Security/UserPermission/<indexID>
Query Parameter
indexID string --
Request Message
None
Response Message
<UserPermission xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
test
</id>
<userID>
test
</userID>
<userType>

<backup>
true
</backup>
<record>
</record>
<playBack>
</playBack>
<preview>
</preview>
<id>
</id>
<playBack>
</playBack>
<preview>
<preview>
</preview>
<record>
</record>
<backup>
true
</backup>
>true
<ptzControl>
true
</ptzControl>

<id>
</id>
<ptzControl>
</ptzControl>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
<upgrade>
true
</upgrade>
<upgradeNotShow>
</upgradeNotShow>
<manageChannel>
true
</manageChannel>
<AIModelManagement>
<AITaskManagement>
</AITaskManagement>
<subSysOrZoneArm>
</subSysOrZoneArm>
<operateOutput>
</operateOutput>
<subSystem>
</subSystem>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<localFileMgr>
</localFileMgr>
<LEDConfig>
</LEDConfig>
<logMgr>
</logMgr>
<TIPConfig>
</TIPConfig>
<netWorkCfg>
</netWorkCfg>
<ISUPAccess>
</ISUPAccess>
<timeMgr>
</timeMgr>
<HDDMgr>
</HDDMgr>

<operationSchedule>

arm
<timeRange>
<beginTime>
00:00:00
</beginTime>
<endTime>
00:00:00
</endTime>
</timeRange>
</localPermission>
<remotePermission>

<record>
</record>
<playBack>
</playBack>
<preview>
</preview>
<id>
test
</id>
<preview>
</preview>
<playBack>
</playBack>
<record>
</record>
>true
<ptzControl>
true
</ptzControl>

<id>
test
</id>
<ptzControl>
</ptzControl>
<logOrStateCheck>
true
</logOrStateCheck>
<parameterConfig>
true
</parameterConfig>
<restartOrShutdown>
true
<upgrade>
true
</upgrade>
<upgradeNotShow>
</upgradeNotShow>
<voiceTalk>
true
</voiceTalk>
true
<contorlLocalOut>
true
</contorlLocalOut>
<manageChannel>
true
</manageChannel>
<alarmOutOrUpload>
true
</alarmOutOrUpload>
<IRAID>

true
<reset>
true
</reset>
</IRAID>
<LEDConfig>
</LEDConfig>
<AIModelManagement>
<AITaskManagement>
</AITaskManagement>
<materialReview>
true
</materialReview>
<programReview>
</programReview>
<uploadMaterial>
</uploadMaterial>
<addProgram>
</addProgram>
<addSchedule>
</addSchedule>
<programPlay>
</programPlay>
<terminalMgr>
</terminalMgr>
<shopSmart>
</shopSmart>
<materialReplace>
</materialReplace>
<scheduleRelease>
</scheduleRelease>
<scheduleReview>
</scheduleReview>
<addTerminal>
</addTerminal>
<terminalDispatch>
</terminalDispatch>
<addUser>
true
</addUser>
<addOrg>
</addOrg>
<logMgr>
</logMgr>
<dataUpdate>
</dataUpdate>
<insertMessage>
</insertMessage>
<notReview>
</notReview>
<MgrTerminal>

<terminalNo>
</terminalNo>
</TerminalNoList>

<terminalGroupNo>
</terminalGroupNo>
</MgrTerminal>
<subSysOrZoneArm>
</subSysOrZoneArm>
<zoneBypass>
</zoneBypass>
<zoneBypassRecover>
<operateOutput>
</operateOutput>
<subSystem>
</subSystem>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<factoryReset>
</factoryReset>
<arm>
</arm>
<disarm>
</disarm>
<accessControl>
</accessControl>
<restoreTamper>
true
</restoreTamper>
true
<LPListAudit>
true
true

<subUserType>
</subUserType>

<subUserType>
</subUserType>
true
<TIPConfig>
</TIPConfig>
<netWorkCfg>
</netWorkCfg>
<ISUPAccess>
</ISUPAccess>
<timeMgr>
</timeMgr>
<HDDMgr>
</HDDMgr>
</remotePermission>
<passwordValidity>
1
</passwordValidity>
<subUserType>
</subUserType>
</UserPermission>
21.2.11 Get the configuration capability of all users' permission

Request URL
GET /ISAPI/Security/UserPermission/capabilities
Query Parameter
None
Request Message
None
Response Message


<UserPermission>

<id min="1" max="32">
test
</id>
<userID min="1" max="32">
test
</userID>
<userType opt="admin,operator,viewer,installer,manufacturer,single">
admin
</userType>
<localPermission>

<backup opt="true,false">
true
</backup>
<record opt="true,false">
true
</record>
<playBack opt="true,false">
true
</playBack>
<preview opt="true,false">
true
true
</preview>
<id min="1" max="32">
test
</id>
true
</playBack>
true
</preview>
true
</record>
<backup opt="true,false">
true
</backup>
>true
<ptzControl opt="true,false">
true
</ptzControl>

<id min="1" max="32">
test
</id>
true
</ptzControl>
<logOrStateCheck opt="true,false">
true
</logOrStateCheck>
<parameterConfig opt="true,false">
true
</parameterConfig>
<restartOrShutdown opt="true,false">
true
<upgrade opt="true,false">
true
</upgrade>
<manageChannel opt="true,false">
true
</manageChannel>
<AIModelManagement>
<AITaskManagement>
</AITaskManagement>
<subSysOrZoneArm>
</subSysOrZoneArm>
<operateOutput>
</operateOutput>
<supportLinkageSubSystemList size="64">

<subSystem>
</subSystem>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<localFileMgr opt="true,false">
true
</localFileMgr>
<LEDConfig opt="true,false">
</LEDConfig>
<logMgr opt="true,false">
<logMgr opt="true,false">
</logMgr>
<TIPConfig opt="true,false">
</TIPConfig>
<securityFunctionCfg opt="true,false">
<netWorkCfg opt="true,false">
</netWorkCfg>
<ISUPAccess opt="true,false">
</ISUPAccess>
<timeMgr opt="true,false">
</timeMgr>
<HDDMgr opt="true,false">
</HDDMgr>
<securitySystemMaintenance opt="true,false">
<securityCheckingPicExport opt="true,false">
<securityCheckingPicDelete opt="true,false">

<operationSchedule>
<operationScheduleEnabled opt="true,false">
<operationDetailItem opt="all,arm,disarm,operateOutput">
arm
<timeRange>
<beginTime>
00:00:00
</beginTime>
<endTime>
00:00:00
</endTime>
</timeRange>
</localPermission>
<remotePermission>

true
</record>
true
</playBack>
true
</preview>
<id min="1" max="32">
test
</id>
true
</preview>
true
</playBack>
true
</record>
>true
true
</ptzControl>

<id>
</id>
</id>
true
</ptzControl>
<logOrStateCheck opt="true,false">
true
</logOrStateCheck>
<parameterConfig opt="true,false">
true
</parameterConfig>
<restartOrShutdown opt="true,false">
true
<upgrade opt="true,false">
true
</upgrade>
<upgradeNotShow opt="true,false">
true
</upgradeNotShow>
<voiceTalk opt="true,false">
true
</voiceTalk>
<transParentChannel opt="true,false">
true
<contorlLocalOut opt="true,false">
true
</contorlLocalOut>
<manageChannel opt="true,false">
true
</manageChannel>
<alarmOutOrUpload opt="true,false">
true
</alarmOutOrUpload>
<IRAID>

<rapidConfiguration opt="true,false">
true
<reset opt="true,false">
true
</reset>
</IRAID>
<LEDConfig>
</LEDConfig>
<AIModelManagement>
<AITaskManagement>
</AITaskManagement>
<materialReview>
true
</materialReview>
<programReview>
</programReview>
<uploadMaterial>
</uploadMaterial>
<addProgram>
</addProgram>
<addSchedule>
</addSchedule>
<programPlay>
</programPlay>
<terminalMgr>
</terminalMgr>
<shopSmart>
</shopSmart>
<materialReplace>
</materialReplace>
<scheduleRelease>
</scheduleRelease>
<scheduleReview>
</scheduleReview>
<addTerminal>
</addTerminal>
<terminalDispatch>
</terminalDispatch>
<addUser>
<addUser>
true
</addUser>
<addOrg>
</addOrg>
<logMgr>
</logMgr>
<dataUpdate>
</dataUpdate>
<insertMessage>
</insertMessage>
<notReview>
</notReview>
<MgrTerminal>

<terminalNo>
</terminalNo>
</TerminalNoList>

<terminalGroupNo>
</terminalGroupNo>
</MgrTerminal>
<subSysOrZoneArm>
</subSysOrZoneArm>
<zoneBypass>
</zoneBypass>
<zoneBypassRecover>
<operateOutput>
</operateOutput>
<supportLinkageSubSystemList size="64">

<subSystem>
</subSystem>
<subSystemList>

<subSystem>
</subSystem>
</subSystemList>
<factoryReset>
</factoryReset>
<arm>
</arm>
<disarm>
</disarm>
<accessControl>
</accessControl>
<restoreTamper opt="true,false">
true
<LPListAudit opt="true,false">
true
<subSystemManagement opt="true,false">
true
<userOfModifyKeypadPasswordList size="7">

<subUserType opt="cloudAdmin,localAdmin,installerAdmin,installEmployee,localInstaller,cloudOperator,localOperator">
cloudAdmin
</subUserType>
<userOfModifyUserPermissionList size="7">

<subUserType opt="cloudAdmin,localAdmin,installerAdmin,installEmployee,localInstaller,cloudOperator,localOperator">
cloudAdmin
</subUserType>
<falseAlarmMaterialLibMgr opt="true,false">
true
<TIPConfig opt="true,false">
</TIPConfig>
<netWorkCfg opt="true,false">
</netWorkCfg>
<ISUPAccess opt="true,false">
</ISUPAccess>
<timeMgr opt="true,false">
</timeMgr>
<HDDMgr opt="true,false">
</HDDMgr>
</remotePermission>
<passwordValidity min="0" max="365">
1
</passwordValidity>
<adminType opt="cloudAdmin,localAdmin">
cloudAdmin
</adminType>
<installerType opt="installerAdmin,installEmployee,localInstaller">
cloudAdmin
</installerType>
<operatorType opt="cloudOperator,localOperator">

<NTPServer>

<id>
1
</id>
<addressingFormatType>
hostname
</addressingFormatType>
<hostName>
hik12345
</hostName>
<ipAddress>
192.168.1.112
</ipAddress>
<ipv6Address>
1030:C9B4:FF12:48AA:1A2B
</ipv6Address>
<portNo>
123
</portNo>
<synchronizeInterval>
1440
</synchronizeInterval>
<enabled>
false
</enabled>
</NTPServer>
</NTPServerList>
21.3.2 Get the parameters of a NTP server

Request URL
GET /ISAPI/System/time/ntpServers/<NTPServerID>
Query Parameter
NTPServerID string --
Request Message
None
Response Message
<NTPServer xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
</id>
hostname
<hostName>
hik12345
</hostName>
<ipAddress>
192.168.1.112
</ipAddress>
<ipv6Address>
1030:C9B4:FF12:48AA:1A2B
</ipv6Address>
<portNo>
1
</portNo>
1440
<enabled>
false
</enabled>
</NTPServer>
21.3.3 Set the parameters of a NTP server

Request URL
PUT /ISAPI/System/time/ntpServers/<NTPServerID>
Query Parameter
NTPServerID string --
Request Message
<NTPServer xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
1
</id>
hostname
<hostName>
hik12345
</hostName>
<ipAddress>
192.168.1.112
</ipAddress>
<ipv6Address>
1030:C9B4:FF12:48AA:1A2B
</ipv6Address>
<portNo>
1
</portNo>
1440
<enabled>
false
</enabled>
</NTPServer>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.3.4 Get device time synchronization management parameters

Request URL
GET /ISAPI/System/time
Query Parameter
None
Request Message
None
Response Message
<Time xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<timeMode>
NTP
</timeMode>
<localTime>
2019-02-28T10:50:44+08:00
</localTime>
<timeZone>
CST-
8:00:00DST00:30:00,M4.1.0/02:00:00,M10.5.0/02:00:00
</timeZone>
<satelliteInterval>
60
</satelliteInterval>
<isSummerTime>
true
</isSummerTime>
<platformType>
1
</platformNo>
</Time>
21.3.5 Set device time synchronization management parameters

Request URL
PUT /ISAPI/System/time
Query Parameter
None
Request Message


<timeMode>
NTP
</timeMode>
<localTime>
2019-02-28T10:50:44+08:00
</localTime>
<timeZone>
CST-
8:00:00DST00:30:00,M4.1.0/02:00:00,M10.5.0/02:00:00
</timeZone>
<satelliteInterval>
60
<isSummerTime>
true
</isSummerTime>
<platformType>
EZVIZ
</platformType>
<platformNo>
1
</platformNo>
</Time>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
<FailedNodeInfoList>

<FailedNodeInfo>

<nodeID>
test
</nodeID>
<nodeIP>
test
</nodeIP>
<reason>
test
</reason>
</FailedNodeInfo>
</FailedNodeInfoList>
</ResponseStatus>
21.3.6 Get the capability of device time synchronization management

Request URL
GET /ISAPI/System/time/capabilities
Query Parameter
None
Request Message
None
Response Message


<timeMode opt="NTP,manual,satellite,SDK,28181,ONVIF,ALL(任何支持的校时方式都允许校时),NONE(不允校时或无校时源),platform">
NTP
</timeMode>
<localTime min="0" max="256">
test
</localTime>
<timeZone min="0" max="256">
test
</timeZone>
<satelliteInterval min="0" max="3600">
60
<timeType opt="local,UTC">
local
</timeType>
<platformType opt="EZVIZ">
EZVIZ
</platformType>
<platformNo min="1" max="2">
1
</platformNo>
<isSupportHistoryTime>
true
</isSupportHistoryTime>
<isSupportTimeFilter>
true
</isSupportTimeFilter>
<displayFormat opt="MM/dd/yyyy hh:mm,mm,dd-MM-yyyy hh,MM-dd-yyyy hh:mm,yyyy-MM-dd hh:mm">
MM/dd/yyyy hh:mm
</displayFormat>
<isSupportSyncDeviceNTPInfoToCamera>
true
</isSupportSyncDeviceNTPInfoToCamera>
<isSupportNTPService>
</isSupportNTPService>
</Time>
21.3.7 Get the configuration capability of parameters of a specific NTP (Network Time
Protocol) server
Request URL
GET /ISAPI/System/time/ntpServers/capabilities
Query Parameter
None
Request Message
None
Response Message


<NTPServer>

<id>
</id>
<addressingFormatType opt="ipaddress,hostname">
hostname
<hostName min="1" max="64">
hik12345
</hostName>
<ipAddress min="1" max="32">
192.168.1.112
</ipAddress>
<ipv6Address min="1" max="128">
1030:C9B4:FF12:48AA:1A2B
</ipv6Address>
<portNo min="1" max="65535">
123
</portNo>
<synchronizeInterval min="1" max="10800">
1440
true
</enabled>
</NTPServer>
</NTPServerList>
21.3.8 Set parameters of all NTP servers

Request URL
PUT /ISAPI/System/time/ntpServers
Query Parameter
None
Request Message


<NTPServer>

<id>
</id>
hostname
<hostName>
hik12345
</hostName>
<ipAddress>
192.168.1.112
</ipAddress>
<ipv6Address>
1030:C9B4:FF12:48AA:1A2B
</ipv6Address>
<portNo>
123
</portNo>
1440
<enabled>
false
</enabled>
</NTPServer>
</NTPServerList>
Response Message

<requestURL>
/ISAPI/xxxx
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.4 Log Management

21.4.1 Search for log information
Request URL
POST /ISAPI/ContentMgmt/logSearch
Query Parameter
None
Request Message
<CMSearchDescription xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<searchID>
test
</searchID>
<trackIDList>

<trackID>
1
</trackID>
</trackIDList>
<metaId>
log.std-cgi.com/Alarm/methaneConcentrationException
</metaId>
<timeSpanList>

<timeSpan>

<startTime>
1970-01-01T00:00:00Z
</startTime>
<endTime>
1970-01-01T01:00:00Z
</endTime>
</timeSpan>
</timeSpanList>
<searchResultPostion>
100
</searchResultPostion>
<maxResults>
0
</maxResults>
<onlySmart>
false
</onlySmart>
<logLevel>
emergency
</logLevel>
<alarmLevel>
high
</alarmLevel>
</CMSearchDescription>
Response Message
<CMSearchResult xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<searchID>
test
</searchID>
<responseStatus>
true
</responseStatus>
<responseStatusStrg>
OK
</responseStatusStrg>
<totalMatches>
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>
<VisAlarmRecord>

<type>
zone
</type>
</VisAlarmRecord>
</logInfo>
<ipAddress>
10.20.30.10
</ipAddress>
<object>
network
</object>
<params>
test
</params>
<seq>
test
</seq>
<additionInformation>
test
</additionInformation>
<panelUser>
admin
</panelUser>
<diskNumber>
0
</diskNumber>
<alarmInPort>
0
</alarmInPort>
<alarmOutPort>
0
</alarmOutPort>
<remoteHostIPAddress>
<remoteHostIPAddress>
10.12.25.23
</remoteHostIPAddress>
<logLevel>
emergency
</logLevel>
<alarmLevel>
high
</alarmLevel>
<moduleName>
test
</moduleName>
</logDescriptor>
</searchMatchItem>
</matchList>
</CMSearchResult>
21.4.2 Set log server parameters

Request URL
PUT /ISAPI/System/logServer
Query Parameter
None
Request Message
<LogServer xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<enabled>
true
</enabled>
ipaddress
<hostName>
test
</hostName>
<ipAddress>
test
</ipAddress>
<ipv6Address>
test
</ipv6Address>
<portNo>
1
</portNo>
<transmissionEncryption>
true
</transmissionEncryption>
<checkCertificate>
true
</checkCertificate>
<uploadInterval>
1
</uploadInterval>
<protocolType>
tcp
</protocolType>
<sysLogCacheSize>
1000
</sysLogCacheSize>
<sysLogLevel>
</sysLogLevel>
<serverLogLevel>
</serverLogLevel>
<alarmLogCacheSize>
1000
</alarmLogCacheSize>
</LogServer>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.4.3 Get log server parameters

Request URL
GET /ISAPI/System/logServer
Query Parameter
None
Request Message
None
Response Message
<LogServer xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<enabled>
true
</enabled>
ipaddress
<hostName>
test
</hostName>
<ipAddress>
test
</ipAddress>
<ipv6Address>
test
</ipv6Address>
<portNo>
1
</portNo>
<transmissionEncryption>
true
<checkCertificate>
true
</checkCertificate>
<uploadInterval>
1
</uploadInterval>
<protocolType>
tcp
</protocolType>
<sysLogCacheSize>
1000
</sysLogCacheSize>
<sysLogLevel>
</sysLogLevel>
<serverLogLevel>
</serverLogLevel>
<alarmLogCacheSize>
1000
</LogServer>
21.4.4 Get the configuration capability of log servers
Request URL
GET /ISAPI/System/logServer/capabilities
Query Parameter
None
Request Message
None
Response Message
<LogServerCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

test
</enabled>
test
test
</hostName>
</ipAddress>
</ipv6Address>
1
</portNo>
<transmissionEncryption opt="true,false">
true
<checkCertificate opt="true,false">
true
</checkCertificate>
<uploadInterval min="1" max="24" def="1">
1
</uploadInterval>
<protocolType opt="tcp,udp">
tcp
</protocolType>
<sysLogCacheSize min="10" max="3000" def="1000">
1000
</sysLogCacheSize>
<sysLogLevel opt="emergency,alert,critical,error,warning,notice,information,debug">
emergency
</sysLogLevel>
<serverLogLevel opt="emergency,alert,critical,error,warning,notice,information,debug">
emergency
</serverLogLevel>
<alarmLogCacheSize min="10" max="3000" def="1000">
1000
</LogServerCap>
21.5 System Maintenance

21.5.1 Get the system service capability (JSON format)
Request URL
GET /ISAPI/System/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"statusCode": 1,
/*ro, opt, int, status code, desc:1 (succeeded). It is required when an error occurred*/
"statusString": "ok",
/*ro, opt, string, status description, range:[1,64], desc:ok (succeeded). It is required when an error occurred*/
"subStatusCode": "ok",
/*ro, opt, string, sub status code, range:[1,64], desc:"ok" (succeeded). It is required when an error occurred*/
"errorCode": 1,
/*ro, req, int, error code, desc:when the value of statusCode is not 1, it corresponds to subStatusCode*/
"errorMsg": "ok",
/*ro, req, string, error information, desc:this node is required when the value of statusCode is not 1*/
"isSupportBlackFDControl": true,
/*ro, opt, bool, whether it supports list management*/
"isSupportExecuteControl": true,
/*ro, opt, bool, whether it supports arming management*/
"isSupportEventUpload": true,
/*ro, opt, bool, whether it supports uploading events*/
"isSupportSDKServer": true,
/*ro, opt, bool, whether it supports SDK service configuration*/
"isSupportAI": true,
/*ro, opt, bool, whether the applications support functions related to AI algorithm, desc:functions include AI algorithm management, task analysis,
event uploading, which will be displayed or hidden in the web*/
"isSupportBehavior": true,
/*ro, opt, bool, whether the applications support functions related to behavior analysis algorithm, desc:functions include behavior analysis algorithm
management, task analysis, event uploading, which will be displayed or hidden in the web*/
"isSupportAlgorithm": true,
/*ro, opt, bool, whether it supports the algorithm library, desc:if this node does not exist, you need to call
/ISAPI/Intelligent/algorithm/capabilities?format=json by GET method to check whether the device supports the algorithm library*/
"isSupportHttpHosts": true,
/*ro, opt, bool, whether it supports security control panel configuration, desc:related URI: /ISAPI/Event/notification/httpHosts/capabilities?
format=json*/
"isSupportDST": true,
/*ro, opt, bool, whether the device supports Daylight Saving Time (DST)*/
"isSupportEhome": true
/*ro, opt, bool, whether the device supports ISUP functions*/
}
21.5.2 Import device configuration file

Request URL
POST /ISAPI/System/configurationData?security=<security>&iv=<iv>&secretkey=<secretkey>
Query Parameter
security string --
iv string --
secretkey string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.5.3 Export device configuration file

Request URL
GET /ISAPI/System/configurationData?security=<security>&iv=<iv>&secretkey=<secretkey>
Query Parameter
security string --
iv string --
secretkey string --
Request Message
None
Response Message
None
21.5.4 Get the system security capability

Request URL
GET /ISAPI/Security/capabilities
Query Parameter
None
Request Message
None
Response Message
<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>
true
</isSupportStreamEncryption>
<securityVersion opt="1,2">
1
</securityVersion>
<keyIterateNum>
100
</keyIterateNum>
<isSupportUserCheck>
true
</isSupportUserCheck>
<isSupportGUIDFileDataExport>
true
</isSupportGUIDFileDataExport>
<isSupportSecurityQuestionConfig>
true
</isSupportSecurityQuestionConfig>
<supportSecurityNode opt="wirelessServer,wirelessDial">
wirelessServer
</supportSecurityNode>
<isSupportGetOnlineUserListSC>
true
</isSupportGetOnlineUserListSC>
<SecurityLimits>

<LoginPasswordLenLimit min="1" max="16">
1
</LoginPasswordLenLimit>
<SecurityAnswerLenLimit min="1" max="128">
1
</SecurityAnswerLenLimit>
</SecurityLimits>
<RSAKeyLength opt="512,1024,2048" def="2048">
2048
</RSAKeyLength>
<isSupportONVIFUserManagement>
true
</isSupportONVIFUserManagement>
<WebCertificateCap>

<CertificateType opt="basic,digest,digest/basic">
basic
</CertificateType>
<SecurityAlgorithm>

<algorithmType opt="MD5,SHA256,MD5/SHA256">
MD5
</algorithmType>
</SecurityAlgorithm>
</WebCertificateCap>
<isSupportConfigFileImport>
true
</isSupportConfigFileImport>
<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
</isSupportPictureURlCertificate>
<isSupportGB35114Certificate>
true
</isSupportGB35114Certificate>
<isSupportAuthenticationMode opt="uKey,private">
private
</isSupportAuthenticationMode>
<isSupportUnloggedUserPermissionConfig opt="true,false">
true
</isSupportUnloggedUserPermissionConfig>
<isSupportUserNamePasswordCheckUpgrade>
true
</isSupportUserNamePasswordCheckUpgrade>
<isSupportDeviceCertificatesManagement>
true
</isSupportDeviceCertificatesManagement>
<isSupportSIPCertificatesManagement>
true
</isSupportSIPCertificatesManagement>
<isSupportDeviceSelfSignCertExport>
true
</isSupportDeviceSelfSignCertExport>
<isSupportSecurityEmail>
true
</isSupportSecurityEmail>
<isSupportRTSPCertificate opt="true,false">
true
</isSupportRTSPCertificate>
<maxIllegalLoginTimes min="3" max="20" def="5">
3
</maxIllegalLoginTimes>
<SecurityAdvanced>

<securityEnhanced>
true
</securityEnhanced>
<noOperationEnabled>
true
</noOperationEnabled>
<noOperationTime min="1" max="60" def="15">
15
</noOperationTime>
<isSupportDigestStatus>
true
</isSupportDigestStatus>
<passwordLimitLevel opt="middling,high">
middling
</passwordLimitLevel>
</SecurityAdvanced>
<LoginLinkNum>

<maxLinkNum min="1" max="128" def="50">
50
</maxLinkNum>
</LoginLinkNum>
<isSupportCCClientCertificate>
true
</isSupportCCClientCertificate>
1
</passwordValidity>
<isSupportResetChannelPassword>
true
</isSupportResetChannelPassword>
<DoubleVerificationCap>

<isSupportUsersConfig>
true
</isSupportUsersConfig>
<isSupportUsersPermissionConfig>
true
</isSupportUsersPermissionConfig>
</DoubleVerificationCap>
<isSupportUserSearch>
true
</isSupportUserSearch>
1
</keypadPassword>
<installerKeypadPassword min="1" max="10">
1
</installerKeypadPassword>
<operatorKeypadPassword min="1" max="10">
1
</operatorKeypadPassword>
1
</userOperateType>
<isSptUserEnabled>
true
</isSptUserEnabled>
<isSptAdminCap>
true
</isSptAdminCap>
<isSupportBackLogCfg>
true
</isSupportBackLogCfg>
<isSupportBackLogExport>
true
</isSupportBackLogExport>
<isSupportModifyInnerPassword opt="true,false">
true
</isSupportModifyInnerPassword>
<isSupportEncryptCertificate>
true
</isSupportEncryptCertificate>
<maxIllegalLoginLockTime min="1" max="120" def="30.00">
1
</maxIllegalLoginLockTime>
<cloudSensitiveInfoEncryptType>
2.1
</cloudSensitiveInfoEncryptType>
<isSupportCertificateCustomID>
true
</isSupportCertificateCustomID>
<isSupportResetLANPassword>
true
</isSupportResetLANPassword>
<isSupportPicHttpsCertificatesManagement>
true
</isSupportPicHttpsCertificatesManagement>
<isSupportAKSKImport>
true
</isSupportAKSKImport>
<isSupportAKSKExport>
true
</isSupportAKSKExport>
<isSupportAKSKReset>
true
</isSupportAKSKReset>
<ExportCertificateFile>

<type opt="GB35114,GB35114Service">
GB35114
</type>
</ExportCertificateFile>
<isSupportGB351114FDWSFCertificate>
true
</isSupportGB351114FDWSFCertificate>
<isSupportMediaObjectEncryption>
true
</isSupportMediaObjectEncryption>
<isSupportDisclaimer>
true
</isSupportDisclaimer>
<isSupportSoftwareLicense>
true
</isSupportSoftwareLicense>
<isSupportInstallerCap>
true
</isSupportInstallerCap>
<isSupportResetPasswordFile>
true
</isSupportResetPasswordFile>
<isNotSupportLogSeverCertificate>
true
</isNotSupportLogSeverCertificate>
</SecurityCap>
21.5.5 Set device language parameters

Request URL
PUT /ISAPI/System/DeviceLanguage
Query Parameter
None
Request Message
<DeviceLanguage xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<language>
SimChinese
</language>
</DeviceLanguage>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.5.6 Get the languages supported by the device

Request URL
GET /ISAPI/System/DeviceLanguage
Query Parameter
None
Request Message
None
Response Message


<language>
SimChinese
</language>
</DeviceLanguage>
21.5.7 Get the capability of configuring the device language

Request URL
GET /ISAPI/System/DeviceLanguage/capabilities
Query Parameter
None
Request Message
None
Response Message


<language
opt="SimChinese,TraChinese,English,Russian,Bulgarian,Hungarian,Greek,German,Italian,Czech,Slovakia,French,Polish,Dutch,Portuguese,Spanish,Romanian,Turkish,J
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">
true
</upgradeFirmWareEnabled>
</DeviceLanguage>
21.5.8 Set SSH parameters

Request URL
PUT /ISAPI/System/Network/ssh
Query Parameter
None
Request Message
<SSH xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<enabled>
true
</enabled>
<port>
22
</port>
</SSH>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.5.9 Get the storage capability of the device

Request URL
GET /ISAPI/ContentMgmt/capabilities
Query Parameter
None
Request Message
None
Response Message
<RacmCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<isSupportZeroChan>
true
</isSupportZeroChan>
<inputProxyNums>
0
</inputProxyNums>
<eSATANums>
0
</eSATANums>
<miniSASNums>
0
</miniSASNums>
<nasNums>
0
</nasNums>
<ipSanNums>
0
</ipSanNums>
<isSupportRaid>
true
</isSupportRaid>
<isSupportExtHdCfg>
true
</isSupportExtHdCfg>
<isSupportTransCode>
true
</isSupportTransCode>
<isSupportIpcImport>
true
</isSupportIpcImport>
<NasMountType>
true
<isNFSSupportAuthentication>
true
</isNFSSupportAuthentication>
<isCIFSSupportAuthentication>
true
</isCIFSSupportAuthentication>
</NasMountType>
<isSupportIpcStreamType>
true
</isSupportIpcStreamType>
<isSupportIOInputProxy>
true
</isSupportIOInputProxy>
<isSupportIOOutputProxy>
true
</isSupportIOOutputProxy>
<isSupportPTZRs485Proxy>
true
</isSupportPTZRs485Proxy>
<isSupportSrcIDSearch>
true
</isSupportSrcIDSearch>
<isSupportReversePlayback>
true
</isSupportReversePlayback>
<isSupportSMARTTest>
true
</isSupportSMARTTest>
<isSupportDownloadByTime>
true
</isSupportDownloadByTime>
<pictureSearchType
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,
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
tUp,toiletTarry,
playCellphone,vehicleMonitor,vibrationDetection,running,retention,spacingChange,yardTarry,keyPersonGetUp,sitQuietly,standUp,plateRecognition,smoking,onThePh
one,fatigueDriving,
notLookingStraightAhead,leaveThePost,seatBelt,sunglasses,identityAbnormal,ForwardCollisionWarning,LaneDepartureWarning,BlindSpotDetection,HeadwayMonitoringW
arning,
PedestrianCollisionWarning,SuddenSpeedUp,SuddenSpeedDown,SuddenLeftTurn,SuddenRightTurn,Turnover,NotYieldToPedestrian,unregisteredStreetVendor,stallOutsideS
hop,stallOccupyingRoad, illegalHeap,illegalParkingofNon-
MotorVehicle,illegalOutdoorAdvertisement,packGarbage,stallUnderUmbrella,dustbinOverflow,exposeGarbage,hangClothingAlongStreet,allPic,ATMPanel,
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,ReID,methaneConcen
trationException,methaneLightIntensityException,bannerDetection,variableDataEvent,shipChannelAbnormal,radarVideoDetection">
AllEvent
</pictureSearchType>
<recordSearchType
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">
AllEvent
</recordSearchType>
<isSupportActivateIpc>
true
</isSupportActivateIpc>
<isSupportCheckIpcSecurity>

<isSupportCheckPassword>
true
</isSupportCheckPassword>
</isSupportCheckIpcSecurity>
<isSupportMainAndSubRecord>
true
</isSupportMainAndSubRecord>
<isSupportSyncIPCPassword>
true
</isSupportSyncIPCPassword>
<isSupportTransferIPC>
true
</isSupportTransferIPC>
<isSupportSmartSearch>
true
</isSupportSmartSearch>
<isSupportPOS>
true
</isSupportPOS>
<isSupportLinkNum>
true
</isSupportLinkNum>
<isSupportPassBackBasicCfg>
true
</isSupportPassBackBasicCfg>
<PassBackTaskConfig>

<isSupportAddTask>
true
</isSupportAddTask>
<isSupportSearchTask>
true
</isSupportSearchTask>
<isSupportControlTask>
true
</isSupportDeleteTask>
</PassBackTaskConfig>
<PassBackPlanConfig>

<isSupportAddPlan>
true
</isSupportAddPlan>
<isSupportSearchPlan>

<isSupportIRAIDRapidConfiguration>
true
</isSupportIRAIDRapidConfiguration>
</IRAIDCap>
<isSupportStorageExtraInfo>
true
</isSupportStorageExtraInfo>
<isSupportRecordStatus>
true
</isSupportRacmChannelsCap>
<LockCap>

<LockByName>

<TrackId>
101
</TrackId>
<recordName min="1" max="100">
test
</recordName>
<command opt="lock,unlock">
lock
</command>
<duration min="1" max="10">
1
</duration>
<recorderCode min="1" max="100">
test
</recorderCode>
<policeCode min="1" max="100">
test
</policeCode>
</LockByName>
<LockByTime>

<TrackId>
101
</TrackId>
<recordType opt="ALL,MANUAL,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,COMMAND,SMART">
ALL
</recordType>
<startDateTime>
1970-01-01T00:00:00+08:00
</startDateTime>
<endDateTime>
1970-01-01T00:00:00+08:00
</endDateTime>
<command opt="lock,unlock">
lock
</command>
<duration min="1" max="10">
1
</duration>
</LockByTime>
</LockCap>
<isSupportForamtAll>
true
</isSupportForamtAll>
<isSupportExtendCabinetCfg>
true
</isSupportExtendCabinetCfg>
<diskGroupNums>
0
</diskGroupNums>
<ExternalDevice>

<USB>

<debugLogOutput>
true
</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>
<secondaryType opt="test">
all
</secondaryType>
</SecurityLogType>
</SecurityLogTypeList>
</SecurityLog>
<isSupportGetBackupDevice>
true
</isSupportGetBackupDevice>
<isSupportAutoBackup>
true
</iSptInputProxyChanCap>
<isSupportLogDataPackage>
true
</isSupportLogDataPackage>
<logSearchTimeSpanNums>
0
</logSearchTimeSpanNums>
<CloudStorageServerCap>

<isSupportCloudStorageParameter>
true
</isSupportCloudStorageParameter>
<isSupportCloudStoragePool>
true
</isSupportCloudStoragePool>
<supportChannelsNum>
0
</supportChannelsNum>
</CloudStorageServerCap>
<isSupportWebPrivatePlaybackByUTC>
true
</isSupportWebPrivatePlaybackByUTC>
<isSupportFindCommonFileByUTC>
true
</isSupportFindCommonFileByUTC>
<isSupportFindEventFileByUTC>
true
</isSupportFindEventFileByUTC>
<isSupportSmartSearchRecordByUTC>
true
</isSupportSmartSearchRecordByUTC>
<isSupportMRDSearchByTimeZone>
true
</isSupportMRDSearchByTimeZone>
<isSupportSearchRecordLabelByUTC>
true
</isSupportSearchRecordLabelByUTC>
<isSupportSearchPictureByUTC>
true
</isSupportSearchPictureByUTC>
<isSupportSmartSearchPictureByUTC>
true
</isSupportSmartSearchPictureByUTC>
<isSupportFindLogByUTC>
true
</isSupportFindLogByUTC>
<isSupportUploadRecordByUTC>
true
</isSupportUploadRecordByUTC>
<isSupportPlaybackByUTC>
true
</isSupportPlaybackByUTC>
<isSupportFaceDetecttionAlarmByTimeZone>
true
</isSupportFaceDetecttionAlarmByTimeZone>
<isSupportSourceModify>
true
</isSupportCountingSearchByUTC>
<isSupportCluster>
true
</isSupportCluster>
<supportAIDTFSType opt="illegalParking,wrongdirection,crosslane,vehicleexist,lanechange,turnround,evidence">
illegalParking
</supportAIDTFSType>
<isSupportMisinfoStateSearch>
true
</isSupportMisinfoStateSearch>
<isSupportOneKeyOperationStorageData>
true
</isSupportOneKeyOperationStorageData>
<eventRecordSearch>

<eventType opt="faceContrast,faceSnap,vehicleMatchResult,hawkResult,VMD,alarmIn,inquestAlarm,behavior,posAlarm,accessControllerEvent,IOTD,trialAlarm">
faceContrast
</eventType>
<recordChannelListSize>
16
</recordChannelListSize>
<triggerChannelsSize>
16
</triggerChannelsSize>
<auxEventType opt="faceContrastFailure,faceContrastSuccess">
faceContrastFailure
</auxEventType>
<inquestParam>

<inquestEventType opt="any,inquestStart,inquestStop,inquestTag,inquestSegment">
any
</inquestEventType>
<roomIndex min="1" max="65535">
1
</roomIndex>
</inquestParam>
<behavior>

<behaviorEventType
opt="any,linedetection,regionEntrance,regionExiting,fielddetection,loitering,parking,violentMotion,group,unattendedBaggage,attendedBaggage,audioAbnormal">
any
</behaviorEventType>
</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>
</litigant1>
<litigant2 min="0" max="32">
test
</litigant2>
<chiefJudge min="0" max="32">
test
</chiefJudge>
<caseType opt="0,1,2">
0
</caseType>
</trialParam>
<accessControllerEvent>

<majorEventType>
0
</majorEventType>
<subEventType>
0
</subEventType>
<cardNo min="0" max="32">
test
</cardNo>
<name min="0" max="32">
test
</name>
<MACAddr min="0" max="12">
test
</MACAddr>
</accessControllerEvent>
<IOTD>

<deviceType opt="0,1,2,3,4,5,6">
0
</deviceType>
<subEventType>
test
</subEventType>
<IoTchannelID size="256">
test
</IoTchannelID>
<caseSensitive opt="true,false">
false
</caseSensitive>
<combinateMode opt="and,or">
and
</combinateMode>
<keyword size="3">
test
</keyword>
<zonNo>
1
</zonNo>
</IOTD>
</eventRecordSearch>
<isSupportManualRecord>
true
</isSupportRemark>
<FileUpload>

<enabled>
true
</enabled>
</FileUpload>
<PoliceInfoUpload>

<enabled>
true
</enabled>
</PoliceInfoUpload>
<PoliceInfo>

<policeID>
true
</policeID>
<policeCode>
true
</policeCode>
<policeName>
true
</policeName>
<password>
true
</password>
<deviceID>
true
</deviceID>
<isSupportPoliceFacePicture>
true
</isSupportPoliceFacePicture>
</PoliceInfo>
<isSupportAssignChannelID>

<PictureSearchSubType>

<mainType>
vehicleDetection
</mainType>
<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>
true
</isSupportSourceStatus>
<isSupportSSDSMARTTest>
true
</isSupportSSDSMARTTest>
<MobileStorage>

<isSupportGetFileTime>
true
</isSupportGetFileTime>
</MobileStorage>
<isSupportGetChannelList>
true
</isSupportGetChannelList>
<isSupportCascade>
true
</isSupportCascade>
<isSupportFileManagement>
true
</isSupportFileManagement>
<isSupportPictureInfo>
true
</isSupportPictureInfo>
<isSupportChanStatusPage>
test
</isSupportChanStatusPage>
<isSupportRecordSearchByTargetType>
true
</isSupportRecordSearchByTargetType>
<storIpcStartNo>
0
</storIpcStartNo>
<maxRecordIpcNum>
0
</maxRecordIpcNum>
<maxConferenceIpcNum>
0
</maxConferenceIpcNum>
<decIpcStartNo>
0
</decIpcStartNo>
<maxDecodeIpcNum>
0
</maxDecodeIpcNum>
</maxDecodeIpcNum>
<pipIpcStartNo>
0
</pipIpcStartNo>
<maxPipIpcNum>
0
</maxPipIpcNum>
<isSupportLogSearch>
true
</isSupportLogSearch>
<isSupportRecordSearch>
true
</isSupportRecordSearch>
<isSupportRecordDownload>
true
</isSupportRecordDownload>
<isSupportPnp opt="true,false">
true
</isSupportPnp>
<esataUseage>
backup
</esataUseage>
<subType opt="all,leave,on,sleep">
true
</isSupportManualBackup>
<isSupportLinkToIPCWeb>
true
</isSupportLinkToIPCWeb>
<isSupportIPCConfigCSV>
true
</isSupportIPCConfigCSV>
<isSupportExperimentExam>
true
</isSupportExperimentExam>
<isSupportPOSRecordSearch>
true
</isSupportPOSRecordSearch>
<isSupportSpare>
true
</isSupportTracksDates>
<isSupportRecordAudio>
true
</isSupportRecordAudio>
<isSupportSearchAudio>
true
</isSupportAudioDailyDistribution>
<isSupportDownloadAudio>
true
</isSupportDownloadAudio>
<isSupportDeleteAudio>
true
</isSupportDeleteAudio>
<isSupportEventRecordCfg>
true
</isSupportEventRecordCfg>
<isSupportSearchRemoteAlbum>
true
</isSupportSearchRemoteAlbum>
<isNotSupportTracks>
true
</isSupportFileManagement>
</RacmCap>
21.5.10 Get the system service capability (JSON format)
Request URL
GET /ISAPI/System/capabilities
Query Parameter
None
Request Message
None
Response Message
<DeviceCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<isSupportPreview>
true
</isSupportPreview>
<isSupportSystemMaintain>
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>
true
</isSupportBond>
<isSupport802_1x>
true
</isSupport802_1x>
<isSupportNtp>
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 opt="true,false">
true
</isSupportSSH>
<isSupportNetPreviewStrategy>
true
</isSupportNetPreviewStrategy>
<isSupportEZVIZ>
true
</isSupportEZVIZ>
<isSupportEhome>
true
</isSupportEhome>
<isSupportWirelessDial>
true
</isSupportWirelessDial>
<isSupportWirelessServer>
true
</isSupportWirelessServer>
<isSupportWPS>
true
</isSupportWPS>
<isWirelessMutexWithWirelessServer>
true
</isWirelessMutexWithWirelessServer>
<isSupportMACFilter>
true
</isSupportMACFilter>
<GB28181Cap>

<isSupportGB28181Service>
</isSupportGB28181Service>
</GB28181Cap>
<WPS>

<NetworkInterfaceList size="2">

<NetworkInterface>

<id>
1
</id>
<enabled>
true
</enabled>
<isSupportAutoConnect>
true
</isSupportAutoConnect>
<isSupportDevicePinCode>
true
</isSupportDevicePinCode>
<isSupportDevicePinCodeUpdate>
true
</isSupportDevicePinCodeUpdate>
<ApPinCode>

<ssid min="1" max="1">
test
</ssid>
<pinCode min="1" max="1">
test
</pinCode>
</ApPinCode>
</NetworkInterface>
</NetworkInterfaceList>
</WPS>
<isSupportRFIDData>
true
</isSupportRFIDData>
<isSupportwifiProbeSSID>
true
</isSupportwifiProbeSSID>
<isSupportWifiProbe>
true
</isSupportWifiProbe>
<verificationCode min="1" max="1">
test
</verificationCode>
<WPSCap>

<isSupport>
true
</isSupport>
</isSupport>
<isSupportAutoConnect>
true
</isSupportAutoConnect>
</WPSCap>
<NetWorkMode>

<workMode>
true
</workMode>
</NetWorkMode>
<VerificationCodeModification>

<verificationCodeType opt="normal,empty">
true
</verificationCodeType>
<isSupportDeclarationURL>
true
</isSupportDeclarationURL>
<isSupportPrivacyPolicyURL>
true
</isSupportPrivacyPolicyURL>
<verificationCodeModify opt="true,false">
true
</verificationCodeModify>
<Hyperlinks>

<declarationURL>
test
</declarationURL>
<privacyPolicyURL>
test
</privacyPolicyURL>
</Hyperlinks>
<isSupportVerificationCodeCheck>
true
</isSupportVerificationCodeCheck>
<isSupportOldVerificationCode>
true
</isSupportOldVerificationCode>
</VerificationCodeModification>
<isSupportIntegrate>
true
</isSupportIntegrate>
<isSupportPlatformAccess>
true
</isSupportPlatformAccess>
<isSupportIntelligentBoost>
true
</isSupportIntelligentBoost>
<isSupportResourceStatistics>
true
</isSupportResourceStatistics>
<isSupportBandwidthLimit>
true
</isSupportBandwidthLimit>
<isSupportPOEPortsDisableAdaptiveServer>
true
</isSupportPOEPortsDisableAdaptiveServer>
<isSupportPOEConfiguration>
true
</isSupportPOEConfiguration>
<isSupportGetLinkSocketIP>
true
</isSupportGetLinkSocketIP>
<isSupportWebSocket>
true
</isSupportWebSocket>
<isSupportWebSocketS>
true
</isSupportWebSocketS>
<Adaption>

<streamType opt="0,1,2,3,4,5,7,8,9,10">
test
</streamType>
<isSupportPlayback>
true
</isSupportPlayback>
</Adaption>
<isSupportVideoImgDB>
true
</isSupportVideoImgDB>
<isSupportEventDataOverWebSocket opt="true,false">
true
</isSupportEventDataOverWebSocket>
<isSupportDynamicHostName>
true
</isSupportDynamicHostName>
<isSupportTCPAcceleration>
true
true
</isSupportTCPAcceleration>
<isSupportFlowControl>
true
</isSupportFlowControl>
<isSupportEZVIZTiming>
true
</isSupportEZVIZTiming>
<isSupportTrafficMonitor>
true
</isSupportTrafficMonitor>
<isSupportDMSAuthInfo>
true
</isSupportDMSAuthInfo>
<isSupportWiredandWirelessTrafficMonitor>
true
</isSupportWiredandWirelessTrafficMonitor>
<isSupport4G>
true
</isSupport4G>
<isSupport4GConfig>
true
</isSupport4GConfig>
<isSupportGRIDServer>
</isSupportGRIDServer>
<isSupportGRIDInfo>
</isSupportGRIDInfo>
<isSupportSipTransmit>
true
</isSupportSipTransmit>
<isSupportSip>
true
</isSupportSip>
<isSupportWifiCascade>
true
</isSupportRelativeInfo>
<isSupportEmailEncrypt>
true
</isSupportEmailEncrypt>
<isSupportPortFilter>
true
</isSupportPortFilter>
<isSupportPingDeny>
true
</isSupportPingDeny>
<isSupportDOSDeny>
true
</isSupportDOSDeny>
<isSupportNetworkStatus>
true
</isSupportNetworkStatus>
<isSupportEZVIZQRcode>
true
</isSupportEZVIZQRcode>
<isSupportEZVIZUnbind>
true
</isSupportEZVIZUnbind>
<isSupportPingTest>
true
</isSupportPingTest>
<isSupportMOTCloudPlateform>
true
</isSupportMOTCloudPlateform>
<isSupportSpectrumScan>
true
</isSupportSpectrumScan>
<isSupportFRP>
true
</isSupportFRP>
<isSupport5GModule>
true
</isSupportWirelessDialRoute>
<isSupportNPlusOne>
true
</isSupportNPlusOne>
<supportEnvironmentalStandards opt="HJ212">
true
true
</supportEnvironmentalStandards>
<isSupportIntranetSegment>
true
</isSupportIntranetSegment>
<isSupportDHCPServer>
true
</isSupportDHCPServer>
<isSupportClusterIntercom>
true
</isSupportClusterIntercom>
<isSupportHydrologicMonitoring>
true
</isSupportHydrologicMonitoring>
<isWirelessDialMutexWithWlanAndWifi>
true
</isWirelessDialMutexWithWlanAndWifi>
<isSupportSpeechTranscription>
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>
</isSupportRFIDTagCheckTest>
<isSupportQoSDSCPtoLoaclPriorityMapping>
</isSupportQoSDSCPtoLoaclPriorityMapping>
<isSupportQoS802.1pto802.1pPriorityMapping>
</isSupportQoS802.1pto802.1pPriorityMapping>
<isSupportLinkTestStart>
</isSupportLinkTestStart>
<isSupportLinkTestResult>
</isSupportLinkTestResult>
<isSupportNetworkModuleUpgrade>
</isSupportNetworkModuleUpgrade>
<isSupportNetworkModuleVersionInfo>
</isSupportNetworkModuleVersionInfo>
<isSupportFRPParams>
</isSupportFRPParams>
</NetworkCap>
<IOCap>

<IOInputPortNums>
true
</IOInputPortNums>
<IOOutputPortNums>
true
</IOOutputPortNums>
<isSupportStrobeLamp>
true
</isSupportStrobeLamp>
<SoftIOInputPortNums>
true
</SoftIOInputPortNums>
<isSupportIOOutputAdvanceParameter>
true
</isSupportIOOutputAdvanceParameter>
<isSupportSetAllIOOutput>
true
</isSupportSetAllIOOutput>
<isSupportCombinationAlarm>
true
</isSupportCombinationAlarm>
<isSupportAlarmKeyParam>
</isSupportAlarmKeyParam>
</IOCap>
<SerialCap>

<rs485PortNums>
true
</rs485PortNums>
<supportRS232Config>
true
</supportRS232Config>
<rs422PortNums>
</rs422PortNums>
<rs232PortNums>
</rs232PortNums>
<rs485WorkMode opt="Led,CaptureTrigger">
test
</rs485WorkMode>
<rs232SerialNumber opt="1,2,3">
test
</rs232SerialNumber>
<rs485SerialNumber opt="4,5,6">
test
</rs485SerialNumber>
<isSupportAuthenticationService>
true
</isSupportAuthenticationService>
<isSupportDeviceInfo>
true
</isSupportDeviceInfo>
<isSupportSearchDeviceInfoRelations>
true
</isSupportSearchDeviceInfoRelations>
</SerialCap>
<VideoCap>

<videoInputPortNums>
true
</videoInputPortNums>
<videoOutputPortNums>
true
</videoOutputPortNums>
<menuNums>
true
</menuNums>
<externalChannelNum>
true
</externalChannelNum>
<isSupportHeatmap>
true
</isSupportHeatmap>
<isSupportCounting>
true
</isSupportCounting>
<countingType>
test
</countingType>
<isSupportPicture>
true
</isSupportPicture>
<isSupportPreviewSwitch>
true
</isSupportPreviewSwitch>
<isSupportMultiChannelCounting>
true
</isSupportMultiChannelCounting>
<isSupportCountingCollection>
<isSupportCountingCollection>
true
</isSupportCountingCollection>
<isSupportHeatmapCollection>
true
</isSupportHeatmapCollection>
<channelFlexible opt="name,online,linknum">
true
</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>
</isSupportCompressedTranscode>
<isSupportLocalStreamCfg>
</isSupportLocalStreamCfg>
</VideoCap>
<AudioCap>

<audioInputNums>
1
</audioInputNums>
<audioOutputNums>
1
</audioOutputNums>
<mixAudioInSet>
true
</mixAudioInSet>
<mixAudioOutSet>
</mixAudioOutSet>
<isSupportAudioMixing>
true
</isSupportAudioMixing>
<isSupportRemoveFrequencyPoint>
true
</isSupportRemoveFrequencyPoint>
<isSupportAudioInConfig>
true
</isSupportAudioInConfig>
<muteDuringPanTilt opt="MicIn">
true
</muteDuringPanTilt>
<isSupportAudioOutConfig>
</isSupportAudioOutConfig>
<isSupportSAIP>
</isSupportSAIP>
<SAIPChannelsNum>
1
</SAIPChannelsNum>
<isSupportDataStorage>
true
</isSupportDataStorage>
<isSupportDataRelease>
</isSupportDataRelease>
<isSupportAudioPlan>
</isSupportAudioPlan>
<isSupportAudioTask>
</isSupportAudioTask>
<isSupportaudioCollection>
</isSupportaudioCollection>
<isSupportWirelessPickUp>
</isSupportWirelessPickUp>
<audioOutputBroadcastNums opt="1,2,3,4">
0
</audioOutputBroadcastNums>
<isSupportAudioOutMixing>
</isSupportAudioOutMixing>
<isSupportRTSPAudio>
true
</isSupportRTSPAudio>
<isSupportRTSPAudioPlaybackByFile>
</isSupportRTSPAudioPlaybackByFile>
</AudioCap>
<isSupportHolidy>
true
</isSupportHolidy>
<RebootConfigurationCap>

<Genetec>
true
</Genetec>
<ONVIF>
true
</ONVIF>
<RTSP>
true
</RTSP>
<HTTP>
true
</HTTP>
<SADP>

<ISDiscoveryMode>
true
</ISDiscoveryMode>
<PcapMode>
true
</PcapMode>
</SADP>
<IPCAddStatus>
true
</IPCAddStatus>
</RebootConfigurationCap>
<isSupportExternalDevice>
true
</isSupportSoundCfg>
<isSupportSubscribeEvent>
true
</isSupportSubscribeEvent>
<isSupportSubscribeIOTInfo>
true
</isSupportSubscribeIOTInfo>
<isSupportDiagnosedData>
true
</isSupportDiagnosedData>
<isSupportChangedUpload>
true
</isSupportChangedUpload>
<isSupportGettingWorkingStatus>
true
</isSupportGettingWorkingStatus>
<isSupportGettingChannelInfoByCondition>
true
</isSupportGettingChannelInfoByCondition>
<isSupportDiagnosedDataParameter>
true
</isSupportDiagnosedDataParameter>
<isSupportSimpleDevStatus>
true
</isSupportSimpleDevStatus>
<isSupportFlexible>
true
</isSupportPTZChannels>
<isSupportMetadata>
true
</isSupportMetadata>
<isSupportTimeCap>
true
</isSupportTimeCap>
</isSupportTimeCap>
<isSupportThermalStreamData>
true
</isSupportThermalStreamData>
<isSupportShutdown>
true
</isSupportShutdown>
<isSupportConsumptionMode>
true
</isSupportConsumptionMode>
<isSupportManualPowerConsumption>
true
</isSupportManualPowerConsumption>
<isSupportPostUpdateFirmware>
true
</isSupportPostUpdateFirmware>
<isSupportPostConfigData>
true
</isSupportPostConfigData>
<isSupportUserLock>
true
</isSupportUserLock>
<isSupportModuleLock>
true
</isSupportModuleLock>
<supportSmartOverlapChannles opt="1">
true
</supportSmartOverlapChannles>
<isSupportNetworkCapture>
true
</isSupportNetworkCapture>
<isSupportOperationRecord>
true
</isSupportOperationRecord>
</SysCap>
<voicetalkNums>
2
</voicetalkNums>
<isSupportSnapshot>
true
</isSupportSnapshot>
<SecurityCap>

<supportUserNums>
1
</supportUserNums>
<userBondIpNums>
1
</userBondIpNums>
<userBondMacNums>
1
</userBondMacNums>
<isSupCertificate>
true
</isSupCertificate>
<issupIllegalLoginLock>
true
</issupIllegalLoginLock>
<isSupportOnlineUser>
true
</isSupportOnlineUser>
<isSupportAnonymous>
true
</isSupportAnonymous>
<isSupportStreamEncryption>
</isSupportStreamEncryption>
<securityVersion opt="1,2">
test
</securityVersion>
<keyIterateNum>
100
</keyIterateNum>
<isSupportUserCheck>
true
</isSupportUserCheck>
<isSupportGUIDFileDataExport>
true
</isSupportGUIDFileDataExport>
<isSupportSecurityQuestionConfig>
true
</isSupportSecurityQuestionConfig>
<supportSecurityNode opt="wirelessServer,wirelessDial">
test
<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
</RSAKeyLength>
<isSupportONVIFUserManagement>
true
</isSupportONVIFUserManagement>
<WebCertificateCap>

<CertificateType opt="basic,digest,digest/basic">
test
</CertificateType>
<SecurityAlgorithm>

<algorithmType opt="MD5,SHA256,MD5/SHA256">
test
</algorithmType>
</SecurityAlgorithm>
</WebCertificateCap>
<isSupportConfigFileImport>
true
</isSupportConfigFileImport>
<isSupportConfigFileExport>
true
</isSupportConfigFileExport>
<cfgFileSecretKeyLenLimit min="0" max="16">
0
</cfgFileSecretKeyLenLimit>
<supportIPCActivatePassword>
true
</supportIPCActivatePassword>
<isIrreversible>
true
</isIrreversible>
<salt>
test
</salt>
<isSupportOnvifInfo>
true
</isSupportOnvifInfo>
<isSupportUserNamePasswordCheckUpgrade>
true
</isSupportUserNamePasswordCheckUpgrade>
<isSupportDeviceCertificatesManagement>
true
</isSupportDeviceCertificatesManagement>
<isSupportSIPCertificatesManagement>
true
<isSupportDeviceSelfSignCertExport>
true
</isSupportDeviceSelfSignCertExport>
<isSupportSecurityEmail>
true
</isSupportSecurityEmail>
<isSupportRTSPCertificate opt="true,false">
true
</isSupportRTSPCertificate>
<isSupportPictureURlCertificate opt="true,false">
true
</isSupportPictureURlCertificate>
<isSupportGB35114Certificate>
</isSupportGB35114Certificate>
<isSupportAuthenticationMode opt="uKey,private">
private
</isSupportAuthenticationMode>
<isSupportUnloggedUserPermissionConfig opt="true,false">
true
</isSupportUnloggedUserPermissionConfig>
<maxIllegalLoginTimes min="3" max="20" def="5">
1
</maxIllegalLoginTimes>
<SecurityAdvanced>

<securityEnhanced>
true
</securityEnhanced>
true
</noOperationEnabled>
<noOperationTime min="1" max="60" def="15">
1
</noOperationTime>
<isSupportDigestStatus>
true
</isSupportDigestStatus>
</SecurityAdvanced>
<LoginLinkNum>

<maxLinkNum min="1" max="128" def="50">
64
</maxLinkNum>
</LoginLinkNum>
<isSupportCCClientCertificate>
true
</isSupportCCClientCertificate>
1
</passwordValidity>
<isSupportResetChannelPassword>
true
</isSupportResetChannelPassword>
<DoubleVerificationCap>

<isSupportUsersConfig>
true
</isSupportUsersConfig>
<isSupportUsersPermissionConfig>
true
</isSupportUsersPermissionConfig>
</DoubleVerificationCap>
<isSupportUserSearch>
true
</isSupportUserSearch>
1
</keypadPassword>
<installerKeypadPassword min="1" max="10">
1
</installerKeypadPassword>
<operatorKeypadPassword min="1" max="10">
1
</operatorKeypadPassword>
1
</userOperateType>
<isSptUserEnabled>
true
</isSptUserEnabled>
<isSptAdminCap>
true
</isSptAdminCap>
<isSupportBackLogCfg>
true
</isSupportBackLogCfg>
<isSupportBackLogExport>
true
</isSupportBackLogExport>
<isSupportModifyInnerPassword opt="true,false">
true
</isSupportModifyInnerPassword>
<isSupportEncryptCertificate>
true
</isSupportEncryptCertificate>
<maxIllegalLoginLockTime min="1" max="120" def="30.00">
1
</maxIllegalLoginLockTime>
<cloudSensitiveInfoEncryptType>
2.1
</cloudSensitiveInfoEncryptType>
<isSupportCertificateCustomID>
true
</isSupportCertificateCustomID>
<isSupportResetLANPassword>
true
</isSupportResetLANPassword>
<isSupportPicHttpsCertificatesManagement>
true
</isSupportPicHttpsCertificatesManagement>
<isSupportAKSKImport>
true
</isSupportAKSKImport>
<isSupportAKSKExport>

<type opt="GB35114">
GB35114
</type>
</ExportCertificateFile>
<isSupportGB351114FDWSFCertificate>
true
</isSupportGB351114FDWSFCertificate>
</SecurityCap>
<EventCap>

<isSupportHDFull>
true
</isSupportHDFull>
<isSupportHDError>
true
</isSupportHDError>
<isSupportNicBroken>
true
</isSupportNicBroken>
<isSupportIpConflict>
true
</isSupportIpConflict>
<isSupportIllAccess>
true
</isSupportIllAccess>
<isSupportViException>
true
</isSupportViException>
<isSupportViMismatch>
true
</isSupportViMismatch>
<isSupportRecordException>
true
</isSupportRecordException>
<isSupportRaidException>
true
</isSupportRaidException>
<isSupportViResMismatch>
true
</isSupportViResMismatch>
<isSupportPOCException>
true
</isSupportPOCException>
<isSupportSmartDetection>
true
</isSupportSmartDetection>
<isSupportSpareException>
true
</isSupportSpareException>
<isSupportPoePowerException>
true
</isSupportPoePowerException>
<isSupportTriggerFocus>
true
</isSupportTriggerFocus>
<isSupportMotionDetection>
true
</isSupportMotionDetection>
<isSupportVideoLoss>
true
</isSupportVideoLoss>
<isSupportTamperDetection>
true
</isSupportTamperDetection>
<isSupportFireDetection>
true
</isSupportFireDetection>
<isSupportRegionEntrance>
true
</isSupportRegionEntrance>
<isSupportRegionExiting>
true
</isSupportRegionExiting>
<isSupportLoitering>
true
</isSupportLoitering>
<isSupportGroup>
true
</isSupportGroup>
<isSupportRapidMove>
true
</isSupportRapidMove>
<isSupportParking>
true
</isSupportParking>
<isSupportUnattendedBaggage>
true
</isSupportUnattendedBaggage>
<isSupportAttendedBaggage>
true
</isSupportAttendedBaggage>
<isSupportHumanAttribute>
true
</isSupportHumanAttribute>
<isSupportHumanRecognition>
true
</isSupportHumanRecognition>
<isSupportFaceContrast>
true
</isSupportFaceContrast>
<isSupportFaceLib>
true
</isSupportFaceLib>
<isSupportBlackListFaceContrast>
true
</isSupportBlackListFaceContrast>
<isSupportWhiteListFaceContrast>
true
</isSupportWhiteListFaceContrast>
<isSupportillegalParking>
true
</isSupportillegalParking>
<isSupportPedestrian>
true
</isSupportPedestrian>
<isSupportTrafficAccident>
true
</isSupportTrafficAccident>
<isSupportConstruction>
true
</isSupportConstruction>
<isSupportRoadBlock>
true
</isSupportRoadBlock>
<isSupportAbandonedObject>
true
</isSupportAbandonedObject>
<isSupportParallelParking>
true
</isSupportParallelParking>
<isSupportParkingState>
true
</isSupportParkingState>
<isSupportTrafficJam>
true
</isSupportTrafficJam>
<isSupportCongestion>
true
</isSupportCongestion>
<isSupportStudentsStoodUp>
true
</isSupportStudentsStoodUp>
<isSupportFramesPeopleCounting>
true
</isSupportFramesPeopleCounting>
<isSupportFaceSnap>
true
</isSupportFaceSnap>
<isSupportPersonDensityDetection>
true
</isSupportPersonDensityDetection>
<HFPD>
true
</HFPD>
<isSupportPersonQueueDetection>
true
</isSupportPersonQueueDetection>
<isSupportVehicleStatistics>
true
</isSupportVehicleStatistics>
<isSupportFaceThermometry>
true
</isSupportFaceThermometry>
<isSupportSafetyHelmetDetection>
true
</isSupportSafetyHelmetDetection>
<isSupportPowerSupplyCabinet>
true
</isSupportPowerSupplyCabinet>
<isSupportSensorDetection>
true
true
</isSupportSensorDetection>
<isSupportSignAbnormal>
true
</isSupportSignAbnormal>
<isSupportTeacherBehaviorDetect>
true
</isSupportTeacherBehaviorDetect>
<isSupportCityManagement>
true
</isSupportCityManagement>
<isSupportMixedTargetDetection>
true
</isSupportMixedTargetDetection>
<isSupportFaceSnapModeling>
true
</isSupportFaceSnapModeling>
<isSupportIntersectionAnalysis>
true
</isSupportIntersectionAnalysis>
<isSupportTriggerCapCheck>
true
</isSupportTriggerCapCheck>
<isSupportLuma>
true
</isSupportLuma>
<isSupportChroma>
true
</isSupportChroma>
<isSupportSnow>
true
</isSupportSnow>
<isSupportStreak>
true
</isSupportStreak>
<isSupportFreeze>
true
</isSupportFreeze>
<isSupportSigLose>
true
</isSupportSigLose>
<isSupportClarity>
true
</isSupportClarity>
<isSupportJitter>
true
</isSupportJitter>
<isSupportBlock>
true
</isSupportBlock>
<isSupportFlowers>
true
</isSupportFlowers>
<isSupportNoise>
true
</isSupportNoise>
<isSupportGhost>
true
</isSupportGhost>
<isSupportPurple>
true
</isSupportPurple>
<isSupportICR>
true
</isSupportICR>
<isSupportProtectiveFilm>
true
</isSupportProtectiveFilm>
<isSupportVoltageInstable>
true
</isSupportVoltageInstable>
<isSupportCertificateRevocation>
true
</isSupportCertificateRevocation>
<isSupportSysStorFull>
true
</isSupportSysStorFull>
<isSupportVersionAbnormal>
true
</isSupportVersionAbnormal>
<isSupportNodeOffline>
true
</isSupportNodeOffline>
<isSupportRecordCycleAbnormal>
true
</isSupportRecordCycleAbnormal>
<isSupportIpcTransferAbnormal>
true
</isSupportIpcTransferAbnormal>
<isSupportDrivingBehaviorDetect>
true
</isSupportDrivingBehaviorDetect>
<isSupportWasteGasDetection>
true
</isSupportWasteGasDetection>
<isSupportGreyScaleAlarm>
true
</isSupportGreyScaleAlarm>
<isSupportPTLocking>
true
</isSupportPTLocking>
<isSupportNoMaskDetection>
true
</isSupportNoMaskDetection>
<isSupportTMPA>
true
</isSupportTMPA>
<RuleScheduleCap>

true
</RuleScheduleCap>
<RegionScheduleCap>

<isSupportPersonDensityDetection>
true
</isSupportPersonDensityDetection>
<isSupportPersonQueueDetection>
true
</isSupportPersonQueueDetection>
</RegionScheduleCap>
<isSupportThermalCalibrationFileException>
true
</isSupportThermalCalibrationFileException>
<isSupportTemperatureIntervalMeasurement>
true
</isSupportTemperatureIntervalMeasurement>
<isSupportThermalVehicleDetection>
true
</isSupportThermalVehicleDetection>
<isSupportWaterQualityDetection>
true
</isSupportWaterQualityDetection>
<isSupportWaterLevelDetection>
true
</isSupportWaterLevelDetection>
<isSupportDeviceTemperatureAbnormal>
true
</isSupportDeviceTemperatureAbnormal>
<isSupportObjectAccumulationDetection>
true
</isSupportObjectAccumulationDetection>
<isSupportAppAbnormal>
true
</isSupportAppAbnormal>
<isSupportLensTemperatureException>
</isSupportLensTemperatureException>
<isSupportPTZFXYFinish>
</isSupportPTZFXYFinish>
<isSupportNormalTemperatureAlarm>
</isSupportNormalTemperatureAlarm>
<isSupportLowTemperatureAlarm>
</isSupportLowTemperatureAlarm>
<isSupportLowCoolerLifeEvent>
</isSupportLowCoolerLifeEvent>
<isSupportObstacleAvoidanceAlarm>
</isSupportObstacleAvoidanceAlarm>
</EventCap>
<ITCCap>

<isSupportITC>
true
</isSupportITC>
<isSupportIllegalDictionary>
true
</isSupportIllegalDictionary>
<isSupportVehicleDetection>
true
</isSupportVehicleDetection>
<isSupportHVTVehicleDetection>
true
</isSupportHVTVehicleDetection>
<isSupportlicencePlateAuditData>
true
</isSupportlicencePlateAuditData>
<isSupportSearchLPListAudit>
true
</isSupportSearchLPListAudit>
<isSupportVehicleDetectionManualTrigger opt="false,true">
<isSupportVehicleDetectionManualTrigger opt="false,true">
true
</isSupportVehicleDetectionManualTrigger>
<isSupportSyncSignalOutput>
true
</isSupportSyncSignalOutput>
</ITCCap>
<ImageCap>

<isSupportRegionalExposure>
true
</isSupportRegionalExposure>
<isSupportRegionalFocus>
true
</isSupportRegionalFocus>
</ImageCap>
<RacmCap>

<isSupportZeroChan>
true
</isSupportZeroChan>
<inputProxyNums>
1
</inputProxyNums>
<eSATANums>
1
</eSATANums>
<miniSASNums>
1
</miniSASNums>
<nasNums>
1
</nasNums>
<ipSanNums>
1
</ipSanNums>
<isSupportRaid>
true
</isSupportRaid>
<isSupportExtHdCfg>
true
</isSupportExtHdCfg>
<isSupportTransCode>
true
</isSupportTransCode>
<isSupportIpcImport>
true
</isSupportIpcImport>
<NasMountType>

<isNFSSupportAuthentication>
true
</isNFSSupportAuthentication>
<isCIFSSupportAuthentication>
true
</isCIFSSupportAuthentication>
</NasMountType>
<isSupportIpcStreamType>
true
</isSupportIpcStreamType>
<isSupportIOInputProxy>
true
</isSupportIOInputProxy>
<isSupportIOOutputProxy>
true
</isSupportIOOutputProxy>
<isSupportPTZRs485Proxy>
true
</isSupportPTZRs485Proxy>
<isSupportSrcIDSearch>
true
</isSupportSrcIDSearch>
<isSupportReversePlayback>
true
</isSupportReversePlayback>
<isSupportSMARTTest>
true
</isSupportSMARTTest>
<isSupportDownloadByTime>
true
</isSupportDownloadByTime>
<pictureSearchType
elmet,
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
tUp,toiletTarry,
playCellphone,vehicleMonitor,vibrationDetection,running,retention,spacingChange,yardTarry,keyPersonGetUp,sitQuietly,standUp,plateRecognition,smoking,onThePh
one,fatigueDriving,
notLookingStraightAhead,leaveThePost,seatBelt,sunglasses,identityAbnormal,ForwardCollisionWarning,LaneDepartureWarning,BlindSpotDetection,HeadwayMonitoringW
arning,
arning,
PedestrianCollisionWarning,SuddenSpeedUp,SuddenSpeedDown,SuddenLeftTurn,SuddenRightTurn,Turnover,NotYieldToPedestrian,unregisteredStreetVendor,stallOutsideS
hop,stallOccupyingRoad, illegalHeap,illegalParkingofNon-
MotorVehicle,illegalOutdoorAdvertisement,packGarbage,stallUnderUmbrella,dustbinOverflow,exposeGarbage,hangClothingAlongStreet,allPic,ATMPanel,
ATMSurround,ATMFace,ATMSafetyCabin,loitering,smokeDetectAlarm">
test
</pictureSearchType>
<recordSearchType
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>
<isSupportSyncIPCPassword>
true
</isSupportSyncIPCPassword>
<isSupportTransferIPC>
true
</isSupportTransferIPC>
<isSupportSmartSearch>
true
</isSupportSmartSearch>
<isSupportPOS>
true
</isSupportPOS>
<isSupportLinkNum>
true
</isSupportPassBackBasicCfg>
<PassBackTaskConfig>

<isSupportAddTask>
true
</isSupportAddTask>
<isSupportSearchTask>
true
</isSupportSearchTask>
<isSupportControlTask>

<isSupportAddPlan>
true
</isSupportAddPlan>
<isSupportSearchPlan>

<isSupportIRAIDRapidConfiguration>
true
</IRAIDCap>
<isSupportStorageExtraInfo>
true
</isSupportStorageExtraInfo>
true
</isSupportRacmChannelsCap>
<LockCap>

</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>
true
</isSupportLogConfig>
<SecurityLog>
<isSupportSecurityLog>
true
</isSupportSecurityLog>
<isSupportLogServer>
true
</isSupportLogServer>
<isSupportLogServerTest>
true
</isSupportLogServerTest>
<SecurityLogTypeList>

<SecurityLogType>

<primaryType>
test
</primaryType>
<secondaryType opt="all">
test
</secondaryType>
</SecurityLogType>
</SecurityLogTypeList>
<isSupportLogServerList>
</isSupportLogServerList>
</SecurityLog>
<isSupportGetBackupDevice>
true
</defaultAdminPortEnabled>
<isSupportLogDataPackage>
true
</isSupportLogDataPackage>
<logSearchTimeSpanNums>
1
<CloudStorageServerCap>

<isSupportCloudStorageParameter>
true
</isSupportCloudStorageParameter>
<isSupportCloudStoragePool>
true
</isSupportCloudStoragePool>
<supportChannelsNum>
1
</supportChannelsNum>
</CloudStorageServerCap>
<isSupportWebPrivatePlaybackByUTC>
true
</isSupportWebPrivatePlaybackByUTC>
<isSupportFindCommonFileByUTC>
true
</isSupportFindCommonFileByUTC>
<isSupportFindEventFileByUTC>
</isSupportFindEventFileByUTC>
<isSupportSmartSearchRecordByUTC>
true
</isSupportSmartSearchRecordByUTC>
<isSupportMRDSearchByTimeZone>
true
</isSupportMRDSearchByTimeZone>
<isSupportSearchRecordLabelByUTC>
true
</isSupportSearchRecordLabelByUTC>
<isSupportSearchPictureByUTC>
true
</isSupportSearchPictureByUTC>
<isSupportSmartSearchPictureByUTC>
true
</isSupportSmartSearchPictureByUTC>
<isSupportFindLogByUTC>
true
</isSupportFindLogByUTC>
<isSupportUploadRecordByUTC>
true
</isSupportUploadRecordByUTC>
<isSupportPlaybackByUTC>
true
</isSupportPlaybackByUTC>
<isSupportFaceDetecttionAlarmByTimeZone>
true
</isSupportFaceDetecttionAlarmByTimeZone>
<isSupportSourceModify>
true
</isSupportSourceModify>
<isSupportCountingSearchByUTC>
true
</isSupportCountingSearchByUTC>
<isSupportCluster>
true
</isSupportCluster>
<supportAIDTFSType opt="illegalParking,wrongdirection,crosslane,vehicleexist,lanechange,turnround,evidence">
test
</supportAIDTFSType>
<isSupportMisinfoStateSearch>
true
</isSupportMisinfoStateSearch>
<isSupportOneKeyOperationStorageData>
true
</isSupportOneKeyOperationStorageData>
<eventRecordSearch>

<eventType opt="faceContrast,faceSnap,vehicleMatchResult,hawkResult">
</eventType>
<auxEventType opt="faceContrastFailure,faceContrastSuccess">
test
</auxEventType>
</eventRecordSearch>
<isSupportManualRecord>
true
</isSupportRemark>
<FileUpload>

<enabled>
true
</enabled>
</FileUpload>
<PoliceInfoUpload>

<enabled>
true
</enabled>
</PoliceInfoUpload>
<PoliceInfo>

<policeID>
true
</policeID>
<policeCode>
true
</policeCode>
<policeName>
true
</policeName>
<password>
true
</password>
<deviceID>
</deviceID>
</PoliceInfo>
<isSupportAssignChannelID>
true
</isSupportAssignChannelID>
<isSupportAssignStreamID>
true
</isSupportAssignStreamID>
<PictureSearchSubTypeList>

<PictureSearchSubType>

<mainType>
test
</mainType>
<subType opt="all,motorVehicle,nonMotorVehicle,pedestrian">
test
</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>
true
</isSupportSourceStatus>
<isSupportSSDSMARTTest>

<isSupportGetFileTime>
true
</isSupportGetFileTime>
</MobileStorage>
<isSupportGetChannelList>
true
</isSupportGetChannelList>
<isSupportCascade>
true
</isSupportCascade>
<isSupportPictureInfo>
true
</isSupportPictureInfo>
<isSupportCloudStorageModel>
true
</isSupportCloudStorageModel>
<isSupportCloudStorageModelList>
true
</isSupportCloudStorageModelList>
<isSupportRecordAudio>
true
</isSupportRecordAudio>
<isSupportSearchAudio>
true
</isSupportAudioDailyDistribution>
<isSupportDownloadAudio>
true
</isSupportDownloadAudio>
<isSupportDeleteAudio>
true
</isSupportDeleteAudio>
<isSupportSearchRemoteAlbum>
true
</isSupportSearchRemoteAlbum>
<isSupportStreamParam>
</isSupportStreamParam>
</RacmCap>
<PTZCtrlCap>

<isSupportPatrols>
true
</isSupportPatrols>
<isSupportCombinedPath>
</isSupportCombinedPath>
<isSupportRailwayRobot>
</isSupportRailwayRobot>
</PTZCtrlCap>
<SmartCap>

<isSupportROI>
true
</isSupportROI>
<isSupportFaceDetect>
true
</isSupportFaceDetect>
<isSupportIntelliTrace>
true
</isSupportIntelliTrace>
<isSupportFieldDetection>
true
</isSupportFieldDetection>
<isSupportDefocusDetection>
true
</isSupportDefocusDetection>
<isSupportAudioDetection>
true
</isSupportAudioDetection>
<isSupportSceneChangeDetection>
true
</isSupportSceneChangeDetection>
<isSupportLineDetection>
true
</isSupportLineDetection>
<isSupportRegionEntrance>
true
</isSupportRegionEntrance>
<isSupportRegionExiting>
true
</isSupportRegionExiting>
<isSupportLoitering>
true
</isSupportLoitering>
<isSupportGroup>
true
</isSupportGroup>
<isSupportRapidMove>
true
</isSupportRapidMove>
<isSupportParking>
true
</isSupportParking>
<isSupportUnattendedBaggage>
true
</isSupportUnattendedBaggage>
<isSupportAttendedBaggage>
true
</isSupportAttendedBaggage>
<isSupportPeopleDetection>
true
</isSupportPeopleDetection>
<isSupportSmartCalibration>
</isSupportSmartCalibration>
<isSupportStorageDetection>
</isSupportStorageDetection>
<isSupportShipsDetection>
true
</isSupportShipsDetection>
<isSupportShield>
</isSupportShield>
<isSupportAlgVersion>
true
</isSupportAlgVersion>
<isSupportVideoOverlap>
</isSupportVideoOverlap>
<isSupportParkingState>
true
</isSupportParkingState>
<isSupportChannelResource>
true
</isSupportChannelResource>
<isSupportAnalysisUnitSwitch opt="true,false">
true
</isSupportAnalysisUnitSwitch>
<isSupportHFPD>
true
</isSupportHFPD>
<isSupportImageROI>
true
</isSupportImageROI>
<isSupportLFPD>
true
</isSupportLFPD>
</SmartCap>
<isSupportEhome>
true
</isSupportEhome>
<isSupportStreamingEncrypt>
</isSupportStreamingEncrypt>
<TestCap>

<isSupportEmailTest>
true
</isSupportEmailTest>
</TestCap>
<ImageMiscCap>

<isSupportDPC>
true
</isSupportDPC>
</ImageMiscCap>
<PanoramaCap>
<isSupportGeneratePanorama>
</isSupportGeneratePanorama>
<isSupportPanoramaPosition3D>
</isSupportPanoramaPosition3D>
<isSupportPreset>
</isSupportPreset>
</PanoramaCap>
<ThermalCap>

<isSupportFireDetection>
true
</isSupportFireDetection>
<isFireFocusZoomSupport>
true
</isFireFocusZoomSupport>
<isSupportThermometry>
true
</isSupportThermometry>
<isSupportRealtimeThermometry>
true
</isSupportRealtimeThermometry>
<isSupportThermIntell>
true
</isSupportThermIntell>
<isSupportNVR>
</isSupportNVR>
<isSupportThermometrySchedule>
</isSupportThermometrySchedule>
<isSupportTemperatureSchedule>
</isSupportTemperatureSchedule>
<isSupportFireDetectionSchedule>
</isSupportFireDetectionSchedule>
<isSupportPower>
true
</isSupportPower>
<isSupportRealtimeTempHumi>
<isSupportRealtimeTempHumi>
true
</isSupportRealtimeTempHumi>
<ManualThermCap>
<manualThermRuleNum>
true
</manualThermRuleNum>
</ManualThermCap>
<isSupportManualThermBasic>
true
</isSupportManualThermBasic>
<isSupportFireShieldMask>
true
</isSupportFireShieldMask>
<isSupportSmokeShieldMask>
true
</isSupportSmokeShieldMask>
<isSupportThermometryMode>
true
</isSupportThermometryMode>
<isSupportThermalPip>
true
</isSupportThermalPip>
<isSupportThermalIntelRuleDisplay>

<thermometryAlgName min="1" max="128">
test
</thermometryAlgName>
<shipsAlgName min="1" max="128">
test
</shipsAlgName>
<fireAlgName min="1" max="128">
test
</fireAlgName>
<smokeAlgName min="1" max="128">
test
</smokeAlgName>
<wasteGasAlgName min="1" max="128">
test
</wasteGasAlgName>
<greyScaleAlarmAlgName min="1" max="128">
test
</greyScaleAlarmAlgName>
</AlgVersionInfo>
<isSupportFaceThermometry>
true
</isSupportThermalBlackBody>
<isSupportThermalStreamParam>
true
</isSupportThermalStreamParam>
<isSupportBodyTemperatureCompensation>
true
</isSupportBodyTemperatureCompensation>
<isSupportClickToThermometry>
true
</isSupportThermometryShieldMask>
<isSupportTemperatureCorrection>
true
</isSupportTemperatureCorrection>
<isSupportBurningPrevention>
true
</isSupportBurningPrevention>
<isSupportTemperatureCollection>
true
</isSupportTemperatureCollection>
<isSupportJpegPicWithAppendData>
true
</isSupportJpegPicWithAppendData>
<isSupportRealTimethermometryForHTTP>
true
not returned-->true
</isSupportRealTimethermometryForHTTP>
<isSupportthermometryOffLineCapture>
true
</isSupportthermometryOffLineCapture>
<isSupportShipsDetectionWithScene>
true
</isSupportShipsDetectionWithScene>
<isSupportWasteGasDetection>
true
</isSupportWasteGasDetection>
<isSupportGreyScaleAlarm>
true
</isSupportGreyScaleAlarm>
<isSupportFaceSnapThermometry>
true
</isSupportFaceSnapThermometry>
<isSupportThermalTemperatureCorrect>
true
</isSupportThermalVehicleDetection>
<isSupportSensorParam>
true
</isSupportSensorParam>
<isSupportThermalDataLinkInfo>
</isSupportThermalDataLinkInfo>
<isSupportTemperatureCompensationCalib>
</isSupportTemperatureCompensationCalib>
<isSupportWebDisplayPixelToPixelParam>
true
</isSupportWebDisplayPixelToPixelParam>
<isSupportThermalInspection>
</isSupportThermalInspection>
</ThermalCap>
<WLAlarmCap>

<isSupportTeleControl>
true
</isSupportTeleControl>
<isSupportPIR>
true
</isSupportPIR>
<isSupportWLSensors>
</isSupportWLSensors>
<isSupportCallHelp>
true
</isSupportCallHelp>
<WLSensorsNum>
</WLSensorsNum>
</WLAlarmCap>
<isSupportGIS>
true
</isSupportGIS>
<isSupportCompass>
true
</isSupportCompass>
<isSupportRoadInfoOverlays>
true
</isSupportRoadInfoOverlays>
<isSupportFaceCaptureStatistics>
</isSupportFaceCaptureStatistics>
<isSupportElectronicsEnlarge>
</isSupportElectronicsEnlarge>
<isSupportRemoveStorage>
true
</isSupportRemoveStorage>
<isSupportCloud>
true
</isSupportCloud>
<isSupportRecordHost>
true
</isSupportRecordHost>
<isSupportViewshedOverlay>
</isSupportViewshedOverlay>
<isSupportGPSLabelTracking>
</isSupportGPSLabelTracking>
<isSupportEagleEye>
</isSupportEagleEye>
</isSupportEagleEye>
<isSupportPanorama>
</isSupportPanorama>
<isSupportFirmwareVersionInfo>
true
</isSupportFirmwareVersionInfo>
<isSupportExternalWirelessServer>
true
</isSupportExternalWirelessServer>
<isSupportSetupCalibration>
</isSupportSetupCalibration>
<isSupportGetmutexFuncErrMsg>
</isSupportGetmutexFuncErrMsg>
<isSupportTokenAuthenticate>
true
</isSupportTokenAuthenticate>
<isSupportStreamDualVCA>
</isSupportStreamDualVCA>
<isSupportLaserSpotManual>
</isSupportLaserSpotManual>
<isSupportRTMP>
true
</isSupportRTMP>
<isSupportTraffic>
true
</isSupportTraffic>
<isSupportLaserSpotAdjustment>
true
</isSupportLaserSpotAdjustment>
<VideoIntercomCap>

<isSupportSceneManage>
</isSupportSceneManage>
<isSupportDeviceId>
</isSupportDeviceId>
<isSupportOperationTime>
</isSupportOperationTime>
<isSupportCallerInfo>
</isSupportCallerInfo>
<isSupportCallSignal>
</isSupportCallSignal>
<isSupportCallStatus>
</isSupportCallStatus>
<isSupportCallElevator>
true
</isSupportCallElevator>
<isSupportRelatedDeviceAdress>
</isSupportRelatedDeviceAdress>
<isSupportCardSectorCheck>
</isSupportCardSectorCheck>
<isSupportKeyCfg>
</isSupportKeyCfg>
<isSupportWorkModeCfg>
</isSupportWorkModeCfg>
<isSupportSystemSwitchCfg>
</isSupportSystemSwitchCfg>
<isSupportPrivilegePasswordStatus>
</isSupportPrivilegePasswordStatus>
<isSupportSmartHomeRoomsCfg>
</isSupportSmartHomeRoomsCfg>
<isSupportSmartHomeDevices>
</isSupportSmartHomeDevices>
<isSupportScenesCfg>
</isSupportScenesCfg>
<isSupportNameModify>
</isSupportNameModify>
<isSupportElevatorControlCfg>
</isSupportElevatorControlCfg>
<isSupportPrivilegePassword>
</isSupportPrivilegePassword>
</isSupportPrivilegePassword>
<isSupportSubModules>
</isSupportSubModules>
<isSupportIssueCards>
</isSupportIssueCards>
<isSupportSendCardCfg>
</isSupportSendCardCfg>
<isSupportRingBackTone>
</isSupportRingBackTone>
<isSupportCallPriority>
</isSupportCallPriority>
<isSupportPhoneCfg>
</isSupportPhoneCfg>
<isSupportWatchPoint>
</isSupportWatchPoint>
<isSupportVoiceConfiguration>
</isSupportVoiceConfiguration>
<isSupportSubModulesCfg>
</isSupportSubModulesCfg>
<isSupportDisplayRegion>
</isSupportDisplayRegion>
<isSupportUpdateData>
</isSupportUpdateData>
<isSupportUpdateStrategy>
</isSupportUpdateStrategy>
<isSupportMetaInfo>
</isSupportMetaInfo>
<isSupportStreamAbility>
</isSupportStreamAbility>
<platform opt="R0,R1">
R0
</platform>
<isSupportSecurityMode>
</isSupportSecurityMode>
<isSupportDeviceCommunication>
</isSupportDeviceCommunication>
<isSupportAutoSync>
</isSupportAutoSync>
<isSupportDifferentKeystrokes>
</isSupportDifferentKeystrokes>
<isSupportKeyCfgWeekPlan>
</isSupportKeyCfgWeekPlan>
<isSupportKeyCfgHolidayPlan>
</isSupportKeyCfgHolidayPlan>
<isSupportKeyCfgHolidayGroup>
</isSupportKeyCfgHolidayGroup>
<isSupportKeyCfgPlanTemplate>
</isSupportKeyCfgPlanTemplate>
<isSupportCallCfg>
</isSupportCallCfg>
<isSupportAccessParams>
</isSupportAccessParams>
<isSupportTransmitRequestEventConfirm>
</isSupportTransmitRequestEventConfirm>
<isSupportIncomingCallLinkage>
</isSupportIncomingCallLinkage>
<isSupportAdbControl>
</isSupportAdbControl>
<isSupportProtocolFileManage>
</isSupportProtocolFileManage>
<isSupportStreamSwitch>
</isSupportStreamSwitch>
<isSupportKeywordAudioRecognition>
</isSupportKeywordAudioRecognition>
<isSupportOneWaySpeaking>
</isSupportOneWaySpeaking>
<isSupportPositionInfo>
</isSupportPositionInfo>
<isSupportElevatorControlDisplay>
</isSupportElevatorControlDisplay>
<isSupportRingManage>
</isSupportRingManage>
<isSupportPasswordAuthentication>
</isSupportPasswordAuthentication>
<isSupportAlarmControlByPhone>
</isSupportAlarmControlByPhone>
<isSupportZoneCfgByScene>
</isSupportZoneCfgByScene>
<isSupportAppKeyConfiguration>
</isSupportAppKeyConfiguration>
<isSupportIntercomProtocolChange>
</isSupportIntercomProtocolChange>
<isSupportGetAnnouncementMessage>
</isSupportGetAnnouncementMessage>
<isSupportGetDeployInfo>
</isSupportGetDeployInfo>
<detectorType opt="panicButton,magneticContact,smokeDetector,activeInfraredDetector,passiveInfraredDetector,combustibleGasDetector,doorbell">
test
</detectorType>
<isSupportBroadcastRealtime>
</isSupportBroadcastRealtime>
<isSupportOrganizationNodes>
</isSupportOrganizationNodes>
<isSupportCallForwarding>
</isSupportCallForwarding>
<isSupportAudioPlayStatus>
</isSupportAudioPlayStatus>
<isSupportDeviceIdAnalysisRuleCfg>
</isSupportDeviceIdAnalysisRuleCfg>
<isSupportOperationTimeByChannel>
</isSupportOperationTimeByChannel>
<isSupportCallAuthorization>
</isSupportCallAuthorization>
<isSupportRecordControl>
</isSupportRecordControl>
<isSupportTrusteeship>
</isSupportTrusteeship>
<isSupportAnalogIndoorStation>
</isSupportAnalogIndoorStation>
<isSupportImportPartitions>
</isSupportImportPartitions>
<isSupportBroadcastPlan>
</isSupportBroadcastPlan>
<isSupportBroadcastPlanSearch>
true
</isSupportBroadcastPlanSearch>
<isSupportBroadcastPlanPause>
</isSupportBroadcastPlanPause>
<isSupportBroadcastPlanResume>
</isSupportBroadcastPlanResume>
<isSupportBroadcastPlanTest>
</isSupportBroadcastPlanTest>
<isSupportBroadcastPlanEx>
</isSupportBroadcastPlanEx>
<isSupportBroadcastPlanExSearch>
true
</isSupportBroadcastPlanExSearch>
<isSupportBroadcastPlanModify>
</isSupportBroadcastPlanModify>
<isSupportBroadcastPlanDelete>
<isSupportBroadcastPlanDelete>
</isSupportBroadcastPlanDelete>
<isSupportAudioInPlayCfg>
</isSupportAudioInPlayCfg>
<isSupportSearchWardBedInfo>
</isSupportSearchWardBedInfo>
<isSupportPatient>
</isSupportPatient>
<isSupportPatientTagInfo>
</isSupportPatientTagInfo>
<isSupportPatientMessage>
</isSupportPatientMessage>
<isSupportPatientReport>
</isSupportPatientReport>
<isSupportOperation>
</isSupportOperation>
<isSupportPatientExpenses>
</isSupportPatientExpenses>
<isSupportIntroduction>
</isSupportIntroduction>
<isSupportMedicalUpdate>
</isSupportMedicalUpdate>
</VideoIntercomCap>
<SecurityCPCapabilities>
true
</SecurityCPCapabilities>
<isSupportSafetyCabin>
true
</isSupportSafetyCabin>
<isSupportAcsUpdate>
true
</isSupportAcsUpdate>
<isSupportSecurityCP>
</isSupportSecurityCP>
<isSupportPEA>
</isSupportPEA>
<isSupportCurrentLock>
</isSupportCurrentLock>
<isSupportGuardAgainstTheft>
true
</isSupportGuardAgainstTheft>
<isSupportPicInfoOverlap>
</isSupportPicInfoOverlap>
<isSupportPlay>
</isSupportPlay>
<isSupportPlayback>
</isSupportPlayback>
<UHFRFIDReader>
<isSupportBasicInformation>
</isSupportBasicInformation>
<isSupportHardDiskStorageTest>
</isSupportHardDiskStorageTest>
<isSupportCarReaderConfig>
true
</isSupportCarReaderConfig>
</UHFRFIDReader>
<isSupportIntelligentStructureAnalysis>
true
</isSupportIntelligentStructureAnalysis>
<isSupportIntelligentAnalysisEngines>
true
</isSupportBoard>
<ResourceSwitch>
<workMode opt="4KPreview,educationRecord">
test
</workMode>
</ResourceSwitch>
<isSupportCustomStream>
true
</isSupportCustomStream>
<isSupportTriggerCapCheck>
</isSupportTriggerCapCheck>
<isSupportChannelEventCap>
true
</isSupportChannelEventCap>
<SensorCap>

<SensorNums>
1
</SensorNums>
<isSupportSensorPortConfiguration>
</isSupportSensorPortConfiguration>
<isSupportSensorPortControl>
</isSupportSensorPortControl>
<isSupportAcquireSensorStatus>
true
</isSupportAcquireSensorStatus>
<isSupportSearchSensorData>
true
</isSupportSearchSensorData>
</SensorCap>
<isSupportEncryption>
true
</isSupportEncryption>
<isSupportTrial>
</isSupportTrial>
<isSupportSignInstrument>
</isSupportSignInstrument>
<isSupportLocate>
</isSupportLocate>
<isSupportVibration>
</isSupportVibration>
<isSupportMixedTargetDetection>
true
</isSupportMixedTargetDetection>
<SDCardCtrlCap>
<isSupportIOCtrl>
</isSupportIOCtrl>
<isSupportReadCardStatus>
</isSupportReadCardStatus>
<isSupportStartUpdate>
</isSupportStartUpdate>
<isSupportEndUpdate>
</isSupportEndUpdate>
<isSupportPowerCtrl>
</isSupportPowerCtrl>
</SDCardCtrlCap>
<isSupportMutiChannelCalibration>
</isSupportMutiChannelCalibration>
<isSupportElevatorFloorCalibration>
</isSupportElevatorFloorCalibration>
<isSupportPictureCaptureComparision>
</isSupportPictureCaptureComparision>
<isSupportGPSCalibratation>
</isSupportGPSCalibratation>
<isSupportBVCorrect>
</isSupportBVCorrect>
<isSupportSteamingCodingModeSwitch>
true
</isSupportSteamingCodingModeSwitch>
<supportImageChannel opt="1,2,3,4">
test
</supportImageChannel>
<isSupportPanoramaCalibration>
</isSupportPanoramaCalibration>
<isSupportPanoramaMode>
</isSupportPanoramaMode>
<supportSnapshotChannel opt="1">
</supportSnapshotChannel>
<isSupportPanoramaCorrections>
</isSupportPanoramaCorrections>
<isSupportActiveMulticast>
</isSupportActiveMulticast>
<isSupportChannelEventListCap>
</isSupportChannelEventListCap>
<VCAResourceChannelsCap>
<ChannelsList>

<channelsID>
1
</channelsID>
</ChannelsList>
</VCAResourceChannelsCap>
<isSupportTimerVCAResource>
</isSupportTimerVCAResource>
<MixedTargetDetection>
<isSupportFaceRecognition>
true
</isSupportFaceRecognition>
<isSupportHumanRecognition>
true
</isSupportHumanRecognition>
<isSupportVehicleRecognition>
true
</isSupportVehicleRecognition>
</MixedTargetDetection>
<isSupportDiscoveryMode>
true
</isSupportDiscoveryMode>
<isSupportDumpData>
true
</isSupportDumpData>
<isSupportCameraAccessConfiguration>
true
</isSupportCameraAccessConfiguration>
<isSupportIntelligentSearch>
true
</isSupportAutoMaintenance>
<isSupportRtspOverHTTPS>
</isSupportRtspOverHTTPS>
<isSupportIntersectionAnalysis>
true
</isSupportIntersectionAnalysis>
<isSupportAudioInteract>
true
</isSupportAudioInteract>
<isSupportChannelFullEventListCap>
</isSupportChannelFullEventListCap>
<isSupportAUXInfoCap>
</isSupportAUXInfoCap>
<supportPanoramaChannel opt="2">
</supportPanoramaChannel>
<regionClip>
<channels opt="101">
</channels>
</regionClip>
<AIDEventSupport
opt="abandonedObject,pedestrian,congestion,roadBlock,construction,trafficAccident,fogDetection,wrongDirection,illegalParking,SSharpDriving,lowSpeed,dragRaci
ng,obstacle,vehNoYieldPedest,illegalMannedVeh,illegalMannedNonMotorVeh,umbrellaTentInstall,nonMotorVehOnVehLane,wearingNoHelmet,pedestRedLightRunning,pedest
OnNonMotorVehLane,pedestOnVehLane,conflagration,smoke">
</AIDEventSupport>
<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
_nonZipperMerge">
_nonZipperMerge">
</TFSEventSupport>
<isVehicleStatisticsSupport>
true
</isVehicleStatisticsSupport>
<isSupportElevatorFloorName>
</isSupportElevatorFloorName>
<isSupportVehicleFaceRecognition>
</isSupportVehicleFaceRecognition>
<VQDEventSupport opt="luma,chroma,snow,streak,freeze,sigLose,clarity,jitter,block,flowers,noise,ghost,purple,ICR,protectiveFilm">
test
</VQDEventSupport>
<IOTCap>
<supportChannelNum opt="1">
</supportChannelNum>
<startChannelNo>
</startChannelNo>
<isSupportlinkageChannelsSearch>
</isSupportlinkageChannelsSearch>
<isSupportIOTChannelCap>
</isSupportIOTChannelCap>
<satusSearchTaskCap>
<maxResults>
</maxResults>
<filterType opt="all,online,offline,updateFailed">
all
</filterType>
<deviceStatus opt="calling,noCall,medicationChangePrompt,alarming,offline,free">
calling
</deviceStatus>
<logicRelationship opt="and,or">
and
</logicRelationship>
<alarmType opt="SOS,toilet">
test
</alarmType>
<callWaitingType opt="normal,cisit">
test
</callWaitingType>
</satusSearchTaskCap>
<channelConfigList>
<channelConfig>
<unitType>
outdoor
</unitType>
<floorNumber min="0" max="10">
0
</floorNumber>
<roomNumber min="0" max="10">
0
</roomNumber>
<isSupportSlaveDevice>
true
</isSupportSlaveDevice>
<isSupportZeroFloorNumber>
</isSupportZeroFloorNumber>
<periodNumber min="0" max="10">
0
</periodNumber>
<buildingNumber min="0" max="10">
0
</buildingNumber>
<unitNumber min="0" max="10">
0
</unitNumber>
<deviceIndex min="1" max="15">
</deviceIndex>
<industryType opt="builidings,prison,medicalTreatment,broadcasting,general">
</industryType>
<priority min="1" max="100">
</priority>
<transportType opt="unicast,multicast">
test
</transportType>
<audioVolume min="0" max="15">
</audioVolume>
<callForwardingEnabled>
test
</customCommunicationName>
<isSupportMoreFeatures>
</isSupportMoreFeatures>
<isNotSupportRegPassword>
</isNotSupportRegPassword>
<mappingRoomNumber min="0" max="5">
</mappingRoomNumber>
<IOTProtocolType opt="CodeMaster,GJD,HIKVISION,Luminite,OPTEX,SIA-CID,logisticsScanningGun,Adam,Arteco,ISUP,Ezviz">
CodeMaster
</IOTProtocolType>
</deviceID>
<ISUPkey min="1" max="32">
</ISUPkey>
</channelConfig>
</channelConfigList>
<isSupportConfigTemplate>
</isSupportConfigTemplate>
<isSupportConfigReport>
</isSupportConfigReport>
<unitType opt="outdoor,indoor,manage,fence,terminal,netAudio">
test
</unitType>
<serialNumber min="1" max="32">
</serialNumber>
<isSupportAsyncStatus>
</isSupportAsyncStatus>
<isSupportAddIOTChannelList>
</isSupportAddIOTChannelList>
<isSupportSearchMoreIOTSource>
</isSupportSearchMoreIOTSource>
<channelConfigReportMode>
cover
</channelConfigReportMode>
</IOTCap>
<isSupportLCDScreen>
</isSupportLCDScreen>
<isSupportBluetooth>
true
</isSupportBluetooth>
<isSupportNetScreen>
true
</isSupportLocation>
<isSupportDebugInfoExport>
true
</isSupportDebugInfoExport>
<isSupportIoTGateway>
true
</isSupportIoTGateway>
<isSupportImageCap>
true
</isSupportImageCap>
<isSupportLogToUSB opt="true,false">
true
</isSupportLogToUSB>
<isSupportWiresharkToUSB opt="true,false">
</isSupportWiresharkToUSB>
<CDBurningStreamEncryptionChannels opt="1,2">
true
</CDBurningStreamEncryptionChannels>
<isSupportOCR>
true
</isSupportOCR>
<isSupportInstallationAngleCalibration>
<isSupportInstallationAngleCalibration>
true
</isSupportInstallationAngleCalibration>
<isSupportZeroBiasCalibration>
</isSupportZeroBiasCalibration>
<isSupportCalibrationFile>
true
</isSupportCalibrationFile>
<isSupportDisplayTrajectory>
</isSupportDisplayTrajectory>
<maximumSuperPositionTime opt="5,10,20,30">
true
</maximumSuperPositionTime>
<isSupportUnitConfig>
true
</isSupportUnitConfig>
<isSupportShipsDetectionWithScene>
true
</isSupportShipsDetectionWithScene>
<isSupportPictureServer>
true
</isSupportPictureServer>
<isSupportEmmcInfo>
</isSupportEmmcInfo>
<isSupportVehicleIllegalType opt="1,2...29">
</isSupportVehicleIllegalType>
<isSupportRFIDChannels>
</isSupportRFIDChannels>
<isSupportRfidCollection>
</isSupportRfidCollection>
<DevInfoSearch opt="tiltAngle">
test
</DevInfoSearch>
<isSupportAIOpenPlatform>
true
</isSupportAIOpenPlatform>
<isSupportPictureDownloadError>
true
</isSupportPictureDownloadError>
<isSupportStudentBehavior>
true
</isSupportStudentBehavior>
<guideEventSupport opt="linkageCapture">
test
</guideEventSupport>
<supportRemoteCtrl opt="up,down,left,right,enter,menu,num,power,esc,edit,F1,.prev,rec,play,stop,notSupport">
test
</supportRemoteCtrl>
<isSupportSSDFileSystemUpgrade>
</isSupportSSDFileSystemUpgrade>
<isSupportSSDFileSystemFormat>
true
</isSupportSSDFileSystemFormat>
<FaceCounting>
<ChannelsList>
<channelsID>
</channelsID>
</ChannelsList>
</FaceCounting>
<isSupportCluster>
true
</isSupportCluster>
<DeviceConfigurationSupport opt="time,network,accessProtocol,recordSchedule,channel,customProtocol">
test
</DeviceConfigurationSupport>
<behaviorEventSupport opt="getUp,toiletTarry,playCellphone">
test
</behaviorEventSupport>
<isSupportBVCorrectPassthrough>
true
</isSupportBVCorrectPassthrough>
<VehiclePositionControl>

<license min="0" max="16">
test
</license>
<intervalTime min="0" max="65535" def="1">
1
</intervalTime>
</VehiclePositionControl>
<supportGISEvent opt="AID,TPS,ANPR,mixedTargetDetection">
</supportGISEvent>
<isSupportGPSPTZCalibratation>
true
</isSupportGPSPTZCalibratation>
<isSupportRadar>
true
</isSupportRadar>
<isSupportISUPHttpPassthrough>
</isSupportISUPHttpPassthrough>
<isSupportMaterialListQuery>
</isSupportMaterialListQuery>
<isSupportDebugLogAsync>
true
</isSupportDebugLogAsync>
<isSupportAlgorithmsInfo>
true
</isSupportAlgorithmsInfo>
<isSupportSecurityChecking>
</isSupportSecurityChecking>
<isSupportSecurityCheckException>
</isSupportSecurityCheckException>
<isSupportPictureManage>
true
</isSupportPictureManage>
<isSupportAutoSwitch>

<isSupportHighHDTemperature>
true
</isSupportHighHDTemperature>
<isSupportLowHDTemperature>
true
</isSupportLowHDTemperature>
<isSupportHDImpact>
true
</isSupportHDImpact>
<isSupportHDBadBlock>
true
</isSupportHDBadBlock>
<isSupportSevereHDFailure>
true
</isSupportSevereHDFailure>
</SHMCap>
<isSupportLinkStatusEvent>
true
</isSupportClearCache>
<isSupportIntelligentMode>
true
</isSupportIntelligentMode>
<isSupportFaceTemperatureMeasurementEvent>
true
</isSupportFaceTemperatureMeasurementEvent>
<isSupportQRCodeEvent>
true
</isSupportQRCodeEvent>
<isSupportVisitorEvent>
true
</isSupportVisitorEvent>
<isSupportEmployeeAuthEvent>
true
</isSupportEmployeeAuthEvent>
<isSupportVisitorInfoSearchEvent>
<isSupportVisitorInfoSearchEvent>
true
</isSupportVisitorInfoSearchEvent>
<isSupportConsumptionEvent>
true
</isSupportConsumptionEvent>
<isSupportTransactionRecordEvent>
true
</isSupportTransactionRecordEvent>
<isSupportFaceContrastResultDisplay>
true
</isSupportFaceContrastResultDisplay>
<isSupportSnapshotAsync>
true
</isSupportSnapshotAsync>
<isSupportLogExportByUSB>
</isSupportLogExportByUSB>
<isSupportShellCmd>
</isSupportShellCmd>
<faceMonitor opt="dailyFaceMonitor,dailyFaceTracking,VCAFaceMonitor,VCAFaceTracking,manualFaceMonitor,advanceConfiguration,">
true
</faceMonitor>
<isSupportRelatedVCAResource>
</isSupportRelatedVCAResource>
<isSupportVehicleMonitor>
true
</isSupportVehicleMonitor>
<isSupportManualVehicleMonitor>
true
</isSupportManualVehicleMonitor>
<isSupportDailyVehicleMonitor>
true
</isSupportDailyVehicleMonitor>
<isSupportInputProxyDeviceInfo>
true
</isSupportInputProxyDeviceInfo>
<isSupportAccessControlCap>
true
</isSupportAccessControlCap>
<isSupportDebugLog>
true
</isSupportDebugLog>
<isSupportFaceAppear>
</isSupportFaceAppear>
<isSupportFaceDisappear>
</isSupportFaceDisappear>
<isSupportTeacherBehavior>
true
</isSupportTeacherBehavior>
<isSupportHeadRiseRate>
</isSupportHeadRiseRate>
<isSupportIPCUpgrade>
true
</isSupportIPCUpgrade>
<isSupportFaceLibRebuildEvent>
</isSupportFaceLibRebuildEvent>
<isSupportCalibrationStream>
</isSupportCalibrationStream>
<isSupportChannelOccupy>
</isSupportChannelOccupy>
<isSupportOffDuty>
</isSupportOffDuty>
<isSupportNoCertificate>
</isSupportNoCertificate>
<isSupportSmokeAlarm>
true
</isSupportSmokeAlarm>
<isSupportBatteryCarDisobey>
</isSupportBatteryCarDisobey>
<isSupportNoFireExtinguisherRecog>
</isSupportNoFireExtinguisherRecog>
<isSupportIndoorPasswayBlock>
</isSupportIndoorPasswayBlock>
<isSupportFireSmartFireDetect>
true
</isSupportFireSmartFireDetect>
<isSupportDetectorRunningStatus>
true
</isSupportDetectorRunningStatus>
<isSupportDetectorOperationStatus>
true
</isSupportDetectorOperationStatus>
<isSupportDetectorTemperatureAlarm opt="highTemperature,riseTemperature,flame">
true
</isSupportDetectorTemperatureAlarm>
<isSupportDetectorShelterAlarm>
</isSupportDetectorShelterAlarm>
<isSupportDetectorMotionAlarm>
</isSupportDetectorMotionAlarm>
<isSupportDetectorTamperAlarm>
</isSupportDetectorTamperAlarm>
<isSupportDetectorEmergencyAlarm>
</isSupportDetectorEmergencyAlarm>
<isSupportDetectorSmokeAlarm>
</isSupportDetectorSmokeAlarm>
<isSupportDetectorCombustibleGasAlarm>
</isSupportDetectorCombustibleGasAlarm>
<isSupportFireControlData>
</isSupportFireControlData>
<isSupportFireNoRegulation>
</isSupportFireNoRegulation>
<isSupportSmokeFireRecognize>
</isSupportSmokeFireRecognize>
<isSupportClientProxyWEB>
</isSupportClientProxyWEB>
<WEBLocation>
local
</WEBLocation>
<isSupportWEBLocalPlug>
</isSupportWEBLocalPlug>
<deviceId>
</deviceId>
<isSupportTimeZone>
true
</isSupportTimeZone>
<isSptHealthDetection>
true
</isSptHealthDetection>
<isSptDiagnosis>
true
</isSptDiagnosis>
<isSptSerialLogCfg>
true
</isSptSerialLogCfg>
<isSptFileExport>
true
</isSptFileExport>
<isSptCertificationStandard>
</isSptCertificationStandard>
<isSptKeypadLock>
true
</isSptKeypadLock>
<isSupportVibrationDetection>
true
</isSupportSmokingDetectAlarm>
<isSupportRadarChannels>
true
</isSupportRadarChannels>
<radarIPDForm>
single
</radarIPDForm>
<isSupportRadarFieldDetection>
true
</isSupportRadarFieldDetection>
<isSupportRadarLineDetection>
true
</isSupportRadarLineDetection>
<mixedTargetDetectionWebNoDisplay>
<mixedTargetDetectionWebNoDisplay>
</mixedTargetDetectionWebNoDisplay>
<isSupportRemovePlaybackRecord>
</isSupportRemovePlaybackRecord>
<isSupportAudioUpload>
true
</isSupportAudioUpload>
<VCAResourceList>
<VCAResource>
<VCAResourceType>
test
</VCAResourceType>
<ChannleVCAResourceList>
<ChannleVCAResource>
<channel>
</channel>
<channleVCAResourceType>
test
</channleVCAResourceType>
</ChannleVCAResource>
</ChannleVCAResourceList>
</VCAResource>
</VCAResourceList>
<isSupportSlotInsertion>
</isSupportSlotInsertion>
<isSupportNetworkLoop>
</isSupportNetworkLoop>
<isSupportApOnOffLine>
</isSupportApOnOffLine>
<isSupportAbnormalWANPort>
</isSupportAbnormalWANPort>
<isSupportAPException>
</isSupportAPException>
<isSupportACException>
</isSupportACException>
<isSupportCartridgeCapacity>
</isSupportCartridgeCapacity>
<isSupportCDCakeBoxCapacity>
</isSupportCDCakeBoxCapacity>
<isSupportSleep>
true
</isSupportSleep>
<isSupportContainerDetection>
</isSupportContainerDetection>
<isSupportRadarVideoDetection>
true
</isSupportRadarVideoDetection>
<isSupportRadarVideoDetectionRealtime>
true
</isSupportRadarVideoDetectionRealtime>
<isSupportBatteryStatusUpload>
true
</isSupportBatteryStatusUpload>
<isSupportPowerConsumptionStatusUpload>
</isSupportPowerConsumptionStatusUpload>
<isSupportOnlineUpgradeTask>
</isSupportOnlineUpgradeTask>
<isSupportPersonArmingTrack>
true
</isSupportPersonArmingTrack>
<isSupportManualPersonArmingTrack>
true
</isSupportManualPersonArmingTrack>
<isSupportGPSVerification>
true
</isSupportGPSVerification>
<isSupportHBDLib>
true
</isSupportHBDLib>
<isSupportDisinfectionInfo>
</isSupportDisinfectionInfo>
<isSupportTempQueryDelete>
</isSupportTempQueryDelete>
<isSupportMobilePayment>
</isSupportMobilePayment>
<isSupportFileSearch>
true
</isSupportFileSearch>
<isSupportFileExportAsync>
true
</isSupportFileExportAsync>
<isSupportSSDFileSystemCapacity>
true
</isSupport4GSafetyHelmetInfo>
<isSupportICCID>
true
</isSupportICCID>
<isSupportFireEscapeDetection>
true
</isSupportFireEscapeDetection>
<isSupportTakingElevatorDetection>
true
</isSupportTakingElevatorDetection>
<isSupportVehicleMatchResult>
true
</isSupportVehicleMatchResult>
<isSupportDataAware>
true
</isSupportVehicleThermometry>
<AssociationScenesList>
<AssociationScenes>

<channelID>
1
</channelID>
<isSupportScene>
true
</isSupportScene>
</AssociationScenes>
</AssociationScenesList>
<supportRelationVideoEvent opt="PIR,cityManagement,roadMaint">
</supportRelationVideoEvent>
<isSupportVCAResourceList>
true
</isSupportVCAResourceList>
<isSupportConvergenceCloud>
</isSupportConvergenceCloud>
<isSupportInterconnection>
</isSupportInterconnection>
<isSupportHPVehicleStatus>
</isSupportHPVehicleStatus>
<isSupportHPWorkingStatus>
</isSupportHPWorkingStatus>
<isSupportHPPeopleDetection>
</isSupportHPPeopleDetection>
<isSupportHPVehicleDoorDetection>
</isSupportHPVehicleDoorDetection>
<isSupportRoadMaint>
</isSupportRoadMaint>
<isSupportDockStationInfo>
</isSupportDockStationInfo>
<isSupportBodyCameraManualForensics>
</isSupportBodyCameraManualForensics>
<isSupportBodyCameraLogin>
</isSupportBodyCameraLogin>
<isSupportBodyCameraRunStatus>
</isSupportBodyCameraRunStatus>
<isSupportBodyCameraSignIn>
</isSupportBodyCameraSignIn>
<isSupportAlertDistribution>
</isSupportAlertDistribution>
<isSupportImageCapture>
</isSupportImageCapture>
<isSupportScheduledRecordUpload>
</isSupportScheduledRecordUpload>
<isSupportTargetPatternCollect>
</isSupportTargetPatternCollect>
<isSupportAudioAnalysis>
true
</isSupportAudioAnalysis>
<isSupportDebuggingDataExport>
</isSupportDebuggingDataExport>
<isSupportInternalParaAdjust>
</isSupportInternalParaAdjust>
<isSupportManualImageCapture>
</isSupportManualImageCapture>
<characteristicCode min="1" max="128">
test
</characteristicCode>
<isSupportSIMCardStatus>
true
</isSupportSIMCardStatus>
<OpenPlatformCap>

<isSupportOpenPlatform>
true
</isSupportOpenPlatform>
<maxAPPNum>
</maxAPPNum>
</OpenPlatformCap>
<isSupportLogException>
true
</isSupportLogException>
<isSupportReID>
true
</isSupportReID>
<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
</isSupportScreenConfig>
<isSupportTemperatureMonitor>
true
</isSupportTemperatureMonitor>
<isSupportObjectServer>
true
</isSupportObjectServer>
<isSupportCDsStatus>
</isSupportCDsStatus>
<isSupportCoalGangueDetection>
</isSupportCoalGangueDetection>
<isSupportVacantSeatRate>
</isSupportVacantSeatRate>
<isSupportObjectsThrownDetection>
</isSupportObjectsThrownDetection>
<isSupportBVCorrectDataSearch>
</isSupportBVCorrectDataSearch>
<isSupportSlagTruckWashingDetection>
true
</isSupportSlagTruckWashingDetection>
<isSupportWOL>
</isSupportWOL>
<isSupportPersonQueueTimingStatistics>
true
</isSupportPersonQueueTimingStatistics>
<isSupportLensParamFile>
</isSupportLensParamFile>
<isSupportVehiclePassingInParkingLot>
true
</isSupportVehiclePassingInParkingLot>
<isSupportPowerOutput>
</isSupportPowerOutput>
<isSupportIPCUpgradeByFTP>
true
</isSupportIPCUpgradeByFTP>
<isSupportMethaneConcentrationException>
true
</isSupportMethaneConcentrationException>
<isSupportMethaneLightIntensityException>
true
</isSupportMethaneLightIntensityException>
<isSupportLocalButtonPermission>
true
</isSupportLocalButtonPermission>
<isSupportLocalButtonRecord>
</isSupportLocalButtonRecord>
<isSupportLocalButtonSnapshot>
</isSupportLocalButtonSnapshot>
<isSupportVoiceTalkEvent>
</isSupportVoiceTalkEvent>
<isSupportPowerSupply>
true
</isSupportPowerSupply>
<isSupportbarrierGateStatus>
true
</isSupportbarrierGateStatus>
<DeployCap>
<deployID opt="1,2">
0
</deployID>
</DeployCap>
<isSupportSignalControllerStatus>
</isSupportSignalControllerStatus>
<isSupportSignalControllerFault>
</isSupportSignalControllerFault>
<isSupportNTPConfig>
true
</isSupportNTPConfig>
<isSupportConsumptionQuery>
</isSupportConsumptionQuery>
<StreamingCodingRegionPositionCap>

<ChannelsList>
<channelsID>
</channelsID>
</ChannelsList>
</StreamingCodingRegionPositionCap>
<isSupportLowPowerPlan>
true
</isSupportLowPowerPlan>
<isSupportPlateQuaAlarm>
</isSupportPlateQuaAlarm>
<isSupportWiegand>
true
</isSupportWiegand>
<zoomFocusWebDisplay opt="ROI,roadTrafficDetection,SMD,mixedTargetDetection,faceCapture">
ROI
</zoomFocusWebDisplay>
<isSupportInternalParamsAdjustment>
true
</isSupportInternalParamsAdjustment>
<isSupportDiagnosticReport>
true
</isSupportWaterQualitySearch>
<isSupportExhaustDetection>
true
</isSupportExhaustDetection>
<isSupportTPMSecretKey>
true
</isSupportTPMSecretKey>
<isSupportWeatherStation>
</isSupportWeatherStation>
<isSupportRoadVisibilityAnalysis>
</isSupportRoadVisibilityAnalysis>
<isSupportRoadWeatherAnalysis>
</isSupportRoadWeatherAnalysis>
<isSupportRoadVisibilityAbnormal>
</isSupportRoadVisibilityAbnormal>
<isSupportRoadWeatherAbnormal>
</isSupportRoadWeatherAbnormal>
<isSupportChannelsTimeSync>
true
</isSupportChannelsTimeSync>
<isSupport433Sensor>
true
</isSupport433Sensor>
<isSupportSignalSource>
true
</isSupportSignalSource>
<isSupportUSBConfig>
true
</isSupportUSBConfig>
<isSupportStandbyStrategy>
true
</isSupportWakeupStrategy>
<isSupportSeachMutexFunction>
</isSupportSeachMutexFunction>
<isSupportMultiDeviceID>
</isSupportMultiDeviceID>
<isNotSupportMultiDeviceIDCustomName>
</isNotSupportMultiDeviceIDCustomName>
<isSupportMixedSecurityChecking>
</isSupportMixedSecurityChecking>
<isSupportVisiblePackageEvent>
</isSupportVisiblePackageEvent>
<isSupportBarCodeEvent>
</isSupportBarCodeEvent>
<isSupportGaugeReading>
</isSupportGaugeReading>
<isSupportUncertificateCompareEvent>
</isSupportUncertificateCompareEvent>
<isSupportAudioDiacritical>
</isSupportAudioDiacritical>
<isSupportMEFReportSearch>
</isSupportMEFReportSearch>
<isSupportBroadcastTriggerEvent>
<isSupportBroadcastTriggerEvent>
true
</isSupportBroadcastTriggerEvent>
<isSupportFishingShipDetection>
true
</isSupportFishingShipDetection>
<isSupportHPVehicleLoadingRate>
true
</isSupportHPVehicleLoadingRate>
<isSupportVideoBarrierGateDetection>
true
</isSupportVideoBarrierGateDetection>
<isSupportLogicalResource>
true
</isSupportLogicalResource>
<isSupportSlagTruckCoverPlate>
true
</isSupportSlagTruckCoverPlate>
<isSupportTrainDetection>
true
</isSupportTrainDetection>
<isNotSupportVideoOverlays>
</isNotSupportVideoOverlays>
<isSupportScheduledCaptureTask>
true
</isSupportScheduledCaptureTask>
<isSupportGuideCfg>
true
</isSupportGuideCfg>
<isSupportCameraGroupPeopleCounting>
true
</isSupportCameraGroupPeopleCounting>
<isSupportAngleDeviationDetection>
</isSupportAngleDeviationDetection>
<isSupportCityCode>
</isSupportCityCode>
<isSupportAlcoholDetectionResult>
</isSupportAlcoholDetectionResult>
<isSupportAlcoholDetectionRodBind>
</isSupportAlcoholDetectionRodBind>
<isSupportAlcoholDetectionRodBindQuery>
</isSupportAlcoholDetectionRodBindQuery>
<isSupportAlcoholDetectionRodUnbind>
</isSupportAlcoholDetectionRodUnbind>
<isSupportAbnormalDriving>
</isSupportAbnormalDriving>
<isSupportEmanationsEvent>
</isSupportEmanationsEvent>
<isSupportClientUpdatePackage>
</isSupportClientUpdatePackage>
<isSupportDeviceStatusUploadStrategy>
</isSupportDeviceStatusUploadStrategy>
<isSupportDialIndicatorReading>
</isSupportDialIndicatorReading>
<isNotSupportAudioVideoCompress>
</isNotSupportAudioVideoCompress>
<isSupportUPLCExceptionEvent>
true
</isSupportUPLCExceptionEvent>
<isSupportUrgentTurn>
true
</isSupportUrgentTurn>
<isSupportUrgentBrake>
true
</isSupportUrgentBrake>
<isSupportUrgentAcceleration>
true
</isSupportUrgentAcceleration>
<isSupportVehiclePanicButton>
true
</isSupportVehiclePanicButton>
<isSupportOverSpeed>
true
</isSupportOverSpeed>
<isSupportAbnormalAcceleration>
true
</isSupportAbnormalAcceleration>
<isSupportRollover>
true
</isSupportRollover>
<isSupportCollision>
true
</isSupportCollision>
<isSupportVehicleOBUInfo>
true
</isSupportVehicleOBUInfo>
<isSupportPowerUpPicture>
true
</isSupportPowerUpPicture>
<isSupportPowerUpPictureCfg>
true
</isSupportPowerUpPictureCfg>
<isSupportAlgoPackageScheduling>
true
</isSupportAlgoPackageScheduling>
<isSupportVoiceTalkRequestingAlarm>
true
</isSupportVoiceTalkRequestingAlarm>
<isSupportSetupStructure>
true
</isSupportSetupStructure>
<isSupportPassNumInfoEvent>
true
</isSupportPassNumInfoEvent>
<isShowClientRemote>
true
</isShowClientRemote>
<isSupportUserManualQRCode>
true
</isSupportUnclosedFrontPanel>
<isSupportVehicleWeight>
true
</isSupportVehicleWeight>
<isSupportSecurityPanicEvent>
true
</isSupportSecurityPanicEvent>
<isSupportTrafficLightMalfunction>
true
</isSupportTrafficLightMalfunction>
<isSupportTOFShelterAlarm>
true
</isSupportSetMealQuery>
<isSupportMultiScreenControlAlarm>
true
</isSupportMultiScreenControlAlarm>
<isSupportKeyFrameLoss>
true
</isSupportKeyFrameLoss>
<isSupportWorkStatusCfg>
true
</isSupportWorkStatusCfg>
<isSupportHealthInfoSyncQuery>
true
</isSupportHealthInfoSyncQuery>
<isSupportVisitorPictureSearchEvent>
true
</isSupportVisitorPictureSearchEvent>
<isSupportEZVIZParameterTest>
true
</isSupportEZVIZParameterTest>
<isSupportUnattendedPackageEvent>
</isSupportUnattendedPackageEvent>
<isSupportPackageFragmentEvent>
true
</isSupportPackageFragmentEvent>
<isSupportPackageBarcodeMismatchEvent>
</isSupportPackageBarcodeMismatchEvent>
<isSupportCheckingModeSwitchEvent>
<isSupportCheckingModeSwitchEvent>
true
</isSupportCheckingModeSwitchEvent>
<FaceSnapPrivacyMask>

<ChannelsList>
<channelsID>
</channelsID>
</ChannelsList>
</FaceSnapPrivacyMask>
<FaceContrastPrivacyMask>

<ChannelsList>
<channelsID>
</channelsID>
</ChannelsList>
</FaceContrastPrivacyMask>
<isSupportHumanBodyComparison>
true
</isSupportHumanBodyComparison>
<isSupportMedicalInfoSearchEvent>
true
</isSupportMedicalInfoSearchEvent>
<isSupportConsumptionStatusQuery>
true
</isSupportConsumptionStatusQuery>
<isSupportShipChannelAbnormal>
</isSupportShipChannelAbnormal>
<isSupportDepositRetrieveEvent>
</isSupportDepositRetrieveEvent>
<isSupportDepositTimeoutEvent>
</isSupportDepositTimeoutEvent>
<isSupportCabinetStatusEvent>
</isSupportCabinetStatusEvent>
<isSupportCabinetAuthorityExpired>
</isSupportCabinetAuthorityExpired>
<isSupportT1Test>
</isSupportT1Test>
<isSupportDrivingDirectionAtIntersection>
</isSupportDrivingDirectionAtIntersection>
<isSupportPlaceSceneExecuteStatus>
</isSupportPlaceSceneExecuteStatus>
<isSupportSceneRecordingCtrl>
</isSupportSceneRecordingCtrl>
<isSupportStreamRecordStatus>
</isSupportStreamRecordStatus>
<isSupportManualSnapPicture>
</isSupportManualSnapPicture>
<isSupportVerificationResultEvent>
</isSupportVerificationResultEvent>
<OTAP>
<isSupportOTAPModel>
</isSupportOTAPModel>
</OTAP>
<isSupportForeignObjectInRoadDetection>
</isSupportForeignObjectInRoadDetection>
<isSupportUPLCMethodOperatingStatus>
</isSupportUPLCMethodOperatingStatus>
<isSupportMaterialScanTaskStatus>
</isSupportMaterialScanTaskStatus>
<isSupportSearchInputProxy>
</isSupportSearchInputProxy>
<isSupportPostureDetection>
</isSupportPostureDetection>
<isSupportFans>
</isSupportFans>
<pickUpCalibration>
<pickUpCalibration>
<ChannelsList>
<channelsID>
</channelsID>
</ChannelsList>
</pickUpCalibration>
<isSupportSerialLogUpload>
</isSupportSerialLogUpload>
<isSupportLiquidDetectionEvent>
</isSupportLiquidDetectionEvent>
<isSupportETCRSU>
</isSupportETCRSU>
<isSupportVideoCodeConvertTool>
</isSupportVideoCodeConvertTool>
<supportQuickConfigType opt="icr,dayNightGate,syncSignalOutput">
syncSignalOutput
</supportQuickConfigType>
<isSupportVisualLocation>
</isSupportVisualLocation>
<isSupportVideoAccessAbnormal>
</isSupportVideoAccessAbnormal>
<isSupportSubSystemAbnormal>
</isSupportSubSystemAbnormal>
<isSupportSearchFileList>
</isSupportSearchFileList>
<isSupportDistanceDetectionEvent>
</isSupportDistanceDetectionEvent>
<isSupportMeetingQueryEvent>
</isSupportMeetingQueryEvent>
<isSupportMeetingLockEvent>
</isSupportMeetingLockEvent>
<isSupportMeetingAddEvent>
</isSupportMeetingAddEvent>
<isSupportMeetingModifyEvent>
</isSupportMeetingModifyEvent>
<isSupportMeetingCancelEvent>
</isSupportMeetingCancelEvent>
<isSupportMeetingElementQueryEvent>
</isSupportMeetingElementQueryEvent>
<isSupportScreenBindIPCEvent>
</isSupportScreenBindIPCEvent>
<isSupportSensorDetection>
</isSupportSensorDetection>
<isSupportClearLogCache>
</isSupportClearLogCache>
<isSupportRoadOccupyDetection>
</isSupportRoadOccupyDetection>
<isSupportMeetingRoomSignInEvent>
</isSupportMeetingRoomSignInEvent>
<isSupportMeetingRoomSignOutEvent>
</isSupportMeetingRoomSignOutEvent>
<isSupportTimeTypeSTD>
</isSupportTimeTypeSTD>
<isSupportScanner>
</isSupportScanner>
<isSupportRegionTargetNumberCounting>
</isSupportRegionTargetNumberCounting>
<depthMapMaintainMode>
<ChannelsList>
<channelID>
</channelID>
</ChannelsList>
</depthMapMaintainMode>
<isSupportExportPipCalibrationFile>
</isSupportExportPipCalibrationFile>
<isSupportCourseUploadInfo>
</isSupportCourseUploadInfo>
<isSupportPresetSwitchingInformation>
</isSupportPresetSwitchingInformation>
<isSupportCabinetChargingQuery>
</isSupportCabinetChargingQuery>
<isSupportSearchVoltageAndPowerConsumptionReport>
</isSupportSearchVoltageAndPowerConsumptionReport>
<isSupportDeviceDrop>
</isSupportDeviceDrop>
<isSupportDeviceNotMoved>
</isSupportDeviceNotMoved>
<isSupportWalkWrongWayOnEscalator>
</isSupportWalkWrongWayOnEscalator>
<isSupportFallOnEscalator>
</isSupportFallOnEscalator>
<isSupportCarryLargeLuggageOnEscalator>
</isSupportCarryLargeLuggageOnEscalator>
<isSupportPushStrollerOnEscalator>
</isSupportPushStrollerOnEscalator>
<isSupportTeachingSpeechDetection>
</isSupportTeachingSpeechDetection>
<updatefirmwareType opt="warningScreenFirmware,warningScreenFont,warningScreenVoice">
warningScreenFirmware
</updatefirmwareType>
<isSupportPaymentQRCodeQuery>
</isSupportPaymentQRCodeQuery>
<isSupportTopUpEvent>
</isSupportTopUpEvent>
<isSupportTopUpRequest>
</isSupportTopUpRequest>
<isSupportTopUpStatusQuery>
</isSupportTopUpStatusQuery>
<isSupportLogOffRefundRequest>
</isSupportLogOffRefundRequest>
<isSupportLogOffRefundStatusQuery>
</isSupportLogOffRefundStatusQuery>
<isSupportAuthenticationTimeoutEvent>
</isSupportAuthenticationTimeoutEvent>
<isSupportCertificateCapture>
</isSupportCertificateCapture>
<isSupportDeviceBatchActivation>
</isSupportDeviceBatchActivation>
<isSupportPlaceEnvironmentMonitoringRule>
</isSupportPlaceEnvironmentMonitoringRule>
<isSupportEngineResource>
</isSupportEngineResource>
<isSupportPTModulePowerCfg>
</isSupportPTModulePowerCfg>
<isSupportGetBoxDoorDetectionCfg>
</isSupportGetBoxDoorDetectionCfg>
<isSupportModifyBoxDoorDetectionCfg>
</isSupportModifyBoxDoorDetectionCfg>
<isSupportSmartBoxStatus>
</isSupportSmartBoxStatus>
<isSupportBatteryStatusCtrl>
</isSupportBatteryStatusCtrl>
<isSupportCooler>
</isSupportCooler>
<isSupportBoxDoorDetectionCfg>
</isSupportBoxDoorDetectionCfg>
<isSupportBoxDoorStatus>
</isSupportBoxDoorStatus>
<isSupportLightningProtectionStatus>
</isSupportLightningProtectionStatus>
<isSupportDeviceVisualLocalizationDetectionEvent>
</isSupportDeviceVisualLocalizationDetectionEvent>
<isSupportDeviceVisualLocalizationAnalysisEvent>
</isSupportDeviceVisualLocalizationAnalysisEvent>
<isSupportGetPowerPortWorkParamList>
</isSupportGetPowerPortWorkParamList>
<isSupportUsersLoginNotification>
</isSupportUsersLoginNotification>
<isSupportLiquidLevelDetectorInfo>
</isSupportLiquidLevelDetectorInfo>
<isSupportWaterPressureDetectorInfo>
</isSupportWaterPressureDetectorInfo>
<isSupportEncryptionFileUpgradeMgr>
</isSupportEncryptionFileUpgradeMgr>
<isSupportInformedConsentTextParam>
</isSupportInformedConsentTextParam>
<isSupportSendConsolePassword>
</isSupportSendConsolePassword>
<isSupportAutoLaserRanging>
</isSupportAutoLaserRanging>
<isSupportDelayedReboot>
</isSupportDelayedReboot>
<isSupportFalseAlarmMaterialLibMgr>
</isSupportFalseAlarmMaterialLibMgr>
<isSupportGetServerRandom>
</isSupportGetServerRandom>
<isSupportSendTelnetTestCmd>
</isSupportSendTelnetTestCmd>
<isSupportTelnetTestCmdStatus>
</isSupportTelnetTestCmdStatus>
<isSupportImportUSBKeyAuthInfo>
</isSupportImportUSBKeyAuthInfo>
<isSupportSendSupervisionRecordCollection>
</isSupportSendSupervisionRecordCollection>
<isSupportStopPersonnelOperationGuidance>
</isSupportStopPersonnelOperationGuidance>
<isSupportRequestPersonnelOperationGuidance>
</isSupportRequestPersonnelOperationGuidance>
<isSupportSearchPersonnelOperationSupervisionTask>
</isSupportSearchPersonnelOperationSupervisionTask>
<isSupportDeletePersonnelOperationSupervisionTask>
</isSupportDeletePersonnelOperationSupervisionTask>
<isSupportAddPersonnelOperationSupervisionTask>
</isSupportAddPersonnelOperationSupervisionTask>
<isSupportStopPersonnelOperationHelp>
</isSupportStopPersonnelOperationHelp>
<isSupportRequestPersonnelOperationHelp>
</isSupportRequestPersonnelOperationHelp>
<isSupportUserLoginStatusChangeEvent>
</isSupportUserLoginStatusChangeEvent>
<isSupportObstacleAvoidance>
</isSupportObstacleAvoidance>
</DeviceCap>
21.5.11 Import the configuration files securely

Request URL
PUT /ISAPI/System/configurationData?security=<security>&iv=<iv>&secretkey=<secretkey>
Query Parameter
security string --
iv string --
secretkey string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.6 Accessing via Protocol

21.6.1 Get device protocol capability
Request URL
GET /ISAPI/Security/adminAccesses/capabilities
Query Parameter
None
Request Message
None
Response Message
<AdminAccessProtocolList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<AdminAccessProtocol>
<id>
test
</id>
true
</enabled>
<protocol opt="HTTP,HTTPS,SDK,RTSP,DEV_MANAGE,WebSocket,WebSocketS,SDK_OVER_TLS,MATRIX_GATEWAY,IOT,GB35114,104Proto,SRTP,ModbusTCP">
GB35114
</protocol>
<redirectToHttps opt="true,false">
</redirectToHttps>
<streamOverTls opt="true,false">
true
</streamOverTls>
<portNo min="1" max="65535" default="8443">
1
</portNo>
<TLS1_1Enable opt="true,false">
</TLS1_1Enable>
</TLS1_2Enable>
</TLS1_3Enable>
<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>
<connectTime min="1" max="999" def="10">
10
</connectTime>
</AdminAccessProtocol>
</AdminAccessProtocolList>
21.6.2 Get the security parameters of a single access protocol

Request URL
GET /ISAPI/Security/adminAccesses/<indexID>
Query Parameter
indexID string --
Request Message
None
Response Message
<AdminAccessProtocol xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
</id>
<enabled>
true
</enabled>
<protocol>
HTTP
</protocol>
<redirectToHttps>
true
</redirectToHttps>
<streamOverTls>
true
</streamOverTls>
<portNo>
80
</portNo>
<TLS1_1Enable>
true
</TLS1_1Enable>
<TLS1_2Enable>
</TLS1_2Enable>
<TLS1_3Enable>
</TLS1_3Enable>
21.6.3 Set the parameters of a specific protocol that supported by device

Request URL
PUT /ISAPI/Security/adminAccesses/<indexID>
Query Parameter
indexID string --
Request Message
<AdminAccessProtocol xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
</id>
<enabled>
true
</enabled>
<protocol>
HTTP
</protocol>
<redirectToHttps>
true
</redirectToHttps>
<streamOverTls>
true
</streamOverTls>
<portNo>
80
</portNo>
<TLS1_1Enable>

<enabled>
false
</enabled>
<registerStatus>
true
</registerStatus>
<redirect>
true
</redirect>
<serverAddress>
ipaddress
<hostName>
test
</hostName>
<ipAddress>
172.6.64.7
</ipAddress>
<ipv6Address>
1080:0:0:0:8:800:200C:417A
</ipv6Address>
</serverAddress>
<verificationCode>
123456789TESTtest
</verificationCode>
<offlineStatus>
secretKeyInvalid
</offlineStatus>
<enabledTiming>
true
</enabledTiming>
<version>
test
</version>
<operateCode>
test
</operateCode>
<netWork>
3
</netWork>
<convergenceCloudEnabled>
false
</convergenceCloudEnabled>
<streamEncrypteEnabled>
true
</streamEncrypteEnabled>
<bindStatus>
bind
</bindStatus>
<upISAPIStatus>
open
</upISAPIStatus>
<offlineCode>
0xFFFFFFFF
</offlineCode>
<periodicTestEnabled>
true
</periodicTestEnabled>
<periodicTestTime>
10
</periodicTestTime>
<networkPriorityEnabled>
</networkPriorityEnabled>
<NetworkPriorityList>

<NetworkPriority>

<networkType>
1
</networkType>
<priority>
1
</priority>
</NetworkPriority>
</NetworkPriorityList>
<protocolVersion>
v2.0
</protocolVersion>
</protocolVersion>
</EZVIZ>
21.7.2 Set Hik-Connect parameters

Request URL
PUT /ISAPI/System/Network/EZVIZ?security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message


<enabled>
false
</enabled>
<registerStatus>
true
</registerStatus>
<redirect>
true
</redirect>
<serverAddress>

ipaddress
<hostName>
test
</hostName>
<ipAddress>
172.6.64.7
</ipAddress>
<ipv6Address>
1080:0:0:0:8:800:200C:417A
</ipv6Address>
</serverAddress>
<verificationCode>
test
</verificationCode>
<offlineStatus>
secretKeyInvalid
</offlineStatus>
<enabledTiming>
true
</enabledTiming>
<version>
test
</version>
<operateCode>
test
</operateCode>
<netWork>
3
</netWork>
<convergenceCloudEnabled>
<streamEncrypteEnabled>
true
<upISAPIStatus>
open
</upISAPIStatus>
<bindStatus>
bind
</bindStatus>
<periodicTestEnabled>
true
<periodicTestTime>
10
</periodicTestTime>
<networkPriorityEnabled>
<NetworkPriorityList>

<NetworkPriority>

<networkType>
1
</networkType>
<priority>
1
</priority>
</NetworkPriority>
<protocolVersion>
v2.0
</protocolVersion>
<streamEncryptionPassword>
test
</streamEncryptionPassword>
</EZVIZ>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.7.3 Get the capability of configuring EZ access service

Request URL
GET /ISAPI/System/Network/EZVIZ/capabilities
Query Parameter
None
Request Message
None
Response Message


false
</enabled>
<registerStatus opt="true,false">
true
</registerStatus>
<redirect opt="true,false">
</redirect>
<serverAddress>


ipaddress
www.baidu.com
</hostName>
<ipAddress min="null" max="null">
172.6.64.7
</ipAddress>
<ipv6Address min="null" max="null">
1080:0:0:0:8:800:200C:417A
</ipv6Address>
</serverAddress>
<verificationCode min="null" max="null">
test
</verificationCode>
<offlineStatus opt="secretKeyInvalid,networkError,notInAllowList,unknown">
test
</offlineStatus>
<netWork opt="1,2,3,4">
3
</netWork>
<streamEncrypteEnabled opt="true,false">
true
<bindStatus opt="bind,unbind,unknown">
bind
</bindStatus>
<isSupportEZVIZQRCode>
true
</isSupportEZVIZQRCode>
<isSupportUpISAPI>
true
</isSupportUpISAPI>
<isSupportDownISAPI>
true
</isSupportDownISAPI>
<convergenceCloudEnabled opt="true,false">
false
<offlineCode min="0" max="16">
0xFFFFFFFF
</offlineCode>
<isSupportEZVIZCloud>
true
</isSupportEZVIZCloud>
<periodicTestEnabled opt="true,false">
true
<periodicTestTime min="10" max="86400">
5
</periodicTestTime>
<CloudStorage>
true
</isSupportChannelRecordsSubscribe>
<isSupportRecordsSubscribeStatistics>
</isSupportRecordsSubscribeStatistics>
</CloudStorage>
<physicalAccessVerification opt="1,2,3,4">
1
</physicalAccessVerification>
<userToken min="0" max="16">
</userToken>
<isSupportUserTokenUpdate opt="true,false">
</isSupportUserTokenUpdate>
<networkPriorityEnabled opt="true,false">
<NetworkPriorityList size="5">

<NetworkPriority>

<networkType opt="1,2,3,4,5">
1
</networkType>
<priority min="1" max="10">
1
</priority>
</NetworkPriority>
<protocolVersion opt="v2.0,v3.0" def="v2.0">
v2.0
</protocolVersion>
<physicalAccessUserToken min="0" max="16">
</physicalAccessUserToken>
<streamEncryptionPassword min="8" max="16">
</streamEncryptionPassword>
<isSupportAccessUserTokenCfgList>
</isSupportAccessUserTokenCfgList>
</EZVIZ>
21.8 ISUP Access Management

21.8.1 Set the EHome server access parameters
Request URL
PUT /ISAPI/System/Network/Ehome?security=<security>&iv=<iv>&centerID=<centerID>
Query Parameter
security string --
iv string --
centerID string --
Request Message
<Ehome xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<enabled>
</enabled>
ipaddress
<hostName>
time.windows.com
</hostName>
<ipAddress>
192.168.1.112
</ipAddress>
<ipv6Address>
1030::C9B4:FF12:48AA:1A2B
</ipv6Address>
<portNo>
74
</portNo>
<deviceID>
test1234
</deviceID>
<registerStatus>
true
</registerStatus>
<ServerAddressList>

<ServerAddress>

<id>
alarm
</id>
<ipAddress>
192.168.1.113
</ipAddress>
<portNo>
76
</portNo>
</ServerAddress>
</ServerAddressList>
<key>
test
</key>
<version>
2.3.0.4
</version>
<voiceDeviceType>
bluetooth
</voiceDeviceType>
<protocolVersion>
v5.0
</protocolVersion>
<netWork>
1
</netWork>
</Ehome>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.8.2 Get the configuration capability of accessing servers via ISUP (EHome)
Request URL
GET /ISAPI/System/Network/Ehome/capabilities
Query Parameter
None
Request Message
None
Response Message


false
</enabled>
<id min="1" max="1">
test
</id>
ipaddress
<GPRSAddressingFormatType opt="ipaddress">
ipaddress
</GPRSAddressingFormatType>
time.windows.com
</hostName>
192.168.1.112
</ipAddress>
1030::C9B4:FF12:48AA:1A2B
</ipv6Address>
74
</portNo>
test1234
</deviceID>
<registerStatus opt="true,false">
true
</registerStatus>
<ServerAddressList>

<ServerAddress>
<id>
alarm
</id>
<ipAddress>
192.168.1.113
</ipAddress>
<portNo>
76
</portNo>
</ServerAddress>
<key min="1" max="64">
test
</key>
<version min="1" max="64">
test
</version>
<voiceDeviceType opt="bluetooth,client,local">
test
</voiceDeviceType>
<protocolVersion opt="v2.0,v2.6,v4.0,v5.0,OTAP">
v5.0
</protocolVersion>
<netWork opt="0,1,2,3,4,5,6">
1
</netWork>
<pictureServerID min="1" max="64">
1
</pictureServerID>
<ISUPID min="1" max="64">
1
</ISUPID>
<isSupportTest>
true
</isSupportTest>
<periodicTestEnabled opt="true,false">
true
<periodicTestTime min="10" max="86400">
50
</periodicTestTime>
<isSupportMulticenterTest>
</isSupportMulticenterTest>
</Ehome>
21.8.3 Get the ISUP server access parameters
Request URL
GET /ISAPI/System/Network/Ehome?security=<security>&iv=<iv>&centerID=<centerID>
Query Parameter
security string --
iv string --
centerID string --
Request Message
None
Response Message

<enabled>
false
</enabled>
ipaddress
<hostName>
time.windows.com
</hostName>
<ipAddress>
192.168.1.112
</ipAddress>
<ipv6Address>
1030::C9B4:FF12:48AA:1A2B
</ipv6Address>
<portNo>
74
</portNo>
<deviceID>
test1234
</deviceID>
<registerStatus>
true
</registerStatus>
<ServerAddressList>

<ServerAddress>
<id>
alarm
</id>
<ipAddress>
192.168.1.113
</ipAddress>
<portNo>
76
</portNo>
</ServerAddress>
<key>
test
</key>
<version>
2.3.0.4
</version>
<voiceDeviceType>
bluetooth
</voiceDeviceType>
<protocolVersion>
v5.0
</protocolVersion>
<netWork>
1
</netWork>
</Ehome>
21.9 Picture Storage Protocol Access Management
21.9.1 Set the picture storage server parameters
Request URL
PUT /ISAPI/System/PictureServer?format=json&security=<security>&iv=<iv>
Query Parameter
security enum --
iv string --
Request Message
{
"PictureServerInformation": {
/*req, object, picture server information*/
"pictureServerType": "cloudStorage",
/*req, enum, picture server type, subType:string, desc:"tomact", "VRB", "cloudStorage", "KMS". When the value is null, it indicates that the servers
are all closed*/
"addressingFormatType": "ipaddress",
/*req, enum, address type of the picture storage server, subType:string, desc:"ipaddress" (IP address), "hostname" (domain name)*/
"hostName": "pc3-netsdk",
/*opt, string, domain name of the picture storage server*/
"ipv4Address": "10.17.133.46",
/*opt, string, IPv4 server address of the picture storage server*/
"ipv6Address": "2001:A304:6101:1::E0:F726:4E58",
/*opt, string, IPv6 server address of the picture storage server*/
"portNo": 1024,
/*req, int, picture storage server port, range:[1024,65535]*/
"underlyingProtocol": "http",
/*opt, enum, communication protocol, subType:string, desc:“http”, “https”*/
"cloudStorage": {
/*opt, object, configuration of cloud storage server parameters, dep:and,{$.PictureServerInformation.pictureServerType,eq,cloudStorage}*/
"cloudManageHttpPort": 6120,
/*opt, int, HTTP port No. for central management of the cloud storage server, which can be used for downloading the URLs of pictures and
intelligent structuralization data, range:[1024,65535]*/
"cloudTransDataPort": 9001,
/*opt, int, data transmission port No. of the cloud storage server, range:[1024,65535]*/
"cloudCmdPort": 6011,
/*opt, int, signaling port No. of the cloud storage server, range:[1024,65535]*/
"cloudHeartBeatPort": 9999,
/*opt, int, heartbeat port No. of the cloud storage server, range:[1024,65535]*/
"cloudStorageHttpPort": 8083,
/*opt, int, HTTP port No. of the cloud storage server, range:[1024,65535]*/
"cloudUsername": "username",
/*opt, string, user name of the cloud storage server, range:[0,32]*/
"cloudPassword": "12345",
/*opt, string, user name of the cloud storage server*/
"cloudPoolId": 1,
/*opt, int, cloud storage pool ID (int format), range:[1,4294967295], desc:by default, it is 1 if there is no configured device*/
"clouldProtocolVersion": "V2.0",
/*req, string, protocol version of the cloud storage server, range:[0,32]*/
"clouldAccessKey": "test",
/*opt, string, access key of the cloud storage server, range:[0,64], dep:and,
{$.PictureServerInformation.cloudStorage.clouldProtocolVersion,eq,V2.0}*/
"clouldSecretKey": "test",
/*opt, string, secret key of the cloud storage server, range:[0,64], dep:and,
"resourceID": "test"
/*opt, string, source pool ID (string format), range:[1,256], dep:and,{$.PictureServerInformation.cloudStorage.clouldProtocolVersion,eq,V2.0},
desc:both resourceID and cloudPoolId can be used to configure the cloud storage pool ID. But different from cloudPoolId, the value of resourceID can be in
string format. When both resourceID and cloudPoolId are configured, cloudPoolId has priority over resourceID. If this node is not supported, you can
configure the pool ID via cloudPoolId.*/
}
}
}
Response Message
{
"requestURL": "test",
/*ro, opt, string, URI*/
"statusCode": "test",
/*ro, opt, string, status code*/
"statusString": "test",
/*ro, opt, string, status description*/
"subStatusCode": "test",
/*ro, opt, string, sub status code*/
"errorCode": 1,
/*ro, req, int, error code*/
"errorMsg": "ok"
/*ro, req, string, error message*/
}
21.9.2 Get the configuration capability of the picture storage server

Request URL
GET /ISAPI/System/PictureServer/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object, picture server information*/
"pictureServerType": {
/*ro, opt, object, picture server type*/
"@opt": "tomcat,VRB,cloudStorage,KMS,null",
/*ro, opt, string, optional value*/
"#text": "cloudStorage"
/*ro, req, string, picture server type*/
},
"addressingFormatType": {
/*ro, opt, object, address type of the picture storage server*/
"@opt": "ipaddress,hostname",
/*ro, opt, string, optional value*/
"#text": "ipaddress"
/*ro, req, string, address type of the picture storage server*/
},
"hostName": {
/*ro, opt, object, domain name of the picture storage server*/
"@min": 0,
/*ro, opt, int, minimum value*/
"@max": 64,
/*ro, opt, int, maximum value*/
"#text": "pc3-netsdk"
/*ro, opt, string, domain name of the picture storage server*/
},
"ipv4Address": {
/*ro, opt, object, IPv4 server address of the picture storage server*/
"@min": 0,
"@max": 64,
"#text": "10.17.133.46"
/*ro, opt, string, IPv4 server address of the picture storage server*/
},
"ipv6Address": {
/*ro, opt, object, IPv6 server address of the picture storage server*/
"@min": 0,
"@max": 128,
"#text": "2001:A304:6101:1::E0:F726:4E58"
},
"portNo": {
/*ro, opt, object, picture storage server port*/
"@min": 1024,
"@max": 65535,
"#text": 8000
/*ro, req, int, picture storage server port*/
},
"underlyProtocol": {
/*ro, opt, object, Communication Protocol*/
"@opt": "http,https"
/*ro, opt, string, Communication Protocol*/
},
"cloudStorage": {
/*ro, opt, object, configuration of cloud storage server parameters*/
"cloudManageHttpPort": {
/*ro, opt, object, HTTP port No. for central management of the cloud storage server*/
"@min": 1024,
"@max": 65535,
"#text": 8009
/*ro, opt, int, HTTP port No. for central management of the cloud storage server*/
},
"cloudTransDataPort": {
/*ro, opt, object, data transmission port No. of the cloud storage server*/
"@min": 1024,
"@max": 65535,
"#text": 9001
/*ro, opt, int, data transmission port No. of the cloud storage server*/
},
"cloudCmdPort": {
/*ro, opt, object, signaling port No. of the cloud storage server*/
"@min": 1024,
"@max": 65535,
"#text": 8008
/*ro, opt, int, signaling port No. of the cloud storage server*/
},
"cloudHeartBeatPort": {
/*ro, opt, object, heartbeat port No. of the cloud storage server*/
"@min": 1024,
"@max": 65535,
"#text": 9999
/*ro, opt, int, heartbeat port No. of the cloud storage server*/
},
"cloudStorageHttpPort": {
/*ro, opt, object, HTTP port No. of the cloud storage server*/
"@min": 1024,
"@max": 65535,
"#text": 8083
/*ro, opt, int, HTTP port No. of the cloud storage server*/
},
"cloudUsername": {
/*ro, opt, object, user name of the cloud storage server*/
"@min": 0,
"@max": 32,
"#text": "username"
/*ro, opt, string, user name of the cloud storage server*/
},
"cloudPassword": {
/*ro, opt, object, user name of the cloud storage server*/
"@min": 0,
"@max": 32,
"#text": "12345"
},
"cloudPoolId": {
/*ro, opt, object, cloud storage pool ID (int format)*/
"@min": 1,
"@max": 4294967295,
/*ro, opt, float, maximum value*/
"#text": 1
/*ro, opt, int, cloud storage pool ID*/
},
"clouldProtocolVersion": {
/*ro, opt, object, protocol version of the cloud storage server*/
"@min": 0,
"@max": 32,
"#text": "V2.0"
/*ro, req, string, protocol version of the cloud storage server*/
},
"clouldAccessKey": {
/*ro, opt, object, access key of the cloud storage server*/
"@min": 0,
"@max": 64
},
"clouldSecretKey": {
/*ro, opt, object, secret key of the cloud storage server*/
/*ro, opt, object, secret key of the cloud storage server*/
"@min": 0,
"@max": 64
},
"resourceID": {
/*ro, opt, object, cloud storage pool ID (string format), dep:and,{$.PictureServerInformation.cloudStorage.clouldProtocolVersion,eq,V2.0},
desc:both resourceID and cloudPoolId can be used to configure the cloud storage pool ID. But different from cloudPoolId, the value of resourceID can be in
string format. When both resourceID and cloudPoolId are configured, cloudPoolId has priority over resourceID. If this node is not supported, you can
configure the pool ID via cloudPoolId.*/
"@min": 1,
/*ro, opt, int, the minimum length of the value*/
"@max": 256
/*ro, opt, int, the maximum length of the value*/
}
},
"pictureServerID": {
/*ro, opt, object, picture storage server ID*/
"@min": 1,
"@max": 2,
"#text": 1
/*ro, opt, int, picture storage server ID: /ISAPI/System/PictureServer*/
}
}
}
21.9.3 Get the parameters of the picture storage server

Request URL
GET /ISAPI/System/PictureServer?format=json&security=<security>&iv=<iv>
Query Parameter
security enum --
iv string --
Request Message
None
Response Message
{
/*ro, req, object, picture server information*/
"pictureServerType": "cloudStorage",
/*ro, req, enum, picture server type, subType:string, desc:"tomact", "VRB", "cloudStorage", "KMS". When the value is null, it indicates that the
servers are all closed*/
"addressingFormatType": "ipaddress",
/*ro, req, enum, address type of the picture storage server, subType:string, desc:"ipaddress" (IP address), "hostname" (domain name)*/
"hostName": "pc3-netsdk",
/*ro, opt, string, domain name of the picture storage server*/
"ipv4Address": "10.17.133.46",
"ipv6Address": "2001:A304:6101:1::E0:F726:4E58",
"portNo": 1024,
/*ro, req, int, picture storage server port, range:[1024,65535]*/
"underlyingProtocol": "http",
/*ro, opt, enum, communication protocol, subType:string, desc:“http”, “https”*/
"cloudStorage": {
/*ro, opt, object, configuration of cloud storage server parameters, dep:and,{$.PictureServerInformation.pictureServerType,eq,cloudStorage}*/
"cloudManageHttpPort": 6120,
/*ro, opt, int, HTTP port No. for central management of the cloud storage server, which can be used for downloading the URLs of pictures and
intelligent structuralization data, range:[1024,65535]*/
"cloudTransDataPort": 9001,
/*ro, opt, int, data transmission port No. of the cloud storage server, range:[1024,65535]*/
"cloudCmdPort": 6011,
/*ro, opt, int, signaling port No. of the cloud storage server, range:[1024,65535]*/
"cloudHeartBeatPort": 9999,
/*ro, opt, int, heartbeat port No. of the cloud storage server, range:[1024,65535]*/
"cloudStorageHttpPort": 8083,
/*ro, opt, int, HTTP port No. of the cloud storage server, range:[1024,65535]*/
"cloudUsername": "username",
/*ro, opt, string, user name of the cloud storage server, range:[0,32]*/
"cloudPassword": "12345",
"cloudPoolId": 1,
/*ro, opt, int, cloud storage pool ID (int format), range:[1,4294967295], desc:by default, it is 1 if there is no configured device*/
"clouldProtocolVersion": "V2.0",
/*ro, req, string, protocol version of the cloud storage server, range:[0,32]*/
"clouldAccessKey": "test",
/*ro, opt, string, access key of the cloud storage server, range:[0,64], dep:and,
"clouldSecretKey": "test",
/*ro, opt, string, secret key of the cloud storage server, range:[0,64], dep:and,
"resourceID": "test"
/*ro, opt, string, cloud storage pool ID (string format), range:[1,256], dep:and,
{$.PictureServerInformation.cloudStorage.clouldProtocolVersion,eq,V2.0}, desc:both resourceID and cloudPoolId can be used to configure the cloud storage
pool ID. But different from cloudPoolId, the value of resourceID can be in string format. When both resourceID and cloudPoolId are configured, cloudPoolId
has priority over resourceID. If this node is not supported, you can configure the pool ID via cloudPoolId.*/
}
}
}
21.10 HTTP Listening Management

21.10.1 Set the parameters of a listening host
Request URL
PUT /ISAPI/Event/notification/httpHosts/<hostID>?security=<security>&iv=<iv>
Query Parameter
hostID string --
security string --
iv string --
Request Message
<HttpHostNotification xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
test
</id>
<url>
test
</url>
<protocolType>
HTTP
</protocolType>
<parameterFormatType>
JSON
</parameterFormatType>
hostname
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
test
</ipv6Address>
<portNo>
1
</portNo>
<userName>
test
</userName>
<password>
test
</password>
<httpAuthenticationMethod>
MD5digest
</httpAuthenticationMethod>
<ANPR>

<detectionUpLoadPicturesType>
all
</detectionUpLoadPicturesType>
</ANPR>
<Extensions>

<intervalBetweenEvents>
1
</intervalBetweenEvents>
</Extensions>
<uploadImagesDataType>
true
</httpBroken>
<SubscribeEvent>

<heartbeat>
30
</heartbeat>
<eventMode>
all
</eventMode>
<EventList>

<Event>

<type>
mixedTargetDetection
</type>
<minorAlarm>
0x400,0x401,0x402,0x403
</minorAlarm>
<minorException>
0x400,0x401,0x402,0x403
</minorException>
<minorOperation>
binary
</pictureURLType>
<channels>
1,2,3,4
</channels>
</Event>
</EventList>
<channels>
1,2,3,4
</channels>
<pictureURLType>
binary
</pictureURLType>
<ChangedUploadSub>

<interval>
5
</interval>
<StatusSub>

<all>
true
</all>
<channel>
true
</channel>
<hd>
true
</hd>
<capability>
true
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
<PackingSpaceRecognition>

<upLoadPicturesType>
all
</upLoadPicturesType>
<PicturesTypes>

<picturesType>

<HttpHostNotification>

<id>
test
</id>
<url>
test
</url>
<protocolType>
HTTP
</protocolType>
JSON
hostname
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
test
</ipv6Address>
<portNo>
1
</portNo>
<userName>
test
</userName>
<password>
test
</password>
MD5digest
<ANPR>

all
</ANPR>
<Extensions>

1
</Extensions>
URL
<httpBroken>
true
</httpBroken>
<SubscribeEvent>

<heartbeat>
30
</heartbeat>
<eventMode>
all
</eventMode>
<EventList>

<Event>

<type>
0x400,0x401,0x402,0x403
</minorAlarm>
<minorException>
binary
</pictureURLType>
<channels>
1,2,3,4
</channels>
<pictureURLType>
binary
</pictureURLType>
<ChangedUploadSub>

<interval>
5
</interval>
<StatusSub>

<all>
true
</all>
<channel>
true
</channel>
<hd>
true
</hd>
<capability>
true
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
all
<PicturesTypes>

<picturesType>
backgroundImage
</picturesType>
</PicturesTypes>
</HttpHostNotificationList>
21.10.3 Set IP address of receiving server(s)

Request URL
PUT /ISAPI/Event/notification/httpHosts?security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message



<id>
test
</id>
<url>
</url>
<protocolType>
HTTP
</protocolType>
JSON
hostname
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
1
</portNo>
<userName>
</userName>
<password>
</password>
MD5digest
<ANPR>
all
</ANPR>
<Extensions>
</Extensions>
URL
<httpBroken>
</httpBroken>
<SubscribeEvent>
<heartbeat>
30
</heartbeat>
<eventMode>
all
</eventMode>
<EventList>
<Event>
<type>
mixedTargetDetection
</type>
<minorAlarm>
binary
</pictureURLType>
<channels>
1,2,3,4
</channels>
</Event>
</EventList>
<channels>
1,2,3,4
</channels>
<pictureURLType>
5
</interval>
<StatusSub>
<all>
true
</all>
<channel>
true
</channel>
<hd>
</hd>
<capability>
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
all
<PicturesTypes>

<id>
test
</id>
<url>
</url>
<protocolType>
HTTP
</protocolType>
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
test
</ipv6Address>
<portNo>
</portNo>
<userName>
</userName>
<ANPR>
</ANPR>
<Extensions>
</Extensions>
5
</interval>
<StatusSub>
<all>
</all>
<channel>
</channel>
<hd>
</hd>
<capability>
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
all
<PicturesTypes>
<picturesType>
</picturesType>
</PicturesTypes>
21.10.5 Set the parameters of a listening host

Request URL
PUT /ISAPI/Event/notification/httpHosts/<hostID>?security=<security>&iv=<iv>
Query Parameter
hostID string --
security string --
iv string --
Request Message


<id>
test
</id>
<url>
</url>
<protocolType>
HTTP
</protocolType>
JSON
hostname
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
test
</ipv6Address>
<portNo>
1
</portNo>
<userName>
</userName>
<password>
</password>
MD5digest
<ANPR>
all
</ANPR>
<Extensions>
</Extensions>
30
</heartbeat>
<eventMode>
all
</eventMode>
<EventList>
<Event>
<type>
binary
</pictureURLType>
<channels>
1,2,3,4
</channels>
<pictureURLType>
binary
</pictureURLType>
<ChangedUploadSub>
<interval>
5
</interval>
<StatusSub>
<all>
true
</all>
<channel>
true
</channel>
<hd>
</hd>
<capability>
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
all
<PicturesTypes>

<id>
test
</id>
<url>
</url>
<protocolType>
HTTP
</protocolType>
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
</portNo>
</portNo>
<userName>
</userName>
<ANPR>
</ANPR>
<Extensions>
</Extensions>
5
</interval>
<StatusSub>
<all>
</all>
<channel>
</channel>
<hd>
</hd>
<capability>
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
all
<PicturesTypes>
<picturesType>
</picturesType>
</PicturesTypes>
21.10.7 Set IP address of receiving server(s)

Request URL
PUT /ISAPI/Event/notification/httpHosts?security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message



<id>
</id>
<url>
</url>
<protocolType>
HTTP
</protocolType>
JSON
hostname
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
1
</portNo>
<userName>
</userName>
<password>
</password>
MD5digest
<ANPR>
all
</ANPR>
<Extensions>
</Extensions>
URL
<httpBroken>
</httpBroken>
<SubscribeEvent>
<heartbeat>
30
</heartbeat>
<eventMode>
all
</eventMode>
<EventList>
<Event>
<type>
mixedTargetDetection
</type>
<minorAlarm>
binary
</pictureURLType>
<channels>
1,2,3,4
</channels>
</Event>
</EventList>
<channels>
1,2,3,4
</channels>
<pictureURLType>
5
new arm period-->5
</interval>
<StatusSub>
<all>
true
</all>
<channel>
</channel>
<hd>
</hd>
<capability>
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
all
<PicturesTypes>


<id>
test
</id>
<url>
</url>
<protocolType>
HTTP
</protocolType>
<hostName>
</hostName>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
</portNo>
<userName>
</userName>
<password>
test
</password>
<ANPR>
</ANPR>
<Extensions>
</Extensions>
URL
<httpBroken>
</httpBroken>
<SubscribeEvent>
<heartbeat>
</heartbeat>
<eventMode>
</eventMode>
<EventList>
<Event>
<type>
5
</interval>
<StatusSub>
<all>
</all>
<channel>
</channel>
<hd>
</hd>
<capability>
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEvent>
all
<PicturesTypes>
<picturesType>
</picturesType>
</PicturesTypes>
21.10.9 Get the capabilities of listening hosts parameters

Request URL
GET /ISAPI/Event/notification/httpHosts/capabilities
Query Parameter
None
Request Message
None
Response Message
<HttpHostNotificationCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<hostNumber>
0
</hostNumber>
<urlLen max="10">
test
</urlLen>
<url>
test
</url>
<protocolType opt="HTTP,HTTPS,EHome">
HTTP
</protocolType>
<parameterFormatType opt="XML,querystring,JSON">
ipaddress
test
</hostName>
<ipAddress opt="ipv4,ipv6">
test
</ipAddress>
1
</portNo>
<userNameLen min="0" max="10">
1
</userNameLen>
<passwordLen min="0" max="10">
1
</passwordLen>
<httpAuthenticationMethod opt="MD5digest,none,base64">
MD5digest
<ANPR>
<detectionUpLoadPicturesType opt="test">
test
<alarmHttpPushProtocol opt="baseline,custom">
baseline
</alarmHttpPushProtocol>
</ANPR>
<HttpHostUploadCtrl>

<postDataTypes>
test
</postDataTypes>
<epoliceDataTypes>
test
</epoliceDataTypes>
<eventDataTypes>
test
</eventDataTypes>
<evidenceDataTypes>
test
</evidenceDataTypes>
<uploadInterval min="1" max="2000">
0
</uploadInterval>
<uploadTimeout min="1" max="6000">
0
</uploadTimeout>
<noPlateUploadEnabled opt="true,false">
true
</noPlateUploadEnabled>
<historyEnabled opt="true,false">
true
</historyEnabled>
<uploadTimePlan>

true
</enabled>
<timeList>
<timeList>

<timeSpan>

<timeId min="0" max="1">
0
</timeId>
<startHour min="0" max="23">
0
</startHour>
<startMinute min="0" max="59">
0
</startMinute>
<endHour min="0" max="23">
0
</endHour>
<endMinute min="0" max="59">
0
</endMinute>
</timeSpan>
</timeList>
</uploadTimePlan>
</HttpHostUploadCtrl>
<Extensions>

<intervalBetweenEvents min="0" max="10">
0
</Extensions>
<uploadImagesDataType opt="URL,binary">
URL
<httpBroken opt="true,false" def="true">
true
</httpBroken>
<SubscribeEventCap>
test
<heartbeat min="0" max="10">
1
</heartbeat>
<channelMode opt="all,list">
all
</channelMode>
<eventMode opt="all,list">
all
</eventMode>
<EventList>

<Event>
test
<type>
AccessControllerEvent
</type>
<minorAlarm opt="0x400,0x401,0x402,0x403">
0x400,0x401
</minorException>
<minorOperation opt="0x400,0x401,0x402,0x403">
0x400,0x401
</minorOperation>
<minorEvent opt="0x01,0x02,0x03,0x04">
cloudStorageURL
</pictureURLType>
</Event>
</EventList>
<pictureURLType opt="binary,localURL,cloudStorageURL,EZVIZURL" def="cloudStorageURL">
cloudStorageURL
</pictureURLType>
<ChangedUploadSub>
0
<interval>
1
</interval>
<StatusSub>
true
true
<all>
true
</all>
<channel>
</channel>
<hd>
</hd>
<capability>
</capability>
</StatusSub>
</ChangedUploadSub>
</SubscribeEventCap>
PackingSpaceRecognition. if it is not supported by the device, all pictures will be uploaded by default-->
<upLoadPicturesType opt="all,picturesTypes,notUpload" def="all">
all
<PicturesTypes size="2">

<picturesType opt="backgroundImage,plateImage">
backgroundImage
</picturesType>
</PicturesTypes>
</HttpHostNotificationCap>
21.10.10 Delete receiving server(s)

Request URL
DELETE /ISAPI/Event/notification/httpHosts
Query Parameter
None
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.10.11 Delete a HTTP listening server

Request URL
DELETE /ISAPI/Event/notification/httpHosts/<hostID>
Query Parameter
hostID string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.11 Protocol Certificate

21.11.1 Generate the signature request information of device certificate
Request URL
PUT /ISAPI/Security/serverCertificate/certSignReq?platformNo=<platformNo>&type=<type>&security=
<security>&iv=<iv>
Query Parameter
platformNo string --
type enum --
security string --
iv string --
Request Message
<CertificateReq xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
test
</id>
<SubjectDN>

<countryName>
</countryName>
<stateOrProvinceName>
</stateOrProvinceName>
<localityName>
</localityName>
<organizationName>
</organizationName>
<organizationUnitName>
</organizationUnitName>
<commonName>
</commonName>
<countyOrDistrict>
</countyOrDistrict>
<email>
</email>
</SubjectDN>
<version>
</version>
<keyAlgorithm>
</keyAlgorithm>
<passwd>
</passwd>
<RSAKeyLength>
1
</RSAKeyLength>
</CertificateReq>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.11.2 Delete signature request of device certificate

Request URL
DELETE /ISAPI/Security/serverCertificate/certSignReq?type=<type>
Query Parameter
type enum --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.11.3 Get the signature request information of device certificate

Request URL
GET /ISAPI/Security/serverCertificate/certSignReq?platformNo=<platformNo>&type=<type>&security=
<security>&iv=<iv>
Query Parameter
platformNo string --
type enum --
security string --
iv string --
Request Message
None
Response Message
<CertificateReqInfo xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
test
</id>
<SubjectDN>

<countryName>
test
</countryName>
<stateOrProvinceName>
</stateOrProvinceName>
<localityName>
test
</localityName>
<organizationName>
</organizationName>
<organizationUnitName>
</organizationUnitName>
<commonName>
</commonName>
<email>
</email>
<countyOrDistrict>
</countyOrDistrict>
</SubjectDN>
<version>
</version>
<keyAlgorithm>
</keyAlgorithm>
<passwd>
test
</passwd>
<RSAKeyLength>
</RSAKeyLength>
</CertificateReqInfo>
21.12 Upgrade Management

21.12.1 Upgrade devices
Request URL
POST /ISAPI/System/updateFirmware?type=<type>&moduleAddress=<moduleAddress>&id=<indexID>
Query Parameter
type string --
moduleAddress string --
indexID string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
statusCode statusString subStatusCode errorCode description

3 Device Error theDeviceIsOffline 0x30008007 The device is offline
3 Device Error deviceIsForwardedByTheRepeater 0x30008008 Device is forwarded by the repeater
3 Device Error lowBattery 0x30008009 Low battery
3 Device Error theSignalIsUnstable 0x3000800A The signal is unstable
21.12.2 Get the device upgrade progress

Request URL
GET /ISAPI/System/upgradeStatus?format=json
Query Parameter
None
Request Message
None
Response Message
{
"requestURL": "/ISAPI/Streaming/channels/1",
/*ro, opt, string, request URL*/
/*ro, req, string, status code*/
/*ro, req, string, status description*/
/*ro, req, string, sub status code*/
"errorCode": 1,
/*ro, opt, int, This field is required when the value of statusCode is not 1, and it corresponds to subStatusCode.*/
"errorMsg": "ok",
/*ro, opt, string, This field is required when the value of statusCode is not 1. Detailed error description of a certain parameter can be provided*/
"upgrading": "TRUE",
/*ro, opt, string, whether the device is upgrading: “TRUE" (upgrading), "FALSE" (not in upgrading)*/
"percent": 22,
/*ro, opt, int, upgrade progress (% complete)*/
"idList": [
/*ro, opt, array, ID list, subType:object*/
{
"id": "test",
/*ro, req, string, analysis unit ID*/
"percent": 22,
/*ro, opt, int, upgrade progress (% complete)*/
"status": "test"
/*ro, opt, string, "backingUp" (backing up upgrade)*/
}
]
}
21.12.3 Get the capabilities of peripheral module upgrade

Request URL
GET /ISAPI/System/AcsUpdate/capabilities
Query Parameter
None
Request Message
None
Response Message
<AcsUpdate xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<type
opt="cardReader,FPModule,securityModule,extendModule,channelController,IRModule,lampModule,elevatorController,FPAlgorithmProgram,uboot,keypad,wirelessRecv,w
iredZone,sirenIndoor,sirenOutdoor,sirenAudio,repeater,bluetoothModule,single,wallSwitch,smartPlug,detector,transmitter,remoteCtrl,subModule,dispModule,netRe
ader,lockControlBoard,networkZoneModule,userInterfaceBoard,subPermissionController,electricLock,heatingModule,RS485Module,QRCodeModule">
cardReader
</type>
<cardReaderNo min="1" max="10" opt="1,4">
1
</cardReaderNo>
<FPModuleNo min="1" max="10">
1
</FPModuleNo>
<securityModuleNo min="1" max="10">
1
</securityModuleNo>
<extendModuleNo min="1" max="10">
1
</IRModuleNo>
<lampModuleNo min="1" max="10">
1
</lampModuleNo>
<elevatorControllerNo min="1" max="10">
1
</elevatorControllerNo>
<FPAlgorithmProgramNo min="1" max="10">
1
</FPAlgorithmProgramNo>
<faceModuleNo min="1" max="10">
1
</faceModuleNo>
<touchScreenModuleNo min="1" max="10">
1
</touchScreenModuleNo>
<temperatureModuleNo min="1" max="10">
1
</keypadAddress>
<wirelessRecvAddress opt="1,3,5">
1
</wirelessRecvAddress>
<wiredZoneAddress opt="1,3,5">
1
</wiredZoneAddress>
<sirenIndoorNo opt="1,3,5">
1
</sirenIndoorNo>
<sirenOutdoorNo opt="1,3,5">
1
</sirenOutdoorNo>
<repeaterNo opt="1,3,5">
1
</repeaterNo>
<subModuleNo opt="1,3,5">
1
</subModuleNo>
<dispModuleNo opt="1,3,5">
1
</dispModuleNo>
<single opt="1,3,5">
1
</single>
<wallSwitch opt="1,3,5">
1
</wallSwitch>
<smartPlug opt="1,3,5">
1
</smartPlug>
<zoneNo opt="1,3,5">
1
</zoneNo>
<transmitterNo opt="1,3,5">
1
</transmitterNo>
<remoteCtrlNo opt="1,3,5">
1
</remoteCtrlNo>
<netReaderNo min="1" max="10">
1
</netReaderNo>
<lockControlBoardLNo opt="1,2,3,4,5,6,7,8">
1
</lockControlBoardLNo>
<lockControlBoardRNo opt="1,2,3,4,5,6,7,8">
1
</lockControlBoardRNo>
<networkZoneModuleNo opt="1,3,5">
1
</networkZoneModuleNo>
<userInterfaceBoardNo opt="0,1">
0
</userInterfaceBoardNo>
<electricLockNo opt="1,3,5">
1
</electricLockNo>
<heatingModuleNo opt="1,3,5">
1
</heatingModuleNo>
<RS485ModuleNo opt="1,3,5">
1
</RS485ModuleNo>
<sirenAudioNo opt="1,3,5">
1
</sirenAudioNo>
<QRCodeModuleNo min="1" max="10">
1
</QRCodeModuleNo>
</AcsUpdate>
21.12.4 Get the device upgrading status and progress

Request URL
GET /ISAPI/System/upgradeStatus?type=<Type>
Query Parameter
Type string --
Request Message
None
Response Message
<upgradeStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<upgrading>
true
</upgrading>
<percent>
1
</percent>
</upgradeStatus>
21.13 Video Image Settings

21.13.1 Get image standard parameters of a specific channel
Request URL
GET /ISAPI/Image/channels/<channelID>/powerLineFrequency
Query Parameter
channelID string --
Request Message
None
Response Message
<powerLineFrequency xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<powerLineFrequencyMode>
50hz
</powerLineFrequencyMode>
</powerLineFrequency>
21.13.2 Set the video signal standard for a specified channel

Request URL
PUT /ISAPI/Image/channels/<channelID>/powerLineFrequency
Query Parameter
channelID string --
Request Message
<powerLineFrequency xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<powerLineFrequencyMode>
50hz
</powerLineFrequencyMode>
</powerLineFrequency>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.14 Image Adjustment

21.14.1 Get the image adjustment parameters in auto mode of a specific channel
Request URL
GET /ISAPI/Image/channels/<channelID>/color
Query Parameter
channelID string --
Request Message
None
Response Message
<Color xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<brightnessLevel>
24
</brightnessLevel>
<contrastLevel>
22
</contrastLevel>
<saturationLevel>
33
</saturationLevel>
<hueLevel>
55
</hueLevel>
<grayScale>
<grayScaleMode>
outdoor
</grayScaleMode>
</grayScale>
<nightMode>
true
</nightMode>
<redBrightnessLevel>
0
</redBrightnessLevel>
<sharpnessLevel>
0
</sharpnessLevel>
</Color>
21.14.2 Set the image adjustment parameters in auto mode of a specific channel
Request URL
PUT /ISAPI/Image/channels/<channelID>/color
Query Parameter
channelID string --
Request Message
<Color xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<brightnessLevel>
24
</brightnessLevel>
<contrastLevel>
22
</contrastLevel>
<saturationLevel>
33
</saturationLevel>
<hueLevel>
55
</hueLevel>
<grayScale>

<grayScaleMode>
outdoor
</grayScaleMode>
</grayScale>
<nightMode>
0
</redBrightnessLevel>
<sharpnessLevel>
0
</sharpnessLevel>
</Color>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.14.3 Get the sharpness control parameters of a specific channel

Request URL
GET /ISAPI/Image/channels/<channelID>/sharpness
Query Parameter
channelID string --
Request Message
None
Response Message
<Sharpness xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<SharpnessMode>
manual
</SharpnessMode>
<SharpnessLevel>
1
</SharpnessLevel>
</Sharpness>
21.14.4 Set the sharpness control parameters of a specific channel

Request URL
PUT /ISAPI/Image/channels/<channelID>/sharpness
Query Parameter
channelID string --
Request Message
<Sharpness xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<SharpnessMode>
manual
</SharpnessMode>
<SharpnessLevel>
1
</SharpnessLevel>
</Sharpness>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.14.5 Restore the image parameters of a specific channel to default settings

Request URL
PUT /ISAPI/Image/channels/<channelID>/restore
Query Parameter
channelID string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.14.6 Get the image mode parameters of all channels

Request URL
GET /ISAPI/Image/channels/imageModes
Query Parameter
None
Request Message
None
Response Message
<ImageModeList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<ImageMode>

<type>
standard
</type>
<recommendation>

<brightnessLevel>
1
</brightnessLevel>
<contrastLevel>
1
</contrastLevel>
<sharpnessLevel>
1
</sharpnessLevel>
<saturationLevel>
1
</saturationLevel>
<hueLevel>
1
</hueLevel>
<deNoiseLevel>
1
</deNoiseLevel>
</recommendation>
</ImageMode>
</ImageModeList>
21.14.7 Get the configuration parameters of all image modes of a specific channel
Request URL
GET /ISAPI/Image/channels/imageModes/<channelID>
Query Parameter
channelID string --
Request Message
None
Response Message
<ImageMode xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<type>
standard
</type>
<recommendation>

<brightnessLevel>
1
</brightnessLevel>
<contrastLevel>
</contrastLevel>
<sharpnessLevel>
</sharpnessLevel>
<saturationLevel>
</saturationLevel>
<hueLevel>
</hueLevel>
<deNoiseLevel>
</deNoiseLevel>
</recommendation>
</ImageMode>
21.15 Image Light Supplement

21.15.1 Set supplement light parameters of a specific channel
Request URL
PUT /ISAPI/Image/channels/<channelID>/supplementLight
Query Parameter
channelID string --
Request Message
<SupplementLight xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<mode>
auto
</mode>
<Schedule>

<TimeRange>

<beginTime>
00:08:00+08:00
</beginTime>
<endTime>
00:18:00+08:00
</endTime>
</TimeRange>
</Schedule>
<brightnessLimit>
80
</brightnessLimit>
<supplementLightMode>
mixed
</supplementLightMode>
<irLightBrightness>
<irLightBrightness>
80
</irLightBrightness>
<mixedLightBrightnessRegulatMode>
auto
</mixedLightBrightnessRegulatMode>
<highIrLightBrightness>
80
</highIrLightBrightness>
<highWhiteLightBrightness>
80
</whiteLightBrightness>
<WhiteLightModeCfg>

80
80
80
</WhiteLightModeCfg>
<irLightbrightnessLimit>
80
</irLightbrightnessLimit>
<whiteLightbrightnessLimit>
80
</whiteLightbrightnessLimit>
<EventIntelligenceModeCfg>

<brightnessRegulatMode>
auto
</brightnessRegulatMode>
80
<irLightBrightness>
80
<BrightnessCtrlList>

<BrightnessCtrl>

<lightType>
highWhite
</lightType>
<brightness>
80
</brightness>
</BrightnessCtrl>
</BrightnessCtrlList>
</EventIntelligenceModeCfg>
<MultiAzimuthMixedModeCfg>

<LightCtrlList>
<LightCtrl>

<azimuthType>
left
</azimuthType>
<lightType>
</lightType>
<brightness>
</brightness>
</LightCtrl>
</LightCtrlList>
<regulatSensitivityType>
fast
</regulatSensitivityType>
</MultiAzimuthMixedModeCfg>
<MultiAzimuthWhiteLightCfg>

<LightCtrlList>
<LightCtrl>

<azimuthType>
</azimuthType>
<lightType>
</lightType>
<brightness>
</brightness>
</LightCtrl>
</LightCtrlList>
fast
</MultiAzimuthWhiteLightCfg>
<MultiAzimuthIrLightCfg>

<LightCtrlList>
<LightCtrl>

<azimuthType>
</azimuthType>
<lightType>
highIrLight
</lightType>
<brightness>
</brightness>
</LightCtrl>
</LightCtrlList>
</MultiAzimuthIrLightCfg>
<PanoramicWhiteLightCfg>

<LightCtrlList>
<LightCtrl>

<lightID>
1
</lightID>
<brightness>
</brightness>
</LightCtrl>
</LightCtrlList>
</PanoramicWhiteLightCfg>
<PanoramicIrLightCfg>

<LightCtrlList>
<LightCtrl>

<lightID>
1
</lightID>
<brightness>
</brightness>
</LightCtrl>
</LightCtrlList>
</PanoramicIrLightCfg>
<whiteLightEnhanceEnabled>
</whiteLightEnhanceEnabled>
<LightManualCtrlList>

<LightCtrl>

<lightType>
highIrLight
</lightType>
</lightType>
<brightness>
</brightness>
</LightCtrl>
</LightManualCtrlList>
</SupplementLight>
Response Message


<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.15.2 Get supplement light parameters of a specific channel

Request URL
GET /ISAPI/Image/channels/<channelID>/supplementLight
Query Parameter
channelID string --
Request Message
None
Response Message

<mode>
auto
</mode>
<Schedule>
<TimeRange>
<beginTime>
00:08:00+08:00
</beginTime>
<endTime>
00:18:00+08:00
</endTime>
</TimeRange>
</Schedule>
<brightnessLimit>
80
</brightnessLimit>
<supplementLightMode>
mixed
<irLightBrightness>
80
<mixedLightBrightnessRegulatMode>
auto
<highIrLightBrightness>
80
together with node <irLightBrightness>-->80
80
<lowIrLightBrightness>
80
80
80
<WhiteLightModeCfg>
80
80
80
<irLightbrightnessLimit>
80
<whiteLightbrightnessLimit>
80
auto
80
<irLightBrightness>
80
<BrightnessCtrlList>
<BrightnessCtrl>
<lightType>
highWhite
</lightType>
<brightness>
80
</brightness>
</BrightnessCtrl>
<LightCtrlList>
<LightCtrl>
<azimuthType>
left
</azimuthType>
<lightType>
</lightType>
<brightness>
80
</brightness>
</LightCtrl>
</LightCtrlList>
fast
<LightCtrlList>
<LightCtrl>
<azimuthType>
<azimuthType>
</azimuthType>
<lightType>
</lightType>
<brightness>
80
</brightness>
</LightCtrl>
</LightCtrlList>
fast
<LightCtrlList>
<LightCtrl>
<azimuthType>
</azimuthType>
<lightType>
highIrLight
</lightType>
<brightness>
80
</brightness>
</LightCtrl>
</LightCtrlList>
<LightCtrlList>
<LightCtrl>
<lightID>
1
</lightID>
<brightness>
80
</brightness>
</LightCtrl>
</LightCtrlList>
<LightCtrlList>
<LightCtrl>
<lightID>
1
</lightID>
<brightness>
80
</brightness>
</LightCtrl>
</LightCtrlList>
<whiteLightEnhanceEnabled>
<LightManualCtrlList>

<LightCtrl>
<lightType>
highIrLight
</lightType>
<brightness>
80
</brightness>
</LightCtrl>
</SupplementLight>
21.15.3 Get the configuration capability of the supplement light parameters of a specific
21.15.3 Get the configuration capability of the supplement light parameters of a specific
channel
Request URL
GET /ISAPI/Image/channels/<channelID>/supplementLight/capabilities
Query Parameter
channelID string --
Request Message
None
Response Message

<mode opt="schedule,off,on,auto,manual">
auto
</mode>
<Schedule>
<TimeRange>
<beginTime>
00:08:00+08:00
</beginTime>
<endTime>
00:18:00+08:00
</endTime>
</TimeRange>
</Schedule>
<brightnessLimit min="0" max="100">
80
</brightnessLimit>
<supplementLightMode
opt="mixed,whiteLight,colorVuWhiteLight,irLight,dualLight,close,eventIntelligence,multiAzimuthMixed,multiAzimuthWhiteLight,multiAzimuthIrLight,panoramicWhit
eLight,panoramicIrLight">
mixed
<irLightBrightness min="0" max="100">
80
<mixedLightBrightnessRegulatMode opt="manual,auto">
auto
<mixedModeSupportType opt="irLight,whiteLight">
irLight
</mixedModeSupportType>
<highIrLightBrightness min="0" max="100">
80
<highWhiteLightBrightness min="0" max="100">
80
<WhiteLightModeCfg>
<highWhiteLightBrightness min="0" max="100">
80
80
80
<isAutoModeBrightnessCfg>
</isAutoModeBrightnessCfg>
<irLightbrightnessLimit min="0" max="100">
80
<whiteLightbrightnessLimit min="0" max="100">
80
<isNotSupportMixedWhiteLight>
</isNotSupportMixedWhiteLight>
<brightnessRegulatMode opt="manual,auto">
auto
80
<irLightBrightness min="0" max="100">
80
<BrightnessCtrlList size="4">

<BrightnessCtrl>
<lightType opt="highWhite,lowWhite,highIrLight,lowIrLight">
highWhite
</lightType>
<brightness min="0" max="100">
80
</brightness>
</BrightnessCtrl>
<LightCtrlList size="12">
<LightCtrl>
<azimuthType opt="left,right">
left
</azimuthType>
<lightType opt="highWhite,midWhite,lowWhite,highIrLight,midIrLight,lowIrLight">
</lightType>
</brightness>
</LightCtrl>
</LightCtrlList>
<regulatSensitivityType opt="fast,medium,slow">
fast
<LightCtrl>
</azimuthType>
<lightType opt="highWhite,midWhite,lowWhite,white">
</lightType>
</brightness>
</LightCtrl>
</LightCtrlList>
<regulatSensitivityType opt="fast,medium,slow">
fast
<LightCtrl>
</azimuthType>
<lightType opt="highIrLight,midIrLight,lowIrLight,irLight">
highIrLight
</lightType>
</brightness>
</LightCtrl>
</LightCtrlList>
<LightCtrl>
<lightID min="1" max="4">
1
</lightID>
</brightness>
</LightCtrl>
</LightCtrlList>
<LightCtrl>
<lightID min="1" max="4">
</lightID>
</brightness>
</LightCtrl>
</LightCtrlList>
<whiteLightEnhanceEnabled opt="true,false" def="false">
true
<LightManualCtrlList size="12">

<LightCtrl>
<lightType opt="highIrLight,midIrLight,lowIrLight,irLight,highWhite,midWhite,lowWhite,white">
</lightType>
</brightness>
</LightCtrl>
</SupplementLight>
21.16 Face Picture Library Management

21.16.1 Get the information, including library ID, library type, name, and custom
information, of all face picture libraries
Request URL
GET /ISAPI/Intelligent/FDLib?security=<security>&iv=<iv>&identityKey=<identityKey>
Query Parameter
security string --
iv string --
identityKey string --
Request Message
None
Response Message
<FDLibBaseCfgList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<FDLibBaseCfg>

<id>
1
</id>
<FDID>
test
</FDID>
<name>
faceLib1
</name>
<thresholdValue>
50
</thresholdValue>
<customInfo>
test
</customInfo>
<customFaceLibID>
test
</customFaceLibID>
<faceLibType>
ordinary
</faceLibType>
<autoUpdata>
</autoUpdata>
<qualityThreshold>
50
</qualityThreshold>
<importFDThreshold>
40
</importFDThreshold>
<Age>
<judgementCycleType>
day
</judgementCycleType>
<statisticalCycleType>
month
</statisticalCycleType>
<statisticalCycle>
1
</statisticalCycle>
<minFMCount>
1
</minFMCount>
<FMCountEnabled>
</FMCountEnabled>
<FMCount>
1
</FMCount>
<backgoundPicThreshold>
90
</backgoundPicThreshold>
<judgementCycle>
30
</judgementCycle>
</Age>
<FaceCounting>
<enabled>
</enabled>
<uploadType>
noUpload
</uploadType>
</FaceCounting>
<faceMonitor>
</faceMonitor>
<monitorFaceNum>
</monitorFaceNum>
<customNoConfig>
</customNoConfig>
<uploadID>
test
</uploadID>
</FDLibBaseCfg>
</FDLibBaseCfgList>
21.16.2 Set the face picture library parameters

Request URL
PUT /ISAPI/Intelligent/FDLib?security=<security>&iv=<iv>&identityKey=<identityKey>
Query Parameter
security string --
iv string --
identityKey string --
Request Message
<FDLibBaseCfgList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<FDLibBaseCfg>

<id>
1
</id>
<FDID>
test
</FDID>
<name>
faceLib1
</name>
<thresholdValue>
50
</thresholdValue>
<customInfo>
test
</customInfo>
<customFaceLibID>
test
</customFaceLibID>
<faceLibType>
allowable
</faceLibType>
<autoUpdata>
</autoUpdata>
<qualityThreshold>
50
</qualityThreshold>
<importFDThreshold>
40
<Age>

<judgementCycleType>
day
<statisticalCycleType>
month
<statisticalCycle>
1
</statisticalCycle>
<minFMCount>
1
</minFMCount>
<FMCountEnabled>
</FMCountEnabled>
<FMCount>
1
</FMCount>
<backgoundPicThreshold>
90
<judgementCycle>
30
</judgementCycle>
</Age>
<FaceCounting>

<enabled>
true
</enabled>
<uploadType>
noUpload
</uploadType>
</FaceCounting>
<faceMonitor>
</faceMonitor>
<monitorFaceNum>
</monitorFaceNum>
<customNoConfig>
</customNoConfig>
<uploadID>
test
</uploadID>
</FDLibBaseCfg>
</FDLibBaseCfgList>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.16.3 Edit a face record in a specific face picture library

Request URL
PUT /ISAPI/Intelligent/FDLib/FDSearch?format=json&FDID=<FDID>&FPID=<FPID>&faceLibType=<faceLibType>
Query Parameter
FDID string --
FPID string --
faceLibType string --
Request Message
{
"faceURL": "test",
/*opt, string, face picture URL, range:[0,256]*/
"name": "张三",
/*req, string, name of person in the face picture, range:[0,96]*/
"gender": "male",
/*opt, enum, gender of person in the face picture, subType:string, desc:"male", "female", "unknown"*/
"bornTime": "1970-01-01+08:00",
/*req, date, birthday of person in the face picture, ISO8601 time format, the maximum size is 20 bytes*/
"city": "130100",
/*opt, string, city code of birth for the person in the face picture, the maximum size is 32 bytes*/
"certificateType": "officerID",
/*opt, enum, certificate type, subType:string*/
"certificateNumber": "test",
/*opt, string, certificate No., the maximum size is 32 bytes*/
"caseInfo": "test",
/*opt, string, remarks, range:[0,192], desc:case information,the maximum size is 192 bytes,it is valid when faceLibType is blackFD*/
"tag": "aa,bb,cc,dd",
/*opt, string, custom tag, range:[0,195], desc:up to 4 tags, which are separated by commas. It is valid when faceLibType is blackFD*/
"address": "test",
/*opt, string, person address, range:[0,192], desc:person address,the maximum size is 192 bytes,it is valid when faceLibType is staticFD.*/
"customInfo": "test",
/*opt, string, custom information, range:[0,192], desc:custom information,the maximum size is 192 bytes,it is valid when faceLibType is staticFD.*/
"modelData": "test",
/*opt, string, target modeling data, desc:during the process of transmission, the non-modeling binary data will be encrypted with Base64 method*/
"rowKey": "test",
/*opt, string, main key of face picture library, range:[0,64], desc:searching by rowKey can be more efficient*/
"transfer": true,
/*opt, bool, whether to enable transfer, desc:whether to enable transfer*/
"PicFeaturePoints": [
/*opt, array, feature points to be applied., subType:object, desc:If the device only supports three types of feature points, when the platform applies
more than three types of feature points, the device will not return error information*/
{
"featurePointType": "face",
/*req, enum, feature point type, subType:string, desc:"face", "leftEye" (left eye), "rightEye" (right eye), "leftMouthCorner" (left corner of
mouth), "rightMouthCorner" (right corner of mouth), "nose”*/
"coordinatePoint": {
/*opt, object, region, desc:object,coordinates of the feature point*/
"x": 1,
/*req, int, X-coordinate, range:[0,1000], desc:normalized X-coordinate which is between 0 and 1000*/
"y": 1,
/*req, int, Y-coordinate, range:[0,1000], desc:normalized Y-coordinate which is between 0 and 1000*/
"width": 1,
/*opt, int, width, range:[0,1000], desc:width which is between 0 and 1000. This node is required when featurePointType is "face"*/
"height": 1
/*opt, int, height, range:[0,1000], desc:height which is between 0 and 1000. This node is required when featurePointType is "face"*/
}
}
],
"faceType": "normalFace",
/*opt, enum, face picture type, subType:string*/
"saveFacePic": true,
/*opt, bool, whether to save face pictures*/
"leaderPermission": [1, 2, 3, 4]
/*opt, array, subType:int, range:[1,4]*/
}
Response Message
{
"statusCode": 1,
/*ro, opt, string, status description, range:[1,64], desc:"ok" (succeeded). It is required when an error occurred*/
"errorCode": 1,
/*ro, req, int, error code, desc:when the value of statusCode is not 1, it corresponds to subStatusCode*/
"errorMsg": "ok"
/*ro, req, string, error details, desc:this node is required when the value of statusCode is not 1*/
}
21.16.4 Get face picture library capability

Request URL
GET /ISAPI/Intelligent/FDLib/capabilities
Query Parameter
None
Request Message
None
Response Message
<FDLibCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<CreateFDLibList size="15">

<CreateFDLib>
<id max="15" min="1">
10
</id>
<name max="64" min="1">
64
</name>
<thresholdValue max="100" min="0" def="60">
50
</thresholdValue>
<customInfo max="128" min="1">
128
</customInfo>
<faceDataMax max="150000" min="1">
30000
</faceDataMax>
<customFaceLibID max="64" min="1">
</customFaceLibID>
<PersonInfoExtendList size="128">

<PersonInfoExtend>
<id max="15000" min="1">
</id>
<enable opt="true,false">
true
</enable>
</name>
<value max="256" min="1">
</value>
</PersonInfoExtend>
</PersonInfoExtendList>
<indentityKey max="64" min="0">
</indentityKey>
<autoUpdata opt="true,false">
</autoUpdata>
<qualityThreshold max="100" min="0">
</qualityThreshold>
<importFDThreshold max="100" min="0">
<Age>
<judgementCycleType opt="day,week,month,duration">
month
<statisticalCycleType opt="day,week,month">
month
<statisticalCycle max="99999" min="0">
</statisticalCycle>
<minFMCount max="99999" min="0">
</minFMCount>
<FMCountEnabled opt="true,false">
</FMCountEnabled>
<FMCount max="99999" min="0">
</FMCount>
<backgoundPicThreshold min="1" max="100">
<judgementCycle max="365" min="1">
30
</judgementCycle>
</Age>
<FaceCounting>
</enabled>
<uploadType opt="out_repetition,noUpload">
<uploadType opt="out_repetition,noUpload">
noUpload
</uploadType>
</FaceCounting>
<strangerLibNum max="1" min="2">
</strangerLibNum>
<faceLibType opt="privacyMask">
ordinary
</faceLibType>
</CreateFDLib>
</CreateFDLibList>
<FaceAppendData>
<bornTime>
1970-01-01+08:00
</bornTime>
</name>
<sex opt="male,female">
male
</sex>
<province>
01
</province>
<city>
01
</city>
<certificateType opt="officerID,ID,passportID,other">
officerID
</certificateType>
<certificateNumber max="32" min="1">
32
</certificateNumber>
<PersonInfoExtend>
<id max="15000" min="1">
</id>
</enable>
</name>
</value>
</PersonInfoExtend>
<isSupportPhoneNumber>
</isSupportPhoneNumber>
<isSupportImagesURLImport>
</isSupportImagesURLImport>
<customHumanID max="128" min="1">
</customHumanID>
<faceDescribe max="128" min="1">
</faceDescribe>
<RegionCoordinatesList size="4">
<RegionCoordinates>
<positionX min="0" max="1000">
1
</positionX>
<positionY min="0" max="1000">
1
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
<IMSIList size="5">
<IMSI min="1" max="15">
123456789012345
</IMSI>
</IMSIList>
<plateNo min="0" max="32">
</plateNo>
</FaceAppendData>
<FDSearchDescription>
<searchID max="63" min="1">
63
</searchID>
<searchResultPosition>
</searchResultPosition>
<maxResults>
30
</maxResults>
<FDID>
1
</FDID>
<startTime>
1970-01-01T00:00:00+08:00
</startTime>
<endTime>
1970-01-01T00:00:00+08:00
</endTime>
64
</name>
male
</sex>
<province>
01
</province>
<city>
01
</city>
<certificateType opt="officerID,ID,passportID,other">
officerID
</certificateType>
<certificateNumber max="32" min="1">
32
</certificateNumber>
<FaceModeCap>
<FaceMode>
<similarity max="100.0" min="0.0">
50.0
</similarity>
</FaceMode>
<maxResultNum>
30
</maxResultNum>
</FaceModeCap>
<modelStatus opt="modeling,unmodeled,modelingFailed">
modeling
</modelStatus>
<modelingStatus opt="success,failed,none">
success
</modelingStatus>
<customFaceLibID max="64" min="0">
</customFaceLibID>
<indentityKey max="64" min="0">
64
</indentityKey>
<occurrences max="30" min="1">
30
</occurrences>
<occurrencesSearchType opt="greaterThanOrEqual,lessThan,equal">
greaterThanOrEqual
</occurrencesSearchType>
<faceScore min="-1" max="100">
-1
</faceScore>
<isSupportFDIDList>
</isSupportFDIDList>
<FaceScoreRange>
<min min="0" max="100">
1
</min>
<max min="0" max="100">
</max>
</FaceScoreRange>
<pictureStatus opt="normal,abnormal">
</pictureStatus>
<sortord opt="similarity,time,contrastSuccessTime,count">
count
</sortord>
<order opt="DESC,ASC">
</order>
<importStartTime>
1970-01-01T00:00:00+08:00
</importStartTime>
<importEndTime>
1970-01-01T00:00:00+08:00
</importEndTime>
</importEndTime>
<IMSIList size="5">
<IMSIItem>
</IMSI>
<count min="1">
10
</count>
<lastFMTime>
1970-01-01T00:00:00+08:00
</lastFMTime>
</IMSIItem>
</IMSIList>
<lastFMTime>
1970-01-01T00:00:00+08:00
</lastFMTime>
<faceContrastSuccessStartTime>
1970-01-01T00:00:00+08:00
</faceContrastSuccessStartTime>
<faceContrastSuccessEndTime>
1970-01-01T00:00:00+08:00
</faceContrastSuccessEndTime>
</FDSearchDescription>
<isSuportAnalysisFace>
</isSuportAnalysisFace>
<isSuportFDLibImpEmp opt="true,false">
</isSuportFDLibImpEmp>
<isSuportFCSearch opt="true,false">
true
</isSuportFCSearch>
<FDLibType opt="faceContrast,blacklistFaceContrast,whitelistFaceContrast">
faceContrast
</FDLibType>
<isSupportFDLibEachImport>
</isSupportFDLibEachImport>
<FCSearchDescription>
63
</searchID>
<maxResults>
</maxResults>
<snapStartTime>
1970-01-01T00:00:00+08:00
</snapStartTime>
<snapEndTime>
1970-01-01T00:00:00+08:00
</snapEndTime>
<faceMatchInfoEnable opt="true,false">
</faceMatchInfoEnable>
<monitorName max="1" min="2">
</monitorName>
50.0
</similarity>
<eventType opt="unlimit,faceContrast,whiteFaceContrast,faceCapture,faceContrastFailure">
unlimit
</eventType>
<FaceModeCap>
<FaceMode>
50.0
</similarity>
</FaceMode>
<maxResultNum>
30
</maxResultNum>
</FaceModeCap>
<PictureSearchCap>
<maxSearchPictureNum max="1" min="1">
</maxSearchPictureNum>
</PictureSearchCap>
<isSupportMultiChannelSearch>
</isSupportMultiChannelSearch>
<isSupportTotalSearchResult>
</isSupportTotalSearchResult>
<thermometryUnit opt="celsius,fahrenheit,kelvin">
celsius
</thermometryUnit>
<currTemperature min="-20.0" max="150.0℃">
-20.0
</currTemperature>
<temperatureCondition opt="normal,abnormal,all,above">
normal
</temperatureCondition>
<temperatureValue>
37.2
</temperatureValue>
<IMSIList size="5">
</IMSI>
</IMSIList>
</FCSearchDescription>
<isSupportFDSearchDataPackage>
true
</isSupportFDSearchDataPackage>
<isSupportFCSearchDataPackage>
true
</isSupportFCSearchDataPackage>
<maxFCSearchDataPackageNum>
50
</maxFCSearchDataPackageNum>
<isSupportFDExecuteControl>
true
</isSupportFDExecuteControl>
<isSupportManualModeling>
</isSupportManualModeling>
<isSupportSingleManualModeling>
</isSupportSingleManualModeling>
<isSupportRangeManualModeling>
</isSupportRangeManualModeling>
<isSupportSingleManualModelingSearch>
</isSupportSingleManualModelingSearch>
<isSupportRangeManualModelingSearch>
</isSupportRangeManualModelingSearch>
<isSupportModelingStatusSearch>
</isSupportModelingStatusSearch>
<Reboot>
<thresholdValue>
</thresholdValue>
<delFaceLib>
</delFaceLib>
</Reboot>
<isSupportCoverImportpictures>
</isSupportCoverImportpictures>
<isSupportCoverImportFaceLib>
</isSupportCoverImportFaceLib>
<isSupportConcurrentImportpictures>
</isSupportConcurrentImportpictures>
<isSupportSurplusCapacity>
</isSupportSurplusCapacity>
<isSupportFDlibProgress>
</isSupportFDlibProgress>
<isSupportFDlibPhotoWall>
</isSupportFDlibPhotoWall>
<isSupportFDCoverInfo>
</isSupportFDCoverInfo>
<isSupportStandardSearch>
</isSupportStandardSearch>
<isSupportFaceDataExport>
</isSupportFaceDataExport>
<isSupportNewlyPictureUpload>
</isSupportNewlyPictureUpload>
<isSupportFCSearchNormal>
</isSupportFCSearchNormal>
<FDLibEachImportCap>
<isSupportImportLib>
<isSupportImportLib>
</isSupportImportLib>
<isSupportImportLibPicture>
</isSupportImportLibPicture>
</FDLibEachImportCap>
<isSupportPrompt>
</isSupportPrompt>
<isSupportCustomHumanID>
</isSupportCustomHumanID>
<isSupportCustomFaceLibID>
</isSupportCustomFaceLibID>
<isSupportFCSearchAttendancePackage>
</isSupportFCSearchAttendancePackage>
<isSupportFCSearchJsonFormat>
</isSupportFCSearchJsonFormat>
<isSupportFCSearchDataPackageJsonFormat>
</isSupportFCSearchDataPackageJsonFormat>
<isSupportFDCapacity>
</isSupportFDCapacity>
<SupportUploadPictureType opt="binary,url">
binary
</SupportUploadPictureType>
<isSupportNoSaveUploadPicture>
</isSupportNoSaveUploadPicture>
<isSupportUploadModeling>
</isSupportUploadModeling>
<SupportUploadPictureUrlType opt="ipAddress,domain">
ipAddress
</SupportUploadPictureUrlType>
<isSptFDLibBatchFileManage>
</isSptFDLibBatchFileManage>
<importImageSize max="300" min="1">
30
</importImageSize>
<isSupportUpdateHumanID>
</isSupportUpdateHumanID>
<FDModelingStatusSearchDescription>
searchIDtest
</searchID>
30
<maxResults>
</maxResults>
<FDIDList>

</FDIDList>
<taskID max="64" min="1">
</taskID>
</FDModelingStatusSearchDescription>
<StrangerLibFaceAppendData>
<PersonInfoExtend>
<id max="15000" min="1">
</id>
</enable>
</name>
</value>
</PersonInfoExtend>
</StrangerLibFaceAppendData>
<StrangerLibFDSearchDescription>
<FDID>
1
</FDID>
<PersonInfoExtend>
<id max="15000" min="1">
</id>
</enable>
</name>
</value>
</PersonInfoExtend>
<occurrences max="30" min="1">
</occurrences>
<occurrencesSearchType opt="greaterThanOrEqual,lessThan,equal">
greaterThanOrEqual
</occurrencesSearchType>
</StrangerLibFDSearchDescription>
<isSupportOccurrencesData>
</isSupportOccurrencesData>
<isSupportCopyFaceRecord>
</isSupportCopyFaceRecord>
<isSupportConferenceSmartCheck>
</isSupportConferenceSmartCheck>
<isSupportControlSmartCheck>
</isSupportControlSmartCheck>
<isSupportSmartCheckStatus>
</isSupportSmartCheckStatus>
<isSupportSmartClockIn>
</isSupportSmartClockIn>
<isSupportControlSmartClockIn>
</isSupportControlSmartClockIn>
<isSupportSmartClockInStatus>
</isSupportSmartClockInStatus>
<isSupportSmartClockInTemplate>
</isSupportSmartClockInTemplate>
<isSupportFaceLibFormat>
</isSupportFaceLibFormat>
<isSupportSurplusCapacityALL>
</isSupportSurplusCapacityALL>
<importImageSize min="1" max="300">
10
</importImageSize>
<AsyncImportCap>
<singleFileMaxFaceNum max="100">
100
</singleFileMaxFaceNum>
<singleFileMaxSize max="100">
100
</singleFileMaxSize>
</AsyncImportCap>
<isSupportAsyncImportData>
</isSupportAsyncImportData>
<isSupportTaskStatusSearch>
</isSupportTaskStatusSearch>
<SyncDeletePicNum max="10">
1
</SyncDeletePicNum>
<isSupportPICCertification>
</isSupportPICCertification>
<deleteOriginalPicEnabled opt="true,false">
</deleteOriginalPicEnabled>
<isSupportFaceScore>
</isSupportFaceScore>
<ImportDetails>
<checkCode min="0" max="16">
1
</checkCode>
<concurrentRequest>
</concurrentRequest>
<chunkSize min="1024" max="2048">
1
</chunkSize>
</ImportDetails>
<ExportDetails>
<checkCode min="0" max="16">
</checkCode>
<GUID min="1" max="36">
</GUID>
<concurrentRequest>
</concurrentRequest>
</ExportDetails>
</FDLibCap>
21.16.5 Set the face picture data in the face picture library
Request URL
PUT /ISAPI/Intelligent/FDLib/FDSetUp?format=json
Query Parameter
None
Request Message
{
"faceURL": "http",
/*opt, string, picture storage URL, which is inputted when uploading the face picture by URL*/
"faceLibType": "blackFD",
/*req, enum, face picture library type, subType:string, desc:"blackFD" (list library), "staticFD" (static library), the maximum length is 32 bytes*/
"FDID": "test",
/*req, string, face picture library ID, desc:the maximum length is 63 bytes. Multiple libraries are separated by commas*/
"FPID": " ",
/*opt, string, face record ID, desc:it can be generated by the device or inputted. If it is inputted, it should be the unique ID with the combination of
letters and digits, and the maximum length is 63 bytes; if it is generated by the device automatically, it is the same as the employee No. (person ID)*/
"deleteFP": true,
/*opt, bool, whether to delete the face record, desc:true (yes). This field required when the face record needs to be deleted; for adding or editing the
face record, it should not be configured*/
/*opt, string, target model data, desc:during the process of transmission, the non-modeling binary data will be encrypted with Base64 method*/
/*opt, array, feature picture coordinates, subType:object, desc:if the device only supports three types of feature points, when the platform applies
more than three types of feature points, the device will not return error information*/
{
mouth), "rightMouthCorner" (right corner of mouth), "nose"*/
/*opt, object, coordinates of the feature point*/
"x": 1,
/*req, int, X-coordinate, range:[0,1000], desc:normalized coordinates*/
"y": 1,
/*req, int, Y-coordinate, range:[0,1000], desc:normalized coordinates*/
"width": 1,
/*opt, int, width, range:[0,1000], desc:it is required when featurePointType is "face"*/
"height": 1
/*opt, int, height, range:[0,1000], desc:it is required when featurePointType is "face"*/
}
}
],
/*opt, enum, face picture type, subType:string, desc:"normalFace" (normal face, default value), "patrolFace" (patrol person face), "hijackFace" (duress
person face), "superFace" (super person face)*/
/*opt, bool, whether to save the registered face picture*/
/*opt, array, first authentication permission, subType:int, range:[1,4], desc:first authentication permission*/
}
Parameter Parameter
Parameter Type(Content-Type) Content-ID File Name Description
Name Value
faceURL [报文内容] application/json -- -- --
img [图片二进制数据] image/jpeg faceImage.jpg --
Note： The protocol is transmitted in form format. See Chapter 4.5.1.4 for form framework description, as shown in
the instance below.
--<frontier>
Content-Disposition: form-data; name=Parameter Name;filename=File Name
Content-Type: Parameter Type
Content-Length: ****
Content-ID: Content ID
Parameter Value
Parameter Name: the name property of Content-Disposition in the header of form unit; it refers to the form unit
name.
Parameter Type (Content-Type): the Content-Type property in the header of form unit.
File Name (filename): the filename property of Content-Disposition of form unit Headers. It exists only when the
transmitted data of form unit is file, and it refers to the file name of form unit body.
Parameter Value: the body content of form unit.
Response Message
{
"statusCode": 1,
"errorCode": 1,
/*ro, req, int, error code, desc:it is required when the value of statusCode is not 1, it corresponds to subStatusCode*/
"errorMsg": "ok"
}
21.16.6 Add a face record to the face picture library

Request URL
POST /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json
Query Parameter
None
Request Message
{
"faceURL": "test",
/*opt, string, picture storage URL inputted when uploading the face picture by URL*/
/*req, enum, face picture library type, subType:string, desc:face picture library type*/
"FDID": "test",
/*req, string, face picture library ID, desc:the maximum size is 63 bytes*/
"FPID": " test",
/*opt, string, face record ID, desc:face record ID,it can be generated by device or inputted. If it is inputted,it should be the unique ID with the
combination of letters and digits,and the maximum length is 63 bytes; if it is generated by the device automatically,it is the same as the employee No.
(person ID)*/
"name": "张三",
/*req, string, name of person in the face picture, desc:the maximum size is 96 bytes*/
"gender": "male",
/*opt, enum, gender of person in the face picture, subType:string, desc:“male”, “female”, “unknown”; the maximum size is 32 bytes*/
"bornTime": "2004-05-03",
/*req, string, birthday of person in the face picture, desc:the maximum size is 20 bytes*/
"city": "130100",
/*opt, string, city code of birth for the person in the face picture, desc:the maximum size is 32 bytes*/
"certificateType": "officerID",
/*opt, enum, certificate type, subType:string*/
/*opt, string, certificate No., desc:the maximum size is 32 bytes*/
"caseInfo": "test",
/*opt, string, case information, desc:the maximum size is 192 bytes; it is valid when faceLibType is "blackFD”*/
/*opt, string, custom tag, desc:up to 4 tags, which are separated by commas. The maximum size is 195 bytes. It is valid when faceLibType is "blackFD”*/
"address": "test",
/*opt, string, person address, desc:the maximum size is 192 bytes. It is valid when faceLibType is "staticFD”*/
/*opt, string, custom information, desc:the maximum size is 192 bytes. It is valid when faceLibType is "staticFD"*/
/*opt, string, target modeling data, desc:target model data,non-modeled binary data needs to be encrypted by Base64 during transmission*/
"transfer": true,
/*opt, bool, whether to enable transfer, desc:whether to enable transfer*/
"operateType": "byTerminal",
/*opt, enum, operation type, subType:string, desc:"byTerminal” (operate by terminal)*/
"terminalNoList": [1],
/*opt, array, terminal ID list, subType:int, desc:this node is required when operation type is "byTerminal"; currently, only one terminal is supported*/
/*opt, array, feature points to be applied, subType:object*/
{
mouth), "rightMouthCorner" (right corner of mouth), "nose"*/
/*opt, object, coordinates of the feature point, desc:object,coordinates of the feature point*/
"x": 1,
"y": 1,
"width": 1,
/*opt, int, width, range:[0,1000], desc:this node is required when featurePointType is "face"*/
"height": 1
/*opt, int, height, range:[0,1000], desc:this node is required when featurePointType is "face"*/
}
}
],
}
Parameter Name Parameter Value Parameter Type(Content-Type) Content-ID File Name Description
img [图片二进制数据] image/jpeg facePic.jpg --
the instance below.
--<frontier>
Parameter Value
name.
Response Message
{
"statusCode": 1,
/*ro, req, int, status code*/
"errorCode": 1,
/*ro, opt, int, error code*/
"errorMsg": "ok",
/*ro, opt, string, error description, desc:see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"FPID": "test",
/*ro, opt, string, face record ID, desc:face record ID returned when the face record is added,it is unique,and the maximum size is 63 bytes. This node
is valid when errorCode is "1" and errorMsg is "ok"*/
"rowKey": "test"
/*ro, opt, string*/
}
21.16.7 Edit face records in the face picture library in a batch

Request URL
PUT /ISAPI/Intelligent/FDLib/FDModify?format=json
Query Parameter
None
Request Message
{
"faceURL": "test",
/*opt, string, picture storage URL inputted when uploading the face picture by URL, the maximum length is 256 bytes*/
/*req, enum, face picture library type, subType:string, desc:face picture library type: "blackFD"-list library,"staticFD"-static library,the maximum
length is 32 bytes*/
"FDID": "test",
/*req, string, face picture library ID, desc:face picture library ID,the maximum length is 63 bytes,multiple face picture libraries should be separated
by commas*/
"FPID": " ",
/*opt, string, face record ID*/
"name": "test",
/*opt, string, name*/
"gender": "any",
/*req, enum, gender, subType:string, desc:"any” (unlimited condition which is used in search), "male”, “female”, “unknown"*/
"bornTime": "2004-05-03",
/*req, time, date of birth of the person in the face picture in ISO8601 time format, the maximum length is 20 bytes, desc:date of birth of the person in
the face picture in ISO8601 time format,the maximum length is 20 bytes*/
"city": "130100",
/*opt, string, code of the city of birth for the person in the face picture, the maximum length is 32 bytes, desc:code of the city of birth for the
person in the face picture,the maximum length is 32 bytes*/
"certificateType": "ID",
/*req, enum, certificate type, subType:string*/
/*opt, string, ID No., the maximum length is 32 bytes*/
"caseInfo": "test",
/*opt, string, case information, it is valid when faceLibType is "blackFD”, range:[0,192]*/
/*opt, string, custom tag*/
"address": "test",
/*opt, string, person address, it is valid when faceLibType is "staticFD”*/
/*opt, string, custom information, it is valid when faceLibType is "staticFD”*/
/*opt, string, target model data, non-modeled binary data needs to be encrypted by base64 during transmission*/
/*opt, enum, operation type, subType:string, desc:"byTerminal"-by terminal*/
/*opt, array, terminal ID list, subType:int, desc:this node is required when operation type is "byTerminal"; currently, only one terminal is supported*/
/*opt, array, feature points to be applied. If the device only supports three types of feature points, when the platform applies more than three types
of feature points,the device will not return error information, subType:object*/
{
mouth), "rightMouthCorner" (right corner of mouth), "nose”*/
/*opt, object, point coordinates*/
"x": 1,
"y": 1,
"width": 1,
/*opt, int, width, range:[0,1000], desc:width which is between 0 and 1000. This node is required when featurePointType is "face"*/
"height": 1
/*opt, int, height, range:[0,1000], desc:height which is between 0 and 1000. This node is required when featurePointType is "face"*/
}
}
],
}
Parameter Parameter
Parameter Type(Content-Type) Content-ID File Name Description
Name Value
img [图片二进制数据] image/jpeg faceImage.jpg --
the instance below.
--<frontier>
Parameter Value
name.
Response Message
{
"statusCode": 1,
"errorCode": 1,
/*ro, opt, int, error code, desc:when the value of statusCode is not 1, it corresponds to subStatusCode*/
"errorMsg": "ok"
/*ro, opt, string, error details, desc:this field is required when statusCode is not 1*/
}
21.17 Face Picture Library Management (To be Optimized)

21.17.1 Create a face picture library
Request URL
POST /ISAPI/Intelligent/FDLib?format=json
Query Parameter
None
Request Message
{
"faceLibType": "blackFD,staticFD",
/*req, string, face picture library type, desc:face picture library type*/
"name": "test",
/*req, string, name of the face picture library, range:[0,48], desc:name of the face picture library*/
/*opt, string, custom information, range:[0,192], desc:custom information*/
"libArmingType": "armingLib",
/*opt, enum, subType:string*/
"libAttribute": "blackList",
"FDID": "test"
/*opt, string, face picture library ID, desc:face picture library ID*/
}
Response Message
{
"statusCode": 1,
/*ro, req, int, status code, desc:1 (succeeded). It is required when an error occurred*/
/*ro, req, string, status description, range:[1,64], desc:"ok" (succeeded). It is required when an error occurred*/
/*ro, req, string, sub status code, range:[1,64], desc:"ok" (succeeded). It is required when an error occurred*/
"errorCode": 1,
"errorMsg": "ok",
/*ro, opt, string, error details, desc:this node is required when the value of statusCode is not 1*/
"FDID": "test"
/*ro, opt, string, face picture library ID, desc:face picture library ID*/
}
21.17.2 Get the total number of face records in all face picture libraries
Request URL
GET /ISAPI/Intelligent/FDLib/Count?format=json
Query Parameter
None
Request Message
None
Response Message
{
"requestURL": "http://10.7.52.31:8080/kms/services/rest/dataInfoService/downloadFile",
"statusCode": 1,
"errorCode": 1,
/*ro, req, int, error code, desc:it is required when the value of statusCode is not 1, it corresponds to subStatusCode*/
"errorMsg": "ok",
/*ro, req, string, see the description of this node and above nodes in the message of JSON_ResponseStatus, desc:this node is required when the value of
statusCode is not 1*/
"FDRecordDataInfo": [
/*ro, opt, array, information of face records in face picture library, subType:object, desc:this node is valid when errorCode is 1 and errorMsg is
"ok"*/
{
"FDID": "test",
/*ro, opt, string, face picture library ID, desc:the maximum size is 63 bytes*/
/*ro, opt, enum, face picture library type, subType:string, desc:face picture library type "blackFD" list library,"staticFD" static library, the
maximum size is 32 bytes*/
"name": "test",
/*ro, opt, string, face picture library name, desc:the maximum size is 48 bytes*/
"recordDataNumber": 123,
/*ro, opt, int, number of records*/
/*ro, opt, enum, arming type, subType:string, desc:arming type*/
"libAttribute": "general",
/*ro, opt, enum, subType:string*/
"personnelFileEnabled": true
/*ro, opt, bool*/
}
],
"totalRecordDataNumber": 500000,
/*ro, opt, int, total number of records, desc:total number of records*/
"FDCapacity": {
/*ro, opt, object*/
"total": 0.000,
/*ro, req, float*/
"use": 0.000,
/*ro, req, float*/
"remain": 0.000,
/*ro, req, float, remaining space, desc:remaining space*/
"maxRecordDataNumber": 0,
/*ro, opt, int*/
"useRecordDataNumber": 0,
/*ro, opt, int*/
"remainRecordDataNumber": 0
/*ro, opt, int*/
}
}
21.17.3 Get face picture library capability

Request URL
GET /ISAPI/Intelligent/FDLib/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"statusCode": 1,
"errorCode": 1,
/*ro, opt, int, error code, this field is required when the value of statusCode is not 1, and it corresponds to subStatusCode*/
"errorMsg": "ok",
/*ro, opt, string, detailed error description, this field is required when the value of statusCode is not 1*/
"FDNameMaxLen": 64,
/*ro, req, int, maximum length of face picture library name*/
"customInfoMaxLen": 192,
/*ro, req, int, maximum length of custom information*/
"FDMaxNum": 3,
/*ro, req, int, maximum number of face picture libraries*/
"FDRecordDataMaxNum": 12345,
/*ro, req, int, maximum face records supported by face picture library*/
"supportFDFunction": "post,delete,put,get,setUp",
/*ro, req, string, the supported operations on face picture library, desc:"post” (create), "delete” (delete), "put” (edit), "get” (search), "setUp”
(set)*/
"isSuportFDSearch": true,
/*ro, req, bool, whether supports searching in face picture library*/
"isSupportFDSearchDataPackage": true,
/*ro, req, bool, whether supports packaging the found data in the face picture library*/
"isSuportFSsearchByPic": true,
/*ro, req, bool, whether supports searching by picture in the face picture library*/
"isSuportFSsearchByPicGenerate": true,
/*ro, req, bool, whether supports exporting search by picture results from the face picture library*/
"isSuportFDSearchDuplicate": true,
/*ro, req, bool, whether supports duplication checking*/
"isSuportFDSearchDuplicateGenerate": true,
/*ro, req, bool, whether supports exporting the duplication checking results*/
"isSuportFCSearch": true,
/*ro, req, bool, whether supports searching face picture comparison alarms*/
"isSupportFCSearchDataPackage": true,
/*ro, req, bool, whether supports packaging the search results of face picture comparison alarms*/
"isSupportFDExecuteControl": true,
/*ro, req, bool, whether supports creating relation between face picture libraries and cameras*/
"generateMaxNum": 1234,
/*ro, req, int, maximum face records can be exported from face picture library*/
"faceLibType": "blackFD,staticFD",
/*ro, opt, string, face picture library type*/
"modelMaxNum": 1000,
/*ro, opt, int, the maximum number of search results*/
"isSupportModelData": true,
/*ro, opt, bool, whether it supports applying model data*/
"isSuportFDLibArmingType": true,
/*ro, opt, bool, whether it supports face picture library arming type*/
"isSuportFDLibSearch": true,
/*ro, opt, bool, whether it supports searching face picture library*/
"FDArmingRecordDataMaxNum": 12345,
/*ro, opt, int, the supported maximum number of face records in the face picture arming library*/
"isSupportControlPersonRecordByHumanId": true,
/*ro, opt, bool, whether it supports modifying and deleting the face record by humanId*/
"isSupportControlPersonRecordByRowKey": true,
/*ro, opt, bool, whether it supports modifying and deleting the face record by rowKey*/
"isSupportFaceLibRebuildCfg": true,
/*ro, opt, bool, whether it supports recreating face picture library information and configuration*/
"isSupportFDMove": true,
/*ro, opt, bool, whether it supports moving face data in the face picture library in a batch, desc:the related URI is
/ISAPI/Intelligent/FDLib/FDMove/capabilities?format=json*/
"faceURLLen": 1024,
/*ro, opt, int, the maximum size of the face picture URL, desc:if this node is not returned, the default size of the face picture URL supported by the
device is 256 bytes; otherwise, the device should support that the value of this node is greater than or equal to 256*/
"isSupportArmingLibCfg": true,
/*ro, opt, bool, whether it supports configuring parameters of the armed face picture library, desc:related URI:
/ISAPI/Intelligent/FDLib/armingLibCfg/capabilities?format=json*/
"isSupportModelTransformation": true,
/*ro, opt, bool, whether it supports converting face picture models in the face picture list library, desc:related URI:
/ISAPI/Intelligent/FDLib/model/transformation/capabilities?format=json*/
"featurePointTypeList": ["face", "leftEye", "rightEye", "leftMouthCorner", "rightMouthCorner", "nose"],
/*ro, opt, array, feature point types of face pictures supported by the device, subType:string*/
"isSupportPresort": true,
/*ro, opt, bool*/
"libAttribute": {
/*ro, opt, object*/
"@opt": ["general", "blackList", "VIP", "passerby"]
/*ro, opt, array, subType:string*/
},
"faceType": {
/*ro, opt, object, face picture type*/
"@opt": ["normalFace", "patrolFace", "hijackFace", "superFace"]
/*ro, opt, array, options, subType:string*/
},
"saveFacePic": {
/*ro, opt, object, whether to save the registered face picture*/
/*ro, opt, array, options, subType:bool*/
},
"leaderPermission": {
/*ro, opt, object*/
"@size": 4,
/*ro, opt, int, range:[1,4]*/
"@min": 1,
"@min": 1,
"@max": 4
}
}
21.17.4 Get the information, including library ID, library type, name, and custom
information, of all face picture libraries
Request URL
GET /ISAPI/Intelligent/FDLib?format=json&FDID=<FDID>&faceLibType=<faceLibType>&terminalNo=<terminalNo>
Query Parameter
FDID string --
faceLibType string --
terminalNo string --
Request Message
None
Response Message
{
"statusCode": 1,
/*ro, req, int, status code, desc:status code*/
/*ro, req, string, status description, range:[1,64], desc:status description*/
/*ro, req, string, sub status code, range:[1,64], desc:sub status code*/
"errorCode": 1,
/*ro, opt, int*/
"errorMsg": "ok",
/*ro, opt, string, error description, desc:error description*/
/*ro, opt, enum, face picture library type, subType:string, desc:"blackFD” (list library), "staticFD” (static library)*/
"name": "test",
/*ro, opt, string, face picture library name, range:[0,48]*/
/*ro, opt, string, custom information, range:[0,192]*/
/*ro, opt, enum, library arming type, subType:string, desc:library arming type*/
"libAttribute": "blackList",
"personnelFileEnabled": true
/*ro, opt, bool*/
}
21.17.5 Delete all face picture libraries

Request URL
DELETE /ISAPI/Intelligent/FDLib?format=json
Query Parameter
None
Request Message
None
Response Message
{
"statusCode": 1,
"errorCode": 1,
/*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 field is required when the value of statusCode is not 1*/
}
21.18 Audio Input

21.18.1 Get parameters of all audio channels of the device
Request URL
GET /ISAPI/System/Audio/channels
Query Parameter
None
Request Message
None
Response Message
<AudioChannelList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<AudioChannel>

<id>
test
</id>
<enabled>
true
</enabled>
<type opt="audioIn,audioOut">
audioIn
</type>
<name>
test
</name>
</AudioChannel>
</AudioChannelList>
21.18.2 Get the configuration of a specific audio channel of the device

Request URL
GET /ISAPI/System/Audio/channels/<audioID>
Query Parameter
audioID string --
Request Message
None
Response Message
<AudioChannel xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
test
</id>
<enabled>
true
</enabled>
<type opt="audioIn,audioOut">
audioIn
</type>
<name>
test
</name>
</AudioChannel>
21.18.3 Get the audio capabilities

Request URL
GET /ISAPI/System/Audio/capabilities
Query Parameter
None
Request Message
None
Response Message
<AudioCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<audioInputNums>
</audioInputNums>
<audioOutputNums>
</audioOutputNums>
<mixAudioInSet>
</mixAudioInSet>
<mixAudioOutSet>
</mixAudioOutSet>
<isSupportAudioMixing>
</isSupportAudioMixing>
<isSupportRemoveFrequencyPoint>
</isSupportRemoveFrequencyPoint>
<isSupportAudioInConfig>
</isSupportAudioInConfig>
<muteDuringPanTilt opt="MicIn">
</muteDuringPanTilt>
<isSupportAudioOutConfig>
</isSupportAudioOutConfig>
<isSupportSAIP>
</isSupportSAIP>
<SAIPChannelsNum>
1
</SAIPChannelsNum>
<isSupportDataStorage>
</isSupportDataStorage>
<isSupportDataRelease>
</isSupportDataRelease>
<isSupportAudioPlan>
</isSupportAudioPlan>
<isSupportAudioTask>
</isSupportAudioTask>
<isSupportaudioCollection>
</isSupportaudioCollection>
<isSupportWirelessPickUp>
</isSupportWirelessPickUp>
<audioOutputBroadcastNums opt="1,2,3,4">
</audioOutputBroadcastNums>
<isSupportAudioOutMixing>
</isSupportAudioOutMixing>
<isSupportRTSPAudio>
</isSupportRTSPAudio>
<AudioBoard>
<isSupportNetworkParamCfg>
</isSupportNetworkParamCfg>
</AudioBoard>
<isSupportRTSPAudioPlaybackByFile>
</isSupportRTSPAudioPlaybackByFile>
</AudioCap>
21.18.4 Set audio input parameters of a specific channel

Request URL
PUT /ISAPI/System/Audio/AudioIn/channels/<audioID>
Query Parameter
audioID string --
Request Message
<AudioIn xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
</id>
<MixAudioIn>

<enabled>
true
</enabled>
<audioInputType>
macIn
</audioInputType>
<highPassFilter>
1
</highPassFilter>
<noiseMargin>
1
</noiseMargin>
<AutoLimitWave>

<FBCEnable>
</FBCEnable>
<mode>
fast
</mode>
<filterQValue>
1
</filterQValue>
<staticFilterNum>
1
</staticFilterNum>
</AutoLimitWave>
<DSPParameter>

<FBCEnable>
</FBCEnable>
<volume>
1
</volume>
</DSPParameter>
</MixAudioIn>
<AudioInVolumelist>

<AudioInVlome>

<type>
audioOutput
</type>
<volume>
1
</volume>
</AudioInVlome>
</AudioInVolumelist>
<automaticGainControl>
1
</automaticGainControl>
<energyThreshold>
1
</energyThreshold>
<PhantomPower>

<enabled>
</enabled>
</PhantomPower>
<audioInCodingFormat>
G.711U
</audioInCodingFormat>
<audioInModeEnabled>
</audioInModeEnabled>
<audioInMode>
leftMic
</audioInMode>
<audioInSensitivity>
high
</audioInSensitivity>
<AGCEnabled>
</AGCEnabled>
<noiseReductionEnabled>
</noiseReductionEnabled>
<AECEnable>
</AECEnable>
<audioSamplingRate>
0
</audioSamplingRate>
<audioBitRate>
0
</audioBitRate>
<noiseReductionLevel>
0
</noiseReductionLevel>
</AudioIn>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.18.5 Get the audio input parameters of a specified channel

Request URL
GET /ISAPI/System/Audio/AudioIn/channels/<audioID>
Query Parameter
audioID string --
Request Message
None
Response Message
<AudioIn xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
</id>
<MixAudioIn>

<enabled>
</enabled>
<audioInputType>
macIn
</audioInputType>
<highPassFilter>
1
</highPassFilter>
<noiseMargin>
1
</noiseMargin>
<AutoLimitWave>
<FBCEnable>
</FBCEnable>
<mode>
fast
</mode>
<filterQValue>
1
</filterQValue>
</filterQValue>
<staticFilterNum>
1
</staticFilterNum>
</AutoLimitWave>
<DSPParameter>
<FBCEnable>
</FBCEnable>
<volume>
1
</volume>
</DSPParameter>
</MixAudioIn>
<AudioInVolumelist>
<AudioInVlome>
<type>
audioOutput
</type>
<volume>
1
</volume>
</AudioInVlome>
<automaticGainControl>
<energyThreshold>
</energyThreshold>
<PhantomPower>
<enabled>
</enabled>
</PhantomPower>
<audioInCodingFormat>
G.711U
<audioInMode>
leftMic
</audioInMode>
<audioInSensitivity>
high
<AGCEnabled>
</AGCEnabled>
<noiseReductionEnabled>
<AECEnable>
</AECEnable>
<audioSamplingRate>
0
<audioBitRate>
0
</audioBitRate>
<noiseReductionLevel>
0
</AudioIn>
21.18.6 Get the audio input capability of a specified channel

Request URL
GET /ISAPI/System/Audio/AudioIn/channels/<audioID>/capabilities
Query Parameter
audioID string --
Request Message
None
Response Message
<AudioInCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
</id>
<MixAudioIn>

true
</enabled>
<audioInputType opt="micIn, lineIn">
macIn
</audioInputType>
<highPassFilter
opt="0,8,16,24,31,39,47,55,63,71,79,87,94,102,110,118,126,134,142,150,157,165,173,181,189,197,205,213,220,228,236,244,252,260,268,276,283,291,299,307,315,32
3,331,339,346,354,362,370,378,386,394,402,409,417,425,433,441,449,457,465,472,480,488,496,504,512,520,528,535,543,551,559,567,575,583,591,598,606,614,622,63
0,638,646,654,661,669,677,685,693,701,709,717,724,732,740,748,756,764,772,780,787,795,803,811,819,827,835,843,850,858,866,874,882,890,898,906,913,921,929,93
7,945,953,961,969,976,984,992,1000" def="30">
1
</highPassFilter>
<noiseMargin opt="1000,660,657,653,650,647,643,640,637,633,-
630,627,623,620,617,613,610,607,603,600,597,593,590,587,583,580,577,573,570,567,563,560,557,553,550,547,543,540,537,533,530,527,523,520,517,513,510,507,503,
500,497,493,490,487,483,480,477,473,470,467,463,460,457,453,450,447,443,440,437,433,430,427,423,420,417,413,410,407,403,400,397,393,390,387,383,380,377,373,
370,367,363,360,357,353,350,347,343,340,337,333,330,327,323,320,317,313,310,307,303,300,297,293,290,287,283,280,277,273,270,267,263,260,257,253,250,247,243,
240" def="30">
1
</noiseMargin>
<AutoLimitWave>

<FBCEnable opt="true,false">
</FBCEnable>
<mode opt="fast,general,slow" def="general">
fast
</mode>
<filterQValue opt="40,10" def="40">
1
</filterQValue>
<staticFilterNum min="0" max="12" def="0">
1
</staticFilterNum>
</AutoLimitWave>
<DSPParameter>
<FBCEnable>
</FBCEnable>
<volume min="1" max="10">
1
</volume>
</DSPParameter>
</MixAudioIn>
<AudioInVolumelist>
<AudioInVlome>
<type opt="audioInput,audioOutput,audioEncode">
audioOutput
</type>
<volume min="0" max="127" def="50">
1
</volume>
</AudioInVlome>
<automaticGainControl min="0" max="12" default="12">
1
<energyThreshold min="-90" max="0" default="-55">
1
</energyThreshold>
<PhantomPower>
<enabled opt="true,false" def="false">
true
</enabled>
</PhantomPower>
<audioInCodingFormat opt="G.711U,G.711A,OPUS,PCM,AAC" def="G.711U">
G.711U
<audioInMode opt="leftMic,rightMic,bluetooth,lineIn,earphone,6.5mm,RCALeft,RCARight,embeddedAudio">
high
<AGCEnabled opt="true,false" def="true">
true
</AGCEnabled>
<noiseReductionEnabled opt="true,false">
<AECEnable opt="true,false">
</AECEnable>
<audioSamplingRate opt="16,32" def="16">
0
<audioBitRate opt="1,2,3,4,5" def="0">
0
</audioBitRate>
<isSupportAudioSceneSettings>
</isSupportAudioSceneSettings>
<isSupportSoundSourcerPosition>
</isSupportSoundSourcerPosition>
<noiseReductionLevel min="0" max="6">
0
</AudioInCap>
21.19 ID Card Management

21.19.1 Apply ID card blocklist
Request URL
PUT /ISAPI/AccessControl/IDBlackListCfg?security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
<IDBlackListCfg xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<blackListValid>
1
</blackListValid>
<IDCardInfo>

<name>
</name>
<birth>
1990-02-24
</birth>
<addr>
test
</addr>
<IDNum>
542137199002241111
</IDNum>
<issuingAuthority>
test
</issuingAuthority>
<startDate>
1970-01-01
</startDate>
<endDate>
1977-01-01
</endDate>
<termOfValidity>
true
</termOfValidity>
<sex>
male
</sex>
<nation>
</nation>
</IDCardInfo>
</IDBlackListCfg>
Response Message

<requestURL>
null
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.19.2 Get capability of applying ID card blocklist

Request URL
GET /ISAPI/AccessControl/IDBlackListCfg/capabilities
Query Parameter
None
Request Message
None
Response Message
<IDBlackListCfg xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<blackListValid opt="0,1">
1
</blackListValid>
<IDCardInfo>

test
</name>
<birth>
1970-01-01
</birth>
<addr min="1" max="10">
test
</addr>
<IDNum min="18" max="18">
542137199002241111
</IDNum>
<issuingAuthority min="1" max="10">
test
</issuingAuthority>
<startDate>
1970-01-01
</startDate>
<endDate>
1970-01-01
</endDate>
<termOfValidity opt="true,false">
true
</termOfValidity>
male
</sex>
<nation
opt="1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,5
4,55,56,57">
1
</nation>
</IDCardInfo>
</IDBlackListCfg>
21.19.3 ID card information event

EventType:IDCardInfoEvent
{
"ipAddress": "172.6.64.7",
/*ro, req, string, IPv4 address of the device that triggers the alarm*/
"ipv6Address": "1080:0:0:0:8:800:200C:417A",
/*ro, opt, string, IPv6 address of the device that triggers the alarm*/
"portNo": 80,
/*ro, opt, int, communication port No. of the device that triggers the alarm*/
"protocol": "HTTP",
/*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
ISAPI protocol is transmitted via ISUP, the channel No. is the video channel No. of ISUP*/
"macAddress": "01:17:24:45:D9:F4",
/*ro, opt, string, MAC address*/
"channelID": 1,
/*ro, opt, int, channel No. of the device that triggers the alarm, 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 ISAPI
protocol is transmitted via ISUP, the channel No. is the video channel No. of ISUP*/
"dateTime": "2004-05-03T17:30:08+08:00",
/*ro, req, datetime, alarm trigger time*/
"activePostCount": 1,
/*ro, opt, int, times that the same alarm has been uploaded, desc:times that the same alarm has been uploaded*/
"eventType": "IDCardInfoEvent",
/*ro, req, string, event type, desc:"IDCardInfoEvent" (ID card information event)*/
"eventState": "active",
/*ro, req, enum, event status, subType:string, desc:for durative event: "active" (valid event or event starts), "inactive" (invalid event or the event
ends). For the heartbeat, the node value indicates the heartbeat data, and it is uploaded every 10 seconds*/
"eventDescription": "IDCard Info Event",
/*ro, req, string, event description*/
"deviceID": "test0123",
/*ro, opt, string, device ID (PUID), desc:it should be returned in ISUP alarm*/
"IDCardInfoEvent": {
/*ro, opt, object, ID card information*/
"deviceName": "test",
/*ro, opt, string, device name, range:[1,32]*/
"majorEventType": 1,
/*ro, req, int, major alarm type, desc:the type value should be transformed to the decimal number; see Access Control Alarm Types for details*/
"subEventType": 1,
/*ro, req, int, minor alarm type, dep:and,{$.IDCardInfoEvent.majorEventType,eq,任意值}, desc:the type value should be transformed to the decimal
number; see Access Control Alarm Types for details*/
number; see Access Control Alarm Types for details*/
"inductiveEventType": "authenticated",
/*ro, opt, enum, inductive event type, subType:string, desc:this node is used by storage devices; for access control devices, this node is invalid;
"authenticated", "authenticationFailed", "openingDoor", "closingDoor", "doorException", "remoteOperation", "timeSynchronization", "deviceException",
"deviceRecovered", "alarmTriggered", "alarmRecovered" (arming restoring event), "callCenter"*/
"netUser": "test",
/*ro, opt, string, user name for network operations, range:[1,32]*/
"remoteHostAddr": "test",
/*ro, opt, string, remote host address*/
"cardType": 1,
/*ro, opt, enum, card type, subType:int, desc:1 (normal card), 2 (disability card), 3 (blocklist card), 4 (patrol card), 5 (duress card), 6 (super
card), 7 (visitor card), 8 (dismiss card)*/
"cardReaderNo": 1,
/*ro, opt, int, card reader No.*/
"doorNo": 1,
/*ro, opt, int, door (floor) No.*/
"deviceNo": 1,
/*ro, opt, int, device No.*/
"serialNo": 1,
/*ro, opt, int, event serial No.*/
"currentEvent": true,
/*ro, opt, bool, whether it is a real-time event, desc:true (yes (real-time event)), false (no (offline event))*/
"QRCodeInfo": "test",
/*ro, opt, string, QR code information, range:[1,64]*/
"thermometryUnit": "celsius",
/*ro, opt, enum, temperature unit, subType:string, desc:"celsius" (Celsius (default)), "fahrenheit" (Fahrenheit), "kelvin" (Kelvin)*/
"currTemperature": 36.1,
/*ro, opt, float, skin-surface temperature, desc:it should be accurate to one decimal place*/
"isAbnomalTemperature": true,
/*ro, opt, bool, whether the skin-surface temperature is abnormal*/
"RegionCoordinates": {
/*ro, opt, object, coordinates of the skin-surface temperature*/
"positionX": 0,
/*ro, opt, int, X-coordinate, range:[0,1000], desc:the value is normalized to a number between 0 and 1000*/
"positionY": 0
/*ro, opt, int, Y-coordinate, range:[0,1000], desc:the value is normalized to a number between 0 and 1000*/
},
"remoteCheck": true,
/*ro, opt, bool, whether remote verification is required, desc:true (yes), false (no, default)*/
"mask": "unknown",
/*ro, opt, enum, whether the person wears a mask, subType:string, desc:"unknown", "yes", "no"*/
"frontSerialNo": 1,
/*ro, opt, int, the previous event's serial No., desc:if this node does not exist, the platform will check whether the event loss occurred according
to the node serialNo. If both the serialNo and frontSerialNo are returned, the platform will check whether the event loss occurred according to both nodes.
It is mainly used to solve the problem that the serialNo is inconsistent after subscribing events or alarms*/
"IDCardInfo": {
/*ro, opt, object, ID card information*/
"name": "test",
/*ro, opt, string, name, range:[1,128]*/
"sex": "male",
/*ro, opt, enum, gender, subType:string, desc:"male", "female"*/
"birth": "1970-01-01",
/*ro, opt, date, date of birth*/
"addr": "test",
/*ro, opt, string, address*/
"IDCardNo": "test",
/*ro, opt, string, ID card No.*/
"issuingAuthority": "test",
/*ro, opt, string, issuing authority*/
"startDate": "test",
/*ro, opt, string, start date of the effective period*/
"endDate": "test",
/*ro, opt, string, end date of the effective period*/
"nation": 1,
/*ro, opt, int, N/A, range:[1,57], desc:N/A*/
"isLongTermEffective": false
/*ro, opt, bool, whether the effective period is permanent*/
},
"pictureURL": "test",
/*ro, opt, string, URL of the captured picture, range:[1,256]*/
"IDCardPicURL": "test",
/*ro, opt, string, ID card picture URL, range:[1,256]*/
"certificatePicURL": "test",
/*ro, opt, string, URL of the captured ID picture, range:[1,256]*/
"contentId": "Picture",
/*ro, opt, string, contentID of picture, desc:contentID of the picture data binary data*/
"IDCardContentId": "IDCardPicture",
/*ro, opt, string, contentID of ID card picture, desc:contentID of the picture data binary data*/
"certificateContentId": "CertificatePicture",
/*ro, opt, string, contentID of captured ID picture, desc:contentID of the picture data binary data*/
"visibleLightURL": "test",
/*ro, opt, string, visible light picture URL of the thermal imaging camera, range:[0,256]*/
"thermalURL": "test",
/*ro, opt, string, thermal imaging picture URL, range:[0,256]*/
"picturesNumber": 1,
/*ro, opt, int, number of pictures, range:[0,4], desc:if there is no picture, this node is set to 0 or is not returned*/
"helmet": "unknown",
/*ro, opt, enum, whether the person wears a hard hat, subType:string, desc:"unknown", "yes", "no"*/
"HealthInfo": {
/*ro, opt, object, health information*/
"healthCode": 1,
/*ro, opt, enum, health code status, subType:int, desc:0 (no request), 1 (no health code), 2 (green QR code), 3 (yellow QR code), 4 (red QR
code), 5 (no such person), 6 (other error, e.g., searching failed due to API exception), 7 (searching for the health code timed out)*/
"NADCode": 1,
/*ro, opt, enum, nucleic acid test result, subType:int, desc:0 (no result), 1 (negative, which means normal), 2 (positive, which means
diagnosed), 3 (the result has expired)*/
"NADMsg": "test",
/*ro, opt, string, range:[0,64]*/
"travelCode": 1,
/*ro, opt, enum, trip code, subType:int, desc:0 (no trip in the past 14 days), 1 (has left the current area left in the past 14 days), 2 (has
been to the high-risk area in the past 14 days), 3 (other)*/
"travelInfo": "test",
/*ro, opt, string, trip information, desc:the empty string indicates that searching trip failed*/
"vaccineStatus": 1,
/*ro, opt, enum, whether the person is vaccinated, subType:int, desc:0 (not vaccinated), 1 (vaccinated)*/
"vaccineNum": 1,
/*ro, opt, int, step:1*/
"vaccineMsg": "test",
"ANTCode": 1,
/*ro, opt, enum, subType:int*/
"ANTMsg": "test"
},
"PhysicalInfo": {
/*ro, opt, object, BMI information, desc:this node is obtained after authentication by BMI scales which is connected to MinMoe terminals*/
"weight": 7000,
/*ro, opt, int, weight, unit:kg*/
"height": 18000
/*ro, opt, int, height, unit:cm*/
},
"FaceRect": {
/*ro, opt, object, rectangle frame for human face, desc:the origin is the upper-left corner of the screen*/
"height": 1.000,
/*ro, req, float, height, range:[0.000,1.000]*/
"width": 1.000,
/*ro, req, float, width, range:[0.000,1.000]*/
"x": 0.000,
/*ro, req, float, X-coordinate of the upper-left corner of the frame, range:[0.000,1.000]*/
"y": 0.000
/*ro, req, float, Y-coordinate of the upper-left corner of the frame, range:[0.000,1.000]*/
},
"currentAuthenticationTimes": 1,
/*ro, opt, int, range:[0,255], step:1*/
"allowAuthenticationTimes": 1
}
}
Parameter
Parameter
Parameter Name Type(Content- Content-ID File Name Description
Value
Type)
IDCardInfoEvent [报文内容] application/json -- -- --
[图片二进
IDCardPic image/jpeg IDCardPicImage IDCardPic.jpg --
制数据]
[图片二进
CertificatePicture image/jpeg CertificatePicture CertificatePicture.jpg --
制数据]
[图片二进
VisibleLight image/jpeg visibleLight_image VisibleLight.jpg --
制数据]
[图片二进
Thermal image/jpeg thermal_image Thermal.jpg --
制数据]
[图片二进
ProtocolFileAndSignPic image/jpeg ProtocolFileAndSignPic.jpg --
制数据]
the instance below.
--<frontier>
Parameter Value
name.
21.20 Access Control Module Management
21.20.1 Get the configuration of the door lock status when the device is powered off
Request URL
GET /ISAPI/AccessControl/Configuration/lockType?format=json
Query Parameter
None
Request Message
None
Response Message
{
"LockType": {
/*ro, opt, object, status*/
"status": "alwaysOpen"
/*ro, opt, enum, door lock status when the device is powered off, subType:string, desc:door lock status when the device is powered off:
"alwaysOpen"-remain open,"alwaysClose"-remain closed*/
}
}
21.20.2 Set door lock status when the device is powered off
Request URL
PUT /ISAPI/AccessControl/Configuration/lockType?format=json
Query Parameter
None
Request Message
{
"LockType": {
/*opt, object, status*/
"status": "alwaysOpen"
/*req, enum, door lock status when the device is powered off, subType:string, desc:"alwaysOpen"-remain open, "alwaysClose"-remain closed*/
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
/*ro, req, string, error information*/
}
21.20.3 Get the door configuration capability

Request URL
GET /ISAPI/AccessControl/Door/param/<doorID>/capabilities
Query Parameter
doorID string --
Request Message
None
Response Message
<DoorParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<doorNo min="1" max="10">
1
</doorNo>
<doorName min="1" max="32">
test
</doorName>
<magneticType opt="alwaysClose,alwaysOpen">
1
</openDuration>
<disabledOpenDuration min="1" max="255">
1
</disabledOpenDuration>
<magneticAlarmTimeout min="0" max="255">
1
</magneticAlarmTimeout>
<enableDoorLock opt="true,false">
true
</enableDoorLock>
<enableLeaderCard opt="true,false">
true
</enableLeaderCard>
<leaderCardMode opt="disable,alwaysOpen,authorize">
disable
</leaderCardMode>
<leaderCardOpenDuration min="1" max="1440">
1
</leaderCardOpenDuration>
<stressPassword min="1" max="8">
test
</stressPassword>
<superPassword min="1" max="8">
test
</superPassword>
<unlockPassword min="1" max="8">
test
</unlockPassword>
<useLocalController opt="true,false">
true
</useLocalController>
<localControllerID min="0" max="64">
1
</localControllerID>
<localControllerDoorNumber min="0" max="4">
1
</localControllerDoorNumber>
<localControllerStatus opt="0,1,2,3,4,5,6,7,8,9">
1
</localControllerStatus>
<lockInputCheck opt="true,false">
true
</lockInputCheck>
<lockInputType opt="alwaysClose,alwaysOpen">
preventCutAndShort
</doorTerminalMode>
<openButton opt="true,false">
true
</openButton>
<ladderControlDelayTime min="1" max="255">
1
</ladderControlDelayTime>
<Leader>
<continuousVerificationTimes min="1" max="10">
</continuousVerificationTimes>
<continuousVerificationDuration min="1" max="10">
20
</continuousVerificationDuration>
<effectiveTimeEnabled opt="true,false">
</effectiveTimeEnabled>
<dayBeginTime>
00:00:00
</dayBeginTime>
<beginEffectiveTime>
</beginEffectiveTime>
<endEffectiveTime>
</endEffectiveTime>
</Leader>
<verificationPassOpenDoor opt="true,false">
</verificationPassOpenDoor>
<relayReverseEnabled opt="true,false" def="false">
true
</relayReverseEnabled>
</DoorParam>
21.20.4 Get the door (floor) configuration parameters

Request URL
GET /ISAPI/AccessControl/Door/param/<doorID>?security=<security>&iv=<iv>
Query Parameter
doorID string --
security string --
iv string --
Request Message
None
Response Message

<doorName>
test
</doorName>
<magneticType>
alwaysClose
</magneticType>
<openButtonType>
alwaysClose
</openButtonType>
<openDuration>
1
</openDuration>
<disabledOpenDuration>
1
<magneticAlarmTimeout>
1
<enableDoorLock>
<enableDoorLock>
true
</enableDoorLock>
<enableLeaderCard>
true
</enableLeaderCard>
<leaderCardMode>
disable
</leaderCardMode>
<leaderCardOpenDuration>
1
<stressPassword>
test
</stressPassword>
<superPassword>
test
</superPassword>
<unlockPassword>
test
</unlockPassword>
<useLocalController>
true
<localControllerID>
1
<localControllerDoorNumber>
1
<localControllerStatus>
1
<lockInputCheck>
true
</lockInputCheck>
<lockInputType>
alwaysClose
</lockInputType>
<doorTerminalMode>
preventCutAndShort
</doorTerminalMode>
<openButton>
true
</openButton>
<ladderControlDelayTime>
1
<Leader>
<continuousVerificationTimes>
1
<continuousVerificationDuration>
20
<effectiveTimeEnabled>
<dayBeginTime>
</dayBeginTime>
<endEffectiveTime>
</endEffectiveTime>
</Leader>
<verificationPassOpenDoor>
<relayReverseEnabled>
</DoorParam>
21.20.5 Set the door (floor) parameters

Request URL
PUT /ISAPI/AccessControl/Door/param/<doorID>?security=<security>&iv=<iv>
Query Parameter
doorID string --
security string --
iv string --
Request Message


<doorName>
test
</doorName>
<magneticType>
alwaysClose
</magneticType>
<openButtonType>
alwaysClose
</openButtonType>
<openDuration>
1
</openDuration>
<disabledOpenDuration>
1
<magneticAlarmTimeout>
1
<enableDoorLock>
true
</enableDoorLock>
<enableLeaderCard>
true
</enableLeaderCard>
<leaderCardMode>
disable
</leaderCardMode>
<leaderCardOpenDuration>
1
<stressPassword>
test
</stressPassword>
<superPassword>
test
</superPassword>
<unlockPassword>
test
</unlockPassword>
<useLocalController>
true
<localControllerID>
1
<localControllerDoorNumber>
1
<localControllerStatus>
1
<lockInputCheck>
true
</lockInputCheck>
<lockInputType>
preventCutAndShort
</doorTerminalMode>
<openButton>
true
</openButton>
<ladderControlDelayTime>
1
<Leader>

1
<continuousVerificationDuration>
20
<effectiveTimeEnabled>
<dayBeginTime>
00:00:00
</dayBeginTime>
<endEffectiveTime>
</endEffectiveTime>
</Leader>
<verificationPassOpenDoor>
<relayReverseEnabled>
</DoorParam>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.20.6 Get the capability of getting the status of the secure door control unit
Request URL
GET /ISAPI/AccessControl/DoorSecurityModule/moduleStatus/capabilities
Query Parameter
None
Request Message
None
Response Message
<ModuleStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


test
</securityModuleNo>
<onlineStatus opt="0,1">
1
</onlineStatus>
<desmantelStatus opt="0,1">
1
</desmantelStatus>
</ModuleStatus>
21.20.7 Get the status of the secure door control unit

Request URL
GET /ISAPI/AccessControl/DoorSecurityModule/moduleStatus
Query Parameter
None
Request Message
None
Response Message
<ModuleStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


test
</securityModuleNo>
<onlineStatus opt="0,1">
1
</onlineStatus>
<desmantelStatus opt="0,1">
1
</desmantelStatus>
</ModuleStatus>
21.20.8 Get the capability of configuring the door lock status when the device is powered off
Request URL
GET /ISAPI/AccessControl/Configuration/lockType/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"LockTypeCap": {
/*ro, req, object, the capability of configuring the door lock status when the device is powered off*/
"status": {
/*ro, opt, object, door lock status when the device is powered off*/
"@opt": ["alwaysOpen", "alwaysClose"]
/*ro, req, array, options, subType:string*/
}
}
}
21.21 Capture Parameters Management

21.21.1 Get capture triggering parameters
Request URL
GET /ISAPI/AccessControl/SnapConfig
Query Parameter
None
Request Message
None
Response Message
<SnapConfig xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<snapTimes>
1
</snapTimes>
<snapWaitTime>
1
</snapWaitTime>
<intervalTimeList size="4">

<intervalTime>
1
</intervalTime>
</intervalTimeList>
<JPEGParam>
<pictureSize>
0xff
</pictureSize>
<pictureQuality>
best
</pictureQuality>
</JPEGParam>
</SnapConfig>
21.21.2 Set the capture triggering parameters

Request URL
PUT /ISAPI/AccessControl/SnapConfig
Query Parameter
None
Request Message

<snapTimes>
1
</snapTimes>
<snapWaitTime>
1
</snapWaitTime>

<intervalTime>
1
</intervalTime>
</intervalTimeList>
<JPEGParam>

<pictureSize>
0xff
</pictureSize>
<pictureQuality>
best
</pictureQuality>
<picSize>
</picSize>
</JPEGParam>
</SnapConfig>
Response Message


<requestURL>
null
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.21.3 Get capability of getting capture triggering parameters

Request URL
GET /ISAPI/AccessControl/SnapConfig/capabilities
Query Parameter
None
Request Message
None
Response Message

<snapTimes min="0" max="5">
1
</snapTimes>
<snapWaitTime min="0" max="6000">
1
</snapWaitTime>
<intervalTime min="0" max="6000">
1
</intervalTime>
</intervalTimeList>
<JPEGParam>
<pictureSize
opt="0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,75,78,79,80,82,127,128,161,162,163,164,165,166,167,168,180,181,182,183,
184,185,0xff">
0xff
</pictureSize>
<pictureQuality opt="best, better, general">
best
</pictureQuality>
</JPEGParam>
<isSupportSetSnapConfig>
true
</isSupportSetSnapConfig>
</SnapConfig>
21.22 Person and Credential Management

21.22.1 Get the configuration capability of fingerprint parameters
Request URL
GET /ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"FingerPrintCfg": {
/*ro, opt, object*/
"employeeNo": {
/*ro, req, object, employee No. (person ID) linked with the fingerprint*/
"@min": 1,
/*ro, opt, int, the minimum value*/
"@max": 32
/*ro, opt, int, the maximum value*/
},
"enableCardReader": {
/*ro, req, object, fingerprint module to apply fingerprint data to*/
"@min": 1,
"@max": 512
},
"fingerPrintID": {
/*ro, req, object, fingerprint No.*/
"@min": 1,
"@max": 10
},
"fingerType": {
/*ro, req, object, fingerprint type*/
"@opt": "normalFP"
/*ro, opt, enum, fingerprint type, subType:string, desc:"normalFP" (normal fingerprint), "hijackFP" (duress fingerprint), "patrolFP" (patrol
fingerprint), "superFP" (super fingerprint), "dismissingFP" (dismiss fingerprint)*/
},
"leaderFP": {
/*ro, opt, object, whether to support first time authentication function*/
"@min": 1,
"@max": 32
},
"checkEmployeeNo": "true,false",
/*ro, opt, string, whether to judge the existence of the employee No. (person ID)*/
"StatusList": {
/*ro, opt, object, status list*/
"id": {
/*ro, opt, object, fingerprint module No.*/
"@min": 1,
"@max": 512
},
"cardReaderRecvStatus": {
/*ro, opt, object, fingerprint module status*/
"@opt": "0,1,2,3,4,5,6,7,8,10"
/*ro, opt, string, fingerprint module status*/
},
"errorMsg": {
/*ro, opt, object, error information*/
"@min": 1,
"@max": 32
}
},
"totalStatus": {
/*ro, req, object, applying status*/
"@opt": "0,1"
/*ro, opt, string, 0-applying, 1-applied*/
},
"isSupportFingerCover": true,
/*ro, opt, bool, whether to support overwriting the original fingerprint when applying new fingerprint linked with the same person ID or employee
No. If it is supported, this node will be set to "true"; otherwise, this node will not be returned*/
"isSupportSetUp": true,
/*ro, opt, bool, whether to support setting fingerprint parameters. If it is supported, this node will be set to "true"; otherwise, this node will
not be returned*/
"maxRecordNum": 1,
/*ro, opt, int, range:[0,10000]*/
"isSupportCount": true
/*ro, opt, bool*/
}
}
21.22.2 Set the fingerprint parameters

Request URL
POST /ISAPI/AccessControl/FingerPrint/SetUp?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"FingerPrintCfg": {
/*opt, object, fingerprint parameters*/
"employeeNo": "test",
/*req, string, employee No. (person ID) linked with the fingerprint, range:[1,32]*/
"enableCardReader": [1, 3, 5],
/*req, array, fingerprint modules to apply fingerprint data to, subType:int, desc:[1,3,5] indicates applying fingerprint data to fingerprint modules
No.1, No.3, and No.5*/
"fingerPrintID": 1,
/*req, int, fingerprint No., range:[1,10]*/
"deleteFingerPrint": true,
/*opt, bool, whether to delete the fingerprint, desc:"true" (yes). This field is required only when the fingerprint needs to be deleted; for adding
or editing fingerprint information, it can be empty*/
"fingerType": "normalFP",
/*req, enum, fingerprint type, subType:string, desc:"normalFP" (normal fingerprint), "hijackFP" (duress fingerprint), "patrolFP" (patrol
fingerprint), "superFP" (super fingerprint),"dismissingFP" (dismiss fingerprint)*/
"fingerData": "test",
/*opt, string, fingerprint data, desc:it is encoded by Base64*/
"leaderFP": [1, 3, 5],
/*opt, array, whether the access control points support first fingerprint authentication function, subType:int, range:[1,5], desc:[1,3,5] indicates
that access control points No.1, No.3, and No.5 support first fingerprint authentication function*/
"checkEmployeeNo": true
/*opt, bool, whether to check the existence of the employee No. (person ID)*/
}
}
Response Message
{
"FingerPrintStatus": {
/*ro, opt, object, fingerprint status*/
"status": "success",
/*ro, opt, enum, status, subType:string, desc:"success", "failed". For applying fingerprint data to the fingerprint module, this field will not be
returned. This field will be returned only when editing fingerprint parameters or deleting fingerprints*/
"StatusList": [
/*ro, opt, array, status list, subType:object, desc:This field will be returned only when applying fingerprint data to the fingerprint module. For
editing fingerprint parameters or deleting fingerprints, this filed will not be returned*/
{
"id": 1,
/*ro, opt, int, fingerprint module No.*/
"cardReaderRecvStatus": 1,
/*ro, opt, enum, fingerprint module status, subType:int, desc:0 (connecting failed), 1 (connected), 2 (the fingerprint module is offline), 3
(the fingerprint quality is poor, try again), 4 (the memory is full), 5 (the fingerprint already exists), 6 (the fingerprint ID already exists), 7 (invalid
fingerprint ID), 8 (this fingerprint module is already configured), 10 (the fingerprint module version is too old to support the employee No.)*/
"errorMsg": "test"
/*ro, opt, string, error information, range:[1,32], desc:error information*/
}
]
}
}
21.22.3 Get the capability of clearing all pictures in the device

Request URL
GET /ISAPI/AccessControl/ClearPictureCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"ClearPictureCfgCap": {
/*ro, req, object, clear all pictures in the device*/
"ClearFlags": {
/*ro, opt, object, clear status*/
"facePicture": {
/*ro, opt, object, clear registered face pictures*/
/*ro, req, array, options, subType:bool*/
},
"capOrVerifyPicture": {
/*ro, opt, object, clear authenticated or captured face pictures*/
},
"irisPicture": {
/*ro, opt, object, clear registered iris pictures*/
}
}
}
}
21.22.4 Get the capability of deleting person information (including linked cards,
fingerprints, and faces) and permissions
Request URL
GET /ISAPI/AccessControl/UserInfoDetail/Delete/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"UserInfoDetail": {
/*ro, opt, object, user Information*/
"mode": {
/*ro, req, object*/
"@opt": "all,byEmployeeNo"
/*ro, opt, string, deleting mode, desc:all (delete all), byEmployeeNo (delete by employee No. (person ID))*/
},
"EmployeeNoList": {
/*ro, opt, object, person ID list, desc:person ID list*/
"maxSize": 50,
/*ro, opt, int*/
"employeeNo": {
/*ro, opt, object, employee No. (person ID)*/
"@min": 1,
"@max": 32
}
}
}
}
21.22.5 Add cards and link them with a person

Request URL
POST /ISAPI/AccessControl/CardInfo/Record?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"CardInfo": {
/*req, object, card information*/
/*req, string, employee No. (person ID)*/
"cardNo": "1234567890",
/*req, string, card No.*/
"cardType": "normalCard",
/*opt, enum, card type, subType:string, desc:card type*/
"leaderCard": "1,3,5",
/*opt, string, whether the access control points support first fingerprint authentication function, desc:whether the access control points support
first fingerprint authentication function*/
"checkCardNo": true,
/*opt, bool, whether to enable duplicated card verification, desc:whether to enable duplicated card verification*/
"checkEmployeeNo": true,
/*opt, bool, whether to check the existence of the employee No. (person ID), desc:whether to check the existence of the employee No. (person ID)*/
/*opt, string, operation mode*/
"terminalNoList": [1]
/*opt, array, terminal ID list, subType:int, desc:terminal ID list*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.22.6 Delete person information

Request URL
PUT /ISAPI/AccessControl/UserInfo/Delete?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"UserInfoDelCond": {
/*req, object, deleting conditions*/
"EmployeeNoList": [
/*opt, array, person ID list, subType:object*/
{
"employeeNo": "test"
/*req, string, employee No. (person ID), range:[1,32]*/
}
],
/*opt, string, operation type*/
/*opt, array, terminal ID list, subType:int, desc:terminal ID list*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
/*ro, opt, string, error information, desc:this field is required when statusCode is not 1*/
}
21.22.7 Get the capabilities of applying person data asynchronously

Request URL
GET /ISAPI/AccessControl/UserInfo/asyncImportDatasTasks/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AsyncImportDatasCap": {
/*ro, req, object*/
"taskID": {
/*ro, req, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 64
/*ro, opt, int*/
},
"taskNum": 1,
/*ro, req, int*/
"URL": {
/*ro, req, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 256
/*ro, opt, int*/
},
"singleFileMaxSize": 1,
/*ro, req, int*/
"employeeNo": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 32
/*ro, opt, int*/
},
"deleteUser": {
/*ro, opt, object*/
/*ro, opt, array, subType:bool*/
},
"name": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 32
/*ro, opt, int*/
},
"userType": {
/*ro, opt, object*/
"@opt": ["normal", "visitor", "blackList"]
},
"Valid": {
/*ro, opt, object*/
"enable": {
/*ro, opt, object*/
},
"beginTime": "1970-01-01T00:00:00+08:00",
/*ro, opt, string*/
"endTime": "2037-12-31T23:59:59+08:00"
/*ro, opt, string*/
},
"password": {
/*ro, opt, object*/
"@min": 8,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
},
"RightPlan": {
/*ro, opt, object*/
"doorNo": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"planTemplateNo": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"planTemplateNum": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
}
},
"localUIRight": {
/*ro, opt, object*/
},
"userVerifyMode": {
/*ro, opt, object*/
"@opt": ["cardAndPw", "card", "cardOrPw", "fp", "fpAndPw", "fpOrCard", "fpAndCard", "fpAndCardAndPw", "faceOrFpOrCardOrPw", "faceAndFp",
"faceAndPw", "faceAndCard", "face", "employeeNoAndPw", "fpOrPw", "employeeNoAndFp", "employeeNoAndFpAndPw", "faceAndFpAndCard", "faceAndPwAndFp",
"employeeNoAndFace", "faceOrfaceAndCard", "fpOrface", "cardOrfaceOrPw", "cardOrFace", "cardOrFaceOrFp"]
},
"AccessControl": {
/*ro, opt, object*/
"doorRightNum": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"closeDelayEnabled": {
/*ro, opt, object*/
},
"belongGroupNo": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"belongGroupNum": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"maxOpenDoorTime": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"openDoorTime": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"roomNumber": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"floorNumber": {
/*ro, opt, object*/
"@min": 1,
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
}
},
"FaceInfo": {
/*ro, opt, object*/
"deleteAllFace": {
/*ro, opt, object*/
},
"List": {
/*ro, opt, object*/
"FDID": "test",
/*ro, opt, string*/
"faceID": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"deleteFace": {
/*ro, opt, object*/
},
"isSupportModelData": true
/*ro, opt, bool*/
}
},
"CardInfo": {
/*ro, opt, object*/
"deleteAllCard": {
/*ro, opt, object*/
},
"List": {
/*ro, opt, object*/
"cardNo": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 32
/*ro, opt, int*/
},
"deleteCard": {
/*ro, opt, object*/
},
"cardType": {
/*ro, opt, object*/
"@opt": ["normalCard", "patrolCard", "hijackCard", "superCard", "dismissingCard", "emergencyCard"]
},
"AccessControl": {
/*ro, opt, object*/
"leaderCardNum": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
}
},
"numberPerPerson": 50
}
},
"FPInfo": {
/*ro, opt, object*/
"deleteAllFP": {
/*ro, opt, object*/
},
"List": {
/*ro, opt, object*/
"fingerID": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 10
/*ro, opt, int*/
},
"deleteFP": {
/*ro, opt, object*/
},
},
"enableCardReaderNo": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"enableCardReaderNum": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"fingerType": {
/*ro, opt, object*/
"@opt": ["normalFP", "hijackFP", "patrolFP", "superFP", "dismissingFP"]
},
"fingerData": {
/*ro, opt, object*/
"@opt": [768]
/*ro, opt, array, subType:int*/
},
"AccessControl": {
/*ro, opt, object*/
"leaderFPNum": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
}
}
}
}
}
}
21.22.8 Get the card management capability

Request URL
GET /ISAPI/AccessControl/CardInfo/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"CardInfo": {
/*ro, opt, object, card information*/
"supportFunction": {
/*ro, req, object, supported functions, desc:"post"-add, "delete", "put"-edit, "get"-search, "setUp"-set*/
"@opt": "post, delete, put, get, setUp"
/*ro, req, string*/
},
"CardInfoSearchCond": {
/*ro, opt, object, search condition*/
"searchID": {
/*ro, opt, object, search ID*/
"@min": 1,
"@max": 36
},
"maxResults": {
/*ro, req, object, the maximum number of search results this time by calling this URI*/
"@min": 1,
"@max": 30
},
"EmployeeNoList": {
/*ro, opt, object, person ID list*/
"maxSize": 56,
"employeeNo": {
"@min": 1,
"@max": 32
}
},
"CardNoList": {
/*ro, opt, object, card No. list*/
"maxSize": 56,
"cardNo": {
/*ro, opt, object, card No.*/
"@min": 1,
"@max": 32
}
}
},
"CardInfoDelCond": {
/*ro, opt, object, deleting condition*/
"EmployeeNoList": {
"maxSize": 56,
"employeeNo": {
"@min": 1,
"@max": 32
}
},
"CardNoList": {
/*ro, opt, object, card No. list*/
"maxSize": 56,
"cardNo": {
"@min": 1,
"@max": 32
}
}
},
"cardNo": {
/*ro, req, object, card No.*/
"@min": 1,
"@max": 32
},
"employeeNo": {
/*ro, req, object, employee No. (person ID)*/
"@min": 1,
"@max": 32
},
"cardType": {
/*ro, req, object, card type*/
"@opt": "normalCard, patrolCard, hijackCard, superCard, dismissingCard, emergencyCard"
/*ro, req, string*/
},
"leaderCard": {
/*ro, opt, object, whether it supports first card authentication function*/
"@min": 1,
"@max": 32
},
"checkCardNo": "true,false",
/*ro, opt, string, whether to enable duplicated card verification, desc:"false"-disable, "true"-enable. If this node is not configured, the device
will verify the duplicated card by default this node is used for speeding up applying card information (by setting the value to "false"). It is not
recommended to configure this node*/
"checkEmployeeNo": "true,false",
/*ro, opt, string, whether to check the existence of the employee No. (person ID), desc:"false"-no, "true"-yes. If this node is not configured, the
device will check the existence of the employee No. (person ID) by default. This node is used for speeding up applying card information (by setting the
value to "false"). It is not recommended to configure this node*/
"maxRecordNum": 10000,
/*ro, opt, int, maximum number of records (cards) allowed, desc:supported maximum number of records (card records)*/
"numberPerPerson": 50
}
}
21.22.9 whether to delete card information

Request URL
PUT /ISAPI/AccessControl/CardInfo/Delete?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"CardInfoDelCond": {
/*req, object*/
"EmployeeNoList": [
{
/*opt, string, employee No. (person ID)*/
}
],
"CardNoList": [
/*opt, array, card No. list, subType:object, desc:(this node cannot exist together with the EmployeeNoList, and if this node does not exist or is
set to NULL, it indicates deleting all cards)*/
{
"cardNo": "1234567890"
/*opt, string, card No.*/
}
],
/*opt, enum, operation type, subType:string, desc:"byTerminal"-by terminal*/
/*opt, array, terminal ID list, this node is required when operation type is "byTerminal"; currently, only one terminal is supported, subType:int*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.22.10 Get the total number of the added persons

Request URL
GET /ISAPI/AccessControl/UserInfo/Count?format=json
Query Parameter
None
Request Message
None
Response Message
{
"UserInfoCount": {
/*ro, req, object*/
"userNumber": 100,
/*ro, req, int, number of persons*/
"bindFaceUserNumber": 100,
/*ro, opt, int*/
"bindFingerprintUserNumber": 100,
/*ro, opt, int*/
"bindCardUserNumber": 100,
/*ro, opt, int*/
"bindIrisUserNumber": 100
/*ro, opt, int*/
}
}
21.22.11 Edit person information

Request URL
PUT /ISAPI/AccessControl/UserInfo/Modify?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"UserInfo": {
/*req, object, person information*/
"name": "test",
/*opt, string, name*/
"userType": "normal",
/*opt, enum, person type, subType:string*/
"closeDelayEnabled": true,
/*opt, bool, whether to enable door close delay*/
"Valid": {
/*opt, object, parameters of the effective period,the effective period can be a period of time between 1970-01-01 00:00:00 and 2037-12-31 23:59:59*/
"enable": true,
/*opt, bool, whether to enable validity period*/
"beginTime": "2017-08-01T17:30:08+08:00",
/*opt, datetime, start time of the effective period, desc:if timeType does not exist or is "local", the beginTime is the device local time,
e.g., 2017-08-01T17:30:08; if timeType is "UTC", the beginTime is UTC time, e.g., 2017-08-01T17:30:08+08:00*/
"endTime": "2017-08-01T17:30:08+08:00",
/*opt, datetime, end time of the effective period, desc:if timeType does not exist or is "local", the endTime is the device local time, e.g.,
2017-08-01T17:30:08; if timeType is "UTC", the endTime is UTC time, e.g., 2017-08-01T17:30:08+08:00*/
"timeType": "local"
/*opt, enum, time type, subType:string, desc:"local" (device local time), "UTC" (UTC time)*/
},
"belongGroup": "1,3,5",
/*opt, string, group*/
"password": "123456",
/*opt, string, password*/
"doorRight": "1,3",
/*opt, string, door permission*/
"RightPlan": [
/*opt, array, door permission schedule (lock permission schedule), subType:object*/
{
"doorNo": 1,
/*opt, int, door No. (lock ID)*/
"planTemplateNo": "1,3,5"
/*opt, string, schedule template No., desc:schedule template No.*/
}
],
"maxOpenDoorTime": 0,
/*opt, int, maximum authentication attempts, desc:0-unlimited*/
"roomNumber": 123,
/*opt, int, room No.*/
"floorNumber": 1,
/*opt, int, floor No.*/
"doubleLockRight": true,
/*opt, bool, whether to have the permission to open the double-locked door*/
"localUIRight": true,
/*opt, bool, whether to have the permission to access the device local UI*/
"userVerifyMode": "card",
/*opt, enum, person authentication mode, subType:string,
desc:the person authentication mode is prior to the card reader authentication modeperson authentication mode
"cardAndPw” (card + password), "card” (card), "cardOrPw” (card or password), "fp” (fingerprint), "fpAndPw” (fingerprint + password), "fpOrCard”
"cardAndPw” (card + password), "card” (card), "cardOrPw” (card or password), "fp” (fingerprint), "fpAndPw” (fingerprint + password), "fpOrCard”
(fingerprint or card), "fpAndCard” (fingerprint + card), "fpAndCardAndPw” (fingerprint + card + password), "faceOrFpOrCardOrPw” (face or fingerprint or card
or password), "faceAndFp” (face + fingerprint), "faceAndPw” (face + password), "faceAndCard” (face + card), "face” (face), "employeeNoAndPw” (employee No. +
password), "fpOrPw” (fingerprint or password), "employeeNoAndFp” (employee No. + fingerprint), "employeeNoAndFpAndPw” (employee No. + fingerprint +
password), "faceAndFpAndCard” (face + fingerprint + card), "faceAndPwAndFp” (face + password + fingerprint), "employeeNoAndFace” (employee No. + face),
"faceOrfaceAndCard” (face or face + card), "fpOrface” (fingerprint or face), "cardOrfaceOrPw” (card or face or password), "cardOrFace” (card or face),
"cardOrFaceOrFp” (card or face or fingerprint), "cardOrFpOrPw” (card or fingerprint or password)*/
"checkUser": true,
/*opt, bool, whether to verify the duplicated person information, desc:"false"-no, "true"-yes. If checkUser is not configured, the device will
verify the duplicated person information by default. When there is no person information, you can set checkUser to "false" to speed up data applying;
otherwise, it is not recommended to configure this node*/
"gender": "male",
/*opt, enum, gender of the person in the face picture, subType:string, desc:"male", "female", "unknown"*/
"PersonInfoExtends": [
/*opt, array, extended fields for the additional person information, subType:object, desc:this node is used to configure the extended person
information displayed on the device's UI. For MinMoe series facial recognition terminals, currently only one value node can be supported for displaying the
employee No. and the node id is not supported*/
{
"id": 1,
/*opt, int, extended ID of the additional person information, range:[1,32], desc:it corresponds to the id in the message of the request URI
/ISAPI/AccessControl/personInfoExtendName?format=json and is used to link the value of the node value and its name (the node name in the message of the
request URI /ISAPI/AccessControl/personInfoExtendName?format=json). If the node id does not exist, the ID will start from 1 by default according to the
array order*/
"value": "test"
/*opt, string, extended content of the additional person information*/
}
],
"dynamicCode": "123456",
/*opt, string, dynamic permission code*/
"callNumbers": ["1-1-1-401"],
/*opt, array, room No. list to be called, subType:string, desc:it is extended from roomNumber; for standard SIP; it can be the SIP number*/
"floorNumbers": [1, 2],
/*opt, array, floor No. list, subType:int, desc:it is extended from floorNumber*/
"groupId": 1,
/*opt, int*/
"localAtndPlanTemplateId": 1,
/*opt, int*/
/*opt, string, operation type, desc:"byTerminal"-by terminal*/
/*opt, array, terminal ID list, subType:int, desc:this node is required when operation type is "byTerminal"; currently, only one terminal is
supported*/
"groupName": "test",
/*opt, string, range:[1,64]*/
"age": 0,
/*opt, int, age, range:[0,120]*/
"PatientInfos": {
/*opt, object*/
"deviceID": "test",
/*opt, string*/
"admissionTime": "1970-01-01T00:00:00+08:00",
/*opt, datetime*/
"chargeNurse": "test",
"chargeDoctor": "test",
"nursingLevel": "tertiary",
"doctorsAdvice": "test",
"allergicHistory": "test"
},
"ESDType": "handAndFoot",
"userLevel": "Employee",
"userName": "test",
"loginPassword": "test"
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
/*ro, opt, int, error code, desc:it is required when the value of statusCode is not 1, and it corresponds to subStatusCode*/
"errorMsg": "ok"
}
21.22.12 Get the status of a specified task of applying person pictures asynchronously
Request URL
GET /ISAPI/AccessControl/UserPic/asyncImportDatasTasks/<taskID>/status?format=json
Query Parameter
taskID string --
Request Message
None
Response Message
{
"AsyncImportDatasTask": {
/*ro, req, object*/
"taskID": "test",
/*ro, req, string, range:[1,64]*/
"URL": "test",
"status": 1,
/*ro, req, enum, subType:int*/
"totalNum": 1,
/*ro, opt, int*/
"successNum": 1,
/*ro, opt, int*/
"failedNum": 1
/*ro, opt, int*/
}
}
21.22.13 Start deleting all person information (including linked cards, fingerprints, and
faces) and permissions by employee No.
Request URL
PUT /ISAPI/AccessControl/UserInfoDetail/Delete?format=json
Query Parameter
None
Request Message
{
"UserInfoDetail": {
/*opt, object, user Information*/
"mode": "all",
/*req, enum, deleting mode, subType:string, desc:deleting mode*/
"EmployeeNoList": [
{
/*opt, string, employee No.*/
}
],
/*opt, enum, operation mode, subType:string, desc:"byTerminal" (by terminal), "byOrg" (by organization), "byTerminalOrg" (by terminal
organization)*/
"terminalNoList": [1, 2, 3, 4],
/*opt, array, terminal list, subType:int, dep:and,{$.UserInfoDetail.operateType,eq,byTerminal}*/
"orgNoList": [1, 2, 3, 4]
/*opt, array, organization list, subType:int, dep:or,{$.UserInfoDetail.operateType,eq,byOrg},{$.UserInfoDetail.operateType,eq,byTerminalOrg}*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.22.14 Add a person

Request URL
POST /ISAPI/AccessControl/UserInfo/Record?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"UserInfo": {
"name": "test",
/*opt, string, person name*/
/*req, enum, person type, subType:string, desc:"normal" (normal person (household)), "visitor", "blackList" (person in blocklist), "maintenance"
(maintenance persons including cleaners, repairmen, etc. )*/
/*opt, bool, whether to enable door close delay*/
"Valid": {
/*req, object, parameters of the effective period,the effective period can be a period of time between 1970-01-01 00:00:00 and 2037-12-31 23:59:59*/
"enable": true,
/*req, bool, whether to enable validity period*/
"beginTime": "2017-08-01T17:30:08+08:00",
/*req, datetime, start time of the effective period, desc:if timeType does not exist or is "local", the beginTime is the device local time,
e.g., 2017-08-01T17:30:08; if timeType is "UTC", the beginTime is UTC time, e.g., 2017-08-01T17:30:08+08:00*/
"endTime": "2017-08-01T17:30:08+08:00",
/*req, datetime, end time of the effective period, desc:if timeType does not exist or is "local", the endTime is the device local time, e.g.,
2017-08-01T17:30:08; if timeType is "UTC", the endTime is UTC time, e.g., 2017-08-01T17:30:08+08:00*/
"timeType": "local"
/*opt, enum, time type, subType:string, desc:"local" (device local time), "UTC" (UTC time)*/
},
"password": "123456",
"doorRight": "1,3",
/*opt, string, door permission*/
"RightPlan": [
{
"doorNo": 1,
}
],
/*opt, int, maximum authentication attempts, desc:0-unlimited*/
"roomNumber": 123,
"floorNumber": 1,
/*opt, bool, whether to have the permission to open the double-locked door*/
/*opt, bool, whether to have the permission to access the device local UI*/
/*opt, enum, person authentication mode, subType:string, desc:"cardAndPw" (card+password), "card" (card), "cardOrPw" (card or password), "fp"
(fingerprint), "fpAndPw" (fingerprint+password), "fpOrCard" (fingerprint or card), "fpAndCard" (fingerprint+card), "fpAndCardAndPw"
(fingerprint+card+password), "faceOrFpOrCardOrPw" (face or fingerprint or card or password), "faceAndFp" (face+fingerprint), "faceAndPw" (face+password),
"faceAndCard" (face+card), "face" (face), "employeeNoAndPw" (employee No.+password), "fpOrPw" (fingerprint or password), "employeeNoAndFp" (employee
No.+fingerprint), "employeeNoAndFpAndPw" (employee No.+fingerprint+password), "faceAndFpAndCard" (face+fingerprint+card), "faceAndPwAndFp"
(face+password+fingerprint), "employeeNoAndFace" (employee No.+face), "faceOrfaceAndCard" (face or face+card), "fpOrface" (fingerprint or face),
"cardOrfaceOrPw" (card or face or password), "iris" (iris), "faceOrFpOrCardOrPwOrIris" (face, fingerprint, card, password, or iris), "faceOrCardOrPwOrIris"
(face, card, password, or iris). The person authentication mode is prior to the card reader authentication mode*/
"checkUser": true,
/*opt, bool, whether to verify the duplicated person information, desc:"false"-no, "true"-yes. If checkUser is not configured, the device will
"gender": "male",
/*opt, array, extended fields for the additional person information, subType:object, desc:This node is used to configure the extended person
{
"id": 1,
/*opt, int, extended ID of the additional person information, range:[1,32], desc:it corresponds to the id in the message of the request URI
array order*/
"value": "test"
}
],
/*opt, string, operation type, desc:"byTerminal"-by terminal*/
supported*/
"callNumbers": ["1-1-1-401"],
/*opt, array, room No. list to be called, subType:string, desc:it is extended from roomNumber; for standard SIP, it can be the SIP number*/
/*opt, array, floor No. list, subType:int, desc:it is extended from floorNumber*/
"groupId": 1,
/*opt, int*/
/*opt, int*/
"age": 0,
/*opt, int, age, range:[0,120]*/
"PatientInfos": {
/*opt, object*/
"deviceID": "test",
/*opt, string*/
"admissionTime": "1970-01-01T00:00:00+08:00",
/*opt, datetime*/
},
"userName": "test",
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.22.15 Set person information

Request URL
PUT /ISAPI/AccessControl/UserInfo/SetUp?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"UserInfo": {
"deleteUser": true,
/*opt, bool, whether to delete the person*/
"name": "test",
/*opt, string, person name*/
/*req, enum, person type, subType:string*/
/*opt, bool, whether to enable door close delay, desc:true (yes), false (no)*/
"Valid": {
/*req, object, the parameters of the effective period, desc:If this node is set to "false", the effective period is permanent. The effective period
can be a period of time between 1970-01-01 00:00:00 and 2037-12-31 23:59:59*/
"enable": true,
/*req, bool, whether to enable the effective period, desc:true (yes), false (no)*/
"beginTime": "test",
/*req, string, start date of the effective period, desc:start time of the effective period (if timeType does not exist or is "local",the
beginTime is the device local time,e.g.,2017-08-01T17:30:08; if timeType is "UTC",the beginTime is UTC time,e.g.,2017-08-01T17:30:08+08:00)*/
"endTime": "test",
/*req, string, end time of effective period, desc:end time of the effective period (if timeType does not exist or is "local",the endTime is the
device local time,e.g.,2017-08-01T17:30:08; if timeType is "UTC",the endTime is UTC time,e.g.,2017-08-01T17:30:08+08:00)*/
"timeType": "local"
/*opt, enum, time type, subType:string, desc:"local” (device local time), "UTC” (UTC time)*/
},
"password": "123456",
"doorRight": "1,3",
/*opt, string, No. of the door or lock that has access permission, desc:e.g., "1,3" indicates having permission to access door (lock) No. 1 and No.
3*/
"RightPlan": [
{
"doorNo": 1,
}
],
/*opt, int, the maximum authentication attempts*/
"roomNumber": 123,
"floorNumber": 1,
/*opt, bool, whether to have the permission to open the double-locked door, desc:true (yes), false (no)*/
/*opt, bool, whether to have the permission to access the device local UI: "true"-yes,"false"-no, desc:whether to have the permission to access the
device local UI: "true"-yes,"false"-no*/
/*opt, enum, person authentication mode, subType:string, desc:"cardAndPw” (card+password), "card” (card), "cardOrPw” (card or password), "fp”
(fingerprint), "fpAndPw” (fingerprint+password), "fpOrCard” (fingerprint or card), "fpAndCard” (fingerprint+card), "fpAndCardAndPw”
(fingerprint+card+password), "faceOrFpOrCardOrPw” (face or fingerprint or card or password), "faceAndFp” (face+fingerprint), "faceAndPw” (face+password),
"faceAndCard” (face+card), "face” (face), "employeeNoAndPw” (employee No.+password), "fpOrPw” (fingerprint or password), "employeeNoAndFp” (employee
No.+fingerprint), "employeeNoAndFpAndPw” (employee No.+fingerprint+password), "faceAndFpAndCard” (face+fingerprint+card), "faceAndPwAndFp”
(face+password+fingerprint), "employeeNoAndFace” (employee No.+face), "faceOrfaceAndCard” (face or face+card), "fpOrface” (fingerprint or face),
"cardOrfaceOrPw” (card or face or password), "cardOrFace” (card or face), "cardOrFaceOrFp” (card or face or fingerprint), "cardOrFpOrPw” (card or
fingerprint or password); the priority of the person authentication mode is higher than that of the card reader authentication mode*/
"checkUser": true,
/*opt, bool, whether to verify the duplicated person information, desc:false (no), true (yes). If checkUser is not configured, the device will
"gender": "male",
/*opt, array, extended fields for the additional person information, subType:object, desc:this node is used to configure the extended person
{
"id": 1,
"id": 1,
/*opt, int, extended ID of the additional person information, range:[1,32], desc:It corresponds to the id in the message of the request URI
array order*/
"value": "test"
}
],
"callNumbers": ["1-1-1-401"],
/*opt, array, room No. list to be called, subType:string, desc:this node is extended from roomNumber; for standard SIP, it can be the SIP number*/
/*opt, array, floor No. list, subType:int, desc:this node is extended from floorNumber*/
"groupId": 1,
/*opt, int*/
/*opt, int*/
"userName": "test",
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
/*ro, opt, string, error details, desc:this node is required when statusCode is not 1*/
}
21.22.16 Edit card information

Request URL
PUT /ISAPI/AccessControl/CardInfo/Modify?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"CardInfo": {
/*req, object, card information*/
"cardNo": "1234567890",
/*opt, enum, card type, subType:string, desc:card type*/
/*opt, string, whether to support first card authentication function, desc:e.g., the value "1, 3, 5" indicates that the access control points No.1,
No.3, and No.5 support first card authentication function*/
/*opt, string, operation type*/
supported*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
/*ro, opt, string, error information, desc:this node is required when the value of statusCode is not 1*/
}
21.22.17 Set card information

Request URL
PUT /ISAPI/AccessControl/CardInfo/SetUp?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"CardInfo": {
/*opt, object, card information*/
"cardNo": "1234567890",
"deleteCard": true,
/*opt, bool, whether to delete the card, desc:true (yes). This node is required only when the card needs to be deleted; for adding or editing card
information, this node can be set to NULL*/
/*req, enum, card type, subType:string, desc:normalCard (normal card), patrolCard (patrol card), hijackCard (duress card), superCard (super card),
dismissingCard (dismiss card), emergencyCard (emergency card: it is used to assign permission to a temporary card, but it cannot open the door)*/
/*opt, string, whether to support first card authentication function, desc:e.g., the value "1, 3, 5" indicates that the access control points No.1,
No.3, and No.5 support first card authentication function*/
"checkCardNo": true,
/*opt, bool, whether to enable duplicated card verification, desc:false (disable), true (enable). If this node is not configured, the device will
verify the duplicated card by default. When there is no card information, you can set checkCardNo to "false" to speed up data applying; otherwise, it is not
recommended to configure this node*/
"checkEmployeeNo": true
/*opt, bool, whether to check the existence of the employee No. (person ID), desc:"false"-no, "true"-yes. If this node is not configured, the device
will check the existence of the employee No. (person ID) by default. This node is used for speeding up applying card information (by setting the value to
"false"). It is not recommended to configure this node*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.22.18 Search for person information

Request URL
POST /ISAPI/AccessControl/UserInfo/Search?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"UserInfoSearchCond": {
/*req, object, search condition*/
"searchID": "123",
/*req, string, search ID, desc:it is used to confirm the upper-level platform or system. If the platform or the system is the same one during two
searching, the search history will be saved in the memory to speed up next searching*/
"searchResultPosition": 0,
/*req, int, the start position of the search result in the result list, desc:in a single search, if you cannot get all the records in the result
list, you can mark the end position and get the following records after the marked position in the next search*/
"maxResults": 30,
/*req, int, the maximum number of search results, desc:if maxResults exceeds the range returned by the device capability, the device will return the
maximum number of search results according to the device capability and will not return error message*/
"EmployeeNoList": [
{
/*req, string, employee ID*/
}
],
"fuzzySearch": "test",
/*opt, string, fuzzy search by key words*/
"groupIdList": [1, 2, 3, 4],
/*opt, array, subType:int*/
"arrangeType": "personal",
/*opt, enum, person type, subType:string*/
"deviceIDList": [1, 2],
"hasFace": true,
/*opt, bool*/
"hasCard": true,
/*opt, bool*/
"hasFingerprint": true,
/*opt, bool*/
"hasIris": true
/*opt, bool*/
}
}
Response Message
{
"UserInfoSearch": {
/*ro, req, object, search results*/
"searchID": "test",
/*ro, req, string, search ID*/
"responseStatusStrg": "OK",
/*ro, req, enum, search status, subType:string, desc:"OK" (searching completed), "NO MATCH" (no matched results), "MORE" (searching for more
results)*/
"numOfMatches": 1,
/*ro, req, int, number of results returned this time*/
"totalMatches": 1,
/*ro, req, int, total number of matched results*/
"UserInfo": [
/*ro, opt, array, person information, subType:object*/
{
/*ro, req, string, employee ID (person ID)*/
"name": "test",
/*ro, opt, string, name*/
/*ro, req, enum, person type, subType:string, desc:"normal" (normal person (house owner)), "visitor", "blockList" (person in blocklist),
"patient", "maintenance" (maintenance person)*/
/*ro, opt, bool, whether to enable door close delay*/
"Valid": {
/*ro, opt, object, effective period parameters*/
"enable": true,
/*ro, req, bool, whether to enable effective period*/
/*ro, req, string, start time of the effective period, desc:start time of the effective period (if timeType does not exist or is
"local",the beginTime is the device local time,e.g.,2017-08-01T17:30:08; if timeType is "UTC",the beginTime is UTC time,e.g.,2017-08-01T17:30:08+08:00)*/
"endTime": "test",
/*ro, req, string, end time of the effective period, desc:end time of the effective period (if timeType does not exist or is "local",the
endTime is the device local time,e.g.,2017-08-01T17:30:08; if timeType is "UTC",the endTime is UTC time,e.g.,2017-08-01T17:30:08+08:00)*/
"timeType": "test"
/*ro, opt, string, time type*/
},
/*ro, opt, string, group*/
"password": "123456",
/*ro, opt, string, password*/
"doorRight": "1,3",
/*ro, opt, string, No. of door or lock that has access permission, desc:"1,3" indicates having permission to access door (lock) No. 1 and
No. 3*/
"RightPlan": [
/*ro, opt, array, access permission schedule of the door or lock, subType:object*/
{
"doorNo": 1,
/*ro, opt, int, door No. (lock ID)*/
/*ro, opt, string, schedule template No., desc:schedule template No.*/
}
],
/*ro, opt, int, the maximum number of authentication attempts*/
"openDoorTime": 0,
/*ro, opt, int, number of authenticated attempts*/
"roomNumber": 123,
/*ro, opt, int, room No.*/
"floorNumber": 1,
/*ro, opt, int, floor No.*/
/*ro, opt, bool, whether to have the permission to open the double-locked door, desc:whether to have the permission to open the double-
locked door: "true"-yes,"false"-no*/
/*ro, opt, bool, whether to have the permission to access the device local UI, desc:whether to have the permission to access the device
local UI: "true"-yes,"false"-no*/
/*ro, opt, enum, person authentication mode, subType:string, desc:"cardAndPw" (card+password), "card" (card), "cardOrPw" (card or password),
"fp" (fingerprint), "fpAndPw" (fingerprint+password), "fpOrCard" (fingerprint or card), "fpAndCard" (fingerprint+card), "fpAndCardAndPw"
"cardOrfaceOrPw" (card or face or password), "cardOrFace" (card or face), "cardOrFaceOrFp" (card or face or fingerprint), "cardOrFpOrPw" (card or
fingerprint or password), the priority of the person authentication mode is higher than that of the card reader authentication mode*/
/*ro, opt, string, dynamic permission code*/
"callNumbers": ["1-1-1-401"],
/*ro, opt, array, list of call No., subType:string, desc:this node is the extension of roomNumber*/
/*ro, opt, array, list of floor No., subType:int, desc:this node is the extension of floorNumber*/
"groupId": 1,
/*ro, opt, int*/
/*ro, opt, int*/
"numOfFace": 0,
/*ro, opt, int, number of linked face pictures, desc:if this node is not returned, it indicates that device does not support this function*/
"numOfFP": 0,
/*ro, opt, int, number of linked fingerprints, desc:if this node is not returned, it indicates that device does not support this function*/
"numOfCard": 0,
/*ro, opt, int, number of linked cards, desc:if this node is not returned, it indicates that device does not support this function*/
"numOfIris": 0,
/*ro, opt, int*/
"gender": "male",
/*ro, opt, enum, gender of the person in the face picture, subType:string, desc:"male", "female", "unknown"*/
/*ro, opt, array, person extension information, subType:object, desc:this node is used to configure the extended person information
displayed on the device's UI. For MinMoe series facial recognition terminals, currently only one value node can be supported for displaying the employee No.
and the node id is not supported*/
{
"id": 1,
/*ro, opt, int, serial No. of person extension information, range:[1,32], desc:it corresponds to the id in the message of the
request URI /ISAPI/AccessControl/personInfoExtendName?format=json and is used to link the value of the node value and its name. If the node id does not
exist, the ID will start from 1 by default according to the array order*/
"value": "test"
/*ro, opt, string, extended content of the additional person information*/
}
],
"age": 0,
/*ro, opt, int, age, range:[0,120]*/
"PatientInfos": {
/*ro, opt, object*/
"deviceID": "test",
/*ro, opt, string*/
"admissionTime": "1970-01-01T00:00:00+08:00",
/*ro, opt, datetime*/
},
"TromboneRule": {
/*ro, opt, object*/
"industryType": "builidings",
"unitType": "indoor",
"SIPVersion": "V10"
},
"userName": "test"
}
]
}
}
21.22.19 Get the person management capability

Request URL
GET /ISAPI/AccessControl/UserInfo/capabilities?format=json&terminalNo=<terminalNo>
Query Parameter
terminalNo string --
Request Message
None
Response Message
{
"UserInfo": {
/*ro, req, object, person information*/
"supportFunction": {
/*ro, req, object, supported function of adding, deleting, editing, searching for person information, and getting total number of the added
persons*/
"@opt": "post,delete,put,get,setUp"
/*ro, opt, string, desc:"post” (add), "delete", "put” (edit), "get” (search), "setUp” (set)*/
},
"UserInfoSearchCond": {
/*ro, opt, object, search conditions*/
"maxResults": {
/*ro, req, object, the maximum number of search results this time by calling this URI*/
"@min": 1,
/*ro, opt, int, the minimum value among elements of the array*/
"@max": 100
/*ro, opt, int, the maximum value among elements of the array*/
},
"EmployeeNoList": {
"maxSize": 56,
/*ro, opt, int, range of members in the array*/
"employeeNo": {
"@min": 1,
"@max": 32
}
},
"fuzzySearch": {
/*ro, opt, object, fuzzy search by key words*/
"@min": 1,
"@max": 32
},
"isSupportNumOfFace": true,
/*ro, opt, bool, whether it supports number of linked face pictures when searching*/
"isSupportNumOfFP": true,
/*ro, opt, bool, whether it supports number of linked fingerprints when searching*/
"isSupportNumOfCard": true,
/*ro, opt, bool, whether it supports number of linked cards when searching*/
"groupIdList": {
/*ro, opt, object*/
"@size": 1,
/*ro, req, int*/
"@min": 1,
/*ro, req, int*/
"@max": 1
/*ro, req, int*/
},
"arrangeType": {
/*ro, opt, object*/
"@opt": ["personal"]
/*ro, req, array, subType:string*/
},
"userType": {
/*ro, opt, object, person type*/
"@opt": ["normal", "visitor", "blackList", "patient", "maintenance"]
},
"deviceIDList": {
/*ro, opt, object*/
"@min": 1,
"@max": 512
},
"hasFace": {
/*ro, opt, object*/
/*ro, req, array, subType:bool*/
},
"hasCard": {
/*ro, opt, object*/
},
"hasFingerprint": {
/*ro, opt, object*/
},
"hasIris": {
/*ro, opt, object*/
}
},
"UserInfoDelCond": {
/*ro, opt, object, deleting conditions*/
"EmployeeNoList": {
"maxSize": 56,
"employeeNo": {
"@min": 1,
"@max": 32
}
}
},
"employeeNo": {
/*ro, req, object, employee No. (person ID)*/
"@min": 1,
"@max": 32
},
"name": {
/*ro, opt, object, name*/
"@min": 1,
"@max": 128
},
"userType": {
/*ro, req, object, person type*/
"@opt": "normal,visitor,blackList"
/*ro, opt, string*/
},
"closeDelayEnabled": "true,false",
/*ro, opt, string, whether to enable door close delay*/
"Valid": {
/*ro, req, object, parameters of the validity period*/
"enable": "true,false",
/*ro, req, string, whether to enable validity period*/
"beginTime": {
/*ro, req, object, start time of the effective period (if timeType does not exist or is "local", the beginTime is the device local time, e.g., :
2017-08-01T17:30:08; if timeType is "UTC", the beginTime is UTC time, e.g.,: 2017-08-01T17:30:08+08:00)*/
"@min": 1,
"@max": 32
},
"endTime": {
/*ro, req, object, end time of the effective period (if timeType does not exist or is "local", the endTime is the device local time, e.g.,:
/*ro, req, object, end time of the effective period (if timeType does not exist or is "local", the endTime is the device local time, e.g.,:
2017-08-01T17:30:08; if timeType is "UTC", the endTime is UTC time, e.g.,: 2017-08-01T17:30:08+08:00)*/
"@min": 1,
"@max": 32
},
"timeRangeBegin": "1970-01-01T00:00:00",
/*ro, opt, string, start time that can be configured for beginTime, desc:if the device does not return this node, the default start time that
can be configured for beginTime is "1970-01-01T00:00:00"*/
"timeRangeEnd": "2037-12-31T23:59:59",
/*ro, opt, string, end time that can be configured for endTime, desc:if the device does not return this node, the default start time that can be
configured for beginTime is "1970-01-01T00:00:00"*/
"timeType": {
/*ro, opt, object, time type*/
"@opt": "local,UTC"
/*ro, opt, string*/
}
},
"maxBelongGroup": 4,
/*ro, opt, int, maximum number of groups that a person can belong to*/
"belongGroup": {
/*ro, opt, object, group*/
"@min": 1,
"@max": 32
},
"password": {
/*ro, opt, object, password*/
"@min": 1,
"@max": 32
},
"doorRight": {
/*ro, opt, object, No. of door or lock that has access permission*/
"@min": 1,
"@max": 32
},
"RightPlan": {
/*ro, opt, object, door permission schedule (lock permission schedule)*/
"maxSize": 32,
"doorNo": {
/*ro, opt, object, door No. (lock ID)*/
"@min": 1,
"@max": 32
},
"maxPlanTemplate": 4,
/*ro, opt, int, maximum number of schedule templates that can be configured for one door*/
"planTemplateNo": {
/*ro, opt, object, schedule template No.*/
"@min": 1,
"@max": 32,
"@opt": [65535, 65534, 65533]
}
},
"maxOpenDoorTime": {
/*ro, opt, object, maximum authentication attempts*/
"@min": 0,
"@max": 100
},
"openDoorTime": {
/*ro, opt, object, authenticated attempts*/
"@min": 0,
"@max": 100
},
"roomNumber": {
/*ro, opt, object, room No.*/
"@min": 0,
"@max": 100
},
"floorNumber": {
/*ro, opt, object, floor No.*/
"@min": 0,
"@max": 100
},
"doubleLockRight": "true,false",
/*ro, opt, string, whether to have the permission to open the double-locked door*/
"localUIRight": "true,false",
/*ro, opt, string, whether to have the permission to access the device local UI*/
"userVerifyMode": {
/*ro, opt, object, person authentication mode*/
"@opt":
"cardAndPw,card,cardOrPw,fp,fpAndPw,fpOrCard,fpAndCard,fpAndCardAndPw,faceOrFpOrCardOrPw,faceAndFp,faceAndPw,faceAndCard,face,employeeNoAndPw,fpOrPw,employe
eNoAndFp,employeeNoAndFpAndPw,faceAndFpAndCard,faceAndPwAndFp,employeeNoAndFace,faceOrfaceAndCard,fpOrface,cardOrfaceOrPw,cardOrFace,cardOrFaceOrFp,cardOrFp
OrPw,faceOrPw,employeeNoAndFaceAndPw,cardOrFaceOrFaceAndCard,iris,faceOrFpOrCardOrPwOrIris,faceOrCardOrPwOrIris"
/*ro, opt, string, options, desc:"cardAndPw” (card + password), "card” (card), "cardOrPw” (card or password), "fp” (fingerprint), "fpAndPw”
(fingerprint + password), "fpOrCard” (fingerprint or card), "fpAndCard” (fingerprint + card), "fpAndCardAndPw” (fingerprint + card + password),
"faceOrFpOrCardOrPw” (face or fingerprint or card or password), "faceAndFp” (face + fingerprint), "faceAndPw” (face + password), "faceAndCard” (face +
card), "face” (face), "employeeNoAndPw” (employee No. + password), "fpOrPw” (fingerprint or password), "employeeNoAndFp” (employee No. + fingerprint),
"employeeNoAndFpAndPw” (employee No. + fingerprint + password), "faceAndFpAndCard” (face + fingerprint + card), "faceAndPwAndFp” (face + password +
fingerprint), "employeeNoAndFace” (employee No. + face), "faceOrfaceAndCard” (face or face + card), "fpOrface” (fingerprint or face), "cardOrfaceOrPw” (card
or face or password), "cardOrFace” (card or face), "cardOrFaceOrFp” (card or face or fingerprint), "cardOrFpOrPw” (card or fingerprint or password). The
priority of the person authentication mode is higher than that of the card reader authentication mode*/
},
"checkUser": "true,false",
/*ro, opt, string, whether to verify the duplicated person information*/
"maxRecordNum": 0,
/*ro, opt, int, supported maximum number of records (person records)*/
"gender": {
/*ro, opt, object, gender of the person in the face picture*/
"@opt": "male,female,unknown"
/*ro, opt, string, options*/
},
"PersonInfoExtends": {
/*ro, opt, object, extended fields for the additional person information*/
"maxSize": 3,
/*ro, req, int, range of members in the array*/
"id": {
/*ro, opt, object, extended ID of the additional person information*/
"@min": 1,
"@max": 32
},
"value": {
/*ro, opt, object, extended content of the additional person information*/
"@min": 0,
"@max": 100
}
},
"dynamicCode": {
/*ro, opt, object*/
"@min": 1,
"@max": 32
},
"callNumbers": {
/*ro, opt, object, room No. list to be called,which is extended from roomNumber and it is in higher priority; by default,the No. format is X-X-X-
X,e.g.,1-1-1-401,and for standard SIP,it can be the SIP number; this node must be configured together with roomNumber*/
"maxSize": 0,
"@min": 0,
"@max": 100
},
"floorNumbers": {
/*ro, opt, object, floor No. list*/
"maxSize": 0,
"@min": 0,
"@max": 100
},
"groupId": {
/*ro, opt, object*/
"@min": 0,
/*ro, req, int*/
"@max": 0
/*ro, req, int*/
},
"localAtndPlanTemplateId": {
/*ro, opt, object*/
"@min": 0,
/*ro, req, int*/
"@max": 0
/*ro, req, int*/
},
"purePwdVerifyEnable": true,
/*ro, opt, bool, whether the device supports opening the door only by password, desc:true (yes), this node is not returned (no). The password used
to open the door is the value of the node password in the message JSON_UserInfo*/
"groupName": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int, the minimum length, range:[1,256]*/
"@max": 256
"@max": 256
/*ro, opt, int, the maximum length, range:[1,256]*/
},
"age": {
/*ro, opt, object*/
"@min": 0,
"@max": 120
},
"PatientInfos": {
/*ro, opt, object*/
"admissionTime": "1970-01-01T00:00:00+08:00",
"chargeNurse": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int, the minimum value among elements of the array, unit:Byte*/
"@max": 64
/*ro, opt, int, the maximum value among elements of the array, unit:Byte*/
},
"chargeDoctor": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int, the minimum value among elements of the array, unit:Byte*/
"@max": 64
},
"nursingLevel": {
/*ro, opt, object*/
"@min": 0,
"@max": 0,
"@opt": ["unknow", "tertiary", "secondary", "primary", "special"]
},
"doctorsAdvice": {
/*ro, opt, object*/
"@min": 0,
"@max": 256
},
"allergicHistory": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 128
/*ro, opt, int*/
}
},
"ESDType": {
/*ro, opt, object*/
"@opt": ["handAndFoot", "no", "hand", "foot"]
},
"userLevel": {
/*ro, opt, object*/
"@opt": ["Employee", "DepartmentManager"]
},
"userName": {
/*ro, opt, object*/
"@min": 1,
/*ro, req, int*/
"@max": 32
/*ro, req, int*/
},
"loginPassword": {
/*ro, opt, object*/
"@min": 8,
/*ro, req, int*/
"@max": 16
/*ro, req, int*/
}
}
}
21.22.20 Get the capability of deleting fingerprint data

Request URL
GET /ISAPI/AccessControl/FingerPrint/Delete/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"FingerPrintDelete": {
/*ro, opt, object*/
"mode": {
/*ro, req, object, mode*/
"@opt": "byEmployeeNo,byCardReader"
/*ro, opt, string, deleting mode, desc:"byEmployeeNo"-delete by employee No. (person ID), "byCardReader"-delete by fingerprint module*/
},
"EmployeeNoDetail": {
/*ro, opt, object, delete by employee No. (person ID); this node is valid when mode is "byEmployeeNo"*/
"employeeNo": {
/*ro, opt, object, employee No. (person ID) linked with the fingerprint*/
"@min": 1,
"@max": 32
},
"enableCardReader": {
/*ro, opt, object, fingerprint module whose fingerprints should be deleted*/
"@min": 1,
"@max": 512
},
"fingerPrintID": {
/*ro, opt, object, No. of fingerprint to be deleted*/
"@min": 1,
"@max": 10
}
},
"CardReaderDetail": {
/*ro, opt, object, delete by fingerprint module; this node is valid when mode is "byCardReader"*/
"cardReaderNo": {
/*ro, opt, object, fingerprint module No.*/
"@min": 1,
"@max": 512
},
"clearAllCard": "true,false",
/*ro, opt, string, whether to delete the fingerprint information of all cards: "false"-no (delete by employee No.), "true"-yes (delete the
fingerprint information of all employee No.)*/
"employeeNo": {
/*ro, opt, object, employee No. (person ID) linked with the fingerprint*/
"@min": 1,
"@max": 32
}
}
}
}
21.22.21 Get the progress of deleting fingerprint data

Request URL
GET /ISAPI/AccessControl/FingerPrint/DeleteProcess?format=json
Query Parameter
None
Request Message
None
Response Message
{
"FingerPrintDeleteProcess": {
/*ro, req, object*/
"status": "processing"
/*ro, req, enum, deleting status, subType:string, desc:"processing", "success", "failed"*/
}
}
21.22.22 Get the total number of the added cards

Request URL
GET /ISAPI/AccessControl/CardInfo/Count?format=json
Query Parameter
None
Request Message
None
Response Message
{
"CardInfoCount": {
/*ro, req, object, number of cards*/
"cardNumber": 100
/*ro, req, int, number of cards*/
}
}
21.22.23 Get the progress of applying fingerprint data

Request URL
GET /ISAPI/AccessControl/FingerPrintProgress?format=json
Query Parameter
None
Request Message
None
Response Message
{
"FingerPrintStatus": {
/*ro, opt, object*/
"StatusList": [
/*ro, opt, array, status list, subType:object*/
{
"id": 1,
/*ro, opt, int, fingerprint module No.*/
"cardReaderRecvStatus": 1,
/*ro, opt, enum, fingerprint module status, subType:int, desc:0 (connecting failed), 1 (connected), 2 (the fingerprint module is offline), 3
(the fingerprint quality is poor, try again), 4 (the memory is full), 5 (the fingerprint already exists), 6 (the fingerprint ID already exists), 7 (invalid
fingerprint ID), 8 (this fingerprint module is already configured), 10 (the fingerprint module version is too old to support the employee No.)*/
"errorMsg": "test"
/*ro, opt, string, error information, range:[1,32], desc:error information*/
}
],
"totalStatus": 1
/*ro, req, enum, applying status, subType:int, desc:0 (applying), 1 (applied)*/
}
}
21.22.24 Get the capabilities of applying person pictures asynchronously

Request URL
GET /ISAPI/AccessControl/UserPic/asyncImportDatasTasks/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AsyncImportDatasCap": {
/*ro, opt, object*/
"taskID": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 64
/*ro, req, int*/
},
"taskNum": 1,
/*ro, req, int*/
"URL": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 256
/*ro, req, int*/
},
"singleFileMaxSize": 1,
/*ro, req, int*/
"employeeNo": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 32
/*ro, opt, int*/
},
"FDID": "test",
/*ro, opt, string*/
"deleteFacePic": {
/*ro, opt, object*/
},
"picURL": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
}
}
}
21.22.25 Delete a specified task of applying person pictures asynchronously

Request URL
DELETE /ISAPI/AccessControl/UserPic/asyncImportDatasTasks/<taskID>?format=json
Query Parameter
taskID string --
Request Message
None
Response Message
{
"statusCode": 1,
/*ro, opt, int*/
"errorCode": 1,
/*ro, opt, int*/
"errorMsg": "ok"
/*ro, opt, string*/
}
21.22.26 Get the status of all tasks of applying person pictures asynchronously
Request URL
GET /ISAPI/AccessControl/UserPic/asyncImportDatasTasks/status?format=json
Query Parameter
None
Request Message
None
Response Message
{
"TasksStatusList": [
/*ro, req, array, subType:object*/
{
/*ro, opt, object*/
"taskID": "test",
"URL": "test",
"status": 1,
"totalNum": 1,
/*ro, opt, int*/
"successNum": 1,
/*ro, opt, int*/
"failedNum": 1
/*ro, opt, int*/
}
}
]
}
21.22.27 Delete a specified task of applying person data asynchronously

Request URL
DELETE /ISAPI/AccessControl/UserInfo/asyncImportDatasTasks/<taskID>?format=json
Query Parameter
taskID string --
Request Message
None
Response Message
{
"statusCode": 1,
/*ro, opt, int*/
"errorCode": 1,
/*ro, opt, int*/
"errorMsg": "ok"
/*ro, opt, string*/
}
21.22.28 Get the status of a specified task of applying person data asynchronously
Request URL
GET /ISAPI/AccessControl/UserInfo/asyncImportDatasTasks/<taskID>/status?format=json
Query Parameter
taskID string --
Request Message
None
Response Message
{
/*ro, req, object*/
"taskID": "test",
"URL": "test",
"status": 0,
"totalNum": 1,
/*ro, opt, int*/
"successNum": 1,
/*ro, opt, int*/
"failedNum": 1
/*ro, opt, int*/
}
}
21.22.29 Search for cards

Request URL
POST /ISAPI/AccessControl/CardInfo/Search?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"CardInfoSearchCond": {
/*req, object*/
"searchID": "test",
/*req, string, unique ID of search records, desc:it is used to confirm the upper-level platform or system. If the platform or the system is the same
one during two searching, the search history will be saved in the memory to speed up next searching*/
/*req, int, the start position of the search result in the result list, desc:the start position of the search result in the result list. When there
are multiple records and you cannot get all search results at a time,you can search for the records after the specified position next time. For example,if
the maximum total number of matched results (totalMatches) supported by the device is M and the total number of matched results (totalMatches) stored in the
device currently is N (here N is smaller than M),the valid range of this field is from 0 to N-1*/
"maxResults": 30,
/*req, int, the maximum number of search results this time by calling this URI, desc:if maxResults exceeds the range returned by the device
capability, the device will return the maximum number of search results according to the device capability and will not return error message*/
"EmployeeNoList": [
{
}
],
"CardNoList": [
/*opt, array, card No. list, subType:object, desc:this node cannot exist together with EmployeeNoList*/
{
"cardNo": "1234567890"
}
]
}
}
Response Message
{
"CardInfoSearch": {
/*ro, opt, object*/
"searchID": "test",
/*ro, req, string, unique ID of search records*/
/*ro, req, enum, searching status description, subType:string, desc:"OK" (searching completed), "MORE" (searching for more data), "NO MATCH" (no
matched data)*/
"numOfMatches": 1,
"totalMatches": 1,
"CardInfo": [
/*ro, opt, array, card information, subType:object*/
{
/*ro, req, string, employee No. (person ID)*/
"cardNo": "test",
/*ro, req, string, card No.*/
/*ro, req, enum, card type, desc:card type: "normalCard"-normal card,"patrolCard"-patrol card,"hijackCard"-duress card,"superCard"-super
card,"dismissingCard"-dismiss card,"emergencyCard"-emergency card (it is used to assign permission to a temporary card,but it cannot open the door)*/
"leaderCard": "1,3,5"
/*ro, opt, string, whether to support first card authentication function, desc:the value "1, 3, 5" indicates that the access control points
No.1, No.3, and No.5 support first card authentication function*/
}
]
}
}
21.22.30 Edit fingerprint parameters

Request URL
POST /ISAPI/AccessControl/FingerPrintModify?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"FingerPrintModify": {
/*opt, object*/
"cardReaderNo": 1,
/*req, int, fingerprint module No.*/
"fingerPrintID": 1,
/*req, int, fingerprint No., range:[1,10]*/
/*req, enum, fingerprint type, subType:string, desc:"normalFP" (normal fingerprint), "hijackFP" (duress fingerprint), "patrolFP" (patrol
fingerprint), "superFP" (super fingerprint),"dismissingFP" (dismiss fingerprint)*/
"leaderFP": [1, 3, 5]
/*opt, array, whether the access control points support first fingerprint authentication function, subType:int, desc:e.g., [1,3,5] indicates that
access control points No.1, No.3, and No.5 support first fingerprint authentication function. If this node is not configured, the first fingerprint
authentication function will remain unchanged*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.22.31 Search the fingerprint information
Request URL
POST /ISAPI/AccessControl/FingerPrintUpload?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"FingerPrintCond": {
/*opt, object, search condition*/
"searchID": "test",
/*req, string, search ID, range:[1,32], desc:it is used to check whether the current search requester is the same as the previous one. If they are
the same, the search record will be stored in the device to speed up the next search*/
"cardReaderNo": 1,
/*opt, int, card reader No.*/
"fingerPrintID": 1
/*opt, int, finger ID, range:[1,10]*/
}
}
Response Message
{
"FingerPrintInfo": {
/*ro, opt, object, fingerprint information*/
"searchID": "test",
/*ro, req, string, search ID*/
"status": "OK",
/*ro, req, enum, status, subType:string, desc:"OK” (the fingerprint exists), "NoFP” (the fingerprint does not exist)*/
"FingerPrintList": [
/*ro, opt, array, subType:object*/
{
"cardReaderNo": 1,
/*ro, req, int, card reader No., range:[1,10]*/
"fingerPrintID": 1,
/*ro, req, int, fingerprint No.*/
/*ro, req, enum, fingerprint type, subType:string, desc:fingerprint type: "normalFP"-normal fingerprint,"hijackFP"-duress
fingerprint,"patrolFP"-patrol fingerprint,"superFP"-super fingerprint,"dismissingFP"-dismiss fingerprint*/
"fingerData": "test",
/*ro, req, string, fingerprint data encoded by Base64*/
"leaderFP": [1, 3, 5]
/*ro, opt, array, whether the access control points support first fingerprint authentication function, subType:int, desc:e.g., [1,3,5]
indicates that access control points No.1, No.3, and No.5 support first fingerprint authentication function*/
}
]
}
}
21.22.32 Start deleting the fingerprint data

Request URL
PUT /ISAPI/AccessControl/FingerPrint/Delete?format=json&security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
{
"FingerPrintDelete": {
/*req, object*/
"mode": "byEmployeeNo",
/*req, enum, deleting mode, subType:string, desc:"byEmployeeNo" (delete by employee No. (person ID)), "byCardReader" (delete by fingerprint
module)*/
"EmployeeNoDetail": {
/*opt, object, delete by employee No. (person ID), dep:and,{$.FingerPrintDelete.mode,eq,byEmployeeNo}, desc:this node is valid when mode is
"byEmployeeNo"*/
/*opt, string, employee No. (person ID) linked with the fingerprint*/
"enableCardReader": [1, 3, 5],
/*opt, array, fingerprint module whose fingerprints should be deleted, subType:int*/
"fingerPrintID": [1, 3, 5]
/*opt, array, No. of fingerprint to be deleted, subType:int*/
},
"CardReaderDetail": {
/*opt, object, delete by fingerprint module, dep:and,{$.FingerPrintDelete.mode,eq,byCardReader}, desc:this node is valid when mode is
"byCardReader"*/
"cardReaderNo": 1,
/*opt, int, fingerprint module No.*/
"clearAllCard": false,
/*opt, bool, whether to delete the fingerprint information of all cards, desc:"false" (no (delete by employee No.)), "true" (yes (delete the
fingerprint information of all employee No.))*/
/*opt, string, employee No. (person ID) linked with the fingerprint*/
}
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
/*ro, opt, string, error description, desc:this field is required when the value of statusCode is not 1*/
}
21.22.33 Get the status of all tasks of applying person data asynchronously
Request URL
GET /ISAPI/AccessControl/UserInfo/asyncImportDatasTasks/status?format=json
Query Parameter
None
Request Message
None
Response Message
{
"TasksStatusList": [
{
/*ro, opt, object*/
"taskID": "test",
"URL": "test",
"status": 0,
"totalNum": 1,
/*ro, opt, int*/
"successNum": 1,
/*ro, opt, int*/
"failedNum": 1,
/*ro, opt, int*/
"taskMissingReason": "deviceShutDown"
/*ro, opt, enum, subType:string, dep:and,{$.TasksStatusList[*].AsyncImportDatasTask.status,eq,4}*/
}
}
]
}
21.23 Anti-Passback
21.23.1 Set anti-passing back parameters of a card reader
Request URL
PUT /ISAPI/AccessControl/CardReaderAntiSneakCfg/<cardReaderID>?format=json
Query Parameter
cardReaderID string --
Request Message
{
"CardReaderAntiSneakCfg": {
/*req, object, anti-passing back parameters of a card reader*/
"enable": true,
/*req, bool, whether to enable the anti-passing back function of the card reader, desc:"true"-enable, "false"-disable*/
"followUpCardReader": [2, 3, 4]
/*opt, array, following card reader No. after the first card reader, subType:int, desc:e.g., [2,3,4] indicates that card reader No. 2, No. 3, and
No. 4 can be swiped after the first card reader*/
}
}
Response Message
{
"statusCode": 1,
/*ro, opt, int, status code, desc:1 (succeeded); it is required when an error occurred*/
/*ro, opt, string, status description, range:[1,64], desc:"ok" (succeeded); it is required when an error occurred*/
/*ro, opt, string, sub status code, range:[1,64], desc:"ok" (succeeded); it is required when an error occurred*/
"errorCode": 1,
"errorMsg": "ok"
}
21.23.2 Get the configuration capability of anti-passing back parameters of card readers
Request URL
GET /ISAPI/AccessControl/CardReaderAntiSneakCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, req, object*/
"cardReaderNo": {
/*ro, opt, object, card reader No.*/
"@min": 1,
"@max": 512,
"@opt": [1, 4]
},
/*ro, req, string, whether to enable the anti-passing back function of the card reader*/
"followUpCardReader": {
/*ro, opt, object, array,following card reader No. after the first card reader*/
"@min": 1,
/*ro, opt, int*/
"@max": 512,
/*ro, opt, int*/
"@opt": [1, 4]
}
}
}
21.23.3 Get the capability of clearing anti-passback parameters

Request URL
GET /ISAPI/AccessControl/ClearAntiSneakCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"ClearAntiSneakCfg": {
/*ro, req, object, the capability of clearing anti-passback*/
"ClearFlags": {
/*ro, req, object*/
"antiSneak": "true,false"
/*ro, req, string, whether to clear the anti-passback parameter*/
}
}
}
21.23.4 Get the anti-passing back configuration capability

Request URL
GET /ISAPI/AccessControl/AntiSneakCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AntiSneakCfg": {
/*ro, req, object*/
/*ro, req, string, whether to enable anti-passing back*/
"startCardReaderNo": {
/*ro, opt, object, first card reader No., desc:first card reader No.*/
"@min": 1,
"@max": 4,
"@opt": [1, 4]
}
}
}
21.23.5 Clear anti-passing back parameters

Request URL
PUT /ISAPI/AccessControl/ClearAntiSneakCfg?format=json
Query Parameter
None
Request Message
{
"ClearAntiSneakCfg": {
/*req, object*/
"ClearFlags": {
/*req, object*/
"antiSneak": true
/*req, bool, whether to clear the anti-passing back parameters*/
}
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.23.6 Set the anti-passing back parameters

Request URL
PUT /ISAPI/AccessControl/AntiSneakCfg?format=json
Query Parameter
None
Request Message
{
"AntiSneakCfg": {
/*req, object*/
"enable": true,
/*req, bool, whether to enable anti-passing back*/
"startCardReaderNo": 1
/*opt, int, first card reader No., desc:0-no first card reader*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.23.7 Get the anti-passing back configuration parameters of a specified card reader
Request URL
GET /ISAPI/AccessControl/CardReaderAntiSneakCfg/<cardReaderID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable the anti-passing back function of the card reader, desc:"true" (enable), "false" (disable)*/
"followUpCardReader": [2, 3, 4]
/*ro, opt, array, following card reader No. after the first card reader, subType:int, desc:[2,3,4] indicates that card reader No. 2, No. 3, or No. 4
can be swiped after the first card reader*/
}
}
21.23.8 Get the parameters of anti-passback configuration

Request URL
GET /ISAPI/AccessControl/AntiSneakCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AntiSneakCfg": {
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable anti-passback*/
"startCardReaderNo": 1
/*ro, opt, int, first card reader No., desc:first card reader No.,0-no first card reader*/
}
}
21.24 Mask Detection

21.24.1 Set the mask detection parameters
Request URL
PUT /ISAPI/AccessControl/maskDetection?format=json
Query Parameter
None
Request Message
{
"MaskDetection": {
/*req, object*/
"enable": true,
/*opt, bool, whether to enable mask detection*/
"noMaskStrategy": "noTipsAndOpenDoor"
/*opt, enum, door control strategy when not wearing mask is detected, subType:string, desc:"noTipsAndOpenDoor" (open the door without prompt),
"tipsAndOpenDoor" (prompt and open the door (default)), "tipsAndNotOpenDoor" (prompt and not open the door)*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.24.2 Get the mask detection parameters

Request URL
GET /ISAPI/AccessControl/maskDetection?format=json
Query Parameter
None
Request Message
None
Response Message
{
"MaskDetection": {
/*ro, req, object, mask detection*/
"enable": true,
/*ro, opt, bool, whether to enable mask detection: true-enable, false-disable*/
"noMaskStrategy": "noTipsAndOpenDoor"
/*ro, opt, enum, door control strategy when not wearing mask is detected, subType:string, desc:This field is valid when enable is true;
"noTipsAndOpenDoor”-open the door without prompt, "tipsAndOpenDoor"-prompt and open the door (default), "tipsAndNotOpenDoor"-prompt and not open the door*/
}
}
21.24.3 Get the configuration capability of mask detection

Request URL
GET /ISAPI/AccessControl/maskDetection/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"MaskDetectionCap": {
/*ro, req, object, configuration capability of mask detection*/
"enable": {
/*ro, opt, object, whether to enable mask detection, desc:true-enable, false-disable*/
},
"noMaskStrategy": {
/*ro, opt, object, door control strategy when not wearing mask is detected, desc:"noTipsAndOpenDoor"-open the door without prompt,
"tipsAndOpenDoor"-prompt and open the door (default), "tipsAndNotOpenDoor"-prompt and not open the door. This field is valid when enable is true*/
"@opt": ["noTipsAndOpenDoor", "tipsAndOpenDoor", "tipsAndNotOpenDoor", "noTipsAndConsume", "tipsAndConsume", "tipsAndNotConsume"]
}
}
}
21.25 Access Control Device Management

21.25.1 Get the capability of getting the working status of
the access controller Request URL
GET /ISAPI/AccessControl/AcsWorkStatus/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AcsWorkStatus": {
/*ro, req, object*/
"doorLockStatus": {
/*ro, opt, object, door lock status (relay status): 0-normally close, 1-normally open, 2-short-circuit alarm, 3-broken-circuit alarm, 4-exception
alarm*/
"@opt": "0,1,2,3,4"
/*ro, opt, string*/
},
"doorStatus": {
/*ro, opt, object, door (floor) status: 1-sleep, 2-remain unlocked (free), 3-remain locked (disabled), 4-normal status (controlled)*/
"@opt": "1,2,3,4"
/*ro, opt, string*/
},
"magneticStatus": {
/*ro, opt, object, magnetic contact status: 0-normally close,1-normally open, 2-short-circuit alarm, 3-broken-circuit alarm, 4-exception alarm*/
"@opt": "0,1,2,3,4"
/*ro, opt, string, magnetic contact status*/
},
"caseStatus": {
/*ro, opt, object, event trigger status*/
"@min": 1,
/*ro, opt, int, event trigger status*/
"@max": 1
/*ro, opt, int, event trigger status*/
},
"batteryVoltage": {
/*ro, opt, object, storage battery power voltage, the actual value will be 10 times of this value*/
"@min": 1,
/*ro, opt, int, storage battery power voltage*/
"@max": 1
/*ro, opt, int, storage battery power voltage*/
},
"batteryLowVoltage": "true,false",
/*ro, opt, string, whether the storage battery is in low voltage status: "true"-yes,"false"-no*/
"powerSupplyStatus": {
/*ro, opt, object, device power supply status: "ACPowerSupply"-alternative current, "BatteryPowerSupply"-storage battery power supply*/
"@opt": "ACPowerSupply,BatteryPowerSupply"
/*ro, opt, string*/
},
"multiDoorInterlockStatus": {
/*ro, opt, object, multi-door interlocking status: "close"-disabled, "open"-enabled*/
"@opt": "close,open"
/*ro, opt, string*/
},
"antiSneakStatus": {
/*ro, opt, object, anti-passback status: "close"-disabled,"open"-enabled*/
/*ro, opt, string*/
},
"hostAntiDismantleStatus": {
"hostAntiDismantleStatus": {
/*ro, opt, object, tampering status of the access control device: "close"-disabled, "open"-enabled*/
/*ro, opt, string*/
},
"indicatorLightStatus": {
/*ro, opt, object, indicator status: "offLine"-offline, "onLine"-online*/
"@opt": "offLine,onLine"
/*ro, opt, string*/
},
"cardReaderOnlineStatus": {
/*ro, opt, object, online status of the authentication unit*/
"@min": 1,
/*ro, opt, int, the minimum value, range:[1,8]*/
"@max": 1
/*ro, opt, int, the maximum value, range:[1,8]*/
},
"netReaderOnlineStatus": {
/*ro, opt, object*/
"@min": 1,
"@max": 1
},
"POEPortList": {
/*ro, opt, object*/
"@size": 8,
"port": {
/*ro, opt, object*/
"@min": 1,
"@max": 8
},
"readerID": {
/*ro, opt, object*/
"@size": 8,
"@min": 1,
"@max": 8
}
},
"cardReaderAntiDismantleStatus": {
/*ro, opt, object, tampering status of the authentication unit*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"cardReaderVerifyMode": {
/*ro, opt, object, current authentication mode of the authentication unit, desc:1-sleep,2-card+password,3-card,4-card or password,5-fingerprint,6-
fingerprint+password,7-fingerprint or card,8-fingerprint+card,9-fingerprint+card+password,10-face or fingerprint or card or password,11-face+fingerprint,12-
face+password,13-face+card,14-face,15-employee No.+password,16-fingerprint or password,17-employee No.+fingerprint,18-employee No.+fingerprint+password,19-
face+fingerprint+card,20-face+password+fingerprint,21-employee No.+face,22-face or face+card,23-fingerprint or face,24-card or face or password,25-card or
face,26-card or face or fingerprint,27-card or fingerprint or password*/
"@opt": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34"
/*ro, opt, string*/
},
"setupAlarmStatus": {
/*ro, opt, object, No. of armed input port*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"alarmInStatus": {
/*ro, opt, object, No. of input port with alarms*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"alarmOutStatus": {
/*ro, opt, object, No. of output port with alarms*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"cardNum": {
/*ro, opt, object, number of added cards*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"fireAlarmStatus": {
/*ro, opt, object, fire alarm status*/
"@opt": "normal,shortCircuit,brokenCircuit"
/*ro, opt, string, "normal","shortCircuit"-short-circuit alarm, "brokenCircuit"-broken-circuit alarm*/
},
},
"batteryChargeStatus": {
/*ro, opt, object, battery charging status*/
"@opt": "charging,uncharged"
/*ro, opt, string, "charging","uncharged”*/
},
"masterChannelControllerStatus": {
/*ro, opt, object, online status of the main lane controller*/
/*ro, opt, string, "offLine"-offline, "onLine"-online*/
},
"slaveChannelControllerStatus": {
/*ro, opt, object, online status of the sub lane controller*/
/*ro, opt, string, "offLine"-offline,"onLine"-online*/
},
"antiSneakServerStatus": {
/*ro, opt, object, anti-passback server status: "disable"-disabled, "normal", "disconnect"-disconnected*/
"@opt": "disable,normal,disconnect"
/*ro, opt, string*/
},
"netStatus": {
/*ro, opt, object, network connection status*/
"@opt": ["connect", "disconnect", "ipConflict"]
},
"InterfaceStatusList": {
/*ro, opt, object*/
"@size": 2,
/*ro, opt, int*/
"id": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 2
/*ro, opt, int*/
},
"netStatus": {
/*ro, opt, object*/
"@opt": ["connect", "disconnect", "ipConflict"]
}
},
"signalStatus": {
/*ro, opt, object, signal status*/
"@opt": ["noSignal", "2G", "3G", "4G", "5G"]
},
"sipStatus": {
/*ro, opt, object*/
"@opt": ["connect", "disconnect", "unregistered"]
},
"ezvizStatus": {
/*ro, opt, object*/
"@opt": ["unregistered", "notAdd", "connect"]
},
"voipStatus": {
/*ro, opt, object*/
"@opt": ["unregistered", "connect"]
},
"wifiStatus": {
/*ro, opt, object*/
"@opt": ["connect", " disconnect", "connecting", "noModule"]
},
"TFCardStatus": {
/*ro, opt, object*/
"@opt": ["mounted", "unmounted"]
},
"acrossHostInterlockStatus": {
/*ro, opt, object*/
"@opt": ["disable", "normal", "disconnect"]
},
"faceReceivingStatus": {
/*ro, opt, object*/
"@opt": ["receiving", "received"]
},
"QRCodeReaderStatusList": {
/*ro, opt, object*/
"id": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 2
/*ro, opt, int*/
},
"QRCodeReaderStatus": {
/*ro, opt, object*/
"@opt": ["onLine", "offLine"]
"@opt": ["onLine", "offLine"]
}
}
}
}
21.25.2 Get the working status of the access controller

Request URL
GET /ISAPI/AccessControl/AcsWorkStatus?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AcsWorkStatus": {
/*ro, req, object*/
"doorLockStatus": [1, 2, 1, 2],
/*ro, opt, enumarray, door lock status (relay status), subType:int, desc:door lock status (relay status): 0 (normally close), 1 (normally open), 2
(short-circuit alarm), 3 (broken-circuit alarm), 4 (exception alarm). For example, [1,2,1,2] indicates that door lock 1 is normally open, door lock 2
triggers short-circuit alarm, door lock 3 is normally open, and door lock 4 triggers short-circuit alarm*/
"doorStatus": [1, 2, 1, 2],
/*ro, opt, enumarray, door (floor) status, subType:int, desc:door (floor) status: 1 (sleep), 2 (remain unlocked (free)), 3 (remain locked
(disabled)), 4 (normal status (controlled)). For example, [1,2,1,2] indicates that door 1 is sleeping, door 2 remains unlocked, door 3 is sleeping, and door
4 remains unlocked*/
"magneticStatus": [1, 2, 1, 2],
/*ro, opt, enumarray, magnetic contact status, subType:int, desc:magnetic contact status: 0 (normally close), 1 (normally open), 2 (short-circuit
alarm), 3 (broken-circuit alarm), 4 (exception alarm). For example, [1,2,1,2] indicates that magnetic contact No.1 is normally open, magnetic contact No.2
triggers short-circuit alarm, magnetic contact No.3 is normally open, and magnetic contact No.4 triggers short-circuit alarm*/
"caseStatus": [1, 3, 5],
/*ro, opt, array, event trigger status, subType:int, desc:event trigger status, e.g., [1,3,5] indicates that event trigger No.1, No.3, and No.5 have
input*/
"batteryVoltage": 50,
/*ro, opt, int, storage battery power voltage, desc:storage battery power voltage, the actual value will be 10 times of this value, unit: Volt*/
"batteryLowVoltage": false,
/*ro, opt, bool, whether the storage battery is in low voltage status, desc:"true” (yes), "false” (no)*/
"powerSupplyStatus": "ACPowerSupply",
/*ro, opt, enum, device power supply status, subType:string, desc:"ACPowerSupply” (alternative current), "BatteryPowerSupply” (storage battery power
supply)*/
"multiDoorInterlockStatus": "close",
/*ro, opt, enum, multi-door interlocking status, subType:string, desc:"close” (disabled), "open” (enabled)*/
"antiSneakStatus": "open",
/*ro, opt, enum, anti-passback status, subType:string, desc:"close” (disabled), "open” (enabled)*/
"hostAntiDismantleStatus": "open",
/*ro, opt, enum, tampering status of the access control device, subType:string, desc:"close” (disabled), "open” (enabled)*/
"indicatorLightStatus": "onLine",
/*ro, opt, enum, indicator status, subType:string, desc:"offLine” (offline), "onLine” (online)*/
"cardReaderOnlineStatus": [1, 3, 5],
/*ro, opt, array, online status of the authentication unit, subType:int, desc:online status of the authentication unit, e.g., [1,3,5] indicates that
authentication unit No.1, No.3, and No.5 are online*/
"netReaderOnlineStatus": [1, 3, 5],
"POEPortList": [
/*ro, opt, array, subType:object, range:[1,8]*/
{
"port": 1,
/*ro, req, int, range:[1,8]*/
"readerID": [1, 2, 3]
}
],
"cardReaderAntiDismantleStatus": [1, 3, 5],
/*ro, opt, array, tampering status of the authentication unit, subType:int, desc:tampering status of the authentication unit, e.g., [1,3,5]
indicates that the tampering function of authentication unit No.1, No.3, and No.5 is enabled*/
"cardReaderVerifyMode": [3, 5, 3, 5],
/*ro, opt, enumarray, current authentication mode of the authentication unit, subType:int, desc:1 (sleep), 2 (card + password), 3 (card), 4 (card or
password), 5 (fingerprint), 6 (fingerprint + password), 7 (fingerprint or card), 8 (fingerprint + card), 9 (fingerprint + card + password),10 (face or
fingerprint or card or password), 11 (face + fingerprint), 12 (face + password), 13 (face + card), 14 (face), 15 (employee No. + password), 16 (fingerprint
or password), 17 (employee No. + fingerprint), 18 (employee No. + fingerprint + password), 19 (face + fingerprint + card), 20 (face + password +
fingerprint), 21 (employee No. + face), 22 (face or face + card), 23 (fingerprint or face), 24 (card or face or password), 25 (card or face), 26 (card or
face or fingerprint), 27 (card or fingerprint or password). For example, [3,5,3,5] indicates that the authentication mode of authentication unit 1 is
"card", the authentication mode of authentication unit 2 is "fingerprint", the authentication mode of authentication unit 3 is "card", and the
authentication mode of authentication unit 4 is "fingerprint"*/
"setupAlarmStatus": [1, 3, 5],
/*ro, opt, array, No. of armed input port, subType:int, desc:No. of armed input port, e.g., [1,3,5] indicates that input port No.1, No.3, and No.5
are armed*/
"alarmInStatus": [1, 3, 5],
/*ro, opt, array, No. of input port with alarms, subType:int, desc:No. of input port with alarms, e.g., [1,3,5] indicates that input port No.1,
No.3, and No.5 trigger alarms*/
"alarmOutStatus": [1, 3, 5],
"alarmOutStatus": [1, 3, 5],
/*ro, opt, array, No. of output port with alarms, subType:int, desc:No. of output port with alarms, e.g., [1,3,5] indicates that output port No.1,
No.3, and No.5 trigger alarms*/
"cardNum": 3,
/*ro, opt, int, number of added cards, desc:number of added cards*/
"fireAlarmStatus": "normal",
/*ro, opt, enum, fire alarm status, subType:string, desc:fire alarm status: "normal", "shortCircuit” (short-circuit alarm), "brokenCircuit” (broken-
circuit alarm)*/
"batteryChargeStatus": "charging",
/*ro, opt, enum, battery charging status, subType:string, desc:battery charging status: "charging", "uncharged"*/
"masterChannelControllerStatus": "onLine",
/*ro, opt, enum, online status of the main-lane controller, subType:string, desc:online status of the main lane controller: "offLine” (offline),
"onLine” (online)*/
"slaveChannelControllerStatus": "onLine",
/*ro, opt, enum, online status of the sub lane controller, subType:string, desc:online status of the sub lane controller: "offLine” (offline),
"onLine” (online)*/
"antiSneakServerStatus": "normal",
/*ro, opt, enum, anti-passback server status, subType:string, desc:anti-passback server status: "disable” (disabled), "normal", "disconnect”
(disconnected)*/
"netStatus": "connect",
"InterfaceStatusList": [
{
"id": 1,
/*ro, opt, int*/
"netStatus": "connect"
}
],
"signalStatus": "noSignal",
"sipStatus": "connect",
"ezvizStatus": "unregistered",
"voipStatus": "unregistered",
"wifiStatus": "connect",
"TFCardStatus": "mounted",
"acrossHostInterlockStatus": "disable",
"faceReceivingStatus": "receiving",
"QRCodeReaderStatusList": [
{
"id": 1,
/*ro, opt, int*/
"QRCodeReaderStatus": "onLine"
}
]
}
}
21.25.3 Get the configuration capability of the access controller

Request URL
GET /ISAPI/AccessControl/AcsCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AcsCfg": {
/*ro, req, object*/
"RS485Backup": "true,false",
/*ro, opt, string, whether to enable downstream RS-485 communication redundancy, desc:"true” (yes), "false” (no)*/
"showCapPic": "true,false",
/*ro, opt, string, whether to display the captured picture, desc:"true” (yes), "false” (no)*/
"showUserInfo": "true,false",
/*ro, opt, string, whether to display user information, desc:"true” (yes), "false” (no)*/
"overlayUserInfo": "true,false",
/*ro, opt, string, whether to overlay user information, desc:"true” (yes), "false” (no)*/
"voicePrompt": "true,false",
/*ro, opt, string, whether to enable voice prompt, desc:"true” (yes), "false” (no)*/
"uploadCapPic": "true,false",
/*ro, opt, string, whether to upload the picture from linked capture, desc:"true” (yes), "false” (no)*/
"saveCapPic": "true,false",
"saveCapPic": "true,false",
/*ro, opt, string, whether to save the captured picture, desc:"true” (yes), "false” (no)*/
"inputCardNo": "true,false",
/*ro, opt, string, whether to allow inputting card No. on keypad, desc:"true” (yes), "false” (no)*/
"enableWifiDetect": "true,false",
/*ro, opt, string, whether to enable Wi-Fi probe, desc:"true” (yes), "false” (no)*/
"enable3G4G": "true,false",
/*ro, opt, string, whether to enable 3G/4G, desc:"true” (yes), "false” (no)*/
"protocol": {
/*ro, opt, object, communication protocol type of the card reader, desc:"Private” (private protocol), "OSDP” (OSDP protocol)*/
"@opt": "Private,OSDP"
/*ro, opt, string, optional item*/
},
"enableCaptureCertificate": "true,false",
/*ro, opt, string, whether to enable capturing the ID picture, desc:true (yes), false (no). If this node does not exist, it indicates that this
function is not supported*/
"showPicture": "true,false",
/*ro, opt, string, whether to display the authenticated picture, desc:"true” (yes), "false” (no)*/
"showEmployeeNo": "true,false",
/*ro, opt, string, whether to display the authenticated employee ID, desc:"true” (yes), "false” (no)*/
"showName": "true,false",
/*ro, opt, string, whether to display the authenticated name, desc:"true” (yes), "false” (no)*/
"desensitiseEmployeeNo": {
/*ro, opt, object, whether to enable employee No. de-identification for local UI display*/
},
"desensitiseName": {
/*ro, opt, object, whether to enable name de-identification for local UI display*/
},
"thermalEnabled": {
/*ro, opt, object, whether to enable temperature measurement*/
},
"thermalMode": {
/*ro, opt, object, whether to enable temperature measurement only mode: true-enable (only for temperature measurement),false-disable (default)*/
},
"thermalPictureEnabled": {
/*ro, opt, object, whether to enable uploading visible light pictures in temperature measurement only mode: true-enable,false-disable (default).
This field is used to control uploading captured pictures and visible light pictures, desc:whether to enable uploading visible light pictures in temperature
measurement only mode: true-enable,false-disable (default). This field is used to control uploading captured pictures and visible light pictures*/
/*ro, opt, array, whether to enable uploading visible light pictures in temperature measurement only mode, subType:bool*/
},
"isSupportThermalIp": true,
/*ro, opt, bool, whether it supports configuring IP address of the thermography device, desc:whether it supports configuring IP address of the
thermography device: true-yes,this field is not returned-no*/
"highestThermalThreshold": {
/*ro, opt, object, maximum value of the temperature threshold, desc:float,upper limit of the temperature threshold which is accurate to one decimal
place,unit: Celsius*/
"@min": 1.0,
/*ro, opt, float*/
"@max": 2.0
/*ro, opt, float*/
},
"lowestThermalThreshold": {
/*ro, opt, object, minimum value of the temperature threshold, desc:float,lower limit of the temperature threshold which is accurate to one decimal
place,unit: Celsius*/
"@min": 1.0,
/*ro, opt, float*/
"@max": 2.0
/*ro, opt, float*/
},
"thermalDoorEnabled": {
/*ro, opt, object, whether to open the door according to the temperature threshold, desc:whether to open the door when the temperature is above the
upper limit (highestThermalThreshold) or below the lower limit (lowestThermalThreshold) of the threshold: true (open the door), false (not open the door
(default))*/
},
"QRCodeEnabled": {
/*ro, opt, object, whether to enable QR code function, desc:whether to enable QR code function: true-enable,false-disable (default)*/
},
"remoteCheckDoorEnabled": {
/*ro, opt, object, whether to enable controlling the door by remote verification, desc:whether to enable controlling the door by remote
verification: true-control,false-not control (default)*/
},
"checkChannelType": {
/*ro, opt, object, verification channel type, desc:verification channel type*/
"@opt": ["Ezviz", "ISUP", "ISAPI", "PrivateSDK", "ISAPIListen"]
},
"isSupportChannelIp": true,
/*ro, opt, bool, whether it supports configuring IP address of the verification channel, desc:whether it supports configuring IP address of the
verification channel: true-yes,this field is not returned-no*/
verification channel: true-yes,this field is not returned-no*/
"needDeviceCheck": {
/*ro, opt, object*/
},
"uploadVerificationPic": "true,false",
/*ro, opt, string, whether to upload the authenticated picture, desc:"true"-yes, "false"-no*/
"saveVerificationPic": "true,false",
/*ro, opt, string, whether to save the authenticated picture, desc:"true” (yes), "false” (no)*/
"saveFacePic": "true,false",
/*ro, opt, string, whether to save the registered face picture, desc:"true” (yes), "false” (no)*/
"thermalUnit": {
/*ro, opt, object, temperature unit, desc:object,temperature unit: "celsius" (default),"fahrenheit"*/
"@opt": ["celsius", "fahrenheit"]
},
"highestThermalThresholdF": {
/*ro, opt, object, maximum value of the temperature threshold, desc:the value is accurate to one decimal place, and the unit is Fahrenheit*/
"@min": 1.0,
/*ro, opt, float*/
"@max": 1.0
/*ro, opt, float*/
},
"lowestThermalThresholdF": {
/*ro, opt, object, minimum value of the temperature threshold, desc:the value is accurate to one decimal place, and the unit is Fahrenheit*/
"@min": 1.0,
/*ro, opt, float*/
"@max": 1.0
/*ro, opt, float*/
},
"enable5G": {
/*ro, opt, object, whether to enable 5G*/
},
"thermalCompensation": {
/*ro, opt, object, temperature compensation*/
"@min": -99.9,
/*ro, opt, float*/
"@max": 99.9
/*ro, opt, float*/
},
"externalCardReaderEnabled": {
/*ro, opt, object*/
},
"combinationAuthenticationTimeout": {
/*ro, opt, object*/
"@min": 1,
/*ro, req, int, range:[1,20], step:1, unit:s*/
"@max": 20
/*ro, req, int, range:[1,20], step:1, unit:s*/
},
"combinationAuthenticationLimitOrder": {
/*ro, opt, object*/
},
"passwordEnabled": {
/*ro, opt, object*/
},
"showGender": {
/*ro, opt, object, whether to display gender*/
},
"showSignInTime": {
/*ro, opt, object*/
},
"showsCustomInfo": {
/*ro, opt, object*/
},
"showMobileWebQRCode": {
/*ro, opt, object*/
},
"fireAlarmInputType": {
/*ro, opt, object*/
"@opt": ["alwaysClose", "alwaysOpen"]
},
"buzzerEnabled": {
/*ro, opt, object*/
}
}
}
}
21.25.4 Set the parameters of the access controller

Request URL
PUT /ISAPI/AccessControl/AcsCfg?format=json
Query Parameter
None
Request Message
{
"AcsCfg": {
/*req, object, parameters of the access controller*/
"RS485Backup": true,
/*opt, bool, whether to enable downstream RS-485 communication redundancy*/
"showCapPic": true,
/*opt, bool, whether to display the captured picture*/
"showUserInfo": true,
/*opt, bool, whether to display user information*/
"overlayUserInfo": true,
/*opt, bool, whether to overlay user information*/
"voicePrompt": true,
/*opt, bool, whether to enable voice prompt*/
"uploadCapPic": true,
/*opt, bool, whether to upload the picture from linked capture*/
"saveCapPic": true,
/*opt, bool, whether to save the captured picture*/
"inputCardNo": true,
/*opt, bool, whether to allow inputting card No. on keypad*/
"enableWifiDetect": true,
/*opt, bool, whether to enable Wi-Fi probe*/
"enable3G4G": true,
/*opt, bool, whether to enable 3G/4G*/
"protocol": "Private",
/*opt, enum, communication protocol type of the card reader, subType:string, desc:"Private” (private protocol), "OSDP” (OSDP protocol)*/
"enableCaptureCertificate": true,
/*opt, bool, whether to enable capturing the ID picture, desc:true (yes), false (no). If this node does not exist, it indicates that this function
is not supported*/
"showPicture": true,
/*opt, bool, whether to display the authenticated picture*/
"showEmployeeNo": true,
/*opt, bool, whether to display the authenticated employee ID*/
"showName": true,
/*opt, bool, whether to display the authenticated name*/
"desensitiseEmployeeNo": true,
/*opt, bool, whether to enable employee No. de-identification for local UI display, dep:or,{$.AcsCfg.showEmployeeNo,eq,true}*/
"desensitiseName": true,
/*opt, bool, whether to enable name de-identification for local UI display, dep:or,{$.AcsCfg.showName,eq,true}*/
"thermalEnabled": true,
/*opt, bool, whether to enable temperature measurement*/
"thermalMode": true,
/*opt, bool, whether to enable temperature measurement only mode*/
"thermalPictureEnabled": true,
/*opt, bool, whether to enable uploading visible light pictures in temperature measurement only mode*/
"thermalIp": "192.168.1.1",
/*opt, string, IP address of the thermography device, desc:for access control devices, each device only requires one IP address; for metal detector
doors, this field does not need to be configured*/
"highestThermalThreshold": 37.3,
/*opt, float, maximum value of the temperature threshold*/
"lowestThermalThreshold": 38.5,
/*opt, float, minimum value of the temperature threshold*/
"thermalDoorEnabled": false,
/*opt, bool, whether to open the door when the temperature is above the upper limit (highestThermalThreshold) or below the lower limit
(lowestThermalThreshold) of the threshold: true-open the door,false-not open the door (default), desc:whether to open the door when the temperature is above
the upper limit (highestThermalThreshold) or below the lower limit (lowestThermalThreshold) of the threshold: true (open the door), false (not open the door
(default))*/
"QRCodeEnabled": false,
/*opt, bool, whether to enable QR code function*/
"remoteCheckDoorEnabled": false,
/*opt, bool, whether to enable controlling the door by remote verification*/
"checkChannelType": "Ezviz",
/*opt, enum, verification channel type, subType:string, desc:verification channel type: "Ezviz"-EZVIZ channel,"ISUP"-ISUP channel,"ISAPI"-ISAPI
channel,"PrivateSDK"-private SDK channel,"ISAPIListen"-ISAPI listening channel. This field is valid when remoteCheckDoorEnabled is true*/
"channelIp": "test",
/*opt, string, IP address of the verification channel, desc:this field is valid when checkChannelType is "PrivateSDK"*/
"needDeviceCheck": true,
/*opt, bool, dep:or,{$.AcsCfg.remoteCheckDoorEnabled,eq,true}*/
"uploadVerificationPic": true,
/*opt, bool, whether to upload the authenticated picture*/
"saveVerificationPic": true,
/*opt, bool, whether to save the authenticated picture*/
/*opt, bool, whether to save the registered face picture*/
"thermalUnit": "celsius",
/*opt, enum, temperature unit, subType:string, desc:"celsius", "fahrenheit"*/
"highestThermalThresholdF": 1.0,
/*opt, float, the maximum value of the temperature threshold, desc:the value is accurate to one decimal place, and the unit is Fahrenheit this node
is used to check whether to open the door when the temperature is higher than the threshold*/
"lowestThermalThresholdF": 1.0,
/*opt, float, the minimum value of the temperature threshold, desc:the value is accurate to one decimal place, and the unit is Fahrenheit this node
is used to check whether to open the door when the temperature is higher than the threshold*/
"enable5G": true,
/*opt, bool, whether to enable 5G*/
"thermalCompensation": 1.0,
/*opt, float, temperature compensation, desc:float,temperature compensation,the value is accurate to one decimal place. The unit depends on the node
thermalUnit. If the node thermalUnit does not exist,the default unit is Celsius*/
"externalCardReaderEnabled": true,
/*opt, bool*/
"combinationAuthenticationTimeout": 1,
/*opt, int, range:[1,20], step:1, unit:s*/
"combinationAuthenticationLimitOrder": true
/*opt, bool*/
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
/*ro, req, string, error description*/
}
21.25.5 Get the configuration parameters of the access controller

Request URL
GET /ISAPI/AccessControl/AcsCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AcsCfg": {
/*ro, req, object*/
"RS485Backup": true,
/*ro, opt, bool, whether to enable downstream RS-485 communication redundancy*/
"showCapPic": true,
/*ro, opt, bool, whether to display the captured picture*/
"showUserInfo": true,
/*ro, opt, bool, whether to display user information*/
"overlayUserInfo": true,
/*ro, opt, bool, whether to overlay user information*/
"voicePrompt": true,
/*ro, opt, bool, whether to enable voice prompt*/
"uploadCapPic": true,
/*ro, opt, bool, whether to upload the picture from linked capture*/
"saveCapPic": true,
/*ro, opt, bool, whether to save the captured picture*/
"inputCardNo": true,
/*ro, opt, bool, whether to allow inputting card No. on keypad*/
"enableWifiDetect": true,
/*ro, opt, bool, whether to enable Wi-Fi probe*/
"enable3G4G": true,
/*ro, opt, bool, whether to enable 3G/4G*/
"protocol": "Private",
/*ro, opt, enum, communication protocol type of the card reader, subType:string, desc:"Private” (private protocol), "OSDP” (OSDP protocol)*/
"enableCaptureCertificate": true,
/*ro, opt, bool, whether to enable capturing the ID picture, desc:true (yes), false (no). If this node does not exist, it indicates that this
function is not supported*/
"showPicture": true,
/*ro, opt, bool, whether to display the authenticated picture*/
/*ro, opt, bool, whether to display the authenticated employee ID*/
"showName": true,
/*ro, opt, bool, whether to display the authenticated name*/
"desensitiseEmployeeNo": true,
/*ro, opt, bool, whether to enable employee No. de-identification for local UI display, dep:or,{$.AcsCfg.showEmployeeNo,eq,true}*/
"desensitiseName": true,
/*ro, opt, bool, whether to enable name de-identification for local UI display, dep:or,{$.AcsCfg.showName,eq,true}*/
"thermalEnabled": true,
/*ro, opt, bool, whether to enable temperature measurement*/
"thermalMode": true,
/*ro, opt, bool, whether to enable temperature measurement only mode*/
"thermalPictureEnabled": true,
/*ro, opt, bool, whether to enable uploading visible light pictures in temperature measurement only mode: true-enable,false-disable (default). This
field is used to control uploading captured pictures and visible light pictures*/
"thermalIp": "192.168.1.1",
/*ro, opt, string, IP address of the thermography device, desc:for access control devices, each device only requires one IP address; for metal
detector doors, this field does not need to be configured*/
"highestThermalThreshold": 37.3,
/*ro, opt, float, upper limit of the temperature threshold*/
"lowestThermalThreshold": 38.5,
/*ro, opt, float, lower limit of the temperature threshold*/
"thermalDoorEnabled": false,
/*ro, opt, bool, whether to open the door according to the temperature threshold, desc:whether to open the door when the temperature is above the
upper limit (highestThermalThreshold) or below the lower limit (lowestThermalThreshold) of the threshold: true (open the door), false (not open the door
(default))*/
"QRCodeEnabled": false,
/*ro, opt, bool, whether to enable QR code function*/
"remoteCheckDoorEnabled": false,
/*ro, opt, bool, whether to enable controlling the door by remote verification*/
"checkChannelType": "Ezviz",
/*ro, opt, enum, verification channel type, subType:string, desc:verification channel type*/
"channelIp": "test",
/*ro, opt, string, IP address of the verification channel, desc:this field is valid when checkChannelType is "PrivateSDK"*/
"needDeviceCheck": true,
/*ro, opt, bool, dep:or,{$.AcsCfg.remoteCheckDoorEnabled,eq,true}*/
"uploadVerificationPic": true,
/*ro, opt, bool, whether to upload the authenticated picture*/
"saveVerificationPic": true,
/*ro, opt, bool, whether to save the authenticated picture*/
/*ro, opt, bool, whether to save the registered face picture*/
"thermalUnit": "celsius",
/*ro, opt, enum, temperature unit, subType:string, desc:"celsius", "fahrenheit"*/
"highestThermalThresholdF": 1.0,
/*ro, opt, float, the maximum value of the temperature threshold, desc:the value is accurate to one decimal place, and the unit is Fahrenheit this
node is used to check whether to open the door when the temperature is higher than the threshold*/
"lowestThermalThresholdF": 1.0,
/*ro, opt, float, the minimum value of the temperature threshold, desc:the value is accurate to one decimal place, and the unit is Fahrenheit this
node is used to check whether to open the door when the temperature is higher than the threshold*/
"enable5G": true,
/*ro, opt, bool, whether to enable 5G*/
"thermalCompensation": 1.0,
/*ro, opt, float, temperature compensation, desc:float,temperature compensation,the value is accurate to one decimal place. The unit depends on the
node thermalUnit. If the node thermalUnit does not exist,the default unit is Celsius*/
"externalCardReaderEnabled": true,
/*ro, opt, bool*/
"combinationAuthenticationTimeout": 1,
/*ro, opt, int, range:[1,20], step:1, unit:s*/
"combinationAuthenticationLimitOrder": true,
/*ro, opt, bool*/
"passwordEnabled": true,
/*ro, opt, bool*/
"showGender": true,
/*ro, opt, bool, whether to display gender*/
"showSignInTime": true,
/*ro, opt, bool*/
"showsCustomInfo": true,
/*ro, opt, bool*/
"showMobileWebQRCode": true,
/*ro, opt, bool*/
"fireAlarmInputType": "alwaysOpen",
"buzzerEnabled": true
/*ro, opt, bool*/
}
}
21.26 Access Point Attendance

21.26.1 Get the configuration capability of the attendance schedule template
Request URL
GET /ISAPI/AccessControl/Attendance/planTemplate/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AttendancePlanTemplateCap": {
/*ro, req, object*/
"templateNo": {
"@min": 1,
"@max": 16
},
"property": {
/*ro, req, object, attendance attribute, desc:"check"-check in and check out, "break"-break out and break in, "overtime"-overtime in and overtime
out*/
"@opt": ["check", "break", "overtime"]
},
"enable": {
/*ro, opt, object, whether to enable, desc:true (yes), false (no)*/
},
"templateName": {
/*ro, opt, object, template name*/
"@min": 1,
"@max": 32
},
"weekPlanNo": {
/*ro, opt, object, week schedule No.*/
"@min": 1,
"@max": 16
},
"holidayGroupNo": {
/*ro, opt, object, holiday group No.*/
"@min": 1,
"@max": 16
}
}
}
21.26.2 Get the list of attendance schedule templates

Request URL
GET /ISAPI/AccessControl/Attendance/planTemplate?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AttendancePlanTemplateList": [
{
"templateNo": 1,
/*ro, req, int, schedule template No., range:[1,16]*/
"enable": true,
/*ro, req, bool, whether to enable the function, desc:true (yes), false (no)*/
"property": "check",
"templateName": "test",
/*ro, req, string, template name, range:[1,32]*/
"weekPlanNo": 1
/*ro, req, int, week schedule No., range:[1,5]*/
}
]
}
21.26.3 Get the configuration capability of attendance check by pressing the key
Request URL
GET /ISAPI/AccessControl/keyCfg/attendance/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AttendanceCap": {
/*ro, req, object*/
"id": {
/*ro, req, object, key No.*/
"@min": 0,
"@max": 0
},
"enable": {
/*ro, req, object, whether to enable*/
},
"label": {
/*ro, opt, object, custom name*/
"@min": 0,
"@max": 0
},
"attendanceStatus": {
/*ro, opt, object, attendance status, desc:attendance status*/
"@opt": ["checkIn", "checkOut", "breakOut", "breakIn", "overtimeIn", "overtimeOut"]
}
}
}
21.26.4 Get the capability of attendance mode parameters

Request URL
GET /ISAPI/AccessControl/Configuration/attendanceMode/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AttendanceMode": {
/*ro, req, object, attendance mode*/
"mode": {
/*ro, opt, object, mode of attendance rule, desc:"disable", "manual", "auto", "manualAndAuto" (manual and auto)*/
"@opt": ["disable", "manual", "auto", "manualAndAuto"]
},
"attendanceStatusTime": {
/*ro, opt, object, attendance status duration, desc:this node is valid when mode is "manual" or "manualAndAuto"*/
"@min": 0,
"@max": 0
},
"reqAttendanceStatus": {
/*ro, opt, object, whether attendance status is required*/
}
}
}
21.26.5 Set the attendance mode parameters

Request URL
PUT /ISAPI/AccessControl/Configuration/attendanceMode?format=json
Query Parameter
None
Request Message
{
"AttendanceMode": {
/*req, object*/
"mode": "disable",
/*opt, enum, attendance mode, subType:string, desc:"disable", "manual", "auto" (automatic), "manualAndAuto" (manual and automatic)*/
"attendanceStatusTime": 0,
/*opt, int, attendance status duration, desc:unit: second; this node is valid when mode is "manual" or "manualAndAuto"*/
"reqAttendanceStatus": true
/*opt, bool, whether the attendance status is required*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.26.6 Get the attendance mode parameters

Request URL
GET /ISAPI/AccessControl/Configuration/attendanceMode?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AttendanceMode": {
/*ro, req, object*/
"mode": "disable",
/*ro, opt, enum, attendance mode, subType:string, desc:"disable", "manual", "auto"-automatic, "manualAndAuto"-manual and automatic*/
"attendanceStatusTime": 0,
/*ro, opt, int, attendance status duration, desc:unit: second. This node is valid when mode is "manual" or "manualAndAuto"*/
"reqAttendanceStatus": true
/*ro, opt, bool, whether the attendance status is required*/
}
}
21.26.7 Get the capability of configuring weekly attendance schedules

Request URL
GET /ISAPI/AccessControl/Attendance/weekPlan/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AttendanceWeekPlanCap": {
/*ro, req, object, the capability of configuring weekly attendance schedules*/
"planNo": {
/*ro, opt, object, weekly schedule No.*/
"@min": 1,
"@max": 16
},
"enable": {
/*ro, opt, object, whether to enable: true-enable,false-disable*/
},
"WeekPlanCfg": {
/*ro, opt, object, weekly schedule parameters*/
"maxSize": 5,
/*ro, opt, int*/
"id": {
/*ro, opt, object, time period No.*/
"@min": 1,
/*ro, opt, int*/
"@max": 8
/*ro, opt, int*/
},
"week": {
/*ro, opt, object*/
"@opt": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
},
"enable": {
/*ro, opt, object, whether to enable: true-enable,false-disable*/
},
"TimeSegment": {
/*ro, opt, object*/
"beginTime": "10:10:00",
/*ro, opt, time, start time (device's local time)*/
"endTime": "12:10:00",
/*ro, opt, time, end time (device's local time)*/
"validUnit": "second"
/*ro, opt, enum, time accuracy, subType:string, desc:"hour", "minute", "second". If this node is not returned, the default time accuracy is
"minute"*/
}
}
}
}
21.26.8 Set the parameters of the week attendance schedule

Request URL
PUT /ISAPI/AccessControl/Attendance/weekPlan/<PlanNo>?format=json
Query Parameter
PlanNo string --
Request Message
{
"AttendanceWeekPlan": {
/*req, object*/
"enable": true,
/*req, bool, whether to enable the function*/
"WeekPlanCfg": [
/*req, array, week schedule parameters, subType:object*/
{
"id": 1,
/*req, int, time period No.*/
"week": "Monday",
/*req, enum, days of the week, subType:string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"*/
"enable": true,
/*req, bool, whether to enable the function*/
"TimeSegment": {
/*req, object, time range*/
"beginTime": "10:10:00",
/*req, time, start time (device's local time)*/
"endTime": "12:10:00"
/*req, time, end time (device's local time)*/
}
}
]
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.26.9 Get the parameters of the week attendance schedule

Request URL
GET /ISAPI/AccessControl/Attendance/weekPlan/<PlanNo>?format=json
Query Parameter
PlanNo string --
Request Message
None
Response Message
{
"AttendanceWeekPlan": {
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable the function*/
"WeekPlanCfg": [
/*ro, req, array, week schedule parameters, subType:object*/
{
"id": 1,
/*ro, req, int, time period No.*/
"week": "Monday",
/*ro, req, enum, day of a week, subType:string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"*/
"enable": true,
"TimeSegment": {
/*ro, req, object, time range*/
"beginTime": "10:10:00",
/*ro, req, time, start time (device's local time)*/
"endTime": "12:10:00"
/*ro, req, time, end time (device's local time)*/
}
}
]
}
}
21.26.10 Set the parameters of the attendance schedule template

Request URL
PUT /ISAPI/AccessControl/Attendance/planTemplate/<TemplateNo>?format=json
Query Parameter
TemplateNo string --
Request Message
{
"AttendancePlanTemplate": {
/*req, object, attendance schedule template*/
"enable": true,
/*req, bool, whether to enable, desc:true (yes), false (no)*/
/*req, enum, attendance attribute, subType:string, desc:"check” (check in and check out), "break” (break out and break in), "overtime” (overtime in
and overtime out). Only one attendance attribute can be configured for each template*/
/*req, string, template name, range:[1,32]*/
"weekPlanNo": 1
/*req, int, week schedule No., range:[1,5]*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.26.11 Get the parameters of the attendance schedule template

Request URL
GET /ISAPI/AccessControl/Attendance/planTemplate/<TemplateNo>?format=json
Query Parameter
TemplateNo string --
Request Message
None
Response Message
{
"AttendancePlanTemplate": {
/*ro, req, object, attendance schedule template*/
"enable": true,
/*ro, req, bool, whether to enable the function, desc:whether to enable: true-enable,false-disable*/
/*ro, req, enum, attendance attribute, subType:string, desc:"check” (check in and check out), "break” (break out and break in), "overtime” (overtime
in and overtime out). Only one attendance attribute can be configured for each template*/
/*ro, req, string, template name, range:[1,32]*/
"weekPlanNo": 1
/*ro, req, int, week schedule No., range:[1,5]*/
}
}
21.26.12 Get the parameter configuration of attendance check by pressing the key
Request URL
GET /ISAPI/AccessControl/keyCfg/<keyID>/attendance?format=json
Query Parameter
keyID string --
Request Message
None
Response Message
{
"Attendance": {
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable*/
"attendanceStatus": "checkIn",
/*ro, opt, enum, attendance status, subType:string, desc:"checkIn” (check in), "checkOut” (check out), "breakOut” (break out), "breakIn” (break in),
"overtimeIn” (overtime in), "overtimeOut” (overtime out)*/
"label": "test"
/*ro, opt, string, self-defined name, range:[1,32]*/
}
}
21.26.13 Set the parameters of attendance check by pressing the key

Request URL
PUT /ISAPI/AccessControl/keyCfg/<keyID>/attendance?format=json
Query Parameter
keyID string --
Request Message
{
"Attendance": {
/*req, object*/
"enable": true,
/*req, bool, whether to enable*/
/*opt, enum, attendance status, subType:string, desc:"checkIn” (check in), "checkOut” (check out), "breakOut” (break out), "breakIn” (break in),
"overtimeIn” (overtime in), "overtimeOut” (overtime out)*/
"label": "test"
/*opt, string, custom name, range:[1,32]*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.27 Multi-Factor Authentication

21.27.1 Clear group parameters
Request URL
PUT /ISAPI/AccessControl/ClearGroupCfg?format=json
Query Parameter
None
Request Message
{
"ClearGroupCfg": {
/*opt, object, group parameters*/
"ClearFlags": {
/*opt, object*/
"groupCfg": true
/*req, bool, whether to clear group parameters*/
}
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
}
21.27.2 Get the capability of clearing group parameters

Request URL
GET /ISAPI/AccessControl/ClearGroupCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"ClearGroupCfg": {
/*ro, opt, object*/
"ClearFlags": {
/*ro, opt, object*/
"groupCfg": "true,false"
/*ro, req, string, group parameters*/
}
}
}
21.27.3 Get the group configuration parameters

Request URL
GET /ISAPI/AccessControl/GroupCfg/<groupID>?format=json
Query Parameter
groupID string --
Request Message
None
Response Message
{
"GroupCfg": {
/*ro, opt, object, group parameters*/
"enable": true,
"ValidPeriodCfg": {
/*ro, opt, object, validity period of the group*/
"enable": true,
/*ro, req, bool, whether to enable validity period*/
"beginTime": "1970-01-01T00:00:00+08:00",
/*ro, req, datetime, start time of the validity period (UTC time)*/
"endTime": "1970-01-01T00:00:00+08:00"
/*ro, req, datetime, end time of the validity period (UTC time)*/
},
"groupName": "test"
/*ro, opt, string*/
}
}
21.27.4 Set the group parameters

Request URL
PUT /ISAPI/AccessControl/GroupCfg/<groupID>?format=json
Query Parameter
groupID string --
Request Message
{
"GroupCfg": {
/*opt, object, group parameters*/
"enable": true,
/*req, bool, whether to enable the group*/
"ValidPeriodCfg": {
/*opt, object, validity period of the group*/
"enable": true,
/*req, bool, whether to enable validity period*/
"beginTime": "1970-01-01T00:00:00+08:00",
/*req, datetime, start time of the validity period (UTC time)*/
"endTime": "1970-01-01T00:00:00+08:00"
/*req, datetime, end time of the validity period (UTC time)*/
},
"groupName": "test"
/*opt, string, group name*/
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
}
21.27.5 Get the configuration capability of multi-factor authentication mode

Request URL
GET /ISAPI/AccessControl/MultiCardCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"MultiCardCfg": {
/*ro, opt, object*/
"doorNo": {
/*ro, opt, object, door No.*/
"@min": 1,
"@max": 256
},
/*ro, req, string, whether to enable multi-factor authentication*/
"swipeIntervalTimeout": {
/*ro, opt, object, timeout of swiping (authentication) interval*/
"@min": 1,
"@max": 255
},
"GroupCfg": {
/*ro, opt, object, multi-factor authentication parameters*/
"maxSize": 20,
"id": {
/*ro, opt, object, multi-factor authentication No.*/
"@min": 1,
"@max": 20
},
/*ro, opt, string, whether to enable multi-factor authentication*/
"enableOfflineVerifyMode": "true,false",
/*ro, opt, string, whether to enable verification mode when the access control device is offline (the super password will replace opening door
remotely)*/
"templateNo": {
/*ro, opt, object, schedule template No. to enable the multi-factor authentication*/
"@min": 1,
"@max": 20
},
"GroupCombination": {
/*ro, opt, object, parameters of the multi-factor authentication group*/
"maxSize": 8,
/*ro, opt, string, whether to enable multi-factor authentication*/
"memberNum": {
/*ro, opt, object, number of members swiping cards*/
"@min": 1,
"@max": 20
},
"sequenceNo": {
/*ro, opt, object, serial No. of swiping cards of the multi-factor authentication group*/
"@min": 1,
"@max": 8
},
"groupNo": {
/*ro, opt, object, group No.*/
"@min": 1,
"@max": 20
}
}
}
}
}
21.27.6 Set parameters of multi-factor authentication mode

Request URL
PUT /ISAPI/AccessControl/MultiCardCfg/<doorID>?format=json
Query Parameter
doorID string --
Request Message
{
"MultiCardCfg": {
/*opt, object, parameters of multi-factor authentication mode*/
"enable": true,
/*req, bool, whether to enable multi-factor authentication*/
"swipeIntervalTimeout": 10,
/*opt, int, timeout of swiping (authentication) interval*/
"GroupCfg": [
/*opt, array, multi-factor authentication parameters, subType:object*/
{
"id": 1,
/*opt, int, multi-factor authentication No.*/
"enable": true,
/*opt, bool, whether to enable multi-factor authentication*/
"enableOfflineVerifyMode": true,
/*opt, bool, whether to enable verification mode when the access control device is offline (the super password will replace opening door
remotely)*/
"templateNo": 1,
/*opt, int, schedule template No. to enable the multi-factor authentication*/
"GroupCombination": [
/*opt, array, parameters of the multi-factor authentication group, subType:object*/
{
"enable": true,
/*opt, bool, whether to enable multi-factor authentication*/
"memberNum": 3,
/*opt, int, number of members swiping cards*/
"sequenceNo": 1,
/*opt, int, serial No. of swiping cards of the multi-factor authentication group*/
"groupNo": 1
/*opt, int, group No.*/
}
]
}
]
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
}
21.27.7 Get the configuration parameters of multi-factor authentication mode

Request URL
GET /ISAPI/AccessControl/MultiCardCfg/<doorID>?format=json
Query Parameter
doorID string --
Request Message
None
Response Message
{
"MultiCardCfg": {
/*ro, opt, object*/
"enable": true,
/*ro, req, bool, whether to enable multi-factor authentication*/
"swipeIntervalTimeout": 10,
/*ro, opt, int, timeout of swiping (authentication) interval*/
"GroupCfg": [
/*ro, opt, array, multi-factor authentication parameters, subType:object*/
{
"id": 1,
/*ro, opt, int, multi-factor authentication No.*/
"enable": true,
/*ro, opt, bool, whether to enable multi-factor authentication*/
"enableOfflineVerifyMode": true,
/*ro, opt, bool, whether to enable verification mode when the access control device is offline (the super password will replace opening door
remotely)*/
"templateNo": 1,
/*ro, opt, int, schedule template No. to enable the multi-factor authentication*/
"GroupCombination": [
/*ro, opt, array, multi-factor authentication parameters, subType:object*/
{
"enable": true,
/*ro, opt, bool, whether to enable multi-factor authentication*/
"memberNum": 3,
/*ro, opt, int, number of members swiping cards*/
"sequenceNo": 1,
/*ro, opt, int, serial No. of swiping cards of the multi-factor authentication group*/
"groupNo": 1
/*ro, opt, int, group No.*/
}
]
}
]
}
}
21.27.8 Get the group configuration capability

Request URL
GET /ISAPI/AccessControl/GroupCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"GroupCfg": {
/*ro, opt, object, group parameters*/
"groupNo": {
"@min": 1,
"@max": 1
},
/*ro, req, string, whether to enable the group*/
"ValidPeriodCfg": {
/*ro, req, object, whether to enable validity period parameters of the group*/
/*ro, req, string, whether to enable validity period*/
"beginTime": {
/*ro, req, object, start time of the validity period (UTC time)*/
"@min": 1,
"@max": 32
},
"endTime": {
/*ro, req, object, end time of the validity period (UTC time)*/
"@min": 1,
"@max": 32
}
},
"groupName": {
/*ro, opt, object, group name*/
"@min": 1,
"@max": 32
}
}
}
21.28 Access Control Event Management

21.28.1 Clear event card linkage configurations
Request URL
PUT /ISAPI/AccessControl/ClearEventCardLinkageCfg?format=json
Query Parameter
None
Request Message
{
"ClearEventCardLinkageCfg": {
/*req, object*/
"ClearFlags": {
/*opt, object*/
"eventCardLinkage": true
/*req, bool, whether to clear event and card linkage parameters*/
}
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
/*ro, opt, string, error information, desc:this node must be returned when the value of statusCode is not 1*/
}
21.28.2 Get the configuration capability of storing access control events
Request URL
GET /ISAPI/AccessControl/AcsEvent/StorageCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"EventStorageCfgCap": {
/*ro, req, object, configuration capability of event storing*/
"mode": {
/*ro, req, object, event storage method, desc:"regular" (delete old events periodically), "time" (delete old events by specified time), "cycle"
(overwriting)*/
"@opt": ["regular", "time", "cycle"]
},
"checkTime": {
/*ro, opt, object, check time, desc:this node is valid when mode is "time". Events that occurred before the check time will be deleted*/
"@min": 0,
"@max": 0
},
"period": {
/*ro, opt, object, time period for deleting old events, desc:this node is valid when mode is "regular"*/
"@min": 10,
"@max": 10
}
}
}
21.28.3 Set the event card linkage parameters

Request URL
PUT /ISAPI/AccessControl/EventCardLinkageCfg/<ACEID>?format=json
Query Parameter
ACEID string --
Request Message
{
"EventCardLinkageCfg": {
/*req, object, event card linkage parameters*/
"proMode": "event",
/*req, enum, linkage type, subType:string, desc:"event” (event linkage), "card” (card linkage), "mac" (MAC address linkage), "employee” (employee
No., i.e., person ID)*/
"EventLinkageInfo": {
/*opt, object, event linkage parameters, desc:it is valid when proMode is "event"*/
"mainEventType": 0,
/*opt, enum, major event type, subType:int, desc:0-device event, 1-alarm input event, 2-access control point event, 3-authentication unit (card
reader, fingerprint module) event*/
"subEventType": 54
/*opt, int, sub event type, desc:minor event type,refer to Event Linkage Types for details*/
},
"CardNoLinkageInfo": {
/*opt, object, card linkage parameters, desc:it is valid when proMode is "card”*/
"cardNo": "test"
},
"MacAddrLinkageInfo": {
/*opt, object, MAC address linkage parameters, desc:it is valid when proMode is "mac"*/
"MACAddr": "test"
/*opt, string, MAC address linkage parameters*/
},
"EmployeeInfo": {
/*opt, object, employee No. (person ID) linkage parameters, desc:it is valid when proMode is "employee”*/
},
"eventSourceID": 1,
/*opt, int, event source ID, desc:it is valid when proMode is "event". For device event (mainEventType is 0), this field is invalid; for access
control point event (mainEventType is 2), this field refers to the access control point No.; for authentication unit event (mainEventType is 3), this field
refers to the authentication unit No.; for alarm input event (mainEventType is 1), this field refers to the zone alarm input ID or the event alarm input ID
65535-all*/
"alarmout": [1, 3, 5],
/*opt, array, linked alarm output No., subType:int, desc:[1,3,5]: 1-linked alarm output No.1; 3-linked alarm output No.3; 5-linked alarm output
No.5*/
"ReaderAlarmout": [
/*opt, array, subType:object*/
{
"readerID": 1,
/*opt, int, card reader No.*/
"alarmOut": [1, 3, 5],
"alarmOutClose": [1, 3, 5]
/*opt, array, linked alarm output No. to disable, subType:int, desc:[1,3,5]: 1-alarm output No.1, 3-alarm output No.3, 5-alarm output No.5*/
}
],
"openDoor": [1, 3, 5],
/*opt, array, linked door No. to open, subType:int, desc:[1,3,5]: 1-linked door No.1, 3-linked door No.3, 5-linked door No.5*/
"closeDoor": [1, 3, 5],
/*opt, array, linked door No. to close, subType:int, desc:[1,3,5]: 1-linked door No.1, 3-linked door No.3, 5-linked door No.5*/
"alwaysOpen": [1, 3, 5],
/*opt, array, linked door No. to remain unlocked, subType:int, desc:[1,3,5]: 1-linked door No.1, 3-linked door No.3, 5-linked door No.5*/
"alwaysClose": [1, 3, 5],
/*opt, array, linked door No. to remain locked, subType:int, desc:[1,3,5]: 1-linked door No.1, 3-linked door No.3, 5-linked door No.5*/
"mainDevBuzzer": true,
/*opt, bool, whether to enable buzzer linkage of the access controller (start buzzing):, desc:false-no, true-yes*/
"capturePic": true,
/*opt, bool, whether to enable capture linkage, desc:false-no, true-yes*/
"readerCapturePic": [1, 2],
"recordVideo": true,
/*opt, bool, whether to enable recording linkage, desc:false-no, true-yes*/
"readerRecordVideo": [1, 2],
"mainDevStopBuzzer": true,
/*opt, bool, whether to enable buzzer linkage of access controller (stop buzzing), desc:false-no, true-yes*/
"audioSourceType": "TTS",
"audioDisplayTTSLanguage": "SimChinese",
/*opt, enum, subType:string, dep:and,{$.EventCardLinkageCfg.audioSourceType,eq,TTS}*/
"audioDisplayTTS": "test",
/*opt, string, range:[1,64], dep:and,{$.EventCardLinkageCfg.audioSourceType,eq,TTS}*/
"customAudioID": 1,
/*opt, int, range:[1,65535], dep:and,{$.EventCardLinkageCfg.audioSourceType,eq,customFile}*/
"audioDisplayMode": "close",
/*opt, enum, linked audio announcement mode, subType:string, desc:"close", "single", "loop"*/
"readerBuzzer": [1, 3, 5],
/*opt, array, linked buzzer No., subType:int, desc:[1,3,5]: 1-buzzer No.1, 3-buzzer No.3, 5-buzzer No.5*/
"alarmOutClose": [1, 3, 5],
/*opt, array, linked alarm output No. to disable, subType:int, desc:[1,3,5]: 1-alarm output No.1, 3-alarm output No.3, 5-alarm output No.5*/
"alarmInSetup": [1, 3, 5],
/*opt, array, linked zone No. to arm, subType:int, desc:[1,3,5]: 1-zone No.1, 3-zone No.3, 5-zone No.5*/
"alarmInClose": [1, 3, 5],
/*opt, array, linked zone No. to disarm, subType:int, desc:[1,3,5]: 1-zone No.1, 3-zone No.3, 5-zone No.5*/
"readerStopBuzzer": [1, 3, 5],
/*opt, array, linked buzzer No. to stop buzzing, subType:int, desc:[1,3,5]: 1-buzzer No.1, 3-buzzer No.3, 5-buzzer No.5*/
"duration": 30,
/*opt, int, range:[0,30], unit:s*/
"eventCardLinkageName": "test",
"FireMatrixEventSourceList": [
/*opt, array, subType:object, dep:and,{$.EventCardLinkageCfg.EventLinkageInfo.subEventType,eq,52}*/
{
"IoTChannelID": 1,
/*req, int*/
"channels": [1, 2, 3]
}
],
"Operations": {
/*opt, object*/
"eventSourceIDList": [1, 2],
/*req, array, subType:int*/
"TerminalsInfo": [
/*opt, array, terminal list, subType:object, range:[0,1024]*/
{
"terminalID": 1,
/*req, int, range:[1,1024]*/
"ACPChannels": [1, 2]
}
],
"audioSource": "audioFile",
/*req, enum, subType:string*/
"materialIdList": [1, 2],
"speechSynthesisContent": "test",
"voiceType": "male",
"audioLevel": 0,
/*req, int, range:[0,15], step:1*/
"audioVolume": 5,
/*opt, int, range:[0,10]*/
"playMode": "order",
/*opt, enum, play mode, subType:string*/
"duration": 30
/*opt, int, range:[0,3000], unit:s*/
}
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
}
21.28.4 Get the total number of access control events by specific conditions
Request URL
POST /ISAPI/AccessControl/AcsEventTotalNum?format=json
Query Parameter
None
Request Message
{
"AcsEventTotalNumCond": {
/*req, object*/
"major": 1,
/*req, int, major alarm type, desc:(the type value should be transformed to the decimal number), refer to Access Control Event Types for details*/
"minor": 1024,
/*req, int, sub type, step:1, desc:(the type value should be transformed to the decimal number),refer to Access Control Event Types for details*/
"startTime": "1970-01-01+08:00",
/*opt, date, start time (UTC time)*/
"endTime": "1970-01-01+08:00",
/*opt, date, end time (UTC time)*/
"cardNo": "test",
"name": "test",
/*opt, string, name of the card holder*/
"picEnable": true,
/*opt, bool, whether to upload the picture along with the event information, desc:whether to contain pictures: "true"-yes,"false"-no*/
"beginSerialNo": 1,
/*opt, int, start serial No.*/
"endSerialNo": 100,
/*opt, int, end serial No.*/
"employeeNoString": "test"
/*opt, string, employee No. (person ID), range:[1,32]*/
}
}
Response Message
{
"AcsEventTotalNum": {
/*ro, req, object*/
"totalNum": 1,
/*ro, req, int, total number of events that match the search conditions*/
"existedEventNum": 1
/*ro, opt, int*/
}
}
21.28.5 Get the event and card linkage configuration parameters
Request URL
GET /ISAPI/AccessControl/EventCardLinkageCfg/<ACEID>?format=json
Query Parameter
ACEID string --
Request Message
None
Response Message
{
/*ro, req, object*/
"proMode": "event",
/*ro, req, enum, linkage type, subType:string, desc:"event"-event linkage, "card"-card linkage, "mac"-MAC address linkage, "employee"-employee No.
(person ID)*/
/*ro, opt, object, event linage parameters, desc:it is valid when proMode is "event”*/
"mainEventType": 0,
/*ro, opt, enum, major event type, subType:int, desc:0-device event,1-alarm input event,2-access control point event,3-authentication unit (card
reader, fingerprint module) event*/
"subEventType": 54
/*ro, opt, int, event sub type, desc:minor event type,refer to Event Linkage Types for details*/
},
/*ro, opt, object, card linkage parameters, desc:it is valid when proMode is "card”*/
"cardNo": "test"
/*ro, opt, string, card No.*/
},
/*ro, opt, object, MAC address linkage parameters, desc:it is valid when proMode is "mac”*/
"MACAddr": "test"
/*ro, opt, string, physical MAC address*/
},
"EmployeeInfo": {
/*ro, opt, object, employee No. (person ID) linkage parameters, desc:it is valid when proMode is "employee”*/
/*ro, opt, string, employee No. (person ID)*/
},
"eventSourceID": 1,
/*ro, opt, int, event source ID, desc:it is valid when proMode is "event",65535-all. For device event (mainEventType is 0),this field is invalid;
for access control point event (mainEventType is 2),this field refers to the access control point No.; for authentication unit event (mainEventType is
3,this field refers to the authentication unit No.; for alarm input event (mainEventType is 1),this field refers to the zone alarm input ID or the event
alarm input ID*/
"alarmout": [1, 3, 5],
/*ro, opt, array, linked alarm output No., subType:int, desc:[1,3,5]: 1-linked alarm output No.1; 3-linked alarm output No.3; 5-linked alarm output
No.5*/
"ReaderAlarmout": [
{
"readerID": 1,
/*ro, opt, int, card reader number*/
"alarmOut": [1, 3, 5],
"alarmOutClose": [1, 3, 5]
/*ro, opt, array, linked alarm output No. to disable, subType:int, desc:e.g,[1,3,5]: 1-alarm output No.1,3-alarm output No.3,5-alarm output
No.5*/
}
],
"openDoor": [1, 3, 5],
/*ro, opt, array, linked door No. to open, subType:int, desc:[1,3,5]: 1-linked door No.1; 3-linked door No.3; 5-linked door No.5*/
"closeDoor": [1, 3, 5],
/*ro, opt, array, linked door No. to close, subType:int, desc:[1,3,5]: 1-linked door No.1; 3-linked door No.3; 5-linked door No.5*/
"alwaysOpen": [1, 3, 5],
/*ro, opt, array, linked door No. to remain unlocked, subType:int, desc:e.g.,[1,3,5]: 1-linked door No.1; 3-linked door No.3; 5-linked door No.5*/
"alwaysClose": [1, 3, 5],
/*ro, opt, array, linked door No. to remain locked, subType:int, desc:[1,3,5]: 1-linked door No.1; 3-linked door No.3; 5-linked door No.5*/
"mainDevBuzzer": true,
/*ro, opt, bool, whether to enable buzzer linkage of the access controller (start buzzing), desc:"false"-no, "true"-yes*/
"capturePic": true,
/*ro, opt, bool, whether to enable capture linkage, desc:"false"-no, "true"-yes*/
"readerCapturePic": [1, 2],
/*ro, opt, array, subType:int, range:[0,8]*/
"recordVideo": true,
/*ro, opt, bool, whether to enable recording linkage, desc:"false"-no, "true"-yes*/
"readerRecordVideo": [1, 2],
"mainDevStopBuzzer": true,
/*ro, opt, bool, whether to enable buzzer linkage of access controller (stop buzzing), desc:"false"-no,"true"-yes*/
"audioDisplayTTSLanguage": "SimChinese",
/*ro, opt, enum, subType:string, dep:and,{$.EventCardLinkageCfg.audioSourceType,eq,TTS}*/
"audioDisplayTTS": "test",
/*ro, opt, string, range:[1,64], dep:and,{$.EventCardLinkageCfg.audioSourceType,eq,TTS}*/
"customAudioID": 1,
/*ro, opt, int, range:[1,65535], dep:and,{$.EventCardLinkageCfg.audioSourceType,eq,customFile}*/
"audioDisplayMode": "close",
/*ro, opt, enum, linked audio announcement mode: "close", "single", "loop", subType:string, desc:linked audio announcement mode:
"close","single","loop"*/
"readerBuzzer": [1, 3, 5],
/*ro, opt, array, linked buzzer No., subType:int, desc:[1,3,5]: 1-buzzer No.1,3-buzzer No.3,5-buzzer No.5*/
"alarmOutClose": [1, 3, 5],
/*ro, opt, array, linked alarm output No. to disable, subType:int, desc:[1,3,5]: 1-alarm output No.1, 3-alarm output No.3,5-alarm output No.5*/
"alarmInSetup": [1, 3, 5],
/*ro, opt, array, linked zone No. to arm, subType:int, desc:[1,3,5]: 1-zone No.1,3-zone No.3,5-zone No.5*/
"alarmInClose": [1, 3, 5],
/*ro, opt, array, linked zone No. to disarm, subType:int, desc:e.g,[1,3,5]: 1-zone No.1,3-zone No.3,5-zone No.5*/
"readerStopBuzzer": [1, 3, 5],
/*ro, opt, array, linked buzzer No. to stop buzzing, subType:int, desc:[1,3,5]: 1-buzzer No.1,3-buzzer No.3,5-buzzer No.*/
"duration": 30,
/*ro, opt, int, range:[0,30], unit:s*/
"eventCardLinkageName": "test",
"FireMatrixEventSourceList": [
/*ro, opt, array, subType:object, dep:and,{$.EventCardLinkageCfg.EventLinkageInfo.subEventType,eq,52}*/
{
"IoTChannelID": 1,
/*ro, req, int*/
"channels": [1, 2, 3]
}
],
"Operations": {
/*ro, opt, object*/
"eventSourceIDList": [1, 2],
/*ro, req, array, subType:int*/
"TerminalsInfo": [
/*ro, opt, array, terminal list, subType:object, range:[0,1024]*/
{
"terminalID": 1,
/*ro, req, int, range:[1,1024]*/
"ACPChannels": [1, 2]
}
],
"audioSource": "audioFile",
/*ro, req, enum, subType:string*/
"materialIdList": [1, 2],
"speechSynthesisContent": "test",
"voiceType": "male",
"audioLevel": 0,
/*ro, req, int, range:[0,15], step:1*/
"audioVolume": 5,
"playMode": "order",
/*ro, opt, enum, play mode, subType:string*/
"duration": 30
/*ro, opt, int, range:[0,3000], unit:s*/
}
}
}
21.28.6 Search for access control events

Request URL
POST /ISAPI/AccessControl/AcsEvent?format=json
Query Parameter
None
Request Message
{
"AcsEventCond": {
/*req, object, access control events*/
"searchID": "test",
/*req, string, search ID, desc:it is used to check whether the current search requester is the same as the previous one. If they are the same, the
search record will be stored in the device to speed up the next search*/
/*req, int, the start position of the search result in the result list:, desc:in a single search, if you cannot get all the records in the result
list, you can mark the end position and get the following records after the marked position in the next search. If the maximum number of totalMatches
supported by the device is M and the number of totalMatches stored in the device now is N (N<=M), the valid range of this node is 0 to N-1*/
"maxResults": 30,
/*req, int, the maximum number of search results, which is defined by the device capability, will be returned if the value of maxResults reaches the
limit, desc:if maxResults exceeds the range returned by the device capability, the device will return the maximum number of search results according to the
device capability and will not return error message*/
"major": 1,
/*req, int, major type, desc:the type value should be transformed to the decimal number; see Access Control Event Types for details*/
"minor": 1024,
/*req, int, minor type, desc:the type value should be transformed to the decimal number; see Access Control Event Types for details*/
"startTime": "1970-01-01T00:00:00+08:00",
/*opt, datetime, start time (UTC time)*/
"endTime": "1970-01-01T00:00:00+08:00",
/*opt, datetime, end time (UTC time)*/
"cardNo": "test",
"name": "test",
/*opt, string, name of the card holder*/
"videoChannel": 1,
/*opt, int, video channel No., range:[1,86400], desc:this node is newly added to DeepinMind devices for attendance*/
"picEnable": true,
/*opt, bool, whether to upload the picture along with the event information, desc:false (no), true (yes, default value); (1. all matched events will
be uploaded without pictures; 2. all matched events will be uploaded with pictures if there are any; 3. if this node is not configured, the default value is
true)*/
"beginSerialNo": 1,
"endSerialNo": 1,
"employeeNoString": "test",
"timeReverseOrder": true,
/*opt, bool, whether to return events in descending order of time (later events will be returned first), desc:true (yes), false or this node is not
returned (no)*/
/*opt, bool, whether the skin-surface temperature is abnormal*/
"temperatureSearchCond": "all",
/*opt, enum, temperature search condition, subType:string, desc:when this node and isAbnormalTemperature both exist, isAbnormalTemperature is
invalid; "all" (event with temperature), "normal" (event with normal temperature), "abnormal" (event with abnormal temperature)*/
"isAttendanceInfo": true,
/*opt, bool, whether it contains attendance records, desc:this node is newly added to HEOP protocol; if this node is true, main type, minor type,
employee No., name, and time will be returned*/
"hasRecordInfo": true
/*opt, bool*/
}
}
Response Message
{
"AcsEvent": {
/*ro, req, object, access control events*/
"searchID": "test",
/*ro, req, string, search ID, it is used to check whether the current search requester is the same as the previous one. If they are the same, the
search record will be stored in the device to speed up the next search*/
/*ro, req, string, searching status description*/
"numOfMatches": 1,
"totalMatches": 1,
"InfoList": [
/*ro, opt, array, information list, subType:object*/
{
"major": 1,
/*ro, req, int, major alarm type*/
"minor": 1,
/*ro, req, int, minor alarm type*/
"time": "2016-12-12T17:30:08+08:00",
/*ro, req, string, time (UTC time)*/
"netUser": "test",
/*ro, opt, string, user name*/
"videoChannel": 1,
/*ro, opt, int, video channel No., range:[1,86400], desc:this node is newly added to DeepinMind devices for attendance*/
"cardNo": "test",
"cardType": 1,
/*ro, opt, enum, card type, subType:int, desc:1 (normal card), 2 (disability card), 3 (blocklist card), 4 (patrol card), 5 (duress card), 6
(super card), 7 (visitor card), 8 (dismiss card)*/
"whiteListNo": 1,
/*ro, opt, int, allowlist No.*/
"reportChannel": 1,
/*ro, opt, int, channel type for uploading alarm/event*/
"cardReaderKind": 1,
/*ro, opt, int, card reader type: 1 (IC card reader)*/
"cardReaderNo": 1,
/*ro, opt, int, card reader No.*/
"doorNo": 1,
/*ro, opt, int, door or floor No.*/
"verifyNo": 1,
/*ro, opt, int, multi-factor authentication No.*/
"alarmInNo": 1,
/*ro, opt, int, alarm input No.*/
"alarmOutNo": 1,
/*ro, opt, int, alarm output No.*/
"caseSensorNo": 1,
/*ro, opt, int, event trigger No.*/
"RS485No": 1,
/*ro, opt, int, RS-485 channel No.*/
"multiCardGroupNo": 1,
"accessChannel": 1,
"deviceNo": 1,
"distractControlNo": 1,
/*ro, opt, int, distributed controller No.*/
/*ro, opt, string, employee No. (person ID)*/
"localControllerID": 1,
/*ro, opt, int, distributed controller No.*/
"InternetAccess": 1,
/*ro, opt, int, network interface No.*/
"type": 1,
/*ro, opt, int, zone type, desc:0 (instant alarm zone), 1 (24-hour zone), 2 (delayed zone), 3 (internal zone), 4 (key zone), 5 (fire alarm
zone), 6 (perimeter zone), 7 (24-hour silent zone), 8 (24-hour auxiliary zone), 9 (24-hour shock zone), 10 (emergency door open zone), 11 (emergency door
closed zone), 255 (none)*/
"MACAddr": "test",
"swipeCardType": 1,
/*ro, opt, enum, card swiping type, subType:int, desc:0 (invalid), 1 (QR code)*/
"serialNo": 1,
"channelControllerID": 1,
/*ro, opt, int, lane controller ID*/
"channelControllerLampID": 1,
/*ro, opt, int, light board ID of lane controller, range:[1,255]*/
"channelControllerIRAdaptorID": 1,
/*ro, opt, int, IR adapter ID of lane controller, range:[1,255]*/
"channelControllerIREmitterID": 1,
/*ro, opt, int, active infrared intrusion detector No. of lane controller, range:[1,255]*/
/*ro, opt, string, person type*/
"currentVerifyMode": "cardAndPw",
/*ro, opt, enum, current authentication mode of the card reader, subType:string, desc:"cardAndPw" (card + password); "card", "cardOrPw"
(card or password), "fp" (fingerprint), "fpAndPw" (fingerprint + password), "fpOrCard" "fingerprint or card", "fpAndCard" (fingerprint + card),
"fpAndCardAndPw" (fingerprint + card + password), "faceOrFpOrCardOrPw" (face or fingerprint or card or password), "faceAndFp" (face + fingerprint),
"faceAndPw" (face + password), "faceAndCard" (face + card), "face", "employeeNoAndPw" (emplyee No. +password), "fpOrPw" (fingerprint or password),
"employeeNoAndFp" (employee No. + fingerprint), "employeeNoAndFpAndPw" (employee No. + fingerprint + password), "faceAndFpAndCard" (face + fingerprint +
card), "faceAndPwAndFp" (face + password + fingerprint), "employeeNoAndFace" (employee No. + face), "faceOrfaceAndCard" (face or face + card), "fpOrface"
(fingerprint or face), "cardOrfaceOrPw" (card or face or password), "faceOrFpOrCardOrPwOrIris" (face or fingerprint or card or password or iris),
"faceOrCardOrPwOrIris" (face or card or password or iris), "sleep", "invalid"*/
/*ro, opt, string, QR code information*/
/*ro, opt, enum, temperature unit, subType:string, desc:"celsius" (Celsius, default value), "fahrenheit" (Fahrenheit), "kelvin" (Kelvin)*/
/*ro, opt, float, skin-surface temperature, which is accurate to one decimal place*/
/*ro, opt, bool, whether the skin-surface temperature is abnormal (true-yes)*/
"positionX": 254,
/*ro, opt, int, normalized X-coordinate which is between 0 and 1000*/
"positionY": 133
/*ro, opt, int, normalized Y-coordinate which is between 0 and 1000*/
},
"mask": "unknown",
/*ro, opt, enum, whether the person wears a mask, subType:string, desc:"unknown"*/
/*ro, opt, string, picture URL*/
"filename": "picture1",
/*ro, opt, string, file name, desc:if multiple pictures are returned at a time, filename of each picture should be unique*/
"attendanceStatus": "undefined",
/*ro, opt, enum, attendance status, subType:string, desc:"undefined", "checkIn" (check-in), "checkOut" (check-out), "breakOut" (start of
break), "breakIn" (end of break), "overtimeIn" (start of overtime), "overTimeOut" (end of overtime)*/
"label": "test",
/*ro, opt, string, custom attendance name*/
"statusValue": 1,
/*ro, opt, int, status value*/
"visibleLightPicUrl": "test",
/*ro, opt, string, visible light picture URL*/
/*ro, opt, string, visible light picture URL*/
"thermalPicUrl": "test",
/*ro, opt, string, URL of the thermal imaging picture*/
"appType": "attendance",
/*ro, opt, enum, application type, subType:string, desc:"attendance" (Time & Attendance module), "signIn" (Check-In module, which is only
used for FocSign products)*/
"HealthInfo": {
"healthCode": 1,
/*ro, opt, enum, health code status, subType:int, desc:0 (no request), 1 (no health code), 2 (green QR code), 3 (yellow QR code), 4 (red
QR code), 5 (no such person), 6 (other error, e.g., searching failed due to API exception), 7 (searching for the health code timed out)*/
"NADCode": 1,
"travelCode": 1,
/*ro, opt, enum, trip code, subType:int, desc:0 (no trip in the past 14 days), 1 (has left the current area in the past 14 days), 2 (has
/*ro, opt, string*/
"vaccineStatus": 1,
"vaccineNum": 1
},
"meetingID": "test",
/*ro, opt, string, meeting ID*/
/*ro, opt, array, additional person information, subType:object, desc:this node displays additional person information on the device*/
{
"id": 1,
/*ro, opt, int, extended ID of the additional person information, range:[1,32], desc:related URL:
/ISAPI/AccessControl/personInfoExtendName?format=json; this node is used for displaying the name of value; if ID does not exists, it starts from 1*/
"value": "test"
}
],
"name": "test",
/*ro, opt, string, name, desc:person name*/
"FaceRect": {
"height": 1.000,
"width": 1.000,
"x": 0.000,
"y": 0.000
},
"RecordInfo": {
/*ro, opt, object*/
"startTime": "1970-01-01T00:00:00+08:00",
/*ro, opt, datetime, recording start time*/
"endTime": "1970-01-01T00:00:00+08:00",
/*ro, opt, datetime, recording end time*/
"playbackURL": "rtsp://10.65.130.168:554/ISAPI/Streaming/tracks/201/?starttime=20190213T091134Z&endtime=20190213T092116Z"
},
"allowAuthenticationTimes": 1
}
]
}
}
21.28.7 Get the capability of searching for access control events

Request URL
GET /ISAPI/AccessControl/AcsEvent/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AcsEvent": {
/*ro, req, object, access control events*/
"AcsEventCond": {
"searchID": {
/*ro, req, object, search ID, it is used to check whether the current search requester is the same as the previous one. If they are the same,
the search record will be stored in the device to speed up the next search*/
"@min": 1,
"@max": 1
},
"searchResultPosition": {
/*ro, req, object, the start position of the search result in the result list*/
"@min": 1,
"@max": 1
},
"maxResults": {
/*ro, req, object, the maximum number of search results that can be obtained by calling this URL*/
"@min": 1,
"@max": 1
},
"major": {
/*ro, opt, object, major alarm type (the type value should be transformed to the decimal number)*/
"@opt": "0,1,2,3,5"
/*ro, req, string, major type*/
},
"minorAlarm": {
/*ro, opt, object, minor alarm type (the type value should be transformed to the decimal number)*/
"@opt": "1024,1025,1026,1027…"
/*ro, req, string, minor alarm type*/
},
"minorException": {
/*ro, opt, object, minor exception type (the type value should be transformed to the decimal number)*/
"@opt": "39,58,59,1024…"
/*ro, req, string, minor exception type*/
},
"minorOperation": {
/*ro, opt, object, minor operation type (the type value should be transformed to the decimal number)*/
"@opt": "80,90,112,113…"
/*ro, req, string, minor operation type*/
},
"minorEvent": {
/*ro, opt, object, minor event type (the type value should be transformed to the decimal number)*/
"@opt": "1,2,3,4…"
/*ro, req, string, minor event type*/
},
"startTime": {
/*ro, opt, object, start time*/
"@min": 0,
/*ro, req, int, the minimum value, range:[0,32]*/
"@max": 32
/*ro, req, int, the maximum value, range:[0,32]*/
},
"endTime": {
/*ro, opt, object, end time*/
"@min": 0,
"@max": 32
},
"cardNo": {
"@min": 1,
"@max": 1
},
"name": {
/*ro, opt, object, name of the card holder*/
"@min": 1,
"@max": 1
},
"videoChannel": {
/*ro, opt, object, video channel No. (this node is newly added to DeepinMind devices for attendance)*/
"@min": 1,
"@max": 1
},
"picEnable": "true,false",
/*ro, opt, string, whether to include pictures*/
"beginSerialNo": {
/*ro, opt, object, start serial No.*/
"@min": 1,
"@max": 1
},
"endSerialNo": {
/*ro, opt, object, end serial No.*/
"@min": 1,
"@max": 1
},
"employeeNoString": {
/*ro, opt, object, employee No.*/
"@min": 1,
"@max": 1
},
"isAbnomalTemperature": {
/*ro, opt, object, whether the skin-surface temperature is abnormal*/
/*ro, req, array, options, subType:bool, desc:true (yes), false (no)*/
},
"temperatureSearchCond": {
/*ro, opt, object, temperature search condition*/
"@opt": ["all", "normal", "abnormal"]
},
"isAttendanceInfo": {
/*ro, opt, object, whether it contains attendance records*/
/*ro, req, array, options, subType:bool, desc:true (yes), false (no)*/
},
"hasRecordInfo": {
/*ro, opt, object*/
}
},
"InfoList": {
/*ro, opt, object, information list*/
"maxSize": 10,
"time": {
/*ro, opt, object, time (UTC time)*/
"@min": 0,
"@max": 32
},
"netUser": {
/*ro, opt, object, user name*/
"@min": 1,
"@max": 1
},
"remoteHostAddr": {
/*ro, opt, object, remote host address*/
"@min": 1,
"@max": 1
},
"cardNo": {
"@min": 1,
"@max": 1
},
"cardType": {
/*ro, opt, object, card type*/
"@opt": "1,2,3,4,5,6,7,8"
/*ro, req, string, 1 (normal card), 2 (disability card), 3 (blocklist card), 4 (patrol card), 5 (duress card), 6 (super card), 7 (visitor
card), 8 (dismiss card)*/
},
"whiteListNo": {
/*ro, opt, object, allowlist No.*/
"@min": 1,
"@max": 1
},
"reportChannel": {
/*ro, opt, object, channel type for uploading alarms/events*/
"@opt": "1,2,3"
/*ro, req, string, "1" (for uploading arming information), "2" (for uploading by central group 1), "3" (for uploading by central group 2)*/
},
"cardReaderKind": {
/*ro, opt, object, card reader type*/
"@opt": "1,2,3,4"
/*ro, req, string, "1" (IC card reader), "2" (ID card reader), "3" (QR code scanner), "4" (fingerprint module)*/
},
"cardReaderNo": {
"@min": 1,
"@max": 1
},
},
"doorNo": {
/*ro, opt, object, door (floor) No.*/
"@min": 1,
"@max": 1
},
"verifyNo": {
/*ro, opt, object, multiple authentication No.*/
"@min": 1,
"@max": 1
},
"alarmInNo": {
/*ro, opt, object, alarm input No.*/
"@min": 1,
"@max": 1
},
"alarmOutNo": {
/*ro, opt, object, alarm output No.*/
"@min": 1,
"@max": 1
},
"caseSensorNo": {
/*ro, opt, object, event trigger No.*/
"@min": 1,
"@max": 1
},
"RS485No": {
/*ro, opt, object, RS-485 channel No.*/
"@min": 1,
"@max": 1
},
"multiCardGroupNo": {
"@min": 1,
"@max": 1
},
"accessChannel": {
/*ro, opt, object, turnstile No.*/
"@min": 1,
"@max": 1
},
"deviceNo": {
/*ro, opt, object, device No.*/
"@min": 1,
"@max": 1
},
"distractControlNo": {
/*ro, opt, object, distributed access controller No.*/
"@min": 1,
"@max": 1
},
"employeeNo": {
"@min": 1,
"@max": 1
},
"localControllerID": {
/*ro, opt, object, distributed access controller No.*/
"@min": 1,
"@max": 1
},
"InternetAccess": {
/*ro, opt, object, network interface No.*/
"@min": 1,
"@max": 1
},
"type": {
/*ro, opt, object, zone type*/
"@opt": "0,1,2,3,4,5,6,7,8,9,10,11,255"
"@opt": "0,1,2,3,4,5,6,7,8,9,10,11,255"
/*ro, req, string, 0 (instant alarm zone), 1 (24-hour zone), 2 (delayed zone), 3 (internal zone), 4 (key zone), 5 (fire alarm zone), 6
(perimeter zone), 7 (24-hour silent zone), 8 (24-hour auxiliary zone), 9 (24-hour shock zone), 10 (emergency door open zone), 11 (emergency door closed
zone), 255 (none)*/
},
"MACAddr": {
/*ro, opt, object, MAC Address*/
"@min": 1,
"@max": 1
},
"swipeCardType": {
/*ro, opt, object, card swiping type*/
"@opt": "0,1"
/*ro, req, string, "0" (invalid), "1" (QR code)*/
},
"serialNo": {
/*ro, opt, object, event serial No.*/
"@min": 1,
"@max": 1
},
"channelControllerID": {
/*ro, opt, object, lane controller No.*/
"@opt": "0,1"
/*ro, req, string, "1" (main lane controller), "2" (sub lane controller)*/
},
"channelControllerLampID": {
/*ro, opt, object, light board ID of lane controller*/
"@min": 1,
"@max": 1
},
"channelControllerIRAdaptorID": {
/*ro, opt, object, IR adapter No. of lane controller*/
"@min": 1,
"@max": 1
},
"channelControllerIREmitterID": {
/*ro, opt, object, active infrared intrusion detector No. of lane controller*/
"@min": 1,
"@max": 1
},
"userType": {
/*ro, opt, object, person types*/
"@opt": "normal,visitor,blackList,administrators"
/*ro, req, string, "normal" (normal person (household)), "visitor" (visitor), "blacklist" (person in blocklist), "administrators"
(administrator)*/
},
"currentVerifyMode": {
/*ro, opt, object, current authentication mode of the card reader*/
"@opt":
eNoAndFp,employeeNoAndFpAndPw,faceAndFpAndCard,faceAndPwAndFp,employeeNoAndFace,faceOrfaceAndCard,fpOrface,cardOrfaceOrPw,iris,faceOrFpOrCardOrPwOrIris,face
OrCardOrPwOrIris"
/*ro, req, string, "cardAndPw"-card+password, "card", "cardOrPw"-card or password, "fp"-fingerprint, "fpAndPw"-fingerprint+password,
"fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint+card, "fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card
or password, "faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face", "employeeNoAndPw"-employee No.+password, "fpOrPw"-
fingerprint or password, "employeeNoAndFp"-employee No.+fingerprint, "employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-
face+fingerprint+card, "faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face, "faceOrfaceAndCard"-face or face+card, "fpOrface"-
fingerprint or face, "cardOrfaceOrPw"-card or face or password, "cardOrFpOrPw"-card or fingerprint or password*/
},
"QRCodeInfo": {
/*ro, opt, object, QR code information*/
"@min": 1,
"@max": 1
},
"thermometryUnit": {
/*ro, opt, object, temperature unit*/
"@opt": ["celsius", "fahrenheit", "kelvin"]
/*ro, req, array, "celsius" (Celsius (default)), "fahrenheit" (Fahrenheit), "kelvin" (Kelvin), subType:string*/
},
"currTemperature": {
/*ro, opt, object, skin-surface temperature*/
"@min": 1,
/*ro, req, int, skin-surface temperature, which is accurate to one decimal place*/
"@max": 1
/*ro, req, int, skin-surface temperature, which is accurate to one decimal place*/
},
/*ro, req, array, whether the skin-surface temperature is abnormal (true-yes), subType:bool*/
},
"positionX": {
/*ro, opt, object, X-coordinate*/
"@min": 0,
/*ro, req, int, the minimum value, normalized X-coordinate which is between 0 and 1000*/
"@max": 1000
/*ro, req, int, the maximum value, normalized X-coordinate which is between 0 and 1000*/
},
"positionY": {
/*ro, opt, object, Y-coordinate*/
"@min": 0,
/*ro, req, int, the minimum value, normalized Y-coordinate which is between 0 and 1000*/
"@max": 1000
/*ro, req, int, the maximum value, normalized Y-coordinate which is between 0 and 1000*/
}
},
"mask": {
/*ro, opt, object, whether the person is wearing mask*/
"@opt": ["unknown", "yes", "no"]
/*ro, req, array, "unknown", "yes", "no", subType:string*/
},
"pictureURL": {
/*ro, opt, object, URL of the captured picture*/
"@min": 1,
"@max": 1
},
"filename": {
/*ro, opt, object, file name, desc:if multiple pictures are returned, the file name of each picture should be unique*/
"@min": 1,
"@max": 1
},
"attendanceStatus": {
/*ro, opt, object, attendance status, desc:"undefined", "checkIn" (check-in), "checkOut" (check-out), "breakOut" (start of break), "breakIn"
(end of break), "overtimeIn" (start of overtime), "overTimeOut" (end of overtime)*/
"@opt": "undefined,checkIn,checkOut,breakOut,breakIn,overtimeIn,overtimeOut"
/*ro, req, string, options*/
},
"label": {
/*ro, opt, object, self-defined attendance name*/
"@min": 1,
"@max": 1
},
"statusValue": {
/*ro, opt, object, status value*/
"@min": 1,
"@max": 1
},
"helmet": {
/*ro, opt, object, whether the person is wearing hard hat, desc:"unknown", "yes", "no"*/
"@opt": "unknown,yes,no"
/*ro, req, string, options*/
},
"visibleLightPicUrl": {
/*ro, opt, object, URL of the visible light picture*/
"@min": 1,
"@max": 1
},
"thermalPicUrl": {
/*ro, opt, object, URL of the thermal imaging picture*/
"@min": 1,
"@max": 1
},
"HealthInfo": {
"healthCode": {
/*ro, opt, object, health code status*/
"@opt": [0, 1, 2, 3, 4, 5, 6, 7]
/*ro, req, array, options, subType:int, desc:0 (no request), 1 (no health code), 2 (green QR code), 3 (yellow QR code), 4 (red QR code),
5 (no such person), 6 (other error, e.g., searching failed due to API exception), 7 (searching for the health code timed out)*/
},
"NADCode": {
/*ro, opt, object, nucleic acid test result, desc:0 (no result), 1 (negative, which means normal), 2 (positive, which means diagnosed), 3
(the result has expired)*/
"@opt": [0, 1, 2, 3, 4]
/*ro, req, array, options, subType:int*/
},
"travelCode": {
/*ro, opt, object, trip code, desc:0 (no trip in the past 14 days), 1 (has left the current area left in the past 14 days), 2 (has been to
the high-risk area in the past 14 days), 3 (other)*/
"@opt": [0, 1, 2, 3, 4]
},
},
"travelInfo": {
/*ro, opt, object*/
"@min": 0,
/*ro, req, int, step:1*/
"@max": 15
},
"vaccineStatus": {
/*ro, opt, object, whether the person is vaccinated, desc:0 (not vaccinated), 1 (vaccinated)*/
"@opt": [0, 1, 2, 3, 4]
},
"vaccineNum": {
/*ro, opt, object*/
"@min": 0,
"@max": 3
}
},
"meetingID": {
/*ro, opt, object, meeting ID*/
"@min": 1,
"@max": 32
},
"PersonInfoExtends": {
/*ro, opt, object, extended nodes for the additional person information*/
"maxSize": 3,
/*ro, req, int, range of members in the array*/
"id": {
/*ro, opt, object, extended ID of the additional person information*/
"@min": 1,
"@max": 32
},
"value": {
/*ro, opt, object, extended content of the additional person information*/
"@min": 0,
"@max": 100
}
},
"name": {
/*ro, opt, object, name*/
"@min": 1,
"@max": 128
},
"FaceRect": {
"height": {
/*ro, req, object, height*/
"@min": 0.000,
/*ro, req, float, the minimum value*/
"@max": 1.000
/*ro, req, float, the maximum value*/
},
"width": {
/*ro, req, object, width*/
"@min": 0.000,
"@max": 1.000
},
"x": {
/*ro, req, object, X-coordinate of the upper-left corner of the frame*/
"@min": 0.000,
"@max": 1.000
},
"y": {
/*ro, req, object, Y-coordinate of the upper-left corner of the frame*/
"@min": 0.000,
"@max": 1.000
}
},
"RecordInfo": {
/*ro, opt, object*/
"startTime": "1970-01-01T00:00:00+08:00",
"endTime": "1970-01-01T00:00:00+08:00",
"playbackURL": {
/*ro, opt, object*/
"@min": 0,
"@min": 0,
/*ro, req, int, the minimum length*/
"@max": 256
/*ro, req, int, the maximum length*/
}
},
"currentAuthenticationTimes": {
/*ro, req, object*/
"@min": 0,
/*ro, req, int*/
"@max": 255
/*ro, req, int*/
},
"allowAuthenticationTimes": {
/*ro, req, object*/
"@min": 0,
/*ro, req, int*/
"@max": 255
/*ro, req, int*/
}
}
}
}
21.28.8 Get the configuration capability of the event and card linkage
Request URL
GET /ISAPI/AccessControl/EventCardLinkageCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, req, object, parameters of the event and card linkage*/
"eventID": {
/*ro, opt, object, event ID*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"proMode": {
/*ro, req, object, linkage type*/
"@opt": "event,card,mac,employee"
/*ro, opt, string, linkage method*/
},
/*ro, opt, object, event linkage information*/
"mainEventType": {
/*ro, opt, object, event main type*/
"@opt": "0,1,2,3"
/*ro, opt, string, event main type*/
},
"devSubEventType": {
/*ro, opt, object, minor event type*/
"@opt": "0,1,2,3,54…"
/*ro, opt, string, minor event type*/
},
"alarmSubEventType": {
/*ro, opt, object, minor type of alarm input event*/
"@opt": "0,1,2,3,52…"
/*ro, opt, string, minor type of alarm input event*/
},
"doorSubEventType": {
/*ro, opt, object, minor type of access control point event*/
"@opt": "0,1,2,3…"
/*ro, opt, string, minor type of access control point event*/
},
"cardReaderSubEventType": {
/*ro, opt, object, minor type of authentication unit event*/
"@opt": "0,1,2,3…"
/*ro, opt, string, minor type of authentication unit event*/
}
},
/*ro, opt, object, card linkage parameters*/
"cardNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 32
/*ro, opt, int*/
}
},
/*ro, opt, object, MAC address linkage parameters*/
"MACAddr": {
/*ro, opt, object, physical MAC address*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
}
},
"EmployeeInfo": {
/*ro, opt, object, person ID*/
"employeeNo": {
/*ro, opt, object, person ID*/
"@min": 1,
/*ro, opt, int, employee No. (person ID)*/
"@max": 32
/*ro, opt, int*/
}
},
"eventSourceID": {
/*ro, opt, object, event source ID*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"alarmout": {
/*ro, opt, object, linked alarm output No.*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"ReaderAlarmout": [
{
"readerID": 1,
/*ro, opt, int, card reader No., range:[1,8]*/
"alarmOut": {
/*ro, opt, object*/
"@size": 5,
"@min": 1,
"@max": 5
},
"alarmOutClose": {
/*ro, opt, object, array,linked alarm output No.*/
"@size": 5,
"@min": 1,
"@max": 5
}
}
],
"openDoor": {
/*ro, opt, object, linked door No. to open*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"closeDoor": {
/*ro, opt, object, linked door No. to close*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"alwaysOpen": {
/*ro, opt, object, array,linked door No. to remain unlocked*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"alwaysClose": {
/*ro, opt, object, linked door No. to remain locked*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"mainDevBuzzer": "true,false",
/*ro, opt, string, buzzer linkage of the access controller*/
"capturePic": "true,false",
"capturePic": "true,false",
/*ro, opt, string, whether to enable capture linkage*/
"readerCapturePic": {
/*ro, opt, object*/
"@size": 8,
"@min": 1,
"@max": 8,
"@opt": [1, 4]
},
"recordVideo": "true,false",
/*ro, opt, string, whether to enable recording linkage*/
"readerRecordVideo": {
/*ro, opt, object*/
"@size": 8,
"@min": 1,
"@max": 8,
"@opt": [1, 4]
},
"mainDevStopBuzzer": "true,false",
/*ro, opt, string, whether to enable buzzer linkage of the access controller (stop buzzing): "false"-no,"true"-yes*/
"audioSourceType": {
/*ro, opt, object*/
"@opt": ["TTS", "customFile", "none"]
},
"audioDisplayTTSLanguage": {
/*ro, opt, object*/
"@opt": ["SimChinese", "English"]
},
"audioDisplayTTS": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 64
/*ro, opt, int*/
},
"customAudioID": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 65535
/*ro, opt, int*/
},
"audioDisplayMode": {
/*ro, opt, object, linked audio announcement mode*/
"@opt": "close,single,loop"
/*ro, opt, string, linked audio announcement mode*/
},
"readerBuzzer": {
/*ro, opt, object, linked buzzer*/
"@min": 1,
/*ro, opt, int*/
"@max": 1,
/*ro, opt, int*/
"@opt": [1, 4]
},
"alarmOutClose": {
/*ro, opt, object, array,linked alarm output No.*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"alarmInSetup": {
/*ro, opt, object, linked zone No. to arm*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"alarmInClose": {
/*ro, opt, object, linked zone No. to disarm*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
},
"readerStopBuzzer": {
/*ro, opt, object, linked buzzer No. to stop buzzing*/
"@min": 1,
/*ro, opt, int*/
"@max": 1,
/*ro, opt, int*/
"@opt": [1, 4]
},
"duration": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int, unit:s*/
"@max": 30,
"@def": 15
},
"eventCardLinkageName": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int, unit:Byte*/
"@max": 128
},
"FireMatrixEventSourceList": {
/*ro, opt, object, dep:and,{$.EventCardLinkageCfg.EventLinkageInfo.subEventType,eq,52}*/
"@size": 32,
/*ro, opt, int*/
"IoTChannelID": {
/*ro, opt, object*/
"@min": 1,
"@max": 256
},
"channels": {
/*ro, opt, object*/
"@size": 20,
/*ro, opt, int*/
"@min": 1,
"@max": 16
}
},
"Operations": {
/*ro, opt, object*/
"eventSourceID": {
/*ro, opt, object, event source ID,it is valid when proMode is "event",65535-all. For device event (mainEventType is 0),this field is invalid;
for access control point event (mainEventType is 2),this field refers to the access control point No.; for authentication unit event (mainEventType is
3,this field refers to the authentication unit No.; for alarm input event (mainEventType is 1),this field refers to the zone alarm input ID or the event
alarm input ID*/
"@min": 1,
/*ro, opt, int*/
"@max": 128
/*ro, opt, int*/
},
"TerminalsInfoCap": {
/*ro, opt, object, terminal list*/
"size": 1024,
/*ro, opt, int*/
"terminalID": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1024
/*ro, opt, int*/
},
"isSupportACPChannel": true
/*ro, opt, bool*/
},
"audioSource": {
/*ro, opt, object*/
"@opt": ["audioFile", "speechSynthesis"]
},
"materialId": {
/*ro, opt, object*/
"size": 32,
/*ro, opt, int*/
"@min": 1,
/*ro, opt, int*/
"@max": 128
/*ro, opt, int*/
},
"speechSynthesisContent": {
/*ro, opt, object*/
"@min": 0,
"@max": 4096
},
"voiceType": {
/*ro, opt, object*/
"@opt": ["male", "female"]
},
"audioLevel": {
/*ro, opt, object*/
"@min": 0,
"@min": 0,
/*ro, opt, int*/
"@max": 15
/*ro, opt, int*/
},
"audioVolume": {
/*ro, opt, object*/
"@min": 0,
/*ro, opt, int*/
"@max": 15
/*ro, opt, int*/
},
"playMode": {
/*ro, opt, object*/
"@opt": ["order", "duration"]
},
"duration": {
/*ro, opt, object*/
"@min": 0,
"@max": 3000
}
}
}
}
21.28.9 Get the capability of getting total number of access control events by specific
conditions
Request URL
GET /ISAPI/AccessControl/AcsEventTotalNum/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"AcsEvent": {
/*ro, opt, object*/
"AcsEventTotalNumCond": {
"major": {
/*ro, req, object, major alarm type*/
"@opt": "0,1,2,3,5"
/*ro, opt, string, major alarm type*/
},
"minorAlarm": {
/*ro, req, object, minor alarm type*/
"@opt": "1024,1025,1026,1027"
/*ro, opt, string, minor alarm type*/
},
"minorException": {
/*ro, req, object, minor exception type*/
"@opt": "39,58,59,1024"
/*ro, opt, string, minor exception type*/
},
"minorOperation": {
/*ro, req, object, minor operation type*/
"@opt": "80,90,112,113"
/*ro, opt, string, minor operation type*/
},
"minorEvent": {
/*ro, opt, object, minor event type*/
"@opt": "1,2,3,4"
/*ro, opt, string, minor event type*/
},
"startTime": {
/*ro, opt, object, start time*/
"@min": 1,
/*ro, opt, int, start time (UTC time)*/
"@max": 1
/*ro, opt, int, end time (UTC time)*/
},
"endTime": {
/*ro, opt, object, end time*/
"@min": 1,
/*ro, opt, int, start time (UTC time)*/
"@max": 1
/*ro, opt, int, end time (UTC time)*/
},
},
"cardNo": {
"@min": 1,
/*ro, opt, int, card No.*/
"@max": 32
/*ro, opt, int, card No.*/
},
"name": {
/*ro, opt, object, name of the card holder*/
"@min": 1,
/*ro, opt, int, name of the card holder*/
"@max": 32
/*ro, opt, int, name of the card holder*/
},
"picEnable": "true,false",
/*ro, opt, string*/
"beginSerialNo": {
"@min": 1,
/*ro, opt, int, start serial No.*/
"@max": 1
/*ro, opt, int, start serial No.*/
},
"endSerialNo": {
"@min": 1,
/*ro, opt, int, end serial No.*/
"@max": 1
/*ro, opt, int, end serial No.*/
},
"employeeNoString": {
"@min": 1,
"@max": 32
}
},
"totalNum": {
/*ro, req, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 1
/*ro, opt, int*/
}
}
}
21.28.10 Get the capability of clearing event and card linkage parameters
Request URL
GET /ISAPI/AccessControl/ClearEventCardLinkageCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"ClearEventCardLinkageCfg": {
/*ro, opt, object, clear event and card linkage parameters*/
"ClearFlags": {
/*ro, opt, object*/
"eventCardLinkage": "true,false"
/*ro, req, string, event and card linkage parameters*/
}
}
}
21.28.11 Set the event optimization parameters

Request URL
PUT /ISAPI/AccessControl/EventOptimizationCfg?format=json
Query Parameter
None
Request Message
{
"EventOptimizationCfg": {
/*opt, object*/
"enable": true,
/*opt, bool, whether to enable event optimization*/
"isCombinedLinkageEvents": true
/*opt, bool, whether to enable linked event combination*/
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
/*ro, req, string, error details*/
}
21.28.12 Get the configuration capability of event optimization

Request URL
GET /ISAPI/AccessControl/EventOptimizationCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object*/
/*ro, opt, string, whether to enable event optimization*/
"isCombinedLinkageEvents": "true,false"
/*ro, opt, string, whether to enable linked event combination*/
}
}
21.28.13 Get the event optimization configuration parameters

Request URL
GET /ISAPI/AccessControl/EventOptimizationCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object*/
"enable": true,
/*ro, opt, bool, whether to enable event optimization*/
"isCombinedLinkageEvents": true
/*ro, opt, bool, whether to enable linked event combination*/
}
}
21.28.14 Set storage parameters of access control events

Request URL
PUT /ISAPI/AccessControl/AcsEvent/StorageCfg?format=json
Query Parameter
None
Request Message
{
"EventStorageCfg": {
/*wo, req, object*/
"mode": "regular",
/*wo, req, enum, event storage method, subType:string, desc:"regular" (delete old events periodically), "time" (delete old events by specified
time), "cycle" (overwriting);*/
"checkTime": "1970-01-01 00:00:00",
/*wo, opt, string, check time; this node is valid when mode is "time"*/
"period": 10
/*wo, opt, int, time period for deleting old events; this node is valid when mode is "regular", unit:min, desc:time period for deleting old events;
this node is valid when mode is "regular"*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.28.15 Get the storage parameters of access control events

Request URL
GET /ISAPI/AccessControl/AcsEvent/StorageCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
"EventStorageCfg": {
/*ro, req, object*/
"mode": "regular",
/*ro, req, enum, event storage mode, subType:string, desc:"regular" (delete old events periodically), "time" (delete old events by specified time),
"cycle" (overwriting)*/
"checkTime": "1970-01-01 00:00:00",
/*ro, opt, string, check time. This node is required when the storage mode is "time"*/
"period": 10
/*ro, opt, int, time period for deleting old events. This node is required when the storage mode is "regular", unit:min, desc:unit: minute*/
}
}
21.28.16 Getting arming information

Request URL
GET /ISAPI/AccessControl/DeployInfo
Query Parameter
None
Request Message
None
Response Message
<DeployInfo xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<DeployList size="5">

<Content>
<deployNo>
1
</deployNo>
<deployType>
1
</deployType>
<protocolType>
HTTP
</protocolType>
<ipAddr>
test
</ipAddr>
<port>
1
</port>
<eventType>
AccessController
</eventType>
</Content>
</DeployList>
</DeployInfo>
21.28.17 Getting arming information capability

Request URL
GET /ISAPI/AccessControl/DeployInfo/capabilities
Query Parameter
None
Request Message
None
Response Message
<DeployInfo xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<DeployList size="5">

<Content>
<deployNo min="1" max="10">
1
</deployNo>
<deployType opt="0,1,2,3">
1
</deployType>
<protocolType opt="HTTP,HTTPS">
HTTP
</protocolType>
<ipAddr min="1" max="10">
test
</ipAddr>
<port min="0" max="10">
1
</port>
<eventType opt="AccessController,Consumer,AccessControllerAndConsumer">
AccessController
</eventType>
</Content>
</DeployList>
</DeployInfo>
21.28.18 Access control event

EventType:AccessControllerEvent
{
"ipAddress": "172.6.64.7",
"ipv6Address": "1080:0:0:0:8:800:200C:417A",
"portNo": 80,
"protocol": "HTTP",
/*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
ISAPI protocol is transmitted via ISUP, the channel No. is the video channel No. of ISUP*/
"macAddress": "01:17:24:45:D9:F4",
"channelID": 1,
/*ro, opt, int, channel No. of the device that triggers the alarm, 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 ISAPI
protocol is transmitted via ISUP, the channel No. is the video channel No. of ISUP*/
"dateTime": "2004-05-03T17:30:08+08:00",
/*ro, req, datetime, alarm trigger time*/
/*ro, req, int, times that the same alarm has been uploaded, desc:times that the same alarm has been uploaded*/
"eventType": "AccessControllerEvent",
/*ro, req, string, event type, desc:"AccessControllerEvent" (access control event)*/
/*ro, req, enum, event status, subType:string, desc:for durative event: "active" (valid event or event starts), "inactive" (invalid event or the event
ends). For the heartbeat, the node value indicates the heartbeat data, and it is uploaded every 10 seconds*/
"eventDescription": "AccessControllerEvent",
/*ro, req, string, event description, desc:"AccessControllerEvent" (access control event)*/
/*ro, opt, string, device ID (PUID), desc:this node must be returned when ISAPI event information is transmitted via ISUP*/
"AccessControllerEvent": {
/*ro, req, object, access control event information*/
/*ro, opt, string, device name*/
"majorEventType": 1,
/*ro, req, int, major alarm type, desc:the type value should be transformed to the decimal number; see Access Control Alarm Types for details*/
"subEventType": 1,
/*ro, req, int, minor alarm type, desc:the type value should be transformed to the decimal number; see Access Control Alarm Types for details*/
"inductiveEventType": "authenticated",
/*ro, opt, enum, inductive event type, subType:string, desc:this node is used by storage devices; for access control devices, this node is invalid;
"authenticated", "authenticationFailed", "openingDoor", "closingDoor", "doorException", "remoteOperation", "timeSynchronization", "deviceException",
"deviceRecovered", "alarmTriggered", "alarmRecovered" (arming restoring event), "callCenter"*/
"netUser": "test",
/*ro, opt, string, user name for network operations*/
"cardNo": "test",
"cardType": 1,
/*ro, opt, enum, card type, subType:int, desc:1 (normal card), 2 (disability card), 3 (blocklist card), 4 (patrol card), 5 (duress card), 6 (super
card), 7 (visitor card), 8 (dismiss card)*/
"name": "test",
/*ro, opt, string, person name*/
"sex": "male",
"sex": "male",
/*ro, opt, enum, subType:string, desc:"male", "female"*/
"whiteListNo": 1,
/*ro, opt, int, allowlist No.*/
"reportChannel": 1,
/*ro, opt, enum, channel type for uploading alarms/events, subType:int, desc:1 (uploading in arming mode), 2 (uploading by central group 1), 3
(uploading by central group 2)*/
"cardReaderKind": 1,
/*ro, opt, enum, card reader type, subType:int, desc:1 (IC card reader), 2 (ID card reader), 3 (QR code scanner), 4 (fingerprint module)*/
"cardReaderNo": 1,
/*ro, opt, int, card reader No., step:1, desc:card reader No.*/
"doorNo": 1,
/*ro, opt, int, door (floor) No.*/
"verifyNo": 1,
/*ro, opt, int, multiple authentication No.*/
"alarmInNo": 1,
/*ro, opt, int, alarm input No.*/
"alarmOutNo": 1,
/*ro, opt, int, alarm output No.*/
"caseSensorNo": 1,
/*ro, opt, int, event trigger No.*/
"RS485No": 1,
"multiCardGroupNo": 1,
"accessChannel": 1,
/*ro, opt, int, turnstile No.*/
"deviceNo": 1,
"distractControlNo": 1,
/*ro, opt, int, distributed access controller No.*/
"employeeNo": 1,
/*ro, opt, string, employee No. (person ID), desc:if the node employeeNo exists or the value of employeeNoString can be converted to that of
employeeNo, this node is required. For the upper-layer platform or client software, the node employeeNoString will be parsed in priority; if
employeeNoString is not configured, the node employeeNo will be parsed*/
"employeeName": "test",
/*ro, opt, string, person name, desc:this node is only used for FocSign products*/
/*ro, opt, int, distributed access controller No., desc:0 (access controller), 1 to 64 (distributed access controller No. 1 to distributed access
controller No. 64)*/
"InternetAccess": 1,
/*ro, opt, enum, network interface No., subType:int, desc:1 (upstream network interface No. 1), 2 (upstream network interface No. 2), 3 (downstream
network interface No. 1)*/
"type": 1,
/*ro, opt, enum, zone type, subType:int, desc:0 (instant zone), 1 (24-hour zone), 2 (delayed zone), 3 (internal zone), 4 (key zone), 5 (fire alarm
zone), 6 (perimeter zone), 7 (24-hour silent zone), 8 (24-hour auxiliary zone), 9 (24-hour shock zone), 10 (emergency door open zone), 11 (emergency door
closed zone), 255 (none)*/
"MACAddr": "test",
"swipeCardType": 1,
/*ro, opt, enum, card swiping types, subType:int, desc:0 (invalid), 1 (QR code)*/
"serialNo": 1,
/*ro, opt, int, event serial No., range:[1,100000], desc:it starts at 1 and each record increases by 1. It will be overwritten repeatedly when
reaching the maximum value supported by the device*/
"channelControllerID": 1,
/*ro, opt, enum, lane controller ID, subType:int, desc:1 (main lane controller), 2 (sub-lane controller)*/
"channelControllerLampID": 1,
/*ro, opt, int, light board ID of lane controller, range:[1,255]*/
"channelControllerIRAdaptorID": 1,
/*ro, opt, int, IR adaptor ID of the lane controller, range:[1,255]*/
"channelControllerIREmitterID": 1,
/*ro, opt, int, active infrared intrusion detector No. of the lane controller, range:[1,255]*/
/*ro, opt, enum, person type, subType:string, desc:"normal" (normal person (resident)), "visitor" (visitor), "blacklist" (person in the blocklist),
"administrators" (administrator)*/
"currentVerifyMode": "cardAndPw",
/*ro, opt, enum, current authentication mode of the card reader, subType:string, desc:"cardAndPw" (card+password), "card" (card), "cardOrPw" (card
or password), "fp" (fingerprint), "fpAndPw" (fingerprint+password), "fpOrCard" (fingerprint or card), "fpAndCard" (fingerprint+card), "fpAndCardAndPw"
"cardOrfaceOrPw" (card or face or password), "iris" (iris), "faceOrFpOrCardOrPwOrIris" (face, fingerprint, card, password, or iris), "faceOrCardOrPwOrIris"
(face, card, password, or iris)*/
/*ro, opt, bool, whether it is a real-time event*/
/*ro, opt, string, QR code information*/
"thermometryResult": "success",
/*ro, opt, enum, temperature screening result, subType:string, desc:"success", "fail"*/
/*ro, opt, enum, temperature unit, subType:string, desc:"celsius" (Celsius, default value), "fahrenheit" (Fahrenheit), "kelvin" (Kelvin)*/
/*ro, opt, float, skin-surface temperature, which is accurate to one decimal place*/
/*ro, opt, bool, whether the skin-surface temperature is abnormal*/
"positionX": 0,
/*ro, opt, int, normalized X-coordinate which is between 0 and 1000, range:[0,1000]*/
"positionY": 0
/*ro, opt, int, normalized Y-coordinate which is between 0 and 1000, range:[0,1000]*/
},
},
"remoteCheck": true,
/*ro, opt, bool, whether remote verification is required: true-yes, false-no (default)*/
"mask": "unknown",
"frontSerialNo": 1,
/*ro, opt, int, serial No. of the previous event, desc:if this node does not exist, the platform will check whether the event loss occurred
according to the node serialNo. If both the serialNo and frontSerialNo are returned, the platform will check whether the event loss occurred according to
both nodes. It is mainly used to solve the problem that the serialNo is inconsistent after subscribing events or alarms*/
/*ro, opt, enum, attendance status, subType:string, desc:"checkIn" (check-in), "checkOut" (check-out), "breakOut" (start of break), "breakIn" (end
of break), "overtimeIn" (start of overtime), "overTimeOut" (end of overtime)*/
"label": "test",
/*ro, opt, string, self-defined attendance name*/
"statusValue": 1,
/*ro, opt, int, status value*/
/*ro, opt, string, URL of the captured picture, range:[0,256]*/
"visibleLightURL": "test",
/*ro, opt, string, visible light picture URL of the thermal imaging camera, range:[0,256]*/
"thermalURL": "test",
/*ro, opt, string, URL of the thermal picture, range:[0,256]*/
"faceBasemapURL": "test",
"picturesNumber": 1,
/*ro, opt, int, number of captured pictures*/
"unlockType": "password",
/*ro, opt, enum, unlocking type, subType:string, desc:this node is returned when the minor type is MINOR_UNCLOCK_RECORD; "password" (unlock by
password), "hijcking" (unlock by duress), "card" (unlock by card), "householder" (unlock by householder), "centerplatform" (unlock by management center),
"bluetooth" (unlock by bluetooth), "qrcode" (unlocked via QR code), "face" (unlock by recognizing face), "fingerprint" (unlock by fingerprint)*/
"classroomId": "test",
/*ro, opt, string, class ID*/
"classroomName": "test",
/*ro, opt, string, class name*/
"analysisModule": "signageApp",
/*ro, opt, enum, analysis module, subType:string, desc:this node is not returned, and the value is report via signage App; "signageApp" (signage
App), "faceSDK" (face picture SDK)*/
/*ro, opt, string, custom information*/
/*ro, opt, enum, whether the person is wearing hard hat, subType:string, desc:"unknown", "yes", "no"*/
"purePwdVerifyEnable": true,
/*ro, opt, bool, whether the device supports opening the door only by password,
desc:opening the door only by password:
the password in authentication method is person password; checking the repetition of person password is not supported by the device, it should be
performed by the upper-layer platform; adding, deleting, editing, and searching for person password locally is not supported by the device*/
"appType": "attendance",
/*ro, opt, enum, application type (for FocSign products), subType:string, desc:"attendance" (Time & Attendance module), "signIn" (Check-In module)*/
"HealthInfo": {
"healthCode": 1,
/*ro, opt, enum, health code status, subType:int, desc:0 (no request), 1 (no health code), 2 (green QR code), 3 (yellow QR code), 4 (red QR
code), 5 (no such person), 6 (other error, e.g., searching failed due to API exception), 7 (searching for the health code timed out)*/
"NADCode": 1,
"NADMsg": "test",
"NADTime": 1,
"travelCode": 1,
/*ro, opt, enum, trip code, subType:int, desc:0 (no trip in the past 14 days), 1 (has left the current area left in the past 14 days), 2 (has
/*ro, opt, string, trip information, desc:the empty string indicates that searching trip failed*/
"vaccineStatus": 1,
"vaccineNum": 1,
"vaccineMsg": "test",
"ANTCode": 1,
"ANTMsg": "test"
},
"PhysicalInfo": {
/*ro, opt, object, BMI information, desc:this node is obtained after authentication by BMI scales which is connected to MinMoe terminals*/
"weight": 7000,
/*ro, opt, int, weight, unit:kg*/
"height": 18000
/*ro, opt, int, height, unit:cm*/
},
"meetingID": "test",
/*ro, opt, string, meeting ID, range:[1,32]*/
/*ro, opt, array, additional person information, subType:object, desc:this node displays additional person information on the device*/
{
"id": 1,
/*ro, opt, int, extended ID of the additional person information, range:[1,32], desc:related URL: /ISAPI/AccessControl/personInfoExtendName?
format=json; this node is used for displaying the name of value; if ID does not exists, it starts from 1*/
"value": "test"
}
}
],
"customPrompt": "test",
/*ro, opt, string, custom prompt message, range:[1,128], desc:this node is displayed when the authentication result is authenticated, authentication
failed, or stranger*/
"FaceRect": {
"height": 1.000,
"width": 1.000,
"x": 0.000,
"y": 0.000
},
"faceSimilarity": 90,
/*ro, opt, int, Similarity, range:[0,100]*/
"faceRecognitionDistance": 0.1,
/*ro, opt, float, unit:m*/
"eyesDistance": 20,
"faceRecognitionFailedReason": "attackBlacklist",
"allowAuthenticationTimes": 1,
"LocalAttendanceData": {
/*ro, opt, object*/
"attendanceResult": [
{
"date": "1970-01-01",
/*ro, opt, date*/
"week": 1,
/*ro, opt, enum, subType:int, desc:1 (Monday), 2 (Tuesday), 3 (Wednesday), 4 (Thursday), 5 (Friday), 6 (Saturday), 7 (Sunday)*/
"personalAttendanceStatus": "normal"
}
]
},
"hasRecord": true
/*ro, opt, bool*/
},
"URLCertificationType": "digest"
/*ro, opt, enum, picture URL authentication method, subType:string, desc:"no" (no authentication, it is used for the cloud protocol)，"digest" (digest
authentication, it is used for local picture URL returned by NVR or DVR)*/
}
Parameter Parameter
Parameter Name Content-ID File Name Description
Value Type(Content-Type)
AccessControllerEvent [报文内容] application/json -- -- --
[图片二进制数
Picture image/jpeg pictureImage Picture.jpg --
据]
[图片二进制数
据]
[图片二进制数
据]
the instance below.
--<frontier>
Parameter Value
name.
21.29 Access Point Status Schedule
21.29.1 Set parameters of door control weekly schedule
Request URL
PUT /ISAPI/AccessControl/DoorStatusWeekPlanCfg/<weekPlanID>?format=json
Query Parameter
weekPlanID string --
Request Message
{
"DoorStatusWeekPlanCfg": {
/*opt, object, weekly schedule of door control*/
"enable": true,
/*req, bool, whether to enable, desc:"true"-enable, "false"-disable*/
"WeekPlanCfg": [
/*req, array, weekly schedule parameters, subType:object*/
{
"week": "Monday",
"id": 1,
/*req, int, time period No., range:[1,8]*/
"enable": true,
/*req, bool, whether to enable*/
"doorStatus": "remainClosed",
/*req, enum, door control schedule, subType:string, desc:"remainOpen"-remain open (access without authentication), "remainClosed"-remain
closed (access is not allowed), "normal"-access by authentication, "sleep", "invalid”*/
"TimeSegment": {
/*req, object, time*/
"beginTime": "00:00:00",
/*req, time, start time, desc:device local time*/
"endTime": "10:00:00"
/*req, time, end time, desc:device local time*/
}
}
]
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.29.2 Get the configuration parameters of the door control holiday schedule
Request URL
GET /ISAPI/AccessControl/DoorStatusHolidayPlanCfg/<holidayPlanID>?format=json
Query Parameter
holidayPlanID string --
Request Message
None
Response Message
{
"DoorStatusHolidayPlanCfg": {
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable, desc:true (enable), false (disable)*/
"beginDate": "2017-10-01",
/*ro, req, date, start date of the holiday*/
"endDate": "2017-10-08",
/*ro, req, date, end date of the holiday*/
"HolidayPlanCfg": [
/*ro, req, array, holiday schedule parameters, subType:object*/
{
"id": 1,
/*ro, req, int, time period No., range:[1,8]*/
"enable": true,
/*ro, req, enum, door status, subType:string, desc:“remainOpen”-remain open (access without authentication), “remainClosed”-remain closed
(access is not allowed), “normal”-access by authentication, "sleep", "invalid”, “induction”, “barrierFree”*/
"TimeSegment": {
/*ro, opt, object, time*/
"beginTime": "00:00:00",
/*ro, req, time, start time of the time period, desc:device local time*/
"endTime": "10:00:00"
/*ro, req, time, end time of the time period, desc:device local time*/
}
}
]
}
}
21.29.3 Get the configuration capability of the door control week schedule
Request URL
GET /ISAPI/AccessControl/DoorStatusWeekPlanCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object*/
"planNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
},
/*ro, opt, string, whether to enable: "true"-enable,"false"-disable, desc:"true" (enable), "false" (disable)*/
"WeekPlanCfg": {
/*ro, opt, object, week schedule parameters*/
"maxSize": 56,
/*ro, opt, int*/
"week": {
/*ro, opt, object*/
"@opt": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday"
/*ro, opt, string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"*/
},
"id": {
"@min": 1,
/*ro, opt, int*/
"@max": 8
/*ro, opt, int*/
},
"doorStatus": {
/*ro, opt, object, door status*/
"@opt": "remainOpen,remainClosed,normal,sleep,invalid,induction,barrierFree"
/*ro, opt, string, desc:"remainOpen" (remain open (access without authentication)), "remainClosed" (remain closed (access is not allowed)),
"normal" (access by authentication), "sleep", "invalid"*/
},
"TimeSegment": {
"beginTime": "00:00:00",
/*ro, opt, time, start time of the time period (device local time), desc:device local time*/
"endTime": "10:00:00",
/*ro, opt, time, end time of the time period (device local time), desc:device local time*/
"validUnit": "minute"
/*ro, opt, enum, time accuracy, subType:string, desc:"hour", "minute", "second"; if this node is not returned, the default time accuracy is
"minute"*/
}
}
}
}
21.29.4 Get the configuration capability of the door control holiday schedule
Request URL
GET /ISAPI/AccessControl/DoorStatusHolidayPlanCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object*/
"planNo": {
/*ro, opt, object, holiday schedule No.*/
"@min": 1,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
},
"beginDate": "1970-01-01",
/*ro, opt, date, start date of the holiday*/
"endDate": "1971-01-01",
/*ro, opt, date, end date of the holiday*/
"HolidayPlanCfg": {
/*ro, opt, object*/
"maxSize": 8,
/*ro, opt, int*/
"id": {
"@min": 1,
/*ro, opt, int*/
"@max": 8
/*ro, opt, int*/
},
"doorStatus": {
/*ro, opt, object, door status*/
"@opt": "remainOpen,remainClosed,normal,sleep,invlid,induction,barrierFree"
/*ro, opt, string, desc:"remainOpen" (remain open (access without authentication)), "remainClosed" (remain closed (access is not allowed)),
"normal" (access by authentication), "sleep", "invalid"*/
},
"TimeSegment": {
"beginTime": "00:00:00",
/*ro, opt, time, start time of the time period (device local time), desc:device local time*/
"endTime": "00:00:00",
/*ro, opt, time, end time of the time period (device local time), desc:device local time*/
/*ro, opt, enum, time accuracy, subType:string, desc:"hour", "minute", "second"; if this node is not returned, the default time accuracy is
"minute"*/
}
}
}
}
21.29.5 Get the configuration capability of the door control schedule template
Request URL
GET /ISAPI/AccessControl/DoorStatusPlanTemplate/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"DoorStatusPlanTemplate": {
/*ro, opt, object, schedule template*/
"templateNo": {
"@min": 1,
/*ro, opt, int, the minimum value of schedule template No.*/
"@max": 16
/*ro, opt, int, the maximum value of schedule template No.*/
},
/*ro, opt, string, whether to enable, desc:true (enable), false (disable)*/
"templateName": {
/*ro, opt, object, template name length*/
"@min": 1,
/*ro, opt, int, the minimum value of template name length*/
"@max": 32
/*ro, opt, int, the maximum value of template name length*/
},
"weekPlanNo": {
"@min": 1,
/*ro, opt, int, the minimum value of weekly schedule No.*/
"@max": 16
/*ro, opt, int, the maximum value of weekly schedule No.*/
},
"holidayGroupNo": {
"@min": 1,
/*ro, opt, int, the minimum value of holiday group No.*/
"@max": 16
/*ro, opt, int, the maximum value of holiday group No.*/
}
}
}
21.29.6 Get the configuration parameters of the door control week schedule
Request URL
GET /ISAPI/AccessControl/DoorStatusWeekPlanCfg/<weekPlanID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, opt, object, door control week schedule*/
"enable": true,
"WeekPlanCfg": [
{
"week": "Monday",
/*ro, req, enum, days of the week, subType:string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday”*/
"id": 1,
"enable": true,
/*ro, req, bool, whether to enable: "true"-enable, "false"-disable*/
/*ro, req, enum, door status, subType:string, desc:"remainOpen"-remain open (access without authentication), "remainClosed"-remain closed
(access is not allowed), "normal"-access by authentication, "sleep","invalid”, “induction”, “barrierFree”*/
"TimeSegment": {
/*ro, req, object, time*/
"beginTime": "00:00:00",
"endTime": "10:00:00"
}
}
]
}
}
21.29.7 Set parameters of door control holiday schedule
Request URL
PUT /ISAPI/AccessControl/DoorStatusHolidayPlanCfg/<holidayPlanID>?format=json
Query Parameter
Request Message
{
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable, desc:"true"-enable, "false"-disable*/
"beginDate": "2017-10-01",
/*ro, req, date, start date of the holiday*/
"endDate": "2017-10-08",
/*ro, req, date, end data of the holiday*/
"HolidayPlanCfg": [
{
"id": 1,
"enable": true,
/*ro, req, enum, door status, subType:string, desc:"remainOpen"-remain open (access without authentication), "remainClosed"-remain closed
(access is not allowed), "normal"-access by authentication, "sleep", "invalid”*/
"TimeSegment": {
"beginTime": "00:00:00",
/*ro, req, time, start time, desc:device local time*/
"endTime": "10:00:00"
/*ro, req, time, end time, desc:device local time*/
}
}
]
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.29.8 Set parameters of door control schedule template

Request URL
PUT /ISAPI/AccessControl/DoorStatusPlanTemplate/<planTemplateID>?format=json
Query Parameter
planTemplateID string --
Request Message
{
/*ro, opt, object, door control schedule template*/
"enable": true,
/*ro, req, string, template name*/
"weekPlanNo": 1,
/*ro, req, int, weekly schedule No.*/
"holidayGroupNo": "1,3,5"
/*ro, req, string, holiday group No., desc:holiday group No.*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.29.9 Get parameters of door control schedule template

Request URL
GET /ISAPI/AccessControl/DoorStatusPlanTemplate/<planTemplateID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, opt, object, door control schedule template*/
"enable": true,
"weekPlanNo": 1,
/*ro, req, int, weekly schedule No.*/
/*ro, req, string, holiday group No.*/
}
}
21.29.10 Get the configuration capability of the door control schedule

Request URL
GET /ISAPI/AccessControl/DoorStatusPlan/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"DoorStatusPlan": {
/*ro, opt, object*/
"doorNo": {
/*ro, opt, object, door No.*/
"@min": 1,
/*ro, opt, int*/
"@max": 4
/*ro, opt, int*/
},
"templateNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
}
}
}
21.29.11 Get the configuration capability of door status parameters of holiday group
Request URL
GET /ISAPI/AccessControl/DoorStatusHolidayGroupCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"DoorStatusHolidayGroupCfg": {
/*ro, opt, object*/
"groupNo": {
"@min": 1,
"@max": 16
},
/*ro, opt, string, whether to enable, desc:true (enable)*/
"groupName": {
/*ro, opt, object, length of holiday group name*/
"@min": 1,
/*ro, opt, int, the minimum length*/
"@max": 32
/*ro, opt, int, the maximum length*/
},
"holidayPlanNo": {
/*ro, opt, object, holiday group plan No.*/
"@min": 1,
"@max": 16
}
}
}
21.29.12 Get the holiday group configuration parameters of the door control schedule
Request URL
GET /ISAPI/AccessControl/DoorStatusHolidayGroupCfg/<holidayGroupID>?format=json
Query Parameter
holidayGroupID string --
Request Message
None
Response Message
{
/*ro, opt, object*/
"enable": true,
/*ro, req, bool, whether to enable: "true"-enable, "false"-disable*/
/*ro, req, string, holiday group name*/
"holidayPlanNo": "1,3,5"
/*ro, req, string*/
}
}
21.29.13 Set parameters of door control schedule

Request URL
PUT /ISAPI/AccessControl/DoorStatusPlan/<doorID>?format=json
Query Parameter
doorID string --
Request Message
{
"DoorStatusPlan": {
/*req, object*/
"templateNo": 1
/*req, int, schedule template No., desc:0-cancel linking the template with the schedule and restore to the default status (normal status)*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.29.14 Get the configuration parameters of the door control schedule

Request URL
GET /ISAPI/AccessControl/DoorStatusPlan/<doorID>?format=json
Query Parameter
doorID string --
Request Message
None
Response Message
{
"DoorStatusPlan": {
/*ro, req, object*/
"templateNo": 1
/*ro, req, int, schedule template No., desc:0-cancel linking the template with the schedule and restore to the default status (normal status)*/
}
}
21.29.15 Clear access control schedule configuration parameters

Request URL
PUT /ISAPI/AccessControl/ClearPlansCfg?format=json
Query Parameter
None
Request Message
{
"ClearPlansCfg": {
/*opt, object*/
"ClearFlags": {
/*opt, object*/
"doorStatusWeekPlan": true,
/*opt, bool, whether to clear the week schedule of the door control*/
"cardReaderWeekPlan": true,
/*opt, bool, whether to clear the week schedule of the card reader authentication mode control*/
"userRightWeekPlan": true,
/*opt, bool, whether to clear the week schedule of the access permission control*/
"doorStatusHolidayPlan": true,
/*opt, bool, whether to clear the holiday schedule of the door control*/
"cardReaderHolidayPlan": true,
/*opt, bool, whether to clear the holiday schedule of the card reader authentication mode control*/
"userRightHolidayPlan": true,
/*opt, bool, whether to clear the holiday schedule of the access permission control*/
"doorStatusHolidayGroup": true,
/*opt, bool, whether to clear the holiday group of the door control*/
"cardReaderHolidayGroup": true,
/*opt, bool, whether to clear the holiday group of the card reader authentication mode control*/
"userRightHolidayGroup": true,
/*opt, bool, whether to clear the holiday group of the access permission control*/
"doorStatusTemplate": true,
/*opt, bool, whether to clear the schedule template of the door control*/
"cardReaderTemplate": true,
/*opt, bool, whether to clear the control schedule template of card reader authentication mode*/
"userRightTemplate": true
/*opt, bool, whether to clear the schedule template of access permission control*/
}
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.29.16 Get the capability of clearing access control schedule configuration.

Request URL
GET /ISAPI/AccessControl/ClearPlansCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"ClearPlansCfg": {
/*ro, req, object*/
"ClearFlags": {
/*ro, opt, object*/
"doorStatusWeekPlan": "true,false",
/*ro, opt, string, whether to clear the week schedule of the door control*/
"cardReaderWeekPlan": "true,false",
/*ro, opt, string, whether to clear the week schedule of the card reader authentication mode control*/
"userRightWeekPlan": "true,false",
/*ro, opt, string, whether to clear the week schedule of the access permission control*/
"doorStatusHolidayPlan": "true,false",
/*ro, opt, string, whether to clear the holiday schedule of the door control*/
"cardReaderHolidayPlan": "true,false",
/*ro, opt, string, whether to clear the holiday schedule of the card reader authentication mode control*/
"userRightHolidayPlan": "true,false",
/*ro, opt, string, whether to clear the holiday schedule of the access permission control*/
"doorStatusHolidayGroup": "true,false",
/*ro, opt, string, whether to clear the holiday group of the door control*/
"cardReaderHolidayGroup": "true,false",
/*ro, opt, string, whether to clear the holiday group of the card reader authentication mode control*/
"userRightHolidayGroup": "true,false",
/*ro, opt, string, whether to clear the holiday group of the access permission control*/
"doorStatusTemplate": "true,false",
/*ro, opt, string, whether to clear the schedule template of the door control*/
"cardReaderTemplate": "true,false",
/*ro, opt, string, whether to clear the control schedule template of the card reader authentication mode*/
"userRightTemplate": "true,false"
/*ro, opt, string, whether to clear the schedule template of the access permission control*/
}
}
}
21.29.17 Set holiday group parameters of door control schedule

Request URL
PUT /ISAPI/AccessControl/DoorStatusHolidayGroupCfg/<holidayGroupID>?format=json
Query Parameter
Request Message
{
/*opt, object*/
"enable": true,
/*req, bool, whether to enable, desc:whether to enable*/
/*req, string, holiday group name*/
/*opt, string*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.30 Credential Recognition Module Management

21.30.1 Get the configuration capability of enabling NFC (Near-Field Communication)
function
Request URL
GET /ISAPI/AccessControl/Configuration/NFCCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"NFCCfgCap": {
/*ro, opt, object, configuration capability of enabling NFC (Near-Field Communication) function*/
"enable": "true,false"
/*ro, req, string, whether to enable NFC function, desc:true-yes, false-no (default)*/
}
}
21.30.2 Get the capability of configuring card No. authentication rule

Request URL
GET /ISAPI/AccessControl/CardVerificationRule/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"CardVerificationRuleCap": {
/*ro, req, object*/
"cardNoLenMode": {
/*ro, opt, object, length mode of card No. authentication (comparison), desc:length mode of card No. authentication (comparison)*/
"@opt": ["full", "4Bytes", "3Bytes", "wiegand27", "wiegand35", "Corporate1000_35", "Corporate1000_48", "H10302_37", "H10304_37",
"wiegand_26CSN", "H103130_32CSN", "wiegand_56CSN", "wiegand_58"]
},
"CardVerificationRuleRes": {
/*ro, opt, object*/
"checkStatus": {
/*ro, opt, object, status of switching card No. authentication (comparison) mode, desc:"continue" (switching result can be searched for later),
"ok" (switching completed), "duplicate" (duplicate data exist and switching failed)*/
"@opt": ["continue", "ok", "duplicate"]
},
"progress": {
/*ro, opt, object, switching progress in percentage, desc:which is between 0 and 100,and 100 indicates that the card No. authentication
(comparison) mode is switched*/
"@min": 0,
"@max": 0
}
},
"reverseCardNoEnabled": {
/*ro, opt, object*/
/*ro, opt, array, options, subType:bool, range:[1,2]*/
}
}
}
21.30.3 Set Wiegand parameters

Request URL
PUT /ISAPI/AccessControl/WiegandCfg/wiegandNo/<wiegandID>
Query Parameter
wiegandID string --
Request Message
<WiegandCfg xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<communicateDirection>
receive
</communicateDirection>
<wiegandMode>
wiegand26
</wiegandMode>
<inputWiegandMode>
wiegand26
</inputWiegandMode>
<signalInterval>
1
</signalInterval>
<enable>
true
</enable>
<pulseDuration>
1
</pulseDuration>
<facilityCodeEnabled>
</facilityCodeEnabled>
<facilityCode>
1
</facilityCode>
<dataType>
employeeNo
</dataType>
</WiegandCfg>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.30.4 Get Wiegand parameters

Request URL
GET /ISAPI/AccessControl/WiegandCfg/wiegandNo/<wiegandID>
Query Parameter
wiegandID string --
Request Message
None
Response Message


<communicateDirection>
receive
<wiegandMode>
wiegand26
</wiegandMode>
<inputWiegandMode>
wiegand26
</inputWiegandMode>
<signalInterval>
1
</signalInterval>
<enable>
true
</enable>
<pulseDuration>
1
</pulseDuration>
<facilityCodeEnabled>
<facilityCode>
1
</facilityCode>
<dataType>
employeeNo
</dataType>
</WiegandCfg>
21.30.5 Get the card reader configuration parameters

Request URL
GET /ISAPI/AccessControl/CardReaderCfg/<cardReaderID>?format=json
Query Parameter
Request Message
None
Response Message
{
"CardReaderCfg": {
/*ro, req, object, card reader information*/
"enable": true,
"okLedPolarity": "cathode",
/*ro, opt, enum, OK LED polarity, subType:string, desc:"cathode", "anode"*/
"errorLedPolarity": "cathode",
/*ro, opt, enum, Error LED polarity, subType:string, desc:"cathode", "anode"*/
"buzzerPolarity": "cathode",
/*ro, opt, enum, buzzer polarity, subType:string, desc:“cathode", "anode"*/
"swipeInterval": 1,
/*ro, opt, int, time interval of repeated authentication, unit:s, desc:which is valid for authentication modes such as fingerprint, card, face,
etc.*/
"pressTimeout": 1,
/*ro, opt, int, timeout to reset entry on keypad, unit:s*/
"enableFailAlarm": true,
/*ro, opt, bool, whether to enable excessive failed authentication attempts alarm*/
"maxReadCardFailNum": 1,
/*ro, opt, int, maximum number of failed authentication attempts*/
"enableTamperCheck": true,
/*ro, opt, bool, whether to enable tampering detection*/
"offlineCheckTime": 1,
/*ro, opt, int, time to detect after the card reader is offline, unit:s*/
"fingerPrintCheckLevel": 1,
/*ro, opt, enum, fingerprint recognition level, subType:int, desc:1-1/10 false acceptance rate (FAR), 2-1/100 false acceptance rate (FAR), 3-1/1000
false acceptance rate (FAR), 4-1/10000 false acceptance rate (FAR), 5-1/100000 false acceptance rate (FAR), 6-1/1000000 false acceptance rate (FAR), 7-
1/10000000 false acceptance rate (FAR), 8-1/100000000 false acceptance rate (FAR), 9-3/100 false acceptance rate (FAR), 10-3/1000 false acceptance rate
(FAR), 11-3/10000 false acceptance rate (FAR), 12-3/100000 false acceptance rate (FAR), 13-3/1000000 false acceptance rate (FAR), 14-3/10000000 false
acceptance rate (FAR), 15-3/100000000 false acceptance rate (FAR), 16-Automatic Normal, 17-Automatic Secure, 18-Automatic More Secure (currently not
support)*/
"useLocalController": true,
/*ro, opt, bool, whether it is connected to the distributed controller*/
/*ro, opt, int, distributed controller No., range:[0,64], dep:and,{$.CardReaderCfg.localControllerID,eq,true}, desc:which is between 1 and 64, 0-
unregistered. This field is valid only when useLocalController is "true”*/
"localControllerReaderID": 1,
/*ro, opt, int, card reader ID of the distributed controller, 0-unregistered, dep:and,{$.CardReaderCfg.localControllerID,eq,true}, desc:this field
is valid only when useLocalController is "true”*/
"cardReaderChannel": 1,
/*ro, opt, enum, communication channel No. of the card reader, subType:int, dep:and,{$.CardReaderCfg.localControllerID,eq,true}, desc:0-Wiegand or
offline, 1-RS-485A, 2-RS-485B. This field is valid only when useLocalController is "true”*/
"fingerPrintImageQuality": 1,
/*ro, opt, enum, fingerprint image quality, subType:int, desc:1-low quality (V1), 2-medium quality (V1), 3-high quality (V1), 4-highest quality
(V1), 5-low quality (V2), 6-medium quality (V2), 7-high quality (V2), 8-highest quality (V2)*/
"fingerPrintContrastTimeOut": 1,
/*ro, opt, enum, fingerprint comparison timeout, subType:int, desc:fingerprint comparison timeout,which is between 1 and 20,unit: second,255-
infinite*/
"fingerPrintRecogizeInterval": 1,
/*ro, opt, enum, fingerprint scanning interval, subType:int, desc:fingerprint scanning interval,which is between 1 and 10,unit: second,255-no
delay*/
"fingerPrintMatchFastMode": 1,
/*ro, opt, enum, fingerprint matching quick mode, subType:int, desc:1-quick mode 1, 2-quick mode 2, 3-quick mode 3, 4-quick mode 4, 5-quick mode 5,
255-automatic*/
"fingerPrintModuleSensitive": 1,
/*ro, opt, enum, fingerprint module sensitivity, subType:int, desc:fingerprint module sensitivity,which is between 1 and 8*/
"fingerPrintModuleLightCondition": "outdoor",
/*ro, opt, enum, fingerprint module light condition, subType:string, desc:"outdoor", "indoor”*/
"faceMatchThresholdN": 1,
/*ro, opt, int, threshold of face picture 1:N comparison,which is between 0 and 100, range:[0,100]*/
"faceQuality": 1,
/*ro, opt, int, face picture quality, range:[0,100]*/
"faceRecogizeTimeOut": 1,
/*ro, opt, enum, face recognition timeout, subType:int, desc:face recognition timeout,which is between 1 and 20,unit: second,255-infinite*/
"faceRecogizeInterval": 1,
/*ro, opt, enum, face recognition interval, subType:int, desc:face recognition interval,which is between 1 and 10,unit: second,255-no delay*/
"cardReaderFunction": ["fingerPrint", "face", "card"],
/*ro, opt, enumarray, card reader type, subType:string, desc:"fingerPrint”, "face", "fingerVein". For example, ["fingerPrint", "face"] indicates
that the card reader supports both fingerprint and face*/
"cardReaderDescription": "Wiegand\u000485Offline",
/*ro, opt, string, card reader description, desc:if the card reader is the Wiegand card reader or if offline, this field will be set to "Wiegand" or
"485Offline”*/
"faceImageSensitometry": 1,
/*ro, opt, int, face picture exposure, range:[0,655535]*/
"livingBodyDetect": true,
/*ro, opt, bool, whether to enable human detection*/
"faceMatchThreshold1": 1,
/*ro, opt, int, threshold of face picture 1:1 comparison, range:[0,100]*/
"buzzerTime": 1,
/*ro, opt, int, buzzing duration, range:[0,59999], unit:s, desc:buzzing duration,which is between 0 and 5999,unit: second,0-long buzzing*/
"faceMatch1SecurityLevel": 1,
/*ro, opt, enum, security level of face 1:1 recognition, subType:int, desc:1 (normal), 2 (high), 3 (higher)*/
"faceMatchNSecurityLevel": 1,
/*ro, opt, enum, security level of face 1:N recognition: 1-normal,2-high,3-higher, subType:int, desc:1 (normal), 2 (high), 3 (higher)*/
"envirMode": "other",
/*ro, opt, enum, environment mode of face recognition, subType:string, desc:"indoor", "other”*/
"liveDetLevelSet": "low",
/*ro, opt, enum, threshold level of liveness detection, subType:string, desc:"low", "middle", "high”*/
"liveDetAntiAttackCntLimit": 1,
/*ro, opt, int, number of anti-attacks of liveness detection, range:[1,255], desc:this value should be configured as the same one on both client and
device*/
"enableLiveDetAntiAttack": true,
/*ro, opt, bool, whether to enable anti-attack for liveness detection*/
"supportDelFPByID": true,
/*ro, opt, bool, whether the card reader supports deleting fingerprint by fingerprint ID, desc:"true"-yes, "false"-no*/
"fingerPrintCapacity": 1,
/*ro, opt, int, fingerprint capacity*/
"fingerPrintNum": 1,
/*ro, opt, int, number of added fingerprints*/
"defaultVerifyMode": "cardAndPw",
/*ro, opt, enum, default authentication mode of the fingerprint and card reader (factory defaults), subType:string, desc:(factory defaults):
"cardAndPw"-card+password, "card", "cardOrPw"-card or password, "fp"-fingerprint, "fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card,
"fpAndCard"-fingerprint+card, "fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card or password, "faceAndFp"-
face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face", "employeeNoAndPw"-employee No.+password, "fpOrPw"-fingerprint or password,
"employeeNoAndFp"-employee No.+fingerprint, "employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-face+fingerprint+card,
"faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face, "faceOrfaceAndCard"-face or face+card, "fpOrface"-fingerprint or face,
"cardOrfaceOrPw"-card or face or password, "cardOrFace"-card or face, "cardOrFaceOrFp"-card or face or fingerprint*/
"faceRecogizeEnable": 1,
/*ro, opt, enum, whether to enable facial recognition, subType:int, desc:1 (enable), 2 (disable), 3 (attendence checked in/out by recognition of
multiple faces)*/
"FPAlgorithmVersion": "test",
/*ro, opt, string, fingerprint algorithm library version, range:[1,32]*/
"cardReaderVersion": "test",
/*ro, opt, string, card reader version, range:[1,32]*/
"enableReverseCardNo": true,
/*ro, opt, bool, whether to enable reversing the card No.*/
"independSwipeIntervals": 0,
/*ro, opt, int, time interval of person authentication, desc:unit: second. This time interval is calculated for each person separately and is
different from swipeInterval*/
"maskFaceMatchThresholdN": 1,
/*ro, opt, int, 1:N face picture (face with mask and normal background) comparison threshold, range:[0,100]*/
"maskFaceMatchThreshold1": 1,
/*ro, opt, int, 1:1 face picture (face with mask and normal background) comparison threshold, range:[0,100]*/
"faceMotionDetLevel": "low",
"showMode": "normal",
"enableScreenOff": true,
/*ro, opt, bool*/
"screenOffTimeout": 1
/*ro, opt, int, step:1, unit:s*/
}
}
21.30.6 Set the card reader parameters

Request URL
PUT /ISAPI/AccessControl/CardReaderCfg/<cardReaderID>?format=json
Query Parameter
Request Message
{
"CardReaderCfg": {
/*req, object, card reader information*/
"enable": true,
/*req, bool, whether to enable, desc:true-yes, false-no*/
"okLedPolarity": "cathode",
/*opt, enum, OK LED polarity, subType:string, desc:"cathode", "anode”*/
"errorLedPolarity": "cathode",
/*opt, enum, Error LED polarity, subType:string, desc:"cathode", "anode"*/
"buzzerPolarity": "cathode",
/*opt, enum, buzzer polarity, subType:string, desc:"cathode", "anode"*/
"swipeInterval": 1,
/*opt, int, time interval of repeated authentication, unit:s, desc:it is valid for authentication modes such as fingerprint, card, face, etc.*/
"pressTimeout": 1,
/*opt, int, timeout to reset entry on keypad, unit:s*/
"enableFailAlarm": true,
/*opt, bool, whether to enable excessive failed authentication attempt alarm*/
"maxReadCardFailNum": 1,
/*opt, int, maximum number of failed authentication attempts*/
"enableTamperCheck": true,
/*opt, bool, whether to enable tampering detection*/
"offlineCheckTime": 1,
/*opt, int, time to detect after the card reader is offline, unit:s*/
"fingerPrintCheckLevel": 1,
/*opt, enum, fingerprint recognition level, subType:int, desc:1-1/10 false acceptance rate (FAR), 2-1/100 false acceptance rate (FAR), 3-1/1000
false acceptance rate (FAR), 4-1/10000 false acceptance rate (FAR), 5-1/100000 false acceptance rate (FAR), 6-1/1000000 false acceptance rate (FAR), 7-
1/10000000 false acceptance rate (FAR), 8-1/100000000 false acceptance rate (FAR), 9-3/100 false acceptance rate (FAR), 10-3/1000 false acceptance rate
(FAR), 11-3/10000 false acceptance rate (FAR), 12-3/100000 false acceptance rate (FAR), 13-3/1000000 false acceptance rate (FAR), 14-3/10000000 false
acceptance rate (FAR), 15-3/100000000 false acceptance rate (FAR), 16-Automatic Normal, 17-Automatic Secure, 18-Automatic More Secure (currently not
support)*/
"useLocalController": true,
/*opt, bool, whether it is connected to the distributed controller*/
/*opt, int, distributed controller No., range:[0,64], dep:and,{$.CardReaderCfg.localControllerID,eq,true}, desc:0-unregistered. This field is valid
only when useLocalController is "true"*/
"localControllerReaderID": 1,
/*opt, int, card reader ID of the distributed controller, dep:and,{$.CardReaderCfg.localControllerID,eq,true}, desc:0-unregistered. This field is
valid only when useLocalController is "true"*/
"cardReaderChannel": 1,
/*opt, enum, communication channel No. of the card reader, subType:int, dep:and,{$.CardReaderCfg.localControllerID,eq,true}, desc:0-Wiegand or
offline, 1-RS-485A, 2-RS-485B. This field is valid only when useLocalController is "true"*/
"fingerPrintImageQuality": 1,
/*opt, enum, fingerprint image quality, subType:int, desc:1-low quality (V1), 2-medium quality (V1), 3-high quality (V1), 4-highest quality (V1), 5-
low quality (V2), 6-medium quality (V2), 7-high quality (V2), 8-highest quality (V2)*/
"fingerPrintContrastTimeOut": 1,
/*opt, enum, fingerprint comparison timeout, subType:int, desc:it is between 1 and 20, unit: second, 255-infinite*/
"fingerPrintRecogizeInterval": 1,
/*opt, enum, fingerprint scanning interval, subType:int, desc:it is between 1 and 10, unit: second, 255-no delay*/
"fingerPrintMatchFastMode": 1,
/*opt, enum, fingerprint matching quick mode, subType:int, desc:1-quick mode 1, 2-quick mode 2, 3-quick mode 3, 4-quick mode 4, 5-quick mode 5, 255-
automatic*/
"fingerPrintModuleSensitive": 1,
/*opt, enum, fingerprint module sensitivity, subType:int, desc:fingerprint module sensitivity,which is between 1 and 8*/
"fingerPrintModuleLightCondition": "outdoor",
/*opt, enum, fingerprint module light condition, subType:string, desc:"outdoor", "indoor”*/
"faceMatchThresholdN": 1,
/*opt, int, threshold of face picture 1:N comparison, range:[0,100], desc:threshold of face picture 1:N comparison,which is between 0 and 100*/
"faceQuality": 1,
/*opt, int, face picture quality, range:[0,100]*/
"faceRecogizeTimeOut": 1,
/*opt, enum, face recognition timeout, subType:int, desc:it is between 1 and 20, unit: second, 255-infinite*/
"faceRecogizeInterval": 1,
/*opt, enum, face recognition interval, subType:int, desc:it is between 1 and 10, unit: second, 255-no delay*/
"cardReaderFunction": ["fingerPrint", "face", "fingerVein", "iris", "card"],
"cardReaderFunction": ["fingerPrint", "face", "fingerVein", "iris", "card"],
/*opt, enumarray, card reader type, subType:string, desc:"fingerPrint"-fingerprint, "face", "fingerVein"-finger vein, “iris”. For example,
["fingerPrint","face"] indicates that the card reader supports both fingerprint and face*/
"cardReaderDescription": "Wiegand\u000485Offline",
/*opt, string, card reader description, desc:if the card reader is the Wiegand card reader or if offline, this field will be set to "Wiegand" or
"485Offline”*/
"faceImageSensitometry": 1,
/*opt, int, face picture exposure, range:[0,655535]*/
"livingBodyDetect": true,
/*opt, bool, whether to enable human detection*/
"faceMatchThreshold1": 1,
/*opt, int, threshold of face picture 1:1 comparison, range:[0,100], desc:threshold of face picture 1:1 comparison,which is between 0 and 100*/
"buzzerTime": 1,
/*opt, int, buzzing duration, range:[0,59999], unit:s, desc:0-long buzzing*/
"faceMatch1SecurityLevel": 1,
/*opt, enum, security level of face 1:1 recognition, subType:int, desc:1-normal, 2-high, 3-higher*/
"faceMatchNSecurityLevel": 1,
/*opt, enum, security level of face 1:N recognition, subType:int, desc:1-normal, 2-high, 3-higher*/
"envirMode": "indoor",
/*opt, enum, environment mode of face recognition, subType:string, desc:"indoor", "other”*/
"liveDetLevelSet": "low",
/*opt, enum, threshold level of liveness detection, subType:string, desc:"low", "middle"-medium, "high"*/
"liveDetAntiAttackCntLimit": 1,
/*opt, int, number of anti-attacks of liveness detection,, range:[1,255], desc:this value should be configured as the same one on both client and
device*/
"enableLiveDetAntiAttack": true,
/*opt, bool, whether to enable anti-attack for liveness detection*/
"supportDelFPByID": true,
/*opt, bool, whether the card reader supports deleting fingerprint by fingerprint ID, desc:true-yes, false-no*/
"fingerPrintCapacity": 1,
/*opt, int, fingerprint capacity*/
"fingerPrintNum": 1,
/*opt, int, number of added fingerprints*/
"defaultVerifyMode": "cardAndPw",
/*opt, enum, default authentication mode of the fingerprint and card reader (factory defaults):, subType:string, desc:"cardAndPw"-card+password,
"card", "cardOrPw"-card or password, "fp"-fingerprint, "fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint+card,
"fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card or password, "faceAndFp"-face+fingerprint, "faceAndPw"-
face+password, "faceAndCard"-face+card, "face", "employeeNoAndPw"-employee No.+password, "fpOrPw"-fingerprint or password, "employeeNoAndFp"-employee
No.+fingerprint, "employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-face+fingerprint+card, "faceAndPwAndFp"-
face+password+fingerprint, "employeeNoAndFace"-employee No.+face, "faceOrfaceAndCard"-face or face+card, "fpOrface"-fingerprint or face, "cardOrfaceOrPw"-
card or face or password, “iris”, “faceOrFpOrCardOrPwOrIris"-face or fingerprint or card password or iris”, "faceOrCardOrPwOrIris"-face or card or password
or iris*/
"faceRecogizeEnable": 1,
/*opt, enum, whether to enable facial recognition, subType:int, desc:1-enable, 2-disable, 3-attendence checked in/out by recognition of multiple
faces*/
"FPAlgorithmVersion": "test",
/*opt, string, fingerprint algorithm library version, range:[1,32]*/
"cardReaderVersion": "test",
/*opt, string, card reader version, range:[1,32]*/
"enableReverseCardNo": true,
/*opt, bool, whether to enable reversing the card No.*/
"independSwipeIntervals": 0,
/*opt, int, time interval of person authentication, unit: second. This time interval is calculated for each person separately and is different from
swipeInterval, desc:time interval of person authentication,unit: second. This time interval is calculated for each person separately and is different from
swipeInterval*/
"maskFaceMatchThresholdN": 1,
/*opt, int, 1:N face picture (face with mask and normal background) comparison threshold, range:[0,100], desc:1:N face picture (face with mask and
normal background) comparison threshold,value range: [0,100]*/
"maskFaceMatchThreshold1": 1,
/*opt, int, 1:1 face picture (face with mask and normal background) comparison threshold, range:[0,100], desc:1:1 face picture (face with mask and
normal background) comparison threshold,value range: [0,100]*/
"faceMotionDetLevel": "low",
"showMode": "normal",
"enableScreenOff": true,
/*opt, bool*/
"screenOffTimeout": 1
/*opt, int, step:1, unit:s*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
/*ro, opt, string, error description, desc:this node is required when the value of statusCode is not 1*/
}
21.30.7 Get the configuration capability of the card reader

Request URL
GET /ISAPI/AccessControl/CardReaderCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"CardReaderCfg": {
/*ro, req, object*/
"cardReaderNo": {
/*ro, opt, object, card reader No., desc:card reader No.*/
"@min": 1,
/*ro, opt, int*/
"@max": 512,
/*ro, opt, int*/
"@opt": [1, 4]
},
/*ro, opt, string, whether to enable: "true"-yes,"false"-no, desc:whether to enable: "true"-yes,"false"-no*/
"okLedPolarity": {
/*ro, opt, object, OK LED polarity*/
"@opt": "cathode,anode"
/*ro, req, string, desc:"cathode", "anode"*/
},
"errorLedPolarity": {
/*ro, opt, object, error LED polarity*/
/*ro, req, string*/
},
"buzzerPolarity": {
/*ro, opt, object, buzzer polarity, desc:buzzer polarity: "cathode","anode"*/
/*ro, req, string*/
},
"swipeInterval": {
/*ro, opt, object, time interval of repeated authentication, desc:it is valid for authentication modes such as fingerprint, card, face, etc., unit:
second*/
"@min": 1,
/*ro, req, int*/
"@max": 255
/*ro, req, int*/
},
"pressTimeout": {
/*ro, opt, object, timeout to reset entry on keypad, desc:unit: second*/
"@min": 1,
/*ro, req, int*/
"@max": 255
/*ro, req, int*/
},
"enableFailAlarm": "true,false",
/*ro, opt, string, whether to enable excessive failed authentication attempts alarm*/
"maxReadCardFailNum": {
/*ro, opt, object, maximum number of failed authentication attempts*/
"@min": 1,
/*ro, req, int*/
"@max": 255
/*ro, req, int*/
},
"enableTamperCheck": "true,false",
/*ro, opt, string, whether to enable tampering detection*/
"offlineCheckTime": {
/*ro, opt, object, time to detect after the card reader is offline, desc:unit: second*/
"@min": 1,
/*ro, req, int*/
"@max": 255
/*ro, req, int*/
},
"fingerPrintCheckLevel": {
/*ro, opt, object, fingerprint recognition level*/
"@opt": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18"
/*ro, req, string*/
},
"useLocalController": "true,false",
/*ro, opt, string, whether it is connected to the distributed controller*/
"localControllerID": {
/*ro, opt, object, distributed controller No., desc:it is between 1 and 64, 0 (unregistered). This field is valid only when useLocalController is
"true"*/
"@min": 0,
/*ro, req, int*/
"@max": 64
/*ro, req, int*/
},
"localControllerReaderID": {
/*ro, opt, object, card reader ID of the distributed controller, desc:0 (unregistered). This field is valid only when useLocalController is "true"*/
"@min": 0,
/*ro, req, int*/
"@max": 4
/*ro, req, int*/
},
"cardReaderChannel": {
/*ro, opt, object, communication channel No. of the card reader, desc:this field is valid only when useLocalController is "true"*/
"@opt": "0,1,2"
/*ro, req, string*/
},
"fingerPrintImageQuality": {
/*ro, opt, object, fingerprint image quality, desc:fingerprint image quality: 1 (low quality (V1)), 2 (medium quality (V1)), 3 (high quality (V1)),
4 (highest quality (V1)), 5 (low quality (V2)), 6 (medium quality (V2)), 7 (high quality (V2)), 8 (highest quality (V2))*/
"@opt": "1,2,3,4,5,6,7,8"
/*ro, req, string*/
},
"fingerPrintContrastTimeOut": {
/*ro, opt, object, fingerprint comparison timeout, desc:it is between 1 and 20, unit: second, 0 (infinite)*/
"@min": 0,
/*ro, req, int*/
"@max": 20
/*ro, req, int*/
},
"fingerPrintRecogizeInterval": {
/*ro, opt, object, fingerprint scanning interval, desc:it is between 1 and 10, unit: second, 0 (no delay)*/
"@min": 0,
/*ro, req, int*/
"@max": 10
/*ro, req, int*/
},
"fingerPrintMatchFastMode": {
/*ro, opt, object, fingerprint matching quick mode, desc:1 (quick mode 1), 2 (quick mode 2), 3 (quick mode 3), 4 (quick mode 4), 5 (quick mode 5), 0
(automatic)*/
"@min": 0,
/*ro, req, int*/
"@max": 5
/*ro, req, int*/
},
"fingerPrintModuleSensitive": {
/*ro, opt, object, fingerprint module sensitivity, desc:it is between 1 and 8*/
"@min": 1,
/*ro, req, int*/
"@max": 8
/*ro, req, int*/
},
"fingerPrintModuleLightCondition": {
/*ro, opt, object, fingerprint module light condition*/
"@opt": "outdoor,indoor"
/*ro, req, string, desc:"outdoor", "indoor"*/
},
"faceMatchThresholdN": {
/*ro, opt, object, threshold of face picture 1:N comparison, desc:it is between 0 and 100*/
"@min": 0,
/*ro, req, int*/
"@max": 100
/*ro, req, int*/
},
"faceQuality": {
/*ro, opt, object, face picture quality, desc:it is between 0 and 100*/
"@min": 0,
/*ro, req, int*/
"@max": 100
},
"faceRecogizeTimeOut": {
/*ro, opt, object, face recognition timeout, desc:it is between 1 and 20, unit: second, 0 (infinite)*/
"@min": 0,
/*ro, req, int*/
"@max": 20
/*ro, req, int*/
},
"faceRecogizeInterval": {
/*ro, opt, object, face recognition interval, desc:it is between 1 and 10, unit: second, 0 (no delay)*/
"@min": 0,
/*ro, req, int*/
"@max": 10
/*ro, req, int*/
},
"cardReaderFunction": {
/*ro, opt, object, card reader type*/
"@opt": "fingerPrint,face,fingerVein,iris,card"
/*ro, req, string, desc:"fingerPrint” (fingerprint), "face", "fingerVein” (finger vein), “iris”*/
},
"cardReaderDescription": {
/*ro, opt, object, card reader description, desc:if the card reader is the Wiegand card reader or if offline, this field will be set to "Wiegand" or
"485Offline"*/
"@min": 1,
/*ro, req, int*/
"@max": 16
/*ro, req, int*/
},
"isSupportOfflineSendPermission": true,
"isSupportOfflineSendPermission": true,
/*ro, opt, bool*/
"faceImageSensitometry": {
/*ro, opt, object, face picture exposure, desc:it is between 0 and 65535*/
"@min": 0,
/*ro, req, int*/
"@max": 65535
/*ro, req, int*/
},
"livingBodyDetect": "true,false",
/*ro, opt, string, whether to enable human detection*/
"faceMatchThreshold1": {
/*ro, opt, object, threshold of face picture 1:1 comparison, desc:it is between 0 and 100*/
"@min": 0,
/*ro, req, int*/
"@max": 100
/*ro, req, int*/
},
"buzzerTime": {
/*ro, opt, object, buzzing duration, desc:it is between 0 and 5999, unit: second, 0 (long buzzing)*/
"@min": 0,
/*ro, req, int*/
"@max": 5999
/*ro, req, int*/
},
"faceMatch1SecurityLevel": {
/*ro, opt, object, security level of face 1:1 recognition*/
"@opt": "1,2,3"
/*ro, req, string, desc:1 (normal), 2 (high), 3 (higher)*/
},
"faceMatchNSecurityLevel": {
/*ro, opt, object, security level of face 1:N recognition*/
"@opt": "1,2,3"
/*ro, req, string, desc:1 (normal), 2 (high), 3 (higher)*/
},
"envirMode": {
/*ro, opt, object, environment mode of face recognition*/
"@opt": "indoor,other"
/*ro, req, string, desc:"indoor", "other"*/
},
"liveDetLevelSet": {
/*ro, opt, object, threshold level of liveness detection*/
"@opt": "low,middle,high"
/*ro, req, string, desc:"low", "middle” (medium), "high"*/
},
"liveDetAntiAttackCntLimit": {
/*ro, opt, object, number of anti-attacks of liveness detection, desc:it is between 1 and 255. This value should be configured as the same one on
both client and device*/
"@min": 1,
/*ro, req, int*/
"@max": 255
/*ro, req, int*/
},
"enableLiveDetAntiAttack": "true,false",
/*ro, opt, string, whether to enable anti-attack for liveness detection, desc:whether to enable anti-attack for liveness detection*/
"supportDelFPByID": "true,false",
/*ro, opt, string, whether the card reader supports deleting the fingerprint by fingerprint ID, desc:"true” (yes), "false” (no)*/
"fingerPrintCapacity": {
/*ro, opt, object, maximum number of fingerprints that can be added*/
"@min": 1,
/*ro, req, int*/
"@max": 100
/*ro, req, int*/
},
"fingerPrintNum": {
/*ro, opt, object, number of added fingerprints*/
"@min": 1,
/*ro, req, int*/
"@max": 100
/*ro, req, int*/
},
"defaultVerifyMode": {
/*ro, opt, object, default authentication mode of the card reader, desc:default authentication mode of the card reader (factory defaults)*/
"@opt":
eNoAndFp,employeeNoAndFpAndPw,faceAndFpAndCard,faceAndPwAndFp,employeeNoAndFace,faceOrfaceAndCard,fpOrface,cardOrfaceOrPw,cardOrFace,cardOrFaceOrFp,iris,fac
eOrFpOrCardOrPwOrIris,faceOrCardOrPwOrIris"
/*ro, req, string*/
},
"FPAlgorithmVersion": {
/*ro, opt, object, fingerprint algorithm library version*/
"@min": 1,
/*ro, req, int*/
"@max": 1
/*ro, req, int*/
},
"cardReaderVersion": {
/*ro, opt, object, card reader version*/
"@min": 1,
/*ro, req, int*/
"@max": 1
/*ro, req, int*/
},
"faceRecogizeEnable": {
"faceRecogizeEnable": {
/*ro, opt, object, whether to enable facial recognition*/
"@opt": "1,2,3"
/*ro, req, string, desc:1 (enable), 2 (disable), 3 (attendence checked in/out by recognition of multiple faces)*/
},
"enableReverseCardNo": "true,false",
/*ro, opt, string, whether to enable reversing the card No.*/
"independSwipeIntervals": {
/*ro, opt, object, time interval of person authentication, desc:unit: second. This time interval is calculated for each person separately and is
different from swipeInterval*/
"@min": 1,
/*ro, req, int*/
"@max": 1
/*ro, req, int*/
},
"maskFaceMatchThresholdN": {
/*ro, opt, object, 1:N face picture (face with mask and normal background) comparison threshold, desc:value range: [0,100]*/
"@min": 0,
/*ro, req, int*/
"@max": 100
/*ro, req, int*/
},
"maskFaceMatchThreshold1": {
/*ro, opt, object, 1:1 face picture (face with mask and normal background) comparison threshold, desc:value range: [0,100]*/
"@min": 0,
/*ro, req, int*/
"@max": 100
/*ro, req, int*/
},
"faceMotionDetLevel": {
/*ro, opt, object*/
"@opt": ["low", "meduim", "height"]
},
"showMode": {
/*ro, opt, object*/
"@opt": ["concise", "normal", "advertising", "meeting", "selfDefine"]
},
"enableScreenOff": {
/*ro, opt, object*/
},
"screenOffTimeout": {
/*ro, opt, object*/
"@min": 0,
/*ro, req, int*/
"@max": 10
/*ro, req, int*/
}
}
}
21.30.8 Set the parameters of intelligent identity recognition terminal

Request URL
PUT /ISAPI/AccessControl/IdentityTerminal
Query Parameter
None
Request Message
<IdentityTerminal xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<terminalMode>
authMode
</terminalMode>
<idCardReader>
iDR210
</idCardReader>
<camera>
C270
</camera>
<fingerPrintModule>
ALIWARD
</fingerPrintModule>
<videoStorageTime>
1
</videoStorageTime>
<faceContrastThreshold>
1
</faceContrastThreshold>
<twoDimensionCode>
<twoDimensionCode>
enable
</twoDimensionCode>
<blackListCheck>
enable
</blackListCheck>
<idCardCheckCenter>
local
</idCardCheckCenter>
<faceAlgorithm>
DeepLearn
</faceAlgorithm>
<comNo>
1
</comNo>
<memoryLearning>
enable
</memoryLearning>
<saveCertifiedImage>
enable
</saveCertifiedImage>
<MCUVersion>
test
</MCUVersion>
<usbOutput>
enable
</usbOutput>
<serialOutput>
enable
</serialOutput>
<readInfoOfCard>
serialNo
</readInfoOfCard>
<workMode>
passMode
</workMode>
<ecoMode>

<eco>
enable
</eco>
<faceMatchThreshold1>
1
</faceMatchThreshold1>
<faceMatchThresholdN>
1
</faceMatchThresholdN>
<changeThreshold>
0
</changeThreshold>
<maskFaceMatchThresholdN>
1
</maskFaceMatchThresholdN>
<maskFaceMatchThreshold1>
1
</maskFaceMatchThreshold1>
</ecoMode>
<readCardRule>
wiegand26
</readCardRule>
<enableScreenOff>
true
</enableScreenOff>
<screenOffTimeout>
1
</screenOffTimeout>
<enableScreensaver>
true
</enableScreensaver>
<faceModuleVersion>
</faceModuleVersion>
<showMode>
concise
</showMode>
<needDeviceCheck>
true
</needDeviceCheck>
</IdentityTerminal>
Response Message

<requestURL>
test
</requestURL>
<statusCode>
1
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
test
</subStatusCode>
</ResponseStatus>
21.30.9 Get the parameters of intelligent identity recognition terminal

Request URL
GET /ISAPI/AccessControl/IdentityTerminal
Query Parameter
None
Request Message
None
Response Message


<terminalMode>
authMode
</terminalMode>
<idCardReader>
iDR210
</idCardReader>
<camera>
C270
</camera>
<fingerPrintModule>
ALIWARD
<videoStorageTime>
1
</videoStorageTime>
<faceContrastThreshold>
1
<twoDimensionCode>
enable
</twoDimensionCode>
<blackListCheck>
enable
</blackListCheck>
<idCardCheckCenter>
local
<faceAlgorithm>
1
</comNo>
<memoryLearning>
enable
</memoryLearning>
<saveCertifiedImage>
enable
<MCUVersion>
test
</MCUVersion>
<usbOutput>
enable
</usbOutput>
<serialOutput>
enable
</serialOutput>
<readInfoOfCard>
serialNo
</readInfoOfCard>
<workMode>
passMode
</workMode>
<ecoMode>
<eco>
enable
</eco>
<faceMatchThreshold1>
1
<faceMatchThresholdN>
1
<changeThreshold>
0
</changeThreshold>
<maskFaceMatchThresholdN>
0
<maskFaceMatchThreshold1>
0
</ecoMode>
<readCardRule>
wiegand26
</readCardRule>
<enableScreenOff>
true
</enableScreenOff>
<screenOffTimeout>
1
</screenOffTimeout>
<enableScreensaver>
true
<faceModuleVersion>
<showMode>
concise
</showMode>
<needDeviceCheck>
true
</needDeviceCheck>
</IdentityTerminal>
21.30.10 Get configuration capability of intelligent identity recognition terminal

Request URL
GET /ISAPI/AccessControl/IdentityTerminal/capabilities
Query Parameter
None
Request Message
None
Response Message


<terminalMode opt="authMode,registerMode">
iDR210
</idCardReader>
<camera opt="C270,DS-2CS5432B-S">
C270
</camera>
<fingerPrintModule opt="ALIWARD,HikModule">
ALIWARD
<videoStorageTime min="0" max="10">
1
</videoStorageTime>
<faceContrastThreshold min="0" max="100">
1
<twoDimensionCode opt="enable,disable">
enable
</twoDimensionCode>
<blackListCheck opt="enable,disable">
enable
</blackListCheck>
<idCardCheckCenter opt="local,server">
local
<faceAlgorithm opt="DeepLearn,Tradition">
DeepLearn
</faceAlgorithm>
<comNo min="1" max="9">
1
</comNo>
<memoryLearning opt="enable,disable">
enable
</memoryLearning>
<saveCertifiedImage opt="enable,disable">
enable
<MCUVersion min="1" max="10">
test
</MCUVersion>
<usbOutput opt="enable,disable">
enable
</usbOutput>
<serialOutput opt="enable,disable">
enable
</serialOutput>
<readInfoOfCard opt="serialNo,file">
serialNo
</readInfoOfCard>
<workMode opt="passMode,accessControlMode">
passMode
</workMode>
<ecoMode>
<eco opt="enable,disable">
enable
</eco>
<faceMatchThreshold1 min="0" max="100">
1
<faceMatchThresholdN min="0" max="100">
1
<changeThreshold min="1" max="10">
0
</changeThreshold>
<maskFaceMatchThresholdN min="0" max="100">
wiegand26
</readCardRule>
<enableScreenOff opt="true,false">
true
</enableScreenOff>
<screenOffTimeout min="0" max="10">
1
</screenOffTimeout>
<enableScreensaver opt="true,false">
true
<faceModuleVersion min="0" max="10">
<showMode opt="concise,normal,advertising,meeting,selfDefine,boxStatus">
concise
</showMode>
<needDeviceCheck opt="true,false">
true
</needDeviceCheck>
</IdentityTerminal>
21.30.11 Set the condition parameters of face picture comparison
Request URL
PUT /ISAPI/AccessControl/FaceCompareCond
Query Parameter
None
Request Message
<FaceCompareCond xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<faceWidthLowerLimit>
50
</faceWidthLowerLimit>
<pitch>
0
</pitch>
<yaw>
0
</yaw>
<width>
50
</width>
<height>
50
</height>
<leftBorder>
50
</leftBorder>
<rightBorder>
50
</rightBorder>
<upBorder>
50
</upBorder>
<bottomBorder>
50
</bottomBorder>
<interorbitalDistance>
50
</interorbitalDistance>
<faceScore>
50
</faceScore>
<maxDistance>
0.5
</maxDistance>
<similarity>
50
</similarity>
<antiFake>
50
</antiFake>
<identifyType>
highest
</identifyType>
<chooseType>
all
</chooseType>
<enabled>
singleFace
</enabled>
<faceScoreEnabled>
true
</faceScoreEnabled>
</FaceCompareCond>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.30.12 Get the facial recognition parameters.

Request URL
GET /ISAPI/AccessControl/FaceCompareCond
Query Parameter
None
Request Message
None
Response Message


<faceWidthLowerLimit>
50
<pitch>
0
</pitch>
<yaw>
0
</yaw>
<width>
50
</width>
<height>
50
</height>
<leftBorder>
50
</leftBorder>
<rightBorder>
50
</rightBorder>
<upBorder>
50
</upBorder>
<bottomBorder>
50
</bottomBorder>
<interorbitalDistance>
50
<faceScore>
50
</faceScore>
<maxDistance>
0.5
</maxDistance>
<similarity>
50
</similarity>
<antiFake>
50
</antiFake>
<identifyType>
highest
</identifyType>
<chooseType>
all
</chooseType>
<enabled>
singleFace
</enabled>
<faceScoreEnabled>
true
</faceScoreEnabled>
</FaceCompareCond>
21.30.13 Get the capability of configuring facial recognition parameters.

Request URL
GET /ISAPI/AccessControl/FaceCompareCond/capabilities
Query Parameter
None
Request Message
None
Response Message


<faceWidthLowerLimit min="1" max="10">
1
<pitch min="1" max="10">
1
</pitch>
<yaw min="1" max="10">
1
</yaw>
<width min="1" max="10">
1
</width>
<height min="1" max="10">
1
</height>
<leftBorder min="1" max="10">
1
</leftBorder>
<rightBorder min="1" max="10">
1
</rightBorder>
<upBorder min="1" max="10">
1
</upBorder>
<bottomBorder min="1" max="10">
1
</bottomBorder>
<interorbitalDistance min="1" max="10">
1
<faceScore min="1" max="10">
1
</faceScore>
<maxDistance opt="0.5,1,1.5,2,auto">
test
</maxDistance>
<similarity min="0.0" max="1.0">
0.000
</similarity>
<antiFake min="1" max="10">
1
</antiFake>
<identifyType opt="highest,single,multipl">
highest
</identifyType>
<chooseType opt="middle,biggest,all">
middle
</chooseType>
<enabled opt="singleFace,close,multiFace">
singleFace
</enabled>
<faceScoreEnabled opt="true,false">
true
</faceScoreEnabled>
</FaceCompareCond>
21.30.14 Get the capability of Wiegand parameters

Request URL
GET /ISAPI/AccessControl/WiegandCfg/capabilities
Query Parameter
None
Request Message
None
Response Message


<wiegandNo min="1" max="4" opt="1,4">
1
</wiegandNo>
<communicateDirection opt="receive,send">
receive
<wiegandMode
opt="wiegand26,wiegand34,wiegand27,wiegand35,Corporate1000_35,Corporate1000_48,H10302_37,H10304_37,wiegand_26CSN,H103130_32CSN,wiegand_56CSN,wiegand_58">
wiegand26
</wiegandMode>
<inputWiegandMode>
wiegand26
</inputWiegandMode>
<signalInterval min="1" max="20">
1
</signalInterval>
true
</enable>
<pulseDuration min="1" max="10">
1
</pulseDuration>
<facilityCodeEnabled opt="true,false">
true
<facilityCode min="0" max="65535">
1
</facilityCode>
<dataType opt="employeeNo,cardNo">
employeeNo
</dataType>
</WiegandCfg>
21.30.15 Get the capability of configuring parameters of the facial recognition mode.
Request URL
GET /ISAPI/AccessControl/FaceRecognizeMode/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"FaceRecognizeMode": {
/*ro, opt, object, facial recognition mode*/
"mode": {
/*ro, req, object, mode*/
"@opt": "normalMode"
/*ro, opt, enum, mode options, subType:string, desc:"normalMode" (normal mode), "deepMode" (deep mode)*/
}
}
}
21.30.16 Set the parameters of enabling NFC (Near-Field Communication) function

Request URL
PUT /ISAPI/AccessControl/Configuration/NFCCfg?format=json
Query Parameter
None
Request Message
{
"NFCCfg": {
/*req, object, configuration capability of enabling NFC (Near-Field Communication) function*/
"enable": true
/*req, bool, whether to enable NFC function, desc:true-yes, false-no (default)*/
}
}
Response Message
{
"statusCode": 1,
/*ro, opt, string, status description, desc:"ok" (succeeded). It is required when an error occurred*/
/*ro, opt, string, sub status code, desc:"ok" (succeeded). It is required when an error occurred*/
"errorCode": 1,
/*ro, req, int, error code, desc:it is required when the value of statusCode is not 1, and it corresponds to subStatusCode*/
"errorMsg": "ok"
}
21.30.17 Get the parameters of enabling NFC (Near-Field Communication) function

Request URL
GET /ISAPI/AccessControl/Configuration/NFCCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
"NFCCfg": {
/*ro, req, object*/
"enable": true
/*ro, req, bool, whether to enable NFC function, desc:true (yes), false (no). The value of this node is "false" by default*/
}
}
21.30.18 Set the facial recognition mode parameters

Request URL
PUT /ISAPI/AccessControl/FaceRecognizeMode?format=json
Query Parameter
None
Request Message
{
/*opt, object, facial recognition mode*/
"mode": "normalMode"
/*req, enum, facial recognition mode, subType:string, desc:"normalMode" (normal mode), "deepMode" (deep mode)*/
}
}
Response Message
{
"requestURL": "/ISAPI/Intelligent/FDLib/asyncImportDatas?format=json",
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.30.19 Get the parameters of the facial recognition mode.

Request URL
GET /ISAPI/AccessControl/FaceRecognizeMode?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object, facial recognition mode*/
"mode": "normalMode"
/*ro, req, enum, facial recognition mode, subType:string, desc:"normalMode" (normal mode), "deepMode" (deep mode)*/
}
}
21.30.20 Get the configuration capability of the M1 card encryption verification

Request URL
GET /ISAPI/AccessControl/M1CardEncryptCfg/capabilities
Query Parameter
None
Request Message
None
Response Message
<M1CardEncryptCfg xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


true
</enable>
<sectionID min="0" max="100">
1
</sectionID>
</M1CardEncryptCfg>
21.30.21 Get the configuration parameters of M1 card encryption verification

Request URL
GET /ISAPI/AccessControl/M1CardEncryptCfg
Query Parameter
None
Request Message
None
Response Message


<enable>
true
</enable>
<sectionID>
1
</sectionID>
</M1CardEncryptCfg>
21.30.22 Set the parameters of M1 card encryption verification

Request URL
PUT /ISAPI/AccessControl/M1CardEncryptCfg
Query Parameter
None
Request Message


<enable>
</enable>
<sectionID>
1
</sectionID>
</M1CardEncryptCfg>
Response Message


<requestURL>
test
</requestURL>
<statusCode>
OK
</statusString>
<subStatusCode>
test
</subStatusCode>
</ResponseStatus>
21.30.23 Get the parameters of enabling RF (Radio Frequency) card recognition

Request URL
GET /ISAPI/AccessControl/Configuration/RFCardCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
"RFCardCfg": [
{
"cardType": "EMCard",
/*ro, req, enum, card type, subType:string, desc:"EMCard” (EM card), "M1Card” (M1 card), "CPUCard” (CPU card), "IDCard” (ID card), "DesfireCard”
(DESFire card), "FelicaCard” (FeliCa card)*/
"enabled": true
/*ro, req, bool, whether to enable RF card recognition, desc:true-yes, false-no*/
}
]
}
21.30.24 Set the parameters of enabling RF (Radio Frequency) card recognition

Request URL
PUT /ISAPI/AccessControl/Configuration/RFCardCfg?format=json
Query Parameter
None
Request Message
{
"RFCardCfg": [
/*req, array, the parameters of enabling RF (Radio Frequency) card recognition, subType:object*/
{
"cardType": "EMCard",
/*req, enum, card type, subType:string, desc:"EMCard"(EM card), "M1Card"(M1 card), "CPUCard"(CPU card), "IDCard"(ID card), "DesfireCard"(DESFire
card), "FelicaCard"(FeliCa card)*/
"enabled": true
/*req, bool, whether to enable RF card recognition, desc:"true"(yes), "false"(no)*/
}
]
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.30.25 Get the configuration capability of enabling RF (Radio Frequency) card recognition
Request URL
GET /ISAPI/AccessControl/Configuration/RFCardCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"RFCardCfgCap": {
/*ro, req, object*/
"cardType": {
/*ro, opt, object, card type, desc:"EMCard"-EM card, "M1Card"-M1 card, "CPUCard"-CPU card, "IDCard"-ID card, "DesfireCard"-DESFire card,
"FelicaCard"-FeliCa card*/
"@opt": ["EMCard", "M1Card", "CPUCard", "IDCard", "FelicaCard"]
},
"enabled": {
/*ro, opt, object, whether to enable RF card recognition*/
}
}
}
21.30.26 Set the parameters of card No. authentication mode

Request URL
PUT /ISAPI/AccessControl/CardVerificationRule?format=json
Query Parameter
None
Request Message
{
"CardVerificationRule": {
/*req, object*/
"cardNoLenMode": "full",
/*req, enum, length mode of card No. authentication (comparison), subType:string, desc:"full", "3Bytes", "4Bytes". After the card No. authentication
(comparison) mode is switched, the device should check the card No. compatibility*/
"reverseCardNoEnabled": true
/*opt, bool*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.30.27 Get the parameters of card No. authentication mode

Request URL
GET /ISAPI/AccessControl/CardVerificationRule?format=json
Query Parameter
None
Request Message
None
Response Message
{
"CardVerificationRule": {
/*ro, req, object*/
"cardNoLenMode": "full",
/*ro, req, enum, length mode of card No. authentication (comparison), subType:string, desc:"full", "3Bytes", "4Bytes". After the card No.
authentication (comparison) mode is switched, the device should check the card No. compatibility*/
"reverseCardNoEnabled": true
/*ro, opt, bool*/
}
}
21.30.28 Get the switching progress and configuration result of card No. authentication
mode
Request URL
GET /ISAPI/AccessControl/CardVerificationRule/progress?format=json
Query Parameter
None
Request Message
None
Response Message
{
"CardVerificationRuleRes": {
/*ro, req, object*/
"checkStatus": "continue",
/*ro, opt, enum, status of switching card No. authentication (comparison) mode, subType:string, desc:"continue" (switching result can be searched
for later), "ok" (switching succeeded), "duplicate" (duplicate data exist and switching failed)*/
"progress": 100
/*ro, opt, int, switching progress in percentage, range:[0,100], desc:100 indicates that card No. authentication (comparison) mode is switched*/
}
}
21.31 Voice Prompt of Access Authentication

21.31.1 audio prompt control parameters
Request URL
PUT /ISAPI/AccessControl/Verification/ttsText?format=json
Query Parameter
None
Request Message
{
"TTSText": {
/*req, object*/
"enable": true,
/*req, bool, whether to enable, desc:true-enable, false-disable*/
"prefix": "name",
/*opt, enum, whether to play the audio with "user name" or "honorific and last name of the user" as the prefix, subType:string, desc:"name"-play the
audio with "user name" (e.g.,"Jack Smith" will be played), "lastname"-play the audio with "honorific and last name of the user" (e.g.,"Mr. Smith" will be
played), "none" (default)*/
"temperatureBroadcastEnabled": false,
/*opt, bool*/
"Success": [
/*opt, array, Succeeded., subType:object, range:[1,8]*/
{
"TimeSegment": {
/*opt, object, time period, desc:time period*/
"beginTime": "00:00:00",
/*req, string, start time, range:[1,32], desc:start time*/
"endTime": "00:00:00"
/*req, string, end time, range:[1,32], desc:end time*/
},
"language": "SimChinese",
/*opt, enum, language, subType:string, desc:“SimChinese”, “TraChinese”, “English”*/
"text": "test",
/*req, string, text of the audio prompt, range:[1,32], dep:and,{$.TTSText.Success[*].audioSourceType,eq,TTS}, desc:text of the audio
prompt*/
"customFileID": 1
/*opt, int, dep:or,{$.TTSText.Success[*].audioSourceType,eq,customFile}*/
}
],
"Failure": [
/*opt, array, subType:object*/
{
"TimeSegment": {
/*opt, object, time period, desc:time period*/
"beginTime": "00:00:00",
/*req, string, start time, range:[1,32], desc:start time*/
"endTime": "00:00:00"
/*req, string, end time, range:[1,32], desc:end time*/
},
/*opt, enum, language, subType:string, desc:language*/
"text": "test",
/*req, string, text of the audio prompt, range:[1,32], dep:and,{$.TTSText.Success[*].audioSourceType,eq,TTS}, desc:text of the audio
prompt*/
"customFileID": 1
/*opt, int, dep:or,{$.TTSText.Success[*].audioSourceType,eq,customFile}*/
}
]
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
/*ro, opt, int, error code, desc:error code*/
"errorMsg": "ok"
/*ro, opt, string, error information, desc:error information*/
}
21.31.2 Get text parameters of the audio prompt

Request URL
GET /ISAPI/AccessControl/Verification/ttsText?format=json
Query Parameter
None
Request Message
None
Response Message
{
"TTSText": {
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable, desc:true-enable, false-disable*/
"prefix": "name",
/*ro, opt, enum, whether to play the audio with "user name" or "honorific and last name of the user" as the prefix, subType:string, desc:"name"-play
the audio with "user name" (e.g.,"Jack Smith" will be played), "lastname"-play the audio with "honorific and last name of the user" (e.g.,"Mr. Smith" will
be played), "none" (default)*/
"temperatureBroadcastEnabled": false,
/*ro, opt, bool*/
"Success": [
/*ro, opt, array, succeeded, subType:object, range:[1,8]*/
{
"TimeSegment": {
/*ro, opt, object, time period, desc:time period*/
"beginTime": "00:00:00",
/*ro, req, string, start time, range:[1,32], desc:between 00:00:00 and 23:59:59*/
"endTime": "00:00:00"
/*ro, req, string, end time, range:[1,32], desc:between 00:00:00 and 23:59:59*/
},
/*ro, opt, enum, language, subType:string, desc:SimChinese (default), TraChinese, English*/
"text": "test",
/*ro, req, string, text of the audio prompt, range:[1,32], dep:and,{$.TTSText.Success[*].audioSourceType,eq,TTS}, desc:text of the audio
prompt*/
"customFileID": 1
/*ro, opt, int, dep:or,{$.TTSText.Success[*].audioSourceType,eq,customFile}*/
}
],
"Failure": [
/*ro, opt, array, failed, subType:object*/
{
"TimeSegment": {
/*ro, opt, object, time period, desc:time period*/
"beginTime": "00:00:00",
/*ro, req, string, start time, range:[1,32], desc:between 00:00:00 and 23:59:59*/
"endTime": "00:00:00"
/*ro, req, string, end time, range:[1,32], desc:between 00:00:00 and 23:59:59*/
},
/*ro, opt, enum, language, subType:string, desc:SimChinese, TraChinese, English;*/
"text": "test",
/*ro, req, string, text of the audio prompt, range:[1,32], dep:and,{$.TTSText.Success[*].audioSourceType,eq,TTS}, desc:text of the audio
prompt*/
"customFileID": 1
/*ro, opt, int, dep:or,{$.TTSText.Success[*].audioSourceType,eq,customFile}*/
}
]
}
}
21.31.3 Get the text configuration capability of the audio prompt for the authentication
results
Request URL
GET /ISAPI/AccessControl/Verification/ttsText/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"TTSTextCap": {
/*ro, req, object*/
"enable": [true, false],
/*ro, req, array, whether to enable: true-enable,false-disable, subType:bool, desc:true (enable), false (disable)*/
"prefix": ["name", "lastname", "none"],
/*ro, opt, array, prefix, subType:string, desc:"name"-play the audio with "user name" (e.g.,"Jack Smith" will be played), "lastname"-play the audio
with "honorific and last name of the user" (e.g.,"Mr. Smith" will be played), "none" (default)*/
"temperatureBroadcastEnabled": {
/*ro, opt, object*/
/*ro, opt, array, optional item, subType:bool*/
/*ro, opt, array, optional item, subType:bool*/
},
"Success": {
/*ro, opt, object, succeeded*/
"maxSize": 4,
"TimeSegment": {
/*ro, opt, object, time range*/
"beginTime": "00:00:00",
/*ro, opt, time, start time, desc:start time*/
"endTime": "00:00:00",
/*ro, opt, string, end time, desc:end time*/
/*ro, opt, enum, time accuracy, subType:string, desc:time accuracy*/
},
"language": {
/*ro, opt, object, language*/
"@opt": ["SimChinese", "TraChinese", "English"]
/*ro, opt, array, optional item, subType:string*/
},
/*ro, opt, object*/
"@opt": ["TTS", "customFile"]
/*ro, opt, array, range, subType:string*/
},
"text": {
/*ro, req, object, text of the audio prompt*/
"@min": 1,
/*ro, opt, int, range, range:[1,128]*/
"@max": 128
},
"customFileID": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int, range*/
"@max": 128
}
},
"Failure": {
/*ro, opt, object*/
"maxSize": 4,
"TimeSegment": {
/*ro, opt, object, time range*/
"beginTime": "00:00:00",
/*ro, opt, time, start time, desc:start time*/
"endTime": "00:00:00",
/*ro, opt, string, end time, desc:end time*/
/*ro, opt, enum, time accuracy, subType:string, desc:time accuracy*/
},
"language": {
/*ro, opt, object, language*/
"@opt": ["SimChinese", "TraChinese", "English"]
/*ro, opt, array, optional item, subType:string*/
},
/*ro, opt, object*/
"@opt": ["TTS", "customFile"]
/*ro, opt, array, range, subType:string*/
},
"text": {
/*ro, req, object, text of the audio prompt*/
"@min": 1,
"@max": 128
},
"customFileID": {
/*ro, opt, object*/
"@min": 1,
"@max": 128
}
}
}
}
21.32 Temperature Measurement

21.32.1 Get the capability of actively searching for face temperature screening events
Request URL
GET /ISAPI/AccessControl/FaceTemperatureEvent/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"FaceTemperatureEventCap": {
/*ro, req, object, capability of actively getting face temperature screening events*/
"FaceTemperatureEventCond": {
/*ro, opt, object, conditions of actively getting face temperature screening events*/
"searchID": {
/*ro, req, object, search ID, desc:which is used to check whether the current search requester is the same with the previous one. If it is the
same one, the search record will be stored in the device to speed up the next search*/
"@min": 1,
"@max": 1
},
"searchResultPosition": {
/*ro, req, object, the start position of search result in the result list, desc:in a single search, if you cannot get all the records in the
result list, you can mark the end position and get the following records after the marked position in the next search. If the maximum number of totalMatches
"@min": 1,
"@max": 1
},
"maxResults": {
/*ro, req, object, the maximum number of search results this time by calling this URL, desc:if maxResults value exceeds the range returned by
the device capability, the device will return the maximum number of search results according to the device capability and will not return error message*/
"@min": 1,
"@max": 1
},
"startTime": "1970-01-01T00:00:00+08:00",
/*ro, opt, datetime, start time (UTC time)*/
"endTime": "1970-01-01T00:00:00+08:00",
/*ro, opt, datetime, end time (UTC time)*/
"picEnable": {
/*ro, opt, object, whether to upload the picture along with the event information, desc:true (all matched events will be uploaded with pictures
if there is any), false (all matched events will be uploaded without pictures)*/
},
"beginSerialNo": {
"@min": 1,
"@max": 1
},
"endSerialNo": {
"@min": 1,
"@max": 1
},
/*ro, opt, array, options, subType:bool, desc:true (yes), false (no)*/
}
},
"InfoList": {
/*ro, opt, object, event information*/
"deviceName": {
/*ro, opt, object, device name*/
"@min": 1,
"@max": 1
},
"serialNo": {
/*ro, opt, object, event serial No.*/
"@min": 1,
"@max": 1
},
"thermometryUnit": {
/*ro, req, object, temperature unit, desc:"celsius" (Celsius-default value), "fahrenheit" (Fahrenheit), "kelvin" (Kelvin)*/
"@opt": ["celsius", "fahrenheit", "kelvin"]
},
/*ro, req, object, face temperature, desc:it should be accurate to one decimal place*/
"@min": 1.0,
/*ro, opt, float, the minimum value*/
"@max": 1.0
/*ro, opt, float, the maximum value*/
},
/*ro, opt, object, whether the face temperature is abnormal, desc:true (yes), false (no)*/
},
/*ro, opt, object, face temperature's coordinates*/
"positionX": {
/*ro, opt, object, x-coordinate, desc:the value is normalized to a number between 0 and 1000*/
"@min": 1,
"@max": 1
},
"positionY": {
/*ro, opt, object, Y-coordinate, desc:the value is normalized to a number between 0 and 1000*/
"@min": 1,
"@max": 1
}
},
"mask": {
/*ro, opt, object, whether the person wears a mask: "unknown" (unknown), "yes" (wearing a mask), "no" (no mask), desc:"unknown" (unknown), "yes"
(wearing a mask), "no" (no mask)*/
},
"capturePicUrl": {
/*ro, opt, object, URL of the captured picture*/
"@min": 1,
"@max": 1
},
"visibleLightPicUrl": {
/*ro, opt, object, URL of the visible light picture*/
"@min": 1,
"@max": 1
},
"thermalPicUrl": {
/*ro, opt, object, the URL of the thermal picture*/
"@min": 1,
"@max": 1
},
"helmet": {
/*ro, opt, object, whether the person wears a hard hat*/
},
"dateTime": "1970-01-01T00:00:00+08:00",
/*ro, req, datetime, the time (UTC time) when the alarm is triggered, desc:the maximum size is 32*/
"FaceRect": {
"height": {
/*ro, req, object, height*/
"@min": 0.000,
"@max": 1.000
},
"width": {
/*ro, req, object, width*/
"@min": 0.000,
"@max": 1.000
},
"x": {
/*ro, req, object, X-coordinate of the upper-left corner of the frame*/
"@min": 0.000,
"@max": 1.000
},
"y": {
/*ro, req, object, Y-coordinate of the upper-left corner of the frame*/
"@min": 0.000,
"@max": 1.000
}
}
}
}
}
}
21.32.2 Search for skin-surface temperature screening event

Request URL
POST /ISAPI/AccessControl/FaceTemperatureEvent?format=json
Query Parameter
None
Request Message
{
"FaceTemperatureEventCond": {
/*req, object, search conditions of skin-surface temperature screening events*/
"searchID": "test",
/*req, string, search ID, desc:which is used to check whether the current search requester is the same as the previous one. If they are the same,
/*req, int, the start position of the search result in the result list, desc:In a single search, if you cannot get all the records in the result
list, you can mark the end position and get the following records after the marked position in the next search. If the maximum number of totalMatches
"maxResults": 30,
/*req, int, the maximum number of search results this time by calling this URL, desc:if maxResults exceeds the range returned by the device
capability, the device will return the maximum number of search results according to the device capability and will not return error message*/
"startTime": "1970-01-01T00:00:00+08:00",
/*opt, datetime, start time (UTC time)*/
"endTime": "1970-01-01T00:00:00+08:00",
/*opt, datetime, end time (UTC time)*/
"picEnable": true,
/*opt, bool, whether to upload the picture along with the event information*/
"beginSerialNo": 1,
"endSerialNo": 1,
"isAbnomalTemperature": true
/*opt, bool, whether the skin-surface temperature is abnormal*/
}
}
Response Message
{
"FaceTemperatureEvent": {
/*ro, req, object, skin-surface temperature screening event*/
"searchID": "test",
/*ro, req, string, search ID, desc:it is used to check whether the current search requester is the same as the previous one. If they are the same,
/*ro, req, enum, searching status description, subType:string, desc:"OK" (searching completed), "MORE" (searching for more data), "NO MATCH" (no
matched data)*/
"numOfMatches": 1,
"totalMatches": 1,
"InfoList": [
/*ro, opt, array, event information list, subType:object*/
{
"serialNo": 1,
/*ro, req, enum, temperature unit, subType:string, desc:"celsius" (Celsius, default value), "fahrenheit" (Fahrenheit), "kelvin" (Kelvin)*/
/*ro, req, float, skin-surface temperature, desc:it should be accurate to one decimal place*/
/*ro, opt, bool, whether the skin-surface temperature is abnormal, desc:true (yes), false (no)*/
"positionX": 1,
"positionY": 1
/*ro, opt, int, Y-coordinate, range:[0,1000], desc:the value is normalized to a number between 0 and 1000*/
},
"mask": "unknown",
/*ro, opt, enum, whether the person wears a mask, subType:string, desc:"unknown" (unknown), "yes" (wearing a mask), "no" (no mask)*/
"capturePicUrl": "test",
/*ro, opt, string, URL of the captured picture*/
"visibleLightPicUrl": "test",
/*ro, opt, string, URL of the visible light picture*/
"thermalPicUrl": "test",
/*ro, opt, enum, whether the person is wearing hard hat, subType:string, desc:"unknown", "yes", "no"*/
"dateTime": "1970-01-01T00:00:00+08:00",
/*ro, req, datetime, alarm trigger time (UTC time), desc:the maximum size is 32 bytes*/
"FaceRect": {
"height": 1.000,
"width": 1.000,
"x": 0.000,
"y": 0.000
}
}
]
}
}
21.32.3 Set the temperature measurement parameters

Request URL
PUT /ISAPI/AccessControl/temperatureMeasureCfg?format=json
Query Parameter
None
Request Message
{
"showTemperatureInfo": true,
/*opt, bool, whether to display the temperature information, desc:true (yes), false (no)*/
"saveThermalPicture": true,
/*opt, bool, whether to save the thermal picture, desc:true (yes), false (no)*/
"uploadThermalPicture": true,
/*opt, bool, whether to upload the thermal picture, desc:true (yes), false (no)*/
"lowTemperatureEnabled": true,
/*opt, bool, whether to enable temperature measurement in the low-temperature environment, desc:true (enable), false (disable)*/
"distance": 0.3,
/*opt, float, unit:m*/
"temperatureMeasureMode": "auto"
/*opt, enum, temperature measurement mode, subType:string, desc:temperature measurement mode*/
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.32.4 Get the temperature measurement parameters

Request URL
GET /ISAPI/AccessControl/temperatureMeasureCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
"showTemperatureInfo": true,
/*ro, opt, bool, whether to display the temperature information, desc:true (yes), false (no)*/
"saveThermalPicture": true,
/*ro, opt, bool, whether to save the thermal picture, desc:true (yes), false (no)*/
"uploadThermalPicture": true,
/*ro, opt, bool, whether to upload the thermal picture, desc:true (yes), false (no)*/
"lowTemperatureEnabled": true,
/*ro, opt, bool, whether to enable temperature measurement in the low-temperature environment, desc:true (enable), false (disable)*/
"distance": 0.3,
/*ro, opt, float, face temperature screening distance, unit:m*/
"temperatureMeasureMode": "auto",
/*ro, opt, enum, temperature screening mode, subType:string, desc:"auto", "manual"*/
"thermometryModuleStatus": "online"
/*ro, opt, enum, subType:string, desc:"online", "offline"*/
}
21.32.5 Get the configuration capability of temperature measurement parameters

Request URL
GET /ISAPI/AccessControl/temperatureMeasureCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"showTemperatureInfo": {
/*ro, opt, object, whether to display the temperature information, desc:true (yes), false (no)*/
},
"saveThermalPicture": {
/*ro, opt, object, whether to save the thermal picture, desc:true (yes), false (no)*/
},
"uploadThermalPicture": {
/*ro, opt, object, whether to upload the thermal picture, desc:true (yes), false (no)*/
},
"lowTemperatureEnabled": {
/*ro, opt, object, whether to enable temperature measurement in the low-temperature environment, desc:when this function is enabled, if the face
temperature is lower than 36 °C, the measured temperature will be mapped to that higher than 36 °C; temperatures higher than 36 °C will not be mapped*/
/*ro, req, array, subType:bool, desc:true (enable), false (disable)*/
},
"distance": {
/*ro, opt, object*/
"@min": 0.3,
/*ro, req, float*/
"@max": 2.0
/*ro, req, float*/
},
"temperatureMeasureMode": {
/*ro, opt, object*/
"@opt": ["auto", "manual"]
},
"thermometryModuleStatus": {
/*ro, opt, object*/
"@opt": ["online", "offline"]
}
}
21.32.6 Get the configuration capability of the black body

Request URL
GET /ISAPI/AccessControl/blackObject/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"enabled": {
/*ro, req, object, whether to enable the black body, desc:the black body is used to calibrate the temperature of the thermography module. You need to
put the black body with fixed temperature in front of the device and calibrate the temperature of the thermography module according to the black body in the
image*/
},
"Position": {
/*ro, opt, object, black body position (coordinate), desc:the value is normalized to a number between 0 and 1000*/
"x": {
"@min": 0,
"@max": 1000
},
"y": {
"@min": 0,
"@max": 1000
}
},
"distance": {
/*ro, opt, object, distance between the black body and the lens, desc:the value is accurate to one decimal place, unit: meter*/
"@min": 0.0,
"@max": 10.0
},
"emissivity": {
/*ro, opt, object, emissivity, desc:the value is accurate to two decimal places. The emissivity is applied from the system or platform to the device and
is transmitted to the thermography module by the device for temperature measurement*/
"@min": 0.00,
"@max": 1.00
},
"TemperatureList": [
/*ro, opt, array, temperature list of the black body, subType:object, desc:the second decimal place of the black body's temperature will be rounded to
eliminate the error. For example, 0.95 will be input as 1.0*/
{
"unit": "celsius",
"temperature": {
/*ro, opt, object, black body temperature, desc:When the unit is "celsius", the value of this node is between 30.0 and 50.0; when the unit is
"fahrenheit", the value of this node is between 86.0 and 122.0*/
"@min": 30.0,
"@max": 50.0
}
}
]
}
21.32.7 Set the black body parameters

Request URL
PUT /ISAPI/AccessControl/blackObject?format=json
Query Parameter
None
Request Message
{
"enabled": true,
/*req, bool, whether to enable the black body*/
"Position": {
/*opt, object, black body position (coordinate), desc:black body position (coordinate)*/
"x": 1,
/*opt, int, X-coordinate, range:[0,1000]*/
"y": 1
/*opt, int, Y-coordinate, range:[0,1000]*/
},
"distance": 1.0,
/*opt, float, distance between the black body and the lens, range:[0.0,10.0], desc:unit: meter; the value is accurate to one decimal place*/
"emissivity": 0.10,
/*opt, float, emissivity, range:[0.00,1.00], desc:the value is accurate to two decimal places*/
"unit": "celsius",
/*opt, enum, unit, subType:string, desc:"celsius", "fahrenheit"*/
"temperature": 30.0
/*opt, float, black body temperature, range:[30.0,50.0],
desc:the value is accurate to one decimal place
when the value of the node unit is "celsius", the value of this node is between 30.0 and 50.0; when the value of the node unit is "fahrenheit", the
value of this node is between 86.0 and 122.0*/
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.32.8 Get the black body parameters

Request URL
GET /ISAPI/AccessControl/blackObject?format=json
Query Parameter
None
Request Message
None
Response Message
{
"enabled": true,
/*ro, req, bool, whether to enable the black body*/
"Position": {
/*ro, opt, object, black body position (coordinate), desc:the value is normalized to a number between 0 and 1000. The origin is the upper-left corner of
the screen*/
"x": 1,
/*ro, opt, int, X-coordinate, range:[0,1000]*/
"y": 1
/*ro, opt, int, Y-coordinate, range:[0,1000]*/
},
"distance": 1.0,
/*ro, opt, float, distance between the black body and the lens, range:[0.0,10.0], desc:the value is accurate to one decimal place, unit: meter*/
"emissivity": 0.10,
/*ro, opt, float, emissivity, range:[0.00,1.00], desc:the value is accurate to two decimal places*/
"unit": "celsius",
"temperature": 30.0
/*ro, opt, float, black body temperature, range:[30.0,50.0],
desc:the value is accurate to one decimal place
when the value of the node unit is "celsius", the value of this node is between 30.0 and 50.0; when the value of the node unit is "fahrenheit", the
value of this node is between 86.0 and 122.0*/
}
21.32.9 Get the calibration capability of the temperature measurement area

Request URL
GET /ISAPI/AccessControl/temperatureMeasureAreaCalibration/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"enabled": {
/*ro, req, object, whether to enable the calibration function, desc:true (enable), false (disable)*/
},
"FaceFrameCoordinate": {
/*ro, opt, object, coordinates of the face picture frame, desc:the origin is the upper-left corner of the screen*/
"height": {
/*ro, opt, object, height*/
"@min": 0,
"@max": 1000
},
"width": {
/*ro, opt, object, width*/
"@min": 0,
"@max": 1000
},
"x": {
"@min": 0,
"@max": 1000
},
"y": {
"@min": 0,
"@max": 1000
}
}
}
21.32.10 Set the calibration parameters of the temperature measurement area

Request URL
PUT /ISAPI/AccessControl/temperatureMeasureAreaCalibration?format=json
Query Parameter
None
Request Message
{
"enabled": true,
/*req, bool, whether to enable calibration, desc:true (enable), false (disable)*/
/*opt, object, coordinate of the face frame, desc:the value is normalized to a number between 0 and 1000*/
"height": 1,
/*opt, int, height, range:[0,1000]*/
"width": 2,
/*opt, int, width, range:[0,1000]*/
"x": 5,
/*opt, int, x-coordinate, range:[0,1000]*/
"y": 10
/*opt, int, y-coordinate, range:[0,1000]*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.32.11 Get the calibration parameters of the temperature measurement area

Request URL
GET /ISAPI/AccessControl/temperatureMeasureAreaCalibration?format=json
Query Parameter
None
Request Message
None
Response Message
{
"enabled": true,
/*ro, req, bool, whether to enable calibration, desc:true (enable), false (disable)*/
/*ro, opt, object, coordinate of the face frame, desc:object,coordinate of the face frame,the value is normalized to a number between 0 and 1000*/
"height": 1,
/*ro, opt, int, height, range:[0,1000]*/
"width": 2,
/*ro, opt, int, width, range:[0,1000]*/
"x": 5,
"y": 10
}
}
21.32.12 Get the configuration capability of temperature measurement parameters

Request URL
GET /ISAPI/AccessControl/temperatureMeasureAreaCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"uniqueItems": {
/*ro, req, object, range of the number of vertexes of the polygon*/
"@min": 3,
"@max": 10
/*ro, opt, int*/
},
"RegionCoordinate": {
/*ro, opt, object, coordinate of the vertexes of the polygon, desc:the origin is the upper-left corner of the screen*/
"x": {
"@min": 0,
"@max": 1000
},
"y": {
"@min": 0,
"@max": 1000
}
}
}
21.32.13 Set the parameters of the temperature measurement area

Request URL
PUT /ISAPI/AccessControl/temperatureMeasureAreaCfg?format=json
Query Parameter
None
Request Message
{
"RegionCoordinate": [
/*req, array, coordinates of vertexes of the polygon, subType:object, range:[0,4], desc:coordinates of vertexes of the polygon*/
{
"x": 1,
/*opt, int, x-coordinate, range:[0,1000]*/
"y": 2
/*opt, int, y-coordinate, range:[0,1000]*/
}
]
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.32.14 Get the parameters of the temperature measurement area

Request URL
GET /ISAPI/AccessControl/temperatureMeasureAreaCfg?format=json
Query Parameter
None
Request Message
None
Response Message
{
"RegionCoordinate": [
/*ro, req, array, area point coordinates, subType:object, range:[0,4], desc:rectangle, the origin is the upper-left corner of the screen*/
{
"x": 1,
"y": 2
}
]
}
21.32.15 Skin-surface temperature screening event

EventType:FaceTemperatureMeasurementEvent
{
"ipAddress": "172.6.64.7",
"ipv6Address": "1080:0:0:0:8:800:200C:417A",
"portNo": 80,
"protocol": "HTTP",
/*ro, opt, string, protocol type, desc:"HTTP", "HTTPS"*/
"macAddress": "01:17:24:45:D9:F4",
"channelID": 1,
/*ro, opt, int, channel No. of the device that triggers the alarm*/
"dateTime": "2016-12-12T17:30:08+08:00",
/*ro, req, string, alarm trigger time*/
/*ro, req, int, times that the same alarm has been uploaded*/
"eventType": "FaceTemperatureMeasurementEvent",
/*ro, req, string, triggered event type, desc:"FaceTemperatureMeasurementEvent" (skin-surface temperature screening event)*/
/*ro, req, enum, event status, subType:string, desc:"active" (triggered), "inactive" (not triggered)*/
"eventDescription": "Face Temperature Measurement Event",
/*ro, req, string, event description, desc:skin-surface temperature screening event*/
/*ro, opt, string, device ID (PUID), desc:this node must be returned when ISAPI event information is transmitted via ISUP*/
"FaceTemperatureMeasurementEvent": {
/*ro, req, object, "FaceTemperatureMeasurementEvent" (skin-surface temperature screening event)*/
"deviceName": "test设备",
"serialNo": 1,
/*ro, opt, bool, whether it is a real-time event, desc:true (yes), false (no)*/
/*ro, req, enum, temperature unit, subType:string, desc:"celsius" (Celsius (default)), "fahrenheit" (Fahrenheit), "kelvin" (Kelvin)*/
/*ro, req, float, skin-surface temperature, desc:it should be accurate to one decimal place*/
/*ro, opt, bool, whether the skin-surface temperature is abnormal, desc:true (yes), false (no)*/
"positionX": 1,
"positionY": 1
/*ro, opt, int, Y-coordinate, desc:the value is normalized to a number between 0 and 1000*/
},
"remoteCheck": false,
/*ro, opt, bool, whether remote verification is required, desc:true (yes), false (no, default)*/
"mask": "unknown",
"visibleLightURL": "xxxxxxx",
/*ro, opt, string, visible light picture URL of the thermal imaging camera*/
"thermalURL": "xxxxxxx",
/*ro, opt, string, URL of the captured picture*/
"visibleLightContentID": "visibleLight_image",
/*ro, opt, string*/
"thermalContentID": "thermal_image",
/*ro, opt, string*/
"pictureContentID": "picture_image",
/*ro, opt, string*/
"FaceRect": {
"height": 1.000,
"width": 1.000,
"x": 0.000,
"y": 0.000
}
}
}
Parameter
Parameter
Parameter Name Type(Content- Content-ID File Name Description
Value
Type)
FaceTemperatureMeasurementEvent [报文内容] application/json -- -- --
[图片二进
制数据]
[图片二进
制数据]
[图片二进
Picture image/jpeg picture_image Picture.jpg --
制数据]
the instance below.
--<frontier>
Parameter Value
name.
21.33 Permission Schedules for Persons and Access Points
21.33.1 Get the holiday group configuration capability of the access permission control
Request URL
GET /ISAPI/AccessControl/UserRightHolidayGroupCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"UserRightHolidayGroupCfg": {
/*ro, req, object*/
"groupNo": {
"@min": 1,
"@max": 16
},
/*ro, opt, string, whether it is enabled, desc:"true" (enabled), "false" (disabled)*/
"groupName": {
/*ro, opt, object, holiday group name*/
"@min": 1,
"@max": 32
},
"holidayPlanNo": {
/*ro, opt, object, holiday group schedule No.*/
"@min": 1,
"@max": 16
}
}
}
21.33.2 Get the schedule template configuration capability of the access permission control
Request URL
GET /ISAPI/AccessControl/UserRightPlanTemplate/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"UserRightPlanTemplate": {
/*ro, opt, object*/
"templateNo": {
"@min": 1,
"@max": 16
},
"templateName": {
/*ro, opt, object, template name*/
"@min": 1,
"@max": 32
},
"weekPlanNo": {
"@min": 1,
"@max": 16
},
"holidayGroupNo": {
"@min": 1,
"@max": 16
}
}
}
21.33.3 Get weekly schedule configuration parameters

Request URL
GET /ISAPI/AccessControl/UserRightWeekPlanCfg/<weekPlanID>?format=json
Query Parameter
Request Message
None
Response Message
{
"UserRightWeekPlanCfg": {
/*ro, opt, object, weekly schedule configuration parameters*/
"enable": true,
"WeekPlanCfg": [
/*ro, req, array, weekly schedule parameters, subType:object*/
{
"week": "Monday",
/*ro, req, enum, day of the week, subType:string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"*/
"id": 1,
/*ro, req, int, time period No., range:[1,8], desc:it is between 1 and 8*/
"enable": true,
"TimeSegment": {
/*ro, req, object, time period*/
"beginTime": "10:10:00",
/*ro, req, string, start time of the time period, desc:device local time*/
"endTime": "12:10:00"
/*ro, req, string, end time of the time period, desc:device local time*/
},
"authenticationTimesEnabled": true,
/*ro, opt, bool*/
"authenticationTimes": 10
}
]
}
}
21.33.4 Get the weekly schedule configuration capability of the access permission control
Request URL
GET /ISAPI/AccessControl/UserRightWeekPlanCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object*/
"planNo": {
"@min": 1,
"@max": 16
},
"WeekPlanCfg": {
/*ro, opt, object, weekly schedule parameters*/
"maxSize": 56,
"week": {
/*ro, opt, object, week*/
"@opt": "Monday"
/*ro, opt, enum, days of the week, subType:string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"*/
},
"id": {
/*ro, opt, object*/
"@min": 1,
"@max": 8
},
"TimeSegment": {
/*ro, opt, object, time period*/
/*ro, opt, string, start time, desc:(device local time)*/
"endTime": "test",
/*ro, opt, string, end time, desc:(device local time)*/
"minute"*/
},
"authenticationTimesEnabled": {
/*ro, opt, object*/
},
"authenticationTimes": {
/*ro, opt, object*/
"@min": 1,
"@max": 255
}
}
}
}
21.33.5 Get the holiday schedule configuration capability of the access permission control
Request URL
GET /ISAPI/AccessControl/UserRightHolidayPlanCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"UserRightHolidayPlanCfg": {
/*ro, req, object*/
"planNo": {
/*ro, opt, object, holiday schedule No.*/
"@min": 1,
"@max": 16
},
"beginDate": "1970-01-01",
/*ro, opt, date, start date of the holiday, desc:(device local time)*/
"endDate": "1970-01-01",
/*ro, opt, date, end date of the holiday, desc:(device local time)*/
"HolidayPlanCfg": {
/*ro, opt, object, holiday schedule parameter*/
"maxSize": 8,
"id": {
"@min": 1,
"@max": 8
},
"TimeSegment": {
/*ro, opt, object, time period*/
"beginTime": "00:00:00",
/*ro, opt, time, start time, desc:(device local time)*/
"endTime": "00:00:00",
/*ro, opt, time, end time, desc:(device local time)*/
"minute"*/
},
"authenticationTimesEnabled": {
/*ro, opt, object*/
},
"authenticationTimes": {
/*ro, opt, object*/
"@min": 1,
"@max": 255
}
}
}
}
21.33.6 Get holiday schedule configuration parameters

Request URL
GET /ISAPI/AccessControl/UserRightHolidayPlanCfg/<holidayPlanID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, req, object, holiday schedule configuration parameters*/
"enable": true,
"beginDate": "1970-01-01",
/*ro, req, date, start date of the holiday, desc:device local time*/
"endDate": "1970-01-01",
/*ro, req, date, end date of the holiday, desc:device local time*/
"HolidayPlanCfg": [
{
"id": 1,
/*ro, req, int, time period No., range:[1,8], desc:it is between 1 and 8*/
"enable": true,
"TimeSegment": {
/*ro, req, object, time period*/
"beginTime": "00:00:00",
"endTime": "00:00:00"
},
/*ro, opt, bool*/
}
]
}
}
21.33.7 Set the week schedule parameters of the access permission control
Request URL
PUT /ISAPI/AccessControl/UserRightWeekPlanCfg/<weekPlanID>?format=json
Query Parameter
Request Message
{
/*opt, object, the week schedule parameters of the access permission control*/
"enable": true,
/*req, bool, whether to enable, desc:"true" (enable), "false" (disable)*/
"WeekPlanCfg": [
{
"week": "Monday",
"id": 1,
/*req, int, time period No., range:[1,8], desc:it is between 1 and 8*/
"enable": true,
"TimeSegment": {
/*req, object, time period*/
"beginTime": "10:10:00",
/*req, string, start time of the time period, desc:(device local time)*/
"endTime": "12:10:00"
/*req, string, end time of the time period, desc:(device local time)*/
},
/*opt, bool*/
/*opt, int, range:[1,255], step:1*/
}
]
}
}
Response Message
{
/*ro, opt, string, status code, desc:1 (succeeded). It is required when an error occurred*/
"errorCode": 1,
"errorMsg": "ok"
}
21.33.8 Set the holiday schedule parameters of the access permission control
Request URL
PUT /ISAPI/AccessControl/UserRightHolidayPlanCfg/<holidayPlanID>?format=json
Query Parameter
Request Message
{
/*req, object, the holiday schedule parameters of the access permission control*/
"enable": true,
"beginDate": "1970-01-01",
/*req, date, start date of the holiday, desc:device local time*/
"endDate": "1970-01-01",
/*req, date, end date of the holiday, desc:device local time*/
"HolidayPlanCfg": [
/*req, array, subType:object*/
{
"id": 1,
/*req, int, time period No., range:[1,8], desc:it is between 1 and 8*/
"enable": true,
"TimeSegment": {
/*opt, object, time period*/
"beginTime": "00:00:00",
/*req, time, start time of the time period, desc:device local time*/
"endTime": "00:00:00"
/*req, time, end time of the time period, desc:device local time*/
},
/*opt, bool*/
/*opt, int, range:[1,255], step:1*/
}
]
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
}
21.33.9 Get the schedule template configuration parameters of the access permission control
Request URL
GET /ISAPI/AccessControl/UserRightPlanTemplate/<planTemplateID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable, desc:true (yes), false (no)*/
"weekPlanNo": 1,
/*ro, req, int, week schedule No.*/
}
}
21.33.10 Get the holiday group configuration parameters of the access permission control
schedule
Request URL
GET /ISAPI/AccessControl/UserRightHolidayGroupCfg/<holidayGroupID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, req, object*/
"enable": true,
/*ro, req, bool, whether to enable, desc:true (yes), false (no)*/
/*ro, req, string, holiday group schedule No., desc:holiday group schedule No.*/
}
}
21.33.11 Set the holiday group parameters of the access permission control schedule
Request URL
PUT /ISAPI/AccessControl/UserRightHolidayGroupCfg/<holidayGroupID>?format=json
Query Parameter
Request Message
{
/*req, object, the holiday group parameters of the access permission control schedule*/
"enable": true,
"holidayPlanNo": "1,3,5",
/*req, string, holiday group schedule No., desc:holiday group schedule No.*/
/*opt, enum, operation type, subType:string, desc:"byTerminal" (by terminal), "byOrg" (by organization), "byTerminalOrg" (by terminal
organization)*/
/*opt, array, terminal ID list, subType:int, desc:this node is required when operation type is "byTerminal" or "byTerminalOrg"*/
"orgNoList": [1, 2, 3, 4]
/*opt, array, organization ID list, subType:int, desc:this node is required when operation type is "byOrg" or "byTerminalOrg"*/
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
}
21.33.12 Set the schedule template parameters of the access permission control
Request URL
PUT /ISAPI/AccessControl/UserRightPlanTemplate/<planTemplateID>?format=json
Query Parameter
Request Message
{
/*req, object, the schedule template of the access permission control*/
"enable": true,
/*req, string, template name*/
"weekPlanNo": 1,
/*req, int, week schedule No.*/
"holidayGroupNo": "1,3,5",
/*req, string, holiday group No., desc:holiday group No.*/
/*opt, enum, operation type, subType:string, desc:"byTerminal" (by terminal), "byOrg" (by organization), "byTerminalOrg" (by terminal
organization)*/
/*opt, array, terminal ID list, subType:int, desc:this node is required when operation type is "byTerminal" or "byTerminalOrg"*/
"orgNoList": [1, 2, 3, 4]
/*opt, array, organization ID list, subType:int, desc:this node is required when operation type is "byOrg" or "byTerminalOrg"*/
}
}
Response Message
{
"errorCode": 1,
"errorMsg": "ok"
}
21.34 Authentication Schedule Management

21.34.1 Get the holiday group configuration capability of the control schedule of the card
reader authentication mode
Request URL
GET /ISAPI/AccessControl/VerifyHolidayGroupCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"VerifyHolidayGroupCfg": {
/*ro, opt, object*/
"groupNo": {
"@min": 1,
"@max": 16
},
/*ro, opt, string, whether to enable, desc:whether to enable: "true"-enable,"false"-disable*/
"groupName": {
/*ro, opt, object, length of holiday group name*/
"@min": 1,
/*ro, opt, int, the minimum length*/
"@max": 32
/*ro, opt, int, the maximum length*/
},
"holidayPlanNo": {
/*ro, opt, object, holiday group schedule No.*/
"@min": 1,
"@max": 16
}
}
}
21.34.2 Get the schedule template configuration capability of the card reader authentication
mode
Request URL
GET /ISAPI/AccessControl/VerifyPlanTemplate/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"VerifyPlanTemplate": {
/*ro, opt, object*/
"templateNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
},
/*ro, opt, string, whether to enable, desc:true (yes), false (no)*/
"templateName": {
/*ro, opt, object, template name length*/
"@min": 1,
/*ro, opt, int*/
"@max": 32
/*ro, opt, int*/
},
"weekPlanNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
},
"holidayGroupNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
}
}
}
21.34.3 Get the control schedule configuration parameters of the card reader authentication
mode
Request URL
GET /ISAPI/AccessControl/CardReaderPlan/<cardReaderID>?format=json
Query Parameter
Request Message
None
Response Message
{
"CardReaderPlan": {
/*ro, req, object, schedule template structure*/
"templateNo": 1
/*ro, req, int, schedule template number, desc:0-cancel linking the template to the schedule and restore to the default status (normal status)*/
}
}
21.34.4 Set control schedule parameters of card reader authentication mode

Request URL
PUT /ISAPI/AccessControl/CardReaderPlan/<cardReaderID>?format=json
Query Parameter
Request Message
{
"CardReaderPlan": {
/*req, object*/
"templateNo": 1
/*req, int, schedule template No., desc:0-cancel linking the template to the schedule and restore to the default status (normal status)*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.34.5 Get the control schedule configuration capability of the card reader authentication
mode
Request URL
GET /ISAPI/AccessControl/CardReaderPlan/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"CardReaderPlan": {
/*ro, opt, object, card reader No. node*/
"cardReaderNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 4
/*ro, opt, int*/
},
"templateNo": {
/*ro, opt, object, schedule template No. node*/
"@min": 1,
/*ro, opt, int*/
"@max": 16,
/*ro, opt, int*/
"@opt": [65535, 65534, 65533]
},
"verifyMode": {
/*ro, opt, object, authentication mode, dep:and,{$.CardReaderPlan.templateNo.@opt[*],eq,65535}*/
"@opt":
OrPw,faceOrPw,employeeNoAndFaceAndPw,cardOrFaceOrFaceAndCard,iris,faceOrFpOrCardOrPwOrIris,faceOrCardOrPwOrIris,sleep,invalid"
/*ro, opt, string, desc:"cardAndPw” (card + password), "card” (card), "cardOrPw” (card or password), "fp” (fingerprint), "fpAndPw” (fingerprint
+ password), "fpOrCard” (fingerprint or card), "fpAndCard” (fingerprint + card), "fpAndCardAndPw” (fingerprint + card + password), "faceOrFpOrCardOrPw”
(face or fingerprint or card or password), "faceAndFp” (face + fingerprint), "faceAndPw” (face + password), "faceAndCard” (face + card), "face” (face),
"employeeNoAndPw” (employee No. + password), "fpOrPw” (fingerprint or password), "employeeNoAndFp” (employee No. + fingerprint), "employeeNoAndFpAndPw”
(employee No. + fingerprint + password), "faceAndFpAndCard” (face + fingerprint + card), "faceAndPwAndFp” (face + password + fingerprint),
"employeeNoAndFace” (employee No. + face), "faceOrfaceAndCard” (face or face + card), "fpOrface” (fingerprint or face), "cardOrfaceOrPw” (card or face or
password), "cardOrFace” (card or face), "cardOrFaceOrFp” (card or face or fingerprint), "cardOrFpOrPw” (card or fingerprint or password), "faceOrPw" (face
or password), "employeeNoAndFaceAndPw" (employee No. + face + card), "cardOrFaceOrFaceAndCard" (card or face or face + card), "iris",
"faceOrFpOrCardOrPwOrIris"(face or fingerprint or card or password or iris), "faceOrCardOrPwOrIris" (face or card or password or iris), "sleep",
"invalid"*/
}
}
}
21.34.6 Get holiday schedule parameters of the card reader authentication mode
Request URL
GET /ISAPI/AccessControl/VerifyHolidayPlanCfg/<holidayPlanID>?format=json
Query Parameter
Request Message
None
Response Message
{
"VerifyHolidayPlanCfg": {
/*ro, opt, object, holiday schedule parameters of the card reader authentication mode*/
"enable": true,
"beginDate": "1970-01-01",
/*ro, req, date, start date of the holiday, desc:device local time*/
"endDate": "1970-01-02",
/*ro, req, date, end date of the holiday, desc:device local time*/
"HolidayPlanCfg": [
{
"id": 1,
"enable": true,
/*ro, req, bool, whether to enable the holiday schedule, desc:true (enable), false (disable)*/
"verifyMode": "cardAndPw",
/*ro, req, enum, authentication mode, subType:string, desc:"cardAndPw"-card+password,"card","cardOrPw"-card or password,"fp"-
fingerprint,"fpAndPw"-fingerprint+password,"fpOrCard"-fingerprint or card,"fpAndCard"-fingerprint+card,"fpAndCardAndPw"-
fingerprint+card+password,"faceOrFpOrCardOrPw"-face or fingerprint or card or password,"faceAndFp"-face+fingerprint,"faceAndPw"-face+password,"faceAndCard"-
face+card,"face","employeeNoAndPw"-employee No.+password,"fpOrPw"-fingerprint or password,"employeeNoAndFp"-employee No.+fingerprint,"employeeNoAndFpAndPw"-
employee No.+fingerprint+password,"faceAndFpAndCard"-face+fingerprint+card,"faceAndPwAndFp"-face+password+fingerprint,"employeeNoAndFace"-employee
No.+face,"faceOrfaceAndCard"-face or face+card,"fpOrface"-fingerprint or face,"cardOrfaceOrPw"-card or face or password,"cardOrFace"-card or
face,"cardOrFaceOrFp"-card or face or fingerprint,"cardOrFpOrPw"-card or fingerprint or password,"sleep","invalid”*/
"TimeSegment": {
/*ro, opt, object*/
"beginTime": "00:00:00",
"endTime": "10:00:00"
}
}
]
}
}
21.34.7 Set holiday schedule parameters of card reader authentication mode

Request URL
PUT /ISAPI/AccessControl/VerifyHolidayPlanCfg/<holidayPlanID>?format=json
Query Parameter
Request Message
{
/*opt, object, holiday schedule parameters of the card reader authentication mode*/
"enable": true,
"beginDate": "1970-01-01",
/*req, date, start date of the holiday, desc:device local time*/
"endDate": "1970-01-02",
/*req, date, end date of the holiday, desc:device local time*/
"HolidayPlanCfg": [
/*req, array, holiday schedule parameters, subType:object*/
{
"id": 1,
"enable": true,
/*req, enum, authentication mode, subType:string, desc:"cardAndPw"-card+password, "card", "cardOrPw"-card or password, "fp"-fingerprint,
"fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint+card, "fpAndCardAndPw"-fingerprint+card+password,
"faceOrFpOrCardOrPw"-face or fingerprint or card or password, "faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face",
"employeeNoAndPw"-employee No.+password, "fpOrPw"-fingerprint or password, "employeeNoAndFp"-employee No.+fingerprint, "employeeNoAndFpAndPw"-employee
No.+fingerprint+password, "faceAndFpAndCard"-face+fingerprint+card, "faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face,
"faceOrfaceAndCard"-face or face+card, "fpOrface"-fingerprint or face, "cardOrfaceOrPw"-card or face or password, "cardOrFace"-card or face,
"cardOrFaceOrFp"-card or face or fingerprint, "cardOrFpOrPw"-card or fingerprint or password, "sleep", "invalid”*/
"TimeSegment": {
/*opt, object, time*/
"beginTime": "00:00:00",
"endTime": "10:00:00"
}
}
]
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.34.8 Get the week schedule configuration parameters of the card reader authentication
mode
Request URL
GET /ISAPI/AccessControl/VerifyWeekPlanCfg/<weekPlanID>?format=json
Query Parameter
Request Message
None
Response Message
{
"VerifyWeekPlanCfg": {
/*ro, opt, object, the week schedule configuration parameters of the card reader authentication mode*/
"enable": true,
/*ro, req, bool, whether to enable the week schedule configuration parameters of the card reader authentication mode, desc:true (enable), false
(disable)*/
"WeekPlanCfg": [
{
"week": "Monday",
/*ro, req, enum, day of a week, subType:string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"*/
"id": 1,
"enable": true,
/*ro, req, bool, whether to enable week schedule*/
/*ro, req, enum, authentication mode, subType:string, desc:"cardAndPw" (card+password), "card" (card), "cardOrPw" (card or password), "fp"
fingerprint or password), "sleep", "invalid"*/
"TimeSegment": {
/*ro, req, object, time*/
"beginTime": "00:00:00",
/*ro, req, time, start time, desc:(device local time)*/
"endTime": "10:00:00"
/*ro, req, time, end time, desc:(device local time)*/
}
}
]
}
}
21.34.9 Set the week schedule parameters of the card reader authentication mode
Request URL
PUT /ISAPI/AccessControl/VerifyWeekPlanCfg/<weekPlanID>?format=json
Query Parameter
Request Message
{
/*opt, object, the week schedule configuration parameters of the card reader authentication mode*/
"enable": true,
"WeekPlanCfg": [
{
"week": "Monday",
"id": 1,
"enable": true,
/*req, bool, whether to enable week schedule*/
/*req, enum, authentication mode, subType:string, desc:"cardAndPw" (card+password), "card" (card), "cardOrPw" (card or password), "fp"
fingerprint or password), "sleep", "invalid"*/
"TimeSegment": {
/*req, object, time*/
"beginTime": "00:00:00",
"endTime": "10:00:00"
}
}
]
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.34.10 Get the holiday schedule configuration capability of the card reader authentication
mode
Request URL
GET /ISAPI/AccessControl/VerifyHolidayPlanCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object*/
"planNo": {
/*ro, opt, object, holiday schedule template No.*/
"@min": 1,
/*ro, opt, int*/
"@max": 16
/*ro, opt, int*/
},
"beginDate": "1970-01-01",
/*ro, opt, date, start date of the holiday (device local time), desc:(device local time)*/
"endDate": "1970-01-02",
/*ro, opt, date, end date of the holiday (device local time), desc:(device local time)*/
"HolidayPlanCfg": {
/*ro, opt, object, holiday schedule parameters*/
"maxSize": 8,
/*ro, opt, int*/
"id": {
"@min": 1,
/*ro, opt, int*/
"@max": 8
/*ro, opt, int*/
},
"verifyMode": {
/*ro, opt, object, authentication mode*/
"@opt":
OrPw,faceOrPw,employeeNoAndFaceAndPw,cardOrFaceOrFaceAndCard,faceOrFpOrPw,iris,faceOrFpOrCardOrPwOrIris,faceOrCardOrPwOrIris,sleep,invalid"
/*ro, opt, string, desc:"cardAndPw"-card+password, "card", "cardOrPw"-card or password, "fp"-fingerprint, "fpAndPw"-fingerprint+password,
or password, "faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face", "employeeNoAndPw"-employee No.+password, "fpOrPw"-
fingerprint or face, "cardOrfaceOrPw"-card or face or password, "cardOrFace"-card or face, "cardOrFaceOrFp"-card or face or fingerprint, "cardOrFpOrPw"-card
or fingerprint or password, "sleep", "invalid”*/
},
"TimeSegment": {
"beginTime": "00:00:00",
/*ro, opt, time, start time, desc:(device local time)*/
"endTime": "10:00:00",
/*ro, opt, time, end time, desc:(device local time)*/
"minute"*/
}
}
}
}
21.34.11 Get the week schedule configuration capability of the card reader authentication
mode
Request URL
GET /ISAPI/AccessControl/VerifyWeekPlanCfg/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
/*ro, opt, object*/
"planNo": {
"@min": 1,
/*ro, opt, int*/
"@max": 16,
/*ro, opt, int*/
"@opt": [65535]
},
"WeekPlanCfg": {
/*ro, opt, object, week schedule parameters*/
"maxSize": 56,
/*ro, opt, int*/
"week": {
/*ro, opt, object, day of a week*/
"@opt": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday"
/*ro, opt, string, desc:"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"*/
},
"id": {
/*ro, opt, object*/
"@min": 1,
/*ro, opt, int*/
"@max": 8
/*ro, opt, int*/
},
"verifyMode": {
/*ro, opt, object, authentication mode*/
"@opt":
OrPw,faceOrPw,employeeNoAndFaceAndPw,cardOrFaceOrFaceAndCard,faceOrFpOrPw,iris,faceOrFpOrCardOrPwOrIris,faceOrCardOrPwOrIris,sleep,invalid"
/*ro, opt, string, desc:"cardAndPw"-card+password, "card", "cardOrPw"-card or password, "fp"-fingerprint, "fpAndPw"-fingerprint+password,
or password, "faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card,"face", "employeeNoAndPw"-employee No.+password, "fpOrPw"-
fingerprint or face,"cardOrfaceOrPw"-card or face or password, "cardOrFace"-card or face, "cardOrFaceOrFp"-card or face or fingerprint, "cardOrFpOrPw"-card
or fingerprint or password, "sleep", "invalid"*/
},
"TimeSegment": {
/*ro, opt, object*/
"beginTime": "00:00:00",
/*ro, opt, time, start time, desc:start time of the time period (device local time)*/
"endTime": "10:00:00",
/*ro, opt, time, end time, desc:end time of the time period (device local time)*/
/*ro, opt, enum, time accuracy, subType:string, desc:If this node is not returned, it indicates that the time accuracy is "minute". "hour",
"minute", "second"*/
}
}
}
}
21.34.12 Set holiday group parameters of control schedule of card reader authentication
mode
Request URL
PUT /ISAPI/AccessControl/VerifyHolidayGroupCfg/<holidayGroupID>?format=json
Query Parameter
Request Message
{
/*opt, object, holiday group parameters of control schedule of card reader authentication mode*/
"enable": true,
/*opt, string, holiday group schedule No., desc:holiday group schedule No.*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.34.13 Set the schedule template parameters of the card reader authentication mode
Request URL
PUT /ISAPI/AccessControl/VerifyPlanTemplate/<planTemplateID>?format=json
Query Parameter
Request Message
{
/*opt, object*/
"enable": true,
/*req, string, template name*/
"weekPlanNo": 1,
/*req, int, week schedule No.*/
/*req, string, holiday group No., desc:holiday group No.*/
}
}
Response Message
{
"statusCode": 1,
"errorCode": 1,
"errorMsg": "ok"
}
21.34.14 Get the schedule template parameters of card reader authentication mode
Request URL
GET /ISAPI/AccessControl/VerifyPlanTemplate/<planTemplateID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, opt, object, the schedule template parameters of card reader authentication mode*/
"enable": true,
"weekPlanNo": 1,
/*ro, req, int, week schedule No.*/
}
}
21.34.15 Get the holiday group configuration parameters of the control schedule of the card
reader authentication mode
Request URL
GET /ISAPI/AccessControl/VerifyHolidayGroupCfg/<holidayGroupID>?format=json
Query Parameter
Request Message
None
Response Message
{
/*ro, opt, object*/
"enable": true,
/*ro, req, bool, whether to enable, desc:true (yes), false-no (default)*/
/*ro, opt, string, holiday group schedule No., desc:holiday group schedule No.*/
}
}
21.35 Real-Time Collection

21.35.1 Get the capability of collecting face picture information.
Request URL
GET /ISAPI/AccessControl/CaptureFaceData/capabilities
Query Parameter
None
Request Message
None
Response Message
<CaptureFaceData xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<CaptureFaceDataCond>
true
<captureInfrared opt="true,false">
true
</captureInfrared>
<dataType opt="url,binary">
url
</dataType>
</CaptureFaceDataCond>
<faceDataUrl min="1" max="768">
1
</faceDataUrl>
<captureProgress min="1" max="10">
1
</captureProgress>
<infraredFaceDataUrl min="1" max="100">
test
</infraredFaceDataUrl>
<modelData min="1" max="10">
test
</modelData>
<score min="0" max="100">
80
</score>
<thermometryUnit opt="celsius,fahrenheit,kelvin">
test
</thermometryUnit>
<currTemperature min="0" max="10">
0.000
</currTemperature>
<visibleLightURL min="0" max="10">
test
</visibleLightURL>
<thermalURL min="0" max="10">
test
</thermalURL>
<readerID min="1" max="8">
</readerID>
</CaptureFaceData>
21.35.2 Get capability of getting face picture collection progress

Request URL
GET /ISAPI/AccessControl/CaptureFaceData/Progress/capabilities
Query Parameter
None
Request Message
None
Response Message

test
</faceDataUrl>
1
</captureProgress>
<isCurRequestOver opt="true,false">
true
</isCurRequestOver>
test
</readerID>
<requireReaderID>
</requireReaderID>
</CaptureFaceData>
21.35.3 Get the progress of collecting face picture information

Request URL
GET /ISAPI/AccessControl/CaptureFaceData/Progress?readerID=<readerID>
Query Parameter
readerID string --
Request Message
None
Response Message

<faceDataUrl>
test
</faceDataUrl>
<captureProgress>
100
</captureProgress>
<isCurRequestOver>
test
</CaptureFaceData>
21.35.4 Collect face picture information

Request URL
POST /ISAPI/AccessControl/CaptureFaceData
Query Parameter
None
Request Message
<CaptureFaceDataCond xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<captureInfrared>
true
</captureInfrared>
<dataType>
url
</dataType>
<readerID>
1
</readerID>
Response Message

<CaptureFaceDataCond>
<captureInfrared opt="true,false">
</captureInfrared>
<dataType opt="url,binary">
url
</dataType>
test
</faceDataUrl>
1
</captureProgress>
test
<modelData>
</modelData>
<score>
0
</score>
<thermometryUnit>
</thermometryUnit>
<currTemperature>
0.0
</currTemperature>
<visibleLightURL>
</visibleLightURL>
<thermalURL>
test
</thermalURL>
</CaptureFaceData>
Parameter Parameter Parameter Type(Content- Content-

File Name Description
Name Value Type) ID
设备未实现 [报文内容] application/xml -- -- --
[图片二进制数
FaceData image/jpeg FaceDatac --
据]
[图片二进制数
InfraredFaceData image/jpeg InfraredFaceData.jpg --
据]
the instance below.
--<frontier>
Parameter Value
name.
21.36 Video Intercom Basic Configuration
21.36.1 Get the configuration capability of the video intercom device ID
Request URL
GET /ISAPI/VideoIntercom/deviceId/capabilities?unitType=<unitType>
Query Parameter
unitType enum --
Request Message
None
Response Message
<DeviceId xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<unitType opt="villa,confirm,outdoor,fence,doorbell,manage,indoor,analogIndoor,decoder,netAudio,amplifier">
test
</unitType>
<periodNumber min="0" max="10">
0
</periodNumber>
<buildingNumber min="0" max="10">
0
</buildingNumber>
<unitNumber min="0" max="10">
0
</unitNumber>
<floorNumber min="0" max="10">
0
</floorNumber>
<roomNumber min="0" max="10">
0
</roomNumber>
<deviceIndex min="0" max="10">
0
</deviceIndex>
<readerDeviceIndex min="0" max="10">
0
</readerDeviceIndex>
<communityNumber min="0" max="10">
test
</communityNumber>
<customDeviceId min="0" max="10">
</customDeviceId>
<periodNumberName min="0" max="32">
</periodNumberName>
<buildingNumberName min="0" max="32">
</buildingNumberName>
<unitNumberName min="0" max="32">
</unitNumberName>
<floorNumberName min="0" max="32">
</floorNumberName>
<roomNumberName min="0" max="32">
</roomNumberName>
<deviceIndexName min="0" max="32">
</deviceIndexName>
<communityNumberName min="0" max="32">
</communityNumberName>
</enabled>
<industryType opt="builidings,prison,medicalTreatment,broadcasting">
</industryType>
1
</readerID>
<requireReaderID>
</requireReaderID>
</DeviceId>
21.36.2 Set the video intercom device ID

Request URL
PUT /ISAPI/VideoIntercom/deviceId?readerID=<readerID>
Query Parameter
readerID string --
Request Message


<unitType>
villa
</unitType>
<periodNumber>
0
</periodNumber>
<buildingNumber>
0
</buildingNumber>
<unitNumber>
0
</unitNumber>
<floorNumber>
0
</floorNumber>
<roomNumber>
0
</roomNumber>
<deviceIndex>
0
</deviceIndex>
<communityNumber>
test
</communityNumber>
<customDeviceId>
</customDeviceId>
<periodNumberName>
</periodNumberName>
<buildingNumberName>
<unitNumberName>
</unitNumberName>
<floorNumberName>
</floorNumberName>
<roomNumberName>
</roomNumberName>
<deviceIndexName>
</deviceIndexName>
<communityNumberName>
<enabled>
</enabled>
<industryType>
builidings
</industryType>
</DeviceId>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.36.3 Get the video intercom device ID

Request URL
GET /ISAPI/VideoIntercom/deviceId?readerID=<readerID>
Query Parameter
readerID string --
Request Message
None
Response Message


<unitType>
villa
</unitType>
<periodNumber>
0
</periodNumber>
<buildingNumber>
0
</buildingNumber>
<unitNumber>
0
</unitNumber>
<floorNumber>
0
</floorNumber>
<roomNumber>
0
</roomNumber>
<deviceIndex>
0
</deviceIndex>
<communityNumber>
test
</communityNumber>
<customDeviceId>
</customDeviceId>
<periodNumberName>
</periodNumberName>
<buildingNumberName>
<unitNumberName>
</unitNumberName>
<floorNumberName>
</floorNumberName>
<roomNumberName>
</roomNumberName>
<deviceIndexName>
</deviceIndexName>
<communityNumberName>
<enabled>
</enabled>
<industryType>
builidings
</industryType>
</DeviceId>
21.37 Interface Management

21.37.1 Get a specific page of a specific program
Request URL
GET /ISAPI/Publish/ProgramMgr/program/<programID>/page/<pageID>
Query Parameter
programID string --
pageID string --
Request Message
None
Response Message
<Page xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
1
</id>
<PageBasicInfo>

<pageName>
test
</pageName>
<BackgroundColor>

<RGB>
1
</RGB>
</BackgroundColor>
<playDurationMode>
selfDefine
</playDurationMode>
<playDuration>
1
</playDuration>
<playCount>
</playCount>
<switchDuration>
1
</switchDuration>
<switchEffect>
none
</switchEffect>
<backgroundPic>
1
</backgroundPic>
<SignInCfg>

<VoiceBroadcast>

<enabled>
</enabled>
<broadcastSpeed>
slower
</broadcastSpeed>
<inLibVoice>
</inLibVoice>
<outLibVoice>
</outLibVoice>
<inLibAbnormalTemperatureVoice>
</inLibAbnormalTemperatureVoice>
<outLibAbnormalTemperatureVoice>
</outLibAbnormalTemperatureVoice>
</VoiceBroadcast>
<WelcomeWord>

<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
</WelcomeWord>
<SignCartoon>
<signCartoonSpeed>
fast
</signCartoonSpeed>
</SignCartoon>
<backgroundSignEnabled>
</backgroundSignEnabled>
<TemperatureDetection>

<enabled>
true
</enabled>
<threshold>
0.000
</threshold>
</TemperatureDetection>
</SignInCfg>
</PageBasicInfo>
<characterMode>
mode1
</characterMode>
<WindowsList>

<Windows>

<id>
1
</id>
<Position>

<positionX>
1
</positionX>
<positionY>
1
</positionY>
<height>
1
</height>
<width>
1
</width>
</Position>
<CornerRadius>
<TopLeft>
</TopLeft>
<TopRight>
</TopRight>
<BottomLeft>
</BottomLeft>
<BottomRight>
</BottomRight>
</CornerRadius>
<layerNo>
1
</layerNo>
<WinMaterialInfo>

<materialType>
static
</materialType>
<staticMaterialType>
picture
</staticMaterialType>
<dynamicType>
web
</dynamicType>
<otherType>
clock
</otherType>
</WinMaterialInfo>
<TouchProperty>

<windType>
popup
</windType>
<hyperlinkType>
window
</hyperlinkType>
<windowId>
1
</windowId>
<pageId>
1
</pageId>
</TouchProperty>
<PlayItemList>

<PlayItem>
<id>
1
</id>
<materialNo>
1
</materialNo>
<inputChannel>
1
</inputChannel>
<playEffect>
none
</playEffect>
<MarqueeInfo>
<scrollType>
none
</scrollType>
<scrollDeriction>
none
</scrollDeriction>
<scrollSpeed>
1
</scrollSpeed>
</MarqueeInfo>
<PlayDuration>

<durationType>
selfDefine
</durationType>
<duration>
1
</duration>
</PlayDuration>
<CharactersEffect>

<fontSize>
1
</fontSize>
<FontColor>

<RGB>
1
</RGB>
</FontColor>
<backgroundType>
color
</backgroundType>
<backPicId>
</backPicId>
<BackColor>

<RGB>
</RGB>
</BackColor>
<backTransparent>
1
</backTransparent>
<subtitlesEnabled>
true
</subtitlesEnabled>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
1
</scrollSpeed>
</CharactersEffect>
<switchEffect>
random
</switchEffect>
<pageTime>
1
</scrollSpeed>
<scaleType>
centerCrop
</scaleType>
<playType>
normal
</playType>
<CharactersAttribute>

<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
color
</backgroundType>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backTransparent>
1
</backTransparent>
<alignType>
top
</verticaAlignType>
<characterContent>
test
</characterContent>
<backPicId>
</backPicId>
<characterStyle>
normal
</characterStyle>
<characterType>
mainTitle
</characterType>
</CharactersAttribute>
<WebProperty>
<webType>
desktop
</webType>
</WebProperty>
</PlayItem>
</PlayItemList>
<enabledAudio>
true
</enabledAudio>
<enableHide>
true
</enableHide>
<enableLock>
true
</enableLock>
<AppWindow>
<WindowInfoList>

<WindowInfo>

<id>
</id>
<materialNo>
1
</materialNo>
<path>
</path>
</WindowInfo>
</WindowInfoList>
</AppWindow>
<DataSource>

<materialNo>
1
</materialNo>
</DataSource>
<Call>

<materialNo>
</materialNo>
<tableRow>
1
</tableRow>
<tableColumn>
1
</tableColumn>
<tableDirection>
vertical
</tableDirection>
<tableType>
template1
</tableType>
<backPicId>
1
</backPicId>
<alignType>
left
</alignType>
<refreshDirection>

<id>
</id>
<data>
test
</data>
</HeadData>
</HeadDataList>
<ItemStyleList>
<ItemStyle>

<id>
</id>
<width>
1
</width>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ItemStyle>
</ItemStyleList>
</Call>
<DynamicPic>

<materialNo>
</materialNo>
<backPicId>
</backPicId>
</DynamicPic>
<CapturePic>

<backPicId>
</backPicId>
<ipcMaterialNo>
</ipcMaterialNo>
<cancelType>
manual
</cancelType>
<duration>
1
</duration>
</CapturePic>
<ClockParam>

<backPicId>
</backPicId>
<ClockIcon>

<enabled>
<enabled>
</enabled>
<type>
clock1
</type>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</ClockIcon>
<YmdParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</YmdParam>
<HmsParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</HmsParam>
</HmsParam>
<WeekParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeekParam>
</ClockParam>
<WeatherParam>

<backPicId>
1
</backPicId>
<WeatherIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherIcon>
<Date>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
</height>
<width>
</width>
</Position>
</Date>
<Temperature>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Temperature>
<WeatherContent>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
1
</RGB>
</BackColor>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherContent>
<City>

<enabled>
</enabled>
<cityId>
test
</cityId>
<cityName>
test
</cityName>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</City>
<Humidity>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Humidity>
<AirQuality>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</AirQuality>
<UpdateTime>

<enabled>
</enabled>
<refreshTime>
20200826T051500+08
</refreshTime>
<updateInterval>
1
</updateInterval>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</UpdateTime>
<Wind>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Wind>
</WeatherParam>
<Countdown>

<endTime>
20200826T051500+08
</endTime>
<template>
template1
</template>
<timeUnit>
year
year
</timeUnit>
<backPicId>
</backPicId>
<TimeFontCfg>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</TimeFontCfg>
<timeUnitEnabled>
</timeUnitEnabled>
<maxTimeUnit>
year
</maxTimeUnit>
<ModuleInfoList>
<ModuleInfo>
<moduleType>
second
</moduleType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<text>
</text>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</ModuleInfo>
</ModuleInfoList>
</Countdown>
<localInputNo>
VGA
</localInputNo>
<HyperlinkBtn>
<backPicId>
</backPicId>
</HyperlinkBtn>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<fontType>
normal
</fontType>
<backgroundType>
</backgroundType>
<BackColor>

<RGB>
</RGB>
<fillEnabled>
</fillEnabled>
</BackColor>
<backTransparent>
</backTransparent>
<alignType>
middle
</alignType>
<verticaAlignType>
top
</verticaAlignType>
<characterContent>
</characterContent>
<backPicId>
</backPicId>
<characterStyle>
</characterStyle>
<characterType>
</characterType>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
1
</scrollSpeed>
<SignIn>
<backPicId>
</backPicId>
<ShowInfo>
<row>
</row>
<column>
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>
<nameEnabled>
</nameEnabled>
<genderEnabled>
</genderEnabled>
<selfDefine1Enabled>
</selfDefine1Enabled>
<signInTimeEnabled>
</signInTimeEnabled>
<temperatureEnabled>
</temperatureEnabled>
</inLib>
<outLib>
<nameEnabled>
</nameEnabled>
<name>
</name>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</outLib>
<showDuration>
always
</showDuration>
</ShowInfo>
<MainTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</MainTitle>
<SubTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</SubTitle>
<NormalTemperature>
<PeopleNumber>
<PeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
1
</materialNo>
</Icon>
</NormalTemperature>
<AbnormalTemperature>
<PeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>
</AbnormalTemperature>
</SignIn>
<EventParam>
<EventResourceList>
<EventResource>
<ipVersion>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
1
</portNo>
<userName>
test
</userName>
<passWord>
test
</passWord>
<channels>
1,2
</channels>
</EventResource>
</EventResourceList>
<backPicId>
</backPicId>
<Title>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Title>
<PeopleCounting>
<maxPeopleNumber>
</maxPeopleNumber>
<unavailableBackPicId>
</unavailableBackPicId>
<supportChangeByPeople>
prompt
</supportChangeByPeople>
<Prompt>
<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<FontColor>

<RGB>
</RGB>
</FontColor>
<unavailableText>
</unavailableText>
<UnavailableFontColor>
<RGB>
</RGB>
</UnavailableFontColor>
</Prompt>
<PeopleIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</PeopleIcon>
<InsidePeopleTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</InsidePeopleTitle>
<InsidePeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</InsidePeopleNumber>
<AvailablePeopleTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
1
</width>
</Position>
<text>
</text>
</AvailablePeopleTitle>
<AvailablePeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<FontColor>
<RGB>
</RGB>
</FontColor>
<RGB>
</RGB>
</AvailablePeopleNumber>
<UnavailablePeopleIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</UnavailablePeopleIcon>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
1
</materialNo>
</AudioAlarm>
</PeopleCounting>
<Mask>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<MaskIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</MaskIcon>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</Mask>
<Temperature>
<Prompt>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Prompt>
<TemperatureIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</TemperatureIcon>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
<abnormalHighTemperature>
37.5
</abnormalHighTemperature>
</Temperature>
<WearMask>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<MaskIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</MaskIcon>
</WearMask>
<NormalTemperature>
<Prompt>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Prompt>
<TemperatureIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</TemperatureIcon>
<NormalStatusAudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</NormalStatusAudioAlarm>
</EventParam>
<AlarmDataSourceProperty>
<PictureProperty>

<PictureSwitchEffect>
leftInRightOut
</PictureSwitchEffect>
<PictureScaleType>
fitCenter
</PictureScaleType>
</PictureProperty>
<AlarmDataSource>

<MaterialNo>
</MaterialNo>
<Name>
test
</Name>
<Address>
</Address>
<WebProperty>
<webType>
desktop
</webType>
</WebProperty>
</AlarmDataSource>
</AlarmDataSourceProperty>
<ConferenceParam>

<backPicId>
<backPicId>
</backPicId>
<Title>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
middle
</alignType>
</Title>
<VoiceBroadcast>

<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
test
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>

<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<ShowInfo>
<row>
</row>
<column>
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>
<nameEnabled>
</nameEnabled>
</inLib>
<defaultShowInfoEnabled>
</defaultShowInfoEnabled>
</ShowInfo>
<ModuleInfoList>
<ModuleInfo>
<moduleType>
conferenceTime
</moduleType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
1
</backPicId>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
</alignType>
<CustomKey>
<key>
</key>
<associateProtocolURL>
</associateProtocolURL>
</CustomKey>
</ModuleInfo>
</ModuleInfoList>
<conferenceStatus>
idle
</conferenceStatus>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ConferenceParam>
<CallBtn>
<backPicId>
</backPicId>
</CallBtn>
<OpenDoorBtn>
<backPicId>
</backPicId>
</OpenDoorBtn>
<QRCodeBtn>
<backPicId>
</backPicId>
</QRCodeBtn>
<AuthenticationSuccess>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>
<SubWindow>
<subWindowType>
temperature
</subWindowType>
<enabled>
</enabled>
<fontSize>
1
</fontSize>
<fontColor>
1
</fontColor>
<fontStyle>
bold,italic,underline,strikeout
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</SubWindow>
</SubWindowList>
</AuthenticationSuccess>
<AuthenticationFail>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>
<SubWindow>
<subWindowType>
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<facePicID>
<facePicID>
1
</facePicID>
</SubWindow>
</SubWindowList>
</AuthenticationFail>
<StatusBar>

<backPicId>
</backPicId>
<statusBarType>
fixed
</statusBarType>
<SubStatusList>
<SubStatus>
<statusType>
dial
</statusType>
<enabled>
</enabled>
</SubStatus>
</SubStatusList>
</StatusBar>
<ExamTemplate>
<examTemplateID>
test
</examTemplateID>
<backPicURL>
test
</backPicURL>
<backgroundDirection>
horizontal
</backgroundDirection>
<ModuleInfoList>
<ModuleInfo>
<moduleType>
schoolName
</moduleType>
<enabled>
true
</enabled>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<fontSize>
1
</fontSize>
<fontStyleList>
<fontStyle>
bold
</fontStyle>
</fontStyleList>
<fontType>
custom
</fontType>
<FontColor>
<RGB>
</RGB>
</FontColor>
<fontTransparent>
</fontTransparent>
<alignType>
middle
</alignType>
<characterSpacing>
1
</characterSpacing>
<lineSpacing>
1
</lineSpacing>
<layerNo>
1
</layerNo>
</ModuleInfo>
</ModuleInfoList>
</ExamTemplate>
</Windows>
</WindowsList>
</Page>
21.37.2 Get the page configuration capability

Request URL
GET /ISAPI/Publish/ProgramMgr/program/<programID>/page/<pageID>/capabilities
Query Parameter
programID string --
pageID string --
Request Message
None
Response Message


<id>
1
</id>
<PageBasicInfo>

<pageName max="10">
test
</pageName>
<BackgroundColor>
<RGB>
</RGB>
</BackgroundColor>
<playDurationMode opt="selfDefine,auto,loop">
selfDefine
</playDurationMode>
<playDuration min="1" max="10" default="null">
1
</playDuration>
<playCount min="1" max="10">
1
</playCount>
<switchDuration min="1" max="10">
1
</switchDuration>
<switchEffect
opt="none,random,boxShrink,boxSpread,cycleShrink,cycSpread,eraseUp,eraseDown,eraseLeft,eraseRight,verticalShelter,horizontalShelter,verticalChessboard,horiz
ontalChessboard,dissolve,leftRightToCenter,ceterToLeftRight,upDownToCenter,centerToUpDown,drawOutLeftDown,drawOutLeftUp,drawOutRightDown,drawOutRightUp,vert
icalLine,horizontalLine">
none
</switchEffect>
<backgroundPic>
</backgroundPic>
<SignInCfg>

<VoiceBroadcast>
true
</enabled>
<broadcastSpeed opt="slower,slow,medium,fast,faster">
slower
</broadcastSpeed>
<inLibVoice min="1" max="10">
test
</inLibVoice>
<outLibVoice min="1" max="10">
</outLibVoice>
<inLibAbnormalTemperatureVoice min="1" max="10">
test
<outLibAbnormalTemperatureVoice min="1" max="10">
</VoiceBroadcast>
<WelcomeWord>
true
</enabled>
<inLibWord min="1" max="10">
</inLibWord>
<outLibWord min="1" max="10">
</outLibWord>
</WelcomeWord>
<SignCartoon>
<signCartoonSpeed opt="fast,medium,slow">
fast
</signCartoonSpeed>
</SignCartoon>
<backgroundSignEnabled opt="true,false">
</enabled>
<threshold min="1" max="10">
0.000
</threshold>
</SignInCfg>
</PageBasicInfo>
<characterMode opt="mode1,mode2,mode3">
mode1
</characterMode>
<WindowsList size="10">

<Windows>
<id>
</id>
<Position>

1
</positionX>
1
</positionY>
1
</height>
1
</width>
</Position>
<CornerRadius>
<TopLeft min="1" max="10">
</TopLeft>
<TopRight min="1" max="10">
</TopRight>
<BottomLeft min="1" max="10">
</BottomLeft>
<BottomRight min="1" max="10">
</BottomRight>
</CornerRadius>
<layerNo min="1" max="10">
1
</layerNo>
<WinMaterialInfo>
<materialType opt="static,dynamic,other">
static
</materialType>
<staticMaterialType opt="picture,flash,audio,video,document,ppt,doc,excel,pdf,web,app,signIn,conference">
picture
<dynamicType opt="web,socket,rss,call,dynamicPic,realStream,capturePic,character,chart">
web
</dynamicType>
<otherType
opt="clock,weather,countdown,localInput,hyperlinkBtn,event,callBtn,openDoorBtn,QRCodeBtn,authenticationSuccess,authenticationFail,statusBar">
clock
</otherType>
</WinMaterialInfo>
<TouchProperty>
<windType opt="popup,page">
popup
</windType>
<hyperlinkType opt="window,page">
window
</hyperlinkType>
<windowId>
</windowId>
<pageId>
</pageId>
</TouchProperty>
<PlayItemList size="10">

<PlayItem>

<id>
1
</id>
<materialNo>
</materialNo>
<inputChannel min="1" max="10">
1
</inputChannel>
<playEffect opt="none,marquee">
none
</playEffect>
<MarqueeInfo>
<scrollType opt="none,loops,once,backAndForth">
none
</scrollType>
<scrollDeriction opt="none,up,down,left,right">
none
</scrollDeriction>
<scrollSpeed min="1" max="10">
1
</scrollSpeed>
</MarqueeInfo>
<PlayDuration>

<durationType opt="materialTime,selfDefine,unlimited">
selfDefine
</durationType>
<duration min="1" max="10" default="null">
1
</duration>
</PlayDuration>
<CharactersEffect>
<fontSize min="1" max="10">
1
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType opt="color,picture">
color
</backgroundType>
<backPicId min="1" max="1000">
1
</backPicId>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backTransparent min="1" max="10">
1
</backTransparent>
<subtitlesEnabled>
true
</subtitlesEnabled>
</subtitlesEnabled>
<scrollDirection opt="left,right,up,down">
left
</scrollDirection>
1
</scrollSpeed>
</CharactersEffect>
<switchEffect
opt="none,random,rightInLeftOut,leftInRightOut,bottomInTopOut,topInBottomOut,fadeInFadeOut,middleExit,topPop,rightBottomIn,leftTopIn">
random
</switchEffect>
<pageTime min="1" max="10">
1
</pageTime>
1
</scrollSpeed>
<scaleType opt="fitXY,fitCenter,centerCrop,originalScale">
centerCrop
</scaleType>
<playType opt="normal,faceAttendance,PeopleCounting,temperature,conference">
normal
</playType>
<WebProperty>

<webType opt="desktop,mobile">
desktop
</webType>
</WebProperty>
</PlayItem>
</PlayItemList>
<enabledAudio opt="true,false">
true
</enabledAudio>
<enableHide opt="true,false">
true
</enableHide>
<enableLock opt="true,false">
true
</enableLock>
<AppWindow>

<WindowInfoList size="10">

<WindowInfo>
<id>
</id>
<materialNo>
1
</materialNo>
<path min="0" max="1024">
test
</path>
</WindowInfo>
</WindowInfoList>
</AppWindow>
<DataSource>

<materialNo>
</materialNo>
<dataSourceUUID min="1" max="32">
1
</dataSourceUUID>
</DataSource>
<Call>
<materialNo>
</materialNo>
<tableRow min="1" max="10">
1
</tableRow>
<tableColumn min="1" max="10">
1
</tableColumn>
<tableDirection opt="vertical,horizontal">
vertical
</tableDirection>
<tableType opt="template1,template2,template3,template4,template5,template6">
left
</alignType>
</alignType>
<refreshDirection opt="upTodown,downToup ,leftToright,rightToleft">
upTodown
</refreshDirection>
<HeadDataList size="10">

<HeadData>

<id>
</id>
<data min="1" max="10">
test
</data>
</HeadData>
</HeadDataList>
<ItemStyleList size="10">

<ItemStyle>
<id>
</id>
</width>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ItemStyle>
</ItemStyleList>
<playType opt="roll,flipOver">
roll
</playType>
</Call>
<DynamicPic>
<materialNo>
</materialNo>
<backPicId>
</backPicId>
</DynamicPic>
<CapturePic>
<backPicId>
</backPicId>
<ipcMaterialNo>
1
</ipcMaterialNo>
<cancelType opt="auto,manual">
manual
</cancelType>
1
</duration>
</CapturePic>
<ClockParam>

<backPicId>
</backPicId>
<ClockIcon>

<enabled>
</enabled>
<type opt="clock1,clock2">
clock1
</type>
<Position>

</positionX>
</positionY>
</positionY>
</height>
</width>
</Position>
</ClockIcon>
<YmdParam>

<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</YmdParam>
<HmsParam>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</HmsParam>
<WeekParam>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</WeekParam>
</ClockParam>
<WeatherParam>
<backPicId>
</backPicId>
<WeatherIcon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</WeatherIcon>
<Date>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</Date>
<Temperature>
<enabled>
</enabled>
</fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</Temperature>
<WeatherContent>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</WeatherContent>
<City>

<enabled>
</enabled>
<cityId min="1" max="10">
test
</cityId>
<cityName min="1" max="10">
test
</cityName>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
resolution-->
resolution-->
</positionX>
</positionY>
</height>
</width>
</Position>
</City>
<Humidity>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
resolution-->
</positionX>
</positionY>
</height>
</width>
</Position>
</Humidity>
<AirQuality>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</AirQuality>
<UpdateTime>

<enabled>
</enabled>
<refreshTime>
</refreshTime>
<updateInterval min="1" max="10">
1
</updateInterval>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</UpdateTime>
<Wind>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
resolution-->
</positionX>
</positionY>
</height>
</width>
</Position>
</Wind>
</WeatherParam>
<Countdown>
<endTime>
20200826T051500+08
</endTime>
<template
opt="template1,template2,openingActivity1,openingActivity2,commercialActivity1,commercialActivity2,salesPromotion,collegeEntranceExam,overseasTimeFormat">
year
</timeUnit>
<backPicId>
</backPicId>
<TimeFontCfg>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</TimeFontCfg>
<timeUnitEnabled opt="true,false">
</timeUnitEnabled>
<maxTimeUnit opt="year,month,day,week,hour,minute,second,week">
year
</maxTimeUnit>
<ModuleInfoList>
<ModuleInfo>
<moduleType opt="year,month,day,hour,minute,second,week,text">
second
</moduleType>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<text min="1" max="256">
</text>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</ModuleInfo>
</ModuleInfoList>
</Countdown>
<localInputNo opt="VGA,HDMI">
VGA
</localInputNo>
<HyperlinkBtn>

<backPicId>
</backPicId>
</HyperlinkBtn>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
color
</backgroundType>
<BackColor>
<RGB>
</RGB>
<fillEnabled opt="true,false">
</fillEnabled>
</BackColor>
1
</backTransparent>
middle
</alignType>
<verticaAlignType opt="top,bottom,verticalCenter">
top
</verticaAlignType>
<characterContent min="1" max="512">
test
</characterContent>
</backPicId>
<characterStyle opt="normal,bold">
normal
</characterStyle>
<characterType opt="mainTitle,subTitle,subTitle2">
mainTitle
</characterType>
<SignIn>
<backPicId>
</backPicId>
<ShowInfo>
<row min="1" max="10">
</row>
<column min="1" max="10">
</column>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<inLib>
<nameEnabled opt="true,false">
</nameEnabled>
<genderEnabled opt="true,false">
</genderEnabled>
<selfDefine1Enabled opt="true,false">
<signInTimeEnabled opt="true,false">
<temperatureEnabled opt="true,false">
</inLib>
<outLib>
</nameEnabled>
</name>
</genderEnabled>
</outLib>
<showDuration opt="always,10s,20s,30s,no">
always
</showDuration>
</ShowInfo>
<MainTitle>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<Position>
resolution-->
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</MainTitle>
<SubTitle>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
resolution-->
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</SubTitle>
<NormalTemperature>
<PeopleNumber>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<materialNo min="1" max="10">
1
</materialNo>
</Icon>
<PeopleNumber>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</Icon>
</SignIn>
<EventParam>

<EventResourceList size="10">

<EventResource>

<ipVersion opt="v4,v6,dual">
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
</portNo>
test
</userName>
<passWord min="1" max="10">
test
</passWord>
<BindIPC>
1,2
</BindIPC>
</EventResource>
<backPicId>
</backPicId>
<Title>

<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</Title>
<PeopleCounting>
<maxPeopleNumber min="1" max="10">
</maxPeopleNumber>
<supportChangeByPeople opt="prompt,peopleIcon,availablePeopleNumber">
prompt
<Prompt>

<enabled>
</enabled>
</fontSize>
</fontSize>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<FontColor>
<RGB>
</RGB>
</FontColor>
<unavailableText min="1" max="10">
</unavailableText>
<RGB>
</RGB>
</Prompt>
<PeopleIcon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</PeopleIcon>
<InsidePeopleTitle>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<enabled>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<enabled>
</enabled>
</fontSize>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<FontColor>
<RGB>
</RGB>
</FontColor>
<RGB>
</RGB>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
<AudioAlarm>
<enabled>
</enabled>
1
</materialNo>
</AudioAlarm>
</PeopleCounting>
<Mask>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<MaskIcon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</width>
</Position>
</materialNo>
</MaskIcon>
<AudioAlarm>
<enabled>
</enabled>
</materialNo>
</AudioAlarm>
</Mask>
<Temperature>
<Prompt>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</Prompt>
<TemperatureIcon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</TemperatureIcon>
<AudioAlarm>

<enabled>
</enabled>
</materialNo>
</AudioAlarm>
<abnormalHighTemperature min="1" max="10">
37.5
</Temperature>
</Temperature>
<WearMask>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<MaskIcon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</MaskIcon>
</WearMask>
<NormalTemperature>
<Prompt>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</Prompt>
<TemperatureIcon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</TemperatureIcon>
<enabled>
</enabled>
</materialNo>
</EventParam>
<ConferenceParam>

<backPicId>
</backPicId>
<Title>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</Title>
<VoiceBroadcast>
true
</enabled>
</broadcastSpeed>
test
</inLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
true
</enabled>
</inLibWord>
</outLibWord>
</WelcomeWord>
<ShowInfo>
</row>
</column>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<inLib>
</nameEnabled>
</inLib>
</ShowInfo>
<ModuleInfoList>
<ModuleInfo>
<moduleType
opt="conferenceTime,conferenceSite,conferenceStatus,signInPersonNum,totalPersonNum,unSignInPersonNum,signInAndTotalPersonNum,QRCode,meetingHostName,employee
No,customKey,nextMeeting">
conferenceTime
</moduleType>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</ModuleInfo>
</ModuleInfoList>
</ConferenceParam>
<CallBtn>
</backPicId>
</CallBtn>
<OpenDoorBtn>
</backPicId>
</OpenDoorBtn>
<QRCodeBtn>
</backPicId>
</QRCodeBtn>
<BackColor>
<RGB>
</RGB>
</BackColor>
1
</backPicId>
<SubWindowList>

<SubWindow>

<subWindowType opt="temperature,facePic,name,employeeNo,group,tips">
temperature
</subWindowType>
</enabled>
1
</fontSize>
<fontColor>
</fontColor>
<fontStyle opt="bold,italic,underline,strikeout">
bold,italic,underline,strikeout
</fontStyle>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</SubWindow>
</SubWindowList>
<BackColor>
<RGB>
</RGB>
</BackColor>
</backPicId>
<SubWindowList>

<SubWindow>
temperature
</subWindowType>
</enabled>
</fontSize>
<fontColor>
</fontColor>
bold,italic,underline,strikeout
</fontStyle>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<facePicID min="1" max="100">
{$.PageList.Page.WindowsList[*].Windows.AuthenticationFail.SubWindowList.SubWindow.subWindowType,eq,facePic}, attr:min{req, int},max{req, int}-->1
</facePicID>
</SubWindow>
</SubWindowList>
<StatusBar>

</backPicId>
<statusBarType opt="fixed">
fixed
</statusBarType>
<SubStatusList size="5">

<SubStatus>
<statusType opt="dial,wifi,EZVIZ,wiredNetwork,deploy,temperature">
dial
</statusType>
</enabled>
</SubStatus>
</SubStatusList>
</StatusBar>
<ExamTemplate>
<examTemplateID max="100">
test
</examTemplateID>
<backPicURL max="1024">
test
</backPicURL>
<backgroundDirection opt="horizontal,vertical">
horizontal
<ModuleInfoList size="50">
<ModuleInfo>
<moduleType
opt="schoolName,currentTime,examinationPlanLable,examinationPlanName,examRoomNumberLable,examRoomNumber,examRoomAddress,examRoomAddressLable,examDescription
Lable,examDescription,examSubjectLable,examSubject,examTimeLable,examTime,teacherLable,teacher,examNumberRangeLable,examNumberRange">
schoolName
</moduleType>
true
</enabled>
<Position>

</positionX>
</positionY>
1
</height>
1
</width>
</Position>
1
</fontSize>
<fontStyleList size="10">


<fontStyle opt="bold,italic,regular,strikethrough,underline">
bold
</fontStyle>
</fontStyleList>
<fontType opt="custom,default,kaiTi,simHei,simSun">
custom
</fontType>
<FontColor>
<RGB min="0" max="20000000">
1
</RGB>
</FontColor>
<fontTransparent min="0.0" max="1.0">
1.0
</fontTransparent>
middle
</alignType>
<characterSpacing min="1" max="100">
1
</characterSpacing>
<lineSpacing min="0.0" max="10">
1.0
</lineSpacing>
1
</layerNo>
</ModuleInfo>
</ModuleInfoList>
</ExamTemplate>
<ChartData>
1
</materialNo>
<chartType opt="histogram,pieChart">
histogram
</chartType>
1
</backPicId>
<HeadDataList>
<HeadData>
<id min="1" max="100">
</id>
</data>
<headType opt="axis,value">
axis
</headType>
</HeadData>
</HeadDataList>
</ChartData>
</Windows>
</WindowsList>
</Page>
21.37.3 Set the parameters of a specific page

Request URL
PUT /ISAPI/Publish/ProgramMgr/program/<programID>/page/<pageID>
Query Parameter
programID string --
pageID string --
Request Message


<id>
1
</id>
<PageBasicInfo>

<pageName>
test
</pageName>
<BackgroundColor>

<RGB>
1
</RGB>
</BackgroundColor>
<playDurationMode>
selfDefine
</playDurationMode>
<playDuration>
1
</playDuration>
<playCount>
1
</playCount>
<switchDuration>
1
</switchDuration>
<switchEffect>
none
</switchEffect>
<backgroundPic>
1
</backgroundPic>
<SignInCfg>

<VoiceBroadcast>

<enabled>
</enabled>
<broadcastSpeed>
slower
</broadcastSpeed>
<inLibVoice>
</inLibVoice>
<outLibVoice>
</outLibVoice>
<inLibAbnormalTemperatureVoice>
<outLibAbnormalTemperatureVoice>
</VoiceBroadcast>
<WelcomeWord>

<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<SignCartoon>

<signCartoonSpeed>
fast
</signCartoonSpeed>
</SignCartoon>

<enabled>
</enabled>
<threshold>
0.000
</threshold>
</SignInCfg>
</PageBasicInfo>
<characterMode>
mode1
</characterMode>
<WindowsList>

<Windows>

<id>
</id>
<Position>

<positionX>
1
</positionX>
<positionY>
1
</positionY>
<height>
1
</height>
<width>
1
</width>
</Position>
<CornerRadius>

<TopLeft>
1
</TopLeft>
<TopRight>
1
</TopRight>
<BottomLeft>
1
</BottomLeft>
<BottomRight>
1
</BottomRight>
</CornerRadius>
<layerNo>
1
</layerNo>
<WinMaterialInfo>

<materialType>
picture
<dynamicType>
web
</dynamicType>
<otherType>
clock
</otherType>
</WinMaterialInfo>
<TouchProperty>

<windType>
popup
</windType>
<hyperlinkType>
window
</hyperlinkType>
<windowId>
1
</windowId>
<pageId>
1
</pageId>
</TouchProperty>
<PlayItemList>

<PlayItem>

<id>
</id>
<materialNo>
1
</materialNo>
<inputChannel>
1
</inputChannel>
<playEffect>
none
</playEffect>
<MarqueeInfo>

<scrollType>
none
</scrollType>
<scrollDeriction>
<scrollDeriction>
none
</scrollDeriction>
<scrollSpeed>
1
</scrollSpeed>
</MarqueeInfo>
<PlayDuration>

<durationType>
selfDefine
</durationType>
<duration>
1
</duration>
</PlayDuration>
<CharactersEffect>

<fontSize>
1
</fontSize>
<FontColor>

<RGB>
1
</RGB>
</FontColor>
<backgroundType>
color
</backgroundType>
<backPicId>
1
</backPicId>
<BackColor>

<RGB>
</RGB>
</BackColor>
<backTransparent>
1
</backTransparent>
<subtitlesEnabled>
true
</subtitlesEnabled>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
1
</scrollSpeed>
</CharactersEffect>
<switchEffect>
random
</switchEffect>
<pageTime>
1
</pageTime>
<scrollSpeed>
1
</scrollSpeed>
<scaleType>
centerCrop
</scaleType>
<playType>
normal
</playType>

<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
color
</backgroundType>
<BackColor>
<RGB>
</RGB>
</BackColor>
</BackColor>
<backTransparent>
1
</backTransparent>
<alignType>
middle
</alignType>
<verticaAlignType>
top
</verticaAlignType>
<characterContent>
test
</characterContent>
<backPicId>
1
</backPicId>
<characterStyle>
normal
</characterStyle>
<characterType>
mainTitle
</characterType>
<WebProperty>

<webType>
desktop
</webType>
</WebProperty>
</PlayItem>
</PlayItemList>
<enabledAudio>
true
</enabledAudio>
<enableHide>
true
</enableHide>
<enableLock>
true
</enableLock>
<AppWindow>

<WindowInfoList>

<WindowInfo>

<id>
</id>
<materialNo>
1
</materialNo>
<path>
</path>
</WindowInfo>
</WindowInfoList>
</AppWindow>
<DataSource>

<materialNo>
1
</materialNo>
</DataSource>
<Call>

<materialNo>
</materialNo>
<tableRow>
1
</tableRow>
<tableColumn>
1
</tableColumn>
<tableDirection>
vertical
</tableDirection>
<tableType>
template1
</tableType>
<backPicId>
</backPicId>
<alignType>
left
</alignType>
<refreshDirection>

<id>
</id>
<data>
test
</data>
</HeadData>
</HeadDataList>
<ItemStyleList>
<ItemStyle>

<id>
</id>
<width>
1
</width>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ItemStyle>
</ItemStyleList>
</Call>
<DynamicPic>

<materialNo>
</materialNo>
<backPicId>
</backPicId>
</DynamicPic>
<CapturePic>

<backPicId>
</backPicId>
<ipcMaterialNo>
1
</ipcMaterialNo>
<cancelType>
manual
</cancelType>
<duration>
1
</duration>
</CapturePic>
<ClockParam>

<backPicId>
</backPicId>
<ClockIcon>

<enabled>
</enabled>
<type>
clock1
</type>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</ClockIcon>
<YmdParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</YmdParam>
<HmsParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</HmsParam>
<WeekParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeekParam>
</ClockParam>
<WeatherParam>

<backPicId>
</backPicId>
<WeatherIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherIcon>
<Date>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Date>
<Temperature>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Temperature>
<WeatherContent>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherContent>
<City>

<enabled>
</enabled>
<cityId>
test
</cityId>
<cityName>
test
</cityName>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</City>
<Humidity>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Humidity>
<AirQuality>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</AirQuality>
</AirQuality>
<UpdateTime>

<enabled>
</enabled>
<refreshTime>
20200826T051500+08
</refreshTime>
<updateInterval>
1
</updateInterval>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</UpdateTime>
<Wind>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Wind>
</WeatherParam>
<Countdown>

<endTime>
20200826T051500+08
</endTime>
<template>
template1
</template>
<timeUnit>
year
</timeUnit>
</timeUnit>
<backPicId>
</backPicId>
<TimeFontCfg>

<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</TimeFontCfg>
<timeUnitEnabled>
</timeUnitEnabled>
<maxTimeUnit>
year
</maxTimeUnit>
<ModuleInfoList>
<ModuleInfo>

<moduleType>
second
</moduleType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<text>
</text>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</ModuleInfo>
</ModuleInfoList>
</Countdown>
<localInputNo>
VGA
</localInputNo>
<HyperlinkBtn>

<backPicId>
</backPicId>
</HyperlinkBtn>

<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<fontType>
</fontType>
<backgroundType>
</backgroundType>
<BackColor>
<RGB>
</RGB>
<fillEnabled>
</fillEnabled>
</BackColor>
<backTransparent>
</backTransparent>
<alignType>
middle
</alignType>
<verticaAlignType>
top
</verticaAlignType>
<characterContent>
</characterContent>
<backPicId>
</backPicId>
<characterStyle>
</characterStyle>
<characterType>
</characterType>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
1
</scrollSpeed>
<SignIn>

<backPicId>
</backPicId>
<ShowInfo>

<row>
1
</row>
<column>
1
</column>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>

<nameEnabled>
</nameEnabled>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</inLib>
<outLib>

<nameEnabled>
</nameEnabled>
<name>
</name>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</outLib>
<showDuration>
always
</showDuration>
</ShowInfo>
<MainTitle>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</MainTitle>
<SubTitle>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</SubTitle>
<NormalTemperature>
<NormalTemperature>

<PeopleNumber>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
1
</materialNo>
</Icon>

<PeopleNumber>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>
</SignIn>
<EventParam>

<EventResourceList>
<EventResource>

<ipVersion>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
1
</portNo>
<userName>
</userName>
<passWord>
</passWord>
<channels>
1,2
</channels>
</EventResource>
<backPicId>
</backPicId>
<Title>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Title>
<PeopleCounting>


<maxPeopleNumber>
1
</maxPeopleNumber>
1
<supportChangeByPeople>
prompt
<Prompt>

<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<FontColor>

<RGB>
</RGB>
</FontColor>
<unavailableText>
</unavailableText>

<RGB>
</RGB>
</Prompt>
<PeopleIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</PeopleIcon>
<InsidePeopleTitle>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>

<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<FontColor>
<RGB>
</RGB>
</FontColor>

<RGB>
</RGB>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
<AudioAlarm>

<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</PeopleCounting>
<Mask>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<MaskIcon>
<MaskIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</MaskIcon>
<AudioAlarm>

<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</Mask>
<Temperature>

<Prompt>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>

<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Prompt>
<TemperatureIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</TemperatureIcon>
<AudioAlarm>

<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
37.5
</Temperature>
<WearMask>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<MaskIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</MaskIcon>
</WearMask>
<NormalTemperature>

<Prompt>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Prompt>
<TemperatureIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</TemperatureIcon>

<enabled>
</enabled>
<materialNo>
</materialNo>
</EventParam>

<PictureProperty>

leftInRightOut
<PictureScaleType>
fitCenter
</PictureScaleType>
</PictureProperty>
<AlarmDataSource>

<MaterialNo>
1
</MaterialNo>
<Name>
test
</Name>
<Address>
</Address>
<WebProperty>

<webType>
desktop
</webType>
</WebProperty>
</AlarmDataSource>
<ConferenceParam>

<backPicId>
</backPicId>
<Title>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
middle
</alignType>
</Title>
<VoiceBroadcast>

<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<ShowInfo>

<row>
1
</row>
<column>
1
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Position>
<inLib>

<nameEnabled>
</nameEnabled>
</inLib>
</ShowInfo>
<ModuleInfoList>
<ModuleInfo>

<moduleType>
conferenceTime
</moduleType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
1
</backPicId>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
</alignType>
<CustomKey>

<key>
</key>
</CustomKey>
</ModuleInfo>
</ModuleInfoList>
<conferenceStatus>
idle
</conferenceStatus>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ConferenceParam>
<CallBtn>

<backPicId>
1
</backPicId>
</CallBtn>
<OpenDoorBtn>

<backPicId>
</backPicId>
</OpenDoorBtn>
<QRCodeBtn>

<backPicId>
</backPicId>
</QRCodeBtn>

<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
1
</backPicId>
<SubWindowList>

<SubWindow>

<subWindowType>
temperature
</subWindowType>
<enabled>
</enabled>
<fontSize>
1
</fontSize>
<fontColor>
1
</fontColor>
<fontStyle>
bold,italic,underline,strikeout
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</SubWindow>
</SubWindowList>

<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
1
</backPicId>
<SubWindowList>

<SubWindow>

<subWindowType>
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
bold,italic,underline,strikeout
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</width>
</Position>
<facePicID>
</facePicID>
</SubWindow>
</SubWindowList>
<StatusBar>

<backPicId>
1
</backPicId>
<statusBarType>
fixed
</statusBarType>
<SubStatusList>

<SubStatus>
<statusType>
dial
</statusType>
<enabled>
</enabled>
</SubStatus>
</SubStatusList>
</StatusBar>
<ExamTemplate>

<examTemplateID>
test
</examTemplateID>
<backPicURL>
</backPicURL>
<backgroundDirection>
horizontal
<ModuleInfoList>
<ModuleInfo>

<moduleType>
schoolName
</moduleType>
<enabled>
true
</enabled>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<fontSize>
1
</fontSize>
<fontStyleList>
<fontStyle>
bold
</fontStyle>
</fontStyleList>
<fontType>
custom
</fontType>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<fontTransparent>
</fontTransparent>
<alignType>
middle
</alignType>
<characterSpacing>
1
</characterSpacing>
<lineSpacing>
<lineSpacing>
1
</lineSpacing>
<layerNo>
1
</layerNo>
</ModuleInfo>
</ModuleInfoList>
</ExamTemplate>
</Windows>
</WindowsList>
</Page>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.37.4 Delete a page

Request URL
DELETE /ISAPI/Publish/ProgramMgr/program/<programID>/page/<pageID>
Query Parameter
programID string --
pageID string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.38 Schedule Management

21.38.1 Add a new program schedule
Request URL
POST /ISAPI/Publish/ScheduleMgr/playSchedule
Query Parameter
None
Request Message
<PlaySchedule xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
1
</id>
<scheduleName>
test
</scheduleName>
<scheduleRemarks>
test
</scheduleRemarks>
<approveState>
approved
</approveState>
<approveRemarks>
test
</approveRemarks>
<scheduleMode>
normal
</scheduleMode>
<orgNo>
1
</orgNo>
<scheduleType>
selfDefine
</scheduleType>
<shareProperty>
public
</shareProperty>
<DailySchedule>

<PlaySpanList>

<PlaySpan>

<id>
1
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
<TimeRange>

<beginTime>
test
</beginTime>
<endTime>
test
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecondList>
<PlaySpanSecond>

<id>
</id>
<programNo>
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</PlaySpanSecondList>
</DailySchedule>
<WeeklySchedule>

<DayList>

<Day>

<id>
1
</id>
<dayOfWeek>
monday
</dayOfWeek>
<PlaySpanList>
<PlaySpan>

<id>
</id>
<programNo>
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecond>

<id>
</id>
<programNo>
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</Day>
</DayList>
</WeeklySchedule>
<LoopSchedule>

<ProgramList>

<program>

<id>
08
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
</program>
</ProgramList>
<ProgramNoList>

<programNo>
1
</programNo>
</ProgramNoList>
<ProgramNoSecondList>
<programNoSecond>
</programNoSecond>
</ProgramNoSecondList>
<ProgramSecondList>

<program>

<id>
08
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
</program>
</ProgramSecondList>
<LoopTimeSpanList>
<LoopTimeSpan>

<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
<ProgramNoList>

<programNo>
</programNo>
</ProgramNoList>
<ProgramList>

<program>

<id>
08
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
</program>
</ProgramList>
</LoopTimeSpan>
</LoopTimeSpanList>
<LoopTimeSpanSecondList>
<LoopTimeSpanSecond>

<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>

<programNoSecond>
</programNoSecond>
<ProgramSecondList>

<program>

<id>
08
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
</program>
</ProgramSecondList>
</LoopTimeSpanSecond>
</LoopTimeSpanSecondList>
</LoopSchedule>
<SelfDefineSchedule>

<SelfDefineList>
<SelfDefine>

<id>
</id>
<programNo>
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefine>
</SelfDefineList>
<SelfDefineSecondList>
<SelfDefineSecond>

<id>
</id>
<programNoSecond>
</programNoSecond>
<programUUIDSecond>
</programUUIDSecond>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefineSecond>
</SelfDefineSecondList>
</SelfDefineSchedule>
<DefaultSchedule>

<programNo>
1
</programNo>
<programUUID>
</programUUID>
<programNoSecond>
1
</programNoSecond>
<programUUIDSecond>
</programUUIDSecond>
</DefaultSchedule>
<HolidaySchedule>

<PlaySpanList>
<PlaySpan>

<id>
1
</id>
<programNo>
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
</HolidaySchedule>
<scheduleUUID>
</scheduleUUID>
<EmergencySchedule>

<ProgramNoList>
<ProgramNoList>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
</ProgramNoList>
<programNoSecond>
1
</programNoSecond>
<programUUID>
</programUUID>
</EmergencySchedule>
</PlaySchedule>
Response Message

<requestURL>
</requestURL>
<statusCode>
0
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
OK
</subStatusCode>
<ID>
</ID>
</ResponseStatus>
21.38.2 Get a specific program schedule

Request URL
GET /ISAPI/Publish/ScheduleMgr/playSchedule/<scheduleID>
Query Parameter
scheduleID string --
Request Message
None
Response Message

<id>
1
</id>
<scheduleName>
test
</scheduleName>
<scheduleRemarks>
test
</scheduleRemarks>
<approveState>
approved
</approveState>
<approveRemarks>
test
</approveRemarks>
<scheduleMode>
normal
normal
</scheduleMode>
<orgNo>
1
</orgNo>
<scheduleType>
selfDefine
</scheduleType>
<shareProperty>
public
</shareProperty>
<DailySchedule>

<PlaySpanList>
<PlaySpan>
<id>
1
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
<TimeRange>

<beginTime>
test
</beginTime>
<endTime>
test
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecond>
<id>
</id>
<programNo>
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</DailySchedule>
<WeeklySchedule>

<DayList>
<Day>

<id>
1
</id>
<dayOfWeek>
monday
</dayOfWeek>
<PlaySpanList>
<PlaySpan>
<id>
</id>
<programNo>
</programNo>
<programUUID>
test
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecond>
<id>
</id>
<programNo>
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</Day>
</DayList>
</WeeklySchedule>
<LoopSchedule>

<ProgramNoList>

<programNo>
1
</programNo>
<programUUID>
</programUUID>
</ProgramNoList>
<programNoSecond>
</programNoSecond>
<LoopTimeSpanList>
<LoopTimeSpan>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
<ProgramNoList>

<programNo>
</programNo>
<programUUID>
</programUUID>
</ProgramNoList>
</LoopTimeSpan>
</LoopTimeSpanList>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>

<programNoSecond>
</programNoSecond>
</LoopSchedule>
<SelfDefineList>
<SelfDefine>

<id>
1
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefine>
</SelfDefineList>
<SelfDefineSecond>
<id>
1
</id>
<programNoSecond>
1
</programNoSecond>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefineSecond>
<DefaultSchedule>

<programNo>
</programNo>
<programUUID>
</programUUID>
<programNoSecond>
</programNoSecond>
</DefaultSchedule>
<HolidaySchedule>

<PlaySpanList>
<PlaySpan>
<id>
</id>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
</HolidaySchedule>
<scheduleUUID>
test
</scheduleUUID>
<EmergencySchedule>
<ProgramNoList>
<programNo>
</programNo>
<programUUID>
</programUUID>
</ProgramNoList>
<programNoSecond>
</programNoSecond>
<programUUID>
</programUUID>
</PlaySchedule>
21.38.3 Get the parameters of all program schedules

Request URL
GET /ISAPI/Publish/ScheduleMgr/playSchedule
Query Parameter
None
Request Message
None
Response Message
<PlayScheduleList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<PlaySchedule>
<id>
</id>
<scheduleName>
test
</scheduleName>
<scheduleRemarks>
test
</scheduleRemarks>
<approveState>
approved
</approveState>
<approveRemarks>
</approveRemarks>
<scheduleMode>
normal
</scheduleMode>
<orgNo>
</orgNo>
<scheduleType>
selfDefine
</scheduleType>
<shareProperty>
public
</shareProperty>
<DailySchedule>
<PlaySpanList>
<PlaySpan>
<id>
1
</id>
<programNo>
</programNo>
<TimeRange>

<beginTime>
test
</beginTime>
<endTime>
test
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecond>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</DailySchedule>
<WeeklySchedule>
<DayList>
<Day>

<id>
</id>
<dayOfWeek>
monday
</dayOfWeek>
<PlaySpanList>
<PlaySpan>

<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecond>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</Day>
</DayList>
</WeeklySchedule>
<LoopSchedule>
<ProgramNoList>

<programNo>
1
</programNo>
</ProgramNoList>
<programNoSecond>
</programNoSecond>
<LoopTimeSpanList>
<LoopTimeSpan>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
<ProgramNoList>

<programNo>
</programNo>
</ProgramNoList>
</LoopTimeSpan>
</LoopTimeSpanList>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>

<programNoSecond>
</programNoSecond>
</LoopSchedule>
<SelfDefineList>
<SelfDefine>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefine>
</SelfDefineList>
<SelfDefineSecond>
<id>
</id>
<programNoSecond>
</programNoSecond>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefineSecond>
<DefaultSchedule>

<programNo>
1
</programNo>
<programNoSecond>
</programNoSecond>
</DefaultSchedule>
<HolidaySchedule>
<PlaySpanList>
<PlaySpan>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
</HolidaySchedule>
<scheduleUUID>
</scheduleUUID>
<EmergencySchedule>
<ProgramNoList>
<programNo>
</programNo>
<programUUID>
</programUUID>
</ProgramNoList>
<programNoSecond>
</programNoSecond>
<programUUID>
</programUUID>
</PlaySchedule>
</PlayScheduleList>
21.38.4 Set a specific program schedule

Request URL
PUT /ISAPI/Publish/ScheduleMgr/playSchedule/<scheduleID>
Query Parameter
Request Message

<id>
</id>
<scheduleName>
test
</scheduleName>
<scheduleRemarks>
test
</scheduleRemarks>
</scheduleRemarks>
<approveState>
approved
</approveState>
<approveRemarks>
</approveRemarks>
<scheduleMode>
normal
</scheduleMode>
<orgNo>
</orgNo>
<scheduleType>
selfDefine
</scheduleType>
<shareProperty>
public
</shareProperty>
<DailySchedule>

<PlaySpanList>
<PlaySpan>
<id>
</id>
<programNo>
1
</programNo>
<TimeRange>

<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecond>

<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</DailySchedule>
<WeeklySchedule>

<DayList>

<Day>

<id>
</id>
<dayOfWeek>
monday
</dayOfWeek>
<PlaySpanList>
<PlaySpan>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecond>

<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</Day>
</DayList>
</WeeklySchedule>
<LoopSchedule>

<ProgramNoList>

<programNo>
1
</programNo>
</ProgramNoList>
<programNoSecond>
</programNoSecond>
<LoopTimeSpanList>
<LoopTimeSpan>

<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
<ProgramNoList>

<programNo>
</programNo>
</ProgramNoList>
</LoopTimeSpan>
</LoopTimeSpanList>

<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
<programNoSecond>
</programNoSecond>
</LoopSchedule>

<SelfDefineList>
<SelfDefine>

<id>
</id>
</id>
<programNo>
1
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefine>
</SelfDefineList>
<SelfDefineSecond>

<id>
</id>
<programNoSecond>
1
</programNoSecond>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefineSecond>
<DefaultSchedule>

<programNo>
</programNo>
<programNoSecond>
1
</programNoSecond>
</DefaultSchedule>
<HolidaySchedule>

<PlaySpanList>
<PlaySpan>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
</HolidaySchedule>
<scheduleUUID>
</scheduleUUID>
<EmergencySchedule>

<ProgramNoList>
<programNo>
1
</programNo>
<programUUID>
</programUUID>
</ProgramNoList>
<programNoSecond>
1
</programNoSecond>
<programUUID>
</programUUID>
</PlaySchedule>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.38.5 Get the configuration capability of the program schedules

Request URL
GET /ISAPI/Publish/ScheduleMgr/playSchedule/<scheduleID>/capabilities
Query Parameter
Request Message
None
Response Message

<id>
1
</id>
<scheduleName max="10">
test
</scheduleName>
<scheduleRemarks max="10">
test
</scheduleRemarks>
<approveState opt="approved,notPass,notApprove">
test
</approveRemarks>
<scheduleMode opt="normal,decode,touch,decodeTouch">
normal
</scheduleMode>
<orgNo>
</orgNo>
<scheduleType opt="selfDefine,daily,weekly,loop,defaultSchedule">
selfDefine
</scheduleType>
<shareProperty opt="static,dynamic">
public
</shareProperty>
<DailySchedule>
<PlaySpanList size="10">
<PlaySpan>
<id>
</id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecondList size="10">
<PlaySpanSecond>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</DailySchedule>
<WeeklySchedule>

<DayList size="10">

<Day>
<id>
1
</id>
<dayOfWeek opt="monday,tuesday,tuesday,wednesday,thursday,friday,saturday,sunday">
monday
</dayOfWeek>
<PlaySpanList size="10">
<PlaySpan>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
<PlaySpanSecondList size="10">
<PlaySpanSecond>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpanSecond>
</Day>
</DayList>
</WeeklySchedule>
<LoopSchedule>
<LoopSchedule>

<ProgramNoList size="10">

<programNo>
</programNo>
</ProgramNoList>
<ProgramNoSecondList size="10">
<programNoSecond>
</programNoSecond>
<LoopTimeSpanList size="10">
<LoopTimeSpan>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
<ProgramNoList size="10">

<programNo>
</programNo>
</ProgramNoList>
</LoopTimeSpan>
</LoopTimeSpanList>
<LoopTimeSpanSecondList size="10">
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
<ProgramNoSecondList size="10">

<programNoSecond>
</programNoSecond>
</LoopSchedule>
<SelfDefineList size="10">
<SelfDefine>

<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefine>
</SelfDefineList>
<SelfDefineSecondList size="10">
<SelfDefineSecond>
<id>
</id>
<programNoSecond>
</programNoSecond>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</SelfDefineSecond>
<DefaultSchedule>

<programNo>
1
</programNo>
<programNoSecond>
</programNoSecond>
</DefaultSchedule>
<HolidaySchedule>

<PlaySpanList>
<PlaySpan>
<id>
</id>
<programNo>
</programNo>
<TimeRange>
<beginTime>
</beginTime>
<endTime>
</endTime>
</TimeRange>
</PlaySpan>
</PlaySpanList>
</HolidaySchedule>
</PlaySchedule>
21.38.6 Delete a specific program schedule

Request URL
DELETE /ISAPI/Publish/ScheduleMgr/playSchedule/<scheduleID>
Query Parameter
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.38.7 Get the schedule management capability set

Request URL
GET /ISAPI/Publish/ScheduleMgr/capabilities?format=json
Query Parameter
None
Request Message
None
Response Message
{
"ScheduleMgrCap": {
/*ro, opt, object*/
"isSupportPostSchedule": true
/*ro, opt, bool, whether it supports releasing program schedules*/
}
}
21.39 Material Management

21.39.1 Get capability of getting material management parameters
Request URL
GET /ISAPI/Publish/material/<materialID>/capabilities
Query Parameter
materialID string --
Request Message
None
Response Message
<Material xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
1
</id>
<seq min="1" max="10">
1
</seq>
<materialName max="10">
test
</materialName>
<materialRemarks max="10">
test
</materialRemarks>
<materialType opt="static,dynamic">
static
</materialType>
>approved
</approveState>
</approveRemarks>
public
</shareProperty>
<uploadUser max="10">
test
</uploadUser>
<uploadTime>
1970-01-01T00:00:00+08:00
</uploadTime>
<materialEncrypt min="1" max="10">
JjEmNTA3NDg5NCY0JjI3OTM5MjAmYWEmMzYyOTM5OCZhMCY0MjAzMDQwJmI1JjQzMzc3ODgmNDg=
</materialEncrypt>
<orgNo>
<orgNo>
</orgNo>
<orgName>
test
</orgName>
<replaceTerminal opt="true,false">
true
</replaceTerminal>
<StorageInfo>

<storageType min="1" max="10">
cloud
</storageType>
<host min="1" max="10">
https://10.11.5.222:4433
</host>
<accountName min="1" max="10">
test
</accountName>
<accountPasswd min="1" max="10">
test
</accountPasswd>
<bucket min="1" max="10">
test
</bucket>
</StorageInfo>
<StaticMaterial>
<staticMaterialType opt="picture,flash,audio,video,document,ppt,doc,excel,pdf,web">
picture
<picFormat opt="gif,bmp,jpg,png">
png
</picFormat>
<picResolution>

0
</height>
0
</width>
</picResolution>
<flashFormat opt="swf">
swf
</flashFormat>
<audioFormat opt="mp3,wav,wma">
wma
</audioFormat>
<videoFormat opt="rm,rmvb,asf,avi,mpg,3gp,mov,mkv,wmv,flv,mp4,hkps">
mp4
</videoFormat>
<documentFormat opt="txt">
txt
</documentFormat>
<pptFormat opt="ppt,pptx">
ppt
</pptFormat>
<docFormat opt="doc,docx">
doc
</docFormat>
<excelFormat opt="xls,xlsx">
xlsx
</excelFormat>
<pdfFormat opt="pdf">
pdf
</pdfFormat>
<webFormat opt="html,htm">
htm
</webFormat>
<fileSize max="10">
1
</fileSize>
<duration max="10">
1
</duration>
<uuid min="1" max="10">
test
</uuid>
<staticMaterialurl min="1" max="10">
</staticMaterialurl>
<materialUrl max="10">
test
</materialUrl>
<StorageInfo>

ipaddress
test
</ipAddress>
test
</ipv6Address>
<port min="1" max="10">
1
</port>
<accessKey min="1" max="10">
test
</accessKey>
<secretKey min="1" max="10">
</secretKey>
<bucket min="1" max="10">
test
</bucket>
</StorageInfo>
<videoFileSize max="10">
0
</videoFileSize>
<picFileSize max="10">
0
</picFileSize>
<materialURL max="10">
test
</materialURL>
</StaticMaterial>
<DynamicMaterial>

<dynamicMaterialType opt="web,socket,rss,realStream,generalData,picUrl,dataSource">
dataSource
</dynamicMaterialType>
<webUrl>
test
</webUrl>
<rssUrl>
test
</rssUrl>
<picUrl>
test
</picUrl>
<RealStream>

<destionType opt="streamMedia,normalIPC">
streamMedia
</destionType>
<streamMediaUrl>
test
</streamMediaUrl>
<NormalIPC>

<IpAddress>

v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
</IpAddress>
<portNo>
</portNo>
<channelNo>
1
</channelNo>
test
</userName>
test
</passWord>
<transmitProtocol opt="tcp,udp,mcast">
tcp
</transmitProtocol>
<streamType opt="main,sub,third">
main
</streamType>
</NormalIPC>
<dataType opt="capture,liveVideo">
capture
capture
</dataType>
</RealStream>
<GeneralData>

<SrcAddress>

v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
</SrcAddress>
<dataType opt="popPic,call">
popPic
</dataType>
</GeneralData>
<dataSourceUrl min="1" max="10">
test
</dataSourceUrl>
</DynamicMaterial>
</Material>
21.39.2 Add a material

Request URL
POST /ISAPI/Publish/MaterialMgr/material?security=<security>&iv=<iv>
Query Parameter
security string --
iv string --
Request Message
<Material xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<id>
1
</id>
<materialName>
test
</materialName>
<materialRemarks>
test
</materialRemarks>
<materialType>
static
</materialType>
<approveState>
</approveState>
<approveRemarks>
</approveRemarks>
<shareProperty>
public
</shareProperty>
<uploadUser>
test
</uploadUser>
<uploadTime>
1970-01-01T00:00:00+08:00
</uploadTime>
<materialEncrypt>
JjEmNTA3NDg5NCY0JjI3OTM5MjAmYWEmMzYyOTM5OCZhMCY0MjAzMDQwJmI1JjQzMzc3ODgmNDg=
</materialEncrypt>
<orgNo>
</orgNo>
<replaceTerminal>
true
</replaceTerminal>
<StaticMaterial>


swf
</flashFormat>
<audioFormat>
wma
</audioFormat>
<videoFormat>
mp4
</videoFormat>
<documentFormat>
txt
</documentFormat>
<pptFormat>
ppt
</pptFormat>
<docFormat>
doc
</docFormat>
<excelFormat>
xlsx
</excelFormat>
<pdfFormat>
pdf
</pdfFormat>
<webFormat>
htm
</webFormat>
<appFormat>
apk
</appFormat>
<fileSize>
1
</fileSize>
<duration>
1
</duration>
<staticMaterialurl>
</staticMaterialurl>
<materialURL>
</materialURL>
<StorageInfo>

ipaddress
<hostName>
test
</hostName>
<ipAddress>
test
</ipAddress>
<ipv6Address>
test
</ipv6Address>
<port>
1
</port>
<accessKey>
</accessKey>
<secretKey>
</secretKey>
<bucket>
</bucket>
</StorageInfo>
</StaticMaterial>
<DynamicMaterial>

<dynamicMaterialType>
dataSource
</dynamicMaterialType>
<webUrl>
test
</webUrl>
<rssUrl>
test
</rssUrl>
<picUrl>
test
</picUrl>
<RealStream>

<destionType>
streamMedia
</destionType>
<streamMediaUrl>
test
</streamMediaUrl>
<NormalIPC>

<IpAddress>

<ipVersion>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
</IpAddress>
<portNo>
</portNo>
<channelNo>
1
</channelNo>
<userName>
test
</userName>
<passWord>
test
</passWord>
<transmitProtocol>
tcp
</transmitProtocol>
<streamType>
main
</streamType>
<iv>
test
</iv>
<secretKey>
</secretKey>
</NormalIPC>
<dataType>
capture
</dataType>
</RealStream>
<GeneralData>

<SrcAddress>

<ipVersion>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
</SrcAddress>
<dataType>
popPic
</dataType>
</GeneralData>
</DynamicMaterial>
</Material>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
OK
</statusString>
<subStatusCode>
OK
</subStatusCode>
<ID>
</ID>
</ResponseStatus>
21.39.3 Delete a specific material

Request URL
DELETE /ISAPI/Publish/MaterialMgr/material/<materialID>
Query Parameter
materialID string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>
21.40 Program Management

21.40.1 Get program parameter capabilities
Request URL
GET /ISAPI/Publish/ProgramMgr/program/<programID>/capabilities
Query Parameter
programID string --
Request Message
None
Response Message
<Program xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<id>
</id>
<programName max="10">
test
</programName>
<programRemarks max="10">
test
</programRemarks>
public
</shareProperty>
>approved
</approveState>
</approveRemarks>
<programType opt="normal,decode,touch,decodeTouch,doubleSide,conference,screensaver,character,mainInterface,idleScreen,txt">
normal
</programType>
<orgNo>
</orgNo>
<Resolution>

<resolutionName opt="1920*1080,1080*1920,3840*2160,2160*3840,selfDefine">
test
</resolutionName>
<imageWidth min="1" max="10">
1
</imageWidth>
<imageHeight min="1" max="10">
1
</imageHeight>
</Resolution>
<PageList size="10">

<Page>

<id>
</id>
<PageBasicInfo>
<pageName max="10">
test
</pageName>
<BackgroundColor>
<RGB>
</RGB>
</BackgroundColor>
<playDurationMode opt="selfDefine,auto,loop">
selfDefine
</playDurationMode>
<playDuration min="1" max="10" default="null">
1
</playDuration>
<playCount min="1" max="10">
1
</playCount>
<switchDuration min="1" max="10">
1
</switchDuration>
<switchEffect
opt="none,random,boxShrink,boxSpread,cycleShrink,cycSpread,eraseUp,eraseDown,eraseLeft,eraseRight,verticalShelter,horizontalShelter,verticalChessboard,horiz
ontalChessboard,dissolve,leftRightToCenter,ceterToLeftRight,upDownToCenter,centerToUpDown,drawOutLeftDown,drawOutLeftUp,drawOutRightDown,drawOutRightUp,vert
icalLine,horizontalLine">
none
</switchEffect>
<backgroundPic>
</backgroundPic>
<SignInCfg>

<VoiceBroadcast>
</enabled>
</enabled>
</broadcastSpeed>
test
</inLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
</enabled>
</inLibWord>
</outLibWord>
</WelcomeWord>
<SignCartoon>
<signCartoonSpeed opt="fast,medium,slow">
fast
</signCartoonSpeed>
</SignCartoon>
<backgroundSignEnabled opt="true,false">
true
</enabled>
<threshold min="1" max="10">
0.000
</threshold>
</SignInCfg>
</PageBasicInfo>
<characterMode opt="mode1,mode2,mode3">
mode1
</characterMode>
<WindowsSplitMode opt="SLIP1,SLIP2,SLIP4,SLIP6,SLIP9">
SLIP4
</WindowsSplitMode>
<WindowsList size="10">
<Windows>
<id>
</id>
<Position>
static
</materialType>
<staticMaterialType opt="picture,flash,audio,video,document,ppt,doc,excel,pdf,web,app,signIn,conference">
picture
<dynamicType opt="web,socket,rss,call,dynamicPic,realStream,capturePic,character">
web
</dynamicType>
<otherType
opt="clock,weather,countdown,localInput,hyperlinkBtn,event,callBtn,openDoorBtn,QRCodeBtn,authenticationSuccess,authenticationFail,statusBar">
clock
</otherType>
</WinMaterialInfo>
<TouchProperty>
<windType opt="popup,page">
popup
</windType>
<hyperlinkType opt="window,page">
window
</hyperlinkType>
<windowId>
1
</windowId>
<pageId>
</pageId>
</TouchProperty>
<PlayItemList size="10">

<PlayItem>
<id>
</id>
<materialNo>
</materialNo>
<inputChannel min="1" max="10">
1
</inputChannel>
<playEffect opt="none,marquee">
none
</playEffect>
<MarqueeInfo>
<scrollType opt="none,loops,once,backAndForth">
none
</scrollType>
<scrollDeriction opt="none,up,down,left,right">
none
</scrollDeriction>
1
</scrollSpeed>
</MarqueeInfo>
<PlayDuration>

<durationType opt="materialTime,selfDefine">
selfDefine
</durationType>
1
</duration>
</PlayDuration>
<CharactersEffect>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
color
</backgroundType>
</backPicId>
<BackColor>
<RGB>
</RGB>
</BackColor>
1
</backTransparent>
</backTransparent>
<subtitlesEnabled>
</subtitlesEnabled>
<scrollDirection opt="left,right,up,down">
left
</scrollDirection>
1
</scrollSpeed>
</CharactersEffect>
<switchEffect
opt="none,random,rightInLeftOut,leftInRightOut,bottomInTopOut,topInBottomOut,fadeInFadeOut,middleExit,topPop,rightBottomIn,leftTopIn">
random
</switchEffect>
<pageTime min="1" max="10">
1
</pageTime>
1
</scrollSpeed>
<scaleType opt="fitXY,fitCenter,centerCrop,originalScale">
centerCrop
</scaleType>
</PlayItem>
</PlayItemList>
<enabledAudio opt="true,false">
true
</enabledAudio>
<enableHide opt="true,false">
true
</enableHide>
<enableLock opt="true,false">
true
</enableLock>
<AppWindow>
<WindowInfoList size="10">
<WindowInfo>
<id>
</id>
<materialNo>
</materialNo>
</WindowInfo>
</WindowInfoList>
</AppWindow>
<DataSource>

<materialNo>
</materialNo>
</DataSource>
<Call>
<materialNo>
</materialNo>
<tableRow min="1" max="10">
1
</tableRow>
<tableColumn min="1" max="10">
1
</tableColumn>
<tableDirection opt="vertical,horizontal">
vertical
</tableDirection>
<tableType opt="template1,template2,template3,template4,template5,template6">
template1
</tableType>
<backPicId>
</backPicId>
left
</alignType>
<refreshDirection opt="upTodown,downToup ,leftToright,rightToleft">
upTodown
</refreshDirection>
<HeadDataList size="10">
<HeadData>
<id>
</id>
</data>
</HeadData>
</HeadDataList>
<ItemStyleList size="10">
<ItemStyle>
<id>
</id>
</width>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ItemStyle>
</ItemStyleList>
</Call>
<DynamicPic>
<materialNo>
</materialNo>
<backPicId>
</backPicId>
</DynamicPic>
<CapturePic>
<backPicId>
</backPicId>
<ipcMaterialNo>
</ipcMaterialNo>
<cancelType opt="auto,manual">
manual
</cancelType>
1
</duration>
</CapturePic>
<ClockParam>
<backPicId>
</backPicId>
<ClockIcon>
<enabled>
</enabled>
<type opt="clock1,clock2">
clock1
</type>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</ClockIcon>
<YmdParam>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</YmdParam>
<HmsParam>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</HmsParam>
<WeekParam>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</WeekParam>
</ClockParam>
<WeatherParam>
<backPicId>
</backPicId>
<WeatherIcon>
<enabled>
</enabled>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</WeatherIcon>
<Date>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</Date>
<Temperature>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</positionY>
</height>
</width>
</Position>
</Temperature>
<WeatherContent>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</WeatherContent>
<City>
<enabled>
</enabled>
<cityId min="1" max="10">
test
</cityId>
<cityName min="1" max="10">
test
</cityName>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</City>
<Humidity>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</Humidity>
<AirQuality>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</AirQuality>
<UpdateTime>
<enabled>
</enabled>
<refreshTime>
20200826T051500+08
</refreshTime>
<updateInterval min="1" max="10">
1
</updateInterval>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</UpdateTime>
<Wind>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</Wind>
</WeatherParam>
<Countdown>
<endTime>
20200826T051500+08
</endTime>
<template
opt="template1,template2,openingActivity1,openingActivity2,commercialActivity1,commercialActivity2,salesPromotion,collegeEntranceExam,overseasTimeFormat">
template1
</template>
<timeUnit opt="year,month,day,week,hour,minute,second">
year
</timeUnit>
<backPicId>
</backPicId>
<TimeFontCfg>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</TimeFontCfg>
</timeUnitEnabled>
</Countdown>
<localInputNo opt="VGA,HDMI">
VGA
</localInputNo>
<HyperlinkBtn>
<backPicId>
</backPicId>
</HyperlinkBtn>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
color
</backgroundType>
<BackColor>
<RGB>
</RGB>
<fillEnabled opt="true,false">
</fillEnabled>
</BackColor>
1
</backTransparent>
middle
</alignType>
<verticaAlignType opt="top,bottom,verticalCenter">
top
</verticaAlignType>
<characterContent min="1" max="512">
test
</characterContent>
</backPicId>
<characterStyle opt="normal,bold">
normal
</characterStyle>
<characterType opt="mainTitle,subTitle,subTitle2">
mainTitle
</characterType>
<scrollDirection opt="left,right,up,down,turePage">
left
</scrollDirection>
1
</scrollSpeed>
<SignIn>
<backPicId>
</backPicId>
<ShowInfo>
</row>
</column>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<inLib>
</nameEnabled>
</genderEnabled>
</inLib>
<outLib>
</nameEnabled>
</name>
</genderEnabled>
</outLib>
<showDuration opt="always,10s,20s,30s,no">
always
</showDuration>
</ShowInfo>
<MainTitle>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
</text>
</MainTitle>
<SubTitle>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
</text>
</SubTitle>
<NormalTemperature>
<PeopleNumber>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<Position>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
</portNo>
test
</userName>
test
</passWord>
<BindIPC>
1,2
</BindIPC>
</EventResource>
<backPicId>
</backPicId>
<Title>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</Title>
<PeopleCounting>
<maxPeopleNumber min="1" max="10">
</maxPeopleNumber>
<supportChangeByPeople opt="prompt,peopleIcon,availablePeopleNumber">
prompt
<Prompt>

<enabled>
<enabled>
</enabled>
</fontSize>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<FontColor>
<RGB>
</RGB>
</FontColor>
<unavailableText min="1" max="10">
</unavailableText>
<RGB>
</RGB>
</Prompt>
<PeopleIcon>
<enabled>
</enabled>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</PeopleIcon>
<InsidePeopleTitle>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<enabled>
</enabled>
</fontSize>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
<FontColor>
<RGB>
</RGB>
</FontColor>
<RGB>
</RGB>
<enabled>
</enabled>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
<AudioAlarm>
<enabled>
</enabled>
</materialNo>
</AudioAlarm>
</PeopleCounting>
<Mask>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
<MaskIcon>
<enabled>
</enabled>
<Position>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</MaskIcon>
<AudioAlarm>
<enabled>
</enabled>
</materialNo>
</AudioAlarm>
</Mask>
<Temperature>
<Prompt>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</text>
</Prompt>
<TemperatureIcon>
<enabled>
</enabled>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</materialNo>
</TemperatureIcon>
<AudioAlarm>
<enabled>
</enabled>
</materialNo>
</AudioAlarm>
<abnormalHighTemperature min="1" max="10">
37.5
</Temperature>
</EventParam>
<ConferenceParam>

<backPicId>
</backPicId>
<Title>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
</Title>
<VoiceBroadcast>
</enabled>
</broadcastSpeed>
test
</inLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
</enabled>
</inLibWord>
</outLibWord>
</WelcomeWord>
<ShowInfo>
</row>
</column>
<Position>
<Position>
</positionX>
</positionY>
</height>
</width>
</Position>
<inLib>
</nameEnabled>
</inLib>
</ShowInfo>
<ModuleInfoList>
<ModuleInfo>
<moduleType
opt="conferenceTime,conferenceSite,conferenceStatus,signInPersonNum,totalPersonNum,unSignInPersonNum,signInAndTotalPersonNum,QRCode,meetingHostName,employee
No,customKey,nextMeeting">
conferenceTime
</moduleType>
<enabled>
</enabled>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<Position>

</positionX>
</positionY>
</height>
</width>
</Position>
</ModuleInfo>
</ModuleInfoList>
</ConferenceParam>
<CallBtn>
</backPicId>
</CallBtn>
<OpenDoorBtn>
</backPicId>
</OpenDoorBtn>
<QRCodeBtn>
</backPicId>
</QRCodeBtn>
<BackColor>
<RGB>
</RGB>
</BackColor>
1
</backPicId>
<SubWindowList>
<SubWindow>
temperature
</subWindowType>
</enabled>
</fontSize>
<fontColor>
</fontColor>
bold,italic,underline,strikeout
</fontStyle>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
</SubWindow>
</SubWindowList>
<BackColor>
<RGB>
</RGB>
</BackColor>
</backPicId>
<SubWindowList>
<SubWindow>
temperature
</subWindowType>
</enabled>
</fontSize>
<fontColor>
</fontColor>
bold,italic,underline,strikeout
</fontStyle>
<Position>
->
</positionX>
</positionY>
</height>
</width>
</Position>
<facePicID min="1" max="100">
{$.PageList.Page.WindowsList[*].Windows.AuthenticationFail.SubWindowList.SubWindow.subWindowType,eq,facePic}, attr:min{req, int},max{req, int}-->1
</facePicID>
</SubWindow>
</SubWindow>
</SubWindowList>
<StatusBar>
</backPicId>
<statusBarType opt="fixed">
fixed
</statusBarType>
<SubStatusList size="5">

<SubStatus>
<statusType opt="dial,wifi,EZVIZ,wiredNetwork,deploy,temperature">
dial
</statusType>
</enabled>
</SubStatus>
</SubStatusList>
</StatusBar>
</Windows>
</WindowsList>
</Page>
</PageList>
<programSize>
1
</programSize>
<programLength>
1
</programLength>
<coordinateType opt="uniformCoordinate,resolutionCoordinate">
uniformCoordinate
</coordinateType>
<screenType opt="first,second">
first
</screenType>
<audioEnabled opt="true,false">
</audioEnabled>
<PageIdList size="10">
<PageId>

<id min="1" max="10">
1
</id>
</PageId>
</PageIdList>
</Program>
21.40.2 Set a specific program

Request URL
PUT /ISAPI/Publish/ProgramMgr/program/<programID>
Query Parameter
programID string --
Request Message


<id>
</id>
<programName>
test
</programName>
<programRemarks>
test
</programRemarks>
<shareProperty>
public
</shareProperty>
<approveState>
</approveState>
<approveRemarks>
</approveRemarks>
<programType>
normal
</programType>
<orgNo>
</orgNo>
<Resolution>

<resolutionName>
test
</resolutionName>
<imageWidth>
1
</imageWidth>
<imageHeight>
1
</imageHeight>
</Resolution>
<PageList>
<Page>

<id>
1
</id>
<PageBasicInfo>

<pageName>
</pageName>
<BackgroundColor>
<RGB>
1
</RGB>
</BackgroundColor>
<playDurationMode>
selfDefine
</playDurationMode>
<playDuration>
1
</playDuration>
<playCount>
1
</playCount>
<switchDuration>
1
</switchDuration>
<switchEffect>
none
</switchEffect>
<backgroundPic>
</backgroundPic>
<SignInCfg>

<VoiceBroadcast>
<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<SignCartoon>

<signCartoonSpeed>
fast
</signCartoonSpeed>
</SignCartoon>

<enabled>
true
</enabled>
<threshold>
0.000
</threshold>
</SignInCfg>
</PageBasicInfo>
<characterMode>
mode1
</characterMode>
<WindowsSplitMode>
SLIP4
</WindowsSplitMode>
<WindowsList>
<Windows>

<id>
1
</id>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<CornerRadius>

<TopLeft>
1
</TopLeft>
<TopRight>
1
</TopRight>
<BottomLeft>
1
</BottomLeft>
<BottomRight>
1
</BottomRight>
</CornerRadius>
<layerNo>
1
</layerNo>
<WinMaterialInfo>

<materialType>
static
</materialType>
picture
<dynamicType>
web
</dynamicType>
<otherType>
clock
</otherType>
</WinMaterialInfo>
<TouchProperty>

<windType>
popup
</windType>
<hyperlinkType>
window
</hyperlinkType>
<windowId>
test
</windowId>
<pageId>
test
</pageId>
</TouchProperty>
<PlayItemList>
<PlayItem>

<id>
</id>
<materialNo>
</materialNo>
<inputChannel>
1
</inputChannel>
<playEffect>
none
</playEffect>
<MarqueeInfo>

<scrollType>
none
</scrollType>
<scrollDeriction>
none
</scrollDeriction>
<scrollSpeed>
1
</scrollSpeed>
</MarqueeInfo>
<PlayDuration>

<durationType>
selfDefine
</durationType>
<duration>
1
</duration>
</PlayDuration>
<CharactersEffect>

<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
color
</backgroundType>
<backPicId>
1
</backPicId>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backTransparent>
1
</backTransparent>
<subtitlesEnabled>
</subtitlesEnabled>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
1
</scrollSpeed>
</CharactersEffect>
<switchEffect>
random
</switchEffect>
<pageTime>
1
</pageTime>
<scrollSpeed>
1
</scrollSpeed>
<scaleType>
centerCrop
</scaleType>
<playType>
</playType>
</PlayItem>
</PlayItemList>
<enabledAudio>
true
</enabledAudio>
<enableHide>
true
</enableHide>
<enableLock>
<enableLock>
true
</enableLock>
<AppWindow>

<WindowInfoList>

<WindowInfo>

<id>
</id>
<materialNo>
</materialNo>
</WindowInfo>
</WindowInfoList>
</AppWindow>
<DataSource>

<materialNo>
</materialNo>
</DataSource>
<Call>

<materialNo>
</materialNo>
<tableRow>
1
</tableRow>
<tableColumn>
1
</tableColumn>
<tableDirection>
vertical
</tableDirection>
<tableType>
template1
</tableType>
<backPicId>
1
</backPicId>
<alignType>
left
</alignType>
<refreshDirection>
upTodown
</refreshDirection>
<HeadDataList>
<HeadData>

<id>
</id>
<data>
test
</data>
</HeadData>
</HeadDataList>
<ItemStyleList>
<ItemStyle>

<id>
</id>
<width>
1
</width>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ItemStyle>
</ItemStyleList>
</Call>
<DynamicPic>

<materialNo>
</materialNo>
<backPicId>
</backPicId>
</DynamicPic>
<CapturePic>

<backPicId>
</backPicId>
<ipcMaterialNo>
1
</ipcMaterialNo>
<cancelType>
manual
</cancelType>
<duration>
1
</duration>
</CapturePic>
<ClockParam>

<backPicId>
</backPicId>
<ClockIcon>

<enabled>
</enabled>
<type>
clock1
</type>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</ClockIcon>
<YmdParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</YmdParam>
<HmsParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</HmsParam>
<WeekParam>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeekParam>
</ClockParam>
<WeatherParam>

<backPicId>
1
</backPicId>
<WeatherIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherIcon>
<Date>

<enabled>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Date>
<Temperature>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Temperature>
<WeatherContent>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherContent>
<City>

<enabled>
</enabled>
<cityId>
</cityId>
<cityName>
test
</cityName>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</City>
<Humidity>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Humidity>
<AirQuality>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</AirQuality>
<UpdateTime>

<enabled>
</enabled>
<refreshTime>
20200826T051500+08
</refreshTime>
<updateInterval>
1
</updateInterval>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</UpdateTime>
<Wind>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Wind>
</WeatherParam>
<Countdown>

<endTime>
20200826T051500+08
</endTime>
<template>
template1
</template>
<timeUnit>
year
</timeUnit>
<backPicId>
</backPicId>
<TimeFontCfg>

<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</TimeFontCfg>
<timeUnitEnabled>
</timeUnitEnabled>
</Countdown>
<localInputNo>
VGA
</localInputNo>
<HyperlinkBtn>

<backPicId>
</backPicId>
</HyperlinkBtn>

<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
</backgroundType>
<BackColor>
<RGB>
</RGB>
<fillEnabled>
</fillEnabled>
</fillEnabled>
</BackColor>
<backTransparent>
</backTransparent>
<alignType>
middle
</alignType>
<verticaAlignType>
top
</verticaAlignType>
<characterContent>
</characterContent>
<backPicId>
</backPicId>
<characterStyle>
</characterStyle>
<characterType>
</characterType>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
1
</scrollSpeed>
<SignIn>

<backPicId>
</backPicId>
<ShowInfo>

<row>
1
</row>
<column>
1
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>

<nameEnabled>
</nameEnabled>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</inLib>
<outLib>

<nameEnabled>
</nameEnabled>
<name>
</name>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</outLib>
<showDuration>
always
</showDuration>
</ShowInfo>
<MainTitle>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<text>
</text>
</MainTitle>
<SubTitle>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<text>
</text>
</SubTitle>
<NormalTemperature>

<PeopleNumber>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>

<PeopleNumber>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>
</SignIn>
<EventParam>

<EventResourceList>
<EventResource>

<ipVersion>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
</portNo>
<userName>
test
</userName>
<passWord>
test
test
</passWord>
<BindIPC>
1,2
</BindIPC>
</EventResource>
<backPicId>
</backPicId>
<Title>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Title>
<PeopleCounting>

<maxPeopleNumber>
1
</maxPeopleNumber>
1
<Prompt>

<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<FontColor>

<RGB>
1
</RGB>
</FontColor>
<unavailableText>
</unavailableText>

<RGB>
1
</RGB>
</Prompt>
<PeopleIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</PeopleIcon>
<InsidePeopleTitle>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>

<enabled>
</enabled>
<fontSize>
</fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>

<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<FontColor>

<RGB>
1
</RGB>
</FontColor>

<RGB>
1
</RGB>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
<AudioAlarm>

<enabled>
</enabled>
<materialNo>
1
</materialNo>
</AudioAlarm>
</PeopleCounting>
<Mask>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<BackColor>
<RGB>
1
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<MaskIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</MaskIcon>
<AudioAlarm>

<enabled>
</enabled>
<materialNo>
1
</materialNo>
</AudioAlarm>
</Mask>
<Temperature>

<Prompt>

<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<BackColor>
<RGB>
1
1
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Prompt>
<TemperatureIcon>

<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</TemperatureIcon>
<AudioAlarm>

<enabled>
</enabled>
<materialNo>
1
</materialNo>
</AudioAlarm>
37.5
</Temperature>
</EventParam>

<PictureProperty>

leftInRightOut
<PictureScaleType>
fitCenter
</PictureScaleType>
</PictureProperty>
<AlarmDataSource>

<MaterialNo>
</MaterialNo>
<Name>
test
</Name>
<Address>
</Address>
</AlarmDataSource>
<ConferenceParam>

<backPicId>
</backPicId>
<Title>

<enabled>
</enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
1
</RGB>
</FontColor>
<BackColor>
<RGB>
1
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
</alignType>
</Title>
<VoiceBroadcast>
<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<ShowInfo>

<row>
1
</row>
<column>
1
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>

<nameEnabled>
</nameEnabled>
</inLib>
</ShowInfo>
</ShowInfo>
<ModuleInfoList>
<ModuleInfo>

<moduleType>
conferenceTime
</moduleType>
<enabled>
</enabled>
<fontSize>
1
</fontSize>
<FontColor>

<RGB>
1
</RGB>
</FontColor>
<BackColor>

<RGB>
1
</RGB>
</BackColor>
<backPicId>
1
</backPicId>
<Position>

<positionX>
1
</positionX>
<positionY>
1
</positionY>
<height>
1
</height>
<width>
1
</width>
</Position>
<alignType>
</alignType>
<CustomKey>

<key>
</key>
</CustomKey>
</ModuleInfo>
</ModuleInfoList>
<conferenceStatus>
idle
</conferenceStatus>
<BackColor>

<RGB>
1
</RGB>
</BackColor>
</ConferenceParam>
<CallBtn>

<backPicId>
</backPicId>
</CallBtn>
<OpenDoorBtn>

<backPicId>
</backPicId>
</OpenDoorBtn>
<QRCodeBtn>

<backPicId>
</backPicId>
</QRCodeBtn>

<BackColor>
<RGB>
1
</RGB>
</BackColor>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>

<SubWindow>

<subWindowType>
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
bold,italic,underline,strikeout
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</SubWindow>
</SubWindowList>

<BackColor>
<RGB>
1
</RGB>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>

<SubWindow>

<subWindowType>
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
bold,italic,underline,strikeout
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<facePicID>
</facePicID>
</SubWindow>
</SubWindowList>
<StatusBar>

<backPicId>
</backPicId>
<statusBarType>
fixed
</statusBarType>
<SubStatusList>

<SubStatus>
<statusType>
dial
</statusType>
<enabled>
</enabled>
</SubStatus>
</SubStatusList>
</StatusBar>
</Windows>
</WindowsList>
</Page>
</PageList>
<programSize>
1
</programSize>
<programLength>
1
</programLength>
<coordinateType>
uniformCoordinate
</coordinateType>
<screenType>
first
</screenType>
<audioEnabled>
</audioEnabled>
<PageIdList>
<PageId>

<id>
</id>
</PageId>
</PageIdList>
<programUUID>
</programUUID>
</Program>
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
OK
</subStatusCode>
</ResponseStatus>
21.40.3 Get a specific program

Request URL
GET /ISAPI/Publish/ProgramMgr/program/<programID>
Query Parameter
programID string --
Request Message
None
Response Message


<id>
</id>
<programName>
test
</programName>
<programRemarks>
test
</programRemarks>
<shareProperty>
public
</shareProperty>
<approveState>
approved
</approveState>
<approveRemarks>
</approveRemarks>
<programType>
normal
</programType>
<orgNo>
</orgNo>
<Resolution>
<resolutionName>
test
</resolutionName>
<imageWidth>
1
</imageWidth>
<imageHeight>
1
</imageHeight>
</Resolution>
<PageList>

<Page>
<id>
</id>
<PageBasicInfo>
<pageName>
</pageName>
<BackgroundColor>
<RGB>
</RGB>
</BackgroundColor>
<playDurationMode>
selfDefine
</playDurationMode>
<playDuration>
1
</playDuration>
<playCount>
1
</playCount>
<switchDuration>
1
</switchDuration>
<switchEffect>
none
</switchEffect>
<backgroundPic>
</backgroundPic>
<SignInCfg>
<VoiceBroadcast>
<VoiceBroadcast>
<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
test
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<SignCartoon>
<signCartoonSpeed>
</signCartoonSpeed>
</SignCartoon>
<enabled>
</enabled>
<threshold>
0.000
</threshold>
</SignInCfg>
</PageBasicInfo>
<characterMode>
mode1
</characterMode>
<WindowsSplitMode>
SLIP4
</WindowsSplitMode>
<WindowsList>
<Windows>
<id>
</id>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<CornerRadius>
<TopLeft>
</TopLeft>
<TopRight>
</TopRight>
<BottomLeft>
</BottomLeft>
<BottomRight>
</BottomRight>
</CornerRadius>
<layerNo>
</layerNo>
<WinMaterialInfo>
<materialType>
static
</materialType>
picture
<dynamicType>
web
</dynamicType>
<otherType>
clock
</otherType>
</WinMaterialInfo>
<TouchProperty>
<windType>
popup
</windType>
<hyperlinkType>
window
</hyperlinkType>
<windowId>
test
</windowId>
<pageId>
test
</pageId>
</TouchProperty>
<PlayItemList>
<PlayItem>
<id>
</id>
<materialNo>
</materialNo>
<inputChannel>
</inputChannel>
<playEffect>
none
</playEffect>
<MarqueeInfo>
<scrollType>
none
</scrollType>
<scrollDeriction>
none
</scrollDeriction>
<scrollSpeed>
</scrollSpeed>
</MarqueeInfo>
<PlayDuration>

<durationType>
selfDefine
</durationType>
<duration>
1
</duration>
</PlayDuration>
<CharactersEffect>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
</backgroundType>
<backPicId>
</backPicId>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backTransparent>
</backTransparent>
</backTransparent>
<subtitlesEnabled>
</subtitlesEnabled>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
</scrollSpeed>
</CharactersEffect>
<switchEffect>
random
</switchEffect>
<pageTime>
1
</pageTime>
<scrollSpeed>
</scrollSpeed>
<scaleType>
</scaleType>
<playType>
</playType>
</PlayItem>
</PlayItemList>
<enabledAudio>
</enabledAudio>
<enableHide>
true
</enableHide>
<enableLock>
</enableLock>
<AppWindow>
<WindowInfoList>
<WindowInfo>
<id>
</id>
<materialNo>
</materialNo>
</WindowInfo>
</WindowInfoList>
</AppWindow>
<DataSource>
<materialNo>
</materialNo>
</DataSource>
<Call>
<materialNo>
</materialNo>
<tableRow>
</tableRow>
<tableColumn>
</tableColumn>
<tableDirection>
vertical
</tableDirection>
<tableType>
</tableType>
<backPicId>
</backPicId>
<alignType>
left
</alignType>
<refreshDirection>
upTodown
</refreshDirection>
<HeadDataList>
<HeadData>
<id>
</id>
<data>
</data>
</data>
</HeadData>
</HeadDataList>
<ItemStyleList>
<ItemStyle>
<id>
</id>
<width>
</width>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ItemStyle>
</ItemStyleList>
</Call>
<DynamicPic>
<materialNo>
</materialNo>
<backPicId>
</backPicId>
</DynamicPic>
<CapturePic>
<backPicId>
</backPicId>
<ipcMaterialNo>
</ipcMaterialNo>
<cancelType>
manual
</cancelType>
<duration>
</duration>
</CapturePic>
<ClockParam>
<backPicId>
</backPicId>
<ClockIcon>

<enabled>
</enabled>
<type>
</type>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</ClockIcon>
<YmdParam>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</YmdParam>
<HmsParam>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</HmsParam>
<WeekParam>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
<width>
</width>
</Position>
</WeekParam>
</ClockParam>
<WeatherParam>
<backPicId>
</backPicId>
<WeatherIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherIcon>
<Date>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Date>
<Temperature>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Temperature>
<WeatherContent>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherContent>
<City>
<enabled>
</enabled>
<cityId>
</cityId>
<cityName>
</cityName>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</City>
<Humidity>
<enabled>
</enabled>
<fontSize>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Humidity>
<AirQuality>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</AirQuality>
<UpdateTime>
<enabled>
</enabled>
<refreshTime>
20200826T051500+08
</refreshTime>
<updateInterval>
1
</updateInterval>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</UpdateTime>
<Wind>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Wind>
</WeatherParam>
<Countdown>
<endTime>
20200826T051500+08
</endTime>
<template>
template1
</template>
<timeUnit>
year
</timeUnit>
<backPicId>
</backPicId>
<TimeFontCfg>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</TimeFontCfg>
<timeUnitEnabled>
<timeUnitEnabled>
</timeUnitEnabled>
</Countdown>
<localInputNo>
VGA
</localInputNo>
<HyperlinkBtn>
<backPicId>
</backPicId>
</HyperlinkBtn>
<fontType>
</fontType>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
</backgroundType>
<BackColor>
<RGB>
</RGB>
<fillEnabled>
</fillEnabled>
</BackColor>
<backTransparent>
</backTransparent>
<alignType>
</alignType>
<verticaAlignType>
</verticaAlignType>
<characterContent>
</characterContent>
<backPicId>
</backPicId>
<characterStyle>
</characterStyle>
<characterType>
mainTitle
</characterType>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
</scrollSpeed>
<SignIn>
<backPicId>
</backPicId>
<ShowInfo>
<row>
</row>
<column>
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</width>
</Position>
<inLib>
<nameEnabled>
</nameEnabled>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</inLib>
<outLib>
<nameEnabled>
</nameEnabled>
<name>
</name>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</outLib>
<showDuration>
</showDuration>
</ShowInfo>
<MainTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<text>
</text>
</MainTitle>
<SubTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<text>
</text>
</SubTitle>
<NormalTemperature>
<PeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>
<PeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>
</SignIn>
<EventParam>
<EventResourceList>
<EventResource>
<ipVersion>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
</portNo>
<userName>
</userName>
<passWord>
</passWord>
<BindIPC>
1,2
</BindIPC>
</EventResource>
<backPicId>
</backPicId>
<Title>
<enabled>
true
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Title>
<PeopleCounting>
<maxPeopleNumber>
</maxPeopleNumber>
<Prompt>
<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<FontColor>
<RGB>
</RGB>
</FontColor>
<unavailableText>
</unavailableText>
<RGB>
</RGB>
</Prompt>
<PeopleIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</PeopleIcon>
<InsidePeopleTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<FontColor>
<RGB>
</RGB>
</FontColor>
<RGB>
</RGB>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</PeopleCounting>
<Mask>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<MaskIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</MaskIcon>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</Mask>
<Temperature>
<Prompt>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Prompt>
<TemperatureIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</TemperatureIcon>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</Temperature>
</EventParam>
<PictureProperty>
<PictureScaleType>
</PictureScaleType>
</PictureProperty>
<AlarmDataSource>
<MaterialNo>
</MaterialNo>
<Name>
</Name>
<Address>
</Address>
</AlarmDataSource>
<ConferenceParam>

<backPicId>
</backPicId>
<Title>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
middle
</alignType>
</Title>
<VoiceBroadcast>
<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
test
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
<enabled>
</enabled>
<inLibWord>
</inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<ShowInfo>
<row>
</row>
<column>
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>
<nameEnabled>
</nameEnabled>
</inLib>
</ShowInfo>
<ModuleInfoList>
<ModuleInfo>
<moduleType>
conferenceTime
</moduleType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
</alignType>
<CustomKey>
<key>
</key>
</CustomKey>
</ModuleInfo>
</ModuleInfo>
</ModuleInfoList>
<conferenceStatus>
</conferenceStatus>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ConferenceParam>
<CallBtn>
<backPicId>
</backPicId>
</CallBtn>
<OpenDoorBtn>
<backPicId>
</backPicId>
</OpenDoorBtn>
<QRCodeBtn>
<backPicId>
</backPicId>
</QRCodeBtn>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>
<SubWindow>
<subWindowType>
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</SubWindow>
</SubWindowList>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>
<SubWindow>
<subWindowType>
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
</fontStyle>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<facePicID>
</facePicID>
</SubWindow>
</SubWindowList>
<StatusBar>

<backPicId>
</backPicId>
<statusBarType>
</statusBarType>
<SubStatusList>
<SubStatus>
<statusType>
</statusType>
<enabled>
</enabled>
</SubStatus>
</SubStatusList>
</StatusBar>
</Windows>
</WindowsList>
</Page>
</PageList>
<programSize>
1
</programSize>
<programLength>
</programLength>
<coordinateType>
uniformCoordinate
</coordinateType>
<screenType>
first
</screenType>
<audioEnabled>
</audioEnabled>
<PageIdList>
<PageId>
<id>
</id>
</PageId>
</PageIdList>
<programUUID>
</programUUID>
</Program>
21.40.4 Get all programs' parameters
Request URL
GET /ISAPI/Publish/ProgramMgr/program
Query Parameter
None
Request Message
None
Response Message
<ProgramList xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">


<Program>

<id>
</id>
<programName>
test
</programName>
<programRemarks>
test
</programRemarks>
<shareProperty>
public
</shareProperty>
<approveState>
approved
</approveState>
<approveRemarks>
</approveRemarks>
<programType>
normal
</programType>
<orgNo>
</orgNo>
<Resolution>

<resolutionName>
test
</resolutionName>
<imageWidth>
1
</imageWidth>
<imageHeight>
1
</imageHeight>
</Resolution>
<PageList>

<Page>
<id>
</id>
<PageBasicInfo>
<pageName>
</pageName>
<BackgroundColor>
<RGB>
</RGB>
</BackgroundColor>
<playDurationMode>
selfDefine
</playDurationMode>
<playDuration>
</playDuration>
<playCount>
1
</playCount>
<switchDuration>
1
</switchDuration>
<switchEffect>
none
</switchEffect>
</switchEffect>
<backgroundPic>
</backgroundPic>
<SignInCfg>
<VoiceBroadcast>
<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>
<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<SignCartoon>
<signCartoonSpeed>
</signCartoonSpeed>
</SignCartoon>
<enabled>
</enabled>
<threshold>
0.000
</threshold>
</SignInCfg>
</PageBasicInfo>
<characterMode>
mode1
</characterMode>
<WindowsList>
<Windows>
<id>
</id>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<CornerRadius>
<TopLeft>
</TopLeft>
<TopRight>
</TopRight>
<BottomLeft>
</BottomLeft>
<BottomRight>
</BottomRight>
</CornerRadius>
<layerNo>
<layerNo>
1
</layerNo>
<WinMaterialInfo>
<materialType>
picture
<dynamicType>
web
</dynamicType>
<otherType>
clock
</otherType>
</WinMaterialInfo>
<TouchProperty>
<windType>
popup
</windType>
<hyperlinkType>
window
</hyperlinkType>
<windowId>
</windowId>
<pageId>
</pageId>
</TouchProperty>
<PlayItemList>

<PlayItem>
<id>
</id>
<materialNo>
</materialNo>
<inputChannel>
</inputChannel>
<playEffect>
none
</playEffect>
<MarqueeInfo>
<scrollType>
none
</scrollType>
<scrollDeriction>
none
</scrollDeriction>
<scrollSpeed>
</scrollSpeed>
</MarqueeInfo>
<PlayDuration>

<durationType>
selfDefine
</durationType>
<duration>
1
</duration>
</PlayDuration>
<CharactersEffect>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
</backgroundType>
<backPicId>
</backPicId>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backTransparent>
<backTransparent>
1
</backTransparent>
<subtitlesEnabled>
</subtitlesEnabled>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
</scrollSpeed>
</CharactersEffect>
<switchEffect>
random
</switchEffect>
<pageTime>
1
</pageTime>
<scrollSpeed>
1
</scrollSpeed>
<scaleType>
</scaleType>
<playType>
</playType>
</PlayItem>
</PlayItemList>
<enabledAudio>
</enabledAudio>
<enableHide>
</enableHide>
<enableLock>
</enableLock>
<AppWindow>
<WindowInfoList>

<WindowInfo>
<id>
</id>
<materialNo>
</materialNo>
</WindowInfo>
</WindowInfoList>
</AppWindow>
<DataSource>

<materialNo>
</materialNo>
</DataSource>
<Call>
<materialNo>
</materialNo>
<tableRow>
</tableRow>
<tableColumn>
</tableColumn>
<tableDirection>
vertical
</tableDirection>
<tableType>
</tableType>
<backPicId>
</backPicId>
<alignType>
left
</alignType>
<refreshDirection>
upTodown
</refreshDirection>
<HeadDataList>
<HeadData>
<id>
</id>
<data>
<data>
test
</data>
</HeadData>
</HeadDataList>
<ItemStyleList>
<ItemStyle>
<id>
</id>
<width>
</width>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ItemStyle>
</ItemStyleList>
</Call>
<DynamicPic>
<materialNo>
</materialNo>
<backPicId>
</backPicId>
</DynamicPic>
<CapturePic>
<backPicId>
</backPicId>
<ipcMaterialNo>
</ipcMaterialNo>
<cancelType>
manual
</cancelType>
<duration>
1
</duration>
</CapturePic>
<ClockParam>
<backPicId>
</backPicId>
<ClockIcon>
<enabled>
</enabled>
<type>
</type>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</ClockIcon>
<YmdParam>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</YmdParam>
<HmsParam>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</HmsParam>
<WeekParam>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeekParam>
</ClockParam>
<WeatherParam>
<backPicId>
</backPicId>
<WeatherIcon>
<enabled>
</enabled>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherIcon>
<Date>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Date>
<Temperature>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Temperature>
<WeatherContent>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</WeatherContent>
<City>
<enabled>
</enabled>
<cityId>
</cityId>
<cityName>
test
</cityName>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
<width>
</width>
</Position>
</City>
<Humidity>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Humidity>
<AirQuality>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</AirQuality>
<UpdateTime>
<enabled>
</enabled>
<refreshTime>
20200826T051500+08
</refreshTime>
<updateInterval>
1
</updateInterval>
<fontSize>
</fontSize>
<FontColor>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</UpdateTime>
<Wind>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</Wind>
</WeatherParam>
<Countdown>
<endTime>
20200826T051500+08
</endTime>
<template>
template1
</template>
<timeUnit>
year
</timeUnit>
<backPicId>
</backPicId>
<TimeFontCfg>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
->
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</TimeFontCfg>
<timeUnitEnabled>
</timeUnitEnabled>
</Countdown>
<localInputNo>
VGA
</localInputNo>
<HyperlinkBtn>
<backPicId>
</backPicId>
</HyperlinkBtn>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<backgroundType>
</backgroundType>
<BackColor>
<RGB>
</RGB>
<fillEnabled>
</fillEnabled>
</BackColor>
<backTransparent>
</backTransparent>
<alignType>
middle
</alignType>
<verticaAlignType>
</verticaAlignType>
<characterContent>
</characterContent>
<backPicId>
</backPicId>
<characterStyle>
</characterStyle>
<characterType>
</characterType>
<scrollDirection>
left
</scrollDirection>
<scrollSpeed>
</scrollSpeed>
<SignIn>
<backPicId>
</backPicId>
<ShowInfo>
<row>
</row>
<column>
</column>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>
<nameEnabled>
</nameEnabled>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</inLib>
<outLib>
<nameEnabled>
</nameEnabled>
<name>
</name>
<genderEnabled>
</genderEnabled>
<signInTimeEnabled>
</outLib>
<showDuration>
</showDuration>
</ShowInfo>
<MainTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<text>
</text>
</MainTitle>
<SubTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<text>
</text>
</SubTitle>
<NormalTemperature>
<PeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>
<PeopleNumber>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
<text>
</text>
</PeopleNumber>
<Icon>
<enabled>
</enabled>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</Icon>
</SignIn>
<EventParam>
<EventResourceList>
<EventResource>
<ipVersion>
v4
</ipVersion>
<ipAddress>
</ipAddress>
<ipv6Address>
</ipv6Address>
<portNo>
</portNo>
<userName>
test
</userName>
<passWord>
test
</passWord>
<BindIPC>
1,2
</BindIPC>
</EventResource>
<backPicId>
</backPicId>
<Title>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Title>
<PeopleCounting>
<maxPeopleNumber>
</maxPeopleNumber>
<Prompt>

<enabled>
</enabled>
<fontSize>
</fontSize>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<FontColor>
<RGB>
</RGB>
</FontColor>
<unavailableText>
</unavailableText>
<RGB>
</RGB>
</Prompt>
<PeopleIcon>
<enabled>
</enabled>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</PeopleIcon>
<InsidePeopleTitle>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<Position>

<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<FontColor>
<RGB>
</RGB>
</FontColor>
<RGB>
</RGB>
<enabled>
</enabled>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</PeopleCounting>
<Mask>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
</height>
<width>
</width>
</Position>
<text>
</text>
<MaskIcon>
<enabled>
</enabled>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</MaskIcon>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</Mask>
<Temperature>
<Prompt>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<text>
</text>
</Prompt>
<TemperatureIcon>
<enabled>
</enabled>
<Position>
resolution-->
<positionX>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<materialNo>
</materialNo>
</TemperatureIcon>
<AudioAlarm>
<enabled>
</enabled>
<materialNo>
</materialNo>
</AudioAlarm>
</Temperature>
</EventParam>
<PictureProperty>
<PictureScaleType>
</PictureScaleType>
</PictureProperty>
<AlarmDataSource>
<MaterialNo>
</MaterialNo>
<Name>
</Name>
<Address>
</Address>
</AlarmDataSource>
<ConferenceParam>

<backPicId>
</backPicId>
<Title>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
</alignType>
</Title>
<VoiceBroadcast>
<enabled>
</enabled>
<broadcastSpeed>
</broadcastSpeed>
<inLibVoice>
</inLibVoice>
<outLibVoice>
</outLibVoice>
</VoiceBroadcast>
<WelcomeWord>

<enabled>
</enabled>
<inLibWord>
</inLibWord>
<outLibWord>
</outLibWord>
</WelcomeWord>
<ShowInfo>
<row>
</row>
<column>
</column>
<Position>
->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<inLib>
<nameEnabled>
</nameEnabled>
</inLib>
</ShowInfo>
<ModuleInfoList>
<ModuleInfo>
<moduleType>
conferenceTime
</moduleType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<FontColor>
<RGB>
</RGB>
</FontColor>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<Position>
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<alignType>
</alignType>
<CustomKey>
<key>
</key>
</CustomKey>
</ModuleInfo>
</ModuleInfoList>
<conferenceStatus>
</conferenceStatus>
<BackColor>
<RGB>
</RGB>
</BackColor>
</ConferenceParam>
<CallBtn>
<backPicId>
</backPicId>
</CallBtn>
<OpenDoorBtn>
<backPicId>
</backPicId>
</OpenDoorBtn>
<QRCodeBtn>
<backPicId>
</backPicId>
</QRCodeBtn>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>
<SubWindow>
<subWindowType>
temperature
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
bold,italic,underline,strikeout
</fontStyle>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
</SubWindow>
</SubWindowList>
<BackColor>
<RGB>
</RGB>
</BackColor>
<backPicId>
</backPicId>
<SubWindowList>
<SubWindow>
<subWindowType>
temperature
</subWindowType>
<enabled>
</enabled>
<fontSize>
</fontSize>
<fontColor>
</fontColor>
<fontStyle>
bold,italic,underline,strikeout
</fontStyle>
<Position>
resolution-->
<positionX>
</positionX>
<positionY>
</positionY>
<height>
</height>
<width>
</width>
</Position>
<facePicID>
</facePicID>
</SubWindow>
</SubWindowList>
<StatusBar>

<backPicId>
</backPicId>
<statusBarType>
</statusBarType>
<SubStatusList>
<SubStatus>
<statusType>
</statusType>
<enabled>
</enabled>
</SubStatus>
</SubStatusList>
</StatusBar>
</Windows>
</WindowsList>
</Page>
</PageList>
<programSize>
1
1
</programSize>
<programLength>
</programLength>
<coordinateType>
uniformCoordinate
</coordinateType>
<screenType>
first
</screenType>
<audioEnabled>
</audioEnabled>
<PageIdList>
<PageId>

<id>
1
</id>
</PageId>
</PageIdList>
</Program>
</ProgramList>
21.40.5 Delete a specific program

Request URL
DELETE /ISAPI/Publish/ProgramMgr/program/<programID>
Query Parameter
programID string --
Request Message
None
Response Message

<requestURL>
</requestURL>
<statusCode>
</statusCode>
<statusString>
</statusString>
<subStatusCode>
</subStatusCode>
</ResponseStatus>

ISAPI Developer Guide - Access Control - Face Recognition Terminals - 2022!07!01

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

ISAPI Developer Guide - Access Control - Face Recognition Terminals - 2022!07!01

Uploaded by

Copyright:

Available Formats

TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE DOCUMENT IS PROVIDED "AS IS" AND "WITH ALL

1.2 Product Scope

1.3 Terms And Definitions

1.3.2 Person Type

1.3.3 Credential Type

1.3.4 EZVIZ Cloud Storage

1.3.7 Listening Host

1.3.8 Person-Based Access Control

1.4 Symbols And Acronyms

1.5 Update History

4.3 Security Mechanism

4.3.1.1 C/C++ (libcurl)

char* pData = (char*)buffer;

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

4.3.1.3 Java (HttpClient)

4.3.1.4 Python (requests)

# - *- coding: utf-8 -*-

4.3.2 User Permission

4.3.3 Stream Encryption

4.5 Message Parsing

4.5.1.3 Binary Data

4.5.1.4 Form (multipart/form-data)

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

Key annotations are shown in the table below.

4.5.3 Capability Set

4.5.4 Time Format

YYYY = the year consisting of four decimal digits

4.5.5 Character Set

4.5.6 Error Processing

HTTP/1.1 403 Forbidden

4.6 Event Uploading

5.2 API Calling Flow

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

5.3 Exception Handling

6 EZVIZ Access Services

6.2 API Calling Flow

7 EZVIZ Storage Configuration

1. Get the capability of configuring EZVIZ access services: GET /ISAPI/System/Network/EZVIZ/capabilities . If

2. Get the capability of configuring EZVIZ storage services: GET

5. Configure the parameters of EZVIZ storage service: PUT /ISAPI/System/Network/EZVIZ/cloudStorage?

6. Configuring the parameters of EZVIZ storage service is not supported currently.

8.2 API Calling Flow

1. Get the capability of configuring EZVIZ access services: GET /ISAPI/System/Network/EZVIZ/capabilities . If

9.2 API Calling Flow

2. Get the capability of checking the statistics of videos: GET

3. Get the statistics of videos: POST /ISAPI/System/Network/EZVIZ/cloudStorage/recordsSubscribe/statistics?

10.2 API Calling Flow

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

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

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

3. Enable the listening service:

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

10.2.2 Event Message Grammar

POST Request_URI HTTP/1.1

Response by the Listening Host

2. With Binary Data

POST Request_URI HTTP/1.1

Response by the Listening Host

Here are the descriptions of the main keywords.

10.3 Exception Handling

11.2 API Calling Flow

12 Device Peripherals Upgrade

# - - coding: utf-8 --