0% found this document useful (0 votes)

109 views

Defense HTTP and MQ API (V7.02.003)

Uploaded by

pedro.mouraodiv

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

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

109 views

Defense HTTP and MQ API (V7.02.003)

Uploaded by

pedro.mouraodiv

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

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 495

1、Development Guide

1.1、General Introduction

Overall structure

The platform provides a function set including authentication, device tree, video, access,
transportation, attendance management, face recognition and visible intercom business, and
interacts with HTTP, MQ and RTSP protocols. HTTP protocol is used for accessing REST interface
provided on platform. Operation control and platform resource access can be required by REST
interface. MQ protocol is used for subscribing and receiving message on the platform. RTSP
protocol is used for accessing audio and video data on the platform. Overall structure chart:

Development preparation

• Get platform installation package and install the platform

according to the manual. After successful installation,
configure an account and import License file.
• Add front-end device to the platform to ensure there are
accessible front-end coding and decoding resources on the
platform.
• Select HTTP and HTTPS: The platform provides HTTP
(plaintext) and HTTPS (encrypted) access modes. Default
access ports of HTTP and HTTPS are port 80 and port 443
respectively. HTTP is recommended at the development and
commissioning stage to position question. HTTPS is
recommended in actual operation to ensure safe access to
the platform.
• Select proper development language to realize interaction
with HTTP, MQ and RTSP protocols. Take player component
into consideration to realize function of video playing.

Basic concept

• Session: A session is generated after a client is authenticated on the platform. In the

session, the client could request permitted resources and receive MQ push messages
on the platform. The platform deletes the session in case of keep-alive timeout or
authentication being canceled initiatively.
• Department: The platform has a root department. Departments and devices can be
mounted under the root department. Departments and devices also can be carried
under an department. The department structure can be defined according the actual
hierarchical relation on the site.
• Device: A real physical device. The platform supports encoder, decoder and other
devices of Intelbras. The platform gets audio and video resources, alarm detection and
other resources via access service and streaming media service.
• Unit: Divide a device into multiple units according to capability provided. Common unit
types include coding unit, decoding unit, alarm input unit and alarm output unit. A
device includes multiple units.
• Channel: There are multiple channels under a unit. A
channel is a smallest unit to provide data. For example, a
coding channel can output video streaming data and an
alarm channel can detect and output alarm information. A
unit has multiple channels, while the channel type and the
unit type are consistent.

1.2、Development Guide

Authentication keep-alive

Before accessing platform resources, call the authentication interface

(/admin/API/accounts/authorize) to get the authentication of the platform. After successful
authentication, save the returned token value and userId. Use the token and userId for
subsequent MQ subscription and RTSP interface calling. When calling other REST interfaces, put
token value in the X-Subject-Token field at HTTP head, otherwise verification might fail, causing
invocation interface return failed. Regularly keep alive for calling keep-alive interfaces
(/admin/API/accounts/updateToken). If no keep-alive actions take place within a period, the
platform detects keep-alive timeout and the corresponding token value becomes invalid.

MQ notice
Get IP and port connecting MQ by getting MQ configuration
(admin/API/BRM/Config/GetMqConfig) interface. Connect MQ service via activeMQ. At present,
there are 3 topics to be subscribed on the platform:

Theme Subscription format

Alarm topic mq.alarm.msg.topic.{UserId}
Public topic mq.common.msg.topic
Event topic mq.event.msg.topic.{UserId}

UserId is authentication interface return. If UserId is 1, subscribe this topic:

Theme Subscription format

Alarm topic mq.alarm.msg.topic.1
Public topic mq.common.msg.topic
Event topic mq.event.msg.topic.1

Message pushed by MQ is in the format of Json. Refer to MQ message for detail format.

Department tree

Call device department tree interface (/admin/API/tree/deviceOrg) and device list interface
(/admin/API/tree/devices) to get department structure and device information. Every device and
channel has a unique code by which data could be assembled and a device tree generated.
Subsequent operations on device and channel are achieved by requesting to the platform via
device code and channel code on the device tree.

Real-time video

Use code channel on the device tree to request real-time video. Get stream data by RTSP
protocol after getting the real-time video URL. The platform supports private stream and
standard stream. Request private stream and standard stream by assembling different RTSP
formats. Intelbras player can play private stream. You can access Intelbras player from Intelbras
official website. It adopts C interface and the dynamic library (dll) for loading. Intelbras player
also can play standard stream. Or you can select a open source library to decode and play it.

Record playback

Platform record: Configure platform storage. The device can be offline for platform record
Search and playback. Device record: Device record should be stored in device. The device must
be online for device record search and playback. The platform supports private stream and
standard stream. Request private stream and standard stream by assembling different RTSP
formats. Intelbras player can play private stream. You can access Intelbras player from Intelbras
official website. It adopts C interface and the dynamic library (dll) for loading. Intelbras player
also can play standard stream. Or you can select a open source library to decode and play it.
1.3、FAQ

Interface returns 401

Token value of X-Subject-Toekn at http head of request message is invalid. Interface returns
401 error code. Packet capture shown as below:

POST /admin/API/MTS/Video/StartVideo HTTP/1.1

Content-type: application/json
X-Subject-Token:
Content-Length: 256
Host: 10.35.93.19:80
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_65)
Accept-Encoding: gzip,deflate

{"clientType":"WINPC","clientMac":"","clientPushId":"","project":"PSD
K","method":"MTS.Video.StartVideo","data":{"streamType":"1","optional
":"/admin/API/MTS/Video/StartVideo?","trackId":"","extend":"","channe
lId":"1000001$1$0$0","planId":"","dataType":"2"}}

HTTP/1.1 401 Unauthorized

Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=CAF98CE25740B7867A4FFC9078CD10FA; Path=/admin;
HttpOnly
Content-Type: application/json;charset=utf-8
Content-Length: 66
Date: Wed, 23 Jan 2019 03:36:22 GMT

{"realm":"DSS","randomKey":"d14a801f91594873","encryptType":"MD5"}

Interface returns 415

Content-type field at http head is not set as application/json. Interface returns 415 error code.
Packet capture as shown below:

POST /admin/API/MTS/Video/StartVideo HTTP/1.1

X-Subject-Token: 0574987f9cf54f5a8a41a8ae22ae8e57
Content-Length: 288
Content-Type: text/plain; charset=ISO-8859-1
Host: 10.35.93.19:80
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_65)
Accept-Encoding: gzip,deflate

{"clientType":"WINPC","clientMac":"","clientPushId":"","project":"PSD
K","method":"MTS.Video.StartVideo","data":{"streamType":"1","optional
":"/admin/API/MTS/Video/StartVideo?0574987f9cf54f5a8a41a8ae22ae8e57",
"trackId":"","extend":"","channelId":"1000001$1$0$0","planId":"","dat
aType":"2"}}

HTTP/1.1 415 Unsupported Media Type

Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=3FEB4F516B136F900B7A8CED64B81484; Path=/admin;
HttpOnly
Content-Type: text/html;charset=utf-8
Content-Language: en
Content-Length: 1048
Date: Wed, 23 Jan 2019 03:46:04 GMT

HTTP Status 415 -

type Status report

message

description The server refused this request because the request entity is in a format not supported by
the requested resource for the requested method.

Apache Tomcat/7.0.85

1.4、Error code

Error
Error Message
code
409 No permission
413 Request entity too large
500 Internal error
520 Server error
1004 The parameter is illegal.
1005 The name already exist.
1006 more than the max limit num.
1007 the data not exist
Error
Error Message
code
1008 the task was not finish
1101 The nonce is illegal.
1103 The user is not authorized.
1104 No permission to access.
2001 Incorrect username or password.
2002 The user has been locked
2003 The user has been disabled
2004 The user has logged in.
2005 The user is forbidden to login at the current date
2006 The user is forbidden to login at the current time
2007 The file name can not be null
2008 The old password can not be null
2009 The new password can not be null
2010 The user does not exist
2011 The password can not be same with default password
2012 The subject can not be null
2013 The user(s) can not be null
2014 The video(s) can not be null
2015 The device code can not be null
2016 The device does not exist
2017 The channel(s) can not be null
2018 The channel id is not valid
2019 The tv wall id must be a unsigned long integer
2020 The task id must be a unsigned long integer
2021 The task name can not be null
2022 The task does not exist
2023 The tv wall does not exist
2024 The tag id must be a unsigned long integer
2025 The record source must be a unsigned integer
2026 The subject can not be null
2027 The tag time must be a unsigned long integer
2028 The start time must be a unsigned long integer
2029 The end time must be a unsigned long integer
2030 The cruise id must be a unsigned long integer
2031 The cruise data can not be null
2032 The cruise does not exist
2033 The caller can not be null
2034 The callee can not be null
2035 The duration must be a unsigned long integer
Error
Error Message
code
2036 The status must be a unsigned integer
2037 The call time must be a unsigned long integer
2038 The operate type must be a unsigned integer
2039 The operate time must be a unsigned long integer
2040 The service type must be a unsigned integer
2041 The device or service does not exist
2042 The talk type must be a unsigned integer
2043 The talk type does not support
2044 The channel seq must be a unsigned integer
2045 The broadcast channels can not be null
2046 The audio type must be a unsigned integer
2047 The talk mode must be a unsigned integer
2048 The audio bit must be a unsigned integer
2049 The sample rate must be a unsigned integer
2050 The record type must be a unsigned integer
2051 The audio session can not be null
2052 The device is at talking
2053 You are requesting talking, please wait for last response
2054 The data type must be a unsigned integer
2055 The data type does not support
2056 The stream type must be a unsigned integer
2057 The stream type does not support
2058 The disk id can not be null
2059 The stream id must be a unsigned long integer
2060 The stream id does not exist
2061 The alarm id must be a unsigned long integer
2062 The alarm status must be a unsigned integer
2063 The record month can not be null
2064 The record duration must be a unsigned long integer
2065 The alarm code can not be null
2066 The record source does not support
2067 The record type does not support
2068 The alarm does not exist
2069 The user id must be a unsigned long integer
2070 The channel(s) can not be null
2071 The id(s) can not be null
2072 The id must be a unsigned long integer
2073 The record lock info does not exist
2074 The operate type does not support
Error
Error Message
code
2075 The lock time must be a unsigned long integer
2076 The command must be a unsigned integer
2077 The direct must be a unsigned integer
2078 The point x must be a integer
2079 The point y must be a integer
2080 The point z must be a integer
2081 The step x must be a unsigned integer
2082 The step y must be a unsigned integer
2083 The handle user can not be null
2084 The user has no authorization.
2085 The PTZ zoom must be a float
2086 The PTZ focus must be a float
2087 The point code can not be null
2088 The point name can not be null
2089 The value of page info can not be null
2090 The value of page size can not be null
2091 The value of order info can not be null
2092 The alarm status must be a unsigned integer
2093 The alarm type must be a unsigned integer
2094 The alarm grade must be a unsigned integer
2095 The handle status must be a unsigned integer
2096 The alarm start time must be a unsigned long integer
2097 The alarm end time must be a unsigned long integer
2098 The handle start time must be a unsigned long integer
2099 The handle end time must be a unsigned long integer
2100 The page number must be a unsigned integer
2101 The page size must be a unsigned integer
2102 The order type must be a unsigned integer
2103 The handle status can not be null
2104 The matrix id can not be null
2105 The operate type can not be null
2106 The tv index can not be null
2107 The tv index must be a unsigned integer
2108 The screen index can not be null
2109 The screen index must be a unsigned integer
2110 The subTv index can not be null
2111 The subTv index must be a unsigned integer
2112 The split num can not be null
2113 The split num must be a unsigned integer
Error
Error Message
code
2114 The tvWall id can not be null
2115 The tvWall id must be a unsigned integer
2116 The value of position info can not be null
2117 The left can not be null
2118 The top can not be null
2119 The width can not be null
2120 The height can not be null
2121 The tv type can not be null
2122 The tv type must be a unsigned integer
2123 The alarm level can not be null
2124 The alarm level must be a unsigned integer
2125 The order can not be null
2126 The order must be a unsigned integer
2127 The child window can not be null
2128 The child window must be a integer
2129 The email is not valid
2130 The command does not support
2131 The alarm process does not exist
2132 The user role does not exist
2133 The user does not have permissions of the channel
2134 The user does not have permissions of the device
2135 The mail recipient can not be null
2136 The mail message can not be null
2137 The number of messages has reached an upper limit
2138 The target must be a unsigned integer
2139 The alarm source can not be null
2140 The duration must be a positive integer
2141 The azimuth must be a digit
2142 The data type can not be null
2143 The data name can not be null
2144 The data does not exist
2145 The window info does not exist
2146 The screen type can not be null
2147 The screen type must be a unsigned integer
2148 The left must be a unsigned float
2149 The top must be a unsigned float
2150 The width must be a unsigned float
2151 The height must be a unsigned float
2152 The window id can not be null
Error
Error Message
code
2153 The window id must be a unsigned Integer
2154 The input data can not be null
2155 The mac address is forbidden
2156 The domain authentication center is forbidden
2157 The value of handle message data too long
2158 The session can not be null.
2159 The type must be a unsigned integer.
2160 The type does not support.
2161 The ivs face device is offline.
2162 The image data can not be null.
2163 The person name can not be null.
2164 The person type must be a positive integer.
2165 The person gender must be a positive integer.
2166 The ss id must not be null.
2168 Only default password
2169 The system undo init.
2170 The system finished init.
2171 The repository more than maximum number x.
2172 The person more than a repository maximum number x.
2173 The person more than maximum number x.
2174 The person type more than maximum number x.
2175 The person type already exists.
2176 The person type has been used, can not be removed.
2177 There are some person types has been used, can not be removed.
2178 Get current task failed from VMS
2179 The repository not enabled.
2180 The person image size more than maximum limit.
2181 The person image size more than minimum limit.
2182 The request info is null.
2183 The face repository search xo is null.
2184 The face repository id is null or zero.
2185 The face repository xo is null.
2186 The face repository name is empty.
2187 The face repository color is empty.
2188 The face person search xo is null.
2189 The face person id is null or zero.
2190 The face person xo is null.
2191 The face person name is empty
2192 The face person gender is empty
Error
Error Message
code
2193 The face person type is empty.
2194 The face person type less than zero or equals to zero
2195 The face image data is empty
2196 The face person type xo is null.
2197 The face person type name is empty.
2198 The face person type id is empty.
2199 The face application data is empty.
2200 The face application search xo is null.
2201 The face control xo is null.
2202 The face control channel info is null.
2203 The face control channel info of id is error.
2204 The face control channel info of similarity is error.
2205 The face repository name already exists.
2206 Mail service has not been opened
2207 The face repository not exist.
2208 The face excel not exist.
2212 The file format must be zip, rar, 7z .
2213 The repository has been used, can not be removed.
2214 There are some repositories has been used, can not be removed.
2215 The face device not support.
2216 The face person id already exists.
2217 The person more than maximum number x.
2218 The user has been locked, because of system update.
2219 The domain ip and port and login user repeat.
2220 The domain name repeat.
2221 The domain is not exist.
2222 The domain can not found.
2223 The domain not enabled.
2224 The face repository is being operated, please try again later.
2225 The domain more than max number.
2226 The domain more than license limit
2227 The user does not have permissions of the slave channel
2228 The master-slave track config is empty
2229 Device delete face repository failed.
2230 the slave channel not exist.
2231 device not support master slave track config.
2232 The page mode must be a unsigned integer.
2233 The last id must be a unsigned integer.
2234 The lens type must be a unsigned integer.
Error
Error Message
code
2235 The system is busy. Please try again later.
2236 The face detection interrupt.
3000 The communication has an error or is timeout
3001 The MTS server is not ready.
3002 The SS server is not ready.
3003 The DMS server is not ready.
3004 The VMS server is not ready.
3005 The PTS server is not ready.
3028 other device is upgrade now!
3029 the device is offline
3030 the device is not door, unable to upgrade
3031 the screen have plan,unable to change
3032 illegal char
3099 The Domain server is not ready.
3100 The service work has an error or is false
3101 The service data has an error or is false
3111 The face server is not ready.
3112 The communication not has response.
3113 The communication has an error.
3201 Record Plan is running
3202 Not match audio type.
3203 Not found available disk
3204 Not found capability
3206 The userType not user clientType.
3207 The search user status must be in -1, 0, 1.
5000 The item type can not be null.
6000 Parameter should be unsignedInteger
6001 Parameter can not be null
6002 UserName can not be null
6003 Password can not be null
6004 User name exist
6005 role name exist
6006 Timetemplate name exist
6007 TimeTemplateName null
6008 new password can not be null
6009 old password can not be null
6010 the randomKey's cache is out of time or removed
6011 the randomKey can not be null
6012 LanPath can not be null
Error
Error Message
code
6013 backup file does not exists
6014 the new password can not be same with original password
6015 restore file path can not be null
6016 restore file does not exists
6017 email address repeats
6018 can not delete or update system user
6019 can not delete or update user,do not have privilege
6020 export file must be xls or csv or txt
6021 current user can not update another user
6022 user ids can not be null
6023 alarm source channel id can not be null
6024 the answers's length must be three.
6025 The encrypt password can not be bull
6026 The auto backup type can not be bull
6027 The auto backup date can not be bull
6028 The auto backup time can not be bull
6029 The decrypt password can not be bull
6030 The manual restore file content not be bull
6031 The alarm keeping info should be unsignedInteger
6032 The log keeping info should be unsignedInteger
6033 The heatmap keeping info should be unsignedInteger
6034 The timesync starting time can not be null
6035 The send email address is illegal
6036 The recipient email address is illegal
6037 The current timeTemplate is occupied by others
6038 The source channel id can not be null.
6039 The target channel id can not be null.
6040 The database does not exist from channel info
6041 Can not delete online user
6044 current user can not operate system service!
6045 Device ip and port repeat
6046 Device not exists
6047 Device password is incorrect
6048 Device login name is incorrect
6049 Device login timeout
6050 Account already login
6051 Account locked
6052 Account are blacklisted
6053 Resource insufficient
Error
Error Message
code
6054 Child connection fail
6055 Main connection fail
6056 Connections exceed
6057 The device password or login name is incorrect
6058 RecordScheduleName null!
6059 RecordScheduleName repeats!
6060 Delete iscsi failed,Check that server task!
6071 Disk group has configured group quota, cannot set picture type!
6072 The IP address is illegal!
6073 The port number is illegal!
6074 The port number has been occupied!
6075 The virtual disk capacity should be between 10 and 16384!
6076 The orgName must not be null
6077 The organization exsit
6078 The organization orgCode is NULL
6079 can not be deleted
6080 The devicegroup forbidden delete
6083 Organization has been changed, please refresh the page.
6089 Incorrect user password
6091 Device discovery cache expired.
6092 Unknown error.
6093 Service type not exists.
6094 Service not register.
6096 Service bad request.
6097 Can not connect to P2P server.
P2P server response empty, device may be not register to p2p
6098
server.
6099 failed to invoke obms.
6101 Import file parse error
6102 Import file data is illegal
6103 Building enable closed is not support
The device is a member of a device group or management group
6106
and is not allowed to delete
The user is a member of a intercom management group and is not
6107
allowed to delete
6108 The number of encoder channels exceeds license limit
6109 The number of access control exceeds license limit
6110 The number of access control channels exceeds license limit
6111 The number of VTO exceeds license limit
6112 The number of SIP ID exceeds license limit
Error
Error Message
code
6113 The number of alarm host exceeds license limit
6114 The number of defence area exceeds license limit
6115 The number of entrance and exit exceeds license limit
6116 The number of face detect exceeds license limit
6117 The number of Client connections exceeds license limit
6120 Failed to fetch device channel info from SOSO
6121 Door is in use
6123 the user has not the module rights
6124 This record was not found
6126 The alarm source code has a alarm plan
6133 The license has expired and you cannot login
The backup file does not match the current DSS version and cannot
6135
be restored
6136 Device type is illegal
6138 The number of Onvif channels exceeds license limit
6139 Disallow building disabled while unit is enabled
6140 The number of attendance terminals exceeds license limit
6141 The device channel has been distributed to the repository
6146 The number of registered VDP APP users exceeds license limit
6153 The residence scenario is not configured
6155 The residence scenario is not supported by platform
The window has been configured link video wall and cannot be
6156
delete
6159 The task of extract acs record is running, please try later.
6160 The number of P2P channels exceeds license limit.
7000 Authentication failed
7001 The card person's id can not be null
7002 The card person's id is exists
7003 The anti-passback'name is exists
7004 The inter-lock'name is exists
7006 The door group does not exist
7007 The department has persons,can not be delete
7008 The department is exists
7009 The department has child node,can not be delete
7010 The door group has rights, can not be delete
8000 Device group name has already existed
8001 Manager group name has already existed
AccessControl support one rule, AccessCentralControl support three
8017
rule
8018 The person has first card info
Error
Error Message
code
8019 The person has anti-passback info
8023 The person group has multicard info
This device group is a member of a relation group and is not
8024
allowed to delete
This management group is a member of a relation group and is not
8025
allowed to delete
8042 The card num is exist
8043 The person has person group info
8044 The inputing parameter is illegal
8045 The person has card rights,must have card number
8046 The parameter must be integer
8049 Import person info is null
8050 Parameter is null
8053 The shift name already exists.
8056 The period name already exists.
8058 Attendance shift is being used.
8059 Attendance period is being used.
8060 The user has no permissions of video intercom
8061 Search license information error
8064 The householder is exists
8066 The person already exist in person group
8067 The extract task has not finished
10001 The parkingLotName is Empty!
10002 The idleLot is more than totalLot!
10003 The parkingLotName is already exists!
10004 The carNo. is already exists or repeat!
10005 The device is not exists or deleted!
10006 The device is offLine!
10007 The time is not in timeTemplate!
10008 The parkingLot config error!
10009 Illegal alarm info!
10010 The cardNUm is not exists!
20002 edit model exception
20003 delete model exception
20004 modelName exists
20005 model label exists,delete fail
20007 label index exists
20008 label name exists
20009 save label exception
20010 edit label exception
Error
Error Message
code
20011 delete label exception
20013 parameter error
20014 The image size is oversized
20015 turn to point exception

2、Business Process
2.1、Login authentication

Authentication

• Login authentication requires two authentications. The

first one takes the username, calculates the signature
value according to the encrypted information returned by
the platform, and then puts the calculated signature value
into the second authentication request. After successful
authentication, it is necessary to call the update token
interface for keeping alive within the keep-alive duration.

First authentication

-The username is required for the first authentication request. At this time, the platform returns
401 no-authority error code and carries encrypted information in the message body. The
encrypted information includes domain information (realm), random key and encryption type.
Currently, the encryption method only supports MD5. -The request process is as follows:

POST /admin/API/accounts/authorize HTTP/1.1

Host: 10.35.92.66
Connection: close
Content-Type: application/json;charset=UTF-8
Content-Length: 67

{
"userName" : "system",
"ipAddress": "",
"clientType": "WINPC"
}HTTP/1.1 401 Unauthorized
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=7994C0D4B07F194D0757882392DCC2C0; Path=/admin;
HttpOnly
Content-Type: application/json;charset=utf-8
Content-Length: 66
Date: Wed, 19 Dec 2018 08:41:58 GMT
Connection: close

{"realm":"DSS","randomKey":"9c2b603650f54bcb","encryptType":"MD5"}

Second authentication

• A signature is required for the second authentication

request. According to the username, password, domain
information (realm), random key and encryption method
(MD5), the signature is calculated as follows: Pseudo code
examples:

temp = md5(password)
temp = md5(userName + temp)
temp = md5(temp)
temp = md5(userName + ":" + realm + ":" + temp)
signature = md5(temp + ":" + randomKey)

• As shown in the above pseudo code, MD5 encryption is

required for five times, in which the parameters and
result values are both strings and the letters of MD5
encrypted result values are all in lowercase. The assumed
values are as follows:

Parameters Value
Parameters Value
userName "system"
password "admin123"
realm "DSS"
randomKey "9c2b603650f54bcb"

-The calculated values for each stage are as follows:

Times of
Parameters/Results Value
encryptions
1 Parameters "admin123"
1 Result "0192023a7bbd73250516f069df18b500"
2 Parameters "system0192023a7bbd73250516f069df18b500"
2 Result "5a0fdbe44b86807b5e5e127918bbc475"
3 Parameters "5a0fdbe44b86807b5e5e127918bbc475"
3 Result "1e27fadce9af09e120ab5142a83a679e"
4 Parameters "system:DSS:1e27fadce9af09e120ab5142a83a679e"
4 Result "675ae42820b189caa27d63b4b3264232"
5 Parameters "675ae42820b189caa27d63b4b3264232:9c2b603650
5 Result "7b6f728a6fa77e1ea5984afda8008e42"

-The request process is as follows:

POST /admin/API/accounts/authorize HTTP/1.1

Host: 10.35.92.66
Connection: close
Content-Type: application/json;charset=UTF-8
Content-Length: 186

{
"userName" : "system",
"randomKey": "9c2b603650f54bcb",
"mac": "",
"encryptType" : "MD5",
"ipAddress": "",
"signature": "7b6f728a6fa77e1ea5984afda8008e42",
"clientType": "WINPC"
}HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=042C68CF5399B1898DCFD78B35A90896; Path=/admin;
HttpOnly
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Date: Wed, 19 Dec 2018 08:41:58 GMT
Connection: close

{"duration":30,"token":"a0e5844699db4cf8a2f9afaae11becd4","userId":"1
","versionInfo":{"lastVersion":"1074472","updateUrl":"/admin/x86/Gene
ral_DSS-Express_Client-x86_V1.000.0000002.0.R.20181213.exe;/admin/x64
/General_DSS-Express_Client-x64_V1.000.0000002.0.R.20181213.exe"},"si
pNum":"8888881000"}

-After the second authentication is successful, the meaning of the field returned by the platform
is as follows: duration: Keep-alive duration. It is necessary to call the update token interface
(/admin/API/accounts/updateToken) for keeping alive during the keep-alive duration. token:
Token. In subsequent requests, the token needs to be placed in the request header and the field
name is X-Subject-Token. userId: User ID. VersionInfo: Client version and client download
address.

Update token

• After successful authentication, it is necessary to call

the update token interface for survival within the
survival duration. The keep-alive interval is suggested to
be 3/4 of the keep-alive duration. In the request to
update the token, a signature value needs to be carried in
the message body, and the signature value here needs to be
MD5 calculated according to the fourth calculation result
of the second authentication and the latest token value.
The first token value is the token returned when the
second authentication is successful, and the subsequent
token value is the one returned by the updatetoken. The
pseudo code is as follows:

signature = md5(temp + ":" + token)

-The assumed values are as follows:

Parameters Value
temp "675ae42820b189caa27d63b4b3264232"
token "a0e5844699db4cf8a2f9afaae11becd4"

-The calculated values are as follows:

Times of
Parameters/Results Value
encryptions
1 Parameters "675ae42820b189caa27d63b4b3264232:a0e5844699
1 Result "5bce0dc0059363e251a706a8b1b281a9"

-The request process is as follows:

POST /admin/API/accounts/updateToken HTTP/1.1
Host: 10.35.92.66
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: a0e5844699db4cf8a2f9afaae11becd4
Content-Length: 52

{
"signature": "5bce0dc0059363e251a706a8b1b281a9"
}HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=C778CC5FC4302D4C71DB10F7FF34391B; Path=/admin;
HttpOnly
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Wed, 19 Dec 2018 08:43:04 GMT
Connection: close

{"code":1000,"desc":"Success","data":{"token":"a0e5844699db4cf8a2f9af
aae11becd4","duration":30}}

The client needs to update the token value in the returned message to the local token value and
use the updated token value for subsequent calculations.

Note:

1. The platform will not check the signature brought in the

updateToken request, but there is no guarantee that no
check will be added subsequently. Therefore, it is
recommended to calculate according to the instructions in
the document.
2. The token of the current version is fixed, that is, the
token value returned in updatetoken is the same as that
returned in the second authentication. However, there is
no guarantee that it will not change, so it is recommended
to update with the token value returned by updatetoken.

Cancel authentication

When the client signs out, it needs to call the unauthorized interface. The message body of this
interface needs to bring the username and token.

-The request process is as follows:

POST /admin/API/accounts/unauthorize HTTP/1.1

Host: 10.35.92.66
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: a0e5844699db4cf8a2f9afaae11becd4
Content-Length: 71

{
"userName" : "system",
"token": "a0e5844699db4cf8a2f9afaae11becd4"
}HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Set-Cookie: JSESSIONID=EB3DEE86E1FD0DAAEADF89E19CD2B1C6; Path=/admin;
HttpOnly
Content-Type: application/json;charset=UTF-8
Transfer-Encoding: chunked
Date: Wed, 19 Dec 2018 08:43:17 GMT
Connection: close

{"code":1000,"desc":"Success"}

2.2、Device department tree

• The acquisition of the device department tree involves two

protocols: The device department tree
(/admin/API/tree/deviceorg) and device list
(/admin/API/tree/devices)
1. The device department tree can obtain the relative
relationships of all departments, devices and
channels.
2. The device list obtains details of devices, units
and channels, such as device IP, port, type and
other information.

Channel coding rules

A channel ID consists of deviceId, unitType, unitSeq and channelSeq, separated by a $ symbol,

as shown in the following figure:

• Where The deviceID is a 7-digit number. Starting from 1,000,000, the codes of the
newly added devices in the platform increase in sequence. UnitType is a unit type.
Refer to the following table for specific meaning. UnitSeq is the unit serial number,
starting from 0. ChannelSeq is the channel number, starting from 0, indicating which
channel is under this unit. In the above figure, 1000000$1$0$3 indicates the 4th
channel of the 1st unit of the coding unit of No.1,000,000 device.
• Unit type parameters

unitType Unit type

1 Encoding unit
2 Decoding unit
3 Alarm input unit
4 Alarm output unit
5 Screen input unit
6 Screen output unit
7 Access control unit
8 Voice control unit
9 Transcoding unit
10 Dynamic ring unit
11 POS unit
12 Virtual unit

Device department tree

• Multiple departments and multiple devices can be carried

under departments, different types of units under devices,
and multiple channels under units. The device department
interface supports condition search for channelType and
orgCode. The channel type and department are placed in the
parameters of the request url as follows:

GET /admin/API/tree/deviceOrg?channelType=1,2,3,4,5,6,7,8,10,11,12,1
4,15,33&sort=&orgCode= HTTP/1.1

• -The meaning of parameters is as follows:

Parameter
Type Description
Name
This is a comma-separated string of numbers, with each
number in the string representing a channel type. If the
parameter channelType is null, all channel types are
channelType string
requested. The channel type corresponds to the unit type
associated with the channel, and the specific meaning can
refer to the unit type.
sort string The field is not used and is null by default.
Department code; if orgCode is blank, all departments are
orgCode string
searched.
• Platform reply data is Json string, departments is array
type, each array element is an department, each department
has attribute field, device list and channel list, and the
returned data format is as follows:

{
"code": 1000,
"desc": "Success",
"data": {
"departments": [
{
"code": "001",
"parentCode": "",
"name":"root",
"orgType":"1",
"modifyTime": "1483528546",
"deparmentsCount": "1",
"domainId": "0",
"device": [
{
"id": "1000004",
"sort": "0"
},
{
"id": "1000738",
"sort": "0"
}
],
"channel": [
{
"id": "1000004$7$0$0",
"sort": "0"
},
{
"id": "1000004$7$0$1",
"sort": "0"
}
]
},
{
"code": "001001",
"parentCode": "001",
"name": "Access Control",
"orgType":"1",
"modifyTime": "1544749099",
"deparmentsCount": "0",
"domainId": "",
"device": [],
"channel": []
}
]
}
}

• The attribute fields of the department have the following meanings:

Parameter
Type Description
Name
The code of each department is unique, and the code
code string
of the root node is "001”.
Each department has a parent node, and its parent
node parentCode is an empty string. The department
parentCode string
finds its corresponding parent department through
parentCode.
name string Department name
The department type is 1 by default, indicating the
orgType string
basic department.
modifyTime string Department modification time, timestamp type
deparmentsCount string Number of sub-departments
domainId string Domain ID

• Devices under the department have the following meanings

in Device:

Parameter Name Type Description

id string Device ID
sort string Sort value

-The channels under the group are in channel, and the meanings of each field are as follows:

Parameter Name Type Description

id string Channel ID
sort string Sort value

• The data returned by request can form an department tree

which has devices and channels, but without their details.
The details should be obtained through the device list.

Device list
• Different types of units are carried under the device, and
specific passages under the units.
• When requesting a list of devices, the optional parameters
are composed of orgCode, deviceCodes and categories. These
parameters are combined into Json strings and placed in
the message body of the request. Three condition
parameters are of relation “and”, as shown below:

{
"orgCode":"",
"deviceCodes": [],
"categories": []
}
Parameter
Type Description
Name
orgCode string If not used, it is null by default.
Device code: The specific code of the device to be
deviceCodes string
queried; if it is blank, it means obtaining all devices.
Device category: Filter the type of device; if blank, all
categories string
device types are queried.

• Platform reply data is Json string, devices node in Json is of the array type, with each
array element being a device, and each device having device attributes and units. Units
node is of the array type, with each array element being a unit, and each unit having
unit attributes and channels. Channels node is of the array type, with each array
element being a channel, and the attributes of the channel being under the channel.
• Device attribute field For the meaning of each field, see Device List Protocol.
• Unit attribute field For the meaning of each field, see Device List Protocol.
• Channel attribute field For the meaning of each field, see
Device List Protocol.

2.3、Real-time Video

-Request for real-time video involves two steps:

1. Get the URL and token played through Rest request.

2. Get stream through RTSP protocol on URL.

Get URL

• Call /admin/API/MTS/Video/StartVideo interface to get URL

and token which are used for subsequent RTSP interaction
process.

RTSP interaction
When requesting a video, use the token field as a url parameter. If you do not use token, the
video request will fail. Each token becomes invalid after being used once. If not used for more
than 30 seconds, the token also becomes invalid. The format of the URL with token is as follows:

rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%240%26subs
tream=1?token=1190

a) Streamline RTSP interaction process

• On the obtained RTSP RUL, streamline the process to get

video data. The simplicity only requires sending SETUP
command before sending the PLAY command. The stream
returned in this way is in Intelbras format, and can be
decoded for playing by Intelbras play library. As shown
below:

SETUP rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%240%
26substream=1?token=1190 RTSP/1.0
Content-Length: 0
CSeq: 61
Transport: RTP/AVP/TCP; interleaved=0-1;playmode=playback

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 61
Session: 435774208694;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=014CFFF3
x-dynamic-rate: 1

PLAY rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%240%2
6substream=1?token=1190 RTSP/1.0
Content-Length: 0
CSeq: 62
Session: 435774208694;timeout=60

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 62
Session: 435774208694
RTP-Info: url=;seq=22252;rtptime=1335745184;ssrc=014CFFF3

a) Standard RTSP interaction process

• Standard protocol pull stream supporting RTSP can be

verified by VLC. The network configuration item of VLC
needs to be set to RTP over RTSP (search online for
configuration steps), open network series stream and enter
URL. The stream returned in this way is a standard stream,
and the client can select a standard decoding library for
decoding.

OPTIONS rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%24
0%26substream=1?token=1194 RTSP/1.0
CSeq: 2
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 2
Public: OPTIONS,DESCRIBE,SETUP,PLAY,PAUSE,TEARDOWN,SET_PARAMETER

DESCRIBE rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%2
40%26substream=1?token=1194 RTSP/1.0
CSeq: 3
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Accept: application/sdp

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 3
Content-Base: rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000
002%240%26substream=1?token=1194
Content-Type: application/sdp
Content-Length: 485
Cache-Control: must-revalidate
x-Accept-Dynamic-Rate: 1

v=0
o=- 2209362008 2209362008 IN IP4 0.0.0.0
s=RTSP Session/2.0
c=IN IP4 0.0.0.0
t=0 0
a=control:*
a=range:npt=now-
m=video 0 RTP/AVP 96
a=control:trackID=0
a=framerate:25.000000
a=rtpmap:96 H264/90000
a=fmtp:96 packetization-mode=1;profile-level-id=640032;sprop-paramete
r-sets=J2QAMq2EBUViuKxUcQgKisVxWKjiECSFITk8nyfk/k/J8nm5s00IEkKQnJ5Pk/
J/J+T5PNzZphcqAeAIn5YQAAA+gAAMNQBA,KP4Jiw==
a=recvonly
m=audio 0 RTP/AVP 8
a=control:trackID=1
a=rtpmap:8 PCMA/16000
a=recvonly
SETUP rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%240%
26substream=1?token=1194/trackID=0 RTSP/1.0
CSeq: 4
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Transport: RTP/AVP/TCP;unicast;interleaved=0-1

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 4
Session: 450492010249;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=014CFFF3
x-dynamic-rate: 1

SETUP rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%240%
26substream=1?token=1194/trackID=1 RTSP/1.0
CSeq: 5
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Transport: RTP/AVP/TCP;unicast;interleaved=2-3
Session: 450492010249

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 5
Session: 450492010249;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=2-3;ssrc=014CFFF5
x-dynamic-rate: 1

PLAY rtsp://10.35.92.18:9100/dss/monitor/param/cameraid=1000002%240%2
6substream=1?token=1194 RTSP/1.0
CSeq: 6
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Session: 450492010249
Range: npt=0.000-

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 6
Session: 450492010249
RTP-Info: url=trackID=0;seq=22015;rtptime=2659590554;ssrc=014CFFF3,ur
l=trackID=1;seq=0;rtptime=0;ssrc=014CFFF5
Range: npt=0.000000-

2.4、Record Search and Playback

Search records

• For protocol format for search records, see

/admin/API/SS/Record/QueryRecords. The search message
format is as follows:

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.QueryRecords",
"data": {
"cardNo": "",
"optional": "/admin/API/SS/Record/QueryRecords?token=f6e903d8
3d7f4c96b9a2591b6ca2af05",
"endTime": "1545926399",
"diskPath": "",
"startIndex": "",
"streamType": "0",
"recordType": "0",
"recordSource": "3",
"startTime": "1545840000",
"endIndex": "",
"channelId": "1000001$1$0$0"
}
}

• Among the above data fields, the following must be filled:

Parameter
Type Description
Name
channelId string Channel code
recordSource string Record source: 1= Full, 2 = Device, 3 = Center
streamType string Stream type: 1= Main stream, 2 = Sub stream
Record type: 0 = Full, 1 = Manual record, 2 = Alarm
record, 3 = Dynamic monitoring, 4 = Video loss, 5 =
recordType string
Video block, 6 = Timing record, 7 = All-weather record,
8 = File record switch
Parameter
Type Description
Name
startTime string Start time (time stamp: second)
endTime string End time (time stamp: second)

• According to the different storage sources of records,

they are divided into platform records (center records)
and device records. The center records are saved in the
storage space configured by the platform. The center
platform and distributed platform are both configured with
storage space. The center records generated during the
carrying period in the storage space will be saved in the
storage space of the corresponding platform. Device
records are saved on the device, regardless of the
platform in which the device is carried.

Search platform records

-The platform record is saved in the storage space configured by the SS service on which the
device is carried. If the device has changed the carried SS service, the platform record in the
inquiry period might be on different SS services. Therefore, when searching the platform records,
the center service will search about the records of all SS services, and the search process will
not be completed until all SS services return the search results. A record returned is in files as
follows:

{
"channelId": "1000001$1$0$0",
"recordSource": "3",
"recordType": "6",
"startTime": "1545840000",
"endTime": "1545841800",
"recordName": "{2db653e6-40d2-4bce-9df6-d2609b96d9ae}",
"fileLength": "737280",
"planId": "0",
"ssId": "1001",
"diskId": "1545840000-1545841800",
"streamId": "18",
"forgotten": "0"
}

Search device record

-When inquiring about the device records, the center service will search about the records from
the SS on which the device is carried. A record returned is in files as follows:

{
"channelId": "1000012$1$0$0",
"recordSource": "2",
"recordType": "6",
"startTime": "1545926402",
"endTime": "1545926473",
"recordName": "0-2-172108-12288-1545926402-1545926473",
"fileLength": "12288",
"planId": "0",
"ssId": "1002",
"diskId": "",
"streamId": "0",
"forgotten": "0"
}

Request for records

• Request for record playback requires obtaining the record

playback URl first, and then obtaining the record stream
through RTSP.

Get record playback URL

• Playback by file is recommended for platform records,

because record files in the same period may correspond to
different SS services (SS services that have been modified
by the device). It can only be controlled by the client,
playing a record file first, and then requesting to play
the next record file after the previous record ends. In
this case, playing a record within a period of time
requires initializing multiple record playback requests.
It is recommended that the device record be played
according to time, because this is relatively simple, and
only one request for record playback is required. For the
format of request protocol for record playback by time,
see /admin/API/SS/Playback/StartPlaybackByTime. For the
format of request protocol for record playback by files,
see /admin/API/SS/Playback/StartPlaybackByFile.

Request record video on playback URL through RTSP interaction

Platform record

a) Streamline RTSP protocol

• Streamline the process by sending SETUP command before

sending PLAY command. The stream returned in this way is
in Intelbras format, and can be decoded for playing by
Intelbras play library. The URL format is the URL obtained
in the previous step plus the token value. Each token
becomes invalid after being used once. If it is not used
for more than 30 seconds, the token also becomes invalid.
As shown below:

rtsp://10.35.92.18:9320/playback/center/55?token=55

• The specific RTSP interaction process is as follows:

SETUP rtsp://10.35.92.18:9320/playback/center/55?token=55 RTSP/1.0

Content-Length: 0
CSeq: 8
Transport: RTP/AVP/TCP; interleaved=0-1;playmode=playback

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 8
Session: 537036813163;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=03EFFFFD
x-dynamic-rate: 1

PLAY rtsp://10.35.92.18:9320/playback/center/55?token=55 RTSP/1.0

Content-Length: 0
CSeq: 9
Range: clock=20181227T000000Z-20181227T003000Z
Session: 537036813163;timeout=60
Speed: 1.000

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 9
Session: 537036813163
RTP-Info: url=;seq=0;rtptime=0;ssrc=03EFFFFD

b) Standard RTSP protocol

• Standard protocol pull stream supporting RTSP can be

• IP, Port corresponds to IP, Port in the record playback

URL obtained in the previous step. StreamID is the
streamId in the record request. BeginTime, endTime are the
start time and end time of the record to be played.
BeginTime can be later than the start time in the record,
but not later than the end time.

-The specific interaction process is as follows:

OPTIONS rtsp://10.35.92.18:9320/playback/center?streamID=18&beginTime
=1545840000&endTime=1545841800 RTSP/1.0
CSeq: 2
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 2
Public: OPTIONS,DESCRIBE,SETUP,PLAY,PAUSE,TEARDOWN,SET_PARAMETER

DESCRIBE rtsp://10.35.92.18:9320/playback/center?streamID=18&beginTim
e=1545840000&endTime=1545841800 RTSP/1.0
CSeq: 3
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Accept: application/sdp

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 3
Content-Base: rtsp://10.35.92.18:9320/playback/center?streamID=18&beg
inTime=1545840000&endTime=1545841800
Content-Type: application/sdp
Content-Length: 419
Cache-Control: must-revalidate
x-Accept-Dynamic-Rate: 1

v=0
o=- 2209529590 2209529590 IN IP4 0.0.0.0
s=RTSP Session/2.0
c=IN IP4 0.0.0.0
t=0 0
a=control:*
a=range:npt=0-1800
m=video 0 RTP/AVP 96
a=control:trackID=0
a=framerate:25.000000
a=rtpmap:96 H264/90000
a=fmtp:96 packetization-mode=1;profile-level-id=4D4032;sprop-paramete
r-sets=J01AMouVAPAET8sIAAAfQAAGGoQg,KP4JiA==
a=recvonly
m=audio 0 RTP/AVP 0
a=control:trackID=1
a=rtpmap:0 PCMU/16000
a=recvonly
SETUP rtsp://10.35.92.18:9320/playback/center?streamID=18&beginTime=1
545840000&endTime=1545841800/trackID=0 RTSP/1.0
CSeq: 4
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Transport: RTP/AVP/TCP;unicast;interleaved=0-1

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 4
Session: 540790241089;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=049DFFFD
x-dynamic-rate: 1

SETUP rtsp://10.35.92.18:9320/playback/center?streamID=18&beginTime=1
545840000&endTime=1545841800/trackID=1 RTSP/1.0
CSeq: 5
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Transport: RTP/AVP/TCP;unicast;interleaved=2-3
Session: 540790241089

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 5
Session: 540790241089;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=2-3;ssrc=049DFFFF
x-dynamic-rate: 1

PLAY rtsp://10.35.92.18:9320/playback/center?streamID=18&beginTime=15
45840000&endTime=1545841800 RTSP/1.0
CSeq: 6
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Session: 540790241089
Range: npt=0.000-
RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 6
Session: 540790241089
RTP-Info: url=trackID=0;seq=0;rtptime=20970;ssrc=049DFFFD,url=trackID
=1;seq=0;rtptime=0;ssrc=049DFFFF
Range: npt=0.233000-1800.000000

Device record

a) Streamline RTSP protocol

• Streamline the process by sending SETUP command before

SETUP rtsp://10.35.93.15:9320/playback/pu/13?token=13 RTSP/1.0

Content-Length: 0
CSeq: 1050
Transport: RTP/AVP/TCP; interleaved=0-1;playmode=playback

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 1050
Session: 68256552456;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=01BE0000
x-dynamic-rate: 1

PLAY rtsp://10.35.93.15:9320/playback/pu/13?token=13 RTSP/1.0

Content-Length: 0
CSeq: 1051
Range: clock=20181228T000002Z-20181228T235959Z
Session: 68256552456;timeout=60
Speed: 1.000

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 1051
Session: 68256552456
RTP-Info: url=;seq=0;rtptime=0;ssrc=01BE0000

b) Standard RTSP protocol

• Standard protocol pull stream supporting RTSP can be

rtsp://{IP}:{Port}/dss/playback/pu?cameraid={cameraid}&begintime={beg
intime}&endtime={endtime}&substream={
substream}

• IP, Port corresponds to IP, Port in the record playback

URL obtained in the previous step. Cameraid consists of
the device id and channelId of the channel Id requested in
the previous step. The transfer character %24 of '$' is
added between the device ID and channel ID. For example,
if the channelId is 1000012$1$2$3, the cameraid is
1000012%243. BeginTime, endTime are the start time and end
time of the record to be played. BeginTime can be later
than the start time in the record, but not later than the
end time. Substream is the main and sub stream; 1, main
stream; 2, sub stream

-The specific interaction process is as follows:

OPTIONS rtsp://10.35.93.15:9320/dss/playback/pu?cameraid=1000012%240&
begintime=1545926402&endtime=1546012799&substream=0 RTSP/1.0
CSeq: 2
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 2
Public: OPTIONS,DESCRIBE,SETUP,PLAY,PAUSE,TEARDOWN,SET_PARAMETER

DESCRIBE rtsp://10.35.93.15:9320/dss/playback/pu?cameraid=1000012%240
&begintime=1545926402&endtime=1546012799&substream=0 RTSP/1.0
CSeq: 3
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Accept: application/sdp
RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 3
Content-Base: rtsp://10.35.93.15:9320/dss/playback/pu?cameraid=100001
2%240&begintime=1545926402&endtime=1546012799&substream=0
Content-Type: application/sdp
Content-Length: 416
Cache-Control: must-revalidate
x-Accept-Dynamic-Rate: 1

v=0
o=- 2209060076 2209060076 IN IP4 0.0.0.0
s=RTSP Session/2.0
c=IN IP4 0.0.0.0
t=0 0
a=control:*
a=range:npt=0-86397
m=video 0 RTP/AVP 96
a=control:trackID=0
a=framerate:25.000000
a=rtpmap:96 H264/90000
a=fmtp:96 packetization-mode=1;profile-level-id=4D0032;sprop-paramete
r-sets=Z00AMpY1QEABg03AQEBAgA==,aO48gA==
a=recvonly
m=audio 0 RTP/AVP 8
a=control:trackID=1
a=rtpmap:8 PCMA/16000
a=recvonly
SETUP rtsp://10.35.93.15:9320/dss/playback/pu?cameraid=1000012%240&be
gintime=1545926402&endtime=1546012799&substream=0/trackID=0 RTSP/1.0
CSeq: 4
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Transport: RTP/AVP/TCP;unicast;interleaved=0-1

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 4
Session: 71273842861;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=0-1;ssrc=02250000
x-dynamic-rate: 1

SETUP rtsp://10.35.93.15:9320/dss/playback/pu?cameraid=1000012%240&be
gintime=1545926402&endtime=1546012799&substream=0/trackID=1 RTSP/1.0
CSeq: 5
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Transport: RTP/AVP/TCP;unicast;interleaved=2-3
Session: 71273842861

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 5
Session: 71273842861;timeout=60
Transport: RTP/AVP/TCP;unicast;interleaved=2-3;ssrc=02250002
x-dynamic-rate: 1

PLAY rtsp://10.35.93.15:9320/dss/playback/pu?cameraid=1000012%240&beg
intime=1545926402&endtime=1546012799&substream=0 RTSP/1.0
CSeq: 6
User-Agent: LibVLC/2.2.4 (LIVE555 Streaming Media v2016.02.22)
Session: 71273842861
Range: npt=0.000-

RTSP/1.0 200 OK
Server: Intelbras Rtsp Server/2.0
CSeq: 6
Session: 71273842861
RTP-Info: url=trackID=0;seq=0;rtptime=187200;ssrc=02250000,url=trackI
D=1;seq=0;rtptime=0;ssrc=02250002
Range: npt=2.080000-86397.000000

2.5、Receive alarm

Get MQ address

-Receive alarm messages from the platform via MQ. The connection address of mq is obtained
by getting mq configuration (/admin/API/BRM/Config/GetMqConfig) protocol.

Subscribe to alarm

-The client gets the alarm message by subscribing to topic, the format of which is as follows:

mq.alarm.msg.topic.{UserID}

-UserId is the user ID returned on second login (/admin/API/accounts/authorize) . -If

the user ID of system is 1, the topic subscribed by the system user after logging in to the
platform is:

mq.alarm.msg.topic.1

Alarm message format

After the platform receives the alarm, if the alarm is configured with linked users, it is sent to
the corresponding online users. The alarm message format is as follows:

{
"method": "vms.alarm.msg",
"info": {
"deviceCode": "1000004",
"channelSeq": 0,
"unitType": 1,
"nodeType": "2",
"nodeCode": "1000004$1$0$0",
"alarmCode": "{8C2C8056-D0A7-454B-845B-C566746D3B42}",
"alarmStat": "1",
"alarmType": "4",
"alarmGrade": "1",
"alarmDate": "1547014708",
"screenNum": "null",
"linkVideoChannels": [
{
"channelId": "1000003$1$0$0",
"channelName": "1DH Protocol -IP Mode- Panoramic PTZ
Camera_1",
"streamType": "1",
"screenId": "0"
}
],
"userIds": [
1
],
"alarmSourceName": "Channel0"
}
}

Search alarm

Get alarm messages by searching alarms (/admin/API/BRM/Alarm/QueryAlarms)

Handle alarm

Handle alarm records through handling alarms (/admin/API/BRM/Alarm/HandleAlarm) .

2.6、Personnel Management

Get card reader data of access control channel Call

(/OBMS/accessControl/door/reader?deviceCode={deviceCode}) interface to get the card reader
data of access control channel. The channelId and readId are combined into a new readerId
with underlined connection in the middle. The new readId is used to collect fingerprints.

Collect fingerprints Call (/OBMS/ACCESS CONTROL/PERSON/CaptureFingerPrint) interface

and issue the command to acquire fingerprint. After issuing the command to collect fingerprints
successfully, the card reader enters the fingerprint collection mode, and at this time, the reader
is pressed with fingers for fingerprint collection. After the fingerprint collection is successful, the
platform reports the fingerprint collection notification (VMS. DOORACESSESCAPTURE
FINGERPRINT) through MQ. The notification contains the fingerprint data used to configure
person information.

Add, modify and delete person Call (/OBMS/accessControl/person) interface to add person
information. After the successful addition of person information, the platform reports the
notification on adding person successfully (vms.batchAddPerson) and on failure to issue the
person (vms.issuePersonCardTaskFail) through MQ. Call
(/OBMS/accessControl/person/{personId}) interface to modify person information. After the
successful modification of person information, the platform reports the notification on
successfully modifying person (vms.updatePerson) and on failure to issue the person
(vms.issuePersonCardTaskFail) through MQ. Call
(/OBMS/accessControl/person?personIds={personIds}) interface to delete person information.
After successful deletion of person information, the platform reports the notification on
successfully deleting the person (vms.deletePerson) through MQ.

Add person in batch Call (/OBMS/accessControl/person/personList) interface to add person

information in batch. After the successful addition of person information, the platform reports
the notification on adding person successfully (vms.batchAddPerson) and on failure to issue the
person (vms.issuePersonCardTaskFail) through MQ.

Search person list Call (/OBMS/accessControl/personList) interface to get person list. Call
(/OBMS/accessControl/personCount) interface to get the total number of persons.
2.7、Access Control

Access control device

The access control device includes the first generation of common access control device, the
first generation of centralized controller, the first generation of face gate and the second
generation of access control device. The door opening methods supported by the device are a
combination of card, fingerprint, password and face. Different devices can support different
opening methods.

Type of access control device

Type of first generation of common access control device
Type of first generation of centralized controller
Type of second generation of face gate
Second generation of access control device

Basic configuration for access control channel

Before using the access control channel, its basic configuration should be set up. First call the
interface (/OBMS/accessControl/door/configure) to get the configuration of access control
channel. Then call the interface (/OBMS/accessControl/door/configure) to set the basic
configuration of access control channel. Configuration items for access control channel:

Access control
Specific meanings
configuration item
Set the card reader as the entrance direction or exit
Card reader direction
direction
Door Status Open, always open, always closed
NO Period Set the time template for always-open period
NC Period Set the time template for always-close period
Set alarm enabled. The alarm types that can be set
Alarm Enable include intrusion, timeout, duress and over-
frequency alarm.
Door Sensor Enable Open or close the door magnet
Unlock Length Set opening period
Unlock timeout Set the timeout period for door closing
Select the combination of card, fingerprint, password
Unlock Method
and other door opening methods.

Open or close door by a single channel

The platform supports remote door-opening and door-closing for a single access control channel
and provides a door-opening and door-closing interface (/OBMS/accessControl/door/control) for
a single door. After the access control channel operation is successful, the platform reports the
access control channel operation record notification (vms.doorAccessRecord) and the door
status notification (vms.doorAccessStatus) through MQ.

Access control global control

The first choice is to configure the global channel, and call the channel to be controlled and
needed to configure interface (/OBMS/accessControl/door/globalControl/config) for global door
opening and closing. After the configuration is successful, the platform reports on updating the
global channel configuration notification (vms.updateGlobalControlConfig) through MQ. Call the
global interface (/OBMS/accessControl/door/globalControl/control) for door opening and closing,
and set the global channel to one of the three states of returning to normal, closing the door
globally and opening the door globally. After the global door opening and closing are successful,
the platform through MQ reports the door global control status notification
(vms.doorGlobalControlStatus), the access control channel operation record notification
(vms.doorAccessRecord), the door status notification on access control channel
(vms.doorAccessStatus), door always-open and -close status notification
(vms.doorAlwaysOpenCloseStatus) and door global control failure channel notification (VMS.
DOORGLOBALCONTROLFAILEDCHANNELS).
Access control incident

When card swiping, fingerprint, password or face verification occurs to the access control device,
the platform pushes the access control event message through MQ. The value of the method
field in the access control event message is "vms.doorAccessRecord". According to the reported
event type, it is divided into the following three categories:

• Normal access control incidents Legal password to open the

door, legal fingerprint to open the door.
• Abnormal access control incidents Illegal card swiping,
abnormal door opening.
• Access alarm Forced alarm, door magnet alarm.

2.8、Attendance management

Configure attendance points

Call (/OBMS/attendance/position/channel) interface to select the access control channel as the
attendance points. After successful setup, the platform reports the notification on modifying the
attendance channels (VMS. Attendance. ModifyStateRule) through MQ.

Configure attendance rules

Call (/OBMS/attendance/statistics-rule) interface to set attendance rules. After successful setup,

the platform reports the notification on modifying the attendance statistics rules
(vms.attendance.modifyStatisRule) through MQ.

Relation diagram
The relationship among the schedule, order and interval is as follows:

Search attendance period

Call (/obms/attendance/time-interval?Pagesize={Pagesize}&Pageno={Pageno}) interface to get

attendance period list. Call (/OBMS/attendance/time-interval/{intervalId}) to get attendance
period details.

Add, modify and delete attendance period

Call (/OBMS/attendance/time-interval) interface to set attendance period. After successful

addition, the platform reports the notification on adding attendance period
(vms.attendance.addTimeInterval) through MQ. Call (/OBMS/attendance/time-
interval/{intervalId}) interface to modify attendance period. After successful modification, the
platform reports the notification on modifying the attendance period
(vms.attendance.modifyTimeInterval) through MQ. Call (/OBMS/attendance/time-
interval?intervalIds={intervalIds}) interface to delete attendance period. After successful
deletion, the platform reports the notification on deleting the attendance period
(vms.attendance.deleteTimeIntervals) through MQ.

Search attendance shift Call

(/OBMS/attendance/order?pageSize={pageSize}&pageNo={pageNo}) interface to get
attendance shift list. Call (/OBMS/attendance/order/{orderId}) interface to get attendance shift
details.

Add, modify and delete attendance shift

Call (/OBMS/attendance/order) interface to add attendance shift. After successful addition, the
platform reports the notification on adding attendance shift (vms.attendance.addTimeInterval)
through MQ. Call (/OBMS/attendance/order/{orderId}) interface to modify attendance shift.
After successful modification, the platform reports the notification on modifying the attendance
shift (vms.attendance.modifyOrder) through MQ. Call
(/OBMS/attendance/order?orderIds={orderIds}) interface to delete attendance order. After
successful deletion, the platform reports the notification on deleting the attendance shift
(vms.attendance.deleteOrders) through MQ.

Get person schedule

Call (/OBMS/attendance/schedule/person/{personId}) interface to get person schedule.

Modify shift schedule

Call (/OBMS/attendance/schedule/person) interface to modify shift schedule. After successful

modification, the platform reports the notification on modifying the shift schedule
(vms.attendance.modifyPersonSchedule) through MQ.

Modify department schedule

Call (/OBMS/attendance/schedule/dept) interface to modify the department schedule. After
successful modification, the platform reports the notification on modifying the department
schedule (vms.attendance.modifyDeptSchedule) through MQ. The department schedule applies
to all persons in this department.

2.9、Displaying videos on the wall

Process of displaying videos on the wall

Preparations for displaying videos on the wall

• Add display and control device to the platform.

• The channel for the display and control device connects to
an external monitor for playing videos on the wall.

New video wall

Call /admin/API/tvwall/wall to add a video wall and then configure windows and bind a decoder
channel. For details, see Add a video wall. The added video wall needs to be bound to a display
and control device channel that has connected to an external monitor.
Obtain information about the video wall at client

Call /admin/API/BRM/TvWall/GetTvWall?token=${token} to obtain the video wall information to

be sent to the device. See the format of the XML example of the video wall:

<tvwall id="5" name="nop" code="001">

<screen id="500" type="3" name="screen0" top="0.00" left="0.00" h
eight="99.55" width="99.66" code="1000034" deviceType="3">
<screen id="0" type="2" name="screen0" top="0.00" left="0.00"
height="99.55" width="99.66" code="1000034" unit="0" seq="149" devic
eType="3"/>
</screen>
</tvwall>
XML configuration
Explanation
item
tvwall Video wall tag
-id Video wall ID
-name Name of video walls
-code Organization
screen Screen
-id Screen ID
Screen type: 0-not bound; 1-large screen; 2-ordinary
-type
screen; 3-matrix; 4-splicing wall
-name Screen name
-top Screen top margin, percentage
-left Screen left margin, percentage
-height Screen height, percentage
-width Screen width, percentage
-code Code of the screen-bound decoder
Device type: 1-NVD; 3-matrix switcher; 4-large-screen
-deviceType
controller
screen Subscreen
-id Screen ID
Screen type: 0-not bound; 1-large screen; 2-ordinary
-type
screen; 3-matrix; 4-splicing wall
-name Screen name
-top Screen top margin, percentage
-left Screen left margin, percentage
-height Screen height, percentage
-width Screen width, percentage
-code Code of the screen-bound decoder
-unit Device sequence number
-seq Device channel sequence number
-deviceType Device type: 1-NVD; 3-matrix switcher; 4-large-screen
XML configuration
Explanation
item
controller

Displaying videos on the wall

Call /admin/API/VMS/TvWall/OperateTvWall?token={token} to display a bound video channel on

the wall. See the XML example:

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

XML configuration
Explanation
item
TVWallScheme Video wall tag
-Tasks Video wall task list
- -Task Video wall task information
- - -id Video wall task ID: -1-no task created
- - -name Video wall task name
- - -screen Number of video screens
- - -tvWallCfgId Video wall ID
XML configuration
Explanation
item
- - -desc Task description
- - -isOnlineSend Whether online: true-yes; false-no
- - -isAlarmTime Duration of displaying videos on the wall
Play back the record made x seconds in advance: 0-
-- -prefTime
real-time play
-- -recordType Record source: 2-device; 3-platform
Task tour mode: 0-ordinary tour; 1-intra-group tour in
-- -taskType priority; 2-inter-group tour in priority; 3-displaying the
service on the video wall
Whether the device performs automatic tour: true-yes;
-- -isDevAutoCycle
false-no
Plan type: 1-real-time video; 2-record playback Not
-- -planType
used for now, 0 at present
- - -Screen Screen
- - - -wndNo Screen sequence number
- - - -decodeId Decoder code
- - - -tvIdx Decoding channel, same as screen ID for a splicing wall
- - - -splitNum Number of windows
1-direct connection; 2-pull-stream; 3-push stream to
-- - -visitorMode
the decoder
- - - -screenId Screen ID
- - - -screenMode 1-image splitting; 2-windowing
- - - -isCombined Whether it is a splicing wall: true-yes; false-no
- - - -name Screen name
- - - -left Screen left margin, percentage
- - - -top Screen top margin, percentage
- - - -width Screen width, percentage
- - - -height Screen height, percentage
Attribute of the linkage screen: 0-ordinary screen; 1-
-- - -screenAlarmWall
alarm action screen
- - - -screenSeq Screen sequence number, valid for logical screens
- - - -SubTv Subscreen
- - - - -id Window ID
- - - - -left Screen left margin, percentage
- - - - -top Screen top margin, percentage
- - - - -width Screen width, percentage
- - - - -height Screen height, percentage
- - - - -name Window name
- - - - -zorder Z order (ignored for image splitting)
- - - - -isAlarm 0-client on the video wall; 1-alarms on the video wall
XML configuration
Explanation
item
Highlight: -1-no processing; 0-not highlighted; 1-
- - - - -isHighLight
highlighted; 2-blinking
- - - - -isOpenAudio -1-no processing; 0-audio disabled; 1-audio enabled
- - - - -subWinNum Number of subwindows, 0 by default
- - - - -Channel Information about the bound video channel
- - - - - -id Channel No.
- - - - - -name Channel name
Stream type: 1-main stream; 2-sub stream; 3-sub
- - - - - -subStream
stream 2; 4-sub stream 3; 5-live view mode
- - - - - -timeSpan Dwell time
Preset, 1-255, no need to rotate the devices out of the
- - - - - -presetPos
range
- - - - - -deviceId Device code
- - - - - -no Channel number
- - - - - -devType Device type
- - - - - -alarmType Alarm type, 0 for non-alarms
------
manufacturer
manufacturerType
501-PS package: 601-original frame; 701-Intelbras
- - - - - -trackID frame; 801-Intelbras standard frame; 901-TS package;
101 (below 300)-RTP standard stream
- - - - - -OsdText OSD overlay content
------
Null
osdBackgroundRect
- - - - - -osdFont Null
------
Null
osdFrontColor
- - - - - -enableOsd OSD overlay enabled
Video source connection type: -1-auto; 0-TCP; 1-UDP;
- - - - - -connType 2-multicast; 3-domain name; 4-auto registration; 5-
ONVIF; 6-GB28181; 7-HTTP web page
Tour mode: 0-tour; 1-non-tour on the video wall; 2-
- - - - - -patrolMode
tour live view
- - - - - -OsdSwitch Null
- - - - - -OsdLeft Null
- - - - - -OsdTop Null
- - - - - -OsdRed Null
- - - - - -OsdGreen Null
- - - - - -OsdBlue Null
Fisheye mounting mode: -1-unknown; 0-wall
- - - - - -fishFitMode
mounting; 1-in-ceiling mounting; 2-ground mounting
XML configuration
Explanation
item
Fisheye display mode: -1-unknown; 0-panoramic
------
(360°); 1-dual panoramic (360°); 2-view 1 PTZ; 3-view
fishShowMode
4 PTZ; 4-output+3 mode; 5-original mode
- - - - - -groupId ID of the home organization of the channel
------
Camera number
cameraIdentifier
- - - - - -encodeType Code type: 0-H264;1-MJPEG
Record playback start time (year month day hour
- - - - - -beginTime
minute second), valid when planType is 2
Record playback end time (year month day hour
- - - - - -endTime
minute second), valid when planType is 2
Forward offset time, relative time, in the unit of days, -
- - - - - -timeOffset 1-fixed time; 0-current day; 1-previous day; valid when
planType is 2

3、MQ
3.1、Alarm Topics

3.1.1、Alarm Message

Theme

• mq.alarm.msg.topic.{userId}

Example

• mq.alarm.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.alarm.msg",
"info": {
"deviceCode": "1000004",
"channelSeq": 0,
"unitSeq": 0,
"unitType": 1,
"nodeType": "2",
"nodeCode": "1000004$1$0$0",
"alarmCode": "{8C2C8056-D0A7-454B-845B-C566746D3B42}",
"alarmStat": "1",
"alarmType": "4",
"alarmGrade": "1",
"alarmDate": "1547014708",
"screenNum": "null",
"alarmPicture": "",
"alarmPictureSize": null,
"memo": "9876",
"linkVideoChannels": [
{
"channelId": "1000003$1$0$0",
"channelName": "11_1",
"streamType": "1",
"screenId": "0"
}
],
"userIds": [
1
],
"alarmSourceName": "Channel0",
"gpsX": null,
"gpsY": null,
"height": null,
"angle": null,
"speed": null
}
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- deviceCode string device Code
- channelSeq string channel
- unitSeq string unit sequence
- unitType string unit type
- nodeType string node type
- nodeCode string channel code
- alarmCode string alarm code
- alarmStat string alarm status: 1—generated; 2—cleared
- alarmType string alarm type
Parameter Name Type Description
- alarmGrade string alarm severity: 1—high; 2—medium; 3—low
- alarmDate string alarm time(second)
- screenNum string screen ID
- alarmPicture string alarm snapshot path
- alarmPictureSize string alarm image size
- memo string remarks
- linkVideoChannels object linkage video channels
- - channelId string channel ID
- - channelName string channel Name
- - streamType string code-stream type
- - screenId string window ID
- userIds string linkage user ID
- alarmSourceName string alarm source channel name
- gpsX number longitude
- gpsY number latitude
- height number height
- angle number direction angle
- speed number speed

3.2、Event Topics

3.2.1、System resources overrun alarm

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.systemInfoWarning",
"info": {
"freeCapcity": "13.28",
"cpuPercent": "100.00",
"memoryPercent": "90.65",
"serverIp": "10.33.68.103",
"mode": "1"
},
"id": "45046"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- freeCapcity string remaining capacity of installation disk
- cpuPercent string cpu usage
- memoryPercent string memory usage
- serverIp string server IP address
- mode string 1 - central mode; 0 - distributed mode
id string message ID

3.2.2、Export path notification

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.notifyFileDownLoadUrl",
"info": {
"session": "87",
"url": "http://10.35.92.17:80\\/upload/admin/videoAnalyse/hum
an/Humans_87.zip"
},
"id": "169393"
}

Parameters:
Parameter Name Type Description
method string method name
info object none
- session string session ID
- url string file download address
id string message ID

3.2.3、Device online or offline notification

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.notifyDeviceStatus",
"info": {
"deviceCode": "1000000",
"onlineStatus": "1",
"offlineReason": "0",
"syncChannelStauts": "1",
"updateTime": "1559913632"
},
"id": "16"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- deviceCode string device code
- onlineStatus string online status: 0 - offline; 1 - online
- offlineReason string offline reason
- whether to synchronize the channel status: 0 - no;1
string
syncChannelStauts - yes; 1 by default
Parameter Name Type Description
- updateTime string change time (s)
id string message ID

3.2.4、Door status notice

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.doorAccessStatus",
"info": {
"channelCode": "1000007$7$0$2",
"doorStatus": "2",
"swipDate": "1562212982"
},
"id": "113"
}

Parameters:

Parameter Name Type Description

method string method name
info object door status
- channelCode string channel code
- doorStatus string door status, 1—open, 2—closed
- swipDate string timestamp for massage generation(second)
id string message ID

3.2.5、Notice on access control records

Theme

• mq.event.msg.topic.{userId}
Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.doorAccessRecord",
"info": {
"channelCode": "1000000$7$0$0",
"channelName": "channel1",
"departmentCode": "",
"departmentName": "",
"cardNum": "",
"firstName": "",
"lastName": "",
"tel": "",
"gender": "",
"idNum": "",
"personId": "",
"stageId": "",
"buildingId": "",
"unitId": "",
"roomId": "",
"cardType": "",
"inOut": "",
"eventType": "56",
"deviceType": "1",
"swipDate": "1562212976",
"pictureUrl": "",
"picture1": "",
"picture2": "",
"picture3": "",
"picture4": "",
"memo": "2",
"alarmCode": "{67E4B8D4-42D8-4E95-AD31-889987462B21}"
}
}

Parameters:
Parameters Type Description
method string method name
info object none
- channelCode string channel code
- channelName string channel Name
- departmentCode string department code
-
string department name
departmentName
- cardNum string card No.
- firstName string first name
- lastName string last name
- tel string telephone number
- gender string gender
- idNum string ID number
- personId string cardholder ID
- stageId string stage ID
- buildingId string building ID
- unitId string unit ID
- roomId string room ID
card type, 0—common, 1—blacklist, 2—visitor, 3—
- cardType string
patrol, 4—VIP
- inOut string in and out status, 0-in, 1-out
- eventType string sub event type
- deviceType string device type
- swipDate string card swipe time(second)
- pictureUrl string face picture URL
- picture1 string capture picture 1
- picture2 string capture picture 2
- picture3 string capture picture 3
- picture4 string capture picture 4
- memo string description
- alarmCode string alarm code

3.2.6、Notification on the progress of importing all-in-one card user

information in batches

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1
Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.importPersonRatio",
"info": {
"failCount": "0",
"failedPersonIds": ["3"],
"fileUrl": "/upload/obms/person/export/11569324702131.xlsx",
"illeglePersonIds": ["999"],
"processRatio": "100",
"repeatCards": ["23651000"],
"repeatPersonIds": ["16"],
"returnCode": "1000",
"session": "6876af068ffa42e2b8e9ab71b571dc8d",
"successCount": "3"
},
"id": "38"
}

Parameters:

Parameter
Type Description
Name
method string method name
info object none
- failCount string number of personnel failed to be imported
- failedPersonIds object unsuccessfully imported personnel ID
path for downloading the information about
- fileUrl string
unsuccessfully imported personnels
- illeglePersonIds object illegal personnel ID
personnel import progress. 100 means import
- processRatio string
completed.
- repeatCards object repeated card
- repeatPersonIds object repeated personnel ID
- returnCode string return code
- session string session ID
- successCount string number of imported personnels
id string message ID

3.2.7、Notification on the progress of exporting visitors

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.exportVisitors",
"info": {
"fileUrl": "/upload/obms/visitor/1572916255099.xlsx",
"processRatio": "100",
"session": "1572916255099"
},
"id": "390"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- fileUrl string visitor file download path
- processRatio string export progress (%)
- session string session ID
id string message ID

3.2.8、Notification on the progress of exporting history visitors

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

Parameter Name Type Description
userId string user ID

Message example

{
"method": "vms.exportVisitorsHistoryRecords",
"info": {
"fileUrl": "/upload/obms/visitorHistoryRecord/1572916339773.x
lsx",
"processRatio": "100",
"session": "1572916339773"
},
"id": "396"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- fileUrl string visit record file download path
- processRatio string export progress (%)
- session string session ID
id string message ID

3.2.9、Alarm export notification

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.notifyAlarmExportResult",
"info": {
"session": "1547171135",
"url": "/upload/admin/alarm/Alarms_1547171135.xls"
},
"id": "200594"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- session string session ID
- url string file download path
id string message ID

3.2.10、Notification on the progress of generating export file

Theme

• mq.event.msg.topic.{userId}

Example

• mq.event.msg.topic.1

Parameters:

Parameter Name Type Description

userId string user ID

Message example

{
"method": "vms.exportRecordRatio",
"info": {
"session": "3d9b25c5c553469eabb92b0e35e82b08",
"fileUrl": "/upload/ipms/car/export/11551948224094.xlsx",
"exportModule": "3",
"exportColumnType": "1",
"customColumns": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12"
],
"processRatio": "90"
},
"id": "200594"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- session string session ID
- fileUrl string file download path
export module: 0 - vehicle parking history; 1 -
- exportModule string vehicle passing history; 2 - on-site vehicles; 3 -
vehicle records
- column export method: 0 - all columns; 1 -
string
exportColumnType customized columns
- customColumns object custom column
export progress. 100 means that the file is
- processRatio string
generated successfully.
id string message ID

3.3、Common Topics

3.3.1、Human Snapshot Information Notification

Theme

• mq.common.msg.topic

Example

• mq.common.msg.topic

Parameters:

none

Message example
{
"method": "vms.notifyHumanInfo",
"info": {
"channelId": "1000005$1$0$0",
"faceImageUrl": "",
"humanImageUrl": "https://10.35.93.16:443/upload/picture/body
/20181206/11/14/2d6c344b-87d1-452b-833a-61ccf6463f16.jpg",
"pictureUrl": "https://10.35.93.16:443/upload/picture/scenebo
dy/20181206/11/14/6687ec54-cb82-45a2-ab55-fed465de3a8a.jpg",
"gender": "0",
"coat": "1",
"coatColor": "5",
"trousers": "1",
"trousersColor": "4",
"hat": "1",
"bag": "1",
"emotion": "",
"glasses": "",
"beard": "0",
"mask": "0",
"age": "0",
"captureTime": "1544252578",
"faceImageTop": "",
"faceImageLeft": "",
"faceImageBottom": "",
"faceImageRight": "",
"humanImageTop": "3845",
"humanImageLeft": "2394",
"humanImageBottom": "5779",
"humanImageRight": "2688"
},
"id": "114662"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- channelId string channel No.
- faceImageUrl string face image
- humanImageUrl string human body image
- pictureUrl string scene picture
- gender string gender
Parameter Name Type Description
- coat string tops
- coatColor string tops color
- trousers string bottoms
- trousersColor string bottoms color
- hat string hat
- bag string bag
- emotion string expression
- glasses string eyes
- beard string beard
- mask string mask
- age string age
- captureTime string snapshot time (s)
- faceImageTop string top coordinate of the face image
- faceImageLeft string left coordinate of the face image
- faceImageBottom string bottom coordinate of the face image
- faceImageRight string right coordinate of the face image
- humanImageTop string top coordinate of the human body image
- humanImageLeft string left coordinate of the human body image
- humanImageBottom string bottom coordinate of the human body image
- humanImageRight string right coordinate of the human body image
id string message ID

3.3.2、Motor vehicle snapshot information notification

Theme

• mq.common.msg.topic

Example

• mq.common.msg.topic

Parameters:

none

Message example

{
"method": "vms.notifyVehicleInfo",
"info": {
"channelId": "1000009$1$0$0",
"plateImageUrl": "https://10.35.93.16:443/upload/picture/vehi
cle/20181206/11/14/ae7bd226-6b9e-49c2-a380-fc5cb8a9004c.jpg",
"pictureUrl": "https://10.35.93.16:443/upload/picture/sceneca
r/20181206/11/14/6e99e4e9-ff71-498a-bcfe-c8634fd10ac3.jpg",
"plate": "",
"plateColor": "3",
"carType": "22",
"carColor": "0",
"carBrand": "0",
"captureTime": "1544066039",
"carImageTop": "2012",
"carImageLeft": "3727",
"carImageBottom": "2420",
"carImageRight": "4312"
},
"id": "114663"
}

Parameters:

Parameter Name Type Description

method string method name
info object none
- channelId string channel No.
- plateImageUrl string license plate image
- pictureUrl string panorama
- plate string plate number
- plateColor string license plate color
- carType string vehicle type, dictionary type=2002
- carColor string vehicle color, dictionary type=2001
- carBrand string vehicle trademark, dictionary type=2016
- captureTime string snapshot time (s)
- carImageTop string top coordinate of the vehicle body image
- carImageLeft string left coordinate of the vehicle body image
- carImageBottom string bottom coordinate of the vehicle body image
- carImageRight string right coordinate of the vehicle body image
id string message ID

3.3.3、Non-motor vehicles snapshot information notification

Theme

• mq.common.msg.topic

Example

• mq.common.msg.topic
Parameters:

none

Message example

{
"method": "vms.notifyNonVehicleInfo",
"info": {
"channelId": "1000009$1$0$0",
"carImageUrl": "https://10.35.93.16:443/upload/picture/nomoto
r/20181206/11/14/c5bc3861-4faf-42fa-8e7a-cf2a60af73f0.jpg",
"pictureUrl": "https://10.35.93.16:443/upload/picture/sceneno
motor/20181206/11/14/445594cf-54e2-4a85-9dcf-5f43bcd0b90d.jpg",
"carType": "2",
"carColor": "8",
"riderNum": "1",
"captureTime": "1544066042",
"carImageTop": "2136",
"carImageLeft": "3682",
"carImageBottom": "2648",
"carImageRight": "4184",
"faceInfos": [
{
"faceId": "...",
"faceOrder": 1,
"faceUrl": "...",
"sex": 1,
"complexion": 2,
"mask": 1,
"glass": 1,
"mouth": 1,
"emotion": -1
}
]
},
"id": "114665"
}

Parameters:

Parameter
Type Description
Name
method string method name
info object none
- channelId string channel No.
Parameter
Type Description
Name
- carImageUrl string vehicle picture
- pictureUrl string panorama
- carType string vehicle type
- carColor string vehicle color, dictionary type=2001
- riderNum string number of riders
- captureTime string snapshot time (s)
- carImageTop string top coordinate of the vehicle image
- carImageLeft string left coordinate of the vehicle image
-
string bottom coordinate of the vehicle image
carImageBottom
- carImageRight string right coordinate of the vehicle image
- faceInfos object face information
- - faceId string face ID
- - faceOrder number sort
- - faceUrl string face image
- - sex number gender: 0—unknown; 1—male; 2—female
skin color: 0 - unrecognized; 1 - yellow; 2 - black; 3
- - complexion number
- white
- - mask number mask: 0 - unrecognized; 1 - no; 2 – yes
glasses: 0 - unknown; 1 - no glasses; 2 - regular
- - glass number
glasses; 3 - sunglasses
mouth: 0 - unknown; 1 - unrecognized; 2 - closed;
- - mouth number
3 – open
expression: 0—smiling; 1—angry; 2—sad; 3—
- - emotion number disgusted; 4—fearful; 5—surprised; 6—normal; 7—
laughing; 8—happy; 9—confused; 10—screaming
id string message ID

3.3.4、Face Snapshot or Recognition Message Notification

Theme

• mq.common.msg.topic

Example

• mq.common.msg.topic

Parameters:

none

Message example
{
"method": "vms.notifyFaceInfo",
"info": {
"channelId": "1000319$1$0$0",
"faceImageUrl": "https://172.22.151.183:50001/afefb58d-5b66-1
1e9-8037-000000000000/20190612/1/dsf_739dc016-8d79-11e9-9f8a-00000000
0000_34998401_35001200.jpg",
"pictureUrl": "https://172.22.151.183:50001/afefb58d-5b66-11e
9-8037-000000000000/20190612/1/dsf_739dc016-8d79-11e9-9f8a-0000000000
00_34782193_34998401.jpg",
"appearTimes": "0",
"hited": "1",
"recAge": "29",
"recGender": "1",
"recFringe": "0",
"recEye": "3",
"recMouth": "3",
"recMask": "2",
"recBeard": "2",
"recGlasses": "1",
"recEmotion": "6",
"beginTime": "1560390144",
"endTime": "1560390144",
"serviceCode": "4001",
"similarFaces": [
{
"uid": "24",
"faceImageUrl": "https://172.22.151.183:50001/afefb58
d-5b66-11e9-8037-000000000000/20190612/1/dsf_739dc016-8d79-11e9-9f8a-
000000000000_35001200_35021084.jpg",
"name": "1212",
"personTypeId": "3",
"personTypeName": "Staff",
"personId": "14565456",
"gender": "1",
"birthday": "",
"nationality": "9999",
"memo": "",
"repositoryId": "3",
"repositoryName": "test",
"repositoryColor": "3",
"similarity": "38",
"surveillance": "0"
}
]
},
"id": "1262006"
}

Parameters:

Parameter
Type Description
Name
method string method name
info object none
- channelId string channel No.
- faceImageUrl string face image
- pictureUrl string scene picture
- appearTimes string appearance times
- hited string whether to recognize: 0 - capture; 1 - recognize
- recAge string age
- recGender string gender: 0 - unrecognized; 1 - male; 2 - female
- recFringe string fringe: 0—none; 1—yes
- recEye string eyes: 1 - unrecognized; 2 - closed; 3 - open
- recMouth string mouth: 1 - unrecognized; 2 - closed; 3 - open
mask: 0 - unknown (SDK); 1 - unrecognized; 2 - no;
- recMask string
3 - yes
beard: 0 - unknown (SDK); 1 - unrecognized; 2 - no;
- recBeard string
3 - yes
- recGlasses string glasses: 0—none; 1—glasses; 2—sunglasses
expression: 0—smiling; 1—angry; 2—sad; 3—
- recEmotion string disgusted; 4—fearful; 5—surprised; 6—normal; 7—
laughing; 8—happy; 9—confused; 10—screaming
- beginTime string start time (s)
- endTime string end time (s)
- serviceCode string service No.
- similarFaces object none
- - uid string face ID
- - faceImageUrl string face image
- - name string name
- - personTypeId string personnel type
--
string personnel type name
personTypeName
- - personId string personnel ID
- - gender string gender: 0 - unrecognized; 1 - male; 2 - female
- - birthday string date of birth, format: yyyy-MM-dd
- - nationality string nationality
Parameter
Type Description
Name
- - memo string remarks
- - repositoryId string face database ID
--
string face database name
repositoryName
face library color: 1 - gray; 2 - red; 3 - orange; 4 -
- - repositoryColor string
yellow; 5 - green; 6 - cyan; 7 - blue; 8 - purple
- - similarity string similarity
- - surveillance string whether armed: 0 - no; 1 - yes
id string message ID

4、API Interface
4.1、Login Authentication

4.1.1、First login

Brief description:

• First login when creating session

Request URL:

• /admin/API/accounts/authorize

Request example

POST /admin/API/accounts/authorize HTTP/1.1

Host: 10.35.93.66
Connection: close
Content-Type: application/json;charset=UTF-8

Request method:

• POST

Request example

{
"userName": "system",
"ipAddress": "",
"clientType": "WINPC"
}

Parameters:
Parameter Name Type Description
userName string Username
ipAddress string IP address of client PC
clientType string Client type

Return example

{
"realm": "DSS",
"randomKey": "c078b9d42eb74ebb",
"encryptType" : "MD5"
}

Description of return parameters

Parameter Name Type Description

realm string Domain information
randomKey string Random value
encryptType string Encryption type

Notes

– For more returned error codes, see the error code description on the home page

4.1.2、Second login

Brief description:

• Second login when creating session

Request URL:

• /admin/API/accounts/authorize

Request example

POST /admin/API/accounts/authorize HTTP/1.1

Host: 10.35.93.66
Connection: close
Content-Type: application/json;charset=UTF-8

Request method:

• POST

Request example

{
"userName": "system",
"randomKey": "c078b9d42eb74ebb",
"mac": "30:9c:23:79:40:08",
"ipAddress": "",
"signature": "a83edfbd6a98f8cc3aedfea36d9b13bb",
"clientType": "WINPC",
"encryptType": "MD5",
"userType": "0"
}

Parameters:

Parameter
Type Description
Name
userName string Username
randomKey string Random value
mac string Mac address
ipAddress string IP address
Authentication data, authentication data=AES (PWD,
signature string
randomKey) if the user type is domain user.
clientType string User Type
encryptTypee string Encryption type
userType string 0=System user, 1=Domain user

Return example

{
"duration": 30,
"token": "5095d4a0c5cc4340b72b7e5c64fa3170",
"userId": "1",
"sipNum": "8888881000",
"emapUrl": null,
"serviceAbilty": null,
"versionInfo": {
"lastVersion": "1016871",
"updateUrl": "/admin/x86/General_DSS-Express_Client-x86_V1.00
0.0000002.0.R.20181011.exe;/admin/x64/General_DSS-Express_Client-x64_
V1.000.0000002.0.R.20181011.exe"
}
}

Description of return parameters

Parameter Name Type Description

duration int Keep-alive interval
Parameter Name Type Description
token string Token
userId string User ID
sipNum string Called number
emapUrl string Electronic map URL
serviceAbilty object None
versionInfo object Version information
- lastVersion string Latest client version
- updateUrl string Client update URL

Notes

– For more returned error codes, see the error code description on the home page

4.1.3、Update token

Brief description:

• Update token

Request URL:

• /admin/API/accounts/updateToken
• X-Subject-Token: {token}

Request example

POST /admin/API/accounts/updateToken HTTP/1.1

Host: 10.35.93.66
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 841e473bacef4b31abc5f53272afeb84

Request method:

• POST

Request example

{
"signature": "6684b3858a56d80c85bfa07f625baa10"
}

Parameters:

Parameter Name Type Description

signature string Signature
Return example

{
"code": 1000,
"desc": "Success",
"data": {
"token": "885c9c2afd784120922e9f5ef164b799",
"duration": 30
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- token string Token number
- duration int Next update interval

Notes

– For more returned error codes, see the error code description on the home page

4.1.4、Modify password

Brief description:

• Modify user password

Request URL:

• /admin/API/Rights/User/Password/{userId}
• X-Subject-Token: {token}

Request example

PUT /admin/API/Rights/User/Password/1 HTTP/1.1

Host: 10.35.93.66
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 841e473bacef4b31abc5f53272afeb84
Parameter Name Type Description
userId string User ID
token string The token obtained when logging in

Request method:
• PUT

Request example

{
"oldPassword": "1e27fadce9af09e120ab5142a83a679e",
"newPassword": "3b314ab6808943c6732b52039a5290b2"
}

Parameters:

Parameter
Type Description
Name
Previous password, encrypted in an encryption type
oldPassword string
returned when creating session.
New password, encrypted in an encryption type
newPassword string
returned when creating session.

Note：

Encryption mode：
temp = md5(password)
temp = md5(userName + temp)
temp = md5(temp)
userName-user name, password-user password

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page

4.1.5、Logout

Brief description:

• Request to destroy a session authenticated by a user.

Request URL:

• /admin/API/accounts/unauthorize
• X-Subject-Token: {token}

请求示例

POST /admin/API/accounts/unauthorize HTTP/1.1

Request method:

• POST

Request example

{
"userName": "system",
"token": "bb15670e2ea24bac832dca223c7b52ac"
}

Parameters:

Parameter Name Type Description

userName string User Name
token string The token obtained when logging in

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes
– For more returned error codes, see the error code description on the home page

4.2、Device Tree

4.2.1、Getting Device Organization Tree (all)

Brief description：

• Get device organization tree (all)

Request URL：

• /admin/API/tree/deviceOrg?channelTypes={channelTypes}&s
ort={sort}&orgCode={orgCode}
• X-Subject-Token: {token}

Request example

GET /admin/API/tree/deviceOrg?channelTypes=1,2,3,4,5,6,7,8,10,11,12,1
4,15,33&sort=&orgCode= HTTP/1.1
Host: 10.35.92.66
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 433b9cac285d434683643f79fb86be6b
Parameter
Type Description
Name
channelTypes string Channel type
sort string Invalid parameter, null
Organization code which means root node 001 if it is
orgCode string
null
token string The token obtained when logging in

Notes:

channelTypes: 1 = Encoder channel, 2 = Decoder channel, 3 = Alarm inp

ut channel, 4 = Alarm output channel, 5 = Large screen input, 6 = Lar
ge screen output, 7 = Access control, 8 = Voice control, 9 = Transcod
ing, 10 = Power environment, 11 = POS; if the type is null, the chann
el is not displayed

Request method：

• GET

Request example

Empty
Parameters： None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"departments": [
{
"code": "001",
"parentCode": "",
"name": "root",
"orgType": "1",
"modifyTime": "1483528546",
"deparmentsCount": "1",
"domainId": "0",
"device": [
{
"id": "1000004",
"sort": "0"
},
{
"id": "1000738",
"sort": "0"
},
{
"id": "1000747",
"sort": "0"
}
],
"channel": [
{
"id": "1000004$7$0$0",
"sort": "0"
},
{
"id": "1000004$7$0$1",
"sort": "0"
},
...
]
},
{
"code": "001001",
"parentCode": "001",
"name": "test99",
"orgType": "1",
"modifyTime": "1544749099",
"deparmentsCount": "0",
"domainId": "",
"device": [],
"channel": []
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- departments object Organization information
- - code string Node code; 001 is the root node
- - parentCode string The parent code of the current node
- - name string Node name
- - orgType string Node Type
- - modifyTime string Change date
- - deparmentsCount string Number of subordinate organizations
- - domainId string Domain ID
- - device object Device node under the organization
- - - id string Device ID
- - - sort string Sort value
- - channel object Channel node under the organization
- - - id string Channel ID
- - - sort string Sort value

Notes

• For more returned error codes, see the error code

description on the home page

4.2.2、Getting Device List (all)

Brief description：

• Get device list.

Request URL：

• /admin/API/tree/devices
• X-Subject-Token: {token}

Request example

POST /admin/API/tree/devices HTTP/1.1

Host: 10.35.92.66
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 433b9cac285d434683643f79fb86be6b
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"orgCode": "",
"deviceCodes": [],
"categories": []
}

Parameters：

Parameter Name Type Description

orgCode int Organization code
deviceCodes string Device code, if it is null, all devices are obtained
categories string Device category, 1-Encoder,5-ANPR,8-Access control

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"devices": [
{
"code": "1000004",
"name": "10.35.93.67",
"category": "8",
"type": "2",
"model": "4",
"status": "1",
"offlineReason": "0",
"protocol": "1",
"manufacturer": "1",
"deviceIp": "10.35.93.67",
"devicePort": "37777",
"proxyIp": "10.35.92.66",
"proxyPort": "",
"userName": "admin",
"password": "8c8944adede71eea53bec5d7624ea53a",
"loginType": "0",
"sn": "",
"orgCode": "001",
"units": [
{
"unitType": "7",
"unitSeq": "0",
"fingerPrintAuth": "0",
"cardAuth": "0",
"faceAuth": "0",
"userIsolate": "0",
"unlockModes": "",
"channels": [
{
"channelCode": "1000004$7$0$0",
"channelName": "Door1",
"channelSeq": 0,
"status": "1",
"db33Code": "",
"intelliState": "",
"capability": "0",
"domainId": ""
},
{
"channelCode": "1000004$7$0$1",
"channelName": "Door2",
"channelSeq": 1,
"status": "1",
"db33Code": "",
"intelliState": "",
"capability": "0",
"domainId": ""
},
...
]
}
],
"sipId": "",
"sipPwd": "",
"unitEnable": "0",
"buildingEnable": "0",
"domainId": "",
"modifyTime": ""
},
{
"code": "1000747",
"name": "NVR",
"category": "1",
"type": "6",
"model": "IPC_256",
"status": "1",
"offlineReason": "0",
"protocol": "1",
"manufacturer": "1",
"deviceIp": "10.35.106.16",
"devicePort": "37140",
"proxyIp": "",
"proxyPort": "",
"userName": "admin",
"password": "8c8944adede71eea53bec5d7624ea53a",
"loginType": "0",
"orgCode": "001",
"units": [
{
"unitType": "1",
"unitSeq": "0",
"assistStream": "3",
"zeroChnEncode": "1",
"streamType": "801",
"channels": [
{
"channelCode": "1000747$1$0$0",
"channelName": "IPC",
"channelSeq": 0,
"status": "1",
"cameraType": "1",
"channelType": "1",
"cameraFunctions": "0",
"forPeopleCount": "0",
"faceFunctions": "0",
"db33Code": "",
"intelliState": "",
"targetDetection": "0",
"capability": "0",
"domainId": ""
},
{
"channelCode": "1000747$1$0$1",
"channelName": "IPC",
"channelSeq": 1,
"status": "1",
"cameraType": "1",
"channelType": "1",
"cameraFunctions": "0",
"forPeopleCount": "0",
"faceFunctions": "0",
"db33Code": "",
"intelliState": "",
"targetDetection": "0",
"capability": "0",
"domainId": ""
}
]
},
{
"unitType": "3",
"unitSeq": "0",
"channels": [
{
"channelCode": "1000747$3$0$0",
"channelName": "NVR_1",
"channelSeq": 0,
"status": "1",
"alarmType": "2",
"alarmLevel": "1",
"db33Code": "",
"intelliState": "",
"capability": "0",
"domainId": ""
},
{
"channelCode": "1000747$3$0$1",
"channelName": "NVR_2",
"channelSeq": 1,
"status": "1",
"alarmType": "2",
"alarmLevel": "1",
"db33Code": "",
"intelliState": "",
"capability": "0",
"domainId": ""
},
...
]
},
{
"unitType": "4",
"unitSeq": "0",
"channels": [
{
"channelCode": "1000747$4$0$0",
"channelName": "NVR_1",
"channelSeq": 0,
"status": "1",
"db33Code": "",
"intelliState": "",
"capability": "0",
"domainId": ""
},
{
"channelCode": "1000747$4$0$1",
"channelName": "NVR_2",
"channelSeq": 1,
"status": "1",
"db33Code": "",
"intelliState": "",
"capability": "0",
"domainId": ""
},
...
]
}
],
"unitEnable": "",
"buildingEnable": "",
"domainId": "",
"modifyTime": ""
},
{
"code": "1000738",
"name": "IPC29",
"category": "1",
"type": "1",
"model": "IPC_256",
"status": "1",
"offlineReason": "0",
"protocol": "1",
"manufacturer": "1",
"deviceIp": "10.35.106.29",
"devicePort": "31239",
"proxyIp": "",
"proxyPort": "",
"userName": "admin",
"password": "8c8944adede71eea53bec5d7624ea53a",
"loginType": "0",
"sn": "",
"orgCode": "001",
"units": [
{
"unitType": "1",
"unitSeq": "0",
"assistStream": "3",
"zeroChnEncode": "0",
"streamType": "801",
"channels": [
{
"channelCode": "1000738$1$0$0",
"channelName": "IPC29_1",
"channelSeq": 0,
"status": "1",
"cameraType": "2",
"channelType": "1",
"cameraFunctions": "0",
"forPeopleCount": "0",
"faceFunctions": "0",
"db33Code": "",
"intelliState": "",
"targetDetection": "0",
"capability": "0",
"domainId": ""
}
]
}
],
"unitEnable": "",
"buildingEnable": "",
"domainId": "",
"modifyTime": ""
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
- devices object Device Information
- - code string Device Code
- - name string Device name
- - category string Device categories
- - type string Device type
- - model string Model
- - status string Device status
- - offlineReason string Offline reason
- - protocol string Protocol
- - manufacturer string Manufacturer
- - deviceIp string Device IP
- - devicePort string Device ports
- - registId string Register ID
- - proxyIp string Proxy IP
- - proxyPort string Proxy port
- - userName string User name
- - password string Password
- - callNumber string SIP number
- - loginType string Login type
- - sn string SN number
- - orgCode string Department code
- - units object Unit information
Parameter
Type Description
Name
- - - unitType string Unit type
- - - unitSeq string Unit sequence
- - - assistStream string Sub stream
---
string Zero channel encode
zeroChnEncode
- - - ssServiceId stringStorage service ID
- - - ptsServiceId stringPTS service ID
- - - streamType stringCode-stream type
- - - decodeMode stringDecoding mode
- - - streamMode stringStream processing mode
Video wall combining status, 0-combining is not
- - - conbineStatus string
supported,1-combining is supported
---
string Third party control
thirdPartyControl
- - - voiceServerIp string Voice service IP
---
string Voice service port
voiceServerPort
---
string Voice status port
voiceStatusPort
- - - voiceClientIp string Voice client IP
- - - dynCode string Power environment resource code
- - - dynName string Power environment resource name
- - - dynType string Power environment resource type
Whether fingerprint authentication is supported, 0-
---
string unknown, compatible with previous one (default),1-
fingerPrintAuth
not supported,2-supported
Whether card authentication is supported, 1-Yes,0-
- - - cardAuth string
No
Whether face recognition authentication is
- - - faceAuth string
supported, 1-Yes,0-No
Whether the user and card are separated,1 - Yes,0-
- - - userIsolate string
No
- - - unlockModes string Unlock mode combination
- - - channels object Channel information
- - - - channelCode string Channel code
----
string Channel name
channelName
- - - - channelSeq string Channel sequence
- - - - status string Enabling status
- - - - sn string SN number
- - - - gpsX string GPS(X)
Parameter
Type Description
Name
- - - - gpsY string GPS(X)
- - - - mapId string Raster map ID
- - - - cameraType string Camera type
- - - - channelType string Channel type
- - - - remoteType string Remote type
----
string Channel function set
cameraFunctions
- - - - multicastIp string Multicast IP
----
string Multicast port
multicastPort
- - - - ipcIp string IPC(IP)
- - - - recordType string Record type
----
string Whether it is used for people count
forPeopleCount
----
string Maximum number of video wall split
maxSplitNum
----
string Interface type
interfaceType
- - - - alarmType string Alarm type
- - - - alarmLevel string Alarm level
- - - - signalType string Signal type
- - - - accessType string Access control type
- - - - posType string Pos type
- - - - posModel string Access control type
- - - - dynCode string Power environment resource
----
string Face image function
faceFunctions
- - - - keyCode string Keyboard code
- - - - db33Code string Landmark code
- - - - intelliState string Intelligent status
----
string Face analysis type
faceAnalyseType
- - - - videoSource string Video source for virtual channel
----
string Target detection function
targetDetection
- - - - capability string Capability set
- - - - domainId string Domain ID
- - sipId string SIP ID
- - sipPwd string SIP password
- - unitEnable string Intercom unit enable
Parameter
Type Description
Name
- - buildingEnable string Intercom building enable
--
string Software version
softwareVersion
--
string Hardware version
hardwareVersion
- - domainId string Domain ID
- - modifyTime string Change date

Notes

• For more returned error codes, see the error code

description on the home page

4.2.3、Getting Device Organization Tree (hierarchical)

Brief description：

• Get device organization tree (hierarchical)

Request URL：

• /admin/API/tree/search
• X-Subject-Token: {token}

Request example

GET /admin/API/tree/search HTTP/1.1

Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 723ab08e7db844d0946b26d1cadf011f
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• GET

Request example

{
"id": "001",
"nodeType": "1,2",
"typeCode": "01;01;01,02,03,04,05,06,07,08,21,40,43;01,02,03,04,0
5,06,07,08,09,10,11,12",
"keyType": "name",
"keyWord": "123",
"cascading": "0",
"page": "1",
"pageSize": "10",
"act": ""
}

Parameters：

Parameter
Type Description
Name
id string Node ID
Node type, separated by commas if there are multiple
nodeType string
node types; 1-organization, 2-device, 3-channel
Node filtering criteria,
typeCode string
{org};{device};{unit&channel};{camera}
Keyword type; null, name-node name, ip-device IP, id-
keyType string
node ID
keyWord string Keywords
Whether cascading data is displayed; 0-not displayed, 1-
cascading string
displayed
page string Page
pageSize string Record number per page
act string Action; search-search; null-hierarchically obtained

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"nextPage": "-1",
"totalCount": "1",
"results": [
{
"id": "001",
"name": "root",
"isParent": "true",
"nodeType": "1",
"domainId": "",
"sort": "0"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- nextPage string Next page, -1 means no next page
- totalCount string Total number of queries
- results object None
- - id string Node ID
- - name string Node name
- - isParent string Whether the node is a parent node
Node type, 1-device organization,2-device,3-
- - nodeType string
channel
- - domainId string Domain ID
- - sort string Sort

Notes

• For more returned error codes, see the error code

description on the home page

4.2.4、Obtain subordinate information about a specified node based on

the search data type

Brief description：

• Obtain subordinate information about a specified node

based on the search data type

Request URL：

• /admin/API/tree/child-node
• X-Subject-Token: {token}

Request example

POST /admin/API/tree/child-node HTTP/1.1

• POST

Request example

{
"dataType": "01,03;01,06,38,45",
"isDomain": 1,
"nodes": [
{
"nodeId": "001",
"checked": true
}
],
"size": 100
}

Parameters：

Parameter
Type Description
Name
dataType string Queried data type
Whether to obtain cascaded subordinate data: 0—no;
isDomain number
1—yes
nodes object Node information
- nodeId string Node number
Whether the node needs to be queried: true—no;
- checked boolean
false—yes
Length of the returned data. All data is returned by
size number
default if the parameter is left blank.

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"results": [
{
"nodeId": "1000000",
"nodeName": "37790",
"pId": "001001",
"gId": "001",
"nodeType": "2"
}
],
"hasMoreNodes": false
}
}

Description of return parameters

Parameter
Type Description
Name
code number Error code
desc string Result description
data object None
- results object None
- - nodeId string Node ID
- - nodeName string Node name
- - pId string Parent node ID
- - gId string Grandparent node ID
Node type: 1—organization; 2—device; 3—
- - nodeType string
channel
Whether there are more nodes: true—yes; false—
- hasMoreNodes boolean
no

Notes

• For more returned error codes, see the error code

description on the home page

4.3、Basic Data

4.3.1、Obtain APP users

Brief description：

• Obtain APP users

Request URL：

• /admin/API/BRM/App/GetAppUsers?token={token}

Request example

POST /admin/API/BRM/App/GetAppUsers?token=247634b4d5f74d298b511af4011
b2de0 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.App.GetAppUsers",
"data": {
"optional": "/admin/API/BRM/App/GetAppUsers?token=247634b4d5f
74d298b511af4011b2de0",
"pageInfo": {
"pageSize": "20",
"pageNo": "1"
},
"searchInfo": {
"keyword": "",
"status": "-1"
}
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- pageInfo object Pagination Information
- - pageSize string Records on each page
- - pageNo string Page
- searchInfo object Search condition
Parameter
Type Description
Name
Keyword, supporting fuzzy search by VTH device
- - keyword string
name, app user name, or SIP code
- - status string User status: -1—all; 0—frozen; 1—normal

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"appUsers": [
{
"userId": "8",
"userName": "1",
"userType": "2",
"deviceName": null,
"sip": "1#1#8002#177",
"lastLoginDate": "1539334022",
"status": "1",
"lastUpdatePasswordDate": "1539335209"
},
{
"userId": "12",
"userName": "12345678901234567891",
"userType": "2",
"deviceName": null,
"sip": "1#1#8002#196",
"lastLoginDate": "1539334752",
"status": "1",
"lastUpdatePasswordDate": null
},
{
"userId": "58",
"userName": "lyc",
"userType": "2",
"deviceName": "VTH-10.35.208.53",
"sip": "8#8#6006#161",
"lastLoginDate": "1540274178",
"status": "1",
"lastUpdatePasswordDate": null
},
{
"userId": "6",
"userName": "q",
"userType": "2",
"deviceName": null,
"sip": "1#1#8001#141",
"lastLoginDate": null,
"status": "1",
"lastUpdatePasswordDate": null
}
],
"totalCount": "4"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- appUsers object List of app users
- - userId string User ID
- - userName string APP user name
User type: 1—PC user; 2—Android user; 3—
- - userType string
iOS user
- - deviceName string VTH device name
- - sip string SIP code
- - lastLoginDate string Previous login time, time stamp (s)
- - status string User status: 0—frozen; 1—normal
-- Previous password modification time, time
string
lastUpdatePasswordDate stamp (s)
- totalCount string Total number of records

Notes

• For more returned error codes, see the error code

description on the home page

4.3.2、Getting MQ Configuration

Brief description：

• Get MQ configuration. Determine whether it is internal

network or external network based on the IP of the
client request, and return the corresponding
configuration
Request URL：

• /admin/API/BRM/Config/GetMqConfig?token={token}

Request example

POST /admin/API/BRM/Config/GetMqConfig?token=30c5f6bea5a643eaa761580c
b762d787 HTTP/1.1
Host: 10.35.92.66
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Config.GetMqConfig",
"data": {
"optional": "/admin/API/BRM/Config/GetMqConfig?token=30c5f6be
a5a643eaa761580cb762d787"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string none
project string none
method string Method name
data object none
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"userName": "",
"addr": "10.35.93.12:61616",
"mqtt": "10.35.93.12:1883",
"password": ""
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
- userName string User name
- addr string MQ IP for PC
- mqtt string MQ IP for APP
Password, use AES encryption, KEY:
- password string
4rfvgy7UJMko0pqa

Notes

• For more returned error codes, see the error code

description on the home page

4.3.3、Obtain corresponding dictionary data based on dictionary types

Brief description：

• Obtain corresponding dictionary data based on

dictionary types

Request URL：

• /OTMS/API/BRM/SysCode/GetSysCodes?token={token}

Request example

POST /OTMS/API/BRM/SysCode/GetSysCodes?token=247634b4d5f74d298b511af4
011b2de0 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.SysCode.GetSysCodes",
"data": {
"locale": "zh_CN",
"optional": "/OTMS/API/BRM/SysCode/GetSysCodes?token=8cf21435
4bd44250b286ef5f8bd6fb2d",
"itemType": "2017"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- locale string Language, such as zh_CN and en
- optional string URI information
- itemType string Dictionary type

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"list": [
{
"itemCode": "0",
"itemName": "unrecognized",
"itemPar1": "",
"itemPar2": "",
"memo": "unrecognized",
"sort": "1"
},
...
{
"itemCode": "15",
"itemName": "other plate",
"itemPar1": "",
"itemPar2": "",
"memo": "other plate",
"sort": "16"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- list object None
- - id string Item ID
- - itemCode string Item code
- - itemName string Item name
- - itemPar1 string Parameter 1
- - itemPar2 string Parameter 2
- - itemType string Type code, namely dictionary type ID
- - itemTypeName string Type name, namely dictionary type name
- - memo string Item description
- - sort string Sorting code
- - stat string Status

Notes

• For more returned error codes, see the error code

description on the home page

4.3.4、Time has been synchronized

Brief description：
• Synchronize time (obtain server time)

Request URL：

• /admin/API/BRM/Time/SyncTime?token={token}

Request example

POST /admin/API/BRM/Time/SyncTime?token=247634b4d5f74d298b511af4011b2
de0 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Time.SyncTime",
"data": {
"optional": "/admin/API/BRM/Time/SyncTime?token=27dfbe49c51b4
ad6be53dd894dd61d17"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example
{
"code": 1000,
"desc": "Success",
"data": {
"systemTime": "1540626127",
"offset": "3690"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- systemTime string System time (s)
- offset string Time offset (s)

Notes

• For more returned error codes, see the error code

description on the home page

4.3.5、Obtain dictionary data

Brief description：

• Obtain dictionary types

Request URL：

• /admin/API/dictionarys?locale={locale}&types={types}
• X-Subject-Token: {token}

Request example

GET /admin/API/dictionarys?locale=zh_CN&types=2 HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: f7d67bc324de43dda49b4c1a4302f601
Parameter Name Type Description
locale string International language, such as zh_CN and en
types string Search type
token string The token obtained when logging in
Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"dictionaries": [
{
"id": "20301",
"code": "1",
"name": "dict.device.type.type1",
"i18nName": "alarm host",
"param1": "3",
"sort": "1",
"status": "1",
"memo": “type 1",
"typeCode": "2",
"allowEdit": "0",
"allowDelete": "0"
},
{
"id": "24001",
"code": "1",
"name": "dict.device.type.pos.adapterBox",
"i18nName": "POS device",
"param1": "40",
"sort": "1",
"status": "1",
"memo": "POS adapter box",
"typeCode": "2",
"allowEdit": "0",
"allowDelete": "0"
},
...
{
"id": "20904",
"code": "1",
"name": "dict.device.type.mike",
"i18nName": "microphone",
"param1": "10",
"sort": "1",
"status": "1",
"typeCode": "2",
"allowEdit": "0",
"allowDelete": "0"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- dictionaries object None
- - id string Self-added ID
- - code string Item code
- - name string Item name
- - i18nName string Internationalized item name
- - param1 string Parameter 1
- - param2 string Parameter 2
- - sort string Sorting code
- - status string Status
- - memo string Remarks
- - typeCode string Type code
- - allowEdit string Edit allowed
- - allowDelete string Deletion allowed

Notes

• For more returned error codes, see the error code

description on the home page

4.3.6、Obtain the time and time zone on the server

Brief description：
• Obtain the time and time zone on the server

Request URL：

• /admin/API/BRM/Time/SyncServerTime?token={token}

Request example

POST /admin/API/BRM/Time/SyncServerTime?token=27dfbe49c51b4ad6be53dd8
94dd61d17 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Time.SyncServerTime",
"data": {
"optional": "/admin/API/BRM/Time/SyncServerTime?token=27dfbe4
9c51b4ad6be53dd894dd61d17"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example
{
"code": 1000,
"desc": "Success",
"data": {
"dateTime": "2019-09-02 15:30:26",
"timeZone": "13"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- dateTime string Server time, format: yyyy-MM-dd HH:mm:ss
- timeZone string Server time zone
timeZone:
0:GMT+00:00,1:GMT+01:00,2:GMT+02:00,3:GMT+03:00,4:GMT+03:30,5:GMT+04:
00,
6:GMT+04:30,7:GMT+05:00,8:GMT+05:30,9:GMT+05:45,10:GMT+06:00,11:GMT+0
6:30,
12:GMT+07:00,13:GMT+08:00,14:GMT+09:00,15:GMT+09:30,16:GMT+10:00,17:G
MT+11:00,
18:GMT+12:00,19:GMT+13:00,20:GMT-01:00,21:GMT-02:00,22:GMT-03:00,23:G
MT-03:30,
24:GMT-04:00,25:GMT-05:00,26:GMT-06:00,27:GMT-07:00,28:GMT-08:00,29:G
MT-09:00,
30:GMT-10:00,31:GMT-11:00,32:GMT-12:00,33:GMT-04:30,34:GMT+10:30,35:G
MT+14:00,
36:GMT-09:30,37:GMT+08:30,38:GMT+08:45,39:GMT+12:45

Notes

• For more returned error codes, see the error code

description on the home page

4.3.7、Obtain all menus

Brief description：

• Obtain all menus

Request URL：

• /admin/API/Rights/Nodes
• X-Subject-Token: {token}

Request example

GET /admin/API/Rights/Nodes HTTP/1.1

Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: fa8a44e51852482a8879705d6a3668ff
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"menuNodes": [
{
"menuId": "001001"
},
{
"menuId": "002001"
},
{
"menuId": "001002"
},
{
"menuId": "002002"
}
],
"functionNodes": [
{
"function": "1"
},
{
"function": "2"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- menuNodes object Menu permission information
- - menuId string Permission code
- functionNodes object Permission node information
- - function string Permission node

Notes

• For more returned error codes, see the error code

description on the home page

4.4、User Data

4.4.1、Obtain menu right

Brief description：

• Obtain menu permissions

Request URL：

• /admin/API/BRM/User/GetMenuRights?token={token}

Request example

POST /admin/API/BRM/User/GetMenuRights?token=247634b4d5f74d298b511af4
011b2de0 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in
Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.User.GetMenuRights",
"data": {
"optional": "/admin/API/BRM/User/GetMenuRights?token=87cadb78
af7e48538cc68ab6cfda2212"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"menuRights": [
"002005",
"002026",
"002007",
"001002",
"002022",
"001014",
"002010"
],
"forbiddenMenus": [
"002009"
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- menuRights object Menu code
- forbiddenMenus object Disable menu code

Notes

• For more returned error codes, see the error code

description on the home page

4.4.2、Obtain a list of users with permissions for resources

Brief description：

• Obtain a list of users who have permissions on a

resource (device/channel)

Request URL：

• /admin/API/BRM/User/GetRightUsers?token={token}

Request example

POST /admin/API/BRM/User/GetRightUsers?token=cf3abd1e36324233807cb3ce
0c50de24 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.User.GetRightUsers",
"data": {
"resourceId": "1000002$1$0$0",
"optional": "/admin/API/BRM/User/GetRightUsers?token=cf3abd1e
36324233807cb3ce0c50de24"
}
}

Parameters：

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"users": [
"system"
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- users object User name list
Notes

• For more returned error codes, see the error code

description on the home page

4.4.3、Obtain currently-authorized channel count

Brief description：

• Obtain the number of channels on which the current user

have permissions

Request URL：

• /admin/API/BRM/User/GetChannelsCount?token={token}

Request example

POST /admin/API/BRM/User/GetChannelsCount?token=cf3abd1e36324233807cb
3ce0c50de24 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.User.GetChannelsCount",
"data": {
"optional": "/admin/API/BRM/User/GetChannelsCount?token=cf3ab
d1e36324233807cb3ce0c50de24"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"count": "305"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- count string Number of channels

Notes

• For more returned error codes, see the error code

description on the home page

4.4.4、Obtain user operation permissions

Brief description：

• Obtain user operation permissions

Request URL：

• /admin/API/BRM/User/GetUserFunctions?token=${token}

Request example

POST /admin/API/BRM/User/GetUserFunctions?token=fa8a44e51852482a88797
05d6a3668ff HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.User.GetUserFunctions",
"data": {
"optional": "/admin/API/BRM/User/GetUserFunctions?token=fa8a4
4e51852482a8879705d6a3668ff"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"functions": [
"1",
"5",
"6",
"2",
"3"
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- functions string Operation permission code

Notes

• For more returned error codes, see the error code

description on the home page

4.5、Intercom Preview

4.5.1、Acquiring the Current Stream Encryption Key

Brief description:

• Acquiring the Current Stream Encryption Key

Request URL:

• /admin/API/BRM/Device/GetCurrentMediaVK?token={token}

Request example

POST /admin/API/BRM/Device/GetCurrentMediaVK?token=efd43db9b272493e86
4789c122eb4530 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• POST

Request example
{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Device.GetCurrentMediaVK",
"data": {
"deviceCode": "1000207",
"optional": "/admin/API/BRM/Device/GetCurrentMediaVK?token=ef
d43db9b272493e864789c122eb4530"
}
}

Parameters:

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string None
project string None
method string Method name
data object None
- deviceCode string Device code
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"vkId": "ARSni0ctAQ+Y01sAz5BBCQ==",
"vkValue": "mr9TWihPFfX3EfCPyS3NY10q9G8x6znmQn/OggHzwL4=",
"createDate": "1540620012"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- vkId string Secret key ID
Parameter Name Type Description
- vkValue string Secret key
- createDate string Generation time(second)

Notes

• For more returned error codes, see the error code

description on the home page

plan4.5.2、Start the Real-Time Video

Brief description:

• Start the real-time video

Request URL:

• /admin/API/MTS/Video/StartVideo?token={token}

Request example

POST /admin/API/MTS/Video/StartVideo?token=06ffde47197c4e6aae3c00db35
03ee12 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4D:7E:C6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "MTS.Video.StartVideo",
"data": {
"streamType": "1",
"optional": "/admin/API/MTS/Video/StartVideo?token=06ffde4719
7c4e6aae3c00db3503ee12",
"trackId": "",
"keyCode": "",
"extend": "",
"channelId": "1000003$1$0$0",
"planId": "",
"dataType": "2"
}
}

Parameters:

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string None
project string None
method string Method name
data object None
- streamType string Stream type: 1—Main stream; 2—Auxiliary stream
- optional string URI information
- trackId string Track ID
- keyCode string Keycode
- extend string Extended data
- channelId string Video channel code
- planId string Record plan ID
Video type: 1—Video; 2—Audio; 3—Audio and video;
- dataType string
not use yet, and can't be null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"minRate": null,
"protocol": null,
"ip": null,
"port": null,
"stunEnable": null,
"stunPort": null,
"url": "rtsp://10.35.92.55:9100/dss/monitor/param/cameraid=10
00040%240%26substream=1",
"connectType": null,
"session": "2204",
"token": "2204",
"trackId": ""
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
Minimum code stream, namely the minimum code
- minRate string
stream requirement for customers
- protocol string Protocol: 1—CNM3, 2—RTSP
IP address, namely the IP address of the transferring
- ip string server or the IP address of the device, depending on
the type
- port string Port
Whether the STUN protocol is supported: 1—
- stunEnable string
Supported; 0—Not supported
- stunPort string Port of the STUN protocol
- url string RTSP address, which is incompatible with VDTS IP/Port
- connectType string Type: 1—Forwarding mode; 2—Direct connection mode
- session string Session ID
- token string Token
- trackId string Track ID

Notes

• For more returned error codes, see the error code

description on the home page

4.5.3、Start voice call

Brief description：

• Start voice call

Request URL：

• /admin/API/MTS/Audio/StartTalk?token={token}

Request example

POST /admin/API/MTS/Audio/StartTalk?token=06ffde47197c4e6aae3c00db350
3ee12 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "MTS.Audio.StartTalk",
"data": {
"optional": "/admin/API/MTS/Audio/StartTalk?token=ff93dabe5d7
54ea8acb0a95dbe6c4a0f",
"source": "",
"deviceCode": "1000040",
"talkType": "1",
"target": "",
"audioBit": "16",
"audioType": "1",
"broadcastChannels": "",
"sampleRate": "8000",
"talkmode": "",
"channelSeq": "0"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- source string GB code, client number, usually 18 digits
Parameter Name Type Description
- deviceCode string Device code
Voice call type: 1—device; 2—channel; 3—GB
- talkType string
device broadcast
- target string GB code, device number, usually 18 digits
Represented by the actual value. If there are 8
- audioBit string
digits, the value is 8.
Refer to the relevant definition of NETSDK, 0—
- audioType string
default; 1-PCM; 2-G711a; 3-AMR; 4-G711u; 5-G726
-
string Broadcast channel, used for broadcast voice call
broadcastChannels
Sampling rate. If the sampling rate is 16k, the value
- sampleRate string
is 16000.
Voice call mode: 0—talk (default); 1—broadcast
- talkmode string (resetting required for switching from broadcast to
talk)
Channel sequence number, used for channel voice
- channelSeq string
call

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"deviceCode": "1000040",
"url": "rtsp://10.35.92.55:9100/talk/pu/2380",
"token": "2",
"session": "2380",
"audioType": "1",
"audioBit": "16",
"sampleRate": "8000",
"protocolType": "3"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- deviceCode string Device code
- url string RTSP address, which is incompatible with VDTS IP/Port
Parameter
Type Description
Name
- token string RTSP token
- session string Voice call session
If the audio type requested by the client is supported,
use the original type. Otherwise, send audios with the
types of G711a, G711u, PCM, G726, AMR, and DEFAULT
- audioType string
based on the priority. If none of these audio types exists
in the device, use the first audio type provided by the
device.
Represented by the actual value. If there are 8 digits, the
- audioBit string
value is 8.
Sampling rate. If the sampling rate is 16k, the value is
- sampleRate string
16000.
- Protocol type. For example, the value 3 indicates the
string
protocolType third-generation device of Intelbras.

Notes

• For more returned error codes, see the error code

description on the home page

4.5.4、Stop voice call

Brief description：

• Stop voice call

Request URL：

• /admin/API/MTS/Audio/StopTalk?token={token}

Request example

POST /admin/API/MTS/Audio/StopTalk?token=06ffde47197c4e6aae3c00db3503
ee12 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example
{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "MTS.Audio.StopTalk",
"data": {
"talkType": "1",
"optional": "/admin/API/MTS/Audio/StopTalk?token=ff93dabe5d75
4ea8acb0a95dbe6c4a0f",
"source": "",
"deviceCode": "1000040",
"target": "",
"session": "2380",
"channelSeq": ""
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
Voice call type: 1—device; 2—channel; 3—GB device
- talkType string
broadcast
- optional string URI information
- source string GB code, client number, usually 18 digits
- deviceCode string Device code
- target string GB code, device number, usually 18 digits
- session string Forwarding session ID
Channel sequence number, used for channel voice
- channelSeq string
call

Return example

{
"code": 1000,
"desc": "Success"
}
Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.5.5、Obtain channel video snapshots

Brief description：

• Obtain channel video snapshots

Request URL：

• /admin/API/capture/channel/{channelId}
• X-Subject-Token: {token}

Request example

GET /admin/API/capture/channel/1000000$1$0$0 HTTP/1.1

Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 25d4aa48f6884c7b90855ffc429e201e
Parameter Name Type Description
token string The token obtained when logging in
channelId string Channel ID

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"url": "https://10.35.93.12:50001/c3e238ad-9ca7-11e9-a84c-ecb
1d753ad2b/20190702/6/dsf_93f3d80e-9cbe-11e9-9104-ecb1d753ad2b_0_3585
9.jpg"
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- url string Video snapshot URL

Notes

• For more returned error codes, see the error code

description on the home page

4.6、PTZ Control

4.6.1、Save tours[99]

Brief description：

• Save tours

Request URL：

• /admin/API/DMS/Cruise/SaveCruise?token={token}

Request example

POST /admin/API/DMS/Cruise/SaveCruise?token=47848a8ec87f4765924f86e56
eb331d9 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST
Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Cruise.SaveCruise",
"data": {
"cruiseId": "1",
"optional": "/admin/API/DMS/Cruise/SaveCruise?token=47848a8ec
87f4765924f86e56eb331d9",
"data": "</Cruise&\n</CruiseConfig&\n",
"channelId": "1000296$1$0$0"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- cruiseId string Tours ID
- optional string URI information
- data string Tours data
- channelId string Channel No.

注:

巡航线 XML 数据标签释义:

Cruise: id-巡航线编码,目前只支持 8 条巡航线,即 id 值取 1-8; name-巡航线
名称; pointId-该条巡航线的预置点数量
PrePoint: id-巡航线巡航序号,按序连续,不可重复; code-预置点编码; stay-
停留时长(秒)

Return example

{
"code": 1000,
"desc": "Success"
}
Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.6.2、Obtain tours[99]

Brief description：

• Obtain tours

Request URL：

• /admin/API/DMS/Cruise/GetCruises?token={token}

Request example

POST /admin/API/DMS/Cruise/GetCruises?token=864f84d52df141c3a005a062d
47f29b9 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Cruise.GetCruises",
"data": {
"channelId": "1000296$1$0$0",
"optional": "/admin/API/DMS/Cruise/GetCruises?token=864f84d52
df141c3a005a062d47f29b9"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- channelId string Channel No.
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"cruises": [
{
"channelId": "1000296$1$0$0",
"cruiseId": "0",
"data": "</Cruise&\n </Cruise&\n</CruiseConfig&\n"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- cruises object Tours information
- - channelId string Channel No.
- - cruiseId string Tours ID
- - data string Tours data

注:
巡航线 XML 数据标签释义:
Cruise: id-巡航线编码,目前只支持 8 条巡航线,即 id 值取 1-8; name-巡航线
名称; pointId-该条巡航线的预置点数量
PrePoint: id-巡航线巡航序号,按序连续,不可重复; code-预置点编码; stay-
停留时长(秒)

Notes

• For more returned error codes, see the error code

description on the home page

4.6.3、PTZ negotiation

Brief description：

• PTZ negotiation

Request URL：

• /admin/API/DMS/Ptz/ArrangePtz?token={token}

Request example

POST /admin/API/DMS/Ptz/ArrangePtz?token=6edaadfa181d46d1af51a813b5bf
a8ee HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.ArrangePtz",
"data": {
"optional": "/admin/API/DMS/Ptz/ArrangePtz?token=6edaadfa181d
46d1af51a813b5bfa8ee",
"extend": "",
"channelId": "1000296$1$0$0",
"lockTime": "0",
"operateType": "1"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- extend string Extended data
- channelId string Channel No.
Lock time (s), 0 means always locked until released or
- lockTime string
robbed
Operation type: 0-unknown; 1-locking the current
camera; 2-unlocking the current camera; 3-unlocking all
- operateType string
the cameras locked by this user; 4-locking all cameras;
5-search the lock status

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
Parameter
Type Description
Name
desc string Result description
data object None
Operation result: 0-failure; 1-success; refer to LockUser
- result string when failed. When searching the locking status: 0-
unlocked; 1-locked
- lockUser object None
- - userName int Name of the user locking the PTZ in a control failure
- - userLevel int Level of the user locking the PTZ in a control failure

Notes

• For more returned error codes, see the error code

description on the home page

4.6.4、Obtain presets

Brief description：

• Obtain presets

Request URL：

• /admin/API/DMS/Ptz/GetPresetPoints?token={token}

Request example

POST /admin/API/DMS/Ptz/GetPresetPoints?token=95ca360984814ea292b4b91
9c4f7d3ac HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.GetPresetPoints",
"data": {
"channelId": "1000296$1$0$0",
"optional": "/admin/API/DMS/Ptz/GetPresetPoints?token=95ca360
984814ea292b4b919c4f7d3ac"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"channelId": "1000296$1$0$0",
"presetPoints": [
{
"channelId": "1000296$1$0$0",
"presetPointCode": "1",
"presetPointName": "1"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- channelId string Channel No.
Parameter Name Type Description
- presetPoints object Preset information
- - presetPointCode string Preset code
- - presetPointName string Preset name

Notes

• For more returned error codes, see the error code

description on the home page

4.6.5、PTZ lens control

Brief description：

• PTZ lens control

Request URL：

• /admin/API/DMS/Ptz/OperateCamera?token={token}

Request example

POST /admin/API/DMS/Ptz/OperateCamera?token=309f70b3723946c09e6341bba
dbec712 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.OperateCamera",
"data": {
"optional": "/admin/API/DMS/Ptz/OperateCamera?token=309f70b37
23946c09e6341bbadbec712",
"extend": "",
"direct": "1",
"command": "0",
"channelId": "1000008$1$0$0",
"step": "4",
"operateType": "1"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data onject Null
- optional string URI information
- extend string Extended data
- direct string Direction: 1-increase; 2-decrease
- command string Command: 0-stop; 1-start
- channelId string Channel No.
- step string speed
- operateType string Operation type: 1-zoom; 2-focus; 3-iris

Return example

The PTZ is not locked by any user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "1",
"lockUser": null
}
}

The PTZ is locked by some user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
Operation result: 0-failure; 1-success; refer to
- result string
LockUser when failed.
- lockUser object information of the user locking the PTZ
- - userName string Name of the user locking the PTZ
- - userLevel string Level of the user locking the PTZ

Notes

• For more returned error codes, see the error code

description on the home page

4.6.6、PTZ direction control

Brief description：

• Control the PTZ direction

Request URL：

• /admin/API/DMS/Ptz/OperateDirect?token={token}

Request example

POST /admin/API/DMS/Ptz/OperateDirect?token=ea1007f71bbc46d2a9e0575b8
ec82d8a HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：
• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.OperateDirect",
"data": {
"optional": "/admin/API/DMS/Ptz/OperateDirect?token=ea1007f71
bbc46d2a9e0575b8ec82d8a",
"stepY": "6",
"extend": "",
"direct": "4",
"channelId": "1000171$1$0$0",
"stepX": "6",
"command": "0"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- stepY string speed in the vertical direction
- extend string Extended data
Direction: 1-up; 2-down; 3-left; 4-right; 5-upper left; 6-
- direct string
lower left; 7-upper right; 8-lower right
- channelId string Channel No.
- stepX string speed in the horizontal direction
- command string Command: 0-stop; 1-start

Return example The PTZ is not locked by any user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "1",
"lockUser": null
}
}

The PTZ is locked by some user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Notes

• For more returned error codes, see the error code

description on the home page

4.6.7、Presets control

Brief description：

• Preset control (positioning/setting/deletion/work time)

Request URL：
• /admin/API/DMS/Ptz/OperatePresetPoint?token={token}

Request example

POST /admin/API/DMS/Ptz/OperatePresetPoint?token=20a40ddc867f4bd68e50
8bf5a6c35dc7 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.OperatePresetPoint",
"data": {
"optional": "/admin/API/DMS/Ptz/OperatePresetPoint?token=20a4
0ddc867f4bd68e508bf5a6c35dc7",
"presetPointCode": "1",
"endTime": "",
"presetPointName": "prepoint1",
"channelId": "1000171$1$0$0",
"startTime": "",
"operateType": "1"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
Parameter
Type Description
Name
data object None
- optional string URI information
- presetPointCode string Preset code
- endTime string End time (s)
- presetPointName string Preset name
- channelId string Channel No.
- startTime string Start time (s)
Operation type: 1-position; 2-set; 3-delete; 4-update
- operateType string
work time

Return example

The PTZ is not locked by any user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "1",
"lockUser": null
}
}

The PTZ is locked by some user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
Parameter
Type Description
Name
data object None
Operation result: 0-failure; 1-success; refer to
- result string
LockUser when failed.
- lockUser string information of the user locking the PTZ
- - userName string Name of the user locking the PTZ
- - userLevel string Level of the user locking the PTZ

Notes

• For more returned error codes, see the error code

description on the home page

4.6.8、Alarm output control

Brief description：

• Alarm output control

Request URL：

• /admin/API/DMS/Alarm/SetAlarmOutStatus?token={token}

Request example

POST /admin/API/DMS/Alarm/SetAlarmOutStatus?token=982a26c86c05459497b
8509b360c71ca HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Alarm.SetAlarmOutStatus",
"data": {
"command": "2",
"optional": "/admin/API/DMS/Alarm/SetAlarmOutStatus?token=982
a26c86c05459497b8509b360c71ca",
"channelId": "1000171$4$0$0",
"operateType": "0"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
Control command: for status control, 1-on; 0-off; for
- command string
mode control, 0-off; 1-automatic; 2-manual
- optional string URI information
- channelId string Channel No.
- operateType string Control type: 1-status control; 2-mode control

Return example

The PTZ is not locked by any user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "1",
"lockUser": null
}
}

The PTZ is locked by some user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
Operation result: 0-failure; 1-success; refer to
- result string
LockUser when failed.
- lockUser string information of the user locking the PTZ
- - userName string Name of the user locking the PTZ
- - userLevel string Level of the user locking the PTZ

Notes

• For more returned error codes, see the error code

description on the home page

4.6.9、Obtain electric focus status

Brief description：

• Obtain electric focus status

Request URL：

• /admin/API/DMS/Ptz/GetFocusStatus?token={token}

Request example

POST /admin/API/DMS/Ptz/GetFocusStatus?token=e3051e858fd34fa99a7d5bca
cec41bad HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：
• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.GetFocusStatus",
"data": {
"channelId": "1000024$1$0$0",
"optional": "/admin/API/DMS/Ptz/GetFocusStatus?token=e3051e85
8fd34fa99a7d5bcacec41bad"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"channelId": "1000024$1$0$0",
"status": "0",
"zoom": "0.000000",
"focus": "0.973770"
}
}

Description of return parameters

Parameter Name Type Description

Parameter Name Type Description
code int Error code
desc string Result description
data object None
- channelId string Channel No.
- status string Focus status: 0-normal; 1-automatic focusing
- zoom string Zoom times
- focus string Focal length

Notes

• For more returned error codes, see the error code

description on the home page

4.6.10、Electric focus control

Brief description：

• Electric focus control

Request URL：

• /admin/API/DMS/Ptz/OperateFocus?token={token}

Request example

POST /admin/API/DMS/Ptz/OperateFocus?token=1c91676bde65406bba60c9938e
e616f5 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.OperateFocus",
"data": {
"optional": "/admin/API/DMS/Ptz/OperateFocus?token=1c91676bde
65406bba60c9938ee616f5",
"focus": "0.97",
"channelId": "1000024$1$0$0",
"zoom": "0.05",
"operateType": "0",
"lensType": "1"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- focus string Focal length
- channelId string Channel No.
- zoom string Zoom times
Operation type: 0-reset; 1-continuous focusing; 2-
- operateType string
automatic focusing
Lens type: 1-embedded vari-focal lens; 2-manual vari-
- lensType string
focal lens; 3-external vari-focal lens

Return example

The PTZ is not locked by any user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "1",
"lockUser": null
}
}

The PTZ is locked by some user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- result string Operation result: 0-failure; 1-success
- lockUser string information of the user locking the PTZ
- - userName string Name of the user locking the PTZ
- - userLevel string Level of the user locking the PTZ

Notes

• For more returned error codes, see the error code

description on the home page

4.6.11、3-dimensional positioning or radar and speed dome positioning

Brief description：

• 3-dimensional positioning/radar and speed dome

positioning

Request URL：

• /admin/API/DMS/Ptz/SitPosition?token={token}

Request example

POST /admin/API/DMS/Ptz/SitPosition?token=9c3ea5f38e944e4e9c6f647e611
07fb9 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.SitPosition",
"data": {
"optional": "/admin/API/DMS/Ptz/SitPosition?token=9c3ea5f38e9
44e4e9c6f647e61107fb9",
"pointZ": "8",
"extend": "1",
"channelId": "1000296$1$0$0",
"pointY": "326",
"pointX": "-1039"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- pointZ string Zoom times: -4 - 4
Extension data: 1- 3-dimensional common positioning;
- extend string 2- 3-dimensional accurate positioning; 3-radar and
speed dome positioning
- channelId string Channel No.
- pointY string Vertical coordinate: -8192 - 8192
- pointX string Horizontal coordinate: -8192 - 8192
Return example

The PTZ is not locked by any user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "1",
"lockUser": null
}
}

The PTZ is locked by some user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
Operation result: 0-failure; 1-success; refer to
- result string
LockUser when failed.
- lockUser object Information locked by user
- - userName string Name of the user locking the PTZ
- - userLevel string Level of the user locking the PTZ

Notes

• For more returned error codes, see the error code

description on the home page

4.6.12、Obtain the PTZ position information

Brief description：

• Obtain the PTZ position information

Request URL：

• /admin/API/DMS/Ptz/GetPosition?token={token}

Request example

POST /admin/API/DMS/Ptz/GetPosition?token=48b0fab46f684781a30faba8215
0ba71 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.GetPosition",
"data": {
"channelId": "1000125$1$0$3",
"optional": "/admin/API/DMS/Ptz/GetPosition?token=48b0fab46f6
84781a30faba82150ba71"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
Parameter Name Type Description
- channelId string Channel No.
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"channelId": "1000125$1$0$3",
"pointX": "3105",
"pointY": "387",
"pointZ": "128"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- channelId string Channel No.
- pointX string Horizontal coordinate: -8192 - 8192
- pointY string Vertical coordinate: -8192 - 8192
- pointZ string Zoom times: -4 - 4

Notes

• For more returned error codes, see the error code

description on the home page

4.6.13、PTZ function control

Brief description：

• PTZ function control

Request URL：

• /admin/API/DMS/Ptz/OperateFunction?token={token}

Request example

POST /admin/API/DMS/Ptz/OperateFunction?token=4d6948b8d77b43fc86d2ee7
f7100b6af HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.OperateFunction",
"data": {
"optional": "/admin/API/DMS/Ptz/OperateFunction?token=4d6948b
8d77b43fc86d2ee7f7100b6af",
"extend": "",
"target": "0",
"channelId": "1000171$1$0$0",
"command": "0",
"operateType": "25"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- extend string Extended data
Operation target, valid only when
- target string
operateType=[14,19,20,21], 0 in other conditions
- channelId string Channel No.
Parameter
Type Description
Name
Command: 0-stop; 1-start; valid only when
- command string operateType=[11,12,13,14,15,18,19,20,21], 0 in other
conditions
-
string See notes for detailed value description.
operateType

Notes operateType

Operation type: 11-light (target=0); 12- wiper (target=0); 13-infrare

d light (target=0); 14-tour (target=tour ID); 15-automatic rotation
(target=0); 16-setting the left border for line scan (target=0); 17-s
etting the right border for line scan (target=0); 18-line scan (targe
t=0); 19-setting tour track (target=tour track ID); 20-pattern (targe
t=tour track ID); 21-auxiliary (target=auxiliary command); 22-opening
the PTZ menu (target=0); 23-closing the PTZ menu (target=0); 24-conf
irming the PTZ menu (target=0); 25-moving the PTZ menu upwards (targe
t=0); 26-moving the PTZ menu downwards (target=0); 27-moving the PTZ
menu leftwards (target=0); 28-moving the PTZ menu rightwards (target=
0)

Return example

The PTZ is not locked by any user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "1",
"lockUser": null
}
}

The PTZ is locked by some user

{
"code": 1000,
"desc": "Success",
"data": {
"result": "0",
"lockUser": {
"userName": "system",
"userLevel": "10"
}
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
Operation result: 0-failure; 1-success; refer to
- result string
LockUser when failed.
- lockUser string information of the user locking the PTZ
- - userName string Name of the user locking the PTZ
- - userLevel string Level of the user locking the PTZ

Notes

• For more returned error codes, see the error code

description on the home page

4.6.14、Search the lens information

Brief description：

• Search the lens information

Request URL：

• /admin/API/DMS/Ptz/GetLensInfo?token={token}

Request example

POST /admin/API/DMS/Ptz/GetLensInfo?token=309f70b3723946c09e6341bbadb
ec712 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example
{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Ptz.GetLensInfo",
"data": {
"optional": "/admin/API/DMS/Ptz/GetLensInfo?token=309f70b3723
946c09e6341bbadbec712",
"channelId": "1000000$1$0$0"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"type": "1"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
Lens type: 1-embedded vari-focal lens; 2-manual vari-
- type string
focal lens; 3-external vari-focal lens
Notes

• For more returned error codes, see the error code

description on the home page

4.7、Device Management

4.7.1、Obtain the information about all associated channels

Brief description：

• Obtain the information about all associated channels

Request URL：

• /admin/API/BRM/Linked/GetLinkedChannels?token={token}

Request example

POST /admin/API/BRM/Linked/GetLinkedChannels?token=dbd76d4034a44ba5a0
41cbffa0e52082 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Linked.GetLinkedChannels",
"data": {
"optional": "/admin/API/BRM/Linked/GetLinkedChannels?token=db
d76d4034a44ba5a041cbffa0e52082"
}
}

Parameters：
Parameter Name Type Description
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"channels": [
{
"srcChannelId": "1000029$7$0$0",
"dstChannelIds": [
"1000017$1$0$0"
],
"location": "1"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- channels object Associated information
- - srcChannelId string Source channel No.
- - dstChannelIds object Associated channel No.
Recording storage location, not used for now, 1 by
- - location string
default

Notes

• For more returned error codes, see the error code description
on the home page
4.7.2、Obtain device type

Brief description：

• Obtain device type (category + subcategory)

Request URL：

• /admin/API/devicesManager/deviceTypes?local={local}
• X-Subject-Token: {token}

Request example

GET /admin/API/devicesManager/deviceTypes?local=zh HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: cbfd3c31ad7345bc807230b51b8eb7bf
Parameter Name Type Description
local string Language, such as zh and en
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"groups": [
{
"categoryId": "1",
"categoryName": "Encoder",
"deviceTypes": [
{
"typeId": "1",
"typeCode": "DVR",
"typeName": "DVR"
},
{
"typeId": "43",
"typeCode": "IVSS",
"typeName": "IVSS"
}
]
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- groups object None
- - categoryId string Device category ID
- - categoryName string Device category name
- - deviceTypes object Device subcategory information
- - - typeId string Device subcategory ID
- - - typeCode string Device subcategory code
- - - typeName string Device subcategory name

Notes

• For more returned error codes, see the error code description
on the home page

4.7.3、Search the reason for device offline

Brief description：

• Search the reason for device offline

Request URL：

• /admin/API/devicesManager/devices/offlineReasons?deviceCodes={
deviceCodes}
• X-Subject-Token: {token}

Request example
GET /admin/API/devicesManager/devices/offlineReasons?deviceCodes=1000
004 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: cbfd3c31ad7345bc807230b51b8eb7bf
Parameter Name Type Description
deviceCodes string Device codes, separated by commas
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"offlineReasons": [
{
"deviceCode": "1000004",
"offlineReason": "9"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- offlineReasons object Device offline information
- - deviceCode string Device code
- - offlineReason string Offline error code
Notes

• For more returned error codes, see the error code description
on the home page

4.7.4、Search device information

Brief description：

• Search device information

Request URL：

• /admin/API/devicesManager/devices/{deviceCode}?fetchFlag={fetc
hFlag}&protocolType={protocolType}&deviceIp={deviceIp}&devic
ePort={devicePort}&loginName={loginName}&loginPass={loginPas
s}
• X-Subject-Token: {token}

Request example

GET /admin/API/devicesManager/devices/1000010?fetchFlag=0&protocolTyp
e=Intelbras2&deviceIp=&devicePort=0&loginName=&loginPass= HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: fc0ced0f7ccb4216aa1993531bf6c776
Parameter
Type Description
Name
deviceCode string Device code
0 - obtain from the database; 1 - obtain the latest
fetchFlag string
information from soso
protocolType string Protocol, such as Intelbras2, Onvif, and HIKVISION
deviceIp string Device IP
devicePort string Device ports
loginName string Device user name
loginPass string Device password (AES encryption)
token string The token obtained when logging in

Request method：

• GET

Request example

Null
Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"deviceCode": "1000010",
"deviceName": "2J03545PAG00009",
"deviceIp": "10.35.92.11",
"state": "online",
"orgCode": "001",
"deviceGroupName": null,
"videoServerName": null,
"itcServerName": null,
"deviceCategory": "1",
"deviceType": "IPC",
"offLineReason": null,
"loginName": "admin",
"loginPass": "8c8944adede71eea53bec5d7624ea53a",
"protocolType": "Intelbras2",
"deviceModel": "IP Camera",
"deviceModelStr": "ASC1202B-D",
"serialNo": null,
"hardwareVersion": null,
"softwareVersion": null,
"memo": null,
"deviceSn": "2J03545PAG00009",
"manufacturer": "Intelbras",
"regionDeviceId": null,
"videoServerCode": "video#local",
"itcServerCode": "pic#local",
"devicePort": "37771",
"proxyIp": "",
"proxyPort": "",
"sipId": null,
"sipPwd": null,
"phaseEnable": null,
"buildingEnable": null,
"unitEnable": null,
"callingNum": null,
"isVideoNexus": null,
"controller": [
{
"subControllerSeq": null,
"name": null,
"property": null
}
],
"encoderUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$1$0$0",
"channelName": "2J03545PAG00009_1",
"channelSn": "0",
"channelType": "1",
"channelRemoteType": "1",
"cameraFunctions": "0",
"cameraType": "2",
"pcFlag": "0",
"faceFunctions": "0",
"targetDetection": "0",
"keyCode": null,
"channelExt": {
"roadway": null,
"cartMaxSpeed": null,
"cartMinSpeed": null,
"dollyMaxSpeed": null,
"dollyMinSpeed": null,
"direction": null
},
"capability": null
}
],
"assistStream": "3",
"zeroChnEncode": "0"
},
"decoderUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$2$0$0",
"channelName": "2J03545PAG00009_1",
"channelSn": null,
"channelType": null,
"maxSplitNum": null
}
],
"decodeMode": null,
"conbineStatus": null
},
"alarmInputUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$3$0$0",
"channelName": "2J03545PAG00009_1",
"alarmType": null,
"alarmLevel": null
}
]
},
"alarmOutputUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$4$0$0",
"channelName": "2J03545PAG00009_1"
}
]
},
"screenInputUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$5$0$0",
"channelName": "2J03545PAG00009_1",
"channelSn": null,
"channelType": null,
"channelRemoteType": null
}
]
},
"screenOutputUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$6$0$0",
"channelName": "2J03545PAG00009_1"
}
],
"decodeMode": null
},
"accessControlUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$7$0$0",
"channelName": "2J03545PAG00009_1",
"subControllerSeq": null,
"readId": null
}
],
"fingerPrintAuth": null,
"cardAuth": null,
"faceAuth": null,
"userIsolate": null,
"unlockModes": null
},
"virUnit": {
"channelsCount": "12",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$12$0$0",
"channelName": "2J03545PAG00009_1"
}
]
},
"voiceUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$8$0$0",
"channelName": "2J03545PAG00009_1"
}
]
},
"posUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$11$0$0",
"channelName": "2J03545PAG00009_1"
}
]
},
"ledUnit": {
"channelsCount": "1",
"channels": [
{
"deviceCode": "1000010",
"channelSeq": "0",
"channelId": "1000010$15$0$0",
"channelName": "2J03545PAG00009_1",
"height": null,
"width": null,
"color": null,
"zeroDisplayType": null,
"gpsX": null,
"gpsY": null,
"mapId": null,
"direct": null,
"defaultText": null,
"fontSize": null,
"fontBold": null,
"arrowheadDirection": null,
"rowNum": null,
"rollType": null,
"rollSpeed": null,
"fixedContent": null,
"fixedContentType": null,
"showContent": [
{
"contentSeq": null,
"content": null,
"useDefined": null
}
]
}
]
}
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- deviceCode string Device code
- deviceName string Device name
- deviceIp string Device IP
- state string Device status: online, offline, and unknown
- orgCode string Code of the home organization node of the device
Name of the home organization node of the
- deviceGroupName string
device
- videoServerName string Video server name
- itcServerName string ANPR server name
- deviceCategory string Device category
- deviceType string Device type
- offLineReason string Offline reason
- loginName string Login user name
- loginPass string Login password
- protocolType string Protocol type
- deviceModel string Device model
- deviceModelStr string Device model character string
- serialNo string Serial Number
- hardwareVersion string Hardware version
- softwareVersion string Software version
Parameter Name Type Description
- memo string Remarks
Device number used by the device in auto
- deviceSn string register, valid only when the protocol type is auto
register
Vendor: Intelbras, HIKVISION, UNIVIEW,
- manufacturer string
UNKNOWN
- regionDeviceId string Not used for now
- videoServerCode string Video server code
- itcServerCode string ITC server code
- devicePort string Port number
- proxyIp string Proxy IP
- proxyPort string Proxy port
- sipId string Video intercom SIP-ID
- sipPwd string Video intercom SIP-ID
- phaseEnable string Intercom phase enable
- buildingEnable string Intercom building enable
- unitEnable string Intercom unit enable
- callingNum string Video intercom call number
Whether a big baseline for video interconnection:
- isVideoNexus string
1 - yes; 0 - no
- controller object Controller
- - subControllerSeq string Controller No.
- - name string Name
- - property string One/Two-way information
- encoderUnit object Encoder unit
- - channelsCount string Total number of code channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel No., starting from 0
- - - channelId string Channel No.
- - - channelName string Channel name
- - - channelSn string Unique channel identification code
Channel type, such as video channel, image
- - - channelType string
channel, and video & image channel
Remote channel type, including the local code
---
string channel, remote channel, cascading channel, and
channelRemoteType
analog matrix channel
Camera type, such as the bullet camera, speed
- - - cameraType string
dome, and dome camera
- - - pcFlag string Whether it is used for passenger flow statistics
- - - faceFunctions string Face function set: 0 - not supported; 1 -
Parameter Name Type Description
snapping; 2 - recognizing
- - - targetDetection string Object detection: 0 - not supported; 1 - supported
- - - keyCode string Keyboard code
- - - channelExt object Channel extension information
- - - - roadway string Lane number
- - - - cartMaxSpeed string Highest speed of large-size vehicles
- - - - cartMinSpeed string Lowest speed of large-size vehicles
- - - - dollyMaxSpeed string Highest speed of small-size vehicles
- - - - dollyMinSpeed string Lowest speed of small-size vehicles
- - - - direction string Driving direction
----
string Object detection: 0 - not supported; 1 - supported
targetDetection
- - - capability string Capability set, decimal number
Stream type: 1 - main stream; 2 - sub stream 1; 3
- - assistStream string
- sub stream 2
- - zeroChnEncode string Zero channel No. type
- decoderUnit object Decoder unit
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel No., starting from 0
- - - channelId string Channel No.
- - - channelName string Channel name
- - - channelSn string Unique channel identification code
Channel type, such as video channel, image
- - - channelType string
channel, and video & image channel
- - - maxSplitNum string Maximum number of splits
- - decodeMode string Decoding mode
Video wall combining status: 1 - supported; 0 -
- - conbineStatus string
not supported
- alarmInputUnit object Alarm input unit
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- - - alarmType string Alarm type
- - - alarmLevel string Alarm level
- alarmOutputUnit object Alarm output unit
- - channelsCount string Number of channels
Parameter Name Type Description
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- screenInputUnit object Large screen input channel
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- - - channelSn string Unique channel identification code
Channel type, such as video channel, image
- - - channelType string
channel, and video & image channel
Remote channel type, including the local code
---
string channel, remote channel, cascading channel, and
channelRemoteType
analog matrix channel
- screenOutputUnit object Large screen output channel
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- - decodeMode string Decoding Type
- accessControlUnit object A&C controller unit
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
---
string Controller No.
subControllerSeq
- - - readId object Reader ID array
Whether fingerprint authentication is supported: 0
- - fingerPrintAuth string - unknown, compatible with previous one
(default); 1 - not supported; 2 - supported
Whether card authentication is supported: 1 - yes;
- - cardAuth string
0 - no
Parameter Name Type Description
Whether face recognition authentication is
- - faceAuth string
supported: 1 - yes; 0 - no
Whether the user and card can be separated: 1 -
- - userIsolate string
yes; 0 - no
Unlocking mode combination supported by
- - unlockModes string devices. Multiple modes are separated by
commas, for example, 0, 1, 2, 3
- virUnit object Virtual unit
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- voiceUnit object Voice device unit
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- posUnit object POS unit
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- ledUnit object LED unit
- - channelsCount string Number of channels
- - channels object Channel information
- - - deviceCode string Device code
- - - channelSeq string Channel sequence number
- - - channelId string Channel No.
- - - channelName string Channel name
- - - height string LED screen height
- - - width string LED screen width
- - - color string LED color: 1 - red; 2 - green; 3 - yellow
Display content of the "0 remaining space"
- - - zeroDisplayType string screen; 0 - 0000; 1 - full (dedicated for the
remaining space screen)
Parameter Name Type Description
- - - gpsX string X coordinate
- - - gpsY string Y coordinate
- - - mapId string Map ID
Display direction: 1 - going straight; 2 - turning
left; 3 - turning right; 4 - going straight and
- - - direct string turning left; 5 - going straight and turning right;
12 - the disabled; 13 - pregnant women; 14 -
vehicles
- - - defaultText string Preset text
- - - fontSize string Text size
- - - fontBold string Text bold
---
string Arrow direction: 1 - left; 2 - right
arrowheadDirection
- - - rowNum string Number of displayed rows
- - - rollType string Content rolling mode: 0 - fixed; 1 - rolling
- - - rollSpeed string Rolling speed
Fixed content, cannot be null when
- - - fixedContent string
fixedContentType is set to 2
--- Fixed content in idle status: 0 - null; 1 - remaining
string
fixedContentType parking space; 2 - customized content
- - - showContent object Displayed information
- - - - contentSeq string No.
- - - - content string Displayed content
- - - - useDefined string Whether it is customized content: 0 - no; 1 - yes

Notes

• For more returned error codes, see the error code description
on the home page

4.7.5、Obtain the home organization based on the channel No.

Brief description：

• Obtain the home organization based on the channel number

Request URL：

• /admin/API/devicesManager/channelOrg
• X-Subject-Token: {token}

Request example

POST /admin/API/devicesManager/channelOrg HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: fc0ced0f7ccb4216aa1993531bf6c776
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"channelIds": [
"1000000$1$0$1"
]
}

Parameters：

Parameter Name Type Description

channelIds object Channel ID

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"results": [
{
"channelId": "1000000$1$0$1",
"pId": "1000000",
"gId": "001"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
Parameter Name Type Description
- results object Home organization of the channel
- - channelId string Channel ID
- - pId string Parent node number, device number
- - gId string Grandparent node number, organization number

Notes

• For more returned error codes, see the error code description
on the home page

4.7.6、Obtain the time zone and time of the A&C device

Brief description：

• Obtain the time zone and time of the A&C device

Request URL：

• /admin/API/device/time/{deviceCode}
• X-Subject-Token: {token}

Request example:

GET /admin/API/device/time/1000001 HTTP/1.1

Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 5fad3e259cbc497fa3e2ece67676469c
Parameter Name Type Description
deviceCode string Device code
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Request parameters:

Null

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"dateTime":"2019-08-23 15:00:00",
"timeZone":"13"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- dateTime string Device time format: yyyy-MM-dd HH:mm:ss
- timeZone string Device time zone
timeZone:
0:GMT+00:00,1:GMT+01:00,2:GMT+02:00,3:GMT+03:00,4:GMT+03:30,5:GMT+04:
00,
6:GMT+04:30,7:GMT+05:00,8:GMT+05:30,9:GMT+05:45,10:GMT+06:00,11:GMT+0
6:30,
12:GMT+07:00,13:GMT+08:00,14:GMT+09:00,15:GMT+09:30,16:GMT+10:00,17:G
MT+11:00,
18:GMT+12:00,19:GMT+13:00,20:GMT-01:00,21:GMT-02:00,22:GMT-03:00,23:G
MT-03:30,
24:GMT-04:00,25:GMT-05:00,26:GMT-06:00,27:GMT-07:00,28:GMT-08:00,29:G
MT-09:00,
30:GMT-10:00,31:GMT-11:00,32:GMT-12:00,33:GMT-04:30,34:GMT+10:30,35:G
MT+14:00,
36:GMT-09:30,37:GMT+08:30,38:GMT+08:45,39:GMT+12:45

Notes

• For more returned error codes, see the error code description
on the home page

4.8、Record Playback

4.8.1、Search the encryption secret key for the device stream

Brief description：

• Search the encryption secret key for the device stream

Request URL：
• /admin/API/BRM/Device/GetMediaVKs?token={token}

Request example

POST /admin/API/BRM/Device/GetMediaVKs?token=b152c3dfb82d435b89a1507c
d2113a31 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Device.GetMediaVKs",
"data": {
"deviceCode": "1000000",
"optional": "/admin/API/BRM/Device/GetMediaVKs?token=b152c3df
b82d435b89a1507cd2113a31",
"startDate": "1542556800",
"endDate": "1542621600"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- deviceCode string Device code
- optional string URI information
- startDate string Start time (s)
Parameter Name Type Description
- endDate string End time (s)

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"vks": [
{
"vkId": "ATivKTcdfxk98lsA8cieBQ==",
"vkValue": "WoDA/naj0PkuvltJX0K1w92WfV24W3D4y2pZCnfmy
F8=",
"createDate": "1542609707"
},
{
"vkId": "ATivKTcdfxk98lsA8cieBQ==",
"vkValue": "WoDA/naj0PkuvltJX0K1w92WfV24W3D4y2pZCnfmy
F8=",
"createDate": "1542609709"
},
{
"vkId": "ATivKTcdf94E8lsAlSJ+Zg==",
"vkValue": "Edm0g//pYIi7tP6QfbiEQ89XSi9DjgzZMgC653Vro
B0=",
"createDate": "1542616414"
},
{
"vkId": "ATivKTcdf94E8lsAlSJ+Zg==",
"vkValue": "Edm0g//pYIi7tP6QfbiEQ89XSi9DjgzZMgC653Vro
B0=",
"createDate": "1542617214"
},
{
"vkId": "ATivKTcdf94E8lsAlSJ+Zg==",
"vkValue": "Edm0g//pYIi7tP6QfbiEQ89XSi9DjgzZMgC653Vro
B0=",
"createDate": "1542618447"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- vks object Encryption information
- - vkId string Secret key ID
- - vkValue string Secret key
Start time (s). Null means starting from the current
- - createDate string
time.

Notes

• For more returned error codes, see the error code

description on the home page

4.8.2、Record Playback by File

Brief description:

• Record Playback by File

Request URL:

• /admin/API/SS/Playback/StartPlaybackByFile?token={token}

Request example

POST /admin/API/SS/Playback/StartPlaybackByFile?token=784abb20ece3493
fbeca9c0d3a8b22eb HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Playback.StartPlaybackByFile",
"data": {
"ssId": "1001",
"optional": "/admin/API/SS/Playback/StartPlaybackByFile?token
=784abb20ece3493fbeca9c0d3a8b22eb",
"endTime": "1540853395",
"fileName": "{fe69f729-9d4b-42d4-b6a0-56189aaa4e1e}",
"diskId": "1540852944-1540853395",
"startTime": "1540852944",
"nvrId": "",
"recordSource": "3",
"channelId": "1000040$1$0$0",
"playbackMode": "0",
"streamId": "5875"
}
}

Parameters:

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string None
project string None
method string Method name
data object None
- ssId string SS service ID
- optional string URI information
- endTime string End time(second)
- fileName string Record file information
- diskId string Disk ID
- startTime string Start time(second)
- nvrId string NVR device ID
- recordSource string Record source: 1—All; 2—Device; 3—Center
- channelId string Channel code
- playbackMode string Playback mode: 0—Normal; 1—Real-time
- streamId string Code stream processing(StreamId)

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"url": "rtsp://10.35.92.81:9320/playback/center/5",
"session": "5",
"protocol": "0",
"token": "5"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- url string URL of the client RTSP request
- session string Record playback session ID
- protocol string Protocol type: 1RTSP\RTP/RTCP
- token string Token

Notes

• For more returned error codes, see the error code

description on the home page

4.8.3、Record Playback by Time

Brief description:

• Record Playback by Time

Request URL:

• /admin/API/SS/Playback/StartPlaybackByTime?token={token}

Request example

POST /admin/API/SS/Playback/StartPlaybackByTime?token=7a882d516f354ca
6a6e4b95d0d0a92f7 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• POST
Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Playback.StartPlaybackByTime",
"data": {
"nvrId": "",
"optional": "/admin/API/SS/Playback/StartPlaybackByTime?token
=7a882d516f354ca6a6e4b95d0d0a92f7",
"recordType": "0",
"streamType": "0",
"recordSource": "2",
"channelId": "1000067$1$0$0",
"endTime": "1540915199",
"startTime": "1540828800"
}
}

Parameters:

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string None
project string None
method string Method name
data object None
- nvrId string NVR device ID
- optional string URI information
- recordType string Record type: 1—General; 2—Alarm
Code stream type: 1—Main code stream; 2—Auxiliary
- streamType string
code stream
- recordSource string Record source: 1—All; 2—Device; 3—Center
- channelId string Channel code
- endTime string End time(second)
- startTime string Start time(second)

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"url": "rtsp://10.35.92.55:9320/playback/pu/94",
"session": "94",
"protocol": "0",
"token": "94",
"fromDevice": ""
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
- url string URL of the client RTSP request
- session string Record playback session ID
- protocol string Protocol type: 1RTSP\RTP/RTCP
- token string Token
Whether to pull stream from the device (pull stream from
- fromDevice string MTS by default): 1—Directly pull stream from the device
(such as EVS); 0—Pull stream from the MTS platform

Notes

• For more returned error codes, see the error code

description on the home page

4.9、Record Management

4.9.1、Obtain the recording status of a certain month

Brief description：

• Obtain the recording status of a certain month

Request URL：

• /admin/API/SS/Record/GetChannelMonthRecordStatus?token=
{token}

Request example
POST /admin/API/SS/Record/GetChannelMonthRecordStatus?token=ac57d9f22
b9f4190ad95e812258c645b HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.GetChannelMonthRecordStatus",
"data": {
"recordSource": "3",
"optional": "/admin/API/SS/Record/GetChannelMonthRecordStatu
s?token=ac57d9f22b9f4190ad95e812258c645b",
"channelId": "1000067$1$0$0",
"month": "201810"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- recordSource string Record source: 1 - All, 2 - Device, 3 - Center
- optional string URI information
- channelId string Channel No.
- month string Month, format: yyyyMM, for example, 201906

Return example
{
"code": 1000,
"desc": "Success",
"data": {
"days": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
0,0,1,1,0"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
Whether there is a record: 0 - No, 1 - Yes; Recording
- days string states of every day are separated by commas, for
example, 1,1,1,0,0,1,0,1,...

Notes

• For more returned error codes, see the error code

description on the home page

4.9.2、Search record

Brief description：

• Search records

Request URL：

• /admin/API/SS/Record/QueryRecords?token={token}

Request example

POST /admin/API/SS/Record/QueryRecords?token=f95d07c84a87407eae5ea083
ee5ca42e HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：
• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.QueryRecords",
"data": {
"cardNo": "",
"optional": "/admin/API/SS/Record/QueryRecords?token=f95d07c8
4a87407eae5ea083ee5ca42e",
"endTime": "1540889999",
"diskPath": "",
"startIndex": "",
"streamType": "0",
"recordType": "0",
"recordSource": "3",
"startTime": "1540828800",
"endIndex": "",
"channelId": "1000067$1$0$1"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- cardNo string Card number
- optional string URI information
- endTime string End time (s)
Optical disc path, optical disc 1: /dev/sg0; optical disc 2:
- diskPath string
/dev/sg1
- startIndex string Start sequence number (from 1)
- streamType string Code stream type: 1 - Main stream, 2 - Sub stream
- recordType string Recording type: 0 - All, 1 - Manual recording, 2 - Alarm
Parameter
Type Description
Name
recording, 3 - Dynamic monitoring, 4 - Video loss, 5 -
Video tampering, 6 - Timed recording, 7 - All-weather
recording, 8 - File record switch
-
string Record source: 1 - All, 2 - Device, 3 - Center
recordSource
- startTime string Start time (s)
- endIndex string End sequence number
- channelId string Channel No.

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"records": [
{
"channelId": "1000067$1$0$1",
"recordSource": "3",
"recordType": "6",
"startTime": "1540886244",
"endTime": "1540886303",
"recordName": "{91254f10-b054-4513-96ac-61a008cb1cb2}
",
"fileLength": "16384",
"planId": "0",
"ssId": "1001",
"diskId": "1540886244-1540886303",
"streamId": "2726",
"forgotten": "0"
},
{
"channelId": "1000067$1$0$1",
"recordSource": "3",
"recordType": "6",
"startTime": "1540888200",
"endTime": "1540888387",
"recordName": "{2b457c5f-7aed-4ac0-bb08-359a1b953904}
",
"fileLength": "32768",
"planId": "0",
"ssId": "1001",
"diskId": "1540888200-1540888387",
"streamId": "2726",
"forgotten": "0"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- records object Recording information
- - channelId string Channel No.
--
string Record source: 1 - All, 2 - Device, 3 - Center
recordSource
Recording type: 0 - All, 1 - Manual recording, 2 - Alarm
recording, 3 - Dynamic monitoring, 4 - Video loss, 5 -
- - recordType string
Video tampering, 6 - Timed recording, 7 - All-weather
recording, 8 - File record switch
- - startTime string Start time (s)
- - endTime string End time (s)
-- Record name (File identifiers vary depending on
string
recordName manufacturers)
- - fileLength string File size
- - planId string Recording plan ID, not used for now, 0 by default
- - ssId string Storage service ID
- - diskId string Disk ID
- - streamId string Code stream processing (StreamId)
- - forgotten string Forgotten or not, not used for now, 0 by default

Notes

• For more returned error codes, see the error code

description on the home page

4.9.3、Search record locking information

Brief description：

• Search record locking information

Request URL：

• /admin/API/SS/Record/QueryLockInfos?token={token}

Request example

POST /admin/API/SS/Record/QueryLockInfos?token=b916f6bc99404d4d99cf8c
6581616b3e HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.QueryLockInfos",
"data": {
"optional": "/admin/API/SS/Record/QueryLockInfos?token=b916f6
bc99404d4d99cf8c6581616b3e",
"source": "3",
"startTime": "1540828800",
"endTime": "1540889999",
"channelId": "1000067$1$0$1",
"userId": "",
"reason": ""
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
Parameter
Type Description
Name
method string Method name
data object None
- optional string URI information
- source string Record source: 1 - All, 2 - Device, 3 - Center
- startTime string Start time (s)
- endTime string End time (s)
- channelId string Channel No.
ID of the locking user. If it is null, all users will be
- userId string
queried.
- reason string Locking reason (fuzzy search)

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"lockInfos": [
{
"id": "15",
"channelId": "1000067$1$0$1",
"startTime": "1540887635",
"endTime": "1540887934",
"source": "3",
"reason": "",
"streamIds": null,
"operateTime": "1540965441",
"userId": "1",
"userIp": "10.33.68.103",
"userName": "system"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
Parameter
Type Description
Name
- lockInfos object Locking information
- - id string Record locking ID
- - channelId string Channel No.
- - startTime string Start time (s)
- - endTime string End time (s)
- - source string Record source: 1 - All, 2 - Device, 3 - Center
- - reason string Locking reason
Stream IDs. Multiple stream IDs are separated by
- - streamIds string
commas
- - operateTime string Operation time (s)
- - userId string Operation user ID
- - userIp string Operation user IP
- - userName string Operation user name

Notes

• For more returned error codes, see the error code

description on the home page

4.9.4、Search record tag

Brief description：

• Search record tags

Request URL：

• /admin/API/SS/Tag/QueryRecordTags?token={token}

Request example

POST /admin/API/SS/Tag/QueryRecordTags?token=ff9baaaf60364cad807ed7b4
c494facb HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example
{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Tag.QueryRecordTags",
"data": {
"optional": "/admin/API/SS/Tag/QueryRecordTags?token=ff9baaaf
60364cad807ed7b4c494facb",
"source": "3",
"keyword": "",
"endTime": "1540915199",
"channelId": "1000067$1$0$0",
"userId": "",
"startTime": "1540828800"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- source string Record source: 1 - All, 2 - Device, 3 - Center
Keyword (topic fuzzy search), not used as a search
- keyword string
condition if it is null
End time (s), not used as a search condition (the target
- endTime string
of the query is tagTime) if it is null
- channelId string Channel No.
- userId string User ID. If it is null, all users will be queried.
Start time (s), not used as a search condition (the
- startTime string
target of the query is tagTime) if it is null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tags": [
{
"tagId": "8",
"channelId": "1000067$1$0$0",
"source": "3",
"tagTime": "1540836090",
"subject": "abc11:00",
"content": "Device: 5832-A1-_. ;#()（） Channel name:
81",
"picUrl": "1000067_0_2018_10_29_233252",
"userId": "1",
"updateTime": "1540881415"
},
{
"tagId": "14",
"channelId": "1000067$1$0$0",
"source": "3",
"tagTime": "1540887654",
"subject": "Tag name 4",
"content": "Device: 5832-A1-_. ;#()（） Channel name:
81",
"picUrl": "1000067_0_2018_10_30_13013",
"userId": "1",
"updateTime": "1540888215"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- tags object None
- - tagId string Tag ID
- - channelId string Channel No.
- - source string Record source: 1 - All, 2 - Device, 3 - Center
- - tagTime string Tag time (s)
- - subject string Subject
- - content string Content
- - picUrl string Picture path
Parameter Name Type Description
- - userId string User ID
- - updateTime string Update time (s)

Notes

• For more returned error codes, see the error code

description on the home page

4.9.5、Save record tags

Brief description：

• Save record tags

Request URL：

• /admin/API/SS/Tag/SaveRecordTag?token={token}

Request example

POST /admin/API/SS/Tag/SaveRecordTag?token=11e4f5fbf0454af9a8e645a7a8
d84f5f HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Tag.SaveRecordTag",
"data": {
"picUrl": "1000067_0_2018_10_31_153818",
"optional": "/admin/API/SS/Tag/SaveRecordTag?token=11e4f5fbf0
454af9a8e645a7a8d84f5f",
"source": "3",
"tagId": "",
"subject": "1122233",
"channelId": "1000067$1$0$0",
"content": "Device: 5832-A1-_. ;#()（） Channel name: 81",
"tagTime": "1540857613"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- picUrl string Picture path
- optional string URI information
- source string Record source: 1 - All, 2 - Device, 3 - Center
Tag ID. The tag is updated to the new one specified by
- tagId string the ID. If it is null, a new tag is added. (A tag update
does not cause a tag user to be updated.)
- subject string Subject
- channelId string Channel No.
- content string Content
- tagTime string Tag time (s)

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tagId": "18"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
Parameter Name Type Description
- tagId string Tag ID

Notes

• For more returned error codes, see the error code

description on the home page

4.9.6、Delete record tag

Brief description：

• Delete record tags

Request URL：

• /admin/API/SS/Tag/DeleteRecordTag?token={token}

Request example

POST /admin/API/SS/Tag/DeleteRecordTag?token=c859693908174cafbb8f42f4
137070d0 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Tag.DeleteRecordTag",
"data": {
"ids": [
"18"
],
"optional": "/admin/API/SS/Tag/DeleteRecordTag?token=c8596939
08174cafbb8f42f4137070d0"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- ids object Tag ID
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.9.7、Lock records

Brief description：

• Lock record

Request URL：

• /admin/API/SS/Record/LockRecord?token={token}

Request example

POST /admin/API/SS/Record/LockRecord?token=a933a1b470974c08b7db1ab7f1
6680b8 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.LockRecord",
"data": {
"optional": "/admin/API/SS/Record/LockRecord?token=a933a1b470
974c08b7db1ab7f16680b8",
"source": "3",
"streamId": "",
"endTime": "1540912247",
"channelId": "1000067$1$0$0",
"startTime": "1540911642",
"reason": ""
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
Record source: 1 - All, 2 - Device, 3 - Center, only
- source string
center recording supported at present
Records of the type specified by the parameter value
- streamId string
are locked. If it is null, all types of records are locked.
Parameter
Type Description
Name
- endTime string End time (s)
- channelId string Channel No.
- startTime string Start time (s)
- reason string Reason

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "16"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- id string Record locking ID

Notes

• For more returned error codes, see the error code

description on the home page

4.9.8、Unlock records

Brief description：

• Unlock records

Request URL：

• /admin/API/SS/Record/UnlockRecord?token={token}

Request example

POST /admin/API/SS/Record/UnlockRecord?token=a933a1b470974c08b7db1ab7
f16680b8 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.UnlockRecord",
"data": {
"ids": [
"16"
],
"optional": "/admin/API/SS/Record/UnlockRecord?token=a933a1b4
70974c08b7db1ab7f16680b8"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- ids object Record locking ID
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description
code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.9.9、Start manual recording

Brief description：

• Start manual recording

Request URL：

• /admin/API/SS/Record/StartRecord?token={token}

Request example

POST /admin/API/SS/Record/StartRecord?token=79c070dae6104c09a87cd327f
8a6f9c3 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.StartRecord",
"data": {
"streamType": "1",
"optional": "/admin/API/SS/Record/StartRecord?token=79c070dae
6104c09a87cd327f8a6f9c3",
"duration": "43200",
"channelId": "1000059$1$0$0"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- streamType string Code stream type: 1 - Main stream, 2 - Sub stream
- optional string URI information
- duration string Recording duration (12 x 3600 seconds by default)
- channelId string Channel No.

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"planId": "0",
"now": "1540974573"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- planId string Not used for now, 0 by default
- now string Current time (s)

Notes

• For more returned error codes, see the error code

description on the home page

4.9.10、Stop manual recording

Brief description：
• Stop manual recording

Request URL：

• /admin/API/SS/Record/StopRecord?token={token}

Request example

POST /admin/API/SS/Record/StopRecord?token=79c070dae6104c09a87cd327f8
a6f9c3 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.StopRecord",
"data": {
"streamType": "1",
"optional": "/admin/API/SS/Record/StopRecord?token=79c070dae6
104c09a87cd327f8a6f9c3",
"channelId": "1000059$1$0$0"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- streamType string Code stream type: 1 - Main stream, 2 - Sub stream
Parameter Name Type Description
- optional string URI information
- channelId string Channel No.

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"planId": "0",
"now": "1540974579"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- planId string Not used for now, 0 by default
- now string Current time (s)

Notes

• For more returned error codes, see the error code

description on the home page

4.9.11、Obtain alarm records

Brief description：

• Obtain alarm records

Request URL：

• /admin/API/SS/Record/GetAlarmRecords?token={token}

Request example

POST /admin/API/SS/Record/GetAlarmRecords?token=4857b6fa9a6e4677affb6
ef366b635b3 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "SS.Record.GetAlarmRecords",
"data": {
"alarmCode": "{CC84DA5A-6B7D-4D7C-8447-1D7DC27EAE81}",
"optional": "/admin/API/SS/Record/GetAlarmRecords?token=4857b
6fa9a6e4677affb6ef366b635b3"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- alarmCode string Alarm code
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"records": [
{
"channelId": "1000053$1$0$0",
"recordSource": "3",
"recordType": "3",
"startTime": "1540975091",
"endTime": "1540975100",
"recordName": "{91254f10-b054-4513-96ac-61a008cb1cb2}
",
"fileLength": "16384",
"planId": "0",
"ssId": "1001",
"diskId": "1540975091-1540975100",
"streamId": "2509",
"forgotten": "0"
},
{
"channelId": "1000053$1$0$2",
"recordSource": "3",
"recordType": "3",
"startTime": "1540975091",
"endTime": "1540975100",
"recordName": "{0b242004-2be5-4404-ab21-3b2a74d1dc24}
",
"fileLength": "16384",
"planId": "0",
"ssId": "1001",
"diskId": "1540975091-1540975100",
"streamId": "2533",
"forgotten": "0"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- records object Alarm record information
- - channelId string Channel No.
--
string Record source: 1 - All, 2 - Device, 3 - Center
recordSource
Recording type: 0 - All, 1 - Manual recording, 2 - Alarm
- - recordType string recording, 3 - Dynamic monitoring, 4 - Video loss, 5 -
Video tampering, 6 - Timed recording, 7 - All-weather
Parameter
Type Description
Name
recording, 8 - File record switch
- - startTime string Start time (s)
- - endTime string End time (s)
-- Record name (File identifiers vary depending on
string
recordName manufacturers)
- - fileLength string File size
- - planId string Recording plan ID, not used for now, 0 by default
- - ssId string Storage service ID
- - diskId string Disk ID
- - streamId string Code stream processing (StreamId)
- - forgotten string Forgotten or not, not used for now, 0 by default

Notes

• For more returned error codes, see the error code

description on the home page

4.10、Traffic Live View

4.10.1、Request real-time subscription to the information about passed

vehicles

Brief description：

• Request real-time subscription to the information about

passed vehicles

Request URL：

• /admin/API/PTS/CarInfo/StartCarInfo?token={token}

Request example

POST /admin/API/PTS/CarInfo/StartCarInfo?token=987078659ab44d589dba3a
73292bb0a8 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST
Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "PTS.CarInfo.StartCarInfo",
"data": {
"streamType": "0",
"optional": "/admin/API/PTS/CarInfo/StartCarInfo?token=987078
659ab44d589dba3a73292bb0a8",
"channelId": "1000103$1$0$0",
"ext": "",
"dataType": "2"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- streamType string Stream type: 0 - All, 1 - Main stream, 2 - Sub stream
- optional string URI information
- channelId string Channel No.
- ext string Extended data
Subscription type: 1 - Vehicle information, 2 - Vehicle
- dataType string
information + picture information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"ip": "10.35.92.81",
"port": "40004",
"minRate": "0",
"connectType": "0",
"stum": "0",
"protocol": "0",
"stumPort": "0",
"model": "0",
"manufacturer": "0",
"session": "26",
"token": "0",
"url": "",
"username": "",
"password": ""
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
IP address, namely the IP address of the server or the
- ip string
IP address of the device, depending on the type
- port string Port
Minimum code stream, namely the minimum code
- minRate string
stream requirement for customers
Type: 1 - Forwarding mode, 2 - Direct connection
- connectType string
mode
Whether the STUM protocol is supported: 1 -
- stum string
Supported, 0 - Not supported
- protocol string Agreement: 1 - CNM3, 2 - RTSP, 3 - RTSP over TCP
- stumPort string STUM protocol interface
- model string Device model
- manufacturer string manufacturer
- session string Forwarding session ID
- token string User token
- url string RTSP address, incompatible with VDTS IP/Port
- username string User name
- password string Password

Notes

• For more returned error codes, see the error code

description on the home page
4.10.2、Stop real-time subscription to the information about passed
vehicles

Brief description：

• Stop real-time subscription to the information about

passed vehicles

Request URL：

• /admin/API/PTS/CarInfo/StopCarInfo?token={token}

Request example

POST /admin/API/PTS/CarInfo/StopCarInfo?token=987078659ab44d589dba3a7
3292bb0a8 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "PTS.CarInfo.StopCarInfo",
"data": {
"session": "26",
"optional": "/admin/API/PTS/CarInfo/StopCarInfo?token=9870786
59ab44d589dba3a73292bb0a8"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
Parameter Name Type Description
project string Null
method string Method name
data object None
- session string Forwarding session ID
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.11、Event Center

4.11.1、Block alarm

Brief description：

• Shielding alarms

Request URL：

• /admin/API/BRM/Alarm/BlockAlarm?token={token}

Request example

POST /admin/API/BRM/Alarm/BlockAlarm?token=2d622caa0a694249aad74bfb5e
57ae20 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in
Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.BlockAlarm",
"data": {
"duration": "60",
"optional": "/admin/API/BRM/Alarm/BlockAlarm?token=2d622caa0a
694249aad74bfb5e57ae20",
"alarmType": "2",
"alarmSource": "1000030$3$0$0"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Client type
clientMac string Client MAC address
clientPushIdstring Null
project string Null
method string Method name
data object None
- duration string Shielding duration (s)
- optional string URI information
- alarmType string Alarm type
Alarm source. For a device alarm, the alarm source is a
- channel No., for example, 1000088$1$0$0. For a system
string
alarmSource alarm, the alarm source is a service code, for example,
pic#1E03EB6PBM00194.

Return example

{
"code": 1000,
"desc": "Success"
}
Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.11.2、Export alarm

Brief description：

• Export user alarms. The download address is sent through MQ

message. See: Alarm export notification

Request URL：

• /admin/API/BRM/Alarm/ExportAlarms?token={token}

Request example

POST /admin/API/BRM/Alarm/ExportAlarms?token=b54bd80f65594de8accc70d1
46421c0c HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.ExportAlarms",
"data": {
"locale": "zh_CN",
"optional": "/admin/API/BRM/Alarm/ExportAlarms?token=b54bd80f
65594de8accc70d146421c0c",
"searchInfo": {
"alarmStatus": ["1"],
"handleUser": "",
"deviceCode": "",
"handleStatus": [
"1",
"0",
"2",
"3",
"4"
],
"endHandleDate": "",
"endAlarmDate": "1540569599",
"alarmId": "",
"alarmGrade": ["1"],
"alarmType": ["2"],
"startHandleDate": "",
"orgCode": "",
"channelId": "1000015$1$0$0",
"startAlarmDate": "1540483200",
"alarmCode": ""
},
"orderInfo": {
"orderType": "1",
"direction": "1"
},
"session": "1540536971"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- locale string Language, such as zh_CN and en
- optional string URI information
- searchInfo object Search condition
Parameter
Type Description
Name
- - alarmStatus object Alarm status: 1—generated; 2—cleared
- - handleUser string Alarm handler (username)
- - deviceCode string Device code
Handling status: 1—handling; 2—solved; 3—false
- - handleStatus object
alarm; 4—ignored; 5—unsolved
--
string handling end time (s)
endHandleDate
- - endAlarmDate string alarm end time (s)
Alarm ID. When this condition is specified, other
- - alarmId string
conditions are ignored.
- - alarmGrade object Alarm severity: 1—high; 2—medium; 3—low
- - alarmType object Alarm type
--
string handling start time (s)
startHandleDate
- - orgCode string Organization code
- - channelId string Channel No.
--
string alarm start time (s)
startAlarmDate
Alarm code. When this condition is specified, other
- - alarmCode string
conditions are ignored.
- orderInfo object Sorting condition
Sorting type: 1—alarm time; 2—alarm type; 3—alarm
- - orderType string
severity; 4—alarm handler; 5—handling status
- - direction string Sorting order: 0—ascending; 1—descending
Session ID, used to distinguish between request
- session string sequences. It is randomly generated by the client for
uniqueness.

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes
• For more returned error codes, see the error code description
on the home page

4.11.3、Obtain the alarm handling history process

Brief description：

• Obtain the alarm handling history process

Request URL：

• /admin/API/BRM/Alarm/GetAlarmProcedures?token={token}

Request example

POST /admin/API/BRM/Alarm/GetAlarmProcedures?token=49a6ddbbeae444dab9
d509323e71d8f5 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmProcedures",
"data": {
"alarmCode": "{E381EFF0-5A82-4502-8CCA-89E14AE34BBB}",
"optional": "/admin/API/BRM/Alarm/GetAlarmProcedures?token=49
a6ddbbeae444dab9d509323e71d8f5"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
Parameter Name Type Description
clientPushId string Null
project string Null
method string Method name
data object None
- alarmCode string Alarm code
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"procedures": [
{
"handleUser": "system",
"handleStatus": "1",
"handleMessage": "",
"handleDate": "1540539138"
}
],
"alarmCode": "{E381EFF0-5A82-4502-8CCA-89E14AE34BBB}"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- procedures object None
Handler (username): claimant/actual
- - handleUser string
handler/transferee
- - handleStatus string Handling status
- - handleMessage string Handling opinion
- - handleDate string Handling time (s)
- alarmCode string Alarm code

Notes

• For more returned error codes, see the error code description
on the home page
4.11.4、Obtain alarm types

Brief description：

• Obtain alarm types

Request URL：

• /admin/API/BRM/Alarm/GetAlarmTypes?token={token}

Request example

POST /admin/API/BRM/Alarm/GetAlarmTypes?token=4ea346c46fd442ef84f4cfb
7a07eb9cb HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmTypes",
"data": {
"locale": "en",
"optional": "/admin/API/BRM/Alarm/GetAlarmTypes?token=4ea346c
46fd442ef84f4cfb7a07eb9cb"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"groups": [
{
"groupId": "1",
"groupName": "Device",
"alarmTypes": [
{
"alarmTypeId": "5",
"alarmTypeName": "Disk Full",
"other": "0"
},
{
"alarmTypeId": "16",
"alarmTypeName": "Device Disconnected",
"other": "0"
}
]
},
{
"groupId": "2",
"groupName": "Video Channel",
"alarmTypes": [
{
"alarmTypeId": "1",
"alarmTypeName": "Video Loss",
"other": "0"
},
{
"alarmTypeId": "13",
"alarmTypeName": "Channel Disconnected",
"other": "0"
}
]
},
...
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- groups object None
Alarm group ID: 1—device alarm; 2—encode channel
alarm; 3—alarm input channel alarm; 4—intelligent
channel alarm; 5—A&C channel alarm; 6—system
- - groupId string
alarm; 7—power and environment alarm; 8—alarm
host alarm; 9—mobile alarm; 10—video intercom
alarm; 11—thermal imaging alarm, and so on
- - groupName string Alarm group name
- - alarmTypes object Alarm type information
--- Alarm type ID. See the alarm type definition for
string
alarmTypeId details.
---
string Alarm type name
alarmTypeName
- - - other string Whether included in others: 0—no; 1—yes

Notes

• For more returned error codes, see the error code description
on the home page

4.11.5、Alarm Handling

Brief description:

• Alarm Handling

Request URL:

• /admin/API/BRM/Alarm/HandleAlarm?token={token}

Request example

POST /admin/API/BRM/Alarm/HandleAlarm?token=06ffde47197c4e6aae3c00db3
503ee12 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.HandleAlarm",
"data": {
"handleUser": "system",
"comment": "",
"mailReceivers": [],
"handleStatus": "1",
"handleMessage": "",
"optional": "/admin/API/BRM/Alarm/HandleAlarm?token=06ffde471
97c4e6aae3c00db3503ee12",
"alarmCode": "{7962659F-9AD1-4E48-899D-82E548B5D721}"
}
}

Parameters:

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string None
project string None
method string Method name
data object None
Handler(user name): Claimant/actual handler/user
- handleUser string
transferred to
Comment, customized on the client to extend
- comment string
information such as alarm linkage video
Parameter
Type Description
Name
- mailReceivers object Email address, not use yet
Handling status: 1—Handling; 2—Solved; 3—False
- handleStatus string
alarm; 4—Ignored; 5—Unsolved
- handleMessage string Handling opinion
- optional string URI information
- alarmCode string Alarm code

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

• For more returned error codes, see the error code description
on the home page

4.11.6、Alarm Search

Brief description:

• Alarm search

Request URL:

• /admin/API/BRM/Alarm/QueryAlarms?token={token}

Request example

POST /admin/API/BRM/Alarm/QueryAlarms?token=6ee0ef822e28419ca2d0f2622
e0ca340 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in
Request method:

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.QueryAlarms",
"data": {
"orderInfo": {
"orderType": "1",
"direction": "1"
},
"optional": "/admin/API/BRM/Alarm/QueryAlarms?token=6ee0ef822
e28419ca2d0f2622e0ca340",
"pageInfo": {
"pageSize": "20",
"pageNo": "1"
},
"searchInfo": {
"alarmStatus": [],
"handleUser": "",
"deviceCode": "",
"handleStatus": [
"1",
"0",
"2",
"3",
"4"
],
"endHandleDate": "",
"endAlarmDate": "1540569599",
"alarmId": "",
"alarmGrade": [],
"alarmType": [],
"startHandleDate": "",
"orgCode": "",
"channelId": "1000015$3$0$0",
"startAlarmDate": "1540483200",
"alarmCode": ""
}
}
}

Parameters:

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string None
project string None
method string Method name
data object None
- orderInfo object Condition for the order
ort type: 1—By alarm time; 2—By alarm type; 3—By
- - orderType string
alarm grade; 4—By alarm handler; 5—By alarm status
- - direction string Sort order: 0—ASC, 1—DESC
- optional string URI information
- pageInfo object Page information
- - pageSize string Page size
- - pageNo string Page number(from 1)
- searchInfo object Search condition
- - alarmStatus string Alarm status: 1—Generated; 2—Disappeared
- - handleUser string Alarm handler(user name)
- - deviceCode string Device code
Handling status: 1—Handling; 2—Solved; 3—False
- - handleStatus string
alarm; 4—Ignored; 5—Unsolved
--
string Handling end time(second)
endHandleDate
- - endAlarmDate string Alarm end time(second)
Alarm ID. When this condition is specified, other
- - alarmId string
conditions will be ignored
- - alarmGrade string Alarm grade: 1-high;2-medium;3-low
- - alarmType string Alarm type
--
string Handling start time(second)
startHandleDate
- - orgCode string Organization code
- - channelId string Channel code
--
string Alarm start time(second)
startAlarmDate
Alarm code. When this condition is specified, other
- - alarmCode string
conditions will be ignored
Return example

{
"code": 1000,
"desc": "Success",
"data": {
"queryTime": 1540540980,
"alarms": [
{
"alarmId": "4",
"alarmCode": "{6752247E-A454-4863-B333-EB5BEB68BD87}
",
"deviceCode": "1000015",
"deviceName": "10.33.68.41",
"channelId": "1000015$3$0$0",
"channelName": "10.33.68.41_1",
"alarmStatus": "1",
"alarmType": "2",
"alarmDate": "1540536961",
"alarmGrade": "3",
"handleStatus": "0",
"handleUser": "",
"handleDate": "",
"handleMessage": "",
"picture": "",
"pictureSize": "",
"mailReceivers": "",
"memo": ""
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
- queryTime long Search time(second)
- alarms object Alarm information
- - alarmId string Alarm ID
- - alarmCode string Alarm code
Parameter
Type Description
Name
- - deviceCode string
Device code
- - deviceName string
Device name
- - channelId string
Channel code
- - channelName string
Channel name
- - alarmStatus string
Alarm status: 1—Generated; 2—Disappeared
- - alarmType string
Alarm type
- - alarmDate string
Alarm time(second)
- - alarmGrade string
Alarm grade: 1-high;2-medium;3-low
Handling status: 1—Handling; 2—Solved; 3—False
- - handleStatus string
alarm; 4—Ignored; 5—Unsolved
- - handleUser string Alarm handler(user name)
- - handleDate string Handling time(second)
--
string Handling opinion
handleMessage
- - picture string Alarm snapshot
- - pictureSize string Alarm snapshot size
Email receiver, separated by semicolon for multiple
- - mailReceivers string
receivers
Alarm plan remark, separated by $ for multiple
- - memo string
memos

Notes

• For more returned error codes, see the error code description
on the home page

4.11.7、Search the total number of alarms

Brief description：

• Search the total number of alarms

Request URL：

• /admin/API/BRM/Alarm/QueryAlarmsCount?token={token}

Request example

POST /admin/API/BRM/Alarm/QueryAlarmsCount?token=2947a858e64c4cdcbd6b
45d867c99ea2 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.QueryAlarmsCount",
"data": {
"searchInfo": {
"alarmId": "",
"alarmCode": "",
"orgCode": "",
"deviceCode": "",
"channelId": "1000015$1$0$0",
"alarmStatus": [],
"alarmType": [],
"startAlarmDate": "1540483200",
"endAlarmDate": "1540569599",
"alarmGrade": [],
"handleUser": "",
"startHandleDate": "",
"endHandleDate": "",
"handleStatus": [
"1",
"0",
"2",
"3",
"4"
]
},
"optional": "/admin/API/BRM/Alarm/QueryAlarmsCount?token=2947
a858e64c4cdcbd6b45d867c99ea2"
}
}

Parameters：
Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- searchInfo object Search condition
Alarm ID. When this condition is specified, other
- - alarmId string
conditions are ignored.
Alarm code. When this condition is specified, other
- - alarmCode string
conditions are ignored.
- - orgCode string Organization code
- - deviceCode string Device code
- - channelId string Channel No.
- - alarmStatus object Alarm status: 1—generated; 2—cleared
- - alarmType object Alarm type
--
string alarm start time (s)
startAlarmDate
- - endAlarmDate string alarm end time (s)
- - alarmGrade object Alarm severity: 1—high; 2—medium; 3—low
- - handleUser string Alarm handler (username)
--
string handling start time (s)
startHandleDate
--
string handling end time (s)
endHandleDate
Handling status: 1—handling; 2—solved; 3—false
- - handleStatus object
alarm; 4—ignored; 5—unsolved
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": "26"
}
}

Description of return parameters

Parameter Name Type Description

Parameter Name Type Description
code int Error code
desc string Result description
data object None
- total string Total number of records

Notes

• For more returned error codes, see the error code description
on the home page

4.11.8、Obtain the restricted list information of vehicles associated with

alarms

Brief description：

• Obtain the restricted list information of vehicles associated

with alarms

Request URL：

• /admin/API/BRM/Alarm/GetAlarmCarBlacklistInfo?token={token}

Request example

POST /admin/API/BRM/Alarm/GetAlarmCarBlacklistInfo?token=03e03f8e17fa
42079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmCarBlacklistInfo",
"data": {
"locale": "en",
"optional": "/admin/API/BRM/Alarm/GetAlarmCarBlacklistInfo?to
ken=03e03f8e17fa42079dc556fb72221ea7",
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}"
}
}

Parameters：

Parameter Name Type Description

clientType string Client type
clientMac string Client MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- locale string Language, such as zh and en
- optional string URI information
- alarmCode string Alarm code

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"carType": "Not Recognized",
"blacklistType": "dict.surveytype.overspeedcar",
"channelName": "itc_1",
"channelId": "1000003$1$0",
"carNum": "TN37CS8691",
"carImgUrl": "http://10.35.93.16:8081/d/1000003$1$0$0/2018112
1/11/1528-4800-0.jpg?streamID:37@capTime:1564208732",
"carNumcolor": "black",
"carColor": "black",
"alarmTime": "1564208732",
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
Parameter Name Type Description
data object None
- carType string Vehicle type (internationalized)
- blacklistType string Restricted list type (internationalized)
- channelName string Channel name
- channelId string Channel No.
- carNum string license plate number
- carImgUrl string Image URL
- carNumcolor string Plate color (internationalized)
- carColor string Vehicle color (internationalized)
- alarmTime string Alarm time (s)
- alarmCode string Alarm code

Notes

• For more returned error codes, see the error code description
on the home page

4.11.9、Obtain the violation information about the vehicles associated

with alarms

Brief description：

• Obtain the violation information about the vehicles associated

with alarms

Request URL：

• /admin/API/BRM/Alarm/GetAlarmCarPeccancyInfo?token={token}

Request example

POST /admin/API/BRM/Alarm/GetAlarmCarPeccancyInfo?token=56c92f2925b84
18f917d01c0cd867ebd HTTP/1.1
Host: 10.33.68.138
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example
{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmCarPeccancyInfo",
"data": {
"locale": "en",
"optional": "/admin/API/BRM/Alarm/GetAlarmCarPeccancyInfo?tok
en=56c92f2925b8418f917d01c0cd867ebd",
"alarmCode": "{fa3a211f-3df0-4123-984d-dc26091af709}"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"carWayCode": "1",
"carImgUrl": "http://10.33.68.138:18081/d/1000002$1$0$0/20190
727/14/2532-34914-0-Peccancy.jpg?streamID:49@capTime:1564208732",
"carColor": "red",
"peccancyType": "Over Speed",
"carType": "TriCycle",
"alarmTime": "1564208732",
"carNum": "ZA12A26",
"channelName": "Channel0",
"alarmCode": "{fa3a211f-3df0-4123-984d-dc26091af709}",
"carSpeed": "30",
"channelId": "1000002$1$0"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- carWayCode string Violation lane code
- carImgUrl string Image URL
- carColor string Vehicle color (internationalized)
- peccancyType string Violation type
- carType string Vehicle type (internationalized)
- alarmTime string Alarm time (s)
- carNum string license plate number
- channelName string Channel name
- alarmCode string Alarm code
- carSpeed string Speed of the vehicle with traffic violation
- channelId string Channel No.

Notes

• For more returned error codes, see the error code description
on the home page

4.11.10、Obtain alarm-associated entrance or exit restricted list

information

Brief description：

• Obtain the restricted list information of entrance/exit

associated with alarms

Request URL：

• /admin/API/BRM/Alarm/GetAlarmEntranceBlacklistInfo?token={token}

Request example

POST /admin/API/BRM/Alarm/GetAlarmEntranceBlacklistInfo?token=03e03f8
e17fa42079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmEntranceBlacklistInfo",
"data": {
"locale": "en",
"optional": "/admin/API/BRM/Alarm/GetAlarmEntranceBlacklistIn
fo?token=03e03f8e17fa42079dc556fb72221ea7",
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}",
"alarmTime": "1564208732",
"carColor": "black",
"carBrand": "bmw",
"carImgUrl": "http://10.35.93.16:8081/d/1000003$1$0$0/2018112
1/11/1528-4800-0.jpg?streamID:37@capTime:1564208732",
"carNoImgUrl": "http://10.35.93.16:8081/d/1000003$1$0$0/20181
121/11/1528-4800-0.jpg?streamID:37@capTime:1564208732",
"carNo": "TN37CS8691",
"channelId": "1000003$1$0",
"channelName": "itc_1",
"parkingLotName": "test"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- alarmCode string Alarm code
- alarmTime string Alarm time (s)
- carColor string Vehicle color (internationalized)
- carBrand string Vehicle brand (internationalized)
- carImgUrl string Vehicle image URL
- carNoImgUrl string Plate matting URL
- carNo string license plate number
- channelId string Channel No.
- channelName string Channel name
- parkingLotName string Parking lot name

Notes

• For more returned error codes, see the error code description
on the home page

4.11.11、Obtain the timeout information at the entrance or exit

associated with alarms

Brief description：

• Obtain the timeout information at the entrance/exit associated

with alarms

Request URL：

• /admin/API/BRM/Alarm/GetAlarmEntranceOverTimeInfo?token={token}
Request example

POST /admin/API/BRM/Alarm/GetAlarmEntranceOverTimeInfo?token=03e03f8e
17fa42079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmEntranceOverTimeInfo",
"data": {
"locale": "en",
"optional": "/admin/API/BRM/Alarm/GetAlarmEntranceOverTimeInf
o?token=03e03f8e17fa42079dc556fb72221ea7",
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}"
}
}

Parameters：

Parameter Name Type Description

Return example
{
"code": 1000,
"desc": "Success",
"data": {
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}",
"alarmTime": "1564208732",
"enterTime": "1564201732",
"parkingTime": "7000",
"carColor": "black",
"carBrand": "Audi",
"carImgUrl": "http://10.35.93.16:8081/d/1000003$1$0$0/2018112
1/11/1528-4800-0.jpg?streamID:37@capTime:1542770166",
"carNoImgUrl": "http://10.35.93.16:8081/d/1000003$1$0$0/20181
121/11/1528-4800-0.jpg?streamID:37@capTime:1542770166",
"carNo": "TN37CS8691",
"channelId": "1000003$1$0",
"channelName": "itc_1",
"parkingLotName": "ws009"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- alarmCode string Alarm code
- alarmTime string Alarm time (s)
- enterTime string Entering time (s)
- parkingTime string Parking duration (s)
- carColor string Vehicle color (internationalized)
- carBrand string Vehicle brand (internationalized)
- carImgUrl string Vehicle image URL
- carNoImgUrl string Plate matting URL
- carNo string license plate number
- channelId string Channel No.
- channelName string Channel name
- parkingLotName string Parking lot name

Notes

• For more returned error codes, see the error code description
on the home page
4.11.12、Obtain the face snapshot information associated with alarms

Brief description：

• Obtain the face snapshot information associated with alarms

Request URL：

• /admin/API/BRM/Alarm/GetAlarmFaceDetectionInfo?token={token}

Request example

POST /admin/API/BRM/Alarm/GetAlarmFaceDetectionInfo?token=03e03f8e17f
a42079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmFaceDetectionInfo",
"data": {
"optional": "/admin/API/BRM/Alarm/GetAlarmFaceDetectionInfo?t
oken=03e03f8e17fa42079dc556fb72221ea7",
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}"
}
}

Parameters：

Parameter Name Type Description

clientType string Client type
clientMac string Client MAC address
clientPushId string Null
project string Null
Parameter Name Type Description
method string Method name
data object None
- optional string URI information
- alarmCode string Alarm code

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "12",
"code": "26",
"deviceCode": "1000000",
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}",
"channelSeq": "0",
"channelId": "1000000$1$0$0",
"faceImageUrl": "http://10.35.93.16:8081/d/1000003$1$0$0/2018
1121/11/1528-4800-0.jpg?streamID:37@capTime:1542770166",
"pictureUrl": "http://10.35.93.16:8081/d/1000003$1$0$0/201811
21/11/1528-4800-0.jpg?streamID:37@capTime:1542770166",
"appearTime": "2",
"age": "23",
"gender": "0",
"fringe": "0",
"eye": "3",
"mouth": "2",
"mask": "3",
"beard": "1",
"glasses": "2",
"emotion": "6",
"alarmTime": "1564208732"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- id string Primary key
Parameter
Type Description
Name
- code string Personnel snapshot information ID
- deviceCode string Device code
- alarmCode string Alarm code
- channelSeq string Channel sequence number
- channelId string Channel No.
- faceImageUrl string Face snapshot URL
- pictureUrl string Scene picture URL
- appearTime string Appearance times
- age string Age
- gender string Gender: 0—unknown; 1—male; 2—female
- fringe string Fringe: 0—none; 1—yes
- eye string Eyes: 1—unrecognized; 2—eyes closed; 3—eyes open
Mouth: 1—unrecognized; 2—mouth closed; 3—mouth
- mouth string
open
- mask string Mask: 1—unrecognized; 2—no mask; 3—wearing mask
- beard string Beard: 1—unrecognized; 2—no beard; 3—bearded
- glasses string Glasses: 0—none; 1—glasses; 2—sunglasses
Emotion: 0—smiling; 1—angry; 2—sad; 3—disgusted;
- emotion string 4—fearful; 5—surprised; 6—normal; 7—laughing; 8—
happy; 9—confused; 10—screaming
- alarmTime string Alarm time (s)

Notes

• For more returned error codes, see the error code description
on the home page

4.11.13、Obtain the face recognition information associated with alarms

Brief description：

• Obtain the face recognition information associated with alarms

Request URL：

• /admin/API/BRM/Alarm/GetAlarmFaceRecognitionInfo?token={token}

Request example

POST /admin/API/BRM/Alarm/GetAlarmFaceRecognitionInfo?token=03e03f8e1
7fa42079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Alarm.GetAlarmFaceRecognitionInfo",
"data": {
"optional": "/admin/API/BRM/Alarm/GetAlarmFaceRecognitionInf
o?token=03e03f8e17fa42079dc556fb72221ea7",
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}"
}
}

Parameters：

Parameter Name Type Description

clientType string Client type
clientMac string Client MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- alarmCode string Alarm code

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"alarmCode": "{1f4a86fd-d1c4-4777-ad8f-1659aa3f036b}",
"alarmTime": "1564208732",
"name": "zhangsan",
"repositoryName": "lib01",
"personId": "12",
"personTypeName": "VIP",
"gender": "1",
"birthday": "2000-05-12",
"nationality": "china",
"detectionImageUrl": "http://10.35.93.16:8081/d/1000003$1$0$0
/20181121/11/1528-4800-0.jpg?streamID:37@capTime:1542770166",
"repositoryImageUrl": "http://10.35.93.16:8081/d/1000003$1$0
$0/20181121/11/1528-4800-0.jpg?streamID:37@capTime:1542770166",
"similarity": "67"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- alarmCode string Alarm code
- alarmTime string Alarm time (s)
- name string Name
- repositoryName string Face database name
- personId string personnel ID
- personTypeName string Personnel attribute name
- gender string Gender: 1-male; 2-female
- birthday string Date of birth, yyyy-MM-dd
- nationality string Nationality
- detectionImageUrl string Snapshot URL
- repositoryImageUrl string Face image URL
- similarity string Similarity

Notes

• For more returned error codes, see the error code description
on the home page

4.12、Video Wall Configuration

4.12.1、Obtain video wall details

Brief description：

• Obtain video wall details

Request URL：

• /admin/API/tvwall/wall/{id}
• X-Subject-Token: {token}

Request example

GET /admin/API/tvwall/wall/6 HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 4a83ab66826a4524adc9a5bb9f0c3a76
Parameter Name Type Description
id string Video wall ID
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "6",
"tvWallName": "y00912",
"tvWallDesc": "",
"width": "0",
"height": "0",
"wallScreenList": [
{
"id": "25",
"parentId": "-1",
"screenName": "Screen 0",
"screenType": "2",
"deviceType": "6",
"deviceCode": "1000035",
"deviceName": "10.35.92.161",
"channelId": "1000035$2$0$50",
"channelName": "3_3",
"left": "0",
"top": "0",
"width": "69.4",
"height": "45.5",
"ismergeedbigscreen": "0",
"isNewScreen": "1",
"previewLeft": "0",
"previewTop": "0",
"previewWidth": "348",
"previewHeight": "252.5"
},
{
"id": "27",
"parentId": "-1",
"screenName": "Screen 1",
"screenType": "2",
"deviceType": "6",
"deviceCode": "1000035",
"deviceName": "10.35.92.161",
"channelId": "1000035$2$0$51",
"channelName": "3_4",
"left": "69.4",
"top": "0",
"width": "69.4",
"height": "45.5",
"ismergeedbigscreen": "0",
"isNewScreen": "1",
"previewLeft": "348",
"previewTop": "0",
"previewWidth": "348",
"previewHeight": "252.5"
}
],
"bigScreenList": [
{
"id": "21",
"parentId": "-1",
"screenName": "Fusion 1",
"screenType": "3",
"deviceType": "6",
"deviceCode": "1000035",
"deviceName": "10.35.92.161",
"left": "0",
"top": "45.5",
"width": "138.8",
"height": "45.5",
"isNewScreen": "1",
"previewLeft": "0",
"previewTop": "252.5",
"previewWidth": "696",
"previewHeight": "252.5",
"screenList": [
{
"id": "22",
"parentId": "-1",
"screenName": "Screen 2",
"screenType": "2",
"deviceType": "6",
"deviceCode": "1000035",
"deviceName": "10.35.92.161",
"channelId": "1000035$2$0$52",
"channelName": "3_5",
"left": "0",
"top": "45.5",
"width": "69.4",
"height": "45.5",
"ismergeedbigscreen": "1",
"isNewScreen": "1",
"previewLeft": "0",
"previewTop": "252.5",
"previewWidth": "348",
"previewHeight": "252.5"
},
{
"id": "23",
"parentId": "-1",
"screenName": "Screen 3",
"screenType": "2",
"deviceType": "6",
"deviceCode": "1000035",
"deviceName": "10.35.92.161",
"channelId": "1000035$2$0$53",
"channelName": "3_6",
"left": "69.4",
"top": "45.5",
"width": "69.4",
"height": "45.5",
"ismergeedbigscreen": "1",
"isNewScreen": "1",
"previewLeft": "348",
"previewTop": "252.5",
"previewWidth": "348",
"previewHeight": "252.5"
}
]
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- id string Video wall ID
- tvWallName string Name of video walls
- tvWallDesc string Description
- width string Video wall width
- height string Video wall height
- wallScreenList object Ordinary screen
- - id string Screen ID
- - parentId string Parent screen ID
- - screenName string Screen name
Screen type: 1 - Large screen, 2 - Monitor, 3 -
- - screenType string
Window
- - deviceType string Device type
- - deviceCode string Device code
- - deviceName string Device name
- - channelId string Channel No.
- - channelName string Channel name
- - left string Screen left margin (pixel)
- - top string Screen top margin (pixel)
- - width string Screen width (pixel)
- - height string Screen height (pixel)
- - ismergeedbigscreen string Whether it is a fusion screen: 0 - No, 1 - Yes
- - isNewScreen string Whether it is a new screen: 0 - No (modified), 1
Parameter Name Type Description
- Yes
- - previewLeft string Screen left margin
- - previewTop string Screen top margin
- - previewWidth string Screen width
- - previewHeight string Screen height
- bigScreenList object Fusion screen
- - id string Screen ID
- - parentId string Parent screen ID
- - screenName string Screen name
Screen type: 1 - Large screen, 2 - Monitor, 3 -
- - screenType string
Window
- - deviceType string Device type
- - deviceCode string Device code
- - deviceName string Device name
- - left string Screen left margin (pixel)
- - top string Screen top margin (pixel)
- - width string Screen width (pixel)
- - height string Screen height (pixel)
Whether it is a new screen: 0 - No (modified), 1
- - isNewScreen string
- Yes
- - previewLeft string Screen left margin
- - previewTop string Screen top margin
- - previewWidth string Screen width
- - previewHeight string Screen height
Child screen of the fusion screen, belonging to
- - screenList object
bigScreenList
- - - id string Screen ID
- - - parentId string Parent screen ID
- - - screenName string Screen name
Screen type: 1 - Large screen, 2 - Monitor, 3 -
- - - screenType string
Window
- - - deviceType string Device type
- - - deviceCode string Device code
- - - deviceName string Device name
- - - channelId string Channel No.
- - - channelName string Channel name
- - - left string Screen left margin (pixel)
- - - top string Screen top margin (pixel)
- - - width string Screen width (pixel)
- - - height string Screen height (pixel)
- - - string Whether it is a fusion screen: 0 - No, 1 - Yes
Parameter Name Type Description
ismergeedbigscreen
Whether it is a new screen: 0 - No (modified), 1
- - - isNewScreen string
- Yes
- - - previewLeft string Screen left margin
- - - previewTop string Screen top margin
- - - previewWidth string Screen width
- - - previewHeight string Screen height

Notes

• For more returned error codes, see the error code

description on the home page

4.12.2、Obtain the video wall window information

Brief description：

• Obtain the video wall window information

Request URL：

• /admin/API/tvwall/window?wallId={wallId}
• X-Subject-Token: {Token}

Request example

GET /admin/API/tvwall/window?wallId=6 HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 4a83ab66826a4524adc9a5bb9f0c3a76
Parameter Name Type Description
wallId string Video wall ID
Token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null
Return example

{
"code": 1000,
"desc": "Success",
"data": {
"sustainedTime": "30",
"windowList": [
{
"windowCode": "53",
"planId": "0",
"windowName": "Window 4",
"screenId": "65",
"windowType": "1",
"sIndex": "1",
"top": "0",
"left": "147",
"height": "108",
"width": "146",
"zIndex": "0"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- sustainedTime string Alarm stay time
- windowList object Window list
- - windowCode string Window code
- - planId string Plan ID
- - windowName string Window name
- - screenId string Screen ID
- - windowType string Window type
- - sIndex string Splitting order
- - top string Window top margin
- - left string Window left margin
- - height string Window height
- - width string Window width
Parameter
Type Description
Name
Window overlapping order. The window with a greater
- - zIndex string
value overlaps the window with a smaller value.

Notes

• For more returned error codes, see the error code

description on the home page

4.13、Video Wall Task

4.13.1、Obtain the list of video walls at the client

Brief description：

• Obtain the list of video walls at the client

Request URL：

• /admin/API/BRM/TvWall/GetTvWalls?token=${token}

Request example

POST /admin/API/BRM/TvWall/GetTvWalls?token=a9e35a9bb8124112a6b416f66
878e2d1 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.TvWall.GetTvWalls",
"data": {
"optional": "/admin/API/BRM/TvWall/GetTvWalls?token=a9e35a9bb
8124112a6b416f66878e2d1"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tvWalls": [
{
"tvWallId": "1",
"tvWallName": "111",
"orgCode": "001",
"status": "1",
"sustainTime": "30",
"tvWallDesc": "123",
"version": "0",
"data": "",
"editFlag": "1"
},
{
"tvWallId": "5",
"tvWallName": "test",
"orgCode": "001",
"status": "1",
"sustainTime": "30",
"tvWallDesc": "456",
"version": "0",
"data": "",
"editFlag": "1"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- tvWalls object Video wall information
- - tvWallId string Video wall ID
--
string Name of video walls
tvWallName
- - orgCode string Organization code
- - status string Status: 0 - Disabled, 1 - Enabled
--
string Duration (s)
sustainTime
- - tvWallDesc string Description
- - version string Video wall version
- - data string Video wall data
Edit flag: 1 - Edit all, 2 - The layout cannot be edited,
that is to say there are windows, 3 - Already on the video
- editFlag string
wall, and the channel cannot be edited, but can be
added.

Notes

• For more returned error codes, see the error code

description on the home page

4.13.2、Obtain the video wall at the client

Brief description：

• Obtain the video wall at the client

Request URL：

• /admin/API/BRM/TvWall/GetTvWall?token=${token}

Request example

POST /admin/API/BRM/TvWall/GetTvWall?token=4a83ab66826a4524adc9a5bb9f
0c3a76 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.TvWall.GetTvWall",
"data": {
"tvWallId": "5",
"optional": "/admin/API/BRM/TvWall/GetTvWall?token=4a83ab6682
6a4524adc9a5bb9f0c3a76"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tvWallId": "5",
"tvWallName": "test",
"orgCode": "001",
"status": "1",
"sustainTime": "30",
"tvWallDesc": "",
"version": "0",
"data": "<tvwall id=\"5\" name=\"dxh_test\" code=\"001\">\n
<screen id=\"500\" type=\"3\" name=\"screen0\" top=\"0.00\" left=\"0.
00\" height=\"100.00\" width=\"50.00\" code=\"1000035\" deviceType=\"
3\">\n <screen id=\"0\" type=\"2\" name=\"screen0\" top=\"0.00\" l
eft=\"0.00\" height=\"100.00\" width=\"50.00\" code=\"1000035\" unit=
\"0\" seq=\"144\" deviceType=\"3\"/>\n </screen>\n <screen id=\"501
\" type=\"3\" name=\"screen1\" top=\"0.00\" left=\"50.00\" height=\"1
00.00\" width=\"50.00\" code=\"1000035\" deviceType=\"3\">\n <scre
en id=\"0\" type=\"2\" name=\"screen1\" top=\"0.00\" left=\"50.00\" h
eight=\"100.00\" width=\"50.00\" code=\"1000035\" unit=\"0\" seq=\"14
5\" deviceType=\"3\"/>\n </screen>\n</tvwall>",
"editFlag": "1"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- tvWallId string Video wall ID
- tvWallName string Name of video walls
- orgCode string Organization code
- status string Status: 0 - Disabled, 1 - Enabled
- sustainTime string Duration (s)
- tvWallDesc string Description
- version string Video wall version
- data string Video wall data
Edit flag: 1 - Edit all, 2 - The layout cannot be edited,
that is to say there are windows, 3 - Already on the video
- editFlag string
wall, and the channel cannot be edited, but can be
added.

Notes

• For more returned error codes, see the error code

description on the home page

4.13.3、Obtain the list of tasks on the video wall at the client

Brief description：

• Obtain the list of tasks on the video wall at the client

Request URL：

• /admin/API/BRM/TvWall/GetUserTvWallTasks?token=${token}

Request example

POST /admin/API/BRM/TvWall/GetUserTvWallTasks?token=a9e35a9bb8124112a
6b416f66878e2d1 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.TvWall.GetUserTvWallTasks",
"data": {
"tvWallId": "5",
"optional": "/admin/API/BRM/TvWall/GetUserTvWallTasks?token=a
9e35a9bb8124112a6b416f66878e2d1"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
Parameter Name Type Description
- tvWallId string Video wall ID
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tasks": [
{
"tvWallId": "5",
"taskId": "1",
"taskName": "12",
"taskDesc": "",
"data": ""
},
{
"tvWallId": "5",
"taskId": "2",
"taskName": "test",
"taskDesc": "",
"data": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n
<TVWallScheme>\n\t<Tasks>\n\t\t<Task id=\"1\" name=\"12\" screen=\"2\
" tvWallCfgId=\"5\" desc=\"\" isOnlineSend=\"false\" isAlarmTime=\"0\
" prefTime=\"0\" recordType=\"0\" taskType=\"0\" isDevAutoCycle=\"fal
se\" planType=\"0\">\n\t\t\t<Screen wndNo=\"0\" decodeId=\"1000035\"
tvIdx=\"500\" splitNum=\"1\" visitorMode=\"1\" screenId=\"500\" scree
nMode=\"2\" isCombined=\"false\" name=\"screen0\" left=\"0\" top=\"0\
" width=\"50\" height=\"100\" screenAlarmWall=\"0\" screenSeq=\"0\">\
n\t\t\t\t<SubTv id=\"0\" left=\"0\" top=\"0\" width=\"100\" height=\"
100\" name=\"1-1\" zorder=\"0\" isAlarm=\"0\" isHighLight=\"0\" isOpe
nAudio=\"0\" subWinNum=\"0\">\n\t\t\t\t\t<Channel id=\"1000039$1$0$1\
" name=\"Channel1\" subStream=\"1\" timeSpan=\"15\" presetPos=\"0\" d
eviceId=\"1000039\" no=\"1\" devType=\"1\" alarmType=\"0\" manufactur
erType=\"1\" trackID=\"801\" OsdText=\"\" osdBackgroundRect=\"\" osdF
ont=\"\" osdFrontColor=\"\" enableOsd=\"false\" connType=\"-1\" patro
lMode=\"0\" OsdSwitch=\"0\" OsdLeft=\"0\" OsdTop=\"0\" OsdRed=\"0\" O
sdGreen=\"0\" OsdBlue=\"0\" fishFitMode=\"0\" fishShowMode=\"0\" grou
pId=\"\" cameraIdentifier=\"\" encodeType=\"0\" beginTime=\"0\" endTi
me=\"0\" timeOffset=\"-1\" />\n\t\t\t\t</SubTv>\n\t\t\t</Screen>\n\t\
t\t<Screen wndNo=\"1\" decodeId=\"1000035\" tvIdx=\"501\" splitNum=\"
1\" visitorMode=\"1\" screenId=\"501\" screenMode=\"2\" isCombined=\"
false\" name=\"screen1\" left=\"50\" top=\"0\" width=\"50\" height=\"
100\" screenAlarmWall=\"0\" screenSeq=\"0\">\n\t\t\t\t<SubTv id=\"0\"
left=\"0\" top=\"0\" width=\"100\" height=\"100\" name=\"2-1\" zorde
r=\"0\" isAlarm=\"0\" isHighLight=\"0\" isOpenAudio=\"0\" subWinNum=\
"0\">\n\t\t\t\t\t<Channel id=\"1000039$1$0$0\" name=\"Channel0\" subS
tream=\"1\" timeSpan=\"15\" presetPos=\"0\" deviceId=\"1000039\" no=\
"0\" devType=\"1\" alarmType=\"0\" manufacturerType=\"1\" trackID=\"8
01\" OsdText=\"\" osdBackgroundRect=\"\" osdFont=\"\" osdFrontColor=\
"\" enableOsd=\"false\" connType=\"-1\" patrolMode=\"0\" OsdSwitch=\"
0\" OsdLeft=\"0\" OsdTop=\"0\" OsdRed=\"0\" OsdGreen=\"0\" OsdBlue=\"
0\" fishFitMode=\"0\" fishShowMode=\"0\" groupId=\"\" cameraIdentifie
r=\"\" encodeType=\"0\" beginTime=\"0\" endTime=\"0\" timeOffset=\"-1
\" />\n\t\t\t\t</SubTv>\n\t\t\t</Screen>\n\t\t</Task>\n\t</Tasks>\n\t
<ChnlExtern>\n\t\t<Channel id=\"1000039$1$0$1\" ip=\"10.33.68.138\" p
ort=\"37779\" username=\"admin\" password=\"admin\" no=\"1\" type=\"0
\" channelNum=\"2\" />\n\t\t<Channel id=\"1000039$1$0$0\" ip=\"10.33.
68.138\" port=\"37779\" username=\"admin\" password=\"admin\" no=\"0\
" type=\"0\" channelNum=\"2\" />\n\t</ChnlExtern>\n</TVWallScheme>\n"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- tasks object Video wall task information
- - tvWallId string Video wall ID
- - taskId string Task ID
- - taskName string Task name
- - taskDesc string Description
- - data string Task data

Notes

• For more returned error codes, see the error code

description on the home page

4.13.4、Obtain the tasks on the video wall at the client

Brief description：
• Obtain the tasks on the video wall at the client

Request URL：

• /admin/API/BRM/TvWall/GetUserTvWallTask?token=${token}

Request example

POST /admin/API/BRM/TvWall/GetUserTvWallTask?token=a9e35a9bb8124112a6
b416f66878e2d1 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.TvWall.GetUserTvWallTask",
"data": {
"tvWallId": "5",
"optional": "/admin/API/BRM/TvWall/GetUserTvWallTask?token=a9
e35a9bb8124112a6b416f66878e2d1",
"taskId": "1"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- tvWallId string Video wall ID
Parameter Name Type Description
- optional string URI information
- taskId string Video wall task ID

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tvWallId": "5",
"taskId": "1",
"taskName": "12",
"taskDesc": "",
"data": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<TVWallS
cheme>\n\t<Tasks>\n\t\t<Task id=\"3\" name=\"test_dxh\" screen=\"2\"
tvWallCfgId=\"5\" desc=\"\" isOnlineSend=\"false\" isAlarmTime=\"0\"
prefTime=\"0\" recordType=\"0\" taskType=\"0\" isDevAutoCycle=\"false
\" planType=\"0\">\n\t\t\t<Screen wndNo=\"0\" decodeId=\"1000035\" tv
Idx=\"500\" splitNum=\"1\" visitorMode=\"1\" screenId=\"500\" screenM
ode=\"2\" isCombined=\"false\" name=\"screen0\" left=\"0\" top=\"0\"
width=\"50\" height=\"100\" screenAlarmWall=\"0\" screenSeq=\"0\">\n\
t\t\t\t<SubTv id=\"0\" left=\"0\" top=\"0\" width=\"100\" height=\"10
0\" name=\"1-1\" zorder=\"0\" isAlarm=\"0\" isHighLight=\"0\" isOpenA
udio=\"0\" subWinNum=\"0\" />\n\t\t\t</Screen>\n\t\t\t<Screen wndNo=\
"1\" decodeId=\"1000035\" tvIdx=\"501\" splitNum=\"1\" visitorMode=\"
1\" screenId=\"501\" screenMode=\"2\" isCombined=\"false\" name=\"scr
een1\" left=\"50\" top=\"0\" width=\"50\" height=\"100\" screenAlarmW
all=\"0\" screenSeq=\"0\">\n\t\t\t\t<SubTv id=\"0\" left=\"0\" top=\"
0\" width=\"100\" height=\"100\" name=\"2-1\" zorder=\"0\" isAlarm=\"
0\" isHighLight=\"0\" isOpenAudio=\"0\" subWinNum=\"0\" />\n\t\t\t</S
creen>\n\t\t</Task>\n\t</Tasks>\n</TVWallScheme>\n"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- tvWallId string Video wall ID
- taskId string Task ID
- taskName string Task name
Parameter Name Type Description
- taskDesc string Description
- data string Task data

Notes

• For more returned error codes, see the error code

description on the home page

4.13.5、Add or modify tasks on the video wall at the client

Brief description：

• Add or modify tasks on the video wall at the client

Request URL：

• /admin/API/BRM/TvWall/SaveUserTvWallTask?token=${token}

Request example

POST /admin/API/BRM/TvWall/SaveUserTvWallTask?token=a9e35a9bb8124112a
6b416f66878e2d1 HTTP/1.1
Host: 10.35.93.21:801
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.TvWall.SaveUserTvWallTask",
"data": {
"tvWallId": "5",
"optional": "/admin/API/BRM/TvWall/SaveUserTvWallTask?token=a
9e35a9bb8124112a6b416f66878e2d1",
"taskId": "3",
"taskName": "test",
"taskDesc": "",
"data": "\n\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t
\t\t\n\t\t\t\n\t\t\n\t\n\n"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- tvWallId string Video wall ID
- optional string URI information
- taskId string Video wall task ID
- taskName string Name of the task on the video wall
- taskDesc string Description of the task on the video wall
- data string Task data

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.13.6、Delete tasks from the video wall at the client

Brief description：

• Delete tasks from the video wall at the client

Request URL：

• /admin/API/BRM/TvWall/DeleteUserTvWallTask?token=${token}

Request example

POST /admin/API/BRM/TvWall/DeleteUserTvWallTask?token=a9e35a9bb812411
2a6b416f66878e2d1 HTTP/1.1
Host: 10.35.93.21:801
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.TvWall.DeleteUserTvWallTask",
"data": {
"tvWallId": "5",
"optional": "/admin/API/BRM/TvWall/DeleteUserTvWallTask?token
=a9e35a9bb8124112a6b416f66878e2d1",
"taskId": "3"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- tvWallId string Video wall ID
- optional string URI information
Parameter Name Type Description
- taskId string Video wall task ID

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.13.7、Obtain the task information on the current video wall

Brief description：

• Obtain the task information on the current video wall

Request URL：

• /admin/API/VMS/TvWall/GetTvWallTaskInfo?token=${token}

Request example

POST /admin/API/VMS/TvWall/GetTvWallTaskInfo?token=a9e35a9bb8124112a6
b416f66878e2d1 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example
{
"clientType": "WINPC",
"clientMac": "48:4d:7e:c6:60:03",
"clientPushId": "",
"project": "PSDK",
"method": "VMS.TvWall.GetTvWallTaskInfo",
"data": {
"optional": "/admin/API/VMS/TvWall/GetTvWallTaskInfo?token=a9
e35a9bb8124112a6b416f66878e2d1"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tasks": [
{
"dataType": "0",
"tvWallId": "3",
"taskId": "1",
"taskName": "matrix",
"planId": "",
"planName": ""
},
{
"dataType": "0",
"tvWallId": "12",
"taskId": "0",
"taskName": "",
"planId": "",
"planName": ""
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- tasks object Task information on the current video wall
- - dataType string Data type: 0 - Task, 1 - Plan
- - tvWallId string Video wall ID
- - taskId string Task ID
- - taskName string Task name
- - planId string Plan ID
- - planName string Plan name

Notes

• For more returned error codes, see the error code

description on the home page

4.14、Video on Wall

4.14.1、Obtain the video wall capability

Brief description：

• Obtain the video wall capability

Request URL：

• /admin/API/VMS/TvWall/GetTvWallCapacity?token=${token}

Request example

POST /admin/API/VMS/TvWall/GetTvWallCapacity?token=01c7319a23114bd5b4
38db8874910279 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
Token string The token obtained when logging in
Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "VMS.TvWall.GetTvWallCapacity",
"data": {
"tvWallId": "3",
"optional": "/admin/API/VMS/TvWall/GetTvWallCapacity?token=01
c7319a23114bd5b438db8874910279"
}
}

Parameters：

Parameter Name Type Description

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"tvWallId": "3",
"screens": [
{
"screenId": "302",
"maxFreeWindows": "16",
"splitCaps": "1,4,16"
},
{
"screenId": "303",
"maxFreeWindows": "16",
"splitCaps": "1,4,16"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- tvWallId string Video wall ID
- screens object None
- - screenId string Screen ID
- - maxFreeWindows string Maximum number of supported windows
- - splitCaps string Supported window layout

Notes

• For more returned error codes, see the error code

description on the home page

4.14.2、Video wall control

Brief description：

• Control the displaying of videos on the wall

Request URL：

• /admin/API/VMS/TvWall/OperateTvWall?token={token}

Request example

POST /admin/API/VMS/TvWall/OperateTvWall?token=f302a7b8212449f29d9a16
8b872c6f4f HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：
• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "VMS.TvWall.OperateTvWall",
"data": {
"tvWallId": "3",
"optional": "/admin/API/VMS/TvWall/OperateTvWall?token=f302a7
b8212449f29d9a168b872c6f4f",
"tvIndex": "302",
"deviceCode": "1000171",
"alarmLevel": "0",
"data": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<TVWallS
cheme>\n\t<Tasks>\n\t\t<Task id=\"-1\" name=\"matrix\" screen=\"2\" t
vWallCfgId=\"5\" desc=\"\" isOnlineSend=\"false\" isAlarmTime=\"0\" p
refTime=\"0\" recordType=\"0\" taskType=\"0\" isDevAutoCycle=\"false\
" planType=\"0\">\n\t\t\t<Screen wndNo=\"0\" decodeId=\"1000035\" tvI
dx=\"500\" splitNum=\"0\" visitorMode=\"1\" screenId=\"500\" screenMo
de=\"2\" isCombined=\"true\" name=\"Screen 0\" left=\"0\" top=\"0\" w
idth=\"50\" height=\"100\" screenAlarmWall=\"0\" screenSeq=\"0\" />\n
\t\t\t<Screen wndNo=\"1\" decodeId=\"1000035\" tvIdx=\"501\" splitNum
=\"0\" visitorMode=\"1\" screenId=\"501\" screenMode=\"2\" isCombined
=\"true\" name=\"Screen 1\" left=\"50\" top=\"0\" width=\"50\" height
=\"100\" screenAlarmWall=\"0\" screenSeq=\"0\" />\n\t\t</Task>\n\t</T
asks>\n</TVWallScheme>\n",
"operateType": "8",
"tvWallVersion": "0",
"tvType": "1",
"position": {
"top": "0",
"height": "0",
"left": "0",
"width": "0"
},
"subWindowNo": "0",
"screenId": "302",
"order": "0",
"splitNumber": "0",
"subTvIndex": "0"
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- tvWallId string Video wall ID
- optional string URI information
Physical channel number, can be the same as the
- tvIndex string
screen ID when used for a merge splicing wall
- deviceCode string Decoder code
- alarmLevel string Alarm grade
- data string Task data
- operateType string See notes for detailed value description.
- tvWallVersion string Video wall configuration solution version
- tvType string 0 - not splicing wall; 1 - merge splicing wall
- position object Position information
- - top string Top
- - height string Height
- - left string Left
- - width string Width
Child window number, -1 for an invalid value (namely,
- subWindowNo string
no child windows)
- screenId string Screen ID
- order string Z order: -1 - to the bottom; 0 - to the top
- splitNumber string Number of splits
- subTvIndex string Window ID

Notes operateType

0 - starting a set of tasks; 1 - real-time displaying of videos on th

e wall - setting a video source; 2 - real-time displaying of videos o
n the wall - closing the video source of the window (no processing on
the splitting/windowing of the screen); 3 - real-time displaying of
videos on the wall - screen splitting; 4 - real-time displaying of vi
deos on the wall - screen windowing; 5 - real-time displaying of vide
os on the wall - window closing on the screen; 6 - real-time displayi
ng of videos on the wall - window moving; 7 - real-time displaying of
videos on the wall - window sticking (setting the window Z order); 8
- screen on and off; 9 - starting a planned task; 10 - alarm task; 1
1 - closing a planned task; 12 - clearing single screens. In this cas
e, only corresponding _tvIndex, _screenId, _tvType, and _tvWallDBId a
re required; 13 - highlighting windows. In this case, only correspond
ing _tvIndex, _screenId, _subTvIndex, _tvType, and _tvWallDBId are re
quired. Here splitNum indicates highlighted (1) or not highlighted
(0). If RGBA color information is required, reuse position; 14 - real
-time displaying of videos on the wall - window maximization, namely
maximizing a window to cover the entire screen; 15 - suspending touri
ng the channels for displaying videos on the wall. In this case, if _
screenId is -1, the function is valid for the entire video wall; if _
subTvIndex is -1, the function is valid for the entire screen (_scree
nId must be a valid value); 16 - restoring touring the channels for d
isplaying videos on the wall, same as 15; 17 - switching the video so
urce in a single window to previous video wall. Both _screenId and _s
ubTvIndex must be valid. 18 - audio switch control for a single windo
w. In this case, only corresponding _tvIndex, _screenId, _subTvIndex,
_tvType, and _tvWallDBId are required. Here splitNum indicates enabl
e (1) or disable (0); 19 - displaying a video source on the wall; 20
- displaying alarm processing on the wall; 21 - displaying new alarm
on the wall (only sending a video source, self-adaptive); 22 - window
splitting

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"session": "0",
"deviceCode": ""
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- session string Session ID
- deviceCode string Decoder code
Notes

• Formore returned error codes, see the error code

description on the home page

4.15、Video Intercom

4.15.1、Obtain the list of released information

Brief description：

• Obtain the list of released information

Request URL：

• /OBMS/vtalk/infoPublishList?page={page}&pagesize={pagesize}
• X-Subject-Token: {token}

Request example

GET /OBMS/vtalk/infoPublishList?page=1&pagesize=20 HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 4a83ab66826a4524adc9a5bb9f0c3a76
Parameter
Type Description
Name
page string First page of search, min. 1, 1 by default
Record count per page, min. 1 and max. 256, 32 by
pagesize string
default
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "3",
"infoType": "1",
"subject": "test9",
"content": "a test",
"status": "1",
"createTime": "1541405432",
"publishDetails": [
{
"vthDeviceCode": "1000002",
"status": "0",
"reason": "offline"
}
]
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- pageData object Page data
- - id string ID of the released message
- - infoType string Type of the sent message: 0 - Prompt, 1 - Bulletin
- - subject string Send subject
- - content string Content
- - status string Release status
- - createTime string Creation time (s)
- - publishDetails object None
- - - vthDeviceCode string Indoor unit device code
- - - status string Release status: 0 - Failed, 1 - Succeeded
- - - reason string Failure cause
- nextPage string Next page
- totalCount string Total count
Notes

• Formore returned error codes, see the error code

description on the home page

4.15.2、Obtain one piece of released information based on the primary key ID

Brief description：

• Obtainone piece of released information based on the

primary key ID

Request URL：

• /OBMS/vtalk/{id}
• X-Subject-Token: {token}

Request example

GET /OBMS/vtalk/1 HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 4a83ab66826a4524adc9a5bb9f0c3a76
Parameter Name Type Description
id string Released message ID
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "1",
"infoType": "1",
"subject": "test9",
"content": "a test",
"status": "1",
"createTime": "1541405432",
"publishDetails": [
{
"vthDeviceCode": "1000002",
"status": "0",
"reason": "offline"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- id string ID of the released message
- infoType string Type of the sent message: 0 - Prompt, 1 - Bulletin
- subject string Send subject
- content string Content
- status string Release status
- createTime string Creation time (s)
- publishDetails object None
- - vthDeviceCode string Indoor unit device code
- - status string Release status: 0 - Failed, 1 - Succeeded
- - reason string Failure cause

Notes

• For more returned error codes, see the error code

description on the home page

4.15.3、Obtain call logs based on devices

Brief description：

• Obtain call logs based on devices

Request URL：

• /OBMS/vtalk/callLogList
• X-Subject-Token: {token}

Request example

POST /OBMS/vtalk/callLogList HTTP/1.1

Host: 10.35.93.179
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: a6da13c574054cd7a8cd3ac61910d077
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"callEndTime": "1558627199",
"callStartTime": "1556640000",
"deviceCodes": [
"1000059",
"1000060",
"1000061"
],
"page": 1,
"pagesize": 20
}

Parameters：

Parameter Name Type Description

callEndTime string Call duration end time (s)
callStartTime string Call duration start time (s)
deviceCodes object Call device code
page number Search start page
pagesize number number of records on each page

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "12",
"deviceName": "4J03991PAZAD67B",
"callType": "0",
"callNumber": "2",
"callTime": "1557785967",
"endState": "0",
"talkTime": "0",
"formatCallTime": "2019-05-13 15:19:27",
"formatTalkTime": "00:00",
"callingParty": "2",
"calledParty": "8888881000",
"picturePath": "",
"recordId": ""
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- pageData object Page data
- - id string Call log ID
- - deviceName string Device name
- - callType string Call type: 0 - Outgoing, 1 - Incoming
- - callNumber string Call number
- - callTime string Call time (s)
- - endState string Final status: 0 - Not connected, 1 - Connected
- - talkTime string Call duration (s)
- - formatCallTime string Call time, format: yyyy-MM-dd HH:mm:ss
- - formatTalkTime string Call duration, format: HH:mm:ss or mm:ss
- - callingParty string Calling party
- - calledParty string Called party
- - picturePath string Image
- - recordId string Record ID
- nextPage string Next page; -1 means no next page.
- totalCount string Total count
Notes

• For more returned error codes, see the error code

description on the home page

4.15.4、Obtain call log number

Brief description：

• Obtain call numbers

Request URL：

• /OBMS/vtalk/callLog/callNumbers
• X-Subject-Token: {token}

Request example

POST /OBMS/vtalk/callLog/callNumbers HTTP/1.1

Request method：

• POST

Request example

{
"userIds": [
"19"
],
"deviceCodes": [
"1000002",
"1000006",
"1000001"
]
}

Parameters：

Parameter Name Type Description

userIds object User ID
Parameter Name Type Description
deviceCodes object Device code

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"userCallNumbers": [
{
"userId": "19",
"callNumber": "15633332666"
}
],
"deviceCallNumbers": [
{
"deviceCode": "1000002",
"callNumber": "1#1#108#0"
},
{
"deviceCode": "1000006",
"callNumber": "1#1#1111"
},
{
"deviceCode": "1000001",
"callNumber": "1#1#801#200"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- userCallNumbers object User call number information
- -userId string User ID
- -callNumber string Call number
- deviceCallNumbers object Device call number information
- -deviceCode string Device code
- -callNumber string Call number
Notes

• Formore returned error codes, see the error code

description on the home page

4.15.5、Obtain the updated app version

Brief description：

• Obtain the updated application version

Request URL：

• /OBMS/vtalk/phone/checkUpdate/{deviceType}
• X-Subject-Token: {token}

Request example

GET /OBMS/vtalk/phone/checkUpdate/1 HTTP/1.1

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"newVersion": "1.2.2.3"
}
}
Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- newVersion string New version number

Notes

• For more returned error codes, see the error code

description on the home page

4.16、Attendance

4.16.1、Exporting card swiping records

Brief description：

• Export attendance card swiping records

Request URL：

• /admin/API/attendance/swiping-card-
report/export?deptId={deptId}&exportType={exportType}&lo
cal={local}&endTime={endTime}&startTime={startTime}&keyw
ord={keyword}&eventType={eventType}
• X-Subject-Token: {token}

Request example

GET /admin/API/attendance/swiping-card-report/export?deptId=001001&ex
portType=xlsx&local=zh&endTime=2018-11-23%2023%3A59%3A59&startTime=20
18-11-23%2000%3A00%3A00&keyword=&eventType=0 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 10bcf45237a14149901e7764ae0a7619
Parameter
Type Description
Name
deptId string Department ID
exportType string Export file type: only .xlsx supported
local string International, such as zh and en
endTime string End time, format: yyyy-MM-dd HH:mm:ss
startTime string Start time, format: yyyy-MM-dd HH:mm:ss
keyword string Keywords
Parameter
Type Description
Name
Attendance events: 0 - All, 1 - Sign-in, 2 - Sign-out, 3
eventType string
- Away, 4 - Back
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"fileUrl": "/upload/admin/alarm/attendanceCardLog/11542960353
616.xls"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- fileUrl string File download URL

Notes

• Formore returned error codes, see the error code

description on the home page

4.16.2、Exporting attendance report information

Brief description：

• Export attendance report information

Request URL：

• /admin/API/attendance/record-info-
report/export?deptId={deptId}&exportType={exportType}&lo
cal={local}&endTime={endTime}&startTime={startTime}&keyw
ord={keyword}&eventType={eventType}
• X-Subject-Token: {token}

Request example

GET /admin/API/attendance/record-info-report/export?deptId=001001&exp
ortType=xlsx&local=zh&endTime=2018-11-23%2023%3A59%3A59&startTime=201
8-11-23%2000%3A00%3A00&keyword=&eventType=0 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 10bcf45237a14149901e7764ae0a7619
Parameter Name Type Description
deptId string Department ID
exportType string Export file type: only .xlsx supported
local string International, such as zh and en
endTime string End time, format: yyyy-MM-dd HH:mm:ss
startTime string Start time, format: yyyy-MM-dd HH:mm:ss
keyword string Keywords
eventType string Ignore, value 0
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"fileUrl": "/upload/admin/alarm/attendanceInfoLog/11542960772
735.xls"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- fileUrl string File download URL

Notes

• For more returned error codes, see the error code

description on the home page

4.16.3、Export attendance abnormality record

Brief description：

• Export attendance abnormality records

Request URL：

• /admin/API/attendance/abnormal-
report/export?deptId={deptId}&exportType={exportType}&lo
cal={local}&endTime={endTime}&startTime={startTime}&keyw
ord={keyword}&eventType={eventType}
• X-Subject-Token: {token}

Request example

GET /admin/API/attendance/abnormal-report/export?deptId=001001&export
Type=xlsx&local=zh&endTime=2018-11-23%2023%3A59%3A59&startTime=2018-1
1-23%2000%3A00%3A00&keyword=&eventType=0 HTTP/1.1
Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 10bcf45237a14149901e7764ae0a7619
Parameter
Type Description
Name
deptId string Department ID
exportType string Export file type: only .xlsx supported
local string International, such as zh and en
endTime string End time, format: yyyy-MM-dd HH:mm:ss
Parameter
Type Description
Name
startTime string Start time, format: yyyy-MM-dd HH:mm:ss
keyword string Keywords
Attendance events: 0 - All, 1 - Late, 2 - Leave early, 3 -
Unauthorized absence, 4 - Late and leave early, 5 - Forget
eventType string
to punch in/out, 6 - Late and forget to punch in 7 - Leave
early and forget to punch out
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"fileUrl": "/upload/admin/alarm/attendanceAbnormalLog/1154296
1016538.xls"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- fileUrl string File download URL

Notes

• Formore returned error codes, see the error code

description on the home page

4.16.4、Search the card swiping table

Brief description：

• Searchcard swiping report. Reports from the same month

can be queried, and reports from different months cannot
be queried at present.

Request URL：

• /admin/API/attendance/swiping-card-
report/page?deptId={deptId}&endTime={endTime}&eventType=
{eventType}&keyword={keyword}&startTime={startTime}&page
No={pageNo}&pageSize={pageSize}
• X-Subject-Token: {token}

Request example

GET /admin/API/attendance/swiping-card-report/page?deptId=001&endTime
=2019-04-22+23:59:59&eventType=0&keyword=&startTime=2019-04-22+00:00:
00&pageNo=1&pageSize=20 HTTP/1.1
Host: 172.22.151.123
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter
Type Description
Name
deptId string Department ID
endTime string End time
Attendance event type: 0 - All, 1 - Sign-in, 2 - Sign-
eventType string
out, 3 - Away, 4 - Back
keyword string Keywords
startTime string Start time
pageNo string Page
pageSize string Number of pages
Token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null
Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "2",
"code": "15",
"name": "test",
"deptName": "",
"swipeTime": "2019-11-15 15:30:10",
"swipeLocation": "areaA",
"eventName": "Punch in",
"cardNumber": "10002365",
"personPic": ""
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- pageData object None
- - id string Record ID
- - code string Card swiping ID
- - name string personnel name
- - deptName string Department name
- - swipeTime string Card swiping time
- - swipeLocation string Device location of card swiping
- - eventName string Attendance event
- - cardNumber string Card number
- - personPic string Personnel picture
- nextPage number Next page; -1 means no more pages.
- totalCount number Total count

Notes
• For more returned error codes, see the error code
description on the home page

4.16.5、Search the attendance report

Brief description：

• Search attendance reports. Reports from the same month can

be queried, and reports from different months cannot be
queried at present.

Request URL：

• /admin/API/attendance/record-info-
report/page?deptId={deptId}&endTime={endTime}&eventType=
{eventType}&keyword={keyword}&startTime={startTime}&page
No={pageNo}&pageSize={pageSize}
• X-Subject-Token: {token}

Request example

GET /admin/API/attendance/record-info-report/page?deptId=001&endTime=
2019-08-06+23:59:59&eventType=&keyword=zhang&startTime=2019-08-06+00:
00:00&pageNo=1&pageSize=20 HTTP/1.1
Host: 172.22.151.123
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter Name Type Description
deptId string Department ID
endTime string End time
eventType string The field is null by default.
keyword string Keyword, optional, fuzzy search by number or name
startTime string Start time
pageNo string Page
pageSize string Number of pages
token string Token obtained in login

Request method：

• GET

Request example

Null
Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"attendanceDate": "2019-08-06",
"code": "10001",
"name": "zhang san",
“deptName": "Root node",
"signInTime": "16:51",
"signOutTime": "16:53",
"week": "2",
"outTime": "0.0 hour",
"workTime": "2",
"abnormalStatus": "1",
"workOverTime": "0.0",
"workOverType": "1"
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Description of return parameters

Parameter
Type Description
Name
code number Error code
desc string Result description
data object None
- pageData object None
- - attendanceDate string Date
- - code string No.
- - name string Name
- - deptName string Department
- - signInTime string Sign-in time
- - signOutTime string Sign-out time
Parameter
Type Description
Name
- - week string
Week
- - outTime string
Away duration
- - workTime string
Work duration (m)
- - abnormalStatus string
Abnormal status, the field not used for now
- - workOverTime string
Overtime duration (m)
Overtime type: 1 - Workday, 2 - Restday, 3 -
- - workOverType string
Holiday
- nextPage number Next page; -1 means no more pages.
- totalCount number Total count

Notes

• For more returned error codes, see the error code

description on the home page

4.16.6、Search abnormality report

Brief description：

• Search abnormality report

Request URL：

• /admin/API/attendance/abnormal-
report/page?deptId={deptId}&endTime={endTime}&eventType=
{eventType}&keyword={keyword}&startTime={startTime}&page
No={pageNo}&pageSize={pageSize}
• X-Subject-Token: {token}

Request example

GET /admin/API/attendance/abnormal-report/page?deptId=001&endTime=201
9-04-22+23:59:59&eventType=0&keyword=&startTime=2019-04-22+00:00:00&p
ageNo=1&pageSize=20 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter
Type Description
Name
deptId string Department ID
endTime string End time
Attendance event abnormality type: 0 - All, 1 - Late, 2 -
eventType string
Leave early, 3 - Unauthorized absence, 4 - Late and leave
Parameter
Type Description
Name
early, 5 - Forget to punch in/out, 6 - Late and forget to
punch in, 7 - Forget to punch out and leave early
keyword string Keywords
startTime string Start time
pageNo string Page
pageSize string Number of pages
token string Token obtained in login

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [],
"nextPage": "-1",
"totalCount": "0"
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- pageData object None
- - id string Record ID
- - attendanceDate string Date
- - code string Code
- - name string Name
- - deptName string Department
Parameter Name Type Description
- - orderName string Shift name
- - signInTime string Sign-in time
- - signOutTime string Sign-out time
- - week string Week
- - outTime string Away duration
- - workTime string Work duration
- - abnormalStatus string Abnormality status
- - workOverTime string Overtime duration
- nextPage number Next page; -1 means no more pages.
- totalCount number Total count

Notes

• For more returned error codes, see the error code

description on the home page

4.17、AI

4.17.1、Obtain face database list (all)

Brief description：

• Obtain face database list (all)

Request URL：

• /admin/API/face/repositorys
• X-Subject-Token: {token}

Request example

GET /admin/API/face/repositorys HTTP/1.1

Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• GET

Request example
Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"results": [
{
"repositoryId": "1",
"repositoryColor": "1",
"repositoryName": "100",
"memo": ""
},
{
"repositoryId": "11",
"repositoryColor": "1",
"repositoryName": "kkk",
"memo": ""
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- results object None
- - repositoryId string Database ID
-- Database color: 1-gray; 2-red; 3-orange; 4-yellow; 5-
string
repositoryColor green; 6-cyan; 7-blue; 8-purple
--
string Database name
repositoryName
- - memo string Remarks

Notes
• Formore returned error codes, see the error code
description on the home page

4.17.2、Obtain the arming face database list (by pages)

Brief description：

• Obtain the arming face database list (paging)

Request URL：

• /admin/API/face/application/repositorys?token={token}

Request example

POST /admin/API/face/application/repositorys?token=457cb8a2da6046c4af
afb7d7a4ac4075 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "DMS.Face.GetFaceRepositorys",
"data": {
"optional": "/admin/API/face/application/repositorys?token=45
7cb8a2da6046c4afafb7d7a4ac4075",
"searchInfo": {
"searchKey": "test"
},
"pageInfo": {
"pageSize": 20,
"pageNo": 1
}
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- searchInfo object Search condition
Search field, used to match the name of the face
- - searchKey string
database
- pageInfo object Page number
- - pageSize string Records on each page
- - pageNo string Page

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": 2,
"pageData": [
{
"id": "58",
"color": "3",
"colorName": "yellow",
"name": "test11111",
"memo": "test",
"createTime": "1550129427",
"updateTime": "1550129427",
"facePersonCount": "0",
"channelInfos": null,
"isFailedChns": "0"
},
{
"id": "1",
"color": "1",
"colorName": "gray",
"name": "Test",
"memo": "",
"createTime": "1544078797",
"updateTime": "1544078797",
"facePersonCount": "1",
"channelInfos": [
{
"cameraType": "1",
"channelName": "3L056E8AAG00018"
}
],
"isFailedChns": "0"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- total number Number of search results
- pageData object None
- - id string Face database ID
- - color string Color of the face database
- - colorName string Name of the color of the face database
- - name string Face database name
- - memo string Face database remarks
- - createTime string Creation time (s)
- - updateTime string Update time (s)
--
string Number of faces in the face database
facePersonCount
- - channelInfos object None
- - - cameraType string Channel type
- - - channelName string Channel name
Whether there is a device failing to be sent: 0-
- - isFailedChns string
none; 1-yes

Notes

• For more returned error codes, see the error code

description on the home page
4.17.3、Obtain personnel type list

Brief description：

• Obtain personnel type list

Request URL：

• /admin/API/person/personTypes
• X-Subject-Token: {token}

Request example

GET /admin/API/person/personTypes HTTP/1.1

Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: a3f76d78f5c84d5d92b7c323b04164a8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"results": [
{
"personTypeId": "1",
"personTypeName": "wanted"
}
]
}
}
Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- results object personnel type information
- - personTypeId int personnel type ID
- - personTypeName int personnel type name

Notes

• For more returned error codes, see the error code

description on the home page

4.17.4、Obtain face database

Brief description：

• Obtain face database

Request URL：

• /admin/API/face/repository/{repositoryId}
• X-Subject-Token: {token}

Request example

GET /admin/API/face/repository/2 HTTP/1.1

Request method：

• GET

Request example

Null

Parameters：
Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "2",
"color": "1",
"colorName": "gray",
"name": "face_test",
"memo": "test",
"createTime": "1551062268",
"updateTime": "1551062268",
"facePersonCount": null,
"thumbIcons": null
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- id string Face database ID
- color string Color of the face database
- colorName string Name of the color of the face database
- name string Face database name
- memo string Remarks
- createTime string Creation time
- updateTime string Update time
- facePersonCount object Ignore
- thumbIcons object Ignore

Notes

• Formore returned error codes, see the error code

description on the home page

4.17.5、Obtain staff in the face database

Brief description：

• Obtain personnel in the face database

Request URL：

• /admin/API/face/repository/{repositoryId}/person/{personId}
• X-Subject-Token: {token}

Request example

GET /admin/API/face/repository/2/person/1 HTTP/1.1

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "1",
"name": "test_1",
"personId": "112233445566",
"gender": "1",
"birthday": "2019-02-25",
"nationality": "51",
"imageUrl": "http://10.35.92.19:80/upload\\face\\person\\2\\l
ibrary_e320c5b7a3e141b598640ca9007eb5b2.jpg",
"personTypeId": "1",
"personTypeName": "wanted",
"memo": "meno_test",
"repositoryId": "2",
"repositoryName": "face_test",
"createTime": "1551062569",
"updateTime": "1551062569",
"similarity": null
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- id string Face ID
- name string personnel name
- personId string personnel ID
- gender string Gender
- birthday string Date of birth
- nationality string Nationality
- imageUrl string Path for personnel images
- personTypeId string personnel type ID
- personTypeName string personnel type name
- memo string Remarks
- repositoryId string Face database ID
- repositoryName string personnel database name
- createTime string Creation time
- updateTime string Update time
- similarity object Similarity, not used for now

Notes

• For more returned error codes, see the error code

description on the home page

4.17.6、Obtain the status of all the channels deployed in the face database

Brief description：

• Obtain the status of all the channels deployed in the face

database

Request URL：

• /admin/API/face/application/repository/{repositoryId}
• X-Subject-Token: {token}
Request example

GET /admin/API/face/application/repository/3 HTTP/1.1

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": [
{
"channelId": "1000177$1$0$1",
"name": "3L056E8AAG00018",
"similarity": "10",
"stat": "1",
"node": "{\"isUnderRegion\":0,\"channelType\":1,\"belonge
dDeviceCategory\":1,\"deviceType\":14,\"videoServerCode\":\"video#loc
al\",\"cameraType\":1,\"cameraFunctions\":0,\"pcFlag\":0,\"faceFuncti
ons\":2,\"id\":\"1000177$1$0$1\",\"name\":\"3L056E8AAG00018\",\"icon\
":\"/admin/include/img/tree/rifle_channel.png\",\"pId\":\"1000177\",\
"type\":\"000101\",\"isParent\":\"false\",\"checked\":false,\"halfChe
ck\":false,\"pPid\":\"001\",\"sort\":3097,\"mapConfiged\":false,\"onl
ine\":0}"
}
]
}

Description of return parameters

Parameter
Type Description
Name
code number Error code
desc string Result description
data object None
- channelId string Channel ID
- name string Channel name
- similarity string Similarity
Arming status: 0-arming unsuccessfully; 1-arming
- stat string
successfully
- node string Parameter, not used for now

Notes

• For more returned error codes, see the error code

description on the home page

4.17.7、Search by picture in the face database

Brief description：

• Search by picture in the face database

Request URL：

• /admin/API/face/detection/repository/picture?token={token}

Request example

POST /admin/API/face/detection/repository/picture?token=457cb8a2da604
6c4afafb7d7a4ac4075 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Face.GetRepositoryPicture",
"data": {
"optional": "/admin/API/face/detection/repository/picture?tok
en=457cb8a2da6046c4afafb7d7a4ac4075",
"page": 1,
"pageSize": 20,
"repositoryId": "11",
"similarity": "80",
"imageData": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBD...06KKKxA//Z"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- page number Page number, from 1
- pageSize number number of records on each page
- repositoryId string Face database ID
- similarity string Similarity
- imageData string Image data, not null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": 1,
"pageData": [
{
"id": "16",
"name": "lll",
"personId": "9999",
"gender": "1",
"birthday": null,
"nationality": "",
"imageUrl": "http://172.22.151.183:80/upload\\face\\p
erson\\11\\library_021ad145306b44169eb9bd7345b3a591.jpg",
"personTypeId": "1",
"personTypeName": "test",
"memo": "",
"repositoryId": "11",
"repositoryName": "kkk",
"createTime": "1548679428",
"updateTime": "1548679428",
"similarity": "99"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- total number Total count
- pageData object None
- - id string Face ID
- - name string personnel name
- - personId string personnel ID
- - gender string Gender: 1-male; 2-female
- - birthday string Date of birth, format: yyyy-MM-dd
- - nationality string Nationality
- - imageUrl string Path for personnel images
- - personTypeId string personnel type ID
- - personTypeName string personnel type name
- - memo string Remarks
- - repositoryId string Face database ID
- - repositoryName string Face database name
- - createTime string Creation time (s)
- - updateTime string Update time (s)
- - similarity string Similarity

Notes

• For more returned error codes, see the error code

description on the home page
4.17.8、Search features in the face database

Brief description：

• Search features in the face database

Request URL：

• /admin/API/face/detection/repository/feature?token={token}

Request example

POST /admin/API/face/detection/repository/feature?token=457cb8a2da604
6c4afafb7d7a4ac4075 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Face.GetRepositoryFeatures",
"data": {
"optional": "/admin/API/face/detection/repository/feature?tok
en=457cb8a2da6046c4afafb7d7a4ac4075",
"page": 1,
"pageSize": 20,
"repositoryId": "11",
"beginAge": "",
"endAge": "",
"gender": "1",
"personTypeIds": [
"1",
"2"
],
"personName": "lll",
"personId": "9999"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- page string Page number, from 1
- pageSize string number of records on each page
- repositoryId string Face database ID
- beginAge string Start age
- endAge string End age
- gender string Gender: 1-male; 2-female
- personTypeIds object Face type ID
- personName string personnel name
- personId string personnel ID

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": 1,
"pageData": [
{
"id": "16",
"name": "lll",
"personId": "9999",
"gender": "1",
"birthday": "",
"nationality": "",
"imageUrl": "http://172.22.151.183:80/upload\\face\\p
erson\\11\\library_021ad145306b44169eb9bd7345b3a591.jpg",
"personTypeId": "1",
"personTypeName": "test",
"memo": "",
"repositoryId": "11",
"repositoryName": "kkk",
"createTime": "1548679428",
"updateTime": "1548679428",
"similarity": null
}
]
}
}

Description of return parameters

Parameter Name Type Description

Notes

• For more returned error codes, see the error code

description on the home page

4.17.9、Search by picture in face snapshot records

Brief description：

• Search by picture in face snapshot records

Request URL：

• /admin/API/face/detection/record/picture?token={token}

Request example

POST /admin/API/face/detection/record/picture?token=457cb8a2da6046c4a
fafb7d7a4ac4075 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Face.GetRecordPicture",
"data": {
"optional": "/admin/API/face/detection/record/picture?token=4
57cb8a2da6046c4afafb7d7a4ac4075",
"page": 1,
"pageSize": 20,
"similarity": "80",
"imageData": "/9j/4AAQSkZ...DiiipYj//2Q==",
"beginTime": "1550678400",
"endTime": "1550764799",
"orderType": "1",
"direction": "0",
"channelIds": [
"1000095$1$0$4"
]
}
}

Parameters：

Parameter Name Type Description

Parameter Name Type Description
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- page string Page number, from 1
- pageSize string number of records on each page
- similarity string Similarity
- imageData string Image data
- beginTime string Start time (s)
- endTime string End time (s)
- orderType string Sorting type
- direction string Order: 0-ascending; 1-descending
- channelIds object Channel ID

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": 1,
"pageData": [
{
"id": null,
"code": null,
"channelId": "1000095$1$0$4",
"channelName": "IPC",
"faceImageUrl": "https://172.22.151.183:443/upload/pi
cture/plugin/20190221/01/28/772b4160-0c26-4ec2-9998-d615fbfd177e.jpg
",
"pictureUrl": "",
"age": "32",
"gender": "1",
"fringe": null,
"eye": null,
"mouth": null,
"mask": null,
"beard": null,
"glasses": null,
"emotion": "6",
"beginTime": "1550738724",
"similarity": "96",
"mapId": "1546504033279",
"mapX": "-141.49573241061",
"mapY": "-200.10317185698"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code number Error code
desc string Result description
data object None
- total number Total count
- pageData object None
- - id object Face snapshot record ID, not used for now
- - code string Unique ID of a snapshot record, not used for now
- - channelId string Channel No.
--
string Channel name
channelName
--
string Face image
faceImageUrl
- - pictureUrl string Scene picture
- - age string Age
- - gender string Gender: 1-male; 2-female
- - fringe string Fringe: 0-none; 1-yes; not used for now
1-unrecognized; 2-eyes closed; 3-eyes open; not used
- - eye string
for now
1-unrecognized; 2-mouth closed; 3-mouth open; not
- - mouth string
used for now
1-unrecognized; 2-no mask; 3-wearing mask; not
- - mask string
used for now
1-unrecognized; 2-no beard; 3-bearded; not used for
- - beard string
now
Glasses: 0-none; 1-glasses; 2-sunglasses; not used
- - glasses string
for now
Expression: 0-smiling; 1-angry; 2-sad; 3-disgusted; 4-
- - emotion string fearful; 5-surprised; 6-normal; 7-laughing; 8-happy;
9-confused; 10-screaming
Parameter
Type Description
Name
- - beginTime string Start time (s)
- - similarity string Similarity
- - mapId string Map ID
- - mapX string Longitude
- - mapY string Latitude

Notes

• For more returned error codes, see the error code

description on the home page

4.17.10、Search features in face snapshot records

Brief description：

• Search features in face snapshot records

Request URL：

• /admin/API/face/detection/record/feature?token={token}

Request example

POST /admin/API/face/detection/record/feature?token=457cb8a2da6046c4a
fafb7d7a4ac4075 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Face.GetRecordFeatures",
"data": {
"optional": "/admin/API/face/detection/record/feature?token=4
57cb8a2da6046c4afafb7d7a4ac4075",
"page": 1,
"pageSize": 20,
"beginTime": "1550678400",
"endTime": "1550764799",
"beginAge": "20",
"endAge": "29",
"gender": "0",
"glasses": "1",
"emotion": "1",
"orderType": "1",
"direction": "0",
"channelIds": [
"1000095$1$0$4"
]
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- page string Page number, from 1
- pageSize string number of records on each page
- beginTime string Start time (s)
- endTime string End time (s)
- beginAge string Start age
- endAge string End age
- gender string Gender: 1-male; 2-female
- glasses string Glasses: 0-none; 1-glasses; 2-sunglasses
Expression: 0-smiling; 1-angry; 2-sad; 3-disgusted; 4-
- emotion string fearful; 5-surprised; 6-normal; 7-laughing; 8-happy; 9-
confused; 10-screaming
- orderType string Sorting type
- direction string Order: 0-ascending; 1-descending
- channelIds object Channel ID
Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": 389771,
"code": "27f767f1f7844fef8c61c01e1a694407",
"channelId": "1000095$1$0$4",
"channelName": "IPC",
"faceImageUrl": "https://172.22.151.183:443/upload/pi
cture/recognition/20190221/01/28/51fdc76b-b999-4f18-81a9-9342e9132de
0.jpg",
"pictureUrl": "https://172.22.151.183:443/upload/pict
ure/recognition/20190221/01/28/dba5cd12-0ec2-47eb-a09d-53d35b2a3149.j
pg",
"age": "32",
"gender": "1",
"fringe": "0",
"eye": "3",
"mouth": "3",
"mask": "2",
"beard": "2",
"glasses": "1",
"emotion": "8",
"beginTime": "1550741292",
"similarity": null,
"mapId": "1546504033279",
"mapX": "-141.49573241061",
"mapY": "-200.10317185698"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code number Error code
desc string Result description
data object None
- pageData object None
Parameter
Type Description
Name
- - id number Face snapshot record ID
- - code string Unique ID of a snapshot record
- - channelId string Channel No.
--
string Channel name
channelName
--
string Face image
faceImageUrl
- - pictureUrl string Scene picture
- - age string Age
- - gender string Gender: 1-male; 2-female
- - fringe string Fringe: 0-none; 1-yes
- - eye string 1-unrecognized; 2-eyes closed; 3-eyes open
- - mouth string 1-unrecognized; 2-mouth closed; 3-mouth open
- - mask string 1-unrecognized; 2-no mask; 3-wearing mask
- - beard string 1-unrecognized; 2-no beard; 3-bearded
- - glasses string Glasses: 0-none; 1-glasses; 2-sunglasses
Expression: 0-smiling; 1-angry; 2-sad; 3-disgusted; 4-
- - emotion string fearful; 5-surprised; 6-normal; 7-laughing; 8-happy;
9-confused; 10-screaming
- - beginTime string Start time (s)
- - similarity object Similarity, not used for now
- - mapId string Map ID
- - mapX string Longitude on the map
- - mapY string Latitude on the map

Notes

• Formore returned error codes, see the error code

description on the home page

4.17.11、Search face recognition records

Brief description：

• Search face recognition records

Request URL：

• /admin/API/face/recognitions?page={page}&pageSize={pageSiz
e}&similarity={similarity}&personName={personName}&gende
r={gender}&personId={personId}&personTypeIds={personType
Ids}&channelIds={channelIds}&beginTime={beginTime}&endTi
me={endTime}&beginAge={beginAge}&endAge={endAge}
• X-Subject-Token: {token}

Request example

GET /admin/API/face/recognitions?page=1&pageSize=20&similarity=36&per
sonName=lll&gender=&personId=9999&personTypeIds=1&channelIds=1000260
$1$0$1&beginTime=1551024000&endTime=1551110399&beginAge=&endAge= HTTP
/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter Name Type Description
page string Page
pageSize string Number of pages
similarity string Similarity
personName string personnel name
gender string Gender: 1-male; 2-female
personId string personnel ID
personTypeIds string personnel type ID
channelIds string Channel No., separated by commas
beginTime string Start time (s)
endTime string End time (s)
beginAge string Start age
endAge string End age
token string The token obtained when logging in

Request method：

• POST

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": 31661,
"code": "79f61e50a300482f99f44672055f6035",
"channelId": "1000260$1$0$1",
"channelName": "2",
"detectionImageUrl": "https://172.22.151.183:443/uplo
ad/picture/recognition/20190224/22/29/721b3873-b570-469e-a71e-b895291
030ec.jpg",
"repositoryImageUrl": "https://172.22.151.183:443/upl
oad/picture/recognition/20190224/22/29/73ed5674-b4ed-423b-b608-6b8431
ef9496.jpg",
"pictureUrl": "https://172.22.151.183:443/upload/pict
ure/recognition/20190224/22/29/1da74672-62fa-4da0-87ae-7a25af800cdd.j
pg",
"personName": "lll",
"personTypeId": "1",
"personTypeName": "fftest",
"personId": "9999",
"repositoryId": "11",
"repositoryName": "kkk",
"repositoryColor": "1",
"recognitionGender": "1",
"birthday": "",
"nationality": "",
"memo": "",
"beginTime": "1551076219",
"similarity": "36",
"age": "35",
"detectionGender": "1",
"fringe": "0",
"eye": "0",
"mouth": "0",
"mask": "2",
"beard": "2",
"glasses": "1",
"emotion": "6",
"mapId": "",
"mapX": "",
"mapY": ""
}
]
}
}
Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- pageData object None
- - id number Record ID
- - code string Record ID
- - channelId string Channel No.
- - channelName string Channel name
--
string Face image in face records
detectionImageUrl
--
string Face image in the face database
repositoryImageUrl
- - pictureUrl string Face record scene picture
- - personId string personnel ID
- - repositoryId string Face database ID
- - repositoryName string Face database name
- - repositoryColor string Color of the face database
--
string Gender: 1-male; 2-female
recognitionGender
- - birthday string Date of birth, format: yyyy-MM-dd
- - nationality string Nationality
- - memo string Remarks
- - personName string personnel name
- - personTypeId string personnel type ID
--
string personnel type name
personTypeName
- - similarity string Similarity
- - beginTime string Start time (s)
Expression: 0-smiling; 1-angry; 2-sad; 3-
- - emotion string disgusted; 4-fearful; 5-surprised; 6-normal; 7-
laughing; 8-happy; 9-confused; 10-screaming
- - age string Age
- - detectionGender string Gender: 1-male; 2-female
- - fringe string Fringe: 0-none; 1-yes
- - eye string 1-unrecognized; 2-eyes closed; 3-eyes open
- - mouth string 1-unrecognized; 2-mouth closed; 3-mouth open
- - mask string 1-unrecognized; 2-no mask; 3-wearing mask
- - beard string 1-unrecognized; 2-no beard; 3-bearded
- - glasses string Glasses: 0-none; 1-glasses; 2-sunglasses
- - mapId string Map ID
Parameter Name Type Description
- - mapX string X coordinate on the map
- - mapY string Y coordinate on the map

Notes

• For more returned error codes, see the error code

description on the home page

4.17.12、Search face record list (by day)

Brief description：

• Search face record list (by day)

Request URL：

• /admin/API/face/report/day/list?time={time}&pageSize={page
Size}&page={page}&order={order}&channelIds={channelIds}
• X-Subject-Token: {token}

Request example

GET /admin/API/face/report/day/list?time=1551024000&pageSize=20&page=
1&order=0&channelIds=1000260$1$0$0,1000260$1$0$1 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter
Type Description
Name
time string Search date (s)
pageSize string number of records on each page
page string Page
Sorting: 0-ascending; 1-descending, descending by
order string
default
channelIds string Channel No., separated by commas
token string The token obtained when logging in

Request method：

• GET

Request example

Null
Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"time": "1551079894",
"channelName": "2",
"gender": "1",
"age": "34"
},
{
"time": "1551079647",
"channelName": "c16",
"gender": "2",
"age": "32"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code number Error code
desc string Result description
data object None
- pageData object None
- - time string Recording time (s)
- - channelName string Channel name
- - gender string Gender: 1-male; 2-female
- - age string Age

Notes

• Formore returned error codes, see the error code

description on the home page

4.17.13、Search face record list (by week)

Brief description：

• Search face record list (by week)

Request URL：

• /admin/API/face/report/week/list?pageSize={pageSize}&page=
{page}&startTime={startTime}&endTime={endTime}&order={or
der}&channelIds={channelIds}
• X-Subject-Token: {token}

Request example

GET /admin/API/face/report/week/list?pageSize=20&page=1&startTime=155
0937600&endTime=1551456000&order=1&channelIds=1000260$1$0$0,1000260$1
$0$1 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter
Type Description
Name
pageSize string number of records on each page
page string Page
startTime string Search start time (s)
endTime string Search end time (s)
Sorting: 0-ascending; 1-descending, descending by
order string
default
channelIds string Channel IDs, separated by commas
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"time": "1551144861",
"channelName": "2",
"gender": "1",
"age": "28"
},
{
"time": "1551144052",
"channelName": "2",
"gender": "2",
"age": "28"
}
]
}
}

Description of return parameters

Parameter Name Type Description

Notes

• For more returned error codes, see the error code

description on the home page

4.17.14、Search face record list (by month)

Brief description：

• Search face record list (by month)

Request URL：

• /admin/API/face/report/month/list?time={time}&pageSize={pa
geSize}&page={page}&order={order}&channelIds={channelIds}
• X-Subject-Token: {token}

Request example

GET /admin/API/face/report/month/list?time=2019-02&pageSize=20&page=1
&order=1&channelIds=1000260$1$0$0,1000260$1$0$1 HTTP/1.1
Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075
Parameter
Type Description
Name
time string Search time, format: yyyy-MM
pageSize string number of records on each page
page string Page
Sorting: 0-ascending; 1-descending, descending by
order string
default
channelIds string Channel No., separated by commas
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"time": "1551145956",
"channelName": "2",
"gender": "2",
"age": "37"
},
{
"time": "1551145425",
"channelName": "c16",
"gender": "1",
"age": "30"
}
]
}
}

Description of return parameters

Parameter Name Type Description

Notes

• For more returned error codes, see the error code

description on the home page

4.18、Video Metadata

4.18.1、Obtain human bodies snapshot records in object detection by pages

Brief description：

• Obtain the records of snapping human bodies in object

detection by pages (in reverse order of snapping time)

Request URL：

• /admin/API/BRM/VideoAnalyse/Human/list?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/Human/list?token=3caf4abd6e584013973
602345c565072 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Human.GetHumans",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/Human/list?token=3ca
f4abd6e584013973602345c565072",
"locale": "en",
"pageInfo": {
"pageSize": "20",
"pageNo": "1"
},
"searchInfo": {
"hat": "",
"trousers": "",
"startTime": "1542643200",
"endTime": "1542729599",
"gender": "",
"coat": "",
"bag": "",
"trousersColor": [],
"coatColor": [],
"channelIds": [
"1000007$1$0$0"
]
}
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
Parameter
Type Description
Name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- locale string Language, such as zh and en
- pageInfo object Pagination Information
- - pageSize string Number of pages
- - pageNo string Page number (from 1)
- searchInfo object Search condition
- - hat string Hat, null for all, 1 - no; 2 - yes
- - trousers string Bottoms, null for all, 1 - pants; 2 - shorts; 3 - skirts
- - startTime string Start time (s)
- - endTime string End time (s)
- - gender string Gender, null for all, 1 - male; 2 - female
- - coat string Tops, null for all, 1 - long-sleeve; 2 - short-sleeve
- - bag string Bag, null for all, 1 - no; 2 - yes
Bottoms color, null for all, 1 - white; 2 - orange; 3 -
--
object pink; 4 - black; 5 - red; 6 - yellow; 7 - gray; 8 - blue; 9
trousersColor
- green; 10 - purple; 11 - brown
Tops color, null for all, 1 - white; 2 - orange; 3 - pink; 4
- - coatColor object - black; 5 - red; 6 - yellow; 7 - gray; 8 - blue; 9 - green;
10 - purple; 11 - brown
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "1",
"channelId": "1000007$1$0$0",
"humanImageUrl": "https://10.35.92.19:443/upload/pict
ure/body/20181120/00/38/2566341d-5e44-4324-8b7a-05af69975f0c.jpg",
"pictureUrl": "https://10.35.92.19:443/upload/picture
/scenebody/20181120/00/38/40310e75-94f1-4ef1-9569-fda4448d3702.jpg",
"faceImageUrl": "https://10.35.92.19:443/upload/pictu
re/",
"gender": "0",
"hat": "1",
"coat": "2",
"coatColor": "4",
"coatColorName": "Black",
"bag": "1",
"trousers": "1",
"trousersColor": "4",
"trousersColorName": "Black",
"emotion": "",
"beard": "0",
"glasses": "",
"mask": "0",
"age": "0",
"captureTime": "1542703127",
"faceImageTop": "",
"faceImageLeft": "",
"faceImageBottom": "",
"faceImageRight": "",
"humanImageTop": "824",
"humanImageLeft": "4032",
"humanImageBottom": "1832",
"humanImageRight": "4272"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- pageData object Human body information
- - id string Record ID
- - channelId string Channel No.
- - humanImageUrl string Human body image
- - pictureUrl string Scene picture
- - faceImageUrl string Face image
- - gender string Gender: 0 - unrecognized; 1 - male; 2 - female
- - hat string Hat: 0 - unknown; 1 - no; 2 - yes
- - coat string Tops: 0 - unknown; 1 - long-sleeve; 2 - short-
Parameter Name Type Description
sleeve
Tops color: 0 - unknown; 1 - white; 2 - orange; 3
- - coatColor string - pink; 4 - black; 5 - red; 6 - yellow; 7 - gray; 8 -
blue; 9 - green; 10 - purple; 11 - brown
- - coatColorName string Tops color name
- - bag string Bag: 0 - unknown; 1 - no; 2 - yes
Bottoms: 0 - unknown; 1 - pants; 2 - shorts; 3 -
- - trousers string
skirts
Bottoms color: 0 - unknown; 1 - white; 2 -
- - trousersColor string orange; 3 - pink; 4 - black; 5 - red; 6 - yellow; 7 -
gray; 8 - blue; 9 - green; 10 - purple; 11 - brown
--
string Bottoms color name
trousersColorName
Expression: 0—smiling; 1—angry; 2—sad; 3—
disgusted; 4—fearful; 5—surprised; 6—normal;
- - emotion string
7—laughing; 8—happy; 9—confused; 10—
screaming
Beard: 0 - unknown; 1 - unrecognized; 2 - no; 3 -
- - beard string
yes
- - glasses string Glasses: 0—none; 1—glasses; 2—sunglasses
Mask: 0 - unknown; 1 - unrecognized; 2 - no; 3 -
- - mask string
yes
- - age string Age
- - captureTime string Snapshot time (s)
- - faceImageTop string Position of the face in the image: Top
- - faceImageLeft string Position of the face in the image: Left
- - faceImageBottom string Position of the face in the image: Bottom
- - faceImageRight string Position of the face in the image: Right
- - humanImageTop string Position of the human body in the image: Top
- - humanImageLeft string Position of the human body in the image: Left
--
string Position of the human body in the image: Bottom
humanImageBottom
--
string Position of the human body in the image: Right
humanImageRight

Notes

• For more returned error codes, see the error code

description on the home page

4.18.2、Obtain the statistics of human bodies snapshot records in object

detection

Brief description：
• Collectthe total number of records of snapping human
bodies in object detection

Request URL：

• /admin/API/BRM/VideoAnalyse/Human/count?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/Human/count?token=3caf4abd6e58401397
3602345c565072 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Human.GetHumansCount",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/Human/count?token=3c
af4abd6e584013973602345c565072",
"searchInfo": {
"hat": "",
"trousers": "",
"startTime": "1542643200",
"endTime": "1542729599",
"gender": "",
"coat": "",
"bag": "",
"trousersColor": [],
"coatColor": [],
"channelIds": [
"1000007$1$0$0"
]
}
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- searchInfo object Search condition
- - hat string Hat, null for all, 1 - no; 2 - yes
- - trousers string Bottoms, null for all, 1 - pants; 2 - shorts; 3 - skirts
- - startTime string Start time (s)
- - endTime string End time (s)
- - gender string Gender, null for all, 1 - male; 2 - female
- - coat string Tops, null for all, 1 - long-sleeve; 2 - short-sleeve
- - bag string Bag, null for all, 1 - no; 2 - yes
Bottoms color, null for all, 1 - white; 2 - orange; 3 -
--
object pink; 4 - black; 5 - red; 6 - yellow; 7 - gray; 8 - blue; 9
trousersColor
- green; 10 - purple; 11 - brown
Tops color, null for all, 1 - white; 2 - orange; 3 - pink; 4
- - coatColor object - black; 5 - red; 6 - yellow; 7 - gray; 8 - blue; 9 - green;
10 - purple; 11 - brown
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": "3"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
Parameter Name Type Description
desc string Result description
data object None
- total string Total count

Notes

• For more returned error codes, see the error code

description on the home page

4.18.3、Export human bodies snapshot records in object detection

Brief description：

• Export the records of snapping human bodies in object

detection (in reverse order of snapping time). For the
export path, see: Export path notification

Request URL：

• /admin/API/BRM/VideoAnalyse/Human/export?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/Human/export?token=3caf4abd6e5840139
73602345c565072 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Human.GetHumansCount",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/Human/count?token=3c
af4abd6e584013973602345c565072",
"locale": "zh",
"session": "93",
"searchInfo": {
"hat": "",
"trousers": "",
"startTime": "1542643200",
"endTime": "1542729599",
"gender": "",
"coat": "",
"bag": "",
"ids": [],
"trousersColor": [],
"coatColor": [],
"channelIds": [
"1000007$1$0$0"
]
}
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- locale string Language, such as zh and en
Session ID, used for asynchronously notifying the
- session string
export file path
- searchInfo object Search condition
- - hat string Hat, null for all, 1 - no; 2 - yes
- - trousers string Bottoms, null for all, 1 - pants; 2 - shorts; 3 - skirts
- - startTime string Start time (s)
- - endTime string End time (s)
- - gender string Gender, null for all, 1 - male; 2 - female
- - coat string Tops, null for all, 1 - long-sleeve; 2 - short-sleeve
- - bag string Bag, null for all, 1 - no; 2 - yes
- - ids string Snapshot ID. Other conditions are invalid if an ID exists.
Parameter
Type Description
Name
Bottoms color, null for all, 1 - white; 2 - orange; 3 -
--
object pink; 4 - black; 5 - red; 6 - yellow; 7 - gray; 8 - blue; 9
trousersColor
- green; 10 - purple; 11 - brown
Tops color, null for all, 1 - white; 2 - orange; 3 - pink; 4
- - coatColor object - black; 5 - red; 6 - yellow; 7 - gray; 8 - blue; 9 - green;
10 - purple; 11 - brown
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.18.4、Obtain motor vehicles snapshot records in object detection by pages

Brief description：

• Obtain the records of snapping motor vehicles in object

detection by pages (in reverse order of snapping time)

Request URL：

• /admin/API/BRM/VideoAnalyse/Vehicle/list?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/Vehicle/list?token=3caf4abd6e5840139
73602345c565072 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Vehicle.GetVehicles",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/Vehicle/list?token=3
caf4abd6e584013973602345c565072",
"locale": "en",
"pageInfo": {
"pageSize": "20",
"pageNo": "1"
},
"searchInfo": {
"startTime": "1542643200",
"endTime": "1542729599",
"plateColor": [],
"carBrand": [],
"carType": [],
"plate": [],
"carColor": [],
"channelIds": [
"1000007$1$0$0"
]
}
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
Parameter Name Type Description
method string Method name
data object None
- optional string URI information
- locale string Language, such as zh and en
- pageInfo object Pagination Information
- - pageSize string Number of pages
- - pageNo string Page number (from 1)
- searchInfo object Search condition
- - startTime string Start time (s)
- - endTime string End time (s)
- - plateColor object License plate color, dictionary type=22
- - carBrand object Vehicle trademark, dictionary type=2016
- - carType object Vehicle type, dictionary type=2002
- - plate object Plate number
- - carColor object Vehicle color, dictionary type=2001
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"vehicles": [
{
"id": "18",
"channelId": "1000007$1$0$0",
"pictureUrl": "https://10.35.92.19:443/upload/picture
/scenecar/20181120/00/38/128a1339-7a72-4152-8ebd-2c221e765071.jpg",
"plateImageUrl": "https://10.35.92.19:443/upload/pict
ure/vehicle/20181120/00/38/e1e3ba1d-5eb2-4fd3-a35a-18a12cdd1288.jpg",
"plate": "zAQ763J",
"carType": "22",
"carTypeName": "Carriage",
"carColor": "1",
"carColorName": "Black",
"plateColor": "0",
"plateColorName": "Blue",
"carBrand": "58",
"carBrandName": "DongNan",
"captureTime": "1542703129",
"carImageTop": "4352",
"carImageLeft": "6040",
"carImageBottom": "6424",
"carImageRight": "7640"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- pageData object None
- - id string Snapshot record ID
- - channelId string Channel No.
- - pictureUrl string Vehicle picture
- - plateImageUrl string License plate picture
- - plate string Plate number
- - carType string Vehicle type, dictionary type=2002
- - carTypeName string Vehicle type name
- - carColor string Vehicle color, dictionary type=2001
- - carColorName string Vehicle color name
- - plateColor string License plate color, dictionary type=22
- - plateColorName string License plate color name
- - carBrand string Vehicle trademark, dictionary type=2016
- - carBrandName string Vehicle trademark name
- - captureTime string Snapshot time (s)
- - carImageTop string Position of the vehicle in the image: Top
- - carImageLeft string Position of the vehicle in the image: Left
- - carImageBottom string Position of the vehicle in the image: Bottom
- - carImageRight string Position of the vehicle in the image: Right

Notes

• For more returned error codes, see the error code

description on the home page

4.18.5、Collect the statistics of motor vehicles snapshot records in object

detection

Brief description：
• Collectthe total number of records of snapping motor
vehicles in object detection

Request URL：

• /admin/API/BRM/VideoAnalyse/Vehicle/count?token={token}}

Request example

POST /admin/API/BRM/VideoAnalyse/Vehicle/count?token=3caf4abd6e584013
973602345c565072 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Vehicle.GetVehicleCount",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/Vehicle/count?token=
3caf4abd6e584013973602345c565072",
"searchInfo": {
"startTime": "1542703120",
"endTime": "1542729599",
"plateColor": [],
"carBrand": [],
"carType": [],
"plate": [],
"carColor": [],
"channelIds": [
"1000007$1$0$0",
"1000008$1$0$0"
]
}
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- searchInfo object Search condition
- - startTime string Start time (s)
- - endTime string End time (s)
- - plateColor object License plate color, dictionary type=22
- - carBrand object Vehicle trademark, dictionary type=2016
- - carType object Vehicle type, dictionary type=2002
- - plate object Plate number
- - carColor object Vehicle color, dictionary type=2001
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": "4"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- total string Total count

Notes

• For more returned error codes, see the error code

description on the home page
4.18.6、Export snapping motor vehicles snapshot records in object detection

Brief description：

• Exportthe records of snapping motor vehicles in object

detection (in reverse order of snapping time). For the
export path, see: Export path notification

Request URL：

• /admin/API/BRM/VideoAnalyse/Vehicle/export?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/Vehicle/export?token=3caf4abd6e58401
3973602345c565072 HTTP/1.1
Host: 10.35.92.19
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Vehicle.ExportVehicles",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/Vehicle/export?token
=3caf4abd6e584013973602345c565072",
"locale": "en",
"session": "126",
"searchInfo": {
"startTime": "1542703120",
"endTime": "1542729599",
"ids": [],
"plateColor": [],
"carColor": [],
"plate": [],
"carType": [],
"carBrand": [],
"channelIds": [
"1000007$1$0$0",
"1000008$1$0$0"
]
}
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- locale string Language, such as zh and en
Session ID, used for asynchronously notifying the
- session string
export file path
- searchInfo object Search information
- - startTime string Start time (s)
- - endTime string End time (s)
Snapshot ID. Other conditions are invalid if an ID
- - ids object
exists.
- - plateColor object License plate color, dictionary type=22
- - carColor object Vehicle color, dictionary type=2001
- - plate object Plate number
- - carType object Vehicle type, dictionary type=2002
- - carBrand object Vehicle trademark, dictionary type=2016
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description
code int Error code
desc string Result description

Notes

• For more returned error codes, see the error code

description on the home page

4.18.7、Obtain non-motor vehicles snapshot records in object detection by

pages

Brief description：

• Obtain the records of snapping non-motor vehicles in

object detection by pages (in reverse order of snapping
time)

Request URL：

• /admin/API/BRM/VideoAnalyse/NonVehicle/list?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/NonVehicle/list?token=03e03f8e17fa42
079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.NonVehicle.GetNonVehicles",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/NonVehicle/list?toke
n=03e03f8e17fa42079dc556fb72221ea7",
"locale": "en",
"pageInfo": {
"pageSize": "20",
"pageNo": "1"
},
"searchInfo": {
"startTime": "1542770357",
"endTime": "1542770383",
"riderNum": "",
"carType": [],
"carColor": [],
"channelIds": [
"1000001$1$0$0"
]
}
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- locale string Language, such as zh and en
- pageInfo object Page number
- - pageSize string Number of pages
- - pageNo string Page number (from 1)
- searchInfo object Search condition
- - startTime string Start time (s)
- - endTime string End time (s)
- - riderNum string Number of riders
- - carType object Vehicle type, dictionary type=2002
- - carColor object Vehicle color, dictionary type=2001
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "491",
"channelId": "1000001$1$0$0",
"pictureUrl": "https://10.35.93.16:443/upload/picture
/scenenomotor/20181121/11/19/61871883-2945-4c93-aca6-dbae145e2aa0.jpg
",
"carImageUrl": "https://10.35.93.16:443/upload/pictur
e/nomotor/20181121/11/19/8ae98e7c-7064-41ab-b405-2b776cb01615.jpg",
"carType": "2",
"carTypeName": "Two-wheeler",
"carColor": "1",
"carColorName": "White",
"riderNum": "1",
"captureTime": "1542770383",
"carImageTop": "3555",
"carImageLeft": "2967",
"carImageBottom": "6232",
"carImageRight": "3479",
"faceInfos": [
{
"faceOrder": "0",
"faceUrl": "https://10.35.93.16:443/upload/pi
cture/face/20181121/11/19/2b2548b7-93ae-4f5b-815b-775ad3338753.jpg",
"sex": "1",
"complexion": "1",
"mask": "2",
"glass": "1",
"mouth": "2",
"emotion": "2"
}
]
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
Parameter
Type Description
Name
desc string Result description
data object None
- pageData object None
- - id string Snapshot record ID
- - channelId string Channel No.
- - pictureUrl string Vehicle picture
- - carImageUrl string Vehicle cutout
- - carType string Vehicle type, dictionary type=2002
- - carTypeName string Vehicle type name
- - carColor string Vehicle color, dictionary type=2001
- - carColorName string Vehicle color name
- - riderNum string Number of riders
- - captureTime string Snapshot time (s)
- - carImageTop string Position of the vehicle in the image: Top
- - carImageLeft string Position of the vehicle in the image: Left
--
string Position of the vehicle in the image: Bottom
carImageBottom
--
string Position of the vehicle in the image: Right
carImageRight
- - faceInfos object Face information
- - - faceOrder string Sort
- - - faceUrl string Face image
- - - sex string Gender: 0—unknown; 1—male; 2—female
Skin color: 0 - unrecognized; 1 - yellow; 2 - black; 3 -
- - - complexion string
white
- - - mask string Whether masked: 0 - unrecognized; 1 - no; 2 - yes
Whether with glasses: 0 - unknown; 1 - no glasses; 2
- - - glass string - regular glasses; 3 - sunglasses: 4 - black-rim
eyeglasses
Mouth status: 0 - unknown; 1 - unrecognized; 2 -
- - - mouth string
closed; 3 - open
Expression: 0—smiling; 1—angry; 2—sad; 3—
- - - emotion string disgusted; 4—fearful; 5—surprised; 6—normal; 7—
laughing; 8—happy; 9—confused; 10—screaming

Notes

• For more returned error codes, see the error code

description on the home page

4.18.8、Collect the statistics of non-motor vehicles snapshot records in object

detection
Brief description：

• Collectthe total number of records of snapping non-motor

vehicles in object detection

Request URL：

• /admin/API/BRM/VideoAnalyse/NonVehicle/count?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/NonVehicle/count?token=03e03f8e17fa4
2079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.NonVehicle.GetNonVehiclesCount",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/NonVehicle/count?tok
en=03e03f8e17fa42079dc556fb72221ea7",
"searchInfo": {
"startTime": "1542770357",
"endTime": "1542770383",
"riderNum": "",
"carType": [],
"carColor": [],
"channelIds": [
"1000000$1$0$0",
"1000007$1$0$0"
]
}
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- searchInfo object Search condition
- - startTime string Start time (s)
- - endTime string End time (s)
- - riderNum string Number of riders
- - carType object Vehicle type, dictionary type=2002
- - carColor object Vehicle color, dictionary type=2001
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": "5"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- total string Total count

Notes

• For more returned error codes, see the error code

description on the home page

4.18.9、Export non-motor vehicles snapshot records in object detection

Brief description：

• Exportthe records of snapping non-motor vehicles in

object detection (in reverse order of snapping time).
For the export path, see: Export path notification

Request URL：

• /admin/API/BRM/VideoAnalyse/NonVehicle/export?token={token}

Request example

POST /admin/API/BRM/VideoAnalyse/NonVehicle/export?token=03e03f8e17fa
42079dc556fb72221ea7 HTTP/1.1
Host: 10.35.93.16
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.NonVehicle.ExportNonVehicles",
"data": {
"optional": "/admin/API/BRM/VideoAnalyse/NonVehicle/export?to
ken=03e03f8e17fa42079dc556fb72221ea7",
"locale": "zh",
"session": "199",
"searchInfo": {
"startTime": "1542770357",
"endTime": "1542770383",
"riderNum": "",
"carType": [],
"carColor": [],
"ids": [],
"channelIds": [
"1000000$1$0$0",
"1000007$1$0$0"
]
}
}
}

Parameters：

Parameter
Type Description
Name
clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information
- locale string Language, such as zh and en
Session ID, used for asynchronously notifying the
- session string
export file path
- searchInfo object Search condition
- - startTime string Start time (s)
- - endTime string End time (s)
- - riderNum string Number of riders
- - carType object Vehicle type, dictionary type=2002
- - carColor object Vehicle color, dictionary type=2001
Snapshot ID. Other conditions are invalid if an ID
- - ids object
exists.
- - channelIds object Channel No, cannot be null

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description

Notes
• Formore returned error codes, see the error code
description on the home page

4.19、Entrance

4.19.1、Obtain parking lot statistics

Brief description：

• Obtain parking lot statistics

Request URL：

• /IPMS/API/entrance/parking-
lot/status?parkingLotName={parkingLotName}
• X-Subject-Token: {token}

Request example:

GET /IPMS/API/entrance/parking-lot/status?parkingLotName= HTTP/1.1

Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 5fad3e259cbc497fa3e2ece67676469c
Parameter Name Type Description
parkingLotName string Parking lot name. If it is null, search all parking lots.
token string The token obtained when logging in

Request method：

• GET

Request example:

Null

Request parameters:

Null

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"results": [
{
"id": "2",
"parkingLotName": "intime",
"totalLots": "300",
"idleLots": "300",
"entrances": "1",
"exituses": "0",
"leds": "1"
}
]
}
}

Return parameters:

Parameter Name Type Description

code int Return code
desc string Result description
data object None
- results object None
- - id string Parking lot ID
- - parkingLotName string Parking lot name
- - totalLots string Total parking lots
- - idleLots string Remaining parking spaces
- - entrances string Number of entrance channels
- - exituses string Number of exit channels
- - leds string Number of LEDs

Notes

• For more returned error codes, see the error code

description on the home page

4.19.2、Search vehicle list

Brief description：

• Search the vehicle list

Request URL：

• /IPMS/API/entrance/car?companyName={companyName}&parkingLo
tId={parkingLotId}&ownerName={ownerName}&endTime={endTim
e}&carNo={carNo}&carGroup={carGroup}&carRight={carRight}
&local={local}&departmentId={departmentId}&startTime={st
artTime}&pageSize={pageSize}&pageNo={pageNo}
• X-Subject-Token: {token}

Request example:

GET /IPMS/API/entrance/car?companyName=&parkingLotId=-1&ownerName=&en
dTime=1867593599&carNo=&carGroup=-1&carRight=-1&local=zh&departmentId
=001&startTime=1551888000&pageSize=20&pageNo=1 HTTP/1.1
Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 5fad3e259cbc497fa3e2ece67676469c
Parameter
Type Description
Name
companyName string Company, fuzzy search supported
parkingLotId string Parking lot ID, -1 - all
ownerName string Vehicle owner name, fuzzy search supported
endTime string End time (s)
carNo string Plate number, fuzzy search supported
Group: -1-all groups; 1-no group; 3-ordinary vehicle;
carGroup string
4-VIP
Vehicle permission: -1-all; 1-restricted list; 2-white
carRight string
list
local string Language, such as zh and en
departmentId string Department ID
startTime string Start time (s)
Number of records per page, minimum: 1,
pageSize string
maximum: 256
pageNo string Search start page, minimum: 1
token string The token obtained when logging in

Request method：

• GET

Request example:

Null

Request parameters:

Null

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "3",
"effectiveStartTime": "1551941218",
"effectiveEndTime": "1867560418",
"carNo": "zA77777",
"personId": "19481000",
"ownerName": "test",
"companyName": "omua",
"departmentId": "001",
"departmentName": "root",
"carRight": "2",
"carColor": "5",
"carBrand": "1",
"memo": "vip car",
"carGroup": "4",
"rightStatus": "3",
"parkingLots": [
{
"parkingLotId": "3",
"parkingLotName": "intime"
}
],
"parkingLotIds": [
"3"
]
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- pageData object None
- - id string Vehicle ID
-- string Validity period start time (s)
Parameter Name Type Description
effectiveStartTime
--
string Validity period end time (s)
effectiveEndTime
- - carNo string Plate number
- - personId string personnel ID
- - ownerName string Owner name
- - companyName string Company name
- - departmentId string Department ID
--
string Department name
departmentName
- - carRight string Vehicle permission: 1-restricted list; 2-white list
- - carColor string Vehicle color
- - carBrand string Vehicle logo
- - memo string Remarks
Vehicle group: 1-no group; 3-ordinary vehicle; 4-
- - carGroup string
VIP
Authorization status: 1-authorizing; 2-authorized
- - rightStatus string
successfully; 3-authorized unsuccessfully
- - parkingLots object Parking lot information
- - - parkingLotId string Parking lot ID
---
string Parking lot name
parkingLotName
- - parkingLotIds object Parking lot ID list
- nextPage string Next page, -1 - no next page
- totalCount string Total number of records

Notes

• For more returned error codes, see the error code

description on the home page

4.19.3、Obtain vehicle information

Brief description：

• Obtain vehicle information. When a vehicle is associated

with a personnel, information about all the vehicles
associated with the personnel is returned.

Request URL：

• /IPMS/API/entrance/car/{id}
• X-Subject-Token: {token}
Request example:

GET /IPMS/API/entrance/car/1 HTTP/1.1

Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 5fad3e259cbc497fa3e2ece67676469c
Parameter Name Type Description
id string Vehicle ID
token string The token obtained when logging in

Request method：

• GET

Request example:

Null

Request parameters:

Null

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"cars": [
{
"id": "3",
"carNo": "zA77777",
"carColor": "5",
"carBrand": "1",
"effectiveStartTime": "1551941218",
"effectiveEndTime": "1867560418",
"carRight": "2",
"carGroup": "4",
"memo": "vip car",
"parkingLotIds": [
"3"
]
}
],
"person": {
"personId": "19481",
"firstName": "test",
"lastName": "test",
"carportAmount": "1",
"departmentId": "001",
"departmentName": "root",
"email": "",
"companyName": "muoa",
"gender": "1",
"tel": "18506831111",
"remark": ""
},
"entranceRight": [
"1000008"
]
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- cars object Vehicle information
- - id string Vehicle ID
- - carNo string Plate number
- - carColor string Vehicle color
- - carBrand string Vehicle logo
--
string Validity period start time (s)
effectiveStartTime
- - effectiveEndTime string Validity period end time (s)
Vehicle permission: 1-restricted list; 2-white list; 2
- - carRight string
by default
Group: 1-no group; 3-ordinary vehicle; 4-VIP; 1 by
- - carGroup string
default if not set
- - memo string Remarks
- - parkingLotIds object Parking lot ID
Information about the personnel associated with
- person object
the vehicle
- - personId string Personnel number
- - firstName string First name
- - lastName string Last name
Parameter Name Type Description
- - carportAmount string Number of parking vehicles allowed
- - departmentId string Department ID
--
string Department name
departmentName
- - email string Email
- - companyName string Company name
- - gender string Gender: 0-female; 1-male
- - tel string Contact number
- - remark string Personnel remarks
- entranceRight object Entrance/exit device code

Notes

• For more returned error codes, see the error code

description on the home page

4.19.4、Export vehicles list

Brief description：

• Export the vehicle list. The export file download path and
session are returned. For the progress of generating an
export file, see: Export file generation progress
notification

Request URL：

• /IPMS/API/entrance/car/export
• X-Subject-Token: {token}

Request example:

POST /IPMS/API/entrance/car/export HTTP/1.1

Request method：

• POST

Request example:
{
"ids": ["1","6","9"],
"customColumns": [
"1","2","3","4","5","6","7","8","9","10","11","12"
],
"companyName": "",
"parkingLotId": "-1",
"ownerName": "",
"endTime": "1867593599",
"carNo": "",
"carGroup": "-1",
"exportType": "",
"local": "zh",
"carRight": "-1",
"exportColumnType": "1",
"departmentId": "001",
"startTime": "1551888000"
}

Request parameters:

Parameter
Type Description
Name
Vehicle ID. If it is null, export all qualified data. If it
ids object is not null, export specified data. Other search
conditions are invalid.
customColumns object Custom column
companyName string Company, fuzzy search supported
parkingLotId string Parking lot ID, -1 - all
ownerName string Vehicle owner name, fuzzy search supported
endTime string End time (s)
carNo string plate number, fuzzy search supported
Group: -1-all groups; 1-no group; 3-ordinary
carGroup string
vehicle; 4-VIP
Type of the export file (not used for now), only .xlsx
exportType string
supported at present
local string Language, such as zh and en
Vehicle permission: -1-all; 1-restricted list; 2-white
carRight string
list
Mode of exporting columns: 0-all columns; 1-custom
exportColumnType string
column; 0 in view mode
departmentId string Department ID
startTime string Start time (s)
Notes:

customColumns: 1—plate number; 2—vehicle owner; 3—company; 4—depa

rtment; 5—vehicle permission; 6—vehicle color; 7—vehicle logo; 8—
group; 9—expiration date; 10—authorization status; 11—remarks; 12
—parking lot

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"session": "3d9b25c5c553469eabb92b0e35e82b08",
"fileUrl": "/upload/ipms/car/export/11551948224094.xlsx"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- session string Session ID
- fileUrl string File download URL

Notes

• For more returned error codes, see the error code

description on the home page

4.19.5、Obtain parking lots statistics

Brief description：

• Obtain the statistics of all parking lots

Request URL：

• /IPMS/API/entrance/parking-lot/status/total
• X-Subject-Token: {token}

Parameter Name Type Description

token string The token obtained when logging in

Request example:
GET /IPMS/API/entrance/parking-lot/status/total HTTP/1.1
Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 18d0369cad1d46c4b88402c1c2b05911

Request method：

• GET

Request example:

Null

Request parameters:

Null

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"idleLots": "180",
"idlePercent": "60.00%",
"parkingLots": "1",
"totalLots": "300"
}
}

Return parameters:

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- idleLots string Total remaining parking spaces
Percentage of total remaining parking spaces to total
- idlePercent string
parking lots
- parkingLots string Total number of parking lots
- totalLots string Total parking lots

Notes
• Formore returned error codes, see the error code
description on the home page

4.19.6、Search vehicles entering or exiting records

Brief description：

• Search the history of vehicle entering and exiting

Request URL：

• /IPMS/API/entrance/car/record/history
• X-Subject-Token: {token}

Parameter Name Type Description

token string The token obtained when logging in

Request example:

POST /IPMS/API/entrance/car/record/history HTTP/1.1

Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 18d0369cad1d46c4b88402c1c2b05911

Request method：

• POST

Request example:

{
"companyName": "",
"orderType": "0",
"startTime": "1551888000",
"exitChannelEmpty": "1",
"enterChannelEmpty": "1",
"ownerName": "",
"departmentId": "001",
"carNo": "ZA12A26",
"carColor": "-1",
"exitChannelIds": [
"1000024$1$0$1"
],
"endTime": "1551974399",
"direction": "1",
"local": "zh",
"carType": "-1",
"carBrand": "-2",
"enterChannelIds": [
"1000024$1$0$0"
],
"pageNo": "1",
"pageSize": "20"
}

Request parameters:

Parameter Name Type Description

companyName string Company name, fuzzy search supported
orderType string Sorting type
startTime string Start time (s)
exitChannelEmpty string Whether the exiting channel is null: 0-no; 1-yes
enterChannelEmpty string Whether the entering channel is null: 0-no; 1-yes
ownerName string Vehicle owner name, fuzzy search supported
departmentId string Department ID
carNo string License plate, fuzzy search supported
carColor string Vehicle color: -1 - all
exitChannelIds object Exit channel number
endTime string End time (s)
direction string Sorting order: 0-ascending; 1-descending
local string Language, such as zh and en
Vehicle type: -1-all; 0-visitor; 1-restricted list; 2-no
carType string
group; 3-ordinary vehicle; 4-VIP
carBrand string Vehicle logo: -2 - all
enterChannelIds object Entrance channel number
pageNo string Search start page, minimum: 1
Number of records per page, minimum: 1,
pageSize string
maximum: 256

Note:

orderType: 0-ID; 1-entering license plate; 2-exiting license plate; 3

-entering time; 4-exiting time; 5-entering channel; 6-exiting channe
l; 7-parking lot; 8-vehicle type; 9-company; 10-department; 11-vehicl
e owner; 12-logo of the entering vehicle; 13-logo of the exiting vehi
cle; 14-color of the entering vehicle; 15-color of the exiting vehicl
e; 0 by default

Return example:
{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "2",
"enterCarNo": "Zhejiang A12A26",
"personId": "1000201",
"ownerName": "zhang san",
"companyName": "",
"departmentId": "001",
"departmentName": "",
"carStatus": "0",
"carType": "0",
"enterCarPicture": "http://10.35.93.25:8081/d/1000024
$1$0$0/20190307/20/0550-3152-0.jpg?streamID:494@capTime:1551960350",
"enterCarNoPicture": "http://10.35.93.25:8081/d/10000
24$1$0$0/20190307/20/0550-3152-1.jpg?streamID:494@capTime:1551960350
",
"enterCarColor": "2",
"enterCarBrand": "1",
"enterChannelId": "1000024$1$0$0",
"enterBindChannelIds": [],
"enterChannelName": "Channel0",
"enterTime": "1551960350",
"enterCaptureRecordId": "3",
"exitCarNo": "Zhejiang A12A26",
"exitCarPicture": "http://10.35.93.25:8081/d/1000024
$1$0$1/20190307/20/0550-3151-0.jpg?streamID:507@capTime:1551960350",
"exitCarNoPicture": "http://10.35.93.25:8081/d/100002
4$1$0$1/20190307/20/0550-3151-1.jpg?streamID:507@capTime:1551960350",
"exitCarColor": "2",
"exitCarBrand": "1",
"exitChannelId": "1000024$1$0$1",
"exitBindChannelIds": [],
"exitChannelName": "Channel1",
"exitTime": "1551960350",
"exitCaptureRecordId": "23",
"parkingLotId": "3",
"parkingLotName": "intime"
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- pageData object None
- - id string History record ID
- - enterCarNo string Entering license plate
- - personId string personnel ID
- - ownerName string Owner name
- - companyName string Company name
- - departmentId string Department ID
- - departmentName string Department name
Vehicle status: 0-entering; 1-entering and
- - carStatus string
exiting; 2-exiting
Vehicle type: 0-visitor; 1-restricted list; 2-no
- - carType string
group; 3-ordinary vehicle; 4-VIP
- - enterCarPicture string Picture of the entering vehicle
- - enterCarNoPicture string Picture of the entering license plate
- - enterCarColor string Color of the captured entering vehicle, -1 - null
- - enterCarBrand string logo of the captured entering vehicle, -2 - null
- - enterChannelId string The entering channel No.
--
object Channel No. bound to the entering channel
enterBindChannelIds
- - enterChannelName string Name of the entering channel
- - enterTime string Entering time (s), -1 - null
--
string Snapshot record ID of entering vehicle
enterCaptureRecordId
- - exitCarNo string Captured exiting license plate
- - exitCarPicture string Picture of the exiting vehicle
- - exitCarNoPicture string Picture of the exiting license plate
- - exitCarColor string Color of the captured exiting vehicle, -1 - null
- - exitCarBrand string logo of the captured exiting vehicle, -2 - null
- - exitChannelId string The exiting channel No.
- - exitBindChannelIds object Channel No. bound to the exiting channel
- - exitChannelName string Name of the exiting channel
- - exitTime string Exiting time (s), -1 - null
Parameter Name Type Description
- - exitCaptureRecordId string Snapshot record ID of exiting vehicle
- - parkingLotId string Parking lot ID
- - parkingLotName string Parking lot name
- nextPage string Next page, -1 - no next page
- totalCount string Total number of records

Notes

• For more returned error codes, see the error code

description on the home page

4.19.7、Export vehicles entering or exiting records

Brief description：

• Export the history of vehicle entering and exiting. The

export file download path and session are returned. For
the progress of generating an export file, see: Export
file generation progress notification

Request URL：

• /IPMS/API/entrance/car/record/history/export
• X-Subject-Token: {token}

Parameter Name Type Description

token string The token obtained when logging in

Request example:

POST /IPMS/API/entrance/car/record/history/export HTTP/1.1

Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 18d0369cad1d46c4b88402c1c2b05911

Request method：

• POST

Request example:

{
"ids": ["1","6","9"],
"customColumns": ["1","6","10","11","12","13","17","18"],
"companyName": "",
"exitChannelIds": [
"1000024$1$0$1"
],
"ownerName": "",
"departmentId": "001",
"carNo": "Zhejiang A12A26",
"carColor": "-1",
"startTime": "1551888000",
"endTime": "1551974399",
"exportType": "",
"local": "zh",
"carType": "-1",
"exportColumnType": "1",
"enterChannelIds": [
"1000024$1$0$0"
],
"carBrand": "-2",
"exitChannelEmpty": "1",
"enterChannelEmpty": "1"
}

Request parameters:

Parameter Name Type Description

Vehicle entering/exiting record ID. If it is null,
ids object export all records. If it is not null, export specified
records. Other search conditions are invalid.
customColumns object Custom column
companyName string Company name, fuzzy search supported
exitChannelIds object Exit channel number
ownerName string Vehicle owner name, fuzzy search supported
departmentId string Department ID
carNo string License plate, fuzzy search supported
carColor string Vehicle color: -1 - all
startTime string Start time (s)
endTime string End time (s)
exportType string Export file type, only .xlsx is supported at present
local string Language, such as zh and en
Vehicle type: -1-all; 0-visitor; 1-restricted list; 2-no
carType string
group; 3-ordinary vehicle; 4-VIP
Mode of exporting columns: 0-all columns; 1-
exportColumnType string
custom column; 0 in view mode
enterChannelIds object Entrance channel number
carBrand string Vehicle logo: -2 - all
Parameter Name Type Description
exitChannelEmpty string Whether the exiting channel is null: 0-no; 1-yes
enterChannelEmpty string Whether the entering channel is null: 0-no; 1-yes

Notes:

customColumns: 1-entering license plate; 2-vehicle owner name; 3-comp

any name; 4-department name; 5-vehicle type; 6-picture of the enterin
g vehicle; 7-picture of the entering license plate; 8-color of the ca
ptured entering vehicle; 9-logo of the captured entering vehicle; 10-
name of the entering channel; 11-entering time; 12-license plate of t
he captured exiting vehicle; 13-picture of the exiting vehicle; 14-pi
cture of the exiting license plate; 15-color of the captured exiting
vehicle; 16-logo of the captured exiting vehicle; 17-name of the exit
ing channel; 18-exiting time; 19-parking lot name

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"session": "29fe3b7b1e9541e68230bfce7e40aa83",
"fileUrl": "/upload/ipms/enterExit/export/11551960644671.xlsx
"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- session string Session ID
- fileUrl string File download URL

Notes

• For more returned error codes, see the error code

description on the home page

4.19.8、Search the records of on-site vehicles

Brief description：
• Search the records of on-site vehicles

Request URL：

• /IPMS/API/entrance/car/record/existing
• X-Subject-Token: {token}

Parameter Name Type Description

token string The token obtained when logging in

Request example:

POST /IPMS/API/entrance/car/record/existing HTTP/1.1

Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075

Request method：

• POST

Request example:

{
"pageNo": 1,
"pageSize": 20,
"orderType": 2,
"direction": 1,
"carNo": "",
"carType": "-1",
"channelIds": [],
"carColor": "-1",
"carBrand": "-2",
"ownerName": "",
"companyName": "",
"departmentId": "001002",
"startTime": "1551888000",
"endTime": "1551974399",
"local": "zh",
"enterModel": "-1"
}

Request parameters:
Parameter
Type Description
Name
pageNo number Search start page, minimum: 1
Number of records per page, minimum: 1, maximum:
pageSize number
256
orderType string Sorting type
direction number Sorting order: 0-ascending; 1-descending
carNo string License plate, fuzzy search supported
Vehicle type: -1-all; 0-visitor; 1-restricted list; 2-no
carType string
group; 3-ordinary vehicle; 4-VIP
channelIds object ANPR channel ID
carColor string Vehicle color: -1 - all
carBrand string Vehicle logo: -2 - all
ownerName string Vehicle owner name, fuzzy search supported
companyName string Company name, fuzzy search supported
departmentId string Department ID
startTime string Start time (s)
endTime string End time (s)
local string Language, such as zh and en
Entering mode: -1-all; 0-card swiping; 1-automatic
recognition; 2-remote opening; 3-password
enterModel string
recognition; 4-fingerprint recognition; 5-face
recognition

Notes:

orderType: 1—plate number; 2—incoming time; 3—vehicle owner; 4—pa

rking lot name; 5—channel; 6—company; 7—department; 8—vehicle col
or; 9—vehicle logo; 10—vehicle type; 11—incoming mode; 2 by defaul
t

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "4",
"captureRecordId": "5",
"carNo": "Zhejiang A12A26",
"personId": "1000211",
"ownerName": "zhang san",
"companyName": "test",
"departmentId": "001002",
"departmentName": "test",
"carColor": "2",
"carBrand": "1",
"carPicture": "http://10.35.93.25:8081/d/1000024$1$0
$0/20190307/20/0653-3167-0.jpg?streamID:494@capTime:1551960413",
"carNoPicture": "http://10.35.93.25:8081/d/1000024$1
$0$0/20190307/20/0653-3167-1.jpg?streamID:494@capTime:1551960413",
"carType": "0",
"enterTime": "1551960413",
"channelId": "1000024$1$0$0",
"channelName": "Channel0",
"carRight": null,
"parkingLotId": "3",
"parkingLotName": "intime",
"enterModel": "1"
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Return parameters:

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- pageData object None
- - id string Snapshot record ID
--
string Snapshot record ID
captureRecordId
- - carNo string plate number
- - personId string personnel ID
- - ownerName string Owner name
- - companyName string Company name
- - departmentId string Department ID
--
string Department name
departmentName
- - carColor string Vehicle color
- - carBrand string Vehicle logo
Parameter
Type Description
Name
- - carPicture string Vehicle picture
- - carNoPicture string License plate picture
Vehicle type: 0-visitor; 1-restricted list; 2-no group;
- - carType string
3-ordinary vehicle; 4-VIP
- - enterTime string Entering time (s)
- - channelId string ANPR channel No.
- - channelName string ANPR channel name
Vehicle permission: 1-restricted list; 2-white list; not
- - carRight string
used for now
- - parkingLotId string Parking lot ID
--
string Parking lot name
parkingLotName
Entering mode: -1-all; 0-card swiping; 1-automatic
recognition; 2-remote opening; 3-password
- - enterModel string
recognition; 4-fingerprint recognition; 5-face
recognition
- nextPage string Next page, -1 - no next page
- totalCount string Total number of records

Notes

• For more returned error codes, see the error code

description on the home page

4.19.9、Export existing car records

Brief description：

• Export the records of on-site vehicles. The export file

download path and session are returned. For the progress
of generating an export file, see: Export file
generation progress notification

Request URL：

• /IPMS/API/entrance/car/record/existing/export
• X-Subject-Token: {token}

Parameter Name Type Description

token string The token obtained when logging in

Request example:

POST /IPMS/API/entrance/car/record/existing/export HTTP/1.1

Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075

Request method：

• POST

Request example:

{
"ids": ["1","6","9"],
"exportColumnType": 0,
"customColumns": ["6","7","1","13","10","11"],
"carNo": "",
"carType": "-1",
"channelIds": [],
"carColor": "-1",
"carBrand": "-2",
"ownerName": "",
"companyName": "",
"departmentId": "001002",
"startTime": "1551888000",
"endTime": "1551974399",
"exportType": "xlsx",
"local": "zh",
"enterModel": "-1"
}

Request parameters:

Parameter
Type Description
Name
Record ID for the on-site vehicle. If it is null, export
ids object all records. If it is not null, export specified records.
Other search conditions are invalid.
Mode of exporting columns: 0-all columns; 1-custom
exportColumnType string
column; 0 in view mode
customColumns object Custom export column
carNo string License plate, fuzzy search supported
Vehicle type: -1-all; 0-visitor; 1-restricted list; 2-no
carType string
group; 3-ordinary vehicle; 4-VIP
channelIds array ANPR channel No.
carColor string Vehicle color: -1 - all
Parameter
Type Description
Name
carBrand string Vehicle logo: -2 - all
ownerName string Vehicle owner name, fuzzy search supported
companyName string Company name, fuzzy search supported
departmentId string Department ID
startTime string Start time (s)
endTime string End time (s)
exportType string Export file type, only .xlsx supported at present
local string Language, such as zh and en
Entering mode: -1-all; 0-card swiping; 1-automatic
recognition; 2-remote opening; 3-password
enterModel string
recognition; 4-fingerprint recognition; 5-face
recognition

Notes:

customColumns: 1-license plate; 2-vehicle owner name; 3-company name;

4-department name; 5-vehicle type; 6-picture of the entering vehicl
e; 7-picture of the entering license plate; 8-vehicle color; 9-vehicl
e logo; 10-name of the entering channel; 11-entering time; 12-vehicle
permission; 13-parking lot name

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"session": "05b0b8e2708543b49f0a228c9576f158",
"fileUrl": "/upload/ipms/existing/export/11551960664766.xlsx"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- session string Session ID
- fileUrl string File download URL

Notes
• Formore returned error codes, see the error code
description on the home page

4.19.10、Search vehicle snapshot records

Brief description：

• Search vehicle snapshot records

Request URL：

• /IPMS/API/entrance/car/record/capture
• X-Subject-Token: {token}

Parameter Name Type Description

token string The token obtained when logging in

Request example:

POST /IPMS/API/entrance/car/record/capture HTTP/1.1

Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075

Request method：

• POST

Request example:

{
"pageNo": 1,
"pageSize": 20,
"orderType": 2,
"direction": 1,
"carNo": "",
"carDirect": "-1",
"channelIds": [],
"carType": "-1",
"carColor": "-1",
"carBrand": "-2",
"ownerName": "",
"companyName": "",
"departmentId": "001",
"startTime": "1551888000",
"endTime": "1551974399",
"local": "zh"
}

Request parameters:

Parameter
Type Description
Name
pageNo number Search start page, minimum: 1
Number of records per page, minimum: 1,
pageSize number
maximum: 256
orderType number Sorting type, 1-plate number,2-snapshot time
direction number Sorting order: 0—ascending; 1—descending
carNo string License plate, fuzzy search supported
carDirect string Vehicle driving direction: -1-all; 8-entering; 9-exiting
channelIds object ANPR channel ID
Vehicle type: -1-all; 0-visitor; 1-restricted list; 2-no
carType string
group; 3-ordinary vehicle; 4-VIP
carColor string Vehicle color: -1 - all
carBrand string Vehicle logo: -2 - all
ownerName string Vehicle owner name, fuzzy search supported
companyName string Company, fuzzy search supported
departmentId string Department ID
startTime string Start time (s)
endTime string End time (s)
local string Language, such as zh and en

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "1",
"captureTime": "1551960413",
"carDirect": "8",
"carPicture": "http://10.35.93.25:8081/d/1000024$1$0
$0/20190307/20/0653-3167-0.jpg?streamID:494@capTime:1551960413",
"carNoPicture": "http://10.35.93.25:8081/d/1000024$1
$0$0/20190307/20/0653-3167-1.jpg?streamID:494@capTime:1551960413",
"carNo": "Zhejiang A12B26",
"carColor": "2",
"carBrand": "1",
"personId": "1000211",
"ownerName": "zhang san",
"companyName": "test",
"departmentId": "001",
"departmentName": "test001",
"carType": "0",
"channelId": "1000024$1$0$0",
"channelName": "Channel0",
"parkingLotId": "3",
"parkingLotName": "intime"
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- pageData object None
- - id string Snapshot record ID
- - captureTime string Snapshot time (s)
- - carDirect string Vehicle driving direction: 8-entering; 9-exiting
- - carPicture string Vehicle picture
- - carNoPicture string License plate picture
- - carNo string Plate number
- - carColor string Vehicle color
- - carBrand string Vehicle logo
- - personId string personnel ID
- - ownerName string Owner name
- - companyName string Company name
- - departmentId string Department ID
--
string Department name
departmentName
Vehicle type: 0-visitor; 1-restricted list; 2-no group;
- - carType string
3-ordinary vehicle; 4-VIP
- - channelId string ANPR channel No.
- - channelName string ANPR channel name
Parameter Name Type Description
- - parkingLotId string Parking lot ID
--
string Parking lot name
parkingLotName
- nextPage string Next page, -1 - no next page
- totalCount string Total number of records

Notes

• For more returned error codes, see the error code

description on the home page

4.19.11、Export vehicles snapshot records

Brief description：

• Export vehicle snapshot records. The export file download

path and session are returned. For the progress of
generating an export file, see: Export file generation
progress notification

Request URL：

• /IPMS/API/entrance/car/record/capture/export
• X-Subject-Token: {token}

Parameter Name Type Description

token string The token obtained when logging in

Request example:

POST /IPMS/API/entrance/car/record/capture/export HTTP/1.1

Host: 10.35.92.55
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 457cb8a2da6046c4afafb7d7a4ac4075

Request method：

• POST

Request example:

{
"ids": ["1","6","9"],
"exportColumnType": 0,
"customColumns": ["6","7","1","13","10","11","12"],
"carNo": "",
"carDirect": "-1",
"carType": "-1",
"channelIds": [],
"carColor": "-1",
"carBrand": "-2",
"ownerName": "",
"companyName": "",
"departmentId": "001",
"startTime": "1551888000",
"endTime": "1551974399",
"exportType": "xlsx",
"local": "zh"
}

Request parameters:

Parameter
Type Description
Name
Snapshot record ID. If it is null, export all records. If
ids object it is not null, export specified records. Other search
conditions are invalid.
Mode of exporting columns: 0-all columns; 1-custom
exportColumnType string
column; 0 in view mode
customColumns object Custom export column
carNo string License plate, fuzzy search supported
carDirect string Vehicle driving direction: -1-all; 8-entering; 9-exiting
Vehicle type: -1-all; 0-visitor; 1-restricted list; 2-no
carType string
group; 3-ordinary vehicle; 4-VIP
channelIds array ANPR channel
carColor string Vehicle color: -1 - all
carBrand string Vehicle logo: -2 - all
ownerName string Vehicle owner name, fuzzy search supported
companyName string Company name, fuzzy search supported
departmentId string Department ID
startTime string Start time (s)
endTime string End time (s)
exportType string Export file type, only .xlsx supported at present
local string Language, such as zh and en

Notes:

customColumns: 1-license plate; 2-vehicle owner name; 3-company name;

4-department name; 5-vehicle type; 6-vehicle picture; 7-license plat
e picture; 8-vehicle color; 9-vehicle logo; 10-ANPR channel name; 11-
snapshot time; 12-vehicle driving direction; 13-parking lot name

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"session": "153a1385539c420199fd966cfa42f176",
"fileUrl": "/upload/ipms/carCapture/export/11551960674702.xls
x"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- session string Session ID
- fileUrl string File download URL

Notes

• For more returned error codes, see the error code

description on the home page

4.19.12、Obtain parking lot information

Brief description：

• Obtain parking lot information

Request URL：

• /IPMS/API/entrance/parking-lot/{id}
• X-Subject-Token: {token}

Parameter Name Type Description

id string Parking lot ID
token string The token obtained when logging in

Request example:
GET /IPMS/API/entrance/parking-lot/3 HTTP/1.1
Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: f1b053ef370d4153a9313c28bbf7359f

Request method：

• GET

Request example:

Null

Request parameters:

Null

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"id": "3",
"parkingLotName": "intime",
"totalLots": "300",
"idleLots": "180",
"overTime": "0",
"timeTemplateId": "1",
"isPassForUnknownCarEnter": "1",
"isPassZeroIdleLot": "3",
"isPassForUnknownCarExit": "1",
"bindingItcs": [
{
"channelId": "1000024$1$0$0",
"channelName": "Channel0",
"isOnline": "1",
"orgCode": "root",
"direct": "8",
"deviceCategory": "5",
"deviceIp": "10.33.68.103",
"deviceManufacturer": "1",
"devicePort": "41000",
"deviceType": "8",
"authorityStatus": "1",
"vtos": [
{
"channelId": "1000014$7$0$0",
"channelName": "7.7.7.7_1",
"isOnline": "1",
"orgCode": "root",
"deviceCategory": "21",
"deviceIp": "7.7.7.7",
"deviceManufacturer": "1",
"devicePort": "37777",
"deviceType": "5",
"authorityStatus": "1"
}
],
"leds": []
}
],
"bindingLeds": [
{
"channelId": "1000007$16$0$0",
"channelName": "AA_1",
"isOnline": "0",
"orgCode": "root",
"deviceCategory": "16",
"deviceIp": "1.1.1.1",
"deviceManufacturer": "1",
"devicePort": "37777",
"deviceType": "2",
"authorityStatus": "1"
}
]
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- id string Parking lot ID
- parkingLotName string Parking lot name
- totalLots string Total parking lots
- idleLots string Remaining parking spaces
Parameter Name Type Description
Timeout alarm duration (s). 0 - the timeout
- overTime string
alarm function is disabled.
ID of the time template for automatic pass-
- timeTemplateId string
through
- Whether automatic release is available for
string
isPassForUnknownCarEnter entering visitors: 0-no; 1-yes
Whether to allow entry when the remaining
parking space is 0: 1-allow the entry of all
- isPassZeroIdleLot string vehicles; 2-allow the entry of vehicles on
the white list; 3-prohibit the entry of
vehicles; 4-allow the entry of VIP vehicles
Whether automatic release is available for
- isPassForUnknownCarExit string
exiting visitors: 0-no; 1-yes
- bindingItcs object None
- - channelId string ANPR channel No.
- - channelName string Channel name
- - isOnline string Online status: 1-online; 0-offline
- - orgCode string Organization
- - direct string Direction
- - deviceCategory string Device type
- - deviceIp string Device IP
- - deviceManufacturer string Device vendor
- - devicePort string Device ports
- - deviceType string Device type
- - authorityStatus string Permission: 0-no; 1-yes
- - vtos object None
- - - channelId string VTO channel No.
- - - channelName string Channel name
- - - isOnline string Online status: 1-online; 0-offline
- - - orgCode string Organization
- - - deviceCategory string Device type
- - - deviceIp string Device IP
- - - deviceManufacturer string Device vendor
- - - devicePort string Device ports
- - - deviceType string Device type
- - - authorityStatus string Permission: 0-no; 1-yes
- - leds object None
- - - channelId string LED channel No.
- - - channelName string Channel name
- - - isOnline string Online status: 1-online; 0-offline
- - - orgCode string Organization
Parameter Name Type Description
- - - deviceCategory string Device type
- - - deviceIp string Device IP
- - - deviceManufacturer string Device vendor
- - - devicePort string Device ports
- - - deviceType string Device type
- - - authorityStatus string Permission: 0-no; 1-yes
- - bindingLeds object None
- - - channelId string LED channel No.
- - - channelName string Channel name
- - - isOnline string Online status: 1-online; 0-offline
- - - orgCode string Organization
- - - deviceCategory string Device type
- - - deviceIp string Device IP
- - - deviceManufacturer string Device vendor
- - - devicePort string Device ports
- - - deviceType string Device type
- - - authorityStatus string Permission: 0-no; 1-yes

Notes

• For more returned error codes, see the error code

description on the home page

4.19.13、Obtain personnel ANPR right

Brief description：

• Obtain personnel ANPR right

Request URL：

• /IPMS/API/entrance/car/right/person/{personId}
• X-Subject-Token: {token}

Request example:

GET /IPMS/API/entrance/car/right/person/19481 HTTP/1.1

Host: 10.35.93.25
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 350a4db703864f1bbf4395965e685efe
Parameter Name Type Description
personId string personnel ID
token string The token obtained when logging in
Request method：

• GET

Request example:

Null

Request parameters:

Null

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"results": [
"1000008"
]
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- results object Entrance/exit device code of the parking lot

Notes

• Formore returned error codes, see the error code

description on the home page

4.19.14、Statistics of the parking rates of parking lots

Brief description：

• Statistics of the parking rates of parking lots

Request URL：

• /IPMS/API/entrance/parking-stat/parking-rate
• X-Subject-Token: {token}
Request example:

POST /IPMS/API/entrance/parking-stat/parking-rate HTTP/1.1

Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 8adeb2e9bfba4c09b2a3d6857206352c
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example:

{
"parkingLotId": ""
}

Request parameters:

Parameter
Type Description
Name
Parking lot ID. If it is null, enable the statistics of the
parkingLotId string
parking rates of all parking lots.

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"total": 200,
"idle": 160,
"used": 40,
"idlePercent": "80.00%"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
Parameter Name Type Description
- total string Total parking lots
- idle string Remaining parking spaces
- used string Used parking spaces
- idlePercent string Percentage of remaining parking spaces

Notes

• For more returned error codes, see the error code

description on the home page

4.19.15、Parking lots real-time information

Brief description：

• Parking lots real-time information

Request URL：

• /IPMS/API/entrance/parking-stat/real-time
• X-Subject-Token: {token}

Request example:

POST /IPMS/API/entrance/parking-stat/real-time HTTP/1.1

Request method：

• POST

Request example:

{
"parkingLotId": ""
}

Request parameters:

Parameter
Type Description
Name
parkingLotId string Parking lot ID. If it is null, enable the statistics of the
Parameter
Type Description
Name
real-time information about all parking lots.

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"total": 200,
"hourFlow": 0,
"dayFlow": 0,
"rotationRate": "0.00%",
"availabilityRate": "0.00%"
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- total string Total parking lots
- hourFlow string Cumulative vehicle flow (every hour)
- dayFlow string Cumulative vehicle flow (every day)
- rotationRate string Parking space turnover rate
- availabilityRate string Parking lot utilization rate

Notes:

• For more returned error codes, see the error code

description on the home page

4.19.16、On-site vehicles in the parking lot at the current day

Brief description：

• On-site vehicles in the parking lot at the current day

Request URL：

• /IPMS/API/entrance/parking-stat/daily-vehicle-stay
• X-Subject-Token: {token}
Request example:

POST /IPMS/API/entrance/parking-stat/daily-vehicle-stay HTTP/1.1

Request method：

• POST

Request example:

{
"parkingLotId": ""
}

Request parameters:

Parameter
Type Description
Name
Parking lot ID. If it is null, enable the statistics of the
parkingLotId string
on-site vehicles in all parking lots.

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"yData": [
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"xDate": [
"00:00",
"01:00",
"02:00",
"03:00",
"04:00",
"05:00",
"06:00",
"07:00",
"08:00",
"09:00",
"10:00",
"11:00",
"12:00",
"13:00",
"14:00",
"15:00",
"16:00"
]
}
}

Return parameters:

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- yData object Number of vehicles corresponding to xDate
- xDate object Time list, unit: hour

Notes

• For more returned error codes, see the error code

description on the home page

4.19.17、Statistics of the vehicle flow of parking lots

Brief description：
• Statistics of the vehicle flow of parking lots

Request URL：

• /IPMS/API/entrance/parking-stat/car-flow
• X-Subject-Token: {token}

Request example:

POST /IPMS/API/entrance/parking-stat/car-flow HTTP/1.1

Request method：

• POST

Request example:

{
"flowType": 1,
"endTime": "2019-10-22 23:59:59",
"startTime": "2019-10-22 00:00:00",
"parkingLotId": ""
}

Request parameters:

Parameter
Type Description
Name
Flow type: 1-by day; 2-by week; 3-by month; 4-by
flowType string
year
endTime string End time and date, format: yyyy-MM-dd HH:mm:ss
startTime string Start time and date, format: yyyy-MM-dd HH:mm:ss
Parking lot ID. If it is null, enable the statistics of the
parkingLotId string
vehicle flow of all parking lots.

Return example:

{
"code": 1000,
"desc": "Success",
"data": {
"enterYFlow": [
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0"
],
"xDate": [
"00:00",
"01:00",
"02:00",
"03:00",
"04:00",
"05:00",
"06:00",
"07:00",
"08:00",
"09:00",
"10:00",
"11:00",
"12:00",
"13:00",
"14:00",
"15:00",
"16:00",
"17:00",
"18:00",
"19:00",
"20:00",
"21:00",
"22:00",
"23:00",
"00:00"
],
"exitYFlow": [
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0",
"0"
]
}
}

Return parameters:

Parameter
Type Description
Name
Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- enterYFlow string Number of entering vehicles corresponding to xDate
Time list, format: day (HH:mm), week (Sunday, ...),
- xDate string
month (yyyy-MM-dd), year (yyyy-MM)
- exitYFlow string Number of exiting vehicles corresponding to xDate

Notes

• For more returned error codes, see the error code

description on the home page

4.20、Traffic

4.20.1、Obtain traffic flow data in a table

Brief description：

• Obtain traffic flow data based on filtering criteria and

display search results in a table in pages

Request URL：

• /OTMS/API/trafficFlow/getTrafficFlow
• X-Subject-Token: {token}

Request example:

GET /OTMS/API/trafficFlow/getTrafficFlow HTTP/1.1

Request method：

• GET

Request example

{
"data": {
"page": 1,
"rows": 20,
"sortFlag": "desc",
"autoCount": 0,
"devChnid": "1000001$1$0$0",
"laneType": "1",
"timeType": "1",
"intervalType": "3",
"startDate": "2019-05-15",
"endDate": ""
}
}

Parameters：

Parameter
Type Description
Name
data object None
- page number Page search
- rows number Number of entries per page
Sorting by startDate: asc - Ascending, desc -
- sortFlag string
Descending
Whether the number is counted automatically: 0 - No,
- autoCount number
1 - Yes
- devChnid string Channel No.
Lane number: 1 - All, 2 - Lane 1, 3 - Lane 2, 4 - Lane
- laneType string
3, 5 - Lane 4
Time type: 1 - Day, 2 - Week, 3 - Month, 4 - Year, 5 -
- timeType string
Customized
Time interval: 1 - 15 minutes, 2 - 30 minutes, 3 - 60
- intervalType string
minutes, valid when timeType is set to Day.
Search start time, format: yyyy-MM-dd. When the time
- startDate string type is Month, Day can be of any value. When the time
type is Year, Day and Month can be of any value.
Search end time, format: yyyy-MM-dd. When the time
- endDate string type is week and customized, the end date cannot be
null.

Return example

{
"code": 0,
"desc": null,
"errorParams": null,
"data": {
"page": 1,
"list": [
{
"id": 12,
"startDate": "2019-05-15 10:00:00",
"endDate": "2019-05-15 11:00:00",
"devName": "10.35.173.116",
"laneNo": "ALL",
"timeOccupancy": 37.89,
"averageSpeed": 28.93,
"flow": 470,
"volume": 530,
"smallCar": 390,
"bus": 13,
"smallTruck": 59,
"bigTruck": 8,
"state": null,
"devChnid": "1000001$1$0$0",
"flowRate": 365,
"leftTurnCount": 0,
"rightTurnCount": null,
"straightTurnCount": 0,
"uTurnCount": 0,
"passengerCar": 13,
"largeTruck": 0,
"midTruck": 8,
"saloonCar": 299,
"microBus": 91,
"microTruck": 59,
"tricycle": 0,
"motorcycle": 0,
"passerby": 0,
"time": "10:00",
"timeType": 1
}
],
"totalSize": 1,
"autoCount": 0,
"rows": 20
}
}

Description of return parameters

Parameter Name Type Description

Parameter Name Type Description
code number Error code
desc string Result description
errorParams object None, not used for now
data object None
- page number Current page number
- list object None
- - id number Identifier
- - startDate string Statistics start time
- - endDate string Statistics end time
- - devName string Device name
Lane number: ALL - All, 1 - Lane 1, 2 - Lane 2, 3
- - laneNo string
- Lane 3, 4 - Lane 4
- - timeOccupancy number Occupation ratio
- - averageSpeed number Average speed
- - flow number Flow value
- - volume number Traffic flow
- - smallCar number Compact car traffic flow
- - bus number Vehicle traffic flow
- - smallTruck number Pickup truck traffic flow
- - bigTruck number Large truck traffic flow
- - state number Flow status
- - devChnid string Channel No.
- - flowRate number Flow rate
- - leftTurnCount number Statistics of left-turning vehicles
- - rightTurnCount number Statistics of right-turning vehicles
--
number Statistics of going-straight vehicles
straightTurnCount
- - uTurnCount number Statistics to be confirmed
- - passengerCar number Bus traffic flow
- - largeTruck number Large truck traffic flow
- - midTruck number Medium truck traffic flow
- - saloonCar number Sedan traffic flow
- - microBus number Minibus traffic flow
- - microTruck number Pickup truck traffic flow
- - tricycle number Three-wheeler traffic flow
- - motorcycle number Motorbike traffic flow
- - passerby number Pedestrian traffic flow
- - time string Statistics time
Time type: 1 - Day, 2 - Week, 3 - Month, 4 -
- - timeType number
Year, 5 - Customized
- totalSize number Total number of records
Parameter Name Type Description
Whether the number is counted automatically: 0 -
- autoCount number
No, 1 - Yes
- rows number Number of entries per page

Notes

• For more returned error codes, see the error code

description on the home page

4.20.2、Obtain traffic flow data in a chart

Brief description：

• Obtain traffic flow data based on filtering criteria and

display all search results in a chart in pages

Request URL：

• /OTMS/API/trafficFlow/drawTrafficFlow
• X-Subject-Token: {token}

Request example:

GET /OTMS/API/trafficFlow/drawTrafficFlow HTTP/1.1

Request method：

• GET

Request example

{
"data": {
"devChnid": "1000001$1$0$0",
"laneType": "2",
"timeType": "1",
"intervalType": "3",
"startDate": "2019-05-15",
"endDate": ""
}
}

Parameters：

Parameter
Type Description
Name
data object None
- devChnid string Channel No.
Lane number: 1 - All, 2 - Lane 1, 3 - Lane 2, 4 - Lane 3,
- laneType string
5 - Lane 4
Time type: 1 - Day, 2 - Week, 3 - Month, 4 - Year, 5 -
- timeType string
Customized
Time interval: 1 - 15 minutes, 2 - 30 minutes, 3 - 60
- intervalType string
minutes, valid when timeType is set to Day.
Search start time, format: yyyy-MM-dd. When the time
- startDate string type is Month, Day can be of any value. When the time
type is Year, Day and Month can be of any value.
Search end time, format: yyyy-MM-dd. When the time
- endDate string type is week and customized, the end date cannot be
null.

Return example

{
"code": 0,
"desc": null,
"errorParams": null,
"data": [
[
"00:00",
"01:00",
"02:00",
"03:00",
"04:00",
"05:00",
"06:00",
"07:00",
"08:00",
"09:00",
"10:00",
"11:00",
"12:00",
"13:00",
"14:00",
"15:00",
"16:00",
"17:00",
"18:00",
"19:00",
"20:00",
"21:00",
"22:00",
"23:00"
],
{
"name": "Sedan",
"data": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
93,
172,
160,
153,
106,
54,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"name": "Bus",
"data": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
8,
12,
13,
10,
6,
3,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"name": "Truck",
"data": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
3,
6,
5,
7,
2,
1,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"name": "Large truck",
"data": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
7,
10,
10,
9,
8,
7,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
},
{
"name": "All",
"data": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
111,
200,
188,
179,
122,
65,
0,
0,
0,
0,
0,
0,
0,
0,
0
]
}
]
}

Description of return parameters

Parameter
Type Description
Name
code number Error code
desc string Result description
errorParams object None, not used for now
data object None
- name string Vehicle type name
Corresponding time coordinate, vehicle flow
- data object
statistics

Notes

• For more returned error codes, see the error code

description on the home page

4.20.3、Obtain section data

Brief description：
• Obtain section data

Request URL：

• /OTMS/API/BRM/Itc/GetSections?token={token}

Request example

POST /OTMS/API/BRM/Itc/GetSections?token=8cf214354bd44250b286ef5f8bd6
fb2d HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Itc.GetSections",
"data": {
"optional": "/OTMS/API/BRM/Itc/GetSections?token=8cf214354bd4
4250b286ef5f8bd6fb2d"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
clientPushId string Null
project string Null
method string Method name
data object None
- optional string URI information

Return example
{
"code": 1000,
"desc": "Success",
"data": {
"list": [
{
"id": "1",
"sectionName": "123"
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- list object None
- - id string Section ID
- - sectionName string Section name

Notes

• For more returned error codes, see the error code

description on the home page

4.21、Flow Analysis

4.21.1、People counting report interface

Brief description：

• People counting report interface

Request URL：

• /admin/API/bi/peopleCount/getData
• X-Subject-Token: {token}

Request example:

POST /admin/API/bi/peopleCount/getData HTTP/1.1

Request method：

• POST

Request example

{
"countType": "2",
"date": "2019-06-01",
"channels": "1000004$1$0$0,1000010$1$0$1,1000013$1$0$6"
}

Parameters：

Parameter
Type Description
Name
countType String Counting type: 1 - Day, 2 - Week, 3 - Month, 4 - Year
Search time, format: day (yyyy-MM-dd), week (yyyy-
date string MM-dd), the last day of each week is Saturday, month
(yyyy-MM), year (yyyy)
channels String Channel No., separated by commas

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"enteredSubtotalList": [
"0","0","0","0","5","0","0","0","0","0","0","0"
],
"exitedSubtotalList": [
"0","0","0","0","2","4","0","0","0","0","0","0"
],
"holdTotalList": [
"0","0","0","0","3","0","0","0","0","0","0","0"
],
"dateList": [
"1","2","3","4","5","6","7","8","9","10","11","12"
],
"recordDateList": [
"2019-01","2019-02","2019-03","2019-04","2019-05","2019-0
6",
"2019-07","2019-08","2019-09","2019-10","2019-11","2019-1
2"
],
"channelNames": "IP PTZ Dome111, 13, Channel 1",
"enteredTotal": "",
"exitedTotal": ""
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
Incoming people number. The data is displayed by
- week, month, or year. Passenger flow data is the
object
enteredSubtotalList entered people number, leaving and stay people
numbers are not displayed.
Leaving people number, valid only for searching by
- exitedSubtotalList object
day
Stay people number, valid only for searching by
- holdTotalList object
day, null for other counting types
- dateList object x coordinate, date sequence number
Total number of incoming people within one day,
- enteredTotal string valid only for searching by day, null for other
counting types
Total leaving people numbers within one day, valid
- exitedTotal string only for searching by day, null for other counting
types
- recordDateList object Accurate date
Channel name, separated by comma for multiple
- channelNames string
channel names

Notes

• For more returned error codes, see the error code

description on the home page

4.22、Heatmap

4.22.1、Search heat map

Brief description：

• Searchthe heat map data generated in a single channel

within a period. Arrays of data (one piece per hour) are
returned.

Request URL：

• /admin/API/BRM/Heatmap/GetHeatmap?token={token}

Request example

GET /admin/API/BRM/Heatmap/GetHeatmap?token=72fc9628ced24a81ad26986e4
c70a23a HTTP/1.1
Host: 172.22.151.11:801
Connection: close
Content-Type: application/json;charset=UTF-8
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• GET

Request example

{
"clientType": "WINPC",
"clientMac": "30:9c:23:79:40:08",
"clientPushId": "",
"project": "PSDK",
"method": "BRM.Heatmap.GetHeatmap",
"data": {
"endTime": "1542902399",
"optional": "/admin/API/BRM/Heatmap/GetHeatmap?token=72fc9628
ced24a81ad26986e4c70a23a",
"channelId": "1000027$1$0$0",
"startTime": "1542816000"
}
}

Parameters：

Parameter Name Type Description

clientType string Computer name
clientMac string Computer MAC address
Parameter Name Type Description
clientPushId string Null
project string Null
method string Method name
data object None
- endTime string End time (s)
- optional string URI information
- channelId string Channel No.
- startTime string Start time (s)

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": "1",
"records": [
{
"deviceCode": "1000027",
"unitSeq": "0",
"channelSeq": "0",
"startTime": "1542816000",
"endTime": "1542902399",
"average": "0",
"width": "192",
"height": "144",
"picDataLen": "27648",
"picData": "..."
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- total string Total count
- records object Record information
- - deviceCode string Device code
- - unitSeq string Unit sequence
Parameter Name Type Description
- - channelSeq string Channel sequence number
- - startTime string Start time (s)
- - endTime string End time (s)
- - average string Heat map average value
- - width string Heat map width
- - height string Heat map height
- - picDataLen string Heat map data size
- - picData string Heat map data

Notes

• For more returned error codes, see the error code

description on the home page

4.23、Access Control

4.23.1、Get configuration channel for global door control

Brief description:

• Get configuration channel for global door control

Request URL:

• /OBMS/accessControl/door/globalControl/config
• X-Subject-Token: {token}

Request example

GET /OBMS/accessControl/door/globalControl/config HTTP/1.1

Host: 10.33.68.138
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 1b90ee2b0a5f4f7cb44149bbbb5f973f
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:
None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"channelId": [
"1000029$7$0$0",
"1000053$7$0$0"
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- channelId object Channel code

Notes

– For more returned error codes, see the error code description on the home page

4.23.2、Configure channel for global door control

Brief description:

• Configure channel for global door control

Request URL:

• /OBMS/accessControl/door/globalControl/config
• X-Subject-Token: {token}

Request example

POST /OBMS/accessControl/door/globalControl/config HTTP/1.1

• POST

Request example

{
"channelId": [
"1000006$7$0$0"
]
}

Parameters:

Parameter Name Type Description

channelId object Channel code

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page

4.23.3、Get global door control status

Brief description:

• Get global door control status

Request URL:

• /OBMS/accessControl/door/globalControl/control
• X-Subject-Token: {token}

Request example

GET /OBMS/accessControl/door/globalControl/control HTTP/1.1

Host: 10.33.68.138
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 1582ca4da1c44578af4e8867243e7b59
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"status": "1"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
Status, 0-return to normal, 1-global door closed, 2-
- status string
global door open

Notes

– For more returned error codes, see the error code description on the home page

4.23.4、Global door control

Brief description:

• Global door control

Request URL:

• /OBMS/accessControl/door/globalControl/control
• X-Subject-Token: {token}

Request example

POST /OBMS/accessControl/door/globalControl/control HTTP/1.1

Request method:

• POST

Request example

{
"status": "2"
}

Parameters:

Parameter
Type Description
Name
Status, 0—return to normal, 1—global door closed, 2—
status string
global door open

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page
4.23.5、Open and close a single door

Brief description:

• Open and close a single door

Request URL:

• /OBMS/accessControl/door/control
• X-Subject-Token: {token}

Request example

POST /OBMS/accessControl/door/control HTTP/1.1

Request method:

• POST

Request example

{
"status": "1",
"channelId": "1000006$7$0$0"
}

Parameters:

Parameter Name Type Description

status string Single door status, 0—close, 1—open
channelId string Access control channel code

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

Parameter Name Type Description
code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page

4.24、Personnel Management

4.24.1、Search one-card user list

Brief description:

• Search one-card user list.

Request URL:

• /OBMS/accessControl/personList?key={key}&deparmentId={depa
rmentId}&channelId={channelId}&personType={personType}&o
rderType={orderType}&direction={direction}&page={page}&p
agesize={pagesize}
• X-Subject-Token: {token}

Request example

GET /OBMS/accessControl/personList?key=liu&deparmentId=001&channelId=
1000006$7$0$0&personType=0&orderType=0&direction=0&page=1&pagesize=20
HTTP/1.1
Host: 10.33.68.138
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: d725f34e4f034038bf1771a8ea43c931
Parameter
Type Description
Name
key string Search keyword
deparmentId int Department ID, such as 001
channelId string Channel ID
Person type, 0—common, 1—blacklist, 2—visitor, 3—
personType int
patrol, 4—VIP
Sort field, 0—person ID (PERSON_ID), 1—first name
(FIRST_NAME), 2—last name (LAST_NAME), 3—gender
orderType int (GENDER), 4—person type (PERSON_TYPE), 5—stage ID
(STAGE_ID), 6—building ID (BUILDING_ID), 7—unit ID
(UNIT_ID), 8—room ID(ROOM_ID)
direction int Sort order, 0—ascending order, 1—descending order
Parameter
Type Description
Name
page int First page of search, min.1
pagesize int Record count per page, min.1 and max.256
token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "3",
"personId": "2047",
"stageId": "",
"buildingId": "12",
"unitId": "1",
"roomId": "36",
"firstName": "liu",
"lastName": "zhao",
"departmentId": "001001",
"gender": "1",
"cardType": "0",
"status": "0",
"hasFinger": "0",
"authority": "0",
"cardNo": [
"00666998"
],
"cars": [
"zA2563D8"
],
"infraredFaceCodes": ["1"],
"headPicUrl": ""
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- pageData object None
- - id string ID
- - personId string Person ID
- - stageId string Stage ID
- - buildingId string Building ID
- - unitId string Unit
- - roomId string Room ID
- - firstName string First name
- - lastName string Last name
- - departmentId string Department code
- - gender string Gender, 0—female, 1—male
Person type, 0—common, 1—blacklist, 2—visitor,
- - cardType string
3—patrol, 4—VIP
- - status string Status, 0—on the job, 1—quit
- - hasFinger string Fingerprint or not, 0—no, 1—yes
- - authority string Administrator or not, 0—no, 1—yes
- - cardNo object Card No.
- - cars object License plate number
--
object Has face feature code or not
infraredFaceCodes
- - headPicUrl string Head picture URL
- nextPage string Next page, -1 means no next page
- totalCount string Total count

Notes

– For more returned error codes, see the error code description on the home page

4.24.2、Search one-card user

Brief description:

• Search one-card user.

Request URL:

• /OBMS/accessControl/person/{personId}
• X-Subject-Token: {token}

Request example

GET /OBMS/accessControl/person/2047 HTTP/1.1

Host: 10.33.68.138
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: d725f34e4f034038bf1771a8ea43c931
Parameter Name Type Description
personId int Person ID
token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"baseInfo": {
"id": 32,
"personId": "2047",
"stageId": "",
"buildingId": "12",
"unitId": "1",
"roomId": "36",
"firstName": "liu",
"lastName": "zhao",
"departmentId": "001001",
"pictureData": "",
"gender": "1",
"cardType": "2",
"status": "0",
"householder": "0",
"authority": "0"
},
"details": {
"tel": "13611111111",
"email": "[email protected]",
"idType": "5",
"idNum": "",
"maritalStatus": "1",
"nationalityId": "china",
"birthday": "2019-06-17",
"degree": "4",
"initialTime": "1560700800",
"expireTime": "1877615999",
"address": "changning",
"remark": "test",
"useTimes": "200",
"nickName": "xiaoliu",
"position": "test",
"companyName": "test"
},
"authentication": {
"password": "9bb8291f7f9426004b3a1586c78244e4",
"carportAmount": "1",
"cards": [
{
"cardNo": "00666998",
"issueDate": "1560753819",
"cardState": "0",
"changeDate": "1560759729",
"duressFlag": "0",
"masterFlag": "1"
}
],
"cars": [
{
"carNo": "zA2563D8",
"carRight": "2",
"carGroup": "1"
}
],
"fingerPrints": [
{
"name": "f009",
"masterFlag": "1",
"threadFlag": "0",
"fingerPrint": "..."
}
],
"facePictures": [
"upload/obms/facePic/2047@[email protected]"
],
"infraredFaceCodes": [
"..."
]
},
"accessRight": {
"channelIds": [
"1000006$7$0$0"
],
"doorGroupIds": [
"1"
],
"entranceDeviceCodes": [
"1000001"
],
"departmentDoorGroupIds": [
"3"
]
}
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- baseInfo object Basic information of user
- - id string ID
- - personId string Person ID
- - stageId string Stage, only domestic version of express is
Parameter Name Type Description
valid.
- - buildingId string Building ID
- - unitId string Unit
- - roomId string Room ID
- - firstName string First name
- - lastName string Last name
- - departmentId string Department ID
- - pictureData string Picture data, face picture
- - gender string Gender, 0—female, 1—male
Card type, 0—common, 1—blacklist, 2—
- - cardType string
visitor, 3—patrol, 4—VIP
- - status string Status, 0—on the job, 1—quit
- - householder string Householder, 0—no, 1—yes
- - authority string Administrator, 0—no, 1—yes
- details object User details
- - tel string Phone number
- - email string Email
ID type, 0—ID card, 1—military officer ID
- - idType string card, 2—student ID card, 3—driving license,
4—passport, 5—tax identification number
- - idNum string ID number
Marital status, 0—confidential, 1—married,
- - maritalStatus string
2—single
- - nationalityId string Reference nationality ID
- - birthday string Birthday
Degree, 0—no, 1—primary school, 2—junior
middle school, 3—senior middle school, 4—
- - degree string
Bachelor, 5—Master, 6—Doctor, 7—
Professor
- - initialTime string Start time(second)
- - expireTime string Expiration time(second)
- - address string Address
- - remark string Notes
- - useTimes string 200 by default
Nick name (used for address book
- - nickName string
distribution)
- - position string Position
- - companyName string Company name
User-related authentication, access card and
fingerprint information. One card and
- authentication object
multiple fingerprints can be associated for a
user.
Parameter Name Type Description
- - password string Password
- - carportAmount string Carport amount for user
- - cards object Cards information
- - - cardNo string Card No.
- - - issueDate string Card issue date
Card state, –1—unknown, 0—normal, 1—
reported for loss, 2—canceled, 4—frozen,
- - - cardState string
8—arrearage, 16—overdue, 32—arrearage
in advance
- - - changeDate string Change date
- - - duressFlag string Duress or not, 0—no, 1—yes
Master card or not (Generation 1 card), 0—
- - - masterFlag string
no, 1—yes
- - cars object Cars information
- - - carNo string License plate number
Car permission, 1—blacklist, 2—whitelist; 2
- - - carRight string
by default
Car group, 1—no, 3—common, 4—VIP; 1 by
- - - carGroup string
default
- - fingerPrints object Fingerprint information
- - - name string Fingerprint name
- - - masterFlag string Master fingerprint or not, 0—no, 1—yes
- - - threadFlag string Duress or not, 0—no, 1—yes
- - - fingerPrint string Fingerprint code/600 bits
- - facePictures object Face picture
- - infraredFaceCodes object Face feature code
- - accessRight object User-associated permission information
- - - channelIds object Device channel id under user control
- - - doorGroupIds object Door group id under user control
- - - entranceDeviceCodes object Entrance/exit device code
---
object Department associate with door group id
departmentDoorGroupIds

Notes

– For more returned error codes, see the error code description on the home page

4.24.3、Import one-card user information in batches

Brief description:

• Import one-card user information in batches. The platform

sends the import progress asynchronously through MQ. For
the MQ, see: Notification on the progress of importing
all-in-one card user information in batches

Request URL:

• /OBMS/accessControl/persons/import?token={token}&locale={l
ocale}
• X-Subject-Token: {token}

Request example

POST /OBMS/accessControl/persons/import?token=47e0e1a962564a4ebbe7fc1
8d8ef7ba8&locale=zh HTTP/1.1
Host: 10.35.94.111
Content-Type: multipart/form-data
MIME-Version: 1.0
Connection: Keep-Alive
Accept-Encoding: gzip, deflate
Accept-Language: zh-CN,en,*
Content-Disposition: form-data; name="multipartFile"; filename="Perso
nInfo.zip"
Parameter Name Type Description
locale string International, such as zh,en
token string The token obtained when logging in

Request method:

• POST

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"session": "87ea776e30bc491a887ef7b88f5fca4d"
}
}
Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- session string Session ID

Notes

– For more returned error codes, see the error code description on the home page

4.24.4、Export information of one-card user

Brief description:

• Export information of one-card user

Request URL:

• /OBMS/accessControl/person/exportUserInfo?deptCode={deptCo
de}&local={local}
• X-Subject-Token: {token}

Request example

GET /OBMS/accessControl/person/exportUserInfo?deptCode=001002&local=e
n HTTP/1.1
Host: 10.33.68.138
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 4aebec19cc3b49fa8bdc6fd447e4fd79
Parameter Name Type Description
deptCode string Department code, such as 001
local string International, such as zh,en
token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:

None
Return example

{
"code": 1000,
"desc": "Success",
"data": {
"session": "115364b433434a93ae052e29098e1ca5",
"fileUrl": "679dc0e36b6fc93afdc9d04444c17718b17cbd6d6d2b72e35
8c1c2624ac6099eb022003264d8bb101d0a75323a785f49"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- session string Session ID
- fileUrl string AES-encrypted file URL

Notes

– For more returned error codes, see the error code description on the home page

4.24.5、Get person count in database

Brief description:

• Get person count in database

Request URL:

• /OBMS/accessControl/personCount
• X-Subject-Token: {token}

Request example

GET /OBMS/accessControl/personCount HTTP/1.1

Request method:
• GET

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"personCount": "2"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- personCount string Person count in database

Notes

– For more returned error codes, see the error code description on the home page

4.25、Visitor Management

4.25.1、Search visitor list by pages

Brief description：

• Search the visitor list by paging (in appointments and

visiting)

Request URL：

• /OBMS/visitors/visitor/page?status={status}&key={key}&time
Type={timeType}&endTime={endTime}&startTime={startTime}&
page={page}&pagesize={pagesize}
• X-Subject-Token: {token}
Request example

GET /OBMS/visitors/visitor/page?status=-1&key=&timeType=0&endTime=156
8995200&startTime=1568822400&page=1&pagesize=20 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: b231ee5551ee40609bbf875680b1cb81
Parameter
Type Description
Name
Visitor status: 0 - In appointments, 1 - Visiting, -1 -
status string
Unlimited
Search keyword of visitor name, contact number, email
key string address, ID card number, visitor card number, visitee
name, home organization of the visitee
Time type: 0 - Visiting time in appointments, 1 - Visiting
timeType string
time, -1 - Unlimited
endTime string End time (s)
startTime string Start time (s)
page string Search start page, minimum: 1
Number of records per page, minimum: 1, maximum:
pagesize string
256
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"visitorId": "2",
"status": "1",
"visitorName": "lisi",
"visitorOrgName": "zga",
"visitedName": "test",
"visitedOrgName": "sec",
"idType": "0",
"idNum": "356521198511254789",
"tel": "19855556666",
"email": "[email protected]",
"expectArrivalTime": "1568977811",
"arrivalTime": "1568977246",
"expectLeaveTime": "1569070751",
"leaveTime": null,
"reason": "dela",
"remark": "180",
"personId": "99999999",
"authInfo": {
"cardNo": "00896547",
"facePicture": null,
"cardIssueTime": "1568908800",
"cardUpdateTime": "1568908800",
"channelIds": [
"1000034$7$0$0"
]
}
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- pageData object Visitor information
- - visitorId string Visitor ID
- - status string Visitor status: 0 - In appointments, 1 - Visiting
- - visitorName string Visitor name
- - visitorOrgName string Home organization of the visitor
- - visitedName string Visitee name
Parameter
Type Description
Name
--
string Home organization of the visitee
visitedOrgName
Identity document type, 0 - ID card, 1 - Military
officer ID card, 2 - Student ID card, 3 - Driving
- - idType string
license, 4 - Passport, 5 - Tax identification number,
6 - Others
- - idNum string ID card number
- - tel string Contact number
- - email string Email address
--
string Visiting time in appointments (s)
expectArrivalTime
- - arrivalTime string Actual visiting time (s)
--
string Leaving time in appointments (s)
expectLeaveTime
- - leaveTime string Actual leaving time (s)
- - reason string Visiting reason
- - remark string Remarks
- - personId string Associated personnel ID
- - authInfo object Authorization information
- - - cardNo string Card number
- - - facePicture string Face data
---
string Card issue time (s)
cardIssueTime
---
string Card modification time (s)
cardUpdateTime
- - - channelIds object Channel code
- nextPage string Next page, -1 - no next page
- totalCount string Total number of records

Notes

• For more returned error codes, see the error code

description on the home page

4.25.2、Search number of existing visitors

Brief description：

• Search number of existing visitors

Request URL：

• /OBMS/visitors/visitor/total/visiting
• X-Subject-Token: {token}

Request example

GET /OBMS/visitors/visitor/total/visiting HTTP/1.1

Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: b231ee5551ee40609bbf875680b1cb81
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"total": "10"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- total string Number of existing visitors

Notes

• Formore returned error codes, see the error code

description on the home page
4.25.3、Export visitors

Brief description：

• Exportthe visitor list (in appointments and visiting).

The platform sends the progress and download address
asynchronously through MQ. For the MQ, see: Visitor list
export progress notification

Request URL：

• /OBMS/visitors/visitor/export?exportType={exportType}&key=
{key}&local={local}&status={status}&timeType={timeType}&
endTime={endTime}&startTime={startTime}
• X-Subject-Token: {token}

Request example

GET /OBMS/visitors/visitor/export?exportType=xlsx&key=&local=zh&statu
s=-1&timeType=0&endTime=1568995200&startTime=1568822400 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: b231ee5551ee40609bbf875680b1cb81
Parameter
Type Description
Name
exportType string Export file type, only .xlsx is supported at present
Search keyword of visitor name, contact number, email
key string address, ID card number, visitor card number, visitee
name, home organization of the visitee
local string International, such as zh and en
Visitor status: 0 - In appointments, 1 - Visiting, -1 -
status string
Unlimited
Time type: 0 - Visiting time in appointments, 1 - Visiting
timeType string
time, -1 - Unlimited
endTime string End time (s)
startTime string Start time (s)
token string The token obtained when logging in

Request method：

• GET

Request example

Null
Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"session": "1568977379206"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- session string Session ID

Notes

• Formore returned error codes, see the error code

description on the home page

4.25.4、Search history visitor by pages

Brief description：

• Searchthe visiting record list by paging (left and

appointment canceled)

Request URL：

• /OBMS/visitors/history/record/page?cardNo={cardNo}&email={
email}&visitedOrgName={visitedOrgName}&visitedName={visi
tedName}&visitorName={visitorName}&idNum={idNum}&status=
{status}&tel={tel}&startTime={startTime}&endTime={endTim
e}&page={page}&pagesize={pagesize}
• X-Subject-Token: {token}

Request example

GET /OBMS/visitors/history/record/page?cardNo=&email=&visitedOrgName=
&visitedName=&visitorName=&idNum=&status=-1&tel=&startTime=1568908800
&endTime=1568995199&page=1&pagesize=20 HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: b231ee5551ee40609bbf875680b1cb81
Parameter
Type Description
Name
cardNo string Card number
email string Email address
visitedOrgName string Home organization of the visitee
visitedName string Visitee name
visitorName string Visitor name
idNum string ID card number
Visitor status: 2 - End of visiting, 3 - Appointment
status string
canceled, -1 - Unlimited
tel string Contact number
startTime string Start time (s)
endTime string End time (s)
page string Search start page, minimum: 1
Number of records per page, minimum: 1, maximum:
pagesize string
256
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"results": [
{
"visitorId": "1",
"status": "2",
"visitorName": "zhangsan",
"visitorOrgName": "123",
"visitedName": "test",
"visitedOrgName": "sec",
"idType": "0",
"idNum": "362635199506234269",
"tel": "19636548859",
"email": "[email protected]",
"expectArrivalTime": "1568976980",
"arrivalTime": "1568976976",
"expectLeaveTime": "1569070576",
"leaveTime": "1568977133",
"reason": "test",
"remark": "123",
"personId": "99999999",
"authInfo": {
"cardNo": "00156987",
"facePicture": "..."
}
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error code
desc string Result description
data object None
- results object Visiting record information
- - visitorId string Visitor ID
Visitor status: 2 - End of visiting, 3 - Appointment
-- status string
canceled
-- visitorName string Visitor name
-- visitorOrgName string Home organization of the visitor
-- visitedName string Visitee name
--
string Home organization of the visitee
visitedOrgName
Identity document type, 0 - ID card, 1 - Military
officer ID card, 2 - Student ID card, 3 - Driving
- - idType string
license, 4 - Passport, 5 - Tax identification number,
6 - Others
Parameter
Type Description
Name
- - idNum string ID card number
- - tel string Contact number
- - email string Email address
--
string Visiting time in appointments (s)
expectArrivalTime
- - arrivalTime string Actual visiting time (s)
--
string Leaving time in appointments (s)
expectLeaveTime
- - leaveTime string Actual leaving time (s)
- - reason string Visiting reason
- - remark string Remarks
- - personId string Associated personnel ID
- - authInfo object Authorization information
- - - cardNo string Card number
- - - facePicture string Face data

Notes

• For more returned error codes, see the error code

description on the home page

4.25.5、Export history visitors

Brief description：

• Export the list of historical visitors (left and

appointment canceled). The platform sends the progress
and download address asynchronously through MQ. For the
MQ, see: Visiting record list export progress
notification

Request URL：

• /OBMS/visitors/history/record/export?cardNo={cardNo}&tel={
tel}&email={email}&visitorName={visitorName}&visitedName
={visitedName}&visitedOrgName={visitedOrgName}&idNum={id
Num}&status={status}&startTime={startTime}&endTime={endT
ime}&local={local}&exportType={exportType}
• X-Subject-Token: {token}

Request example

GET /OBMS/visitors/history/record/export?cardNo=&tel=&email=&visitorN
ame=&visitedName=&visitedOrgName=&idNum=&status=-1&startTime=15689088
00&endTime=1568995199&local=zh&exportType=xlsx HTTP/1.1
Host: 10.35.93.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: b231ee5551ee40609bbf875680b1cb81
Parameter
Type Description
Name
cardNo string Card number
tel string Contact number
email string Email address
visitorName string Visitor name
visitedName string Visitee name
visitedOrgName string Home organization of the visitee
idNum string ID card number
Visitor status: 2 - End of visiting, 3 - Appointment
status string
canceled, -1 - Unlimited
Start time (s), including visits in appointments and
startTime string
actual visits
End time (s), including visits in appointments and
endTime string
actual visits
local string International, such as zh and en
exportType string Export file type, only .xlsx is supported at present
token string The token obtained when logging in

Request method：

• GET

Request example

Null

Parameters：

Null

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"session": "1568977396069"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- session string Session ID

Notes

• For more returned error codes, see the error code

description on the home page

4.26、Log Management

4.26.1、Access Control Log Search

Brief description:

• Access control log search

Request URL:

• /admin/API/log/accessControl
• X-Subject-Token: {token}

Request example

POST /admin/API/log/accessControl HTTP/1.1

Host: 10.35.93.21
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 5139d145f62e44c4af2afa4936233b94
Parameter Name Type Description
token string The token obtained when logging in

Request method:

• POST

Request example

{
"cardNum": "",
"queryType": "0",
"departmentId": "001",
"subeventType": "",
"eventType": "",
"personName": "",
"personNum": "",
"beginTime": "1541779200",
"endTime": "1541865599",
"channelIds": [
"1000029$7$0$0",
"1000038$7$0$0",
"1000038$7$0$1"
],
"page": "1",
"pagesize": "20"
}

Parameters:

Parameter
Type Description
Name
cardNum string Card No.
0-search by channelIds(channelIds not empty,
queryType string personNum optional),1-search by person(channelIds
empty, personNum not empty)
departmentId string Department ID
subeventType string Event subtype
eventType string Event type, all by default
personName string Person name
personNum string Person ID
beginTime string Start time(second)
endTime string End time(second)
Channel code, separated by semicolon for multiple
channelIds object
channels
page string First page of search, min. 1
pagesize string Record count per page, min. 1 and max. 256

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"records": [
{
"time": "1541810731",
"carNum": "15451650",
"deviceName": "10.35.93.67",
"alarmCode": "{5BBEAE9A-14D5-40E1-B79B-1FC2836A2FBD}
",
"channelName": "10.35.93.67_1",
"eventType": "5",
"firstName": "",
"lastName": "",
"subeventType": "51",
"personId": "1",
"inOut": "0",
"channelId": "1000029$7$0$0",
"stageId": "",
"buildingId": "",
"unitId": "",
"roomId": ""
}
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- records object None
- - time string Occurrence time(second)
- - carNum string Card No.
- - deviceName string Device name
- - alarmCode string Alarm code
- - channelName string Channel name
- - eventType string Event type
- - firstName string Last name of the cardholder
- - lastName string First name of the cardholder
- - subeventType string Event subtype
- - channelId string Channel code
- - personId string Person ID
- - inOut string 0-In; 1-Out
- - stageId string stage ID
- - buildingId string building ID
Parameter Name Type Description
- - unitId string unit ID
- - roomId string room ID

Notes

• For more returned error codes, see the error code

description on the home page

4.26.2、Access Control Log Export

Brief description:

• Access Control Log Export

Request URL:

• /admin/API/log/accessControl/export
• X-Subject-Token: {token}

Request example

POST /admin/API/log/accessControl/export HTTP/1.1

Request method:

• POST

Request example

{
"cardNum": "",
"departmentId": "001",
"personNum": "",
"personName": "",
"eventType": "",
"subeventType": "",
"beginTime": "1541779200",
"endTime": "1541865599",
"exportType": "xlsx",
"local": "zh",
"channelIds": [
"1000029$7$0$0",
"1000038$7$0$0",
"1000038$7$0$1"
]
}

Parameters:

Parameter Name Type Description

cardNum string Card No.
departmentId string Department ID
personNum string Person ID
personName string Person name
eventType string Event type, all by default
subeventType string Event subtype, all by default
beginTime string End time(second)
endTime string Start time(second)
exportType string Export type, only xlsx is supported
local string Internationalization, like: zh; en
channelIds object Channel code

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"fileUrl": "/upload/admin/alarm/acControlLog/11542331795136.x
lsx"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- fileUrl string File download address

Notes

• For more returned error codes, see the error code

description on the home page
4.26.3、Export call logs

Brief description：

• Export call logs

Request URL：

• /admin/API/log/vtalk/export
• X-Subject-Token: {token}

Request example

POST /admin/API/log/vtalk/export HTTP/1.1

Host: 172.22.151.12
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 4f32d92d06fa4e608a1d3f9e7be91898
Parameter Name Type Description
token string The token obtained when logging in

Request method：

• POST

Request example

{
"exportType": "xlsx",
"local": "zh",
"beginTime": "1542297600",
"endTime": "1542383999",
"deviceCodes": [
"1000767",
"1000769"
]
}

Parameters：

Parameter Name Type Description

exportType string Export file type, only .xlsx supported at present
local string International, such as zh and en
beginTime string Start time (s)
endTime string End time (s)
deviceCodes object Call device code
Return example

{
"code": 1000,
"desc": "Success",
"data": {
"fileUrl": "/upload/admin/alarm/callLog/11542353515899.xlsx"
}
}

Description of return parameters

Parameter Name Type Description

code int Error code
desc string Result description
data object None
- fileUrl string File download address

Notes

• For more returned error codes, see the error code

description on the home page

4.27、Record Plan

4.27.1、Getting Time Template List

Brief description:

• To get time template list

Request URL:

• /admin/API/record/timeScheduleTemplates?page={page}&pagesi
ze={pagesize}
• X-Subject-Token: {Token}

Request example

GET /admin/API/record/timeScheduleTemplates?page=1&pagesize=100 HTTP/

1.1
Host: 10.35.120.198
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 19e65c8e2ff04249b67430264f2d96cf
Parameter
Type Description
Name
Parameter
Type Description
Name
page string First page of search, min.1, 1 by default
Record count per page, min.1 and max.256, 32 by
pagesize string
default
Token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "1",
"name": "All-Period Template",
"type": "1"
},
{
"id": "2",
"name": "Business Day Template",
"type": "1"
},
{
"id": "3",
"name": "Weekend Template",
"type": "1"
},
{
"id": "4",
"name": "886868",
"type": "2"
},
{
"id": "5",
"name": "1212",
"type": "2"
},
{
"id": "6",
"name": "1234",
"type": "2"
}
],
"nextPage": "-1",
"totalCount": "6"
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
- pageData object None
- - id string Time template ID
- - name string Time template name
Time template type, 1-default template, 2-
- - type string
customized template
- nextPage string Next page, -1 means no next page
- totalCount string Total counts

Notes

– For more returned error codes, see the error code description on the home page

4.27.2、Getting Time Template

Brief description:

• Get time template.

Request URL:

• /admin/API/record/timeScheduleTemplate/{id}
• X-Subject-Token: {Token}
Request example

GET /admin/API/record/timeScheduleTemplate/6 HTTP/1.1

Host: 10.35.120.198
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 19e65c8e2ff04249b67430264f2d96cf
Parameter Name Type Description
id string Time template ID
Token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "6",
"name": "1234",
"type": "2",
"startTime": "1563292800",
"endTime": "1576512000",
"mon": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"tue": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"wed": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"thu": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"fri": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"sat": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"sun": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
]
}
}

Description of return parameters

Parameter
Type Description
Name
code int Error Code
desc string Result description
data object None
- id string Time template ID
- name string Template name, required, not more than 64 bytes.
Time template type, 1-default template, 2-added
- type string
template.
Parameter
Type Description
Name
Start time (optional). Null means starting from the
- startTime string
current time. Timestamp (unit: second).
End time (optional). Null means forever. Timestamp
- endTime string
(unit: second).
- mon object Monday
- - beginTime string Start time
- - endTime string End time
- tue object Tuesday
- - beginTime string Start time
- - endTime string End time
- wed object Wednesday
- - beginTime string Start time
- - endTime string End time
- thu object Thursday
- - beginTime string Start time
- - endTime string End time
- fri object Friday
- - beginTime string Start time
- - endTime string End time
- sat object Saturday
- - beginTime string Start time
- - endTime string End time
- sun object Sunday
- - beginTime string Start time
- - endTime string End time

Notes

– For more returned error codes, see the error code description on the home page

4.27.3、Getting Record Plan List

Brief description:

• Get record plan list.

Request URL:

• /admin/API/record/recordSchedules?page={page}&pagesize={pa
gesize}
• X-Subject-Token: {Token}

Request example
GET /admin/API/record/recordSchedules?page=1&pagesize=100 HTTP/1.1
Host: 10.35.120.198
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 19e65c8e2ff04249b67430264f2d96cf
Parameter
Type Description
Name
page string First page of search, min.1, 1 by default
Record count per page, min.1 and max.256, 32 by
pagesize string
default
Token string The token obtained when logging in

Request method:

• GET

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"pageData": [
{
"id": "1",
"mode": "start",
"name": "1000000$1$0$0",
"videoStream": "main",
"timeScheduleTemplate": "1",
"timeScheduleTemplateName": "All-Period Template",
"channelId": "1000000$1$0$0",
"desc": "test32",
"storagePosition": "1"
}
],
"nextPage": "-1",
"totalCount": "1"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object None
- pageData object None
- - id string Configure record plan ID
- - mode string Start/Stop template
- - name string Record plan name
Stream (required), Main-main stream,
- - videoStream string
sub-sub stream 1, third-sub stream 2
- - timeScheduleTemplate string Time template ID
--
string Time template name
timeScheduleTemplateName
- - channelId string Channel code
- - desc string Description of record plan
Storage location, 1-server, 3-Stored in
- - storagePosition string
the device
- nextPage string Next page, -1 means no next page
- totalCount string Total counts

Notes

– For more returned error codes, see the error code description on the home page

4.27.4、Setting Record Plan Status

Brief description:

• Set record plan status.

Request URL:

• /admin/API/record/recordSchedule/status
• X-Subject-Token: {Token}

Request example

POST /admin/API/record/recordSchedule/status HTTP/1.1

Request method:

• POST

Request example

{
"id": "2",
"status": "1"
}

Parameters:

Parameter Name Type Description

id string Record plan ID
status string Previous record plan status, 1-enabled,0-disabled

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page

4.27.5、Modifying Record Plan

Brief description:

• Modify record plan.

Request URL:

• /admin/API/record/recordSchedule/{id}
• X-Subject-Token: {Token}
Request example

PUT /admin/API/record/recordSchedule/2 HTTP/1.1

Host: 10.35.120.198
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 19e65c8e2ff04249b67430264f2d96cf
Parameter Name Type Description
id string Record plan ID
Token string The token obtained when logging in

Request method:

• PUT

Request example

{
"storagePosition": "1",
"timeScheduleTemplate": "1",
"channelId": "1000000$1$0$0",
"mode": "start",
"videoStream": "main",
"desc": "test32"
}

Parameters:

Parameter Name Type Description

Storage location (required), 1-server; 3-Stored in
storagePosition string
the device
timeScheduleTemplate string Time template ID (required).
Channel code; separated by commas if there are
channelId string
multiple channel codes.
mode string Start/Stop template (required)
Stream (required). Main-main stream, sub-sub
videoStream string
stream 1; third-sub stream 2.
Description of record plan, not more than 256
desc string
bytes (optional).

Return example

{
"code": 1000,
"desc": "Success"
}
Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page

4.27.6、Creating Record Plan

Brief description:

• Create record plan.

Request URL:

• /admin/API/record/recordSchedule
• X-Subject-Token: {Token}

Request example

POST /admin/API/record/recordSchedule HTTP/1.1

Request method:

• POST

Request example

{
"storagePosition": "1",
"timeScheduleTemplate": "3",
"channelId": "1000000$1$0$0",
"mode": "start",
"videoStream": "main",
"desc": "test"
}

Parameters:
Parameter Name Type Description
Storage location (required), 1-server; 3-Stored in
storagePosition string
the device
timeScheduleTemplate string Time template ID (required).
Channel code; separated by commas if there are
channelId string
multiple channel codes.
mode string Start/Stop template (required)
Stream (required). Main-main stream, sub-sub
videoStream string
stream 1; third-sub stream 2.
Description of record plan, not more than 256
desc string
bytes (optional).

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "2"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
data object none
- id string Configure record plan ID

Notes

– For more returned error codes, see the error code description on the home page

4.27.7、Deleting Record Plan

Brief description:

• Delete record plan

Request URL:

• /admin/API/record/recordSchedule?ids={ids}
• X-Subject-Token: {Token}

Request example
DELETE /admin/API/record/recordSchedule?ids=1,2 HTTP/1.1
Host: 10.35.120.198
Connection: close
Content-Type: application/json;charset=UTF-8
X-Subject-Token: 19e65c8e2ff04249b67430264f2d96cf
Parameter Name Type Description
ids string Record plan ID
Token string The token obtained when logging in

Request method:

• DELETE

Request example

Empty

Parameters:

None

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page

4.27.8、Deleting Time Template

Brief description:

• Delete time template.

Request URL:

• /admin/API/record/timeScheduleTemplate/{id}
• X-Subject-Token: {Token}
Request example

DELETE /admin/API/record/timeScheduleTemplate/6 HTTP/1.1

Request method:

• DELETE

Request example

Empty

Parameters:

None

Return example

Successful
{
"code": 1000,
"desc": "Success"
}
Failed.
{
"code": 6037,
"desc": "current timeTemplate is occupied by others",
"data": {
"templateName": "1212",
"storagePlanChnIds": [
"1000000$1$0$0"
]
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
Parameter Name Type Description
data object none
- templateName string Time template name
- storagePlanChnIds object Record plan channel codes
- alarmPlanDevChnIds object Alarm scheme device/channel codes
- backStoragePlanChnIds object Record sync plan channel codes
- multiCardChnIds object Multi-card configuration channel code
- antiPassBackNames object Anti passback configuration name
- interDoorLockNames object Multi-door interlock configuration name
- firstCardChnIds object First card configuration channel code
- Remote door-opening verification
object
remoteVerificationChnIds configuration channel codes
- doorConfigChnIds object Door basic configuration channel codes
- doorGroupNames object Door group configuration name

Notes

– For more returned error codes, see the error code description on the home page

4.27.9、Creating Time Template

Brief description:

• Create time template.

Request URL:

• /admin/API/record/timeScheduleTemplate
• X-Subject-Token: {Token}

Request example

POST /admin/API/record/timeScheduleTemplate HTTP/1.1

Request method:

• POST

Request example
{
"name": "121233",
"mon": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"tue": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"wed": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"thu": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"fri": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"sat": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"sun": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
]
}

Parameters:

Parameter Name Type Description

name string Template name, required, not more than 64 bytes.
mon object Monday
- beginTime string Start time
- endTime string End time
tue object Tuesday
- beginTime string Start time
- endTime string End time
wed object Wednesday
- beginTime string Start time
- endTime string End time
thu object Thursday
- beginTime string Start time
- endTime string End time
fri object Friday
- beginTime string Start time
- endTime string End time
sat object Saturday
- beginTime string Start time
- endTime string End time
sun object Sunday
- beginTime string Start time
- endTime string End time

Return example

{
"code": 1000,
"desc": "Success",
"data": {
"id": "6"
}
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description
Parameter Name Type Description
data object none
- id string Time template ID

Notes

– For more returned error codes, see the error code description on the home page

4.27.10、Modifying Time Template

Brief description:

• Modify time template.

Request URL:

• /admin/API/record/timeScheduleTemplate/{id}
• X-Subject-Token: {Token}

Request example

PUT /admin/API/record/timeScheduleTemplate/6 HTTP/1.1

Request method:

• PUT

Request example

{
"name": "823",
"oldName": "1234",
"mon": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"tue": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"wed": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"thu": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"fri": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"sat": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
],
"sun": [
{
"beginTime": "09:00:00",
"endTime": "16:00:00"
}
]
}

Parameters:

Parameter Name Type Description

name string Template name, required, not more than 64 bytes.
oldName string Previous template name
mon object Monday
- beginTime string Start time
- endTime string End time
Parameter Name Type Description
tue object Tuesday
- beginTime string Start time
- endTime string End time
wed object Wednesday
- beginTime string Start time
- endTime string End time
thu object Thursday
- beginTime string Start time
- endTime string End time
fri object Friday
- beginTime string Start time
- endTime string End time
sat object Saturday
- beginTime string Start time
- endTime string End time
sun object Sunday
- beginTime string Start time
- endTime string End time

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page

4.27.11、Copying Record Plan

Brief description:

• Copy record plan.

Request URL:

• /admin/API/record/recordSchedule/copy
• X-Subject-Token: {Token}

Request example

POST /admin/API/record/recordSchedule/copy HTTP/1.1

Request method:

• POST

Request example

{
"id": "2",
"channelId": [
"1000000$1$0$0"
]
}

Parameters:

Parameter Name Type Description

id string Copied record plan ID
channelId object Channel code the record plan is copied to

Return example

{
"code": 1000,
"desc": "Success"
}

Description of return parameters

Parameter Name Type Description

code int Error Code
desc string Result description

Notes

– For more returned error codes, see the error code description on the home page
5、Dictionary Definition
5.1、Manufacture type

Value Type
1 Intelbras
2 Hikvision
3 Others

5.2、Device type

5.3、Unit type

Value Type
1 Encoding unit
2 Decoding output
3 Alarm input
4 Alarm output
7 A&C unit
8 Voice unit
11 POS unit
12 Virtual unit, used for a single radar
15 LED unit
16 CVI alarm unit
17 Alarm box subunit

5.4、Camera Type

Value Type
1 Bullet camera
2 Speed dome camera
3 Dome camera

Value Type
1 First generation of general access control device type
2 First generation of centralized controller type
3 First generation of face recognition terminals type
5 Second generation of access control device type

5.7、License plate color

Value Type
0 Blue
1 Yellow
2 White
3 Black
4 Green
99 License plate color: unrecognized
100 Other colors

5.8、Alarm type

Value Type
1 Video loss
2 External alarm
3 Motion detection
4 Video tampering
5 Hard disk full
6 Hard disk error
7 Optical fiber alarm
8 GPS information
9 3G
10 Device recording status
11 Device name
12 Hard disk information
13 Channel disconnected
16 Device disconnected
17 Mains powersupply interruption alarm
18 Mains powersupply enabling alarm
19 Infrared detection alarm
20 Gas concentration above the upper limit
21 Instantaneous flow above the upper limit
22 Pipe temperature above the upper limit
Value Type
23 Pipe temperature above the lower limit
24 Pressure above the upper limit
25 Pressure above the lower limit
28 Remote external alarm
41 Duress alarm
42 Legal password unlocking
43 Illegal password unlocking
45 Legal fingerprint unlocking
46 Illegal fingerprint unlocking
Remote unlocking: indoor monitor unlocking or remote platform
48
unlocking
49 Button unlocking
51 Legal card swiping
52 Illegal card swiping
53 Door contact
54 Abnormal unlocking
55 Abnormal locking
56 Normal locking
57 Normal unlocking
58 Patrol timeout
59 A&C intercom
61 Timeout level 1
62 Timeout level 2
63 Timeout level 3
64 Timeout level 4
65 Timeout level 5
72 Timeout alarm
81 Arm
82 Fire alarm
83 No arm
84 Out of battery
85 Mains failure
88 Prisoner escape
89 Violent jailbreak of the prisoner
90 Target attacked
91 Natural disaster
92 One-tap alarm
109 Power grid shock
110 Power grid power failure
111 Power grid short-circuit
Value Type
112 Power grid failure
113 Low voltage on the power grid
115 Power grid open-circuit
116 Power grid sensor alarm
151 Fire pre-alarm
201 Overspeed alarm generation
202 Overspeed alarm clearance
203 Driving out of the driving zone
204 Driving into the driving zone
205 Driving out of the forbidden zone
206 Driving into the forbidden zone
207 Driving out of the departure area
208 Driving into the departure area
209 Driving out of the arrival area
210 Driving into the arrival area
211 Overload
212 Hard braking
213 3G traffic
214 ACC power failure alarm
215 Low speed
216 High speed
217 Upload of mobile customized information
218 Download of mobile customized information
229 Voice request for alarms on the device
230 Power failure alarm
231 Route offset alarm
232 Alarm for tire pressure detection
233 Fatigue driving
234 Driver sign-in
235 Driver sign-out
236 Oil level too low
237 Timely upload of fuel consumption information
238 Driving into the station
239 Driving out of the station
240 ACC power connection alarm
241 Driving out of the departure station
244 Alarm for parking timeout
259 Illegally driving into the speed-limit zone
260 Illegally driving out of the speed-limit zone
261 Driving into the driving zone
Value Type
262 Illegally driving out of the driving zone
263 Illegally driving into the forbidden zone
264 Illegally driving out of the forbidden zone
265 Illegally driving into the loading zone
266 Illegally driving out of the loading zone
267 Illegally driving into the unloading zone
268 Illegally driving out of the unloading zone
269 Illegally driving into the station
270 Illegally driving out of the station
271 Device relogin alarm
301 All intelligent alarms
302 Tripwire
303 Intrusion
304 Violation sticker detection
305 Abandoned object
306 Strand detection
307 Loitering detection
308 Object preservation
309 Fast moving
310 Tailing detection
311 People gathering
312 Fire detection
313 Smoke alarm
314 Violence detection (fighting)
315 Traffic flow statistics
316 Passenger flow alarm
317 Camera shielded
318 Camera moved
319 Abnormal video
320 Video damaged
321 Traffic control
322 Traffic accidents
323 Intersection rules
324 ANPR rules
325 Traffic snapshot event
326 Face detection event
327 Traffic congestion event
564 Illegal parking
574 Abnormal running
575 Wrong-way driving detection
Value Type
577 Object moved
578 Parking detection
579 Face recognition
585 Intelligent external alarm
586 Rise detection
587 Crossing fence
594 Abnormal voice detection
596 Climbing up detection
597 Off-duty detection
665 Scene Changing
675 Fall Detection
826 Area people number alarm
886 People Approaching Detection
897 Alarm snapshot
898 Timely snapshot
899 Client snapshot
901 Abnormal face event
902 Adjacent face
962 People crossing the warning line
963 Vehicles crossing the warning line
964 People crossing the area
965 Vehicles crossing the area
1110 Overspeed
1201 High temperature alarm
1202 Raid degradation
1203 Automatic server migration
1204 Manual server migration
1205 Server status change
1206 Host switched to backup for hot backup
1207 Backup switched to host for hot backup
1208 Abnormal backup for hot backup
1209 Abnormal backup recovery for hot backup
1433 Restricted list alarm
1446 Alarm of excessive use of an illegal card
1500 Diagnosis video loss
1501 High brightness alarm
1502 Red alarm for high brightness
1503 Low brightness alarm
1504 Red alarm for low brightness
1505 Contrast alarm
Value Type
1506 Red alarm for contrast
1507 Clarity alarm
1508 Red alarm for clarity
1509 Color offset alarm
1510 Red alarm for color offset
1511 Diagnosis failure
1700 Mains powersupply interruption alarm
1701 Mains powersupply enabling alarm
1702 Infrared detection alarm
1703 Gas concentration
1704 Instantaneous flow
1705 Exceeding threshold of pipe temperature
1706 Exceeding threshold of pipe pressure
1801 Infrared radiation alarm
1802 Smoke alarm
1803 Water immersion alarm
1804 Compression failure alarm
1805 Overload alarm
1806 Abnormal bus alarm
1807 Life alarm
1808 Sound alarm
1809 Time alarm
1810 Flow loss alarm
1811 Fusing alarm
1812 Power-off alarm
1813 Leaking alarm
1814 Jam-up alarm
1815 Timeout alarm
1816 Reverse order alarm
1817 Networking failure alarm
1818 Unit code loss alarm
1819 Alarm for unit code mismatching
1820 Failure alarm
1821 Unknown alarm
1822 Customized alarm
1823 No-authority alarm
1824 Infrared dual - technology alarm
1825 Electronic fence alarm
1826 Normal mains abnormal mains
1827 Normal battery abnormal battery
Value Type
1828 Normal UPS input bypass power supply
1829 Normal UPS abnormal UPS
1830 UPS type is online UPS or off-line UPS
1831 Small vehicle
1832 Circuit breaker
1833 Isolated breaker switch
1834 Earthing breaker switch
1850 A&C controller switch alarm
1851 UPS switch alarm
1852 Power distribution cabinet switch alarm
1853 Air conditioning switch alarm
1854 DC power switch alarm
1855 Light controller switch alarm
1856 Fan controller switch alarm
1857 Pump switch alarm
1858 Breaker switch alarm
1859 Relay switch alarm
1860 Electric meter switch alarm
1861 Transformer switch alarm
1862 Sensor switch alarm
1863 Rectifier switch alarm
1864 Inverter switch alarm
1865 Pressure switch alarm
1866 Shutdown switch alarm
1867 Siren switch alarm
1881 Temperature alarm
1882 Humidity alarm
1883 Concentration alarm
1884 Wind speed alarm
1885 Capacity alarm
1886 Voltage alarm
1887 Current alarm
1888 Capacitance alarm
1889 Resistance alarm
1890 Conductance alarm
1891 Inductance alarm
1892 Charge alarm
1893 Frequency alarm
1894 Light intensity alarm
1895 Press alarm
Value Type
1896 Pressure alarm
1897 Heat transfer alarm
1898 Thermal conduction alarm
1899 Volume heat alarm
1900 Heat-work alarm
1901 Power alarm
1902 Permeability alarm
1903 Proportion
1904 Electrical energy
1907 Intercom
1909 Abnormal input alarm
1916 NVR no disk alarm
1917 Abnormal dual control version alarm
1918 Cluster switch alarm
1921 Record frame loss alarm
1924 Abnormal storage pool alarm
1925 RAID alarm
1926 Shared service alarm
1998 Intensity change alarm
2001 Dialing
2002 Answering
2200 Door contact
2201 Passive infrared
2202 Gas sensor
2203 Active infrared
2204 Glass break
2205 Emergency switch
2206 Vibration
2207 Dual - technology (infrared + microwave)
2208 Triple - technology
2209 Call button
2210 Others
2211 Fatigue driving
2501 Both people and lock
2502 People without lock
2503 Lock without people
2504 Neither people nor lock
2505 Locking timeout
2506 Emergence call
2602 Switching value alarm
Value Type
2603 Switch box alarm
2604 Vibration fiber defense area disabled
2605 Fiber signal source off
2606 Fiber break
3002 Jailbreak alarm
3003 Violent jailbreak alarm
3004 Attacking alarm
3005 Disaster alarm
3006 Bullet box alarm
3007 Other alarms
3131 Virtual wall
3132 Property protection
3133 Video quality inspection
3134 Region protection
3135 On-duty detection
3136 License plate recognition
3137 Violence detection
3138 Dual people on-duty
3139 People and vehicle classification
3140 People Counting
3141 Tour video diagnosis
3142 Dump truck recognition
3143 Non-motor vehicle detection
3144 Electronic police
3145 Alarm input channel - warning zone event
3146 Alarm input channel - face detection and recognition
3147 Alarm input channel - rise detection
3148 Alarm input channel - warning line event
3149 Alarm input channel - wander event
3150 Alarm input channel - detection of driving on yellow line
3151 Alarm input channel - wrong-way driving detection
3152 Alarm input channel - running red light detection
3153 Alarm input channel - patrol detection
3154 Alarm input channel - ANPR detection
4205 Non-internal vehicle
4300 Door contact
4301 Passive infrared
4302 Gas sensor
4303 Smoke sensing
4306 Glass break
Value Type
4307 Emergency switch
4308 Vibration
4309 Dual - technology (infrared + microwave)
4310 Triple - technology
4311 Temperature
4312 Humidity
4313 Wind speed
4314 Call button
4315 Gas pressure
4316 Gas concentration
4317 Gas flow
4319 Oil level detection, gasoline and diesel oil detection for vehicles
4320 Mileage detection
4321 Emergency button
4322 Theft
4323 IVS rule
4324 Dismantlement prevention
4325 Doorbell
4326 Key alarm
4327 Alarm for low voltage of lock
4328 Lock dismantlement prevention alarm
4329 Lock duress alarm
4401 High load of disk read/write
4402 Abnormal disk
4402 Disk detection alarm
4403 Disk disconnection
4404 No disk
4405 Failed to obtain device stream
4501 Restricted list alarm of ANPR at entrance and exit
4503 Low card alarm
4504 No card alarm
4505 Full card alarm
4506 Vehicle detector disconnection alarm
4507 Induction coil disconnection alarm
4508 LED disconnection alarm
4509 Swiping card device disconnection alarm for panel
4510 Swiping card device disconnection alarm for card issuing
4511 Talkback event alarm
Abnormal temperature alarm at temperature measuring point of
5120
thermal imaging
Value Type
5121 Forest fire prevention alarm: fire point alarm by thermal imaging
5122 Fire alarm report by thermal imaging
5123 Temperature alarm: above temperature threshold
5124 Temperature alarm: below temperature threshold
5125 Temperature difference alarm based on measurement rule
5126 Smoke alarm by thermal imaging
5127 Human fever warning by thermal imaging
8001 Phase voltage Ua
8002 Phase voltage Ub
8003 Phase voltage Uc
8004 Line voltage Uab
8005 Line voltage Ubc
8006 Line voltage Uca
8007 Phase current Ia
8008 Phase current Ib
8009 Phase current Ic
8010 Phase A frequency Fa
8011 Phase B frequency Fb
8012 Phase B frequency Fb
8013 Phase A active power Pa
8014 Phase B active power Pb
8015 Phase C active power Pc
8016 Phase A power factor PFa
8017 Phase B power factor PFa
8018 Phase C power factor PFa
8019 Phase A reactive power Qa
8020 Phase B reactive power Qb
8021 Phase C reactive power Qc
8022 Phase A apparent power Sa
8023 Phase B apparent power Sb
8024 Phase C apparent power Sc
8025 Zero sequence current Io
8026 Three-phase average phase voltage
8027 Three-phase average phase current
8028 Three-phase active power
8029 Three-phase reactive power
8030 Three-phase apparent power
8031 Power factor PF
8032 Frequency F
8033 Positive active energy
Value Type
8034 Positive reactive energy
8035 Phase A input voltage
8036 Phase B input voltage
8037 Phase C input voltage
8038 Phase A output voltage
8039 Phase B output voltage
8040 Phase C output voltage
8041 Phase A input current
8042 Phase B input current
8043 Phase C input current
8044 Phase A output current
8045 Phase B output current
8046 Phase C output current
8047 Phase A output load
8048 Phase B output load
8049 Phase C output load
8050 Positive battery voltage
8051 Negative battery voltage
8052 Positive battery discharge current
8053 Negative battery discharge current
8054 Positive battery charge current
8055 Negative battery charge current
8056 Output frequency
8057 Input frequency
8058 Internal temperature
8059 Battery remaining time
8060 Battery capacity
8061 Inverter supply
8062 Bypass mode
8063 Battery charge status
8064 Mains status
8065 Battery undervoltage
8066 Low battery voltage
8067 High battery voltage
8068 Battery temperature too high
8069 Rectifier failure
8070 Inverter failure
8071 Overload
8072 Self-inspection
8073 UPS failure
Value Type
8074 Temperature too high
8075 Bypass circuit breaker status
8076 Input circuit breaker status
8077 Output circuit breaker status
8078 Input voltage
8079 Output voltage
8080 Failure voltage
8081 Output load
8082 Input frequency
8083 Internal temperature
8084 Batter voltage
8085 Abnormal mains
8086 Low battery voltage
8087 Bypass mode
8088 UPS failure
8089 UPS type
8090 UPS shutdown
8091 Preset temperature
8092 Preset humidity
8093 Ambient temperature
8094 Ambient humidity
8095 Upper limit of temperature
8096 Lower limit of temperature
8097 Upper limit of humidity
8098 Lower limit of humidity
8099 Built-in fan
8100 Compressor 1
8101 Compressor 2
8102 Electric heater 1
8103 Electric heater 2
8104 Dehumidification
8105 Humidification
8106 High temperature alarm
8107 Low temperature alarm
8108 High humidity alarm
8109 Low humidity alarm
8110 Smoke alarm
8111 Fire alarm
8112 Leaking alarm
8113 Air flow alarm
Value Type
8114 Filter alarm
8115 Filter maintenance
8116 Humidifier alarm
8117 Humidifier running timeout
8118 Fan running timeout
8119 Fan overload
8120 Coil frozen alarm
8121 Press probe 1 failure
8122 Press probe 2 failure
8123 Compressor 1 overload
8124 Compressor 2 overload
8125 Compressor 1 high pressure
8126 Compressor 2 high pressure
8127 Compressor 1 low pressure
8128 Compressor 2 low pressure
8129 Heater 1 overload
8130 Heater 2 overload
8131 Cable 1 leaking distance
8132 Cable 2 leaking distance
8133 Cable 1 leaking
8134 Cable 2 leaking
8135 Cable 1 hardware failure
8136 Cable 2 hardware failure
8137 Sensor 1 - temperature
8138 Sensor 1 - humidity
8139 Sensor 1 - temperature below the lower limit
8140 Sensor 1 - temperature above the upper limit
8141 Sensor 1 - humidity below the lower limit
8142 Sensor 1 - humidity above the lower limit
8143 Sensor 2 - temperature
8144 Sensor 2 - humidity
8145 Sensor 2 - temperature below the lower limit
8146 Sensor 2 - temperature above the upper limit
8147 Sensor 2 - humidity below the lower limit
8148 Sensor 2 - humidity above the lower limit
8149 Sensor 3 - temperature
8150 Sensor 3 - humidity
8151 Sensor 3 - temperature below the lower limit
8152 Sensor 3 - temperature above the upper limit
8153 Sensor 3 - humidity below the lower limit
Value Type
8154 Sensor 3 - humidity above the lower limit
8155 Sensor 4 - temperature
8156 Sensor 4 - humidity
8157 Sensor 4 - temperature below the lower limit
8158 Sensor 4 - temperature above the upper limit
8159 Sensor 4 - humidity below the lower limit
8160 Sensor 4 - humidity above the lower limit
8161 Route 1 temperature
8162 Route 2 temperature
8163 Route 3 temperature
8164 Route 4 temperature
8165 Route 5 temperature
8166 Route 6 temperature
8167 Route 7 temperature
8168 Route 8 temperature
8169 Route 9 temperature
8170 Route 10 temperature
8171 Route 11 temperature
8172 Route 12 temperature
8173 Route 13 temperature
8174 Route 14 temperature
8175 Route 15 temperature
8176 Route 16 temperature
8177 Route 1 temperature below the lower limit
8178 Route 1 temperature above the upper limit
8179 Route 2 temperature below the lower limit
8180 Route 2 temperature above the upper limit
8181 Route 3 temperature below the lower limit
8182 Route 3 temperature above the upper limit
8183 Route 4 temperature below the lower limit
8184 Route 4 temperature above the upper limit
8185 Route 5 temperature below the lower limit
8186 Route 5 temperature above the upper limit
8187 Route 6 temperature below the lower limit
8188 Route 6 temperature above the upper limit
8189 Route 7 temperature below the lower limit
8190 Route 7 temperature above the upper limit
8191 Route 8 temperature below the lower limit
8192 Route 8 temperature above the upper limit
8193 Route 9 temperature below the lower limit
Value Type
8194 Route 9 temperature above the upper limit
8195 Route 10 temperature below the lower limit
8196 Route 10 temperature above the upper limit
8197 Route 11 temperature below the lower limit
8198 Route 11 temperature above the upper limit
8199 Route 12 temperature below the lower limit
8200 Route 12 temperature above the upper limit
8201 Route 13 temperature below the lower limit
8202 Route 13 temperature above the upper limit
8203 Route 14 temperature below the lower limit
8204 Route 14 temperature above the upper limit
8205 Route 15 temperature below the lower limit
8206 Route 15 temperature above the upper limit
8207 Route 16 temperature below the lower limit
8208 Route 16 temperature above the upper limit
8209 Kelon UPS input voltage
8210 Kelon UPS output voltage
8211 Kelon UPS failure voltage
8212 Kelon UPS output load
8213 Kelon UPS input frequency
8214 Kelon UPS internal temperature
8215 Kelon UPS battery voltage
8216 Kelon UPS abnormal mains
8217 Kelon UPS low battery voltage
8218 Kelon UPS bypass mode
8219 Kelon UPS failure
8220 Kelon UPS type
8221 Kelon UPS shutdown
8222 Route 1 phase voltage Ua of the quadruple-circuit electric meter
8223 Route 2 phase voltage Ua of the quadruple-circuit electric meter
8224 Route 3 phase voltage Ua of the quadruple-circuit electric meter
8225 Route 4 phase voltage Ua of the quadruple-circuit electric meter
8226 Route 1 phase voltage Ub of the quadruple-circuit electric meter
8227 Route 2 phase voltage Ub of the quadruple-circuit electric meter
8228 Route 3 phase voltage Ub of the quadruple-circuit electric meter
8229 Route 4 phase voltage Ub of the quadruple-circuit electric meter
8230 Route 1 phase voltage Uc of the quadruple-circuit electric meter
8231 Route 2 phase voltage Uc of the quadruple-circuit electric meter
8232 Route 3 phase voltage Uc of the quadruple-circuit electric meter
8233 Route 4 phase voltage Uc of the quadruple-circuit electric meter
Value Type
8234 Route 1 line voltage Uab of the quadruple-circuit electric meter
8235 Route 2 line voltage Uab of the quadruple-circuit electric meter
8236 Route 3 line voltage Uab of the quadruple-circuit electric meter
8237 Route 4 line voltage Uab of the quadruple-circuit electric meter
8238 Route 1 line voltage Ubc of the quadruple-circuit electric meter
8239 Route 2 line voltage Ubc of the quadruple-circuit electric meter
8240 Route 3 line voltage Ubc of the quadruple-circuit electric meter
8241 Route 4 line voltage Ubc of the quadruple-circuit electric meter
8242 Route 1 line voltage Uca of the quadruple-circuit electric meter
8243 Route 2 line voltage Uca of the quadruple-circuit electric meter
8244 Route 3 line voltage Uca of the quadruple-circuit electric meter
8245 Route 4 line voltage Uca of the quadruple-circuit electric meter
8246 Route 1 phase current Ia of the quadruple-circuit electric meter
8247 Route 2 phase current Ia of the quadruple-circuit electric meter
8248 Route 3 phase current Ia of the quadruple-circuit electric meter
8249 Route 4 phase current Ia of the quadruple-circuit electric meter
8250 Route 1 phase current Ib of the quadruple-circuit electric meter
8251 Route 2 phase current Ib of the quadruple-circuit electric meter
8252 Route 3 phase current Ib of the quadruple-circuit electric meter
8253 Route 4 phase current Ib of the quadruple-circuit electric meter
8254 Route 1 phase current Ic of the quadruple-circuit electric meter
8255 Route 2 phase current Ic of the quadruple-circuit electric meter
8256 Route 3 phase current Ic of the quadruple-circuit electric meter
8257 Route 4 phase current Ic of the quadruple-circuit electric meter
8258 Route 1 phase A frequency Fa of the quadruple-circuit electric meter
8259 Route 2 phase A frequency Fa of the quadruple-circuit electric meter
8260 Route 3 phase A frequency Fa of the quadruple-circuit electric meter
8261 Route 4 phase A frequency Fa of the quadruple-circuit electric meter
8262 Route 1 phase B frequency Fb of the quadruple-circuit electric meter
8263 Route 2 phase B frequency Fb of the quadruple-circuit electric meter
8264 Route 3 phase B frequency Fb of the quadruple-circuit electric meter
8265 Route 4 phase B frequency Fb of the quadruple-circuit electric meter
8266 Route 1 phase C frequency Fc of the quadruple-circuit electric meter
8267 Route 2 phase C frequency Fc of the quadruple-circuit electric meter
8268 Route 3 phase C frequency Fc of the quadruple-circuit electric meter
8269 Route 4 phase C frequency Fc of the quadruple-circuit electric meter
Route 1 phase A active power Pa of the quadruple-circuit electric
8270
meter
Route 2 phase A active power Pa of the quadruple-circuit electric
8271
meter
Value Type
Route 3 phase A active power Pa of the quadruple-circuit electric
8272
meter
Route 4 phase A active power Pa of the quadruple-circuit electric
8273
meter
Route 1 phase B active power Pb of the quadruple-circuit electric
8274
meter
Route 2 phase B active power Pb of the quadruple-circuit electric
8275
meter
Route 3 phase B active power Pb of the quadruple-circuit electric
8276
meter
Route 4 phase B active power Pb of the quadruple-circuit electric
8277
meter
Route 1 phase C active power Pc of the quadruple-circuit electric
8278
meter
Route 2 phase C active power Pc of the quadruple-circuit electric
8279
meter
Route 3 phase C active power Pc of the quadruple-circuit electric
8280
meter
Route 4 phase C active power Pc of the quadruple-circuit electric
8281
meter
Route 1 phase A power factor PFa of the quadruple-circuit electric
8282
meter
Route 2 phase A power factor PFa of the quadruple-circuit electric
8283
meter
Route 3 phase A power factor PFa of the quadruple-circuit electric
8284
meter
Route 4 phase A power factor PFa of the quadruple-circuit electric
8285
meter
Route 1 phase B power factor PFb of the quadruple-circuit electric
8286
meter
Route 2 phase B power factor PFb of the quadruple-circuit electric
8287
meter
Route 3 phase B power factor PFb of the quadruple-circuit electric
8288
meter
Route 4 phase B power factor PFb of the quadruple-circuit electric
8289
meter
Route 1 phase C power factor PFc of the quadruple-circuit electric
8290
meter
Route 2 phase C power factor PFc of the quadruple-circuit electric
8291
meter
Route 3 phase C power factor PFc of the quadruple-circuit electric
8292
meter
8293 Route 4 phase C power factor PFc of the quadruple-circuit electric
Value Type
meter
Route 1 phase A reactive power Qa of the quadruple-circuit electric
8294
meter
Route 2 phase A reactive power Qa of the quadruple-circuit electric
8295
meter
Route 3 phase A reactive power Qa of the quadruple-circuit electric
8296
meter
Route 4 phase A reactive power Qa of the quadruple-circuit electric
8297
meter
Route 1 phase B reactive power Qb of the quadruple-circuit electric
8298
meter
Route 2 phase B reactive power Qb of the quadruple-circuit electric
8299
meter
Route 3 phase B reactive power Qb of the quadruple-circuit electric
8300
meter
Route 4 phase B reactive power Qb of the quadruple-circuit electric
8301
meter
Route 1 phase C reactive power Qc of the quadruple-circuit electric
8302
meter
Route 2 phase C reactive power Qc of the quadruple-circuit electric
8303
meter
Route 3 phase C reactive power Qc of the quadruple-circuit electric
8304
meter
Route 4 phase C reactive power Qc of the quadruple-circuit electric
8305
meter
Route 1 phase A apparent power Sa of the quadruple-circuit electric
8306
meter
Route 2 phase A apparent power Sa of the quadruple-circuit electric
8307
meter
Route 3 phase A apparent power Sa of the quadruple-circuit electric
8308
meter
Route 4 phase A apparent power Sa of the quadruple-circuit electric
8309
meter
Route 1 phase B apparent power Sb of the quadruple-circuit electric
8310
meter
Route 2 phase B apparent power Sb of the quadruple-circuit electric
8311
meter
Route 3 phase B apparent power Sb of the quadruple-circuit electric
8312
meter
Route 4 phase B apparent power Sb of the quadruple-circuit electric
8313
meter
Route 1 phase C apparent power Sc of the quadruple-circuit electric
8314
meter
Value Type
Route 2 phase C apparent power Sc of the quadruple-circuit electric
8315
meter
Route 3 phase C apparent power Sc of the quadruple-circuit electric
8316
meter
Route 4 phase C apparent power Sc of the quadruple-circuit electric
8317
meter
Route 1 zero sequence current io of the quadruple-circuit electric
8318
meter
Route 1 three-phase average phase voltage of the quadruple-circuit
8319
electric meter
Route 1 three-phase average phase current of the quadruple-circuit
8320
electric meter
Route 1 three-phase active power of the quadruple-circuit electric
8321
meter
Route 1 three-phase reactive power of the quadruple-circuit electric
8322
meter
Route 1 three-phase apparent power of the quadruple-circuit electric
8323
meter
8324 Route 1 power factor pf of the quadruple-circuit electric meter
8325 Route 1 input frequency f of the quadruple-circuit electric meter
8326 Route 1 positive active energy of the quadruple-circuit electric meter
8327 Route 1 positive reactive energy of the quadruple-circuit electric meter
8328 Route 1 AC input power failure of the quadruple-circuit electric meter
8329 Route 2 AC input power failure of the quadruple-circuit electric meter
8330 Route 3 AC input power failure of the quadruple-circuit electric meter
8331 Route 4 AC input power failure of the quadruple-circuit electric meter
One open phase on route 1 AC input of the quadruple-circuit electric
8332
meter
One open phase on route 2 AC input of the quadruple-circuit electric
8333
meter
One open phase on route 3 AC input of the quadruple-circuit electric
8334
meter
One open phase on route 4 AC input of the quadruple-circuit electric
8335
meter
Two open phases on route 1 AC input of the quadruple-circuit electric
8336
meter
Two open phases on route 2 AC input of the quadruple-circuit electric
8337
meter
Two open phases on route 3 AC input of the quadruple-circuit electric
8338
meter
Two open phases on route 4 AC input of the quadruple-circuit electric
8339
meter
Value Type
Route 1 input frequency of the quadruple-circuit electric meter above
8340
the upper limit
Route 2 input frequency of the quadruple-circuit electric meter above
8341
the upper limit
Route 3 input frequency of the quadruple-circuit electric meter above
8342
the upper limit
Route 4 input frequency of the quadruple-circuit electric meter above
8343
the upper limit
Route 1 input frequency of the quadruple-circuit electric meter below
8344
the lower limit
Route 2 input frequency of the quadruple-circuit electric meter below
8345
the lower limit
Route 3 input frequency of the quadruple-circuit electric meter below
8346
the lower limit
Route 4 input frequency of the quadruple-circuit electric meter below
8347
the lower limit
Route 1 phase A voltage of the quadruple-circuit electric meter above
8348
the upper limit
Route 2 phase A voltage of the quadruple-circuit electric meter above
8349
the upper limit
Route 3 phase A voltage of the quadruple-circuit electric meter above
8350
the upper limit
Route 4 phase A voltage of the quadruple-circuit electric meter above
8351
the upper limit
Route 1 phase A voltage of the quadruple-circuit electric meter below
8352
the lower limit
Route 2 phase A voltage of the quadruple-circuit electric meter below
8353
the lower limit
Route 3 phase A voltage of the quadruple-circuit electric meter below
8354
the lower limit
Route 4 phase A voltage of the quadruple-circuit electric meter below
8355
the lower limit
Route 1 phase B voltage of the quadruple-circuit electric meter above
8356
the upper limit
Route 2 phase B voltage of the quadruple-circuit electric meter above
8357
the upper limit
Route 3 phase B voltage of the quadruple-circuit electric meter above
8358
the upper limit
Route 4 phase B voltage of the quadruple-circuit electric meter above
8359
the upper limit
Route 1 phase B voltage of the quadruple-circuit electric meter below
8360
the lower limit
8361 Route 2 phase B voltage of the quadruple-circuit electric meter below
Value Type
the lower limit
Route 3 phase B voltage of the quadruple-circuit electric meter below
8362
the lower limit
Route 4 phase B voltage of the quadruple-circuit electric meter below
8363
the lower limit
Route 1 phase C voltage of the quadruple-circuit electric meter above
8364
the upper limit
Route 2 phase C voltage of the quadruple-circuit electric meter above
8365
the upper limit
Route 3 phase C voltage of the quadruple-circuit electric meter above
8366
the upper limit
Route 4 phase C voltage of the quadruple-circuit electric meter above
8367
the upper limit
Route 1 phase C voltage of the quadruple-circuit electric meter below
8368
the lower limit
Route 2 phase C voltage of the quadruple-circuit electric meter below
8369
the lower limit
Route 3 phase C voltage of the quadruple-circuit electric meter below
8370
the lower limit
Route 4 phase C voltage of the quadruple-circuit electric meter below
8371
the lower limit
8372 Route 1 mains
8373 Route 2 mains
8374 Route 3 mains
8375 Route 4 mains
8376 Route 5 mains
8377 Route 6 mains
8378 Route 7 mains
8379 Route 8 mains
8380 Route 9 mains
8381 Route 10 mains
8382 Route 11 mains
8383 Route 12 mains
8384 Route 13 mains
8385 Route 14 mains
8386 Route 15 mains
8387 Route 16 mains
8388 Air conditioner controller temperature
8389 Air conditioner controller humidity
8390 Air conditioner controller current
8391 Air conditioner controller load threshold
8392 Air conditioner on/off duration of the air conditioner controller
Value Type
8393 Upper limit of temperature control of the air conditioner controller
8394 Lower limit of temperature control of the air conditioner controller
8395 Upper limit of humidity control of the air conditioner controller
8396 Air conditioner status of the air conditioner controller
8397 Air conditioner controller unable to turn on the air conditioner
8398 Air conditioner controller unable to turn off the air conditioner
8399 Air conditioner controller temperature too high
8400 Air conditioner controller humidity too high
8401 Power failure recovery status of the air conditioner controller
8402 Alarm buzzer of the air conditioner controller enabled
8403 Cooling mode of the air conditioner controller
8404 Heating mode of the air conditioner controller
8405 Timing control of the air conditioner controller
8406 Periodic control of the air conditioner controller
8407 Internal temperature control of the air conditioner
8408 External probe temperature control of the air conditioner
8409 External probe humidity control of the air conditioner
8410 Switching value DI input control of the air conditioner controller
8411 DO alarm output of the air conditioner controller
8412 DO contact output of the air conditioner controller
8413 DO normally closed output of the air conditioner controller
8414 DO manual control of the air conditioner controller
8415 DI air conditioner control of the air conditioner controller
8416 DI air conditioner status monitoring of the air conditioner controller
8417 Air conditioner on when DI of the air conditioner controller is closed
8418 Air conditioner off when DI of the air conditioner controller is closed
8419 Code sending of the air conditioner controller
8420 Code learning of the air conditioner controller
8421 Energy saving mode of the air conditioner controller
8422 Power failure recovery of the air conditioner controller
8423 Control mode of the air conditioner controller
8424 Buzzer of the air conditioner controller enabled
8425 Air conditioner controller load threshold
8426 Upper limit of temperature of the air conditioner controller
8427 Lower limit of temperature of the air conditioner controller
8428 Upper limit of humidity of the air conditioner controller
8429 Periodic timing of the air conditioner controller
8430 Leaking distance of leaking detection cable 1
8431 Leaking distance of leaking detection cable 2
8432 Leaking detection cable 1 leaking
Value Type
8433 Leaking detection cable 2 leaking
8434 Leaking detection cable 1 hardware failure
8435 Leaking detection cable 2 hardware failure
8436 Smoke alarm 1
8437 Smoke alarm 2
8438 Doorstop alarm 1
8439 Doorstop alarm 2
8440 Glass break alarm 1
8441 Glass break alarm 2
8442 Vibration alarm 1
8443 Vibration alarm 2
8444 Dual - technology alarm 1
8445 Dual - technology alarm 2
8446 Triple-technology alarm
8447 Emergency button alarm
8448 Passive IR alarm
8449 IVS rule alarm
8450 Number of the card swiping on the A&C
8451 Date of the card swiping on the A&C
8452 Door contact switch status of the A&C
8453 Lock switch status of the A&C
8454 Illegal in/out alarm of the A&C
8455 Long-time unlocking alarm of the A&C
8456 A&C failure alarm
8457 Other alarms of the A&C
8458 Remote unlocking of the A&C
8459 Remote recovery of the A&C
8460 Carbon dioxide concentration
8461 Carbon dioxide concentration above the upper limit
8462 Carbon dioxide concentration below the lower limit
Route 2 zero sequence current Io of the quadruple-circuit electric
8463
meter
Route 3 zero sequence current Io of the quadruple-circuit electric
8464
meter
Route 4 zero sequence current Io of the quadruple-circuit electric
8465
meter
Route 2 three-phase average phase voltage of the quadruple-circuit
8466
electric meter
Route 3 three-phase average phase voltage of the quadruple-circuit
8467
electric meter
8468 Route 4 three-phase average phase voltage of the quadruple-circuit
Value Type
electric meter
Route 2 three-phase average phase current of the quadruple-circuit
8469
electric meter
Route 3 three-phase average phase current of the quadruple-circuit
8470
electric meter
Route 4 three-phase average phase current of the quadruple-circuit
8471
electric meter
Route 2 three-phase active power of the quadruple-circuit electric
8472
meter
Route 3 three-phase active power of the quadruple-circuit electric
8473
meter
Route 4 three-phase active power of the quadruple-circuit electric
8474
meter
Route 2 three-phase reactive power of the quadruple-circuit electric
8475
meter
Route 3 three-phase reactive power of the quadruple-circuit electric
8476
meter
Route 4 three-phase reactive power of the quadruple-circuit electric
8477
meter
Route 2 three-phase apparent power of the quadruple-circuit electric
8478
meter
Route 3 three-phase apparent power of the quadruple-circuit electric
8479
meter
Route 4 three-phase apparent power of the quadruple-circuit electric
8480
meter
8481 Route 2 power factor PF of the quadruple-circuit electric meter
8482 Route 3 power factor PF of the quadruple-circuit electric meter
8483 Route 4 power factor PF of the quadruple-circuit electric meter
8484 Route 2 input frequency F of the quadruple-circuit electric meter
8485 Route 3 input frequency F of the quadruple-circuit electric meter
8486 Route 4 input frequency F of the quadruple-circuit electric meter
8487 Route 2 positive active energy of the quadruple-circuit electric meter
8488 Route 3 positive active energy of the quadruple-circuit electric meter
8489 Route 4 positive active energy of the quadruple-circuit electric meter
8490 Route 2 positive reactive energy of the quadruple-circuit electric meter
8491 Route 3 positive reactive energy of the quadruple-circuit electric meter
8492 Route 4 positive reactive energy of the quadruple-circuit electric meter
8493 Carbon dioxide flow
8494 Pressure detector
8495 Pressure above the upper limit
8496 Pressure below the lower limit
8497 Lighting detector
Value Type
8498 Lighting above the upper limit
8499 Lighting below the lower limit
8500 Wind force detector
8501 Wind force above the upper limit
8502 Wind force below the lower limit
8503 Soil temperature detector
8504 Soil temperature above the upper limit
8505 Soil temperature below the lower limit
8506 Soil humidity detector
8507 Soil humidity above the upper limit
8508 Soil humidity below the lower limit
8509 Wind direction detector
8510 Wind direction above the upper limit
8511 Wind direction below the lower limit
8512 Soil PH value
8513 Soil PH value above the upper limit
8514 Soil PH value below the lower limit
10700 License plate snapshot
10701 Restricted list alarm
11600 MCS general capacity alarm configuration
11601 MCS data node offline
11602 MCS disk offline alarm configuration
11603 Disk slow alarm configuration
11604 Disk broken alarm configuration
11605 Disk unknown error alarm configuration
11606 Abnormal Metadata server alarm configuration
11607 Abnormal Catalog server alarm configuration
13010 Chassis intrusion
13100 No permission (card/password/fingerprint)
13101 Card missing or frozen
Unlocking mode error (the user is authorized but the locking mode
13103
does not match)
13104 Validity period error
13105 Anti-pass back
13106 Duress alarm not opened
13107 Door always close unlocking
13108 Multi-door interlock (can open up to one door)
13109 Patrol card
13110 Intrusion alarm
13111 Time period error
Value Type
13112 Open time error during holidays
13113 Not the first card (the first card everyday)
13114 Correct card plus wrong password
13115 Correct card plus password timeout
13116 Correct card plus wrong fingerprint
13117 Correct card plus fingerprint timeout
13118 Correct fingerprint plus wrong password
13119 Correct fingerprint plus password timeout
13120 Wrong opening sequence of the person group
13121 Combination unlocking with continuing verification
13122 Verification passed, console unauthorized
13123 Combination unlocking by card and password
13124 Combination unlocking by card and fingerprint
13125 Remote verification
15610 Queue time alarm
15611 Queue number alarm
16998 Crowd intensity (regional)
16999 Crowd intensity (global)
19010 Intelligent motion detection (human)
19011 Intelligent motion detection (motor vehicle)
19012 Intelligent motion detection (human and motor vehicle)
300001 Overspeed vehicle
300002 Stolen vehicle
300003 Vehicle involved in accidents
300004 Suspect vehicle
300005 Intercepted vehicle
300006 Inspection
300007 Observing and tracking
300008 High-risk vehicle
300009 Temporary arm
300101 Overspeed
300102 Running red light
300103 Crossing the line
300104 Wrong-way driving
300105 Parking violation
300106 Lane change violation
300107 Bus lane occupied
300108 Fake-licensed vehicle
600005 Legal face unlocking
600011 Correct card plus face timeout
Value Type
600012 Correct card plus face error
600013 Combination unlocking by card and face
700000 Combination unlocking by fingerprint and password
700001 Combination unlocking by fingerprint and face
700002 Combination unlocking by face and password
700003 Combination unlocking by card, fingerprint, and password
700004 Combination unlocking by card, fingerprint, and face
700005 Combination unlocking by fingerprint, face, and password
700006 Combination unlocking by card, face, and password
700007 Combination unlocking by card, fingerprint, face, and password

5.9、Access Control Event Type

Event Type Event subtype

Value Type Value Type
42 Legal password unlocking
45 Legal fingerprint unlocking
48 Remote unlocking (indoor monitor/platform)
49 Normal button unlocking
51 Legal card swiping
56 Normal locking
57 Normal unlocking
13109 Patrol user
13123 Combination unlocking by card and password
13124 Combination unlocking by card and fingerprint
13125 Remote verification
600005 Legal face unlocking
Normal access 600013 Combination unlocking by card and face
5
control
Combination unlocking by fingerprint and
700000
password
700001 Combination unlocking by fingerprint and face
700002 Combination unlocking by face and password
Combination unlocking by card, fingerprint,
700003
and password
Combination unlocking by card, fingerprint,
700004
and face
Combination unlocking by fingerprint, face,
700005
and password
Combination unlocking by card, face, and
700006
password
700007 Combination unlocking by card, fingerprint,
face, and password
43 Illegal password unlocking
46 Illegal fingerprint unlocking
52 Illegal card swiping
54 Abnormal unlocking
55 Abnormal locking
No permission
13100
(card/password/fingerprint/face)
13101 Card missing or frozen
Unlocking mode error (the user is authorized
13103
but the locking mode does not match)
13104 Validity period error
13106 Duress alarm not opened
13107 Door always closed unlocking
13108 Multi-door interlock (can open up to one door)
Abnormal
15 13111 Time period error
access control
13112 Open time error during holidays
13113 Not the first card (the first card everyday)
13114 Correct card plus wrong password
13115 Correct card plus password timeout
13116 Correct card plus wrong fingerprint
13117 Correct card plus fingerprint timeout
13118 Correct fingerprint plus wrong password
13119 Correct fingerprint plus password timeout
Wrong sequence of the combination for gate
13120
opening
13121 Combination unlocking with further verification
13122 Verification passed, console unauthorized
600011 Correct card plus face timeout
600012 Correct card plus face error
41 Duress alarm
72 Timeout alarm
1433 Restricted list alarm
Access control
16 1446 Alarm of excessive use of illegal card
alarms
13105 Anti-passback alarm
13110 Intrusion alarm
600003 Card reader tamper alarm
Access control
25 600004 Device tamper alarm
device alarm

HTTP API v3.35 Intelbras
No ratings yet
HTTP API v3.35 Intelbras
749 pages
Hands on Hacking: Become an Expert at Next Gen Penetration Testing and Purple Teaming
From Everand
Hands on Hacking: Become an Expert at Next Gen Penetration Testing and Purple Teaming
Matthew Hickey
3/5 (3)
IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
No ratings yet
IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
91 pages
IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
100% (1)
IMaster MAE-Access V100R021C10 Open API Developer Guide (Wireless Network)
78 pages
Howen VSS Web API V1.7R1 en 20210723
No ratings yet
Howen VSS Web API V1.7R1 en 20210723
74 pages
A Study On Rooftop Tower Construction For Selection of An Appropriate Location To Minimize Additional Stress On Host Structure
No ratings yet
A Study On Rooftop Tower Construction For Selection of An Appropriate Location To Minimize Additional Stress On Host Structure
14 pages
SRS - How to build a Pen Test and Hacking Platform
From Everand
SRS - How to build a Pen Test and Hacking Platform
alasdair gilchrist
2/5 (1)
Heroku Cloud Application Development
From Everand
Heroku Cloud Application Development
Anubhav Hanjura
No ratings yet
FreeSWITCH 1.2
From Everand
FreeSWITCH 1.2
Anthony Minessale
No ratings yet
Security+ Boot Camp Study Guide
From Everand
Security+ Boot Camp Study Guide
Chad Russell
5/5 (1)
Basic Setup of FortiGate Firewall
From Everand
Basic Setup of FortiGate Firewall
Dr. Hidaia Mahmood Alassoulii
No ratings yet
Profound Linux For Users
From Everand
Profound Linux For Users
Onder Teker
No ratings yet
Chapter 3
100% (1)
Chapter 3
40 pages
Basic Setup of FortiGate Firewall
From Everand
Basic Setup of FortiGate Firewall
Dr. Hidaia Mahmood Alassouli
No ratings yet
FreeSWITCH 1.0.6
From Everand
FreeSWITCH 1.0.6
Anthony Minessale
No ratings yet
Hack into your Friends Computer
From Everand
Hack into your Friends Computer
Magelan Cyber Security
No ratings yet
Understanding IOT
No ratings yet
Understanding IOT
85 pages
Communication Protocol
No ratings yet
Communication Protocol
63 pages
Building Telephony Systems with OpenSER
From Everand
Building Telephony Systems with OpenSER
Goncalves Flavio E.
No ratings yet
Marmalade SDK Mobile Game Development Essentials
From Everand
Marmalade SDK Mobile Game Development Essentials
Sean Scaplehorn
No ratings yet
HCIP-IoT Developer V2.5 Training Material
No ratings yet
HCIP-IoT Developer V2.5 Training Material
416 pages
RFC 2326
No ratings yet
RFC 2326
92 pages
Hacking of Computer Networks: Full Course on Hacking of Computer Networks
From Everand
Hacking of Computer Networks: Full Course on Hacking of Computer Networks
Dr. Hidaia Mahmood Alassouli
No ratings yet
ZM100 - Student Notebookv2
No ratings yet
ZM100 - Student Notebookv2
214 pages
Building Telephony Systems with OpenSIPS - Second Edition
From Everand
Building Telephony Systems with OpenSIPS - Second Edition
Goncalves Flavio E.
No ratings yet
Securing Application Deployment with Obfuscation and Code Signing: How to Create 3 Layers of Protection for .NET Release Build
From Everand
Securing Application Deployment with Obfuscation and Code Signing: How to Create 3 Layers of Protection for .NET Release Build
Slava Gomzin
No ratings yet
SSL VPN : Understanding, evaluating and planning secure, web-based remote access
From Everand
SSL VPN : Understanding, evaluating and planning secure, web-based remote access
Tim Speed
No ratings yet
Living with Linux in the Industrial World
From Everand
Living with Linux in the Industrial World
Elaiya Iswera Lallan
No ratings yet
Footprinting, Reconnaissance, Scanning and Enumeration Techniques of Computer Networks
From Everand
Footprinting, Reconnaissance, Scanning and Enumeration Techniques of Computer Networks
Dr. Hidaia Mahmood Alassouli
No ratings yet
Rest Youtube 5
No ratings yet
Rest Youtube 5
39 pages
Professional Heroku Programming
From Everand
Professional Heroku Programming
Chris Kemp
4/5 (2)
The Ordinary Function and Cases - Zycoo
No ratings yet
The Ordinary Function and Cases - Zycoo
51 pages
Embedded Ethernet and Internet Complete
From Everand
Embedded Ethernet and Internet Complete
Jan Axelson
4/5 (1)
Common Windows, Linux and Web Server Systems Hacking Techniques
From Everand
Common Windows, Linux and Web Server Systems Hacking Techniques
Dr. Hidaia Mahmood Alassouli
No ratings yet
Messaging Technologies For The Industrial Internet and The Internet of Things Whitepaper
No ratings yet
Messaging Technologies For The Industrial Internet and The Internet of Things Whitepaper
24 pages
FCP - FortiGate 7.4 Admin: 499 Practice Questions to Pass the Certification Exam
From Everand
FCP - FortiGate 7.4 Admin: 499 Practice Questions to Pass the Certification Exam
Steve Brown
No ratings yet
IOT Unit3 Web Comm Protocols
No ratings yet
IOT Unit3 Web Comm Protocols
31 pages
IOT-unit 2a (Reference Model)
No ratings yet
IOT-unit 2a (Reference Model)
24 pages
Aprende programación python aplicaciones web: python, #2
From Everand
Aprende programación python aplicaciones web: python, #2
Jesus Jonathan cuevas orozco
No ratings yet
unit 2
No ratings yet
unit 2
61 pages
Unit 2
No ratings yet
Unit 2
54 pages
RFC 3261
100% (2)
RFC 3261
34 pages
REST
No ratings yet
REST
9 pages
A Practical Guide Wireshark Forensics
From Everand
A Practical Guide Wireshark Forensics
alasdair gilchrist
5/5 (4)
WebRTC Integrator's Guide
From Everand
WebRTC Integrator's Guide
Altanai
5/5 (1)
Ltu Ex 08210 Se
No ratings yet
Ltu Ex 08210 Se
98 pages
Securing Communication of Legacy Applications with IPSec: Step-by-Step Guide to Protecting “Data in Transit” without Changes in Your Existing Software
From Everand
Securing Communication of Legacy Applications with IPSec: Step-by-Step Guide to Protecting “Data in Transit” without Changes in Your Existing Software
Slava Gomzin
No ratings yet
Wireless and Mobile Hacking and Sniffing Techniques
From Everand
Wireless and Mobile Hacking and Sniffing Techniques
Dr. Hidaia Mahmood Alassouli
No ratings yet
Srijan Manandhar MQTT Based Communication in Iot: Master of Science Thesis
No ratings yet
Srijan Manandhar MQTT Based Communication in Iot: Master of Science Thesis
56 pages
Arm Iot Tutorial: Coap: The Web of Things Protocol
No ratings yet
Arm Iot Tutorial: Coap: The Web of Things Protocol
42 pages
IoT CSE U 3
No ratings yet
IoT CSE U 3
144 pages
Api Microservice PDF
No ratings yet
Api Microservice PDF
3 pages
Srs On Web Browser
No ratings yet
Srs On Web Browser
10 pages
Openiec 61850
No ratings yet
Openiec 61850
9 pages
IPv6 Readiness Assessment Final
No ratings yet
IPv6 Readiness Assessment Final
23 pages
MIOT Shreyash Patil
No ratings yet
MIOT Shreyash Patil
12 pages
webrtc-for-the-curious
No ratings yet
webrtc-for-the-curious
48 pages
Edgelink RESTful API Specification_v2.0
No ratings yet
Edgelink RESTful API Specification_v2.0
99 pages
Rest Youtube 4
No ratings yet
Rest Youtube 4
34 pages
Hiding Web Traffic with SSH: How to Protect Your Internet Privacy against Corporate Firewall or Insecure Wireless
From Everand
Hiding Web Traffic with SSH: How to Protect Your Internet Privacy against Corporate Firewall or Insecure Wireless
Slava Gomzin
No ratings yet
Information Technology HandBook
From Everand
Information Technology HandBook
Duong Tran
3/5 (1)
MNX Smoke Detector
No ratings yet
MNX Smoke Detector
59 pages
Latex_Report_Mini_Project_2A (1)
No ratings yet
Latex_Report_Mini_Project_2A (1)
44 pages
Solving Computer Forensic Case Using Autopsy: Scenario
No ratings yet
Solving Computer Forensic Case Using Autopsy: Scenario
26 pages
Email Weapon System (EWS) : LCDR Greg Taylor Bupers Iam
No ratings yet
Email Weapon System (EWS) : LCDR Greg Taylor Bupers Iam
24 pages
1 IntroductiontoProtectionv1
No ratings yet
1 IntroductiontoProtectionv1
62 pages
PWM OC10A Rev0808
100% (1)
PWM OC10A Rev0808
5 pages
Business Proposal: by Lee & Jones Manpower Solutions
No ratings yet
Business Proposal: by Lee & Jones Manpower Solutions
15 pages
SAP All How To Reprocess The IDoc (Inbound & Outbound)
No ratings yet
SAP All How To Reprocess The IDoc (Inbound & Outbound)
4 pages
Hananan
No ratings yet
Hananan
2 pages
The Basics of Search Engine Optimization
100% (2)
The Basics of Search Engine Optimization
117 pages
HRDF Training Provider Orientation (Latest180419)
No ratings yet
HRDF Training Provider Orientation (Latest180419)
23 pages
Cle2023 Gis-And-Remote-Sensing Eth 1.0 37 Cle2023 15
No ratings yet
Cle2023 Gis-And-Remote-Sensing Eth 1.0 37 Cle2023 15
2 pages
Qualcomm Qwriter Tool Instruction
No ratings yet
Qualcomm Qwriter Tool Instruction
11 pages
Scan Plan (PAUT) For Taper Joints and K Welds
100% (1)
Scan Plan (PAUT) For Taper Joints and K Welds
4 pages
Samsung Mobile: Market Share & Profitability in Smartphones
No ratings yet
Samsung Mobile: Market Share & Profitability in Smartphones
15 pages
Updated Building Codes
No ratings yet
Updated Building Codes
6 pages
Automatic Identification System Test Report (Rev 0)
No ratings yet
Automatic Identification System Test Report (Rev 0)
3 pages
Sim8300g-M2 Mmwave Antenna Module Application Notes v1.00
No ratings yet
Sim8300g-M2 Mmwave Antenna Module Application Notes v1.00
22 pages
Improvement The Performance of Mobility Pattern in Mobile Ad-Hoc Sensor Network Using Qualnet 5.0
No ratings yet
Improvement The Performance of Mobility Pattern in Mobile Ad-Hoc Sensor Network Using Qualnet 5.0
7 pages
Case Study Assignment (Part 1) PDF
100% (1)
Case Study Assignment (Part 1) PDF
3 pages
DVP-FX730: Key Features
No ratings yet
DVP-FX730: Key Features
2 pages
HCD V41D
No ratings yet
HCD V41D
74 pages
Certificate: Project Guide Principal
No ratings yet
Certificate: Project Guide Principal
20 pages
LaserMarkerNAVIsmart OperationManual e PDF
No ratings yet
LaserMarkerNAVIsmart OperationManual e PDF
284 pages
ACL 105 Foundation Vol 3 Guideline Book
No ratings yet
ACL 105 Foundation Vol 3 Guideline Book
161 pages
Seg D Rev3.0 PDF
No ratings yet
Seg D Rev3.0 PDF
175 pages
5 Categories of Computer Types and Components
0% (1)
5 Categories of Computer Types and Components
10 pages
LTE Parameter - Channel Config RA
100% (5)
LTE Parameter - Channel Config RA
35 pages
MR-96A-Mindray - Microplate Reader: Missing: Drivers - Must Include
No ratings yet
MR-96A-Mindray - Microplate Reader: Missing: Drivers - Must Include
4 pages