Device Network SDK (Access Control on

Person)
Developer Guide
 Device Network SDK (Access Control on Person) Developer Guide

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

i
 Device Network SDK (Access Control on Person) Developer Guide

Contents
Chapter 1 Access Control ............................................................................................................ 1
1.1 Introduction ........................................................................................................................... 1
1.2 Update History ....................................................................................................................... 1
Chapter 2 Typical Applications .................................................................................................. 11
2.1 Data Collection ..................................................................................................................... 11
2.1.1 Online Collect Data ..................................................................................................... 11
2.1.2 Offline Collect Data ..................................................................................................... 14
2.2 Manage Person Information ................................................................................................ 19
2.3 Manage Card Information .................................................................................................... 23
2.3.1 Collect Card Information ............................................................................................. 27
2.3.2 Card Operation ............................................................................................................ 27
2.4 Manage Fingerprint Information ......................................................................................... 29
2.4.1 Fingerprint Collection ................................................................................................. 34
2.5 Manage Face Information .................................................................................................... 35
2.5.1 Create Face Picture Library ......................................................................................... 35
2.5.2 Collect Face Data ......................................................................................................... 37
2.5.3 Manage Face Records in Face Picture Library ............................................................. 38
2.5.4 Configure Facial Recognition Mode ............................................................................ 41
2.6 Configure Access Permission Control Schedule ................................................................... 43
2.7 Configure Authentication Mode Control Schedule .............................................................. 49
2.8 Configure Door Control Schedule ........................................................................................ 54
2.9 Configure Access Control Event ........................................................................................... 60
2.10 Search for Access Control Events ....................................................................................... 62
2.11 Remotely Control Door, Elevator, and Buzzer .................................................................... 66
2.12 Configure Anti-Passing Back ............................................................................................... 67
2.13 Cross-Controller Anti-Passing Back Configuration ............................................................. 70

ii
 Device Network SDK (Access Control on Person) Developer Guide

2.13.1 Configure Route Anti-Passing Back Based on Network ............................................. 70

2.13.2 Configure Entrance/Exit Anti-Passing Back Based on Network ................................. 74
2.13.3 Configure Route Anti-Passing Back Based on Card ................................................... 77
2.13.4 Configure Entrance/Exit Anti-Passing Back Based on Card ....................................... 80
2.14 Alarm/Event Receiving ....................................................................................................... 81
2.14.1 Receive Alarm/Event in Arming Mode ...................................................................... 82
2.14.2 Receive Alarm/Event in Listening Mode ................................................................... 85
2.15 Configure Attendance Status ............................................................................................. 87
2.16 Other Applications ............................................................................................................. 89
2.16.1 Device Settings .......................................................................................................... 89
2.16.2 Multi-Factor Authentication ..................................................................................... 93
2.16.3 Other Configurations ................................................................................................ 93
Chapter 3 API Reference ........................................................................................................... 96
3.1 NET_DVR_Cleanup ............................................................................................................... 96
3.2 NET_DVR_CloseAlarmChan_V30 ......................................................................................... 96
3.3 NET_DVR_ControlGateway .................................................................................................. 97
3.4 NET_DVR_GetDeviceAbility ................................................................................................. 97
3.5 NET_DVR_GetDeviceConfig ................................................................................................. 98
3.6 NET_DVR_GetDownloadState .............................................................................................. 99
3.7 NET_DVR_GetDVRConfig ................................................................................................... 100
3.8 NET_DVR_GetErrorMsg ..................................................................................................... 101
3.9 NET_DVR_GetLastError ...................................................................................................... 102
3.10 NET_DVR_GetNextRemoteConfig .................................................................................... 102
3.11 NET_DVR_GetUploadState .............................................................................................. 103
3.12 NET_DVR_Init ................................................................................................................... 104
3.13 NET_DVR_Login_V40 ....................................................................................................... 105
3.14 NET_DVR_Logout ............................................................................................................. 106
3.15 NET_DVR_SendRemoteConfig ......................................................................................... 106

iii
 Device Network SDK (Access Control on Person) Developer Guide

3.16 NET_DVR_SetDeviceConfig .............................................................................................. 107

3.17 NET_DVR_SetDVRConfig .................................................................................................. 108
3.18 NET_DVR_SetDVRMessageCallBack_V50 ........................................................................ 109
3.19 NET_DVR_SetSDKInitCfg .................................................................................................. 117
3.20 NET_DVR_SetupAlarmChan_V50 ..................................................................................... 118
3.21 NET_DVR_StartDownload ................................................................................................ 119
3.22 NET_DVR_StartListen_V30 ............................................................................................... 119
3.22.1 MSGCallBack ........................................................................................................... 120
3.23 NET_DVR_StartRemoteConfig ......................................................................................... 121
3.23.1 fRemoteConfigCallback ........................................................................................... 122
3.24 NET_DVR_STDXMLConfig ................................................................................................. 123
3.25 NET_DVR_StopDownload ................................................................................................ 124
3.26 NET_DVR_StopListen_V30 ............................................................................................... 125
3.27 NET_DVR_StopRemoteConfig .......................................................................................... 125
3.28 NET_DVR_UploadClose .................................................................................................... 126
3.29 NET_DVR_UploadFile_V40 .............................................................................................. 126
Chapter 4 Data Structure ........................................................................................................ 128
4.1 NET_ALARM_RECORD_EXCEPTION .................................................................................... 128
4.2 NET_ALARM_STREAM_EXCEPTION ................................................................................... 128
4.3 NET_ALARM_RESOURCE_USAGE ....................................................................................... 128
4.4 NET_ALARM_RECORDFILE_LOSS ....................................................................................... 129
4.5 NET_ALARM_CVR_SUBINFO_UNION ................................................................................. 129
4.6 NET_DVR_ACS_ALARM_INFO_V50 .................................................................................... 130
4.7 NET_DVR_ACS_CFG ........................................................................................................... 132
4.8 NET_DVR_ACS_EVENT_CFG ............................................................................................... 133
4.9 NET_DVR_ACS_EVENT_COND ........................................................................................... 134
4.10 NET_DVR_ACS_EVENT_DETAIL ........................................................................................ 136
4.11 NET_DVR_ACS_EVENT_INFO_EXTEND ............................................................................ 140

iv
 Device Network SDK (Access Control on Person) Developer Guide

4.12 NET_DVR_ACS_EVENT_INFO_V50 ................................................................................... 141

4.13 NET_DVR_ACS_WORK_STATUS_V50 ................................................................................ 144
4.14 NET_DVR_ALARMER ........................................................................................................ 146
4.15 NET_DVR_ALARMINFO_DEV ............................................................................................ 147
4.16 NET_DVR_ALARMINFO_DEV_V40 ................................................................................... 148
4.17 NET_DVR_ALRAM_FIXED_HEADER .................................................................................. 149
4.18 NET_DVR_ALARMINFO_V30 ............................................................................................ 151
4.19 NET_DVR_ALARMINFO_V40 ............................................................................................ 152
4.20 NET_DVR_CAPTURE_FACE_CFG ....................................................................................... 153
4.21 NET_DVR_CAPTURE_FACE_COND ................................................................................... 155
4.22 NET_DVR_CAPTURE_FINGERPRINT_CFG ......................................................................... 155
4.23 NET_DVR_CAPTURE_FINGERPRINT_COND ...................................................................... 156
4.24 NET_DVR_CARD_READER_PLAN ...................................................................................... 157
4.25 NET_DVR_CETTIFICATE_INFO .......................................................................................... 157
4.26 NET_DVR_CARD_READER_CFG_V50 ............................................................................... 158
4.27 NET_DVR_DATE ................................................................................................................ 163
4.28 NET_DVR_DEL_FINGER_PRINT_MODE_V50 .................................................................... 163
4.29 NET_DVR_DEVICEINFO_V30 ............................................................................................ 164
4.30 NET_DVR_DEVICEINFO_V40 ............................................................................................ 168
4.31 NET_DVR_DOOR_FILE_UPLOAD_PARAM ........................................................................ 170
4.32 NET_DVR_DOOR_STATUS_PLAN ...................................................................................... 171
4.33 NET_DVR_ETHERNET_V30 ............................................................................................... 172
4.34 NET_DVR_EVENT_CARD_LINKAGE_CFG_V51 .................................................................. 172
4.35 NET_DVR_EVENT_CARD_LINKAGE_COND ....................................................................... 174
4.36 NET_DVR_EVENT_LINKAGE_INFO ................................................................................... 175
4.37 NET_DVR_EVETN_CARD_LINKAGE_UNION ..................................................................... 176
4.38 NET_DVR_FACE_FEATURE ................................................................................................ 176
4.39 NET_DVR_FAILED_FACE_COND ....................................................................................... 177

v
 Device Network SDK (Access Control on Person) Developer Guide

4.40 NET_DVR_FAILED_FACE_INFO ......................................................................................... 177

4.41 NET_DVR_FINGER_PRINT_BYCARD_V50 ......................................................................... 178
4.42 NET_DVR_FINGER_PRINT_BYREADER_V50 ..................................................................... 179
4.43 NET_DVR_FINGER_PRINT_CFG_V50 ................................................................................ 180
4.44 NET_DVR_FINGER_PRINT_INFO_COND_V50 .................................................................. 181
4.45 NET_DVR_FINGER_PRINT_INFO_CTRL_V50 .................................................................... 182
4.46 NET_DVR_FINGER_PRINT_STATUS_V50 .......................................................................... 183
4.47 NET_DVR_GROUP_CFG .................................................................................................... 184
4.48 NET_DVR_GROUP_COMBINATION_INFO_V50 ................................................................ 185
4.49 NET_DVR_HOLIDAY_GROUP_CFG .................................................................................... 186
4.50 NET_DVR_HOLIDAY_PLAN_CFG ....................................................................................... 186
4.51 NET_DVR_INIT_CFG_ABILITY ........................................................................................... 187
4.52 NET_DVR_IPADDR ............................................................................................................ 188
4.53 NET_DVR_JSON_DATA_CFG ............................................................................................. 189
4.54 NET_DVR_LOCAL_SDK_PATH ........................................................................................... 190
4.55 NET_DVR_MIME_UNIT .................................................................................................... 190
4.56 NET_DVR_MULTI_CARD_CFG_V50 .................................................................................. 191
4.57 NET_DVR_MULTI_CARD_GROUP_CFG_V50 .................................................................... 191
4.58 NET_DVR_NETCFG_V50 ................................................................................................... 192
4.59 NET_DVR_PLAN_TEMPLATE ............................................................................................. 194
4.60 NET_DVR_PPPOECFG ....................................................................................................... 194
4.61 NET_DVR_SETUPALARM_PARAM_V50 ............................................................................ 195
4.62 NET_DVR_SIMPLE_DAYTIME ............................................................................................ 197
4.63 NET_DVR_SINGLE_PLAN_SEGMENT ................................................................................ 198
4.64 NET_DVR_TIME ................................................................................................................ 199
4.65 NET_DVR_TIME_EX .......................................................................................................... 199
4.66 NET_DVR_TIME_SEGMENT .............................................................................................. 200
4.67 NET_DVR_USER_LOGIN_INFO ......................................................................................... 200

vi
 Device Network SDK (Access Control on Person) Developer Guide

4.67.1 fLoginResultCallBack ............................................................................................... 201

4.68 NET_DVR_VALID_PERIOD_CFG ........................................................................................ 201
4.69 NET_DVR_WEEK_PLAN_CFG ............................................................................................ 202
4.70 NET_DVR_XML_CONFIG_INPUT ...................................................................................... 203
4.71 NET_DVR_XML_CONFIG_OUTPUT ................................................................................... 204
4.72 NET_SDK_CALLBACK_STATUS_NORMAL .......................................................................... 204
4.73 NET_SDK_DOWNLOAD_TYPE ........................................................................................... 205
4.74 NET_SDK_UPLOAD_TYPE ................................................................................................. 208
4.75 NET_VCA_POINT .............................................................................................................. 212
4.76 NET_VCA_RECT ................................................................................................................ 213
Chapter 5 Request URL ........................................................................................................... 214
5.1 /ISAPI/AccessControl/AcsEventTotalNum/capabilities?format=json ................................. 214
5.2 /ISAPI/AccessControl/AcsEventTotalNum?format=json ..................................................... 214
5.3 /ISAPI/AccessControl/attendanceStatusModeCfg/capabilities?format=json .................... 215
5.4 /ISAPI/AccessControl/attendanceStatusModeCfg?format=json ........................................ 215
5.5 /ISAPI/AccessControl/attendanceStatusRuleCfg/capabilities?format=json ....................... 216
5.6 /ISAPI/AccessControl/attendanceStatusRuleCfg?attendanceStatus=&format=json .......... 216
5.7 /ISAPI/AccessControl/CaptureCardInfo/capabilities?format=json .................................... 217
5.8 /ISAPI/AccessControl/CaptureCardInfo?format=json ........................................................ 217
5.9 /ISAPI/AccessControl/CaptureFingerPrint ......................................................................... 218
5.10 /ISAPI/AccessControl/CaptureFingerPrint/capabilities .................................................... 218
5.11 /ISAPI/AccessControl/CaptureIDInfo/capabilities?format=json ...................................... 218
5.12 /ISAPI/AccessControl/CaptureIDInfo?format=json .......................................................... 219
5.13 /ISAPI/AccessControl/CapturePresetParam/capabilities?format=json ............................ 219
5.14 /ISAPI/AccessControl/CapturePresetParam?format=json ............................................... 220
5.15 /ISAPI/AccessControl/CaptureRule/capabilities?format=json ......................................... 220
5.16 /ISAPI/AccessControl/CaptureRule?format=json ............................................................. 221
5.17 /ISAPI/AccessControl/CardInfo/capabilities?format=json ............................................... 221

vii
 Device Network SDK (Access Control on Person) Developer Guide

5.18 /ISAPI/AccessControl/CardInfo/Count?format=json ........................................................ 222

5.19 /ISAPI/AccessControl/CardInfo/Count?format=json&employeeNo=<ID> ....................... 222
5.20 /ISAPI/AccessControl/CardInfo/Delete?format=json ....................................................... 223
5.21 /ISAPI/AccessControl/CardInfo/Modify?format=json ...................................................... 223
5.22 /ISAPI/AccessControl/CardInfo/Record?format=json ...................................................... 224
5.23 /ISAPI/AccessControl/CardInfo/Search?format=json ...................................................... 224
5.24 /ISAPI/AccessControl/CardInfo/SetUp?format=json ........................................................ 224
5.25 /ISAPI/AccessControl/CardOperations/capabilities?format=json .................................... 225
5.26 /ISAPI/AccessControl/CardOperations/cardParam?format=json ..................................... 225
5.27 /ISAPI/AccessControl/CardOperations/controlBlock?format=json .................................. 226
5.28 /ISAPI/AccessControl/CardOperations/dataBlock/<address>?format=json .................... 226
5.29 /ISAPI/AccessControl/CardOperations/dataBlock/control?format=json ......................... 227
5.30 /ISAPI/AccessControl/CardOperations/dataTrans?format=json ...................................... 227
5.31 /ISAPI/AccessControl/CardOperations/encryption?format=json .................................... 228
5.32 /ISAPI/AccessControl/CardOperations/protocol?format=json ........................................ 228
5.33 /ISAPI/AccessControl/CardOperations/reset?format=json .............................................. 229
5.34 /ISAPI/AccessControl/CardOperations/sectionEncryption?format=json ......................... 229
5.35 /ISAPI/AccessControl/CardOperations/verification?format=json .................................... 229
5.36 /ISAPI/AccessControl/ClearCardRecord ........................................................................... 230
5.37 /ISAPI/AccessControl/ClearCardRecord/capabilities ....................................................... 230
5.38 /ISAPI/AccessControl/ClearSubmarineBack ..................................................................... 231
5.39 /ISAPI/AccessControl/ClearSubmarineBack/capabilities ................................................. 231
5.40 /ISAPI/AccessControl/Configuration/IRCfg/capabilities?format=json ............................. 232
5.41 /ISAPI/AccessControl/Configuration/IRCfg?format=json ................................................. 232
5.42 /ISAPI/AccessControl/Configuration/NFCCfg/capabilities?format=json .......................... 233
5.43 /ISAPI/AccessControl/Configuration/NFCCfg?format=json .............................................. 233
5.44 /ISAPI/AccessControl/Configuration/RFCardCfg/capabilities?format=json ..................... 234
5.45 /ISAPI/AccessControl/Configuration/RFCardCfg?format=json ......................................... 234

viii
 Device Network SDK (Access Control on Person) Developer Guide

5.46 /ISAPI/AccessControl/DeployInfo .................................................................................... 235

5.47 /ISAPI/AccessControl/DeployInfo/capabilities ................................................................. 235
5.48 /ISAPI/AccessControl/EventOptimizationCfg/capabilities?format=json .......................... 236
5.49 /ISAPI/AccessControl/EventOptimizationCfg?format=json .............................................. 236
5.50 /ISAPI/AccessControl/FaceCompareCond ........................................................................ 237
5.51 /ISAPI/AccessControl/FaceCompareCond/capabilities .................................................... 237
5.52 /ISAPI/AccessControl/FaceRecognizeMode/capabilities?format=json ............................ 238
5.53 /ISAPI/AccessControl/FaceRecognizeMode?format=json ................................................ 238
5.54 /ISAPI/AccessControl/FingerPrint/DeleteProcess?format=json ....................................... 239
5.55 /ISAPI/AccessControl/FingerPrint/Delete/capabilities?format=json ............................... 240
5.56 /ISAPI/AccessControl/FingerPrint/Delete?format=json ................................................... 240
5.57 /ISAPI/AccessControl/FingerPrint/SetUp?format=json .................................................... 241
5.58 /ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json ...................................... 242
5.59 /ISAPI/AccessControl/FingerPrintDownload?format=json .............................................. 242
5.60 /ISAPI/AccessControl/FingerPrintModify?format=json ................................................... 242
5.61 /ISAPI/AccessControl/FingerPrintProgress?format=json ................................................. 243
5.62 /ISAPI/AccessControl/FingerPrintUpload?format=json ................................................... 243
5.63 /ISAPI/AccessControl/GetAcsEvent/capabilities .............................................................. 244
5.64 /ISAPI/AccessControl/IdentityTerminal ............................................................................ 245
5.65 /ISAPI/AccessControl/IdentityTerminal/capabilities ........................................................ 245
5.66 /ISAPI/AccessControl/LogModeCfg/capabilities?format=json ......................................... 246
5.67 /ISAPI/AccessControl/LogModeCfg?format=json ............................................................ 246
5.68 /ISAPI/AccessControl/OfflineCapture/capabilities?format=json ..................................... 247
5.69 /ISAPI/AccessControl/OfflineCapture/DataCollections/<captureNo>?format=json ........ 247
5.70 /ISAPI/AccessControl/OfflineCapture/DataCollections/searchTask?format=json ........... 248
5.71 /ISAPI/AccessControl/OfflineCapture/DataCollections?format=json .............................. 248
5.72 /ISAPI/AccessControl/OfflineCapture/dataOutput/progress?format=json ..................... 248
5.73 /ISAPI/AccessControl/OfflineCapture/dataOutput?format=json ..................................... 249

ix
 Device Network SDK (Access Control on Person) Developer Guide

5.74 /ISAPI/AccessControl/OfflineCapture/progress?format=json .......................................... 249

5.75 /ISAPI/AccessControl/OfflineCapture/ruleInfo?format=json ........................................... 250
5.76 /ISAPI/AccessControl/UserInfo/capabilities?format=json ............................................... 250
5.77 /ISAPI/AccessControl/UserInfo/Count?format=json ........................................................ 251
5.78 /ISAPI/AccessControl/UserInfo/Delete?format=json ....................................................... 251
5.79 /ISAPI/AccessControl/UserInfo/Modify?format=json ...................................................... 251
5.80 /ISAPI/AccessControl/UserInfo/Record?format=json ...................................................... 252
5.81 /ISAPI/AccessControl/UserInfo/Search?format=json ...................................................... 252
5.82 /ISAPI/AccessControl/UserInfo/SetUp?format=json ........................................................ 253
5.83 /ISAPI/AccessControl/UserInfoDetail/Delete/capabilities?format=json .......................... 253
5.84 /ISAPI/AccessControl/UserInfoDetail/Delete?format=json ............................................. 254
5.85 /ISAPI/AccessControl/UserInfoDetail/DeleteProcess?format=json ................................. 254
5.86 /ISAPI/AccessControl/RemoteControl/buzzer/<ID>?format=json ................................... 255
5.87 /ISAPI/AccessControl/RemoteControl/buzzer/capabilities?format=json ........................ 256
5.88 /ISAPI/AccessControl/OSDPModify/<ID>?format=json ................................................... 256
5.89 /ISAPI/AccessControl/OSDPModify/capabilities?format=json ......................................... 256
5.90 /ISAPI/AccessControl/OSDPStatus/<ID>?format=json ..................................................... 257
5.91 /ISAPI/AccessControl/OSDPStatus/capabilities?format=json .......................................... 257
5.92 /ISAPI/AccessControl/ReaderAcrossHost/capabilities ..................................................... 258
5.93 /ISAPI/AccessControl/ReaderAcrossHost ......................................................................... 258
5.94 /ISAPI/AccessControl/ServerDevice/capabilities ............................................................. 259
5.95 /ISAPI/AccessControl/ServerDevice ................................................................................. 259
5.96 /ISAPI/AccessControl/SubmarineBackMode/capabilities ................................................ 260
5.97 /ISAPI/AccessControl/SubmarineBackReader/capabilities .............................................. 261
5.98 /ISAPI/AccessControl/SubmarineBackMode ................................................................... 261
5.99 /ISAPI/AccessControl/SubmarineBackReader/ConfigureNo/<ID> ................................... 262
5.100 /ISAPI/AccessControl/StartReaderInfo/capabilities ....................................................... 262
5.101 /ISAPI/AccessControl/StartReaderInfo ........................................................................... 263

x
 Device Network SDK (Access Control on Person) Developer Guide

5.102 /ISAPI/AccessControl/SubmarineBackHostInfo/capabilities .......................................... 263

5.103 /ISAPI/AccessControl/SubmarineBack/capabilities ....................................................... 264
5.104 /ISAPI/AccessControl/SubmarineBackHostInfo/ConfigureNo/<ID> ............................... 264
5.105 /ISAPI/AccessControl/SubmarineBack ........................................................................... 265
5.106 /ISAPI/AccessControl/ClearAntiSneak?format=json ...................................................... 266
5.107 /ISAPI/AccessControl/CardReaderAntiSneakCfg/<ID>?format=json ............................. 266
5.108 /ISAPI/AccessControl/AcsEvent?format=json ................................................................ 267
5.109 /ISAPI/AccessControl/AntiSneakCfg/capabilities?format=json ...................................... 267
5.110 /ISAPI/AccessControl/AntiSneakCfg?format=json ......................................................... 268
5.111 /ISAPI/AccessControl/capabilities .................................................................................. 268
5.112 /ISAPI/AccessControl/CardInfo/capabilities?format=json ............................................. 269
5.113 /ISAPI/AccessControl/AcsEvent/capabilities?format=json ............................................. 269
5.114 /ISAPI/AccessControl/ClearAntiSneak/capabilities?format=json ................................... 269
5.115 /ISAPI/AccessControl/ClearAntiSneakCfg?format=json ................................................. 270
5.116 /ISAPI/AccessControl/ClearAntiSneakCfg/capabilities?format=json ............................. 270
5.117 /ISAPI/AccessControl/CardReaderAntiSneakCfg/capabilities?format=json ................... 271
5.118 /ISAPI/AccessControl/PrinterCfg/capabilities?format=json ........................................... 271
5.119 /ISAPI/AccessControl/PrinterCfg?format=json .............................................................. 271
5.120 /ISAPI/Intelligent/FDLib/capabilities?format=json ........................................................ 272
5.121 /ISAPI/Intelligent/FDLib?format=json ............................................................................ 272
5.122 /ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType= ........................................ 273
5.123 /ISAPI/Intelligent/FDLib/Count?format=json ................................................................. 275
5.124 /ISAPI/Intelligent/FDLib/Count?format=json&FDID=&faceLibType= ............................. 275
5.125 /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json ................................................ 276
5.126 /ISAPI/Intelligent/FDLib/FDSearch?format=json ........................................................... 276
5.127 /ISAPI/Intelligent/FDLib/FDModify?format=json ........................................................... 276
5.128 /ISAPI/Intelligent/FDLib/FDSearch/Delete?format=json&FDID=&faceLibType= ........... 277
5.129 /ISAPI/Intelligent/FDLib/FDSetUp?format=json ............................................................ 277

xi
 Device Network SDK (Access Control on Person) Developer Guide

5.130 /ISAPI/System/PictureServer?format=json .................................................................... 278

Chapter 6 Request and Response Message ............................................................................. 280
6.1 JSON_AcsEventCond .......................................................................................................... 280
6.2 JSON_AcsEvent .................................................................................................................. 281
6.3 JSON_AcsEventTotalNum ................................................................................................... 283
6.4 JSON_AcsEventTotalNumCond .......................................................................................... 283
6.5 JSON_AddFaceRecordCond ................................................................................................ 284
6.6 JSON_AddFaceRecordResult .............................................................................................. 286
6.7 JSON_AntiSneakCfg ............................................................................................................ 287
6.8 JSON_AttendanceStatusModeCfg ...................................................................................... 287
6.9 JSON_AttendanceStatusRuleCfg ........................................................................................ 288
6.10 JSON_BatchEditFaceRecord ............................................................................................. 288
6.11 JSON_Cap_AcsEvent ........................................................................................................ 289
6.12 JSON_Cap_AcsEventTotalNum ......................................................................................... 295
6.13 JSON_Cap_AntiSneakCfg .................................................................................................. 297
6.14 JSON_Cap_AttendanceStatusModeCfg ............................................................................ 297
6.15 JSON_Cap_AttendanceStatusRuleCfg .............................................................................. 297
6.16 JSON_Cap_CardInfo ......................................................................................................... 298
6.17 JSON_Cap_CardReaderAntiSneakCfg ............................................................................... 300
6.18 JSON_Cap_EventOptimizationCfg .................................................................................... 301
6.19 JSON_Cap_ClearAntiSneak .............................................................................................. 301
6.20 JSON_Cap_ClearAntiSneakCfg ......................................................................................... 301
6.21 JSON_Cap_FaceRecognizeMode ...................................................................................... 302
6.22 JSON_Cap_FingerPrintCfg ................................................................................................ 302
6.23 JSON_Cap_FingerPrintDelete ........................................................................................... 304
6.24 JSON_Cap_LogModeCfg ................................................................................................... 305
6.25 JSON_Cap_OSDPModify .................................................................................................. 305
6.26 JSON_Cap_OSDPStatus .................................................................................................... 305

xii
 Device Network SDK (Access Control on Person) Developer Guide

6.27 JSON_Cap_PrinterCfg ....................................................................................................... 306

6.28 JSON_Cap_RemoteControlBuzzer .................................................................................... 308
6.29 JSON_Cap_UserInfo ......................................................................................................... 308
6.30 JSON_Cap_UserInfoDetail ................................................................................................ 312
6.31 JSON_CapturePreset ........................................................................................................ 313
6.32 JSON_CapturePresetCap .................................................................................................. 313
6.33 JSON_CaptureProgress .................................................................................................... 313
6.34 JSON_CaptureRule ........................................................................................................... 314
6.35 JSON_CaptureRuleCap ..................................................................................................... 314
6.36 JSON_CardEncryption ...................................................................................................... 315
6.37 JSON_CardInfo ................................................................................................................. 315
6.38 JSON_CardInfo_Collection ............................................................................................... 316
6.39 JSON_CardInfoCap ........................................................................................................... 316
6.40 JSON_CardInfoCount ....................................................................................................... 316
6.41 JSON_CardInfoDelCond ................................................................................................... 317
6.42 JSON_CardInfoSearch ...................................................................................................... 317
6.43 JSON_CardInfoSearchCond .............................................................................................. 318
6.44 JSON_CardOperationsCap ................................................................................................ 318
6.45 JSON_CardParam ............................................................................................................. 322
6.46 JSON_CardProto ............................................................................................................... 322
6.47 JSON_CardReaderAntiSneakCfg ....................................................................................... 323
6.48 JSON_CardResetResponse ............................................................................................... 323
6.49 JSON_ClearAntiSneak ...................................................................................................... 323
6.50 JSON_ClearAntiSneakCfg ................................................................................................. 324
6.51 JSON_ControlBlock .......................................................................................................... 324
6.52 JSON_CreateFPLibCond ................................................................................................... 324
6.53 JSON_CreateFPLibResult .................................................................................................. 325
6.54 JSON_DataBlock ............................................................................................................... 325

xiii
 Device Network SDK (Access Control on Person) Developer Guide

6.55 JSON_DataBlockCtrl ......................................................................................................... 325

6.56 JSON_DataOutputCfg ....................................................................................................... 326
6.57 JSON_DataOutputProgress .............................................................................................. 326
6.58 JSON_DataTrans ............................................................................................................... 326
6.59 JSON_DelFaceRecord ....................................................................................................... 326
6.60 JSON_EditFPlibInfo ........................................................................................................... 327
6.61 JSON_EventOptimizationCfg ............................................................................................ 327
6.62 JSON_FaceRecognizeMode .............................................................................................. 327
6.63 JSON_FaceRecordNumInAllFPLib ..................................................................................... 328
6.64 JSON_FaceRecordNumInOneFPLib .................................................................................. 328
6.65 JSON_FingerPrintCfg ........................................................................................................ 329
6.66 JSON_FingerPrintCond ..................................................................................................... 329
6.67 JSON_FingerPrintDelete ................................................................................................... 330
6.68 JSON_FingerPrintDeleteProcess ...................................................................................... 331
6.69 JSON_FingerPrintInfo ....................................................................................................... 331
6.70 JSON_FingerPrintModify .................................................................................................. 331
6.71 JSON_FingerPrintStatus ................................................................................................... 332
6.72 JSON_FPLibCap ................................................................................................................ 332
6.73 JSON_FPLibListInfo ........................................................................................................... 334
6.74 JSON_IdentityInfo ............................................................................................................ 334
6.75 JSON_IdentityInfoCap ...................................................................................................... 335
6.76 JSON_IdentityInfoCond .................................................................................................... 337
6.77 JSON_IRCfg ....................................................................................................................... 338
6.78 JSON_IRCfgCap ................................................................................................................. 338
6.79 JSON_LogModeCfg ........................................................................................................... 338
6.80 JSON_NFCCfg ................................................................................................................... 339
6.81 JSON_NFCCfgCap ............................................................................................................. 339
6.82 JSON_OfflineCaptureCap ................................................................................................. 339

xiv
 Device Network SDK (Access Control on Person) Developer Guide

6.83 JSON_OSDPModify .......................................................................................................... 343

6.84 JSON_OSDPStatus ............................................................................................................ 344
6.85 JSON_PictureServerInformation ...................................................................................... 344
6.86 JSON_PrinterCfg ............................................................................................................... 345
6.87 JSON_RemoteControlBuzzer ............................................................................................ 346
6.88 JSON_ResponseStatus ...................................................................................................... 347
6.89 JSON_RFCardCfg .............................................................................................................. 347
6.90 JSON_RFCardCfgCap ........................................................................................................ 347
6.91 JSON_RuleInfo ................................................................................................................. 348
6.92 JSON_SearchFaceRecordCond ......................................................................................... 349
6.93 JSON_SearchFaceRecordResult ........................................................................................ 350
6.94 JSON_SearchTaskCond ..................................................................................................... 351
6.95 JSON_SearchTaskResponse .............................................................................................. 351
6.96 JSON_SectionEncryption .................................................................................................. 353
6.97 JSON_SetFaceRecord ....................................................................................................... 354
6.98 JSON_SingleFPLibInfo ...................................................................................................... 355
6.99 JSON_UserInfo ................................................................................................................. 355
6.100 JSON_UserInfoCount ..................................................................................................... 357
6.101 JSON_UserInfoDelCond ................................................................................................. 357
6.102 JSON_UserInfoDetail ...................................................................................................... 358
6.103 JSON_UserInfoDetailDeleteProcess ............................................................................... 358
6.104 JSON_UserInfoSearch .................................................................................................... 358
6.105 JSON_UserInfoSearchCond ............................................................................................ 360
6.106 JSON_Verification ........................................................................................................... 360
6.107 XML_AcsAbility .............................................................................................................. 361
6.108 XML_CaptureFingerPrint ............................................................................................... 393
6.109 XML_CaptureFingerPrintCond ....................................................................................... 393
6.110 XML_Cap_AccessControl ............................................................................................... 393

xv
 Device Network SDK (Access Control on Person) Developer Guide

6.111 XML_Cap_CaptureFingerPrint ....................................................................................... 400

6.112 XML_Cap_ClearCardRecord ........................................................................................... 401
6.113 XML_Cap_ClearSubmarineBack ..................................................................................... 401
6.114 XML_Cap_GetAcsEvent .................................................................................................. 402
6.115 XML_Cap_DeployInfo .................................................................................................... 403
6.116 XML_Cap_FaceCompareCond ........................................................................................ 403
6.117 XML_Cap_IdentityTerminal ............................................................................................ 404
6.118 XML_Cap_ReaderAcrossHost ......................................................................................... 405
6.119 XML_Cap_ServerDevice ................................................................................................. 405
6.120 XML_Cap_StartReaderInfo ............................................................................................. 405
6.121 XML_Cap_SubmarineBack ............................................................................................. 405
6.122 XML_Cap_SubmarineBackHostInfo ............................................................................... 406
6.123 XML_Cap_SubmarineBackMode ................................................................................... 406
6.124 XML_Cap_SubmarineBackReader .................................................................................. 406
6.125 XML_ClearCardRecord ................................................................................................... 407
6.126 XML_ClearSubmarineBack ............................................................................................. 407
6.127 XML_DeployInfo ............................................................................................................ 408
6.128 XML_Desc_AcsAbility ..................................................................................................... 408
6.129 XML_FaceCompareCond ................................................................................................ 408
6.130 XML_IdentityTerminal .................................................................................................... 409
6.131 XML_ReaderAcrossHost ................................................................................................. 410
6.132 XML_ResponseStatus ..................................................................................................... 410
6.133 XML_ServerDevice ......................................................................................................... 411
6.134 XML_StartReaderInfo ..................................................................................................... 411
6.135 XML_SubmarineBack ..................................................................................................... 411
6.136 XML_SubmarineBackHostInfo ....................................................................................... 411
6.137 XML_SubmarineBackMode ............................................................................................ 412
6.138 XML_SubmarineBackReader .......................................................................................... 412

xvi
 Device Network SDK (Access Control on Person) Developer Guide

6.139 XML_SubscribeEvent ...................................................................................................... 412

Appendix A. Appendixes ......................................................................................................... 414
A.1 Access Control Event Types ............................................................................................... 414
A.2 Event Linkage Types ........................................................................................................... 429
A.3 Device Network SDK Errors ................................................................................................ 441
A.4 HCNetSDK Log Types ......................................................................................................... 482
A.5 Error Codes in ResponseStatus .......................................................................................... 512

xvii
 Device Network SDK (Access Control on Person) Developer Guide

Chapter 1 Access Control

Access Control is the selective restriction of access to a place or other resources. The access control
applications integrated by Device Network SDK (here is referred as to "HCNetSDK") in this manual
take the person as the management and control unit, which indicates that all applications are
integrated around the basic unit. That is, linking fingerprints, faces, and other attributes to a card
will be replaced by linking fingerprints, cards, and other attributes to a person.

1.1 Introduction
This manual mainly introduces the integration flows and related APIs for access controller,
fingerprint access control terminal, fingerprint time attendance terminal, and so on, to implement
the following functions: schedule configuration, person/card/fingerprint information management,
alarm/event configuration, door/elevator/buzzer control, anti-passing back, and so on.

1.2 Update History

Summary of Changes in Version 6.1.3.X_Sept., 2019

Related Products: Enrollment Station with Models DS-K1F600-D6E and DS-K1F600-D6E-F in Version
1.0
1. Extended access control capability message XML_Cap_AccessControl (related URL: /ISAPI/
AccessControl/capabilities ; related API: NET_DVR_STDXMLConfig ):
added five nodes: <isSupportCaptureIDInfo> (whether it supports collecting ID card
information), <isSupportCaptureRule> (whether it supports configuring online collection rules),
<isSupportCapturePresetParam> (whether it supports configuring preset parameters of online
collection), <isSupportOfflineCapture> (whether it supports offline collection), and
<isSupportCardOperations> (whether it supports card operation).
2. Added the function of online collecting data, refer to Online Collect Data .
3. Extended capability message JSON_CardInfoCap and parameter message
JSON_CardInfo_Collection of collecting card information (related URLs: /ISAPI/AccessControl/
CaptureCardInfo/capabilities?format=json and /ISAPI/AccessControl/CaptureCardInfo?
format=json ; related API: NET_DVR_STDXMLConfig ):
added a node cardType (card type).
4. Extended collected face data structure NET_DVR_CAPTURE_FACE_CFG (related API:
NET_DVR_StartRemoteConfig ):
added three members: byFacePicQuality (face quality in the face picture),
byInfraredFacePicQuality (face quality in the infrared face picture), and strcFeature (feature
information in the matted face picture) by 58 bytes.
5. Extended structure about picture data in JSON format NET_DVR_JSON_DATA_CFG (related API:
NET_DVR_SendRemoteConfig ):

1
 Device Network SDK (Access Control on Person) Developer Guide

added two members: dwInfraredFacePicSize (data size of infrared face picture) and
lpInfraredFacePicBuffer (buffer of infrared face picture data) by eight bytes.
6. Added the function of offline collecting data, refer to Offline Collect Data .
7. Added three error codes to Device Network SDK Errors : 1927-"NET_ERR_CAPTURE_TIMEOUT"
(collection timed out), 1928-"NET_ERR_LOW_SCORE" (low quality of collected data), and
1929-"NET_ERR_OFFLINE_CAPTURING" (the device is collecting data offline and cannot
respond).
8. Added two sub status codes: 0x30006000-"captureTimeout" (data collection timed out) and
0x30006001-"lowScore" (low quality of collected data) to status code 3 (Device Error) in Error
Codes in ResponseStatus .
9. Added functions of operating cards, refer to Card Operation for details.
10. Added functions of configuring active infrared intrusion parameters (related API:
NET_DVR_STDXMLConfig ):
Get configuration capability: GET /ISAPI/AccessControl/Configuration/IRCfg/capabilities?
format=json
Get or set parameters: GET or PUT /ISAPI/AccessControl/Configuration/IRCfg?format=json
11. Added multiple log types, refer to HCNetSDK Log Types for details:
added six minor log types to the "MAJOR_EXCEPTION" log type:
MINOR_AUXILIARY_BOARD_OFFLINE (0x43c), MINOR_AUXILIARY_BOARD_RESUME (0x43d),
MINOR_IDCARD_SECURITY_MOUDLE_EXCEPTION (0x43e),
MINOR_IDCARD_SECURITY_MOUDLE_RESUME (0x43f), MINOR_FP_PERIPHERAL_EXCEPTION
(0x440), and MINOR_FP_PERIPHERAL_RESUME (0x441);
added three minor log types to the "MAJOR_OPERATION" log type:
MINOR_OFFLINE_DATA_OUTPUT (0x423), MINOR_CREATE_SSH_LINK (0x42d), and
MINOR_CLOSE_SSH_LINK (0x42e);
added 14 minor log types to the "MAJOR_INFORMATION" log type:
MINOR_LIVE_DETECT_OPEN ( 0x400), MINOR_LIVE_DETECT_CLOSE (0x401),
MINOR_CLEAR_DATA_COLLECTION (0x402), MINOR_DELETE_DATA_COLLECTION (0x403),
MINOR_EXPORT_DATA_COLLECTION (0x404), MINOR_CARD_LEN_CONFIG (0x405),
MINOR_DATA_BASE_INIT_FAILED (0x406), MINOR_DATA_BASE_PATCH_UPDATE (0x407),
MINOR_PSAM_CARD_INSERT (0x408), MINOR_PSAM_CARD_REMOVE (0x409),
MINOR_HARD_FAULT_REBOOT (0x40a), MINOR_PSAM_CARD_OCP (0x40b),
MINOR_STACK_OVERFLOW (0x40c), and MINOR_PARM_CFG (0x40d).

Summary of Changes in Version 6.1.0.151_July, 2019

Related Products: DS-KH8350 Series, DS-KH6320 Series, and DS-KH8520 Series Indoor Station;
DSKD8003 Series Door Station
1. Extended person management capability JSON_Cap_UserInfo (related API:
NET_DVR_STDXMLConfig ; URL: /ISAPI/AccessControl/UserInfo/capabilities?format=json ):
added four nodes, i.e., "roomNumber" (room No.), "floorNumber" (floor No.), "callNumbers"
(room No. list to be called), and "floorNumbers" (floor No. list).
2. Extended person information message JSON_UserInfo (related API:
NET_DVR_StartRemoteConfig ; URLs: /ISAPI/AccessControl/UserInfo/Record?format=json , /

2
 Device Network SDK (Access Control on Person) Developer Guide

ISAPI/AccessControl/UserInfo/Modify?format=json , and /ISAPI/AccessControl/UserInfo/

SetUp?format=json ):
added two nodes, i.e., "callNumbers" (room No. list to be called) and "floorNumbers" (floor No.
list).
3. Extended access control capability XML_AcsAbility (related API: NET_DVR_GetDeviceAbility ;
capability type: 0x801-"ACS_ABILITY"):
added two sub nodes, i.e., <outdoorModules> (whether to support upgrading modules of door
station) and <modules> (supported module types) to the node <AcsUpgrade>.

Summary of Changes in Version 6.1.0.11_July, 2019

Related Products: DS-K1A802 Series, DS-K1A802A Series, and DS-K1A8503 Series Fingerprint Time
Attendance Terminal; DS-K1T804 Series, DS-K1T8003 Series, and DS-K1T8004 Series Fingerprint
Access Control Terminal.
1. Extended person management capability message JSON_Cap_UserInfo and person information
message JSON_UserInfo (related URLs: /ISAPI/AccessControl/UserInfo/capabilities?
format=json , /ISAPI/AccessControl/UserInfo/Record?format=json , and /ISAPI/AccessControl/
UserInfo/Modify?format=json ; related API: NET_DVR_STDXMLConfig ):
added a node addUser (whether to add the person if the person information being edited does
not exist);
added a person authentication mode "cardOrFpOrPw" (card or fingerprint or password) to the
node userVerifyMode.
2. Extended person information search result message JSON_UserInfoSearch (related URL: /ISAPI/
AccessControl/UserInfo/Search?format=json ; related API: NET_DVR_STDXMLConfig ):
added a person authentication mode "cardOrFpOrPw" (card or fingerprint or password) to the
sub node userVerifyMode of the node UserInfo (person information).
3. Extended card information capability message JSON_Cap_CardInfo and card information
message JSON_CardInfo (related URLs: /ISAPI/AccessControl/CardInfo/capabilities?
format=json and /ISAPI/AccessControl/CardInfo/Modify?format=json ; related API:
NET_DVR_STDXMLConfig ):
added a node addCard (whether to add the card if the card information being edited does not
exist).
4. Extended condition message of searching for access control events JSON_AcsEventCond
(related URL: /ISAPI/AccessControl/AcsEvent?format=json ; related API:
NET_DVR_STDXMLConfig ):
added a node eventAttribute (event attribute).
5. Extended result message of searching for access control events JSON_AcsEvent (related URL: /
ISAPI/AccessControl/AcsEvent?format=json ; related API: NET_DVR_STDXMLConfig ):
added two sub nodes: attendanceStatus (attendance status) and statusValue (status value) to
the node InfoList (event details);
added an authentication mode "cardOrFpOrPw" (card or fingerprint or password) to the sub
node currentVerifyMode of the node InfoList (event details).

3
 Device Network SDK (Access Control on Person) Developer Guide

6. Extended capability message of searching for access control events JSON_Cap_AcsEvent

(related URL: /ISAPI/AccessControl/AcsEvent/capabilities?format=json ; related API:
NET_DVR_STDXMLConfig ):
added a sub node eventAttribute (event attribute) to the node AcsEventCond (search
conditions);
added two sub nodes: attendanceStatus (attendance status) and statusValue (status value) to
the node InfoList (event details);
added an authentication mode "cardOrFpOrPw" (card or fingerprint or password) to the sub
node currentVerifyMode of the node InfoList (event details).
7. Extended condition message of getting the total number of access control events by conditions
JSON_AcsEventTotalNumCond (related URL: /ISAPI/AccessControl/AcsEventTotalNum?
format=json ; related API: NET_DVR_STDXMLConfig ):
added a node eventAttribute (event attribute).
8. Extended capability message of getting the total number of the access control events by
conditions JSON_Cap_AcsEventTotalNum (related URL: /ISAPI/AccessControl/
AcsEventTotalNum/capabilities?format=json ; related API: NET_DVR_STDXMLConfig ):
added a sub node eventAttribute (event attribute) to the node AcsEventTotalNumCond (search
conditions).
9. Extended access control capability message XML_Cap_AccessControl (related URL: /ISAPI/
AccessControl/capabilities ; related API: NET_DVR_STDXMLConfig ):
added five nodes: <isSupportRemoteControlPWChcek> (whether to support verifying the
password for remote door control), <isSupportRemoteControlPWCfg> (whether to support
configuring password for remote door control), <isSupportAttendanceStatusModeCfg>
(whether to support configuring attendance mode), <isSupportAttendanceStatusRuleCfg>
(whether to support configuring attendance status and rule), and <isSupportCaptureCardInfo>
(whether to support collecting card information).
10. Extended condition structure about getting access control events
NET_DVR_ACS_EVENT_COND (related API: NET_DVR_StartRemoteConfig ):
added a member byEventAttribute (event attribute) by one reserved byte.
11. Extended access control event details structure NET_DVR_ACS_EVENT_DETAIL (related API:
NET_DVR_StartRemoteConfig ):
added three members: byAttendanceStatus (attendance status), byStatusValue (attendance
status value), and byEventAttribute (event attribute) by three reserved bytes;
added an authentication mode 27 (card or fingerprint or password) to the member
byCurrentVerifyMode.
12. Extended structure about extended access control event information
NET_DVR_ACS_EVENT_INFO_EXTEND :
added three members: byAttendanceStatus (attendance status), byStatusValue (attendance
status value), and byUUID (UUID) by 38 bytes.
13. Added the function of configuring attendance status, refer to Configure Attendance Status for
details.
14. Added the function of collecting card information, refer to Collect Card Information for details.

4
 Device Network SDK (Access Control on Person) Developer Guide

15. Extended access control capability message XML_AcsAbility (related API:

NET_DVR_GetDeviceAbility ; capability type: 0x801-"ACS_ABILITY"):
added a sub node <ubootUpgrade> (whether to support upgrading uboot) to the node
<AcsUpgrade>;
added an authentication mode "cardOrFpOrPw" (card or fingerprint or password) to the sub
node <verifyType> of the node <WeekPlan> of <DoorStatusPlan> and
<CardReaderVerifyTypePlan>, respectively;
added an authentication mode 27 (card or fingerprint or password) to the sub node
<defaultVerifyMode> of the node <CardReaderCfg>.
16. Extended the access control event types in Access Control Event Types :
added six event types to MAJOR_EVENT: "MINOR_LOCAL_UPGRADE_FAIL" (Local Upgrade
Failed), "MINOR_REMOTE_UPGRADE_FAIL" (Remote Upgrade Failed),
"MINOR_REMOTE_EXTEND_MODULE_UPGRADE_SUCC" (Extension Module is Remotely
Upgraded), "MINOR_REMOTE_EXTEND_MODULE_UPGRADE_FAIL" (Upgrading Extension
Module Remotely Failed), "MINOR_REMOTE_FINGER_PRINT_MODULE_UPGRADE_SUCC"
(Fingerprint Module is Remotely Upgraded), and
"MINOR_REMOTE_FINGER_PRINT_MODULE_UPGRADE_FAIL" (Upgrading Fingerprint Module
Remotely Failed).

Summary of Changes in Version 6.1.0.11_June, 2019

Related Products: DS-K1T607 Series, DS-K1T610 Series, and DS-K5607 Series Face Recognition
Terminal in Version 1.1
1. Extended configuration capability message of intelligent identity recognition terminal
XML_Cap_IdentityTerminal and parameter message of intelligent identity recognition terminal
XML_IdentityTerminal (related URLs: /ISAPI/AccessControl/IdentityTerminal/capabilities and /
ISAPI/AccessControl/IdentityTerminal ; related API: NET_DVR_STDXMLConfig ):
added a node <readCardRule> (card No. setting rule).
2. Added the function of managing face information (including creating face picture library,
managing face records in the face picture library, and configuring facial recognition mode), refer
to Manage Face Information for details.
3. Extended person management capability message JSON_Cap_UserInfo (related URL: /ISAPI/
AccessControl/UserInfo/capabilities?format=json ; related API: NET_DVR_STDXMLConfig ):
added a sub node searchID (search ID) to the node UserInfoSearchCond (search conditions);
added a node maxRecordNum (supported maximum number of records (person records)).
4. Extended card information capability message JSON_Cap_CardInfo (related URL: /ISAPI/
AccessControl/CardInfo/capabilities?format=json ; related API: NET_DVR_STDXMLConfig ):
added a sub node searchID (search ID) to the node CardInfoSearchCond (search conditions);
added a node maxRecordNum (supported maximum number of records (card records)).
5. Extended fingerprint configuration capability message JSON_Cap_FingerPrintCfg (related URL: /
ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json ; related API:
NET_DVR_STDXMLConfig ):
added a node searchID (search ID).

5
 Device Network SDK (Access Control on Person) Developer Guide

6. Added the function of getting information of face modeling failure after upgrading device, refer
to Other Configurations for details.
7. Extended access control capability message XML_Cap_AccessControl (related URL: /ISAPI/
AccessControl/capabilities ; related API: NET_DVR_STDXMLConfig ):
added three nodes: <isSupportCaptureFace> (whether to support collecting face pictures),
<isSupportCaptureInfraredFace> (whether to support collecting infrared face pictures), and
<isSupportFaceRecognizeMode> (whether to support configuring facial recognition mode).

Summary of Changes in Version 6.1.0.10_July, 2019

Related Products: DS-K1T804 Series Fingerprint Access Control Terminal.
1. Added the function of enabling or disabling NFC (Near-Field Communication) function (related
API: NET_DVR_STDXMLConfig ):
Get the configuration capability: GET /ISAPI/AccessControl/Configuration/NFCCfg/capabilities?
format=json ;
Get parameters: GET /ISAPI/AccessControl/Configuration/NFCCfg?format=json ;
Set parameters: PUT /ISAPI/AccessControl/Configuration/NFCCfg?format=json .
2. Added the function of enabling or disabling RF (Radio Frequency) card recognition (related API:
NET_DVR_STDXMLConfig ):
Get the configuration capability: GET /ISAPI/AccessControl/Configuration/RFCardCfg/
capabilities?format=json ;
Get parameters: GET /ISAPI/AccessControl/Configuration/RFCardCfg?format=json ;
Set parameters: PUT /ISAPI/AccessControl/Configuration/RFCardCfg?format=json .
3. Extended access control capability message XML_Cap_AccessControl (related URL: /ISAPI/
AccessControl/capabilities ; related API: NET_DVR_STDXMLConfig ):
added two nodes: <isSupportNFCCfg> (whether the device supports enabling or disabling NFC
function ) and <isSupportRFCardCfg> (whether the device supports enabling or disabling RF
card recognition).
4. Extended access control capability message XML_AcsAbility (related API:
NET_DVR_GetDeviceAbility ; capability type: "0x801-ACS_ABILITY"):
added eight event types to the sub node <EventEntry> (index: 3) of the node <EventLinkage>
(event card linkage): "InformalMifareCardVerifyFail" (authentication failed: invalid Mifare card),
"CPUCardEncryptVerifyFail" (verifying CPU card encryption failed), "NFCDisableVerifyFail"
(disabling NFC verification failed), "EMCardRecognizeNotEnabled" (EM card recognition is
disabled), "M1CardRecognizeNotEnabled" (M1 card recognition is disabled),
"CPUCardRecognizeNotEnabled" (CPU card recognition is disabled),
"IDCardRecognizeNotEnabled" (ID card recognition is disabled), and "CardSetSecretKeyFail"
(importing key to the card failed).
5. Extended the access control event types in Access Control Event Types :
added four operation event types to MAJOR_OPERATION:
"MINOR_M1_CARD_ENCRYPT_VERIFY_OPEN" (M1 Card Encryption Verification Enabled),
"MINOR_M1_CARD_ENCRYPT_VERIFY_CLOSE" (M1 Card Encryption Verification Disabled),
"MINOR_NFC_FUNCTION_OPEN" (Opening Door with NFC Card Enabled), and
"MINOR_NFC_FUNCTION_CLOSE" (Opening Door with NFC Card Disabled);

6
 Device Network SDK (Access Control on Person) Developer Guide

added eight event types to MAJOR_EVENT: "MINOR_INFORMAL_MIFARE_CARD_VERIFY_FAIL"

(Authentication Failed: Invalid Mifare Card), "MINOR_CPU_CARD_ENCRYPT_VERIFY_FAIL"
(Verifying CPU Card Encryption Failed), "MINOR_NFC_DISABLE_VERIFY_FAIL" (Disabling NFC
Verification Failed ), "MINOR_EM_CARD_RECOGNIZE_NOT_ENABLED" (EM Card Recognition
Disabled), "MINOR_M1_CARD_RECOGNIZE_NOT_ENABLED" (M1 Card Recognition Disabled),
"MINOR_CPU_CARD_RECOGNIZE_NOT_ENABLED" (CPU Card Recognition Disabled),
"MINOR_ID_CARD_RECOGNIZE_NOT_ENABLED" (ID Card Recognition Disabled), and
"MINOR_CARD_SET_SECRET_KEY_FAIL" (Importing Key to Card Failed).
6. Extended the event linkage types in Event Linkage Types :
added eight event linkage types of the authentication unit:
"EVENT_ACS_INFORMAL_MIFARE_CARD_VERIFY_FAIL" (Authentication Failed: Invalid Mifare
Card), "EVENT_ACS_CPU_CARD_ENCRYPT_VERIFY_FAIL" (Verifying CPU Card Encryption Failed),
"EVENT_ACS_NFC_DISABLE_VERIFY_FAIL" (Disabling NFC Verification Failed ),
"EVENT_ACS_EM_CARD_RECOGNIZE_NOT_ENABLED" (EM Card Recognition Disabled),
"EVENT_ACS_M1_CARD_RECOGNIZE_NOT_ENABLED" (M1 Card Recognition Disabled),
"EVENT_ACS_CPU_CARD_RECOGNIZE_NOT_ENABLED" (CPU Card Recognition Disabled),
"EVENT_ACS_ID_CARD_RECOGNIZE_NOT_ENABLED" (ID Card Recognition Disabled), and
"EVENT_ACS_CARD_SET_SECRET_KEY_FAIL" (Importing Key to Card Failed).

Summary of Changes in Version 6.0.2.25_May, 2019

Related Products: DS-K2600 Series Access Controller in Version 2.1.0
1. Extended person information message JSON_UserInfo and person information search result
message JSON_UserInfoSearch (related URLs: /ISAPI/AccessControl/UserInfo/Record?
format=json , /ISAPI/AccessControl/UserInfo/Search?format=json , and /ISAPI/AccessControl/
UserInfo/Modify?format=json ; related API: NET_DVR_STDXMLConfig ):
added 11 person authentication modes "faceOrFpOrCardOrPw" (face or fingerprint or card or
password), "faceAndFp" (face+fingerprint), "faceAndPw" (face+password), "faceAndCard" (face
+card), "face" (face), "faceAndFpAndCard" (face+fingerprint+card), "faceAndPwAndFp" (face
+password+fingerprint), "employeeNoAndFace" (employee No.+face), "faceOrfaceandCard"
(face or face+card), "fpOrface" (fingerprint or face), "cardOrfaceOrPw" (card or face or
password) to the sub node userVerifyMode in the node UserInfo.
2. Added the function of setting person information (related API: NET_DVR_STDXMLConfig ):
PUT /ISAPI/AccessControl/UserInfo/SetUp?format=json .
3. Extended person management capability message JSON_Cap_UserInfo (related URL: /ISAPI/
AccessControl/UserInfo/capabilities?format=json ; related API: NET_DVR_STDXMLConfig ):
added a function type "setUp" (set person information) to the node supportFunction;
added two sub nodes timeRangeBegin (start time that can be configured) and timeRangeEnd
(end time that can be configured) to the node Valid.
4. Extended card information message JSON_CardInfo (related URL: /ISAPI/AccessControl/
CardInfo/Record?format=json ; related API: NET_DVR_STDXMLConfig ):
add a node checkEmployeeNo (whether to check the existence of the employee No. (person
ID)).

7
 Device Network SDK (Access Control on Person) Developer Guide

5. Added the function of setting card information (related API: NET_DVR_STDXMLConfig ): PUT /
ISAPI/AccessControl/CardInfo/SetUp?format=json .
6. Extended card information capability message JSON_Cap_CardInfo (related URL: /ISAPI/
AccessControl/CardInfo/capabilities?format=json ; related API: NET_DVR_STDXMLConfig ):
added a function type "setUp" (set card information) to the node supportFunction;
added a node checkEmployeeNo (whether to check the existence of the employee No. (person
ID)).
7. Added the function of managing fingerprint, refer to Manage Fingerprint Information for
details.
8. Extended parameter union about event and card linkage configuration
NET_DVR_EVETN_CARD_LINKAGE_UNION (related API: NET_DVR_SetDeviceConfig ):
added a member byEmployeeNo (employee No. (person ID)) by 32 bytes.
9. Extended parameter structure about event and card linkage configuration
NET_DVR_EVENT_CARD_LINKAGE_CFG_V51 (related API: NET_DVR_SetDeviceConfig ):
added a linkage type "3" (employee No. (person ID) linkage) to the member byProMode.
10. Extended access control event details structure NET_DVR_ACS_EVENT_DETAIL (related API:
NET_DVR_StartRemoteConfig ):
added 11 authentication modes: 10 (face or fingerprint or card or password), 11 (face
+fingerprint), 12 (face+password), 13 (face+card), 14 (face), 19 (face+fingerprint+card), 20 (face
+password+fingerprint), 21 (employee No.+face), 22 (face or face+card), 23 (fingerprint or
face), and 24 (card or face or password) to the member byCurrentVerifyMode;
added a member byEmployeeNo (employee No. (person ID)).
11. Added the function of getting the total number of access control events by specific conditions
(related API: NET_DVR_STDXMLConfig ):
Get the capability: GET /ISAPI/AccessControl/AcsEventTotalNum/capabilities?format=json ;
Get the total number: POST /ISAPI/AccessControl/AcsEventTotalNum?format=json .
12. Added the structure about extended access control event information
NET_DVR_ACS_EVENT_INFO_EXTEND .
13. Extended access control alarm/event information structure
NET_DVR_ACS_ALARM_INFO_V50 :
added two members pAcsEventInfoExtend (it points to the structure
NET_DVR_ACS_EVENT_INFO_EXTEND when it is set to 1) and byAcsEventInfoExtend (whether
pAcsEventInfoExtend is valid).
14. Added the function of log mode configuration and event optimization configuration, refer to
Other Configurations for details.
15. Extended fingerprint and card reader parameters structure
NET_DVR_CARD_READER_CFG_V50 (related API: NET_DVR_SetDVRConfig ):
added two members bySupportDelFPByID (whether the fingerprint and card reader supports
deleting fingerprint by finger ID) and byDefaultVerifyMode (default authentication mode of
the fingerprint and card reader (factory settings)).
16. Extended access controller configuration parameter structure NET_DVR_ACS_CFG (related API:
NET_DVR_GetDVRConfig ):
added a member byProtocol (communication protocol type of the card reader).

8
 Device Network SDK (Access Control on Person) Developer Guide

17. Extended expiry date configuration structure NET_DVR_VALID_PERIOD_CFG (related API:

NET_DVR_GetDVRConfig and NET_DVR_SetDVRConfig ):
added a member byTimeType (time type).
18. Added the function of setting OSDP (Open Supervised Device Protocol) card reader, refer to
Device Settings for details.
19. Extended access control capability message XML_AcsAbility (related API:
NET_DVR_GetDeviceAbility ; capability type: "0x801-ACS_ABILITY"):
added two sub nodes <timeRangeBegin> (start time that can be configured) and
<timeRangeEnd> (end time that can be configured) to the node <Card> (card parameters
capability);
added a sub node <supportDelFPByID> (whether the fingerprint module supports deleting
fingerprint by finger ID) to the node <CardReaderCfg> (reader parameters capability);
added a sub node <cardReaderFPAlgorithmUpgrade> (whether to enable upgrading
fingerprint algorithm program of the fingerprint module) to the node <AcsUpgrade> (access
control upgrading capability);
added six sub nodes <isNotSupportOpenDoor> (whether the opening door linkage is not
supported), <isNotSupportCloseDoor> (whether the closing door linkage is not supported),
<isNotSupportNormalOpen> (whether the remaining door open is not supported),
<isNotSupportNormalClose> (whether the remaining door closed is not supported),
<isNotSupportAlarmout> (whether the alarm output linkage is not supported), and
<isNotSupportCapturePic> (whether the capture linkage is not supported) to the node
<EventLinkage> (event card linkage);
added an event type "LegalEventNearlyFull" (alarm of no memory for legal offline event
storage) to the sub node <EventEntry> (index: 0) of the node <EventLinkage> (event card
linkage);
added a sub node <isSupportFingerCover> (whether to overwrite the old fingerprint
information when applying a new fingerprint information linked to the same employee No.
(person ID)) to the node <FingerPrint> (fingerprint parameters).
20. Extended access control capability message XML_Cap_AccessControl (related URL: /ISAPI/
AccessControl/capabilities ; related API: NET_DVR_STDXMLConfig ):
added 49 nodes: from <isSupportRemoteControlDoor> to <isSupportLogModeCfg>.
21. Added two error codes to Device Network SDK Errors :
1925-NET_ERR_NOT_SUPPORT_DEL_FP_BY_ID (the fingerprint module does not support
deleting fingerprint by finger ID) and 1926-NET_ERR_TIME_RANGE (invalid range of the
effective period).
22. Added a sub status code 0x60001024-"eventNotSupport" (event subscription is not supported)
to status code 6 (Invalid Message Content) in Error Codes in ResponseStatus .

Summary of Changes in Version 5.3.6.0_Sept., 2018

Related Products: Access Controller with Version2.1; Fingerprint Access Control Terminal with
Version1.0.0; Fingerprint Time Attendance Terminal with Version 1.0.0

9
 Device Network SDK (Access Control on Person) Developer Guide

1. Added person management functional module, refer to for details.

2. Edited the integration method of card management and fingerprint management: passed
though the ISAPI protocol via HCNetSDK API to realize the functions. See and for details.
3. Added the control of buzzer and elevator, refer to Remotely Control Door, Elevator, and Buzzer
for details.
4. Edited the flow of access control event configuration and added the functions of receiving
access control event in listening mode, refer to Configure Access Control Event and Receive
Alarm/Event in Listening Mode for details.

Summary of Changes in Version 5.3.2.10_Feb., 2018

New document.

10
 Device Network SDK (Access Control on Person) Developer Guide

Chapter 2 Typical Applications

2.1 Data Collection

2.1.1 Online Collect Data

When the access control device is connected to the client software or platform via the network,
you can collect data (including ID card information, card information, face data, and fingerprint) on
the client software or platform remotely. The online collected data will be uploaded to the client
software or platform in real time.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

11
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-1 Programming Flow of Online Collecting Data

12
 Device Network SDK (Access Control on Person) Developer Guide

1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/

capabilities for getting the access control capability to check whether the device supports
configuring online data collection rules.
The access control capability is returned in XML_Cap_AccessControl by lpOutputParam.
If the device supports, the node <isSupportCaptureRule> is returned in the capability message
and its value is "true", and then you can perform the following steps.
Otherwise, rule configuration of online data collection is not supported, please end this task.
2. Configure online data collection rules.
1) Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/CaptureRule/capabilities?format=json for getting the configuration capability
of online data collection rules.
The capability is returned in the message JSON_CaptureRuleCap by lpOutputParam.
2) Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/CaptureRule?format=json for getting default or configured rule parameters of
online data collection for reference.
The rule parameters are returned in the message JSON_CaptureRule by lpOutputParam.
3) Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CaptureRule?format=json and set lpInputParam to JSON_CaptureRule for setting rule
parameters of online data collection.
3. Optional: Configure preset parameters of online data collection.
1) Check the access control capability XML_Cap_AccessControl to know whether the device
supports configuring preset parameters of online data collection.
If the device supports, the node <isSupportCapturePresetParam> is in the capability
message and its value is "true", and then you can continue to set preset parameters.
Otherwise, preset configuration of online data collection is not supported.
2) Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/CapturePresetParam/capabilities?format=json for getting the configuration
capability of preset parameters of online data collection.
The configuration capability is returned in the message JSON_CapturePresetCap by
lpOutputParam.
3) Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/CapturePresetParam?format=json for getting default or configured preset
parameters of online data collection for reference.
The preset parameters are returned in the message JSON_CapturePreset by lpOutputParam.
4) Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CapturePresetParam?format=json and set lpInputParam to the message
JSON_CapturePreset for setting preset parameters of online data collection.

13
 Device Network SDK (Access Control on Person) Developer Guide

Note
The preset parameters are used to display custom information on the device UI during data
collection. Currently, it only supports displaying the name of the person whose data is being
collected. The preset parameters should be configured again for each collection.
4. Perform the following operation(s) to collect ID card information, card information, face data, or
fingerprint online.
Collect ID Card a. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
Information ISAPI/AccessControl/capabilities for getting access control capability
to check whether the device supports online collecting ID card
information.
The capability is returned in the message XML_Cap_AccessControl by
lpOutputParam. If it supports, the node <isSupportCaptureIDInfo> is
returned and its value is "true". Otherwise, online ID card collection is
not supported.
b. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
ISAPI/AccessControl/CaptureIDInfo/capabilities?format=json for
getting the capability of online collecting ID card information.
The capability is returned in the message JSON_IdentityInfoCap by
lpOutputParam.
c. Call NET_DVR_STDXMLConfig to pass through the request URL:
POST /ISAPI/AccessControl/CaptureIDInfo?format=json and set
lpInputParam to the message JSON_IdentityInfoCond for online
collecting ID card information.
The online collected ID card information is returned in the message
JSON_IdentityInfo by lpOutputParam.
Collect Card Refer to Collect Card Information
Information
Collect Face Refer to Collect Face Data
Data
Collect Refer to Fingerprint Collection
Fingerprint
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.1.2 Offline Collect Data

When the access control device is not connected to the client software or platform via the
network, you can collect data (including ID card information, card information, face data, and
fingerprint) locally on the stand-alone device by importing description of the information that

14
 Device Network SDK (Access Control on Person) Developer Guide

needs to be collected. The offline collected data will be stored on the device and can also be
downloaded, exported, or deleted from the device.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

15
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-2 Programming Flow of Offline Collecting Data

16
 Device Network SDK (Access Control on Person) Developer Guide

1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/

capabilities for getting the access control capability to check whether the device supports
offline data collection.
The capability is returned in the message XML_Cap_AccessControl by lpOutBuffer of
lpOutputParam.
If this function is supported, the node <isSupportOfflineCapture> will be returned and its value
is "true". Otherwise, please end this task.
2. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
OfflineCapture/capabilities?format=json for getting the capability of collecting data offline to
know the supported parameters.
The capability is returned in the message JSON_OfflineCaptureCap lpOutBuffer of
lpOutputParam.
3. Optional: Call NET_DVR_StartDownload with
"NET_SDK_DOWNLOAD_OFFLINE_CAPTURE_INFO_TEMPLATE" (command No.: 40) to download
the user list template of offline data collection.
4. Call NET_DVR_UploadFile_V40 with "UPLOAD_OFFLINE_CAPTURE_INFO" (command No.: 56)
and set lpInBuffer to the structure NET_DVR_DOOR_FILE_UPLOAD_PARAM for importing the
user list of offline data collection filled in the template.
5. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
OfflineCapture/ruleInfo?format=json and set lpInBuffer of lpInputParam to the message
JSON_RuleInfo for setting rule parameters of offline data collection.

Note
Before setting rule parameters of offline data collection, you'd better call
NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
OfflineCapture/ruleInfo?format=json for getting the existing or configured parameters for
reference. The parameters are returned in the message JSON_RuleInfo by lpOutBuffer of
lpOutputParam.
6. Collect ID card information, card information, face data, or fingerprint on the stand-alone device
offline.
7. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/OfflineCapture/progress?format=json for getting the progress of offline data
collection.
The collection progress is returned in the message JSON_CaptureProgress by lpOutBuffer of
lpOutputParam.
8. Optional: Perform the following operation(s) after collecting data offline.
Export Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
Collected AccessControl/OfflineCapture/dataOutput?format=json and set lpInBuffer
Data of lpInputParam to the message JSON_DataOutputCfg .

17
 Device Network SDK (Access Control on Person) Developer Guide

Note
During exporting, you can call NET_DVR_STDXMLConfig to pass through the
request URL: GET /ISAPI/AccessControl/OfflineCapture/dataOutput/
progress?format=json for getting the progress of exporting the offline
collected data.

Download Call NET_DVR_StartDownload with

Collected "NET_SDK_DOWNLOAD_CAPTURE_DATA" (command No.: 41).
Data
Search for a. Call NET_DVR_StartRemoteConfig with
Collected "NET_DVR_CAPTURE_DATA_SEARCH" (command No.: 2554) to pass
Data through the request URL: POST /ISAPI/AccessControl/OfflineCapture/
DataCollections/searchTask?format=json for setting up persistent
connection and set callback function ( fRemoteConfigCallback ) for
searching for the collected data.
b. Call NET_DVR_SendRemoteConfig to send the search condition message
JSON_SearchTaskCond via the persistent connection.
The collected data is returned in the structure
NET_DVR_JSON_DATA_CFG by the output buffer (lpBuffer) of the
callback function.

Note
- The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
- After a search condition message JSON_SearchTaskCond is applied by
calling NET_DVR_SendRemoteConfig , the next piece of data can be
searched only when NET_DVR_JSON_DATA_CFG is returned by the
callback function fRemoteConfigCallback .
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finishing searching.
Delete A Call NET_DVR_STDXMLConfig to pass through the request URL: DELETE /
Specific Piece ISAPI/AccessControl/OfflineCapture/DataCollections/<captureNo>?
of Collected format=json .
Data
Delete All Call NET_DVR_STDXMLConfig to pass through the request URL: DELETE /
Collected ISAPI/AccessControl/OfflineCapture/DataCollections?format=json .
Data
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

18
 Device Network SDK (Access Control on Person) Developer Guide

2.2 Manage Person Information

A person is a basic unit, which can link with multiple cards and fingerprints, for access control in
this manual. So, before starting any other operations, you should add persons and apply the
person information (e.g., person ID, name, organization, permissions, and so on) to access control
devices.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.

19
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-3 Programming Flow of Managing Person Information

20
 Device Network SDK (Access Control on Person) Developer Guide

1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/

UserInfo/capabilities?format=json for getting the person management capability to know the
configuration details and notices.
The capability message JSON_Cap_UserInfo is returned.
2. Call NET_DVR_StartRemoteConfig with the command of NET_DVR_JSON_CONFIG (command
No.: 2550) to pass through the request URL: POST /ISAPI/AccessControl/UserInfo/Record?
format=json for setting up persistent connection and set callback function for adding a person.
3. Call NET_DVR_SendRemoteConfig to send the person information message JSON_UserInfo via
the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to "ENUM_SEND_JSON_DATA".
4. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finish adding.
5. Optional: Perform the following operation(s) after adding persons.
Set Person a. Call NET_DVR_StartRemoteConfig with the command of
Information NET_DVR_JSON_CONFIG (command No.:2550) to pass through the
request URL: PUT /ISAPI/AccessControl/UserInfo/SetUp?format=json
for setting up persistent connection and setting callback function to set a
person.
b. Call NET_DVR_SendRemoteConfig to send the person information
message JSON_UserInfo via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
ENUM_SEND_JSON_DATA.
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish setting.
Edit Person a. Call NET_DVR_StartRemoteConfig with the command of
Information NET_DVR_JSON_CONFIG (command No.: 2550) to pass through the
request URL: PUT /ISAPI/AccessControl/UserInfo/Modify?format=json
for setting up persistent connection and set callback function for editing
a person.
b. Call NET_DVR_SendRemoteConfig to send the person information
message JSON_UserInfo via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish editing.

21
 Device Network SDK (Access Control on Person) Developer Guide

Search for a. Call NET_DVR_StartRemoteConfig with the command of

Persons NET_DVR_JSON_CONFIG (command No.: 2550) to pass through the
request URL: PUT /ISAPI/AccessControl/UserInfo/Search?format=json
for setting up persistent connection and set callback function for
searching for persons.
b. Call NET_DVR_SendRemoteConfig to send the search condition
message JSON_UserInfoSearchCond via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA", and the search results
JSON_UserInfoSearch will be returned in the callback function
configured by the above step.
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish searching.
Get Number Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
of Total ISAPI/AccessControl/UserInfo/Count?format=json .
Added
Persons Note
The number of total added persons will be returned in the message
JSON_UserInfoCount .

Delete Person Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
Only ISAPI/AccessControl/UserInfo/Delete?format=json and set lpInBuffer of
lpInputParam to the message JSON_UserInfoDelCond .

Note
The timeout of deleting person only can be configured, and setting the
timeout to 60s is suggested.

Delete Person a. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
with Linked ISAPI/AccessControl/UserInfoDetail/Delete/capabilities?format=json
Card and for getting capability of deleting person with linked card and fingerprint.
Fingerprint And the capability is returned in the message JSON_Cap_UserInfoDetail
by the output parameter (lpOutputParam).
b. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
ISAPI/AccessControl/UserInfoDetail/Delete?format=json and set
lpInBuffer of lpInputParam to the message JSON_UserInfoDetail for
starting deleting.
c. Call NET_DVR_StartRemoteConfig with the command of
NET_DVR_JSON_CONFIG (command No.: 2550) to pass through the
request URL: GET /ISAPI/AccessControl/UserInfoDetail/DeleteProcess?

22
 Device Network SDK (Access Control on Person) Developer Guide

format=json for setting up persistent connection to get the deleting

progress.

Note
If the value of node status in the deleting progress message
JSON_UserInfoDetailDeleteProcess is "success", it indicates that
deleting completed and perform the next step; if the value is "failed", it
refers to uncompleted deleting progress and you should repeatedly pass
through the request URL: GET /ISAPI/AccessControl/UserInfoDetail/
DeleteProcess?format=json to continuously getting the deleting
progress.
d. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish getting deleting progress.
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out off the device and release the resources.

2.3 Manage Card Information

If a person want to access by card, you should add cards and link the cards with the person for
getting the access permissions, and then apply card information (e.g., card No., card type, and so
on) to access control device.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.
• Make sure you have collected the card information, refer to Collect Card Information for details.

23
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-4 Programming Flow of Managing Card Information

24
 Device Network SDK (Access Control on Person) Developer Guide

1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/

CardInfo/capabilities?format=json for getting the card management capability to know the
configuration details and notices.
The capability message JSON_Cap_CardInfo is returned.
2. Call NET_DVR_StartRemoteConfig with the command of NET_DVR_JSON_CONFIG (command
No.: 2550) to pass through the request URL: POST /ISAPI/AccessControl/CardInfo/Record?
format=json for setting up persistent connection and set callback function for adding a card.
3. Call NET_DVR_SendRemoteConfig to send the card information message JSON_CardInfo via the
persistent connection.

Note
The type of data to be sent (dwDataType) should be set to "ENUM_SEND_JSON_DATA".
4. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finishing adding.
5. Optional: Perform the following operation(s) after adding cards.
Set Card a. Call NET_DVR_StartRemoteConfig with the command of
Information NET_DVR_JSON_CONFIG (command No.: 2550) to pass through the
request URL: PUT /ISAPI/AccessControl/CardInfo/SetUp?format=json
for setting up persistent connection and setting callback function to set
a card.
b. Call NET_DVR_SendRemoteConfig to send the card information
message JSON_CardInfo via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish setting.
Edit Card a. Call NET_DVR_StartRemoteConfig with the command of
Information NET_DVR_JSON_CONFIG (command No.: 2550) to pass through the
request URL: PUT /ISAPI/AccessControl/CardInfo/Modify?format=json
for setting up persistent connection and setting callback function to edit
a card.
b. Call NET_DVR_SendRemoteConfig to send the card information
message JSON_CardInfo via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish editing.

25
 Device Network SDK (Access Control on Person) Developer Guide

Search for a. Call NET_DVR_StartRemoteConfig with the command of

Cards NET_DVR_JSON_CONFIG (command No.: 2550) to pass through the
request URL: PUT /ISAPI/AccessControl/CardInfo/Search?format=json
for setting up persistent connection and set callback function for
searching for cards.
b. Call NET_DVR_SendRemoteConfig to send the search condition
message JSON_CardInfoSearchCond via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA", and the search results
JSON_CardInfoSearch will be returned in the callback function
configured by the above step.
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish searching.
Get Number Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
of Total Added ISAPI/AccessControl/CardInfo/Count?format=json .
Cards
Note
The number of total added cards will be returned in the message
JSON_CardInfoCount .

Get Number Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
of Cards ISAPI/AccessControl/CardInfo/Count?format=json&employeeNo=<ID> .
Linked with A
Person Note
The number of cards linked with a person will be returned in the message
JSON_CardInfoCount .

Delete Card Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
ISAPI/AccessControl/CardInfo/Delete?format=json and set lpInBuffer of
lpInputParam to the message JSON_CardInfoDelCond .

Note
The timeout of deleting card can be configured, and setting the timeout to
60s is suggested.

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out off the device and release the resources.

26
 Device Network SDK (Access Control on Person) Developer Guide

2.3.1 Collect Card Information

The card information for further management and applying should be collected by the card reading
module of the access control device first. The following contents are about the process and
parameter settings of collecting card information.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.
Steps
1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
capabilities for getting access control capability to check whether the device supports card
information collection.
The access control capability is returned in the message XML_Cap_AccessControl by
lpOutputParam.
If the device supports card information collection, the node <isSupportCaptureCardInfo> will be
returned and its value is "true", and then you can perform the following steps.
Otherwise, card information collection is not supported by the device, please end this task.
2. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/CaptureCardInfo/capabilities?format=json to get the capability of collecting
card information.
The capability is returned in the message JSON_CardInfoCap by lpOutputParam.
3. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
CaptureCardInfo?format=json to collect the card information.
The collected card information is returned in the message JSON_CardInfo_Collection by
lpOutputParam.

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.3.2 Card Operation

Get Card Operation Capability
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
CardOperations/capabilities?format=json .
The capability is returned in the message JSON_CardOperationsCap by lpOutputParam.
Encrypt Specific Sections (M1 Card)

27
 Device Network SDK (Access Control on Person) Developer Guide

Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/

CardOperations/sectionEncryption?format=json and set lpInputParam to
JSON_SectionEncryption .
Verify Section Password (M1 Card)
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardOperations/verification?format=json and set lpInputParam to JSON_Verification .
Change Control Block of Section (M1 Card)
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardOperations/controlBlock?format=json and set lpInputParam to JSON_ControlBlock .
Read or Write Block Data (M1 Card)
Read Block Data
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
CardOperations/dataBlock/<address>?format=json .
The block data is returned in the message JSON_DataBlock by lpOutputParam.
Write Block Data
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardOperations/dataBlock/<address>?format=json and set lpInputParam to
JSON_DataBlock .
Operate Data Block (M1 Card)
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardOperations/dataBlock/control?format=json and set lpInputParam to JSON_DataBlockCtrl
Set Operation Protocol Type of Card
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardOperations/protocol?format=json and set lpInputParam to JSON_CardProto .
Set CPU Card Parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardOperations/cardParam?format=json and set lpInputParam to JSON_CardParam .
Reset CPU Card
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
CardOperations/reset?format=json .
And the resetting result is returned in the message JSON_CardResetResponse by lpOutputParam.
Pass Through Data Package of CPU Card
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardOperations/dataTrans?format=json and set lpInputParam to JSON_DataTrans .
Encrypt CPU Card

28
 Device Network SDK (Access Control on Person) Developer Guide

Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/

CardOperations/encryption?format=json and set lpInputParam to JSON_CardEncryption .

2.4 Manage Fingerprint Information

If a person wants to access by fingerprint, you should collect the fingerprint data via the fingerprint
recorder first, and then apply the fingerprint data and parameters (e.g., fingerprint ID, type, and so
on) to the fingerprint module of access control device and link the fingerprints with the person for
getting the access permissions.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.

29
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-5 Programming Flow of Managing Fingerprint Information

30
 Device Network SDK (Access Control on Person) Developer Guide

Note
To collect the fingerprint, refer to Fingerprint Collection for details.
1. Get the fingerprint configuration capability to know the configuration details or notices.
- Call NET_DVR_GetDeviceAbility and set the capability type dwAbilityType to "ACS_ABILITY"
for getting the fingerprint configuration and deleting capability to know the configuration
details or notices.

Note
The input parameter pointer pInBuf should be set to the message XML_Desc_AcsAbility .

The capability is returned in the message XML_AcsAbility by the output parameter pointer
pOutBuf. The related nodes are <FingerPrint> and <DelFingerPrint>.
- Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
FingerPrintCfg/capabilities?format=json to get the fingerprint configuration capability to
know the required configuration details.
2. Set up persistent connection to apply fingerprint information and set callback function to return
applying status.
- Call NET_DVR_StartRemoteConfig with NET_DVR_JSON_CONFIG (command No.: 2550) to
pass through request URL: POST /ISAPI/AccessControl/FingerPrintDownload?format=json
for setting up persistent connection and set callback function ( fRemoteConfigCallback ) for
applying fingerprint information (i.e., fingerprint data and parameters) and returning
applying status
- Call NET_DVR_StartRemoteConfig with NET_DVR_SET_FINGERPRINT_CFG_V50 (command
No.: 2184) to set up persistent connection and set callback function
( fRemoteConfigCallback ) for applying fingerprint information (i.e., fingerprint data and
parameters) and returning applying status.

Note
• Before setting fingerprint parameters, you'd better call
NET_DVR_GET_FINGERPRINT_CFG_V50 (command No.: 2183) to get the existing
configurations for reference, and the input parameter lpInBuffer refers to the structure
NET_DVR_FINGER_PRINT_INFO_COND_V50 .
• When applying the fingerprint information, whether to apply the card No. or employee ID
for linking with the fingerprint is determined by the capability of XML_AcsAbility . If the
<employeeNo> node is returned in the capability, it indicates that the device supports
applying fingerprint information based on person, so the card No. in the structure
NET_DVR_FINGER_PRINT_INFO_COND_V50 is not required, and the fingerprint will link
with the person directly after applying.
3. Set fingerprint parameters and start applying fingerprint data via the persistent connection.
- Call NET_DVR_SendRemoteConfig to send the fingerprint information structure
NET_DVR_FINGER_PRINT_CFG_V50 via the persistent connection for starting applying.

31
 Device Network SDK (Access Control on Person) Developer Guide

Note
The type of data to be sent (dwDataType) should be set to "ENUM_ACS_SEND_DATA".
- Call NET_DVR_SendRemoteConfig to send the fingerprint information message
JSON_FingerPrintCfg via the persistent connection for starting applying.

Note
The type of data to be sent (dwDataType) should be set to "ENUM_SEND_JSON_DATA".
- Call NET_DVR_STDXMLConfig to pass through the request URL: POST /ISAPI/AccessControl/
FingerPrintDownload?format=json to set the fingerprint parameters (e.g., employee No. to
be linked, fingerprint modules to be applied, and so on) and start applying the recorded
fingerprint data.

Note
The binary fingerprint data is collected and recorded by the fingerprint recorder.
4. Check the status of applying fingerprint data.
- Check the applying status in the structure of NET_DVR_FINGER_PRINT_STATUS_V50
returned by NET_DVR_StartRemoteConfig .

Note
When the parameter byStatus in the structure is "3", it indicates that the fingerprint
information is applied.
- Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
FingerPrintProgress?format=json for getting the applying status to make sure that the
applying is completed.

Note
The fingerprint data is linked to a person according to the configured employee No. and
applied to the specified fingerprint modules only when the value of applying status
(totalStatus) is 1.
5. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finish setting
and applying.
6. Optional: Perform the following operation(s) after setting and applying fingerprint information.
Set Option 1:
Fingerprint a. Call NET_DVR_StartRemoteConfig with NET_DVR_JSON_CONFIG
Information (command No.: 2550) to pass through the request URL: POST /ISAPI/
AccessControl/FingerPrint/SetUp?format=json for setting up persistent
connection and set callback function fRemoteConfigCallback for setting
the fingerprint information.
b. Call NET_DVR_SendRemoteConfig to send the fingerprint information
message JSON_FingerPrintCfg via the persistent connection.

32
 Device Network SDK (Access Control on Person) Developer Guide

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish setting.
Option 2:
Call NET_DVR_STDXMLConfig to pass through the request URL: POST /
ISAPI/AccessControl/FingerPrint/SetUp?format=json .
Edit Call NET_DVR_STDXMLConfig to pass through the request URL: POST /
Fingerprint ISAPI/AccessControl/FingerPrintModify?format=json and set the input
Information buffer (lpInBuffer) of the input parameter (lpInputParam) to the message
JSON_FingerPrintModify .

Note
Only the fingerprint parameters (such as fingerprint ID, type, and so on) can
be edited. The collected fingerprint data cannot be edited.

Get Option 1:
Fingerprint a. Call NET_DVR_StartRemoteConfig with NET_DVR_JSON_CONFIG
Data (command No.: 2550) to pass through the request URL: POST /ISAPI/
AccessControl/FingerPrintUpload?format=json for setting up persistent
connection and set callback function fRemoteConfigCallback for getting
the fingerprint information.
b. Call NET_DVR_SendRemoteConfig to send the fingerprint search
condition message JSON_FingerPrintCond via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish getting.
Option 2:
Call NET_DVR_STDXMLConfig to pass through the request URL: POST /
ISAPI/AccessControl/FingerPrintUpload?format=json to get a fingerprint or
all fingerprints of a person.
Delete a. Start deleting the fingerprint information.
Fingerprint Option 1: Call NET_DVR_StartRemoteConfig with
NET_DVR_DEL_FINGERPRINT_CFG_V50 (command No.:2517) and set the
input parameter lpInBuffer (it refers to the structure
NET_DVR_FINGER_PRINT_INFO_CTRL_V50 ) for setting up persistent

33
 Device Network SDK (Access Control on Person) Developer Guide

connection and set callback function ( fRemoteConfigCallback ) for

deleting the fingerprint information and returning deleting status.
Option 2: Call NET_DVR_STDXMLConfig to pass through the request URL:
GET /ISAPI/AccessControl/FingerPrint/Delete/capabilities?format=json
for getting the deleting capability to know the supported deleting modes
(by person or by fingerprint module) and other configuration details. Then
call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
ISAPI/AccessControl/FingerPrint/Delete?format=json to delete the
fingerprint information.
b. Check the status of deleting fingerprint information.
Option 1: Check the deleting status in the structure
NET_DVR_FINGER_PRINT_STATUS_V50 returned by
NET_DVR_StartRemoteConfig . When the parameter byStatus in the
structure is "3", it indicates that the fingerprint is deleted.
Option 2: Call NET_DVR_STDXMLConfig to pass through the request URL:
GET /ISAPI/AccessControl/FingerPrint/DeleteProcess?format=json to get
the fingerprint deleting status and check whether the deleting is
completed.
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish deleting.
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.4.1 Fingerprint Collection

The fingerprint information for further management and applying should be collected by
fingerprint recorder first. The following contents are about the process and parameter settings of
fingerprint collection.
a. Get fingerprint collection capability to know supported parameters.
- Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
CaptureFingerPrint/capabilities to get the fingerprint collection capability.
And the capability is returned in the message XML_Cap_CaptureFingerPrint by the output
parameter (lpOutputParam).
- Call NET_DVR_GetDeviceAbility , set dwAbilityType to "ACS_ABILITY", and set pInBuf to
XML_Desc_AcsAbility for getting the access control capability to know the supported
fingerprint collection parameters.
The capability is returned in the message XML_AcsAbility by the output parameter pointer
pOutBuf. The related node is <CaptureFingerPrint>.
b. Collect the fingerprint information.
- Call NET_DVR_StartRemoteConfig with NET_DVR_CAPTURE_FINGERPRINT_INFO (command
No.: 2504) and set lpInBuffer to NET_DVR_CAPTURE_FINGERPRINT_COND for setting up

34
 Device Network SDK (Access Control on Person) Developer Guide

persistent connection and set callback function ( fRemoteConfigCallback ) for collecting

fingerprint information.
The collected fingerprint data is returned in the structure
NET_DVR_CAPTURE_FINGERPRINT_CFG by lpBuffer of the callback function.
- Call NET_DVR_STDXMLConfig to pass through the request URL: POST /ISAPI/AccessControl/
CaptureFingerPrint and set lpInBuffer of the input parameter (lpInputParam) to the message
XML_CaptureFingerPrintCond to collect the fingerprint information.
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finish collecting.

2.5 Manage Face Information

If a person wants to access by face, you should collect face data via the face capture module of the
access control device first, create face picture libraries, and then apply face records (including face
record ID, information about the person in the picture, and so on) to face picture libraries for
getting the access permission.

2.5.1 Create Face Picture Library

The face picture library refers to the library of face pictures, including captured picture library,
resident population library, blacklist library, etc. You can create, edit, delete, and search for the face
picture libraries.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

35
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-6 Programming Flow of Creating Face Picture Library

1. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
Intelligent/FDLib/capabilities?format=json to get the face picture library capability and check
the supported operations of face picture libraries.
The face picture library capability is returned in the message JSON_FPLibCap by the output
parameter (lpOutputParam). If the value of the node <supportFDFunction> is "post, delete,
put, get", it indicates that creating, editing, deleting, and searching for face picture libraries are
supported, and you can perform the following steps to implement these functions.
2. Call NET_DVR_STDXMLConfig to pass through the request URL: POST /ISAPI/Intelligent/FDLib?
format=json and set the input buffer (lpInBuffer) of the input parameter (lpInputParam) to the
message JSON_CreateFPLibCond to create a face picture library.

Note
There are three types of face picture library, including infrared face picture library, list library,
and static library. So if you want to specify a face picture library, you should provide the library
type and library ID together.
The ID of the created face picture library (FDID) is returned.
3. Optional: Perform the following operation(s) after creating a face picture library.
Edit A Face Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
Picture Library ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType= and set the
input buffer (lpInBuffer) of the input parameter (lpInputParam) to the
message JSON_EditFPlibInfo
Delete A Face Call NET_DVR_STDXMLConfig to pass through the request URL: DELETE /
Picture Library ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType= .

36
 Device Network SDK (Access Control on Person) Developer Guide

Delete All Face Call NET_DVR_STDXMLConfig to pass through the request URL: DELETE /
Picture ISAPI/Intelligent/FDLib?format=json .
Libraries
Search for A Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
Specific Face ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType= .
Picture Library The information of the specified face picture library is returned in the
message JSON_SingleFPLibInfo by the output buffer (lpOutBuffer) of the
output parameter (lpOutputParam).
Search for All Call NET_DVR_STDXMLConfig to pass through the request URL: GET /
Face Picture ISAPI/Intelligent/FDLib?format=json .
Libraries The information of all face picture libraries is returned in the message
JSON_FPLibListInfo by the output buffer (lpOutBuffer) of the output
parameter (lpOutputParam).

Note
In the URL, both the library ID (FDID) and the library type (faceLibType) are required to specify a
face picture library, e.g., /ISAPI/Intelligent/FDLib?
format=json&FDID=1223344455566788&faceLibType=blackFD.

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.5.2 Collect Face Data

The face data for further management and applying should be collected by the face capture
module of the access control device first. The following contents are about the process and
parameter settings of face data collection.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.
Steps
1. Call NET_DVR_GetDeviceAbility , set dwAbilityType to "ACS_ABILITY", and set pInBuf to
XML_Desc_AcsAbility for getting the access control capability to know the supported
parameters of collecting face data.
The capability is returned in the message XML_AcsAbility by pOutBuf. The related node is
<CaptureFace>.
2. Call NET_DVR_StartRemoteConfig with "NET_DVR_CAPTURE_FACE_INFO" (command No.:
2510) and set lpInBuffer to the structure NET_DVR_CAPTURE_FACE_COND for setting up
persistent connection and set callback function ( fRemoteConfigCallback ) for collecting face
data.

37
 Device Network SDK (Access Control on Person) Developer Guide

The collected face data is returned in the structure NET_DVR_CAPTURE_FACE_CFG by lpBuffer

of the callback function.
3. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finishing
collecting face data.
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.5.3 Manage Face Records in Face Picture Library

After creating face picture library, you can import face pictures with different types (i.e., picture
URL and binary picture) to add the face records to the library. And you can also edit, delete, and
search for the face records in the library for management.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.
• Make sure you have added face picture libraries and get the ID of each library. For creating face
picture library, refer to Create Face Picture Library for details.
• Make sure you have collected the face picture data, refer to Collect Face Data for details.
Steps

Figure 1-7 Programming Flow of Managing Face Records in Face Picture Library
1. Prepare picture URLs (picture storage location) or binary pictures in form format for being
imported to the library.
2. Apply the picture URL or binary picture with person information for adding a face record to the
library according to the face picture library ID (FDID).

38
 Device Network SDK (Access Control on Person) Developer Guide

1) Call NET_DVR_StartRemoteConfig with NET_DVR_FACE_DATA_RECORD (command No.:

2551) to pass through the request URL: POST /ISAPI/Intelligent/FDLib/FaceDataRecord?
format=json for setting up persistent connection and set callback function
( fRemoteConfigCallback ) for adding the face record.
2) Call NET_DVR_SendRemoteConfig to send the face record information structure
NET_DVR_JSON_DATA_CFG via the persistent connection.

Note
• The type of data to be sent (dwDataType) should be set to "ENUM_SEND_JSON_DATA".
• After a face record is added to the face picture library by calling
NET_DVR_SendRemoteConfig , the next face record can be added to the face picture
library only when JSON_ResponseStatus is returned by the callback function
fRemoteConfigCallback .
3) Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finish adding.
3. Optional: Perform the following operation(s) after adding face records to the face picture
library.
Edit Face a. Call NET_DVR_StartRemoteConfig with NET_DVR_FACE_DATA_MODIFY
Record (command No.: 2553) to pass through the request URL: PUT /ISAPI/
Intelligent/FDLib/FDModify?format=json for setting up persistent
connection and set callback function ( fRemoteConfigCallback ) for
editing the face record.
b. Call NET_DVR_SendRemoteConfig to send the face record information
structure NET_DVR_JSON_DATA_CFG via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish editing.
Set Face a. Call NET_DVR_StartRemoteConfig with NET_DVR_FACE_DATA_RECORD
Record (command No.: 2551) to pass through the request URL: PUT /ISAPI/
Intelligent/FDLib/FDSetUp?format=json for setting up persistent
connection and set callback function ( fRemoteConfigCallback ) for
setting the face record.
b. Call NET_DVR_SendRemoteConfig to send the face record information
structure NET_DVR_JSON_DATA_CFG via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA".
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish setting.

39
 Device Network SDK (Access Control on Person) Developer Guide

Delete Face Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
Record(s) Intelligent/FDLib/FDSearch/Delete?format=json&FDID=&faceLibType= and
set the input buffer (lpInBuffer) of the input parameter (lpInputParam) to
the message JSON_DelFaceRecord .

Note
Deleting a face record or deleting face records in a batch are both
supported.

Search for a. Call NET_DVR_StartRemoteConfig with NET_DVR_FACE_DATA_SEARCH

Face Records (command No.: 2552) to pass through the request URL: POST /ISAPI/
Intelligent/FDLib/FDSearch?format=json for setting up persistent
connection and set callback function ( fRemoteConfigCallback ) for
searching for face records.
b. Call NET_DVR_SendRemoteConfig to send the search condition message
JSON_SearchFaceRecordCond via the persistent connection.

Note
The type of data to be sent (dwDataType) should be set to
"ENUM_SEND_JSON_DATA", and the search result message
JSON_SearchFaceRecordResult will be returned in the callback function
configured by the above steps.
c. Call NET_DVR_StopRemoteConfig to disconnect the persistent
connection and finish searching.

Note
Searching multiple face picture libraries at a time and fuzzy search are both
supported.

Get Number Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
of Face Intelligent/FDLib/Count?format=json&FDID=&faceLibType= .
Records of A The result is returned in the message JSON_FaceRecordNumInOneFPLib by
Specific Face the output buffer (lpOutBuffer) of the output parameter (lpOutputParam).
Picture
Library
Get Number Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
of Face Intelligent/FDLib/Count?format=json .
Records of The result is returned in the message JSON_FaceRecordNumInAllFPLib by
All Face the output buffer (lpOutBuffer) of the output parameter (lpOutputParam).
Picture
Libraries

40
 Device Network SDK (Access Control on Person) Developer Guide

Note
In the request URL, both the library ID (FDID) and library type (faceLibType) are required to
specify a face picture library, e.g., /ISAPI/Intelligent/FDLib?
format=json&FDID=1223344455566788&faceLibType=blackFD.

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.5.4 Configure Facial Recognition Mode

When recognizing human faces via the access control device, both the normal mode and the deep
mode are available. For the normal mode, the human face is recognized via white light camera; for
the deep mode, the human face is recognized by the IR light camera, which is applicable to a more
complicated environment and can recognize a much wider people range than the normal mode.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

41
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-8 Programming Flow of Configuring Facial Recognition Mode

1. Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
capabilities to get the functional capability of access control and check whether the device
supports configuring facial recognition mode.

Note
The capability will be returned in the message XML_Cap_AccessControl by lpOutputParam.
If the device supports configuring facial recognition mode, the node
<isSupportFaceRecognizeMode> is returned and its value is "true", and then you can perform
the following steps. Otherwise, it indicates that configuring facial recognition mode is not
supported by the device, please end this task.
2. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/FaceRecognizeMode/capabilities?format=json to get the configuration
capability of facial recognition mode to know the supported facial recognition modes.
The configuration capability is returned in the message JSON_Cap_FaceRecognizeMode by
lpOutputParam.

42
 Device Network SDK (Access Control on Person) Developer Guide

3. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/FaceRecognizeMode?format=json to get the current facial recognition mode.
The parameters of the current facial recognition mode are returned in the message
JSON_FaceRecognizeMode by lpOutBuffer of lpOutputParam.
4. Perform one of the following operations to add face records to face picture libraries for setting
normal or deep facial recognition mode.
- Add face records to the default face picture library with "blackFD" type, refer to Manage
Face Records in Face Picture Library for details.
- Add visible face pictures to the default face picture library with "blackFD" type, and add
infrared face pictures to the default library with "infraredFD" type, refer to Manage Face
Records in Face Picture Library for details.

Note
Generally, during the initialization of the access control device, two face picture libraries with
"blackID" type (the library ID is 1) and "infraredFD" type (the library ID is 2) will be created
automatically. But if the default libraries have not been created, you should create them by
yourself, refer to Create Face Picture Library for details.
5. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
FaceRecognizeMode?format=json and set lpInBuffer of lpInputParam to the message
JSON_FaceRecognizeMode to configure facial recognition mode.
Result
The device will reboot automatically after configuring facial recognition mode, and permissions
linked with face pictures in the library will be cleared.
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.6 Configure Access Permission Control Schedule

To regularly control the access permissions for managing the accessible time duration (by default,
it is 24 hours) of some important access control points, you can configure the week or holiday
schedules.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.

43
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-9 Programming Flow of Configuring Access Permission Control Schedule

1. Call NET_DVR_GetDeviceAbility , specify dwAbilityType to "ACS_ABILITY", set pInBuf to
XML_Desc_AcsAbility for getting the access control capability to check if configuring access
permission control schedule is supported.
The capability is returned in the message XML_AcsAbility by pOutBuf.
If the node <CardRightPlan> is returned, it indicates that configuring access permission control
schedule is supported, and you can continue to perform the following steps.
Otherwise, configuring access permission control schedule is not supported, please end this
task.
2. Perform one of the following operations to set week or holiday schedule for access permission
control.
- a. Call NET_DVR_GetDVRConfig with "NET_DVR_GET_CARD_RIGHT_WEEK_PLAN"
(command No.: 2126) to get default or configured week schedule configurations for
reference.

44
 Device Network SDK (Access Control on Person) Developer Guide

Note
The week schedule parameters are returned in the structure NET_DVR_WEEK_PLAN_CFG
by lpOutBuffer.
b. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_CARD_RIGHT_WEEK_PLAN" (command
No.: 2127) and set lpInBuffer to NET_DVR_WEEK_PLAN_CFG for setting the week
schedule.
- a. Call NET_DVR_GetDVRConfig with "NET_DVR_GET_CARD_RIGHT_HOLIDAY_PLAN"
(command No.: 2130) to get default or configured holiday schedule configurations for
reference.

Note
The holiday schedule parameters are returned in the structure
NET_DVR_HOLIDAY_PLAN_CFG by lpOutBuffer.
b. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_CARD_RIGHT_HOLIDAY_PLAN"
(command No.: 2131) and set lpInBuffer to NET_DVR_HOLIDAY_PLAN_CFG for setting the
week schedule.
c. Call NET_DVR_GetDVRConfig with "NET_DVR_GET_CARD_RIGHT_HOLIDAY_GROUP"
(command No.: 2134) to get default or configured holiday group configurations for
reference.

Note
The holiday group parameters are returned in the structure
NET_DVR_HOLIDAY_GROUP_CFG by lpOutBuffer.
d. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_CARD_RIGHT_HOLIDAY_GROUP"
(command No.: 2135) and set lpInBuffer to NET_DVR_HOLIDAY_GROUP_CFG for adding
the configured holiday schedule to a holiday group.
3. Optional: Call NET_DVR_GetDVRConfig with "NET_DVR_GET_CARD_RIGHT_PLAN_TEMPLATE"
(command No.: 2138) to get default or configured schedule template configurations for
reference.

Note
The schedule template parameters are returned in the structure NET_DVR_PLAN_TEMPLATE by
lpOutBuffer.
4. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_CARD_RIGHT_PLAN_TEMPLATE" (command
No.: 2139) and set lpInBuffer to NET_DVR_PLAN_TEMPLATE for setting the schedule template.

Note
The configured schedule template can be directly linked to person ID when applying person
information. And the linked person can get the access permission configured in the template.

Example
Sample Code for Configuring Access Permission Control Schedule

45
 Device Network SDK (Access Control on Person) Developer Guide

#include <stdio.h>
#include <iostream>
#include <afx.h>
#include "Windows.h"
#include "HCNetSDK.h"
using namespace std;

void main()
{
//---------------------------------------
//Initialize
NET_DVR_Init();

//Set connection timeout and reconnection function

NET_DVR_SetConnectTime(2000, 1);
NET_DVR_SetReconnect(10000, true);

//---------------------------------------
//Log in to device
LONG lUserID;
//Login parameters, including device IP address, user name, password, and so on
NET_DVR_USER_LOGIN_INFO struLoginInfo = {0};
struLoginInfo.bUseAsynLogin = 0; //Synchronous login mode
strcpy(struLoginInfo.sDeviceAddress, "192.168.1.64"); //Device IP address
struLoginInfo.wPort = 8000; //Device service port number
strcpy(struLoginInfo.sUserName, "admin"); //User name
strcpy(struLoginInfo.sPassword, "abcd1234"); //Password

//Device information, output parameter

NET_DVR_DEVICEINFO_V40 struDeviceInfoV40 = {0};

lUserID = NET_DVR_Login_V40(&struLoginInfo, &struDeviceInfoV40);

if (lUserID < 0)
{
printf("Login failed, error code: %d\n", NET_DVR_GetLastError());
NET_DVR_Cleanup();
return;
}
//---------------------------------------
//Set access permission schedule template, when issuing card, link to this template

CString m_csTemplateName = "Access permission schedule template 1";

NET_DVR_PLAN_TEMPLATE struPlanTem = {0};
struPlanTem.dwSize = sizeof(struPlanTem);
struPlanTem.byEnable = 1;//Enable or not: 0-No, 1-Yes
strncpy((char *)struPlanTem.byTemplateName, (LPCTSTR)m_csTemplateName, TEMPLATE_NAME_LEN);
struPlanTem.dwWeekPlanNo = 1;//Week schedule No.1
struPlanTem.dwHolidayGroupNo[0] = 1;//Holiday group No.1, up to 16 holiday groups can be linked to each
schedule
//struPlanTem.dwHolidayGroupNo[1] = 2;//Holiday group No.2

BOOL bRet1 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_CARD_RIGHT_PLAN_TEMPLATE, 1, \

46
 Device Network SDK (Access Control on Person) Developer Guide

&struPlanTem, sizeof(struPlanTem));
if (!bRet1)
{
printf("Setting access permission schedule template failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set week schedule 1 for access permission

NET_DVR_WEEK_PLAN_CFG struWeekPlan = {0};
struWeekPlan.dwSize = sizeof(struWeekPlan);
struWeekPlan.byEnable = 1;//Enable week schedule

NET_DVR_SINGLE_PLAN_SEGMENT struSinglePlanSegment = {0};

LPNET_DVR_SINGLE_PLAN_SEGMENT lpPlanSegment = &struSinglePlanSegment;
struSinglePlanSegment.byEnable = 1;

struSinglePlanSegment.struTimeSegment.struBeginTime.byHour = 0;//Start time

struSinglePlanSegment.struTimeSegment.struBeginTime.byMinute = 0;
struSinglePlanSegment.struTimeSegment.struBeginTime.bySecond = 0;

struSinglePlanSegment.struTimeSegment.struEndTime.byHour = 23;//End time

struSinglePlanSegment.struTimeSegment.struEndTime.byMinute = 59;
struSinglePlanSegment.struTimeSegment.struEndTime.bySecond = 59;

/*Up to 8 time periods can be set for each day. Here only takes setting one period for each day*/

for (int iDate = 0; iDate<MAX_DAYS; iDate++)

{
memcpy(&struWeekPlan.struPlanCfg[iDate][0], lpPlanSegment, sizeof(struSinglePlanSegment));
}

BOOL bRet2 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_CARD_RIGHT_WEEK_PLAN, 1, \

&struWeekPlan, sizeof(struWeekPlan));
if (!bRet2)
{
printf("Setting week schedule for access permission failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set holiday group for access permission

CString m_csGroupName = "access permission holiday group 1";
NET_DVR_HOLIDAY_GROUP_CFG struHolidayGroup1 = {0};
struHolidayGroup1.dwSize = sizeof(struHolidayGroup1);
struHolidayGroup1.byEnable = 1;
strncpy((char *)struHolidayGroup1.byGroupName, (LPCTSTR)m_csGroupName, HOLIDAY_GROUP_NAME_LEN);
struHolidayGroup1.dwHolidayPlanNo[0] = 1;//Holiday group 1 links to holiday schedule 1,
//up to 16 holiday schedules can be linked to one holiday group

47
 Device Network SDK (Access Control on Person) Developer Guide

BOOL bRet3 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_CARD_RIGHT_HOLIDAY_GROUP, 1, \

&struHolidayGroup1, sizeof(struHolidayGroup1));
if (!bRet3)
{
printf("设 Setting holiday group for access permission failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set holiday schedule for access permission

NET_DVR_HOLIDAY_PLAN_CFG struHolidayPlan = {0};
struHolidayPlan.dwSize = sizeof(struHolidayPlan);
struHolidayPlan.byEnable = 1;
struHolidayPlan.struBeginDate.wYear = 2017;//Holiday start date
struHolidayPlan.struBeginDate.byMonth = 10;
struHolidayPlan.struBeginDate.byDay = 1;
struHolidayPlan.struEndDate.wYear = 2017;//Holiday end date
struHolidayPlan.struEndDate.byMonth = 10;
struHolidayPlan.struEndDate.byDay = 7;
//Copy the week schedule parameters to holiday schedule of access permission
memcpy(struHolidayPlan.struPlanCfg, struWeekPlan.struPlanCfg,
sizeof(NET_DVR_SINGLE_PLAN_SEGMENT)*MAX_DAYS*MAX_TIMESEGMENT_V30);

BOOL bRet4 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_CARD_RIGHT_HOLIDAY_PLAN, 1, \

&struHolidayPlan, sizeof(struHolidayPlan));
if (!bRet4)
{
printf("Setting holiday schedule for access permission failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}
//---------------------------------------
//Exit
Sleep(5000);

//Log out
NET_DVR_Logout(lUserID);
//Release SDK resource
NET_DVR_Cleanup();
return;
}

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resource.

48
 Device Network SDK (Access Control on Person) Developer Guide

2.7 Configure Authentication Mode Control Schedule

You can configure the week or holiday schedule to regularly control the authentication modes
(e.g., by card, by card+password, by fingerprint, by fingerprint+card, and so on) in some specific
time periods.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.
Steps

Figure 1-10 Programming Flow of Configuring Authentication Mode Control Schedule

1. Optional: Call NET_DVR_GetDeviceAbility , specify the capability type dwAbilityType to
"ACS_ABILITY", set the input buffer (pInBuf) to XML_Desc_AcsAbility for getting the access
control capability to check if configuring authentication mode control schedule is supported.
The capability is returned in the message XML_AcsAbility by the output pointer (pOutBuf).
If the node <CardReaderVerifyTypePlan> is returned, it indicates that configuring
authentication mode control schedule is supported, and you can continue to perform the
following steps.

49
 Device Network SDK (Access Control on Person) Developer Guide

Otherwise, configuring authentication mode control schedule is not supported, please end this
task.
2. Perform one of the following operations to set week or holiday schedule for authentication
mode control.
- a. Call NET_DVR_GetDVRConfig with
NET_DVR_GET_VERIFY_WEEK_PLAN
(command No.: 2124) to get the existing week schedule configurations for reference.

Note
The week schedule parameters are returned in the structure NET_DVR_WEEK_PLAN_CFG
by output buffer (lpOutBuffer).
b. Call NET_DVR_SetDVRConfig with
NET_DVR_SET_VERIFY_WEEK_PLAN
(command No.: 2125) and set the input buffer (lpInBuffer) to NET_DVR_WEEK_PLAN_CFG
for setting the week schedule.
- a. Call NET_DVR_GetDVRConfig with
NET_DVR_GET_VERIFY_HOLIDAY_PLAN
(command No.: 2128) to get the existing holiday schedule configurations for reference.

Note
The holiday schedule parameters are returned in the structure
NET_DVR_HOLIDAY_PLAN_CFG by output buffer (lpOutBuffer).
b. Call NET_DVR_SetDVRConfig with
NET_DVR_SET_VERIFY_HOLIDAY_PLAN
(command No.: 2129) and set the input buffer (lpInBuffer) to
NET_DVR_HOLIDAY_PLAN_CFG for setting the holiday schedule.
c. Call NET_DVR_GetDVRConfig with
NET_DVR_GET_VERIFY_HOLIDAY_GROUP
(command No.: 2132) to get the existing holiday group configurations for reference.

Note
The holiday group parameters are returned in the structure
NET_DVR_HOLIDAY_GROUP_CFG by output buffer (lpOutBuffer).
d. Call NET_DVR_SetDVRConfig with
NET_DVR_SET_VERIFY_HOLIDAY_GROUP
(command No.: 2133) and set the input buffer (lpInBuffer) to
NET_DVR_HOLIDAY_GROUP_CFG for adding the configured holiday schedule to a holiday
group.
3. Optional: Call NET_DVR_GetDVRConfig with
NET_DVR_GET_VERIFY_PLAN_TEMPLATE
(command No.: 2136) to get the existing schedule template configurations for reference.

50
 Device Network SDK (Access Control on Person) Developer Guide

Note
The schedule template parameters are returned in the structure NET_DVR_PLAN_TEMPLATE by
output buffer (lpOutBuffer).
4. Call NET_DVR_SetDVRConfig with
NET_DVR_SET_VERIFY_PLAN_TEMPLATE
(command No.: 2137) and set the input buffer (lpInBuffer) to NET_DVR_PLAN_TEMPLATE for
setting the schedule template.
5. Optional: Call NET_DVR_GetDVRConfig with
NET_DVR_GET_CARD_READER_PLAN
(command No.: 2142) to get the existing authentication mode control schedule configurations
for reference.

Note
The authentication mode control schedule parameters are returned in the structure
NET_DVR_CARD_READER_PLAN by output buffer (lpOutBuffer).
6. Call NET_DVR_SetDVRConfig
NET_DVR_SET_CARD_READER_PLAN
(command No.: 2143) and set the input buffer (lpInBuffer) to NET_DVR_CARD_READER_PLAN
for linking the configured template to the authentication mode control schedule and finishing
the configuration.
Example
Sample Code for Configuring Authentication Mode Control Schedule
#include <stdio.h>
#include <iostream>
#include <afx.h>
#include "Windows.h"
#include "HCNetSDK.h"
using namespace std;

void main()
{
//---------------------------------------
//Initialize
NET_DVR_Init();

//Set connection timeout and reconnection function

NET_DVR_SetConnectTime(2000, 1);
NET_DVR_SetReconnect(10000, true);

//---------------------------------------
//Log in to device
LONG lUserID;
//Login parameters, including device IP address, user name, password, and so on
NET_DVR_USER_LOGIN_INFO struLoginInfo = {0};

51
 Device Network SDK (Access Control on Person) Developer Guide

struLoginInfo.bUseAsynLogin = 0; //Synchronous login mode

strcpy(struLoginInfo.sDeviceAddress, "192.168.1.64"); //Device IP address
struLoginInfo.wPort = 8000; //Device service port number
strcpy(struLoginInfo.sUserName, "admin"); //User name
strcpy(struLoginInfo.sPassword, "abcd1234"); //Password

//Device information, output parameter

NET_DVR_DEVICEINFO_V40 struDeviceInfoV40 = {0};

lUserID = NET_DVR_Login_V40(&struLoginInfo, &struDeviceInfoV40);

if (lUserID < 0)
{
printf("Login failed, error code: %d\n", NET_DVR_GetLastError());
NET_DVR_Cleanup();
return;
}

//---------------------------------------
//Set card reader authentication mode schedule, template 1 linked to card reader 1
NET_DVR_CARD_READER_PLAN struCardReaderPlan = {0};
struCardReaderPlan.dwSize = sizeof(struCardReaderPlan);
struCardReaderPlan.dwTemplateNo = 1;//Schedule template 1
BOOL bRet1 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_CARD_READER_PLAN, 1, \
&struCardReaderPlan, sizeof(struCardReaderPlan));
if (!bRet1)
{
printf("Setting card reader authentication mode schedule failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set card reader authentication mode schedule template 1, template 1 links to week schedule 1 and holiday group
1
CString m_csTemplateName = "card reader authentication mode schedule template 1";
NET_DVR_PLAN_TEMPLATE struPlanTem = {0};
struPlanTem.dwSize = sizeof(struPlanTem);
struPlanTem.byEnable = 1;//Enable or not: 0-No, 1-Yes
strncpy((char *)struPlanTem.byTemplateName, (LPCTSTR)m_csTemplateName, TEMPLATE_NAME_LEN);
struPlanTem.dwWeekPlanNo = 2;//Week schedule No.2
struPlanTem.dwHolidayGroupNo[0] = 2;//Holiday group No.2, up to 16 holiday groups can be linked to each
schedule

BOOL bRet2 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_VERIFY_PLAN_TEMPLATE, 1, \

&struPlanTem, sizeof(struPlanTem));
if (!bRet2)
{
printf("Setting card reader authentication mode schedule template failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

52
 Device Network SDK (Access Control on Person) Developer Guide

//Set week schedule 2 for card reader authentication mode

NET_DVR_WEEK_PLAN_CFG struWeekPlan2 = {0};
struWeekPlan2.dwSize = sizeof(struWeekPlan2);
struWeekPlan2.byEnable = 1;//Enable week schedule

NET_DVR_SINGLE_PLAN_SEGMENT struSinglePlanSegment = {0};

LPNET_DVR_SINGLE_PLAN_SEGMENT lpPlanSegment = &struSinglePlanSegment;
struSinglePlanSegment.byEnable = 1;
struSinglePlanSegment.byVerifyMode = 4;//Authentication mode: 0-invalid, 1-sleepy, 2-card+password, 3-card,
//4-card or password, 5-fingerprint, 6-fingerprint+password, 7-fingerprint or card,
//8-fingerprint+card, 9-fingerprint+card+password
struSinglePlanSegment.struTimeSegment.struBeginTime.byHour = 0;//Start time
struSinglePlanSegment.struTimeSegment.struBeginTime.byMinute = 0;
struSinglePlanSegment.struTimeSegment.struBeginTime.bySecond = 0;

struSinglePlanSegment.struTimeSegment.struEndTime.byHour = 23;//End time

struSinglePlanSegment.struTimeSegment.struEndTime.byMinute = 59;
struSinglePlanSegment.struTimeSegment.struEndTime.bySecond = 59;

/*Up to 8 time periods can be set for each day, and you can set different authentication modes for each time period
Here only takes setting one period for each day*/

for (int iDate = 0; iDate<MAX_DAYS; iDate++)

{
memcpy(&struWeekPlan2.struPlanCfg[iDate][0], lpPlanSegment, sizeof(struSinglePlanSegment));
}

BOOL bRet3 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_VERIFY_WEEK_PLAN, 2, \

&struWeekPlan2, sizeof(struWeekPlan2));
if (!bRet3)
{
printf("Setting week schedule for card reader authentication mode failed,error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set holiday group for card reader authentication mode

CString m_csGroupName = "Holiday group 2";
NET_DVR_HOLIDAY_GROUP_CFG struHolidayGroup2 = {0};
struHolidayGroup2.dwSize = sizeof(struHolidayGroup2);
struHolidayGroup2.byEnable = 1;
strncpy((char *)struHolidayGroup2.byGroupName, (LPCTSTR)m_csGroupName, HOLIDAY_GROUP_NAME_LEN);
struHolidayGroup2.dwHolidayPlanNo[0] = 2;//Holiday group 1 links to holiday schedule 1,
//up to 16 holiday schedules can be linked to one holiday group

BOOL bRet4 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_VERIFY_HOLIDAY_GROUP, 2, \

&struHolidayGroup2, sizeof(struHolidayGroup2));
if (!bRet4)
{
printf("设 Setting holiday group for card reader authentication mode failed, error:%d.\n",

53
 Device Network SDK (Access Control on Person) Developer Guide

NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set holiday schedule for card reader authentication mode

NET_DVR_HOLIDAY_PLAN_CFG struHolidayPlan2 = {0};
struHolidayPlan2.dwSize = sizeof(struHolidayPlan2);
struHolidayPlan2.byEnable = 1;
struHolidayPlan2.struBeginDate.wYear = 2017;//Holiday start date
struHolidayPlan2.struBeginDate.byMonth = 10;
struHolidayPlan2.struBeginDate.byDay = 1;
struHolidayPlan2.struEndDate.wYear = 2017;//Holiday end date
struHolidayPlan2.struEndDate.byMonth = 10;
struHolidayPlan2.struEndDate.byDay = 7;
//Copy the week schedule parameters to holiday schedule of card reader authentication mode
memcpy(struHolidayPlan2.struPlanCfg, struWeekPlan2.struPlanCfg,
sizeof(NET_DVR_SINGLE_PLAN_SEGMENT)*MAX_DAYS*MAX_TIMESEGMENT_V30);

BOOL bRet5 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_VERIFY_HOLIDAY_PLAN, 2, \

&struHolidayPlan2, sizeof(struHolidayPlan2));
if (!bRet5)
{
printf("Setting holiday schedule for card reader authentication mode failed, error:%d.\n",
NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}
//---------------------------------------
//Exit
Sleep(5000);

//Log out
NET_DVR_Logout(lUserID);
//Release SDK resource
NET_DVR_Cleanup();
return;
}

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resource.

2.8 Configure Door Control Schedule

You can configure the week or holiday schedule to regularly control the door statuses, including
Remain Open (access without authentication), Remain Closed (access is not allowed), and Normal
(access with authentication), in some specific time periods.

54
 Device Network SDK (Access Control on Person) Developer Guide

Before You Start

• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.
Steps

Figure 1-11 Programming Flow of Configuring Door Control Schedule

1. Call NET_DVR_GetDeviceAbility , specify the capability type dwAbilityType to "ACS_ABILITY",
set the input buffer (pInBuf) to XML_Desc_AcsAbility for getting the access control capability to
check if configuring door control schedule is supported.
The capability is returned in the message XML_AcsAbility by the output pointer (pOutBuf).
If the node <DoorStatusPlan> is returned, it indicates that configuring door control schedule is
supported, and you can continue to perform the following steps.
Otherwise, configuring door control schedule is not supported, please end this task.
2. Perform one of the following operations to set week or holiday schedule for door control.
- a. Call NET_DVR_GetDVRConfig with "NET_DVR_GET_WEEK_PLAN_CFG" (command No.:
2100) to get the existing week schedule configurations for reference.

55
 Device Network SDK (Access Control on Person) Developer Guide

Note
The week schedule parameters are returned in the structure NET_DVR_WEEK_PLAN_CFG
by output buffer (lpOutBuffer).
b. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_WEEK_PLAN_CFG" (command No.:
2101) and set the input buffer (lpInBuffer) to NET_DVR_WEEK_PLAN_CFG for setting the
week schedule.
- a. Call NET_DVR_GetDVRConfig with "NET_DVR_GET_DOOR_STATUS_HOLIDAY_PLAN"
(command No.: 2102) to get the existing holiday schedule configurations for reference.

Note
The holiday schedule parameters are returned in the structure
NET_DVR_HOLIDAY_PLAN_CFG by output buffer (lpOutBuffer).
b. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_DOOR_STATUS_HOLIDAY_PLAN"
(command No.: 2103) and set the input buffer (lpInBuffer) to
NET_DVR_HOLIDAY_PLAN_CFG for setting the week schedule.
c. Call NET_DVR_GetDVRConfig with "NET_DVR_GET_DOOR_STATUS_HOLIDAY_GROUP"
(command No.: 2104) to get the existing holiday group configurations for reference.

Note
The holiday group parameters are returned in the structure
NET_DVR_HOLIDAY_GROUP_CFG by output buffer (lpOutBuffer).
d. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_DOOR_STATUS_HOLIDAY_GROUP"
(command No.: 2105) and set the input buffer (lpInBuffer) to
NET_DVR_HOLIDAY_GROUP_CFG for adding the configured holiday schedule to a holiday
group.
3. Optional: Call NET_DVR_GetDVRConfig with "NET_DVR_GET_DOOR_STATUS_PLAN_TEMPLATE"
(command No.: 2106) to get the existing schedule template configurations for reference.

Note
The schedule template parameters are returned in the structure NET_DVR_PLAN_TEMPLATE by
output buffer (lpOutBuffer).
4. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_DOOR_STATUS_PLAN_TEMPLATE"
(command No.: 2107) and set the input buffer (lpInBuffer) to NET_DVR_PLAN_TEMPLATE for
setting the schedule template.
5. Optional: Call NET_DVR_GetDVRConfig with "NET_DVR_GET_DOOR_STATUS_PLAN" (command
No.: 2110) to get the existing door control schedule configurations for reference.

Note
The door control schedule parameters are returned in the structure
NET_DVR_DOOR_STATUS_PLAN by output buffer (lpOutBuffer).

56
 Device Network SDK (Access Control on Person) Developer Guide

6. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_DOOR_STATUS_PLAN" (command No.: 2111)

and set the input buffer (lpInBuffer) to NET_DVR_DOOR_STATUS_PLAN for linking the
configured template to the door control schedule and finishing the configuration.
Example
Sample Code for Configuring Door Control Schedule
#include <stdio.h>
#include <iostream>
#include <afx.h>
#include "Windows.h"
#include "HCNetSDK.h"
using namespace std;

void main()
{
//---------------------------------------
//Initialize
NET_DVR_Init();

//Set connection timeout and reconnection function

NET_DVR_SetConnectTime(2000, 1);
NET_DVR_SetReconnect(10000, true);

//---------------------------------------
//Log in to device
LONG lUserID;
//Login parameters, including device IP address, user name, password, and so on
NET_DVR_USER_LOGIN_INFO struLoginInfo = {0};
struLoginInfo.bUseAsynLogin = 0; //Synchronous login mode
strcpy(struLoginInfo.sDeviceAddress, "192.168.1.64"); //Device IP address
struLoginInfo.wPort = 8000; //Device service port number
strcpy(struLoginInfo.sUserName, "admin"); //User name
strcpy(struLoginInfo.sPassword, "abcd1234"); //Password

//Device information, output parameter

NET_DVR_DEVICEINFO_V40 struDeviceInfoV40 = {0};

lUserID = NET_DVR_Login_V40(&struLoginInfo, &struDeviceInfoV40);

if (lUserID < 0)
{
printf("Login failed, error code: %d\n", NET_DVR_GetLastError());
NET_DVR_Cleanup();
return;
}

//---------------------------------------
//Set door status schedule, template 1 linked to door 1
NET_DVR_DOOR_STATUS_PLAN struDoorStatusPlan = {0};
struDoorStatusPlan.dwSize = sizeof(struDoorStatusPlan);
struDoorStatusPlan.dwTemplateNo = 1;//Schedule template 1

57
 Device Network SDK (Access Control on Person) Developer Guide

BOOL bRet1 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_DOOR_STATUS_PLAN, 1, \

&struDoorStatusPlan, sizeof(struDoorStatusPlan));
if (!bRet1)
{
printf("Setting door status schedule failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set door status schedule template 1, template 1 links to week schedule 1 and holiday group 1
CString m_csTemplateName = "door status schedule template 1";
NET_DVR_PLAN_TEMPLATE struPlanTem = {0};
struPlanTem.dwSize = sizeof(struPlanTem);
struPlanTem.byEnable = 1;//Enable or not: 0-No, 1-Yes
strncpy((char *)struPlanTem.byTemplateName, (LPCTSTR)m_csTemplateName, TEMPLATE_NAME_LEN);
struPlanTem.dwWeekPlanNo = 1;//Week schedule No.1
struPlanTem.dwHolidayGroupNo[0] = 1;//Holiday group No.1, up to 16 holiday groups can be linked to each
schedule
//struPlanTem.dwHolidayGroupNo[1] = 2;//Holiday group No.2

BOOL bRet2 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_DOOR_STATUS_PLAN_TEMPLATE, 1, \

&struPlanTem, sizeof(struPlanTem));
if (!bRet2)
{
printf("Setting door status schedule template failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set week schedule 1 for door status

NET_DVR_WEEK_PLAN_CFG struWeekPlan = {0};
struWeekPlan.dwSize = sizeof(struWeekPlan);
struWeekPlan.byEnable = 1;//Enable week scheudle

NET_DVR_SINGLE_PLAN_SEGMENT struSinglePlanSegment = {0};

LPNET_DVR_SINGLE_PLAN_SEGMENT lpPlanSegment = &struSinglePlanSegment;
struSinglePlanSegment.byEnable = 1;
struSinglePlanSegment.byDoorStatus = 3;//Door status: 0-invalid, 1-sleepy, 2-remain open, 3-remain closed.
struSinglePlanSegment.struTimeSegment.struBeginTime.byHour = 0;//Start time
struSinglePlanSegment.struTimeSegment.struBeginTime.byMinute = 0;
struSinglePlanSegment.struTimeSegment.struBeginTime.bySecond = 0;

struSinglePlanSegment.struTimeSegment.struEndTime.byHour = 23;//End time

struSinglePlanSegment.struTimeSegment.struEndTime.byMinute = 59;
struSinglePlanSegment.struTimeSegment.struEndTime.bySecond = 59;

/*Up to 8 time periods can be set for each day, and you can set different statuses for each time period
Here only takes setting one period for each day*/

for (int iDate = 0; iDate<MAX_DAYS; iDate++)

58
 Device Network SDK (Access Control on Person) Developer Guide

{
memcpy(&struWeekPlan.struPlanCfg[iDate][0], lpPlanSegment, sizeof(struSinglePlanSegment));
}

BOOL bRet3 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_WEEK_PLAN_CFG, 1, \

&struWeekPlan, sizeof(struWeekPlan));
if (!bRet3)
{
printf("Setting week schedule for door status failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set holiday group for door status

CString m_csGroupName = "door status holiday group 1";
NET_DVR_HOLIDAY_GROUP_CFG struHolidayGroup1 = {0};
struHolidayGroup1.dwSize = sizeof(struHolidayGroup1);
struHolidayGroup1.byEnable = 1;
strncpy((char *)struHolidayGroup1.byGroupName, (LPCTSTR)m_csGroupName, HOLIDAY_GROUP_NAME_LEN);
struHolidayGroup1.dwHolidayPlanNo[0] = 1;//Holiday group 1 links to holiday schedule 1,
//up to 16 holiday schedules can be linked to one holiday group

BOOL bRet4 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_DOOR_STATUS_HOLIDAY_GROUP, 1, \

&struHolidayGroup1, sizeof(struHolidayGroup1));
if (!bRet4)
{
printf("Setting holiday group for door status failed, error:%d.\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Set holiday schedule for door status

NET_DVR_HOLIDAY_PLAN_CFG struHolidayPlan = {0};
struHolidayPlan.dwSize = sizeof(struHolidayPlan);
struHolidayPlan.byEnable = 1;
struHolidayPlan.struBeginDate.wYear = 2017;//Holiday start date
struHolidayPlan.struBeginDate.byMonth = 10;
struHolidayPlan.struBeginDate.byDay = 1;
struHolidayPlan.struEndDate.wYear = 2017;//Holiday end date
struHolidayPlan.struEndDate.byMonth = 10;
struHolidayPlan.struEndDate.byDay = 7;
//Copy the week schedule parameters to holiday schedule of door status
memcpy(struHolidayPlan.struPlanCfg, struWeekPlan.struPlanCfg,
sizeof(NET_DVR_SINGLE_PLAN_SEGMENT)*MAX_DAYS*MAX_TIMESEGMENT_V30);

BOOL bRet5 = NET_DVR_SetDVRConfig(lUserID, NET_DVR_SET_DOOR_STATUS_HOLIDAY_PLAN, 1, \

&struHolidayPlan, sizeof(struHolidayPlan));
if (!bRet5)
{
printf("Setting holiday schedule for door status failed, error:%d.\n", NET_DVR_GetLastError());

59
 Device Network SDK (Access Control on Person) Developer Guide

NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}
//---------------------------------------
//Exit
Sleep(5000);

//Log out
NET_DVR_Logout(lUserID);
//Release SDK resource
NET_DVR_Cleanup();
return;
}

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resource.

2.9 Configure Access Control Event

The access control events include device events, alarm input events, door events, card reader
events, card swiping events, and so on. You can configure the linkage types (i.e., event linkage, card
linkage, MAC linkage, and person linkage) and linkage actions (e.g., recording, alarm output,
buzzing, capture, etc.) of event card linkage to execute the linked actions when the corresponding
events occurred (e.g., door open or closed, card swiped, etc.). And then you can receive the event
information from event sources in arming or listening mode.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.

60
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-12 Programming Flow of Configuring Access Control Event

1. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: /ISAPI/
AccessControl/DeployInfo/capabilities for getting the capability of getting device arming
information.
The capability message XML_Cap_DeployInfo is returned.
2. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: /ISAPI/
AccessControl/DeployInfo for getting the device arming information to check whether the
device is armed by other platforms or client software.
3. Call NET_DVR_GetDeviceAbility and set the capability type dwAbilityType to "ACS_ABILITY" for
getting the event card linkage configuration capability to know the configuration details or
notices.

Note
The input parameter pointer pInBuf should be set to the message XML_Desc_AcsAbility .
The capability is returned in the message XML_AcsAbility by the output parameter pointer
pOutBuf. The related nodes is <EventLinkage>.

61
 Device Network SDK (Access Control on Person) Developer Guide

4. Optional: Call NET_DVR_GetDeviceConfig with

NET_DVR_GET_EVENT_CARD_LINKAGE_CFG_V51 (command No.: 2518) to get the existing
configurations for reference.

Note
The parameter dwCount should be set to 1.
5. Call NET_DVR_SetDeviceConfig with NET_DVR_SET_EVENT_CARD_LINKAGE_CFG_V51
(command No.: 2519) to set the event card linkage parameters.

Note
• The parameter lpInBuffer refers to the structure NET_DVR_EVENT_CARD_LINKAGE_COND ,
and the parameter lpOutBuffer or lpInParamBuffer refers to the structure
NET_DVR_EVENT_CARD_LINKAGE_CFG_V51 .
• The parameter dwCount should be set to 1.

6. Receive event/alarm in arming mode (see Receive Alarm/Event in Arming Mode ) or listening
mode (see Receive Alarm/Event in Listening Mode ) when alarm is triggered or event occurred.

Note
The command to receive access control alarms/events should be set to
COMM_ALARM_ACS_V50 (command No.: 0x5005) in the APIs of
NET_DVR_SetDVRMessageCallBack_V50 and NET_DVR_StartListen_V30 , and refer to the data
structure NET_DVR_ACS_ALARM_INFO_V50 for the alarm/event details.

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out off the device and release the resources.

2.10 Search for Access Control Events

If the access control alarms or events are received and stored in the third-party platform, you can
search for the alarms or events by setting different search conditions.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.

62
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-13 Programming Flow of Searching for Access Control Events

1. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/GetAcsEvent/capabilities for getting the capability of access control alarm/event
search to know the details or notices about search.
The capability message XML_Cap_GetAcsEvent is returned.
2. Call NET_DVR_StartRemoteConfig with
NET_DVR_GET_ACS_EVENT
(command No: 2514) and set input buffer (IpInBuffer) to NET_DVR_ACS_EVENT_COND for
setting up persistent connection and set callback function ( fRemoteConfigCallback ).
The access control event details are returned in the structure NET_DVR_ACS_EVENT_CFG by
the output buffer (lpBuffer) of callback function.
3. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/AcsEventTotalNum/capabilities?format=json to get the capability of getting total
number of access control events by specific conditions.
4. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: POST /ISAPI/
AccessControl/AcsEventTotalNum?format=json and set input buffer (IpInBuffer) to the

63
 Device Network SDK (Access Control on Person) Developer Guide

message JSON_AcsEventTotalNumCond for getting the total number of access control events by
specific conditions.
5. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finish searching.
Example
Sample Code of Searching for Access Control Event
#include <stdio.h>
#include <iostream>
#include "Windows.h"
#include "HCNetSDK.h"
using namespace std;

BOOL CALLBACK MSesGCallback(LONG lCommand, NET_DVR_ALARMER *pAlarmer, char *pAlarmInfo, DWORD

dwBufLen, void* pUser)
{
//As the operations with long time consumption are not allowed in the callback function,
//do not call the API of HCNetSDK.DLL in the callback function.
//The following code is for reference only, actually, processing data in the callback function is not suggested.
//for example, process in the message response function as PostMessage
switch (lCommand)
{
case COMM_ALARM_ACS://Alarm information of access controller
{
NET_DVR_ACS_ALARM_INFO struAcsAlarmInfo = {0};
memcpy(&struAcsAlarmInfo, pAlarmInfo, sizeof(struAcsAlarmInfo));
//Handle other information in the alarm structure as desired...
break;
}
case COMM_PASSNUM_INFO_ALARM://Number of passed persons
{
NET_DVR_PASSNUM_INFO_ALARM struPassnumInfo = {0};
memcpy(&struPassnumInfo, pAlarmInfo, sizeof(struPassnumInfo));
//Handle other information in the alarm structure as desired...
break;
}
default:
break;
}
return true;
}
void main()
{
//---------------------------------------
//Initialize
NET_DVR_Init();

//Set connection timeout and reconnection function

NET_DVR_SetConnectTime(2000, 1);
NET_DVR_SetReconnect(10000, true);
//---------------------------------------
//Log in to device

64
 Device Network SDK (Access Control on Person) Developer Guide

LONG lUserID;
//Login parameters, including device IP address, user name, password, and so on
NET_DVR_USER_LOGIN_INFO struLoginInfo = {0};
struLoginInfo.bUseAsynLogin = 0; //Synchronous login mode
strcpy(struLoginInfo.sDeviceAddress, "192.168.1.64"); //Device IP address
struLoginInfo.wPort = 8000; //Device service port number
strcpy(struLoginInfo.sUserName, "admin"); //User name
strcpy(struLoginInfo.sPassword, "abcd1234"); //Password

//Device information, output parameter

NET_DVR_DEVICEINFO_V40 struDeviceInfoV40 = {0};

lUserID = NET_DVR_Login_V40(&struLoginInfo, &struDeviceInfoV40);

if (lUserID < 0)
{
printf("Login failed, error code: %d\n", NET_DVR_GetLastError());
NET_DVR_Cleanup();
return;
}

//Set alarm callback function for card swiping event

NET_DVR_SetDVRMessageCallBack_V31(MSesGCallback, NULL);
//Set up channel for uploading alarm information
NET_DVR_SETUPALARM_PARAM struSetupParam={0};
struSetupParam.dwSize=sizeof(NET_DVR_SETUPALARM_PARAM);

LONG lHandle = NET_DVR_SetupAlarmChan_V41(lUserID,&struSetupParam);

if (lHandle < 0)
{
printf("NET_DVR_SetupAlarmChan_V41 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Wait for 60s for receiving captured picture uploaded by device

Sleep(60000);
//Close alarm uploading channel
if (!NET_DVR_CloseAlarmChan_V30(lHandle))
{
printf("NET_DVR_CloseAlarmChan_V30 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}
//Log out
NET_DVR_Logout(lUserID);
//Release SDK resource
NET_DVR_Cleanup();
return;
}

65
 Device Network SDK (Access Control on Person) Developer Guide

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resource.

2.11 Remotely Control Door, Elevator, and Buzzer

You can remotely control the status of doors or elevators, and buzzer (i.e., start or stop buzzing).
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to device.
Steps

Figure 1-14 Programming Flow of Remotely Control Door, Elevator, and Buzzer
1. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/RemoteControl/buzzer/capabilities?format=json for getting the capability to
judge whether the buzzer control is supported and know the control details or notices.

Note
The obtained capability ( JSON_Cap_RemoteControlBuzzer ) is for buzzer control only, the door
control capability does not exist.
2. Perform one of the following operations to control door or elevator remotely or control buzzer
remotely.
- Call NET_DVR_ControlGateway to control door or elevator remotely (i.e., open door, close
door, remain open, remain closed).
- Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
RemoteControl/buzzer/<ID>?format=json for controlling the buzzer (i.e., start or stop
buzzing).
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out off the device and release the resources.

66
 Device Network SDK (Access Control on Person) Developer Guide

2.12 Configure Anti-Passing Back

The anti-passing back is to set the only route for passing the access control points and only one
person could pass after swiping card. You can configure this function to enhance the access
security of some important and specific places (e.g., laboratories, offices).
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

67
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-15 Programming Flow of Configuring Anti-Passing Back

68
 Device Network SDK (Access Control on Person) Developer Guide

Note
Before setting the following parameters, you'd better pass through the each configuration URLs
with GET method to get the existing or configured parameters for reference.
1. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/AntiSneakCfg/capabilities?format=json for getting the anti-passing back
configuration capability of the access controller.
The anti-passing back configuration capability JSON_Cap_AntiSneakCfg is returned.
2. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
AntiSneakCfg?format=json for setting the anti-passing back parameters of access controller.
3. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/CardReaderAntiSneakCfg/capabilities?format=json for getting the anti-passing
back configuration capability of card reader.
4. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
CardReaderAntiSneakCfg/<ID>?format=json for setting the anti-passing parameters of card
reader.
5. Perform the following operation(s) after configuring the anti-passing back function.
Clear Anti- Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
passing Back ISAPI/AccessControl/ClearAntiSneakCfg?format=json .
Parameters
Note
The capability of clearing anti-passing back parameters
( JSON_Cap_ClearAntiSneakCfg ) can be obtained by calling
NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/ClearAntiSneakCfg/capabilities?format=json .

Clear Anti- If the anti-passing back event occurred, it will be recorded in the access
passing Back controller, so if needed, you can call NET_DVR_STDXMLConfig to pass
Records through the request URL: PUT /ISAPI/AccessControl/ClearAntiSneak?
format=json for clearing the records.

Note
The capability of clearing anti-passing back records
( JSON_Cap_ClearAntiSneak ) can be obtained by calling
NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/ClearAntiSneak/capabilities?format=json .

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resources.

69
 Device Network SDK (Access Control on Person) Developer Guide

2.13 Cross-Controller Anti-Passing Back Configuration

You can set anti-passing back for card readers in multiple access controllers. You should swipe the
card according to the configured swiping card route or extrance/exit. And only one person could
pass the access control point after swiping the card.

2.13.1 Configure Route Anti-Passing Back Based on Network

The route anti-passing back depends on the card swiping route. You should set the first card reader
and the card readers afterwards. It will authenticate the anti-passing back according to the
entrance and exit information stored on the card reader.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

70
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-16 Programming Flow of Configuring Route Anti-Passing Back Based on Network

71
 Device Network SDK (Access Control on Person) Developer Guide

Note
Before setting the following parameters, you'd better pass through the each configuration URLs
with GET method to get the existing or configured parameters for reference.
1. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
SubmarineBackMode for setting anti-passing back mode and rule.

Note
• For route anti-passing back based on network, the mode must be set to
"internetCommunicate" and the rule should be set to "line".
• To get the capability of setting anti-passing back mode and rule, you should pass through the
request URL: GET /ISAPI/AccessControl/SubmarineBackMode/capabilities . And the
capability is returned in the message XML_Cap_SubmarineBackMode .

2. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/

ReaderAcrossHost for enabling anti-passing back of card readers.

Note
To get the capability of enabling anti-passing back of card readers, you should pass through the
request URL: GET /ISAPI/AccessControl/ReaderAcrossHost/capabilities . And the capability is
returned in the message XML_Cap_ReaderAcrossHost .
3. Perform one of the following operations to configure anti-passing back server or access
controllers.
- Configure anti-passing back server:
a. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
AccessControl/SubmarineBack for specifying an access controller as the server for cross-
controller anti-passing back and setting the server parameters.

Note
To get the capability of specifying a server for anti-passing back, you should pass through
the request URL: GET /ISAPI/AccessControl/SubmarineBack/capabilities . And the
capability is returned in the message XML_Cap_SubmarineBack .
b. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
AccessControl/SubmarineBackHostInfo/ConfigureNo/<ID> for setting anti-passing back
parameters of access controllers.

Note
To get the capability of adding access controllers to anti-passing back route, you should
pass through the request URL: GET /ISAPI/AccessControl/SubmarineBackHostInfo/
capabilities . And the capability is returned in the message
XML_Cap_SubmarineBackHostInfo .

72
 Device Network SDK (Access Control on Person) Developer Guide

c. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/

AccessControl/StartReaderInfo for specifying a first card reader.

Note
To get the capability of specifying a first card reader, you should pass through the request
URL: GET /ISAPI/AccessControl/StartReaderInfo/capabilities . And the capability is
returned in the message XML_Cap_StartReaderInfo .
d. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
AccessControl/SubmarineBackReader/ConfigureNo/<ID> for setting the anti-passing
back parameters of the first and other card readers.

Note
To get the capability of setting anti-passing back parameters for card readers, you should
pass through the request URL: GET /ISAPI/AccessControl/SubmarineBackReader/
capabilities . And the capability is returned in the message
XML_Cap_SubmarineBackReader .
- Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
ServerDevice for notifying the anti-passing back server information to access controllers.

Note
To get the capability of notifying anti-passing back server information to access controllers,
you should pass through thee request URL: GET /ISAPI/AccessControl/ServerDevice/
capabilities . And the capability is returned in the message XML_Cap_ServerDevice .
4. Optional: Perform the following operation(s) after configuring route anti-passing back based on
network.
Clear Cross- Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
Controller Anti- ISAPI/AccessControl/ClearSubmarineBack .
Passing Back
Parameters Note
To get the capability of clearing the cross-controller anti-passing back
parameters, you should pass through the request URL: GET /ISAPI/
AccessControl/ClearSubmarineBack/capabilities . And the capability is
returned in message XML_Cap_ClearSubmarineBack

Clear Card If the card is swiped in the anti-passing back route or entrance/exit, it will
Swiping be recorded by the server. So if need, you can call
Records in NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
Server AccessControl/ClearCardRecord for clearing card swiping records in the
server.

73
 Device Network SDK (Access Control on Person) Developer Guide

Note
To get the capability of clearing card swiping records in server, you should
pass through the request URL: GET /ISAPI/AccessControl/
ClearCardRecord/capabilities . And the capability is returned in message
XML_Cap_ClearCardRecord

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resources.

2.13.2 Configure Entrance/Exit Anti-Passing Back Based on Network

You can set the entrance card reader and the exit card reader only for entering and exiting, without
setting the first card reader and the card readers afterwards. It will authenticate the anti-passing
back according to the entrance and exit information on the card reader.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

74
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-17 Programming Flow of Configuring Entrance/Exit Anti-Passing Back Based on Network

Note
Before setting the following parameters, you'd better pass through the each configuration URLs
with GET method to get the existing or configured parameters for reference.
1. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
SubmarineBackMode for setting anti-passing back mode and rule.

Note
• For route anti-passing back based on network, the mode must be set to
"internetCommunicate" and the rule should be set to "inOrOut".
• To get the capability of setting anti-passing back mode and rule, you should pass through the
request URL: GET /ISAPI/AccessControl/SubmarineBackMode/capabilities . And the
capability is returned in the message XML_Cap_SubmarineBackMode .

2. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/

ReaderAcrossHost for enabling anti-passing back of card readers.

75
 Device Network SDK (Access Control on Person) Developer Guide

Note
To get the capability of enabling anti-passing back of card readers, you should pass through the
request URL: GET /ISAPI/AccessControl/ReaderAcrossHost/capabilities . And the capability is
returned in the message XML_Cap_ReaderAcrossHost .
3. Perform one of the following operations to configure anti-passing back server or access
controllers.
- Configure anti-passing back server:
a. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
AccessControl/SubmarineBack for specifying an access controller as the server for cross-
controller anti-passing back and setting the server parameters.

Note
To get the capability of specifying a server for anti-passing back, you should pass through
the request URL: GET /ISAPI/AccessControl/SubmarineBack/capabilities . And the
capability is returned in the message XML_Cap_SubmarineBack .
b. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
AccessControl/SubmarineBackHostInfo/ConfigureNo/<ID> for setting anti-passing back
parameters of access controllers.

Note
To get the capability of adding access controllers to anti-passing back route, you should
pass through the request URL: GET /ISAPI/AccessControl/SubmarineBackHostInfo/
capabilities . And the capability is returned in the message
XML_Cap_SubmarineBackHostInfo .
- Configure the access controllers:
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
ServerDevice for notifying the anti-passing back server information to access controllers.

Note
To get the capability of notifying anti-passing back server information to access controllers,
you should pass through thee request URL: GET /ISAPI/AccessControl/ServerDevice/
capabilities . And the capability is returned in the message XML_Cap_ServerDevice .
4. Optional: Perform the following operation(s) after configuring entrance/exit anti-passing back
based on network.
Clear Cross- Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /
Controller Anti- ISAPI/AccessControl/ClearSubmarineBack .
Passing Back
Parameters

76
 Device Network SDK (Access Control on Person) Developer Guide

Note
To get the capability of clearing the cross-controller anti-passing back
parameters, you should pass through the request URL: GET /ISAPI/
AccessControl/ClearSubmarineBack/capabilities . And the capability is
returned in message XML_Cap_ClearSubmarineBack

Clear Card If the card is swiped in the anti-passing back route or entrance/exit, it will
Swiping be recorded by the server. So if need, you can call
Records in NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
Server AccessControl/ClearCardRecord for clearing card swiping records in the
server.

Note
To get the capability of clearing card swiping records in server, you should
pass through the request URL: GET /ISAPI/AccessControl/
ClearCardRecord/capabilities . And the capability is returned in message
XML_Cap_ClearCardRecord

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resources.

2.13.3 Configure Route Anti-Passing Back Based on Card

The route anti-passing back depends on the card swiping route. You should set the first card reader
and the card readers afterwards. It will judge the anti-passing back according to the entrance and
exit records on the card.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.

77
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-18 Programming Flow of Configuring Route Anti-Passing Back Based on Card

Note
Before setting the parameters, you'd better pass through the each configuration URLs with GET
method to get the existing or configured parameters for reference.
1. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
SubmarineBackMode for setting anti-passing back mode and rule.

Note
• For route anti-passing back based on network, the mode must be set to "cardReadAndWrite"
and the rule should be set to "line".
• To get the capability of setting anti-passing back mode and rule, you should pass through the
request URL: GET /ISAPI/AccessControl/SubmarineBackMode/capabilities . And the
capability is returned in the message XML_Cap_SubmarineBackMode .

2. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/

ReaderAcrossHost for enabling anti-passing back of card readers.

78
 Device Network SDK (Access Control on Person) Developer Guide

Note
To get the capability of enabling anti-passing back of card readers, you should pass through the
request URL: GET /ISAPI/AccessControl/ReaderAcrossHost/capabilities . And the capability is
returned in the message XML_Cap_ReaderAcrossHost .
3. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
SubmarineBackHostInfo/ConfigureNo/<ID> for adding access controllers for anti-passing back
and set their parameters.

Note
To get the capability of adding access controllers to anti-passing back route, you should pass
through the request URL: GET /ISAPI/AccessControl/SubmarineBackHostInfo/capabilities . And
the capability is returned in the message XML_Cap_SubmarineBackHostInfo .
4. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
StartReaderInfo for specifying a first card reader.

Note
To get the capability of specifying a first card reader, you should pass through the request URL:
GET /ISAPI/AccessControl/StartReaderInfo/capabilities . And the capability is returned in the
message XML_Cap_StartReaderInfo .
5. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
SubmarineBackReader/ConfigureNo/<ID> for setting the anti-passing back parameters of the
first and other card readers.

Note
To get the capability of setting anti-passing back parameters for card readers, you should pass
through the request URL: GET /ISAPI/AccessControl/SubmarineBackReader/capabilities . And
the capability is returned in the message XML_Cap_SubmarineBackReader .
6. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
AccessControl/ClearSubmarineBack for clearing the cross-controller anti-passing back
parameters.

Note
To get the capability of clearing the cross-controller anti-passing back parameters, you should
pass through the request URL: GET /ISAPI/AccessControl/ClearSubmarineBack/capabilities .
And the capability is returned in message XML_Cap_ClearSubmarineBack

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resources.

79
 Device Network SDK (Access Control on Person) Developer Guide

2.13.4 Configure Entrance/Exit Anti-Passing Back Based on Card

You can set the entrance card reader and the exit card reader only for entering and exiting, without
setting the first card reader and the card readers afterward. It will judge the anti-passing back
according to the entrance and exit records on the card.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.
Steps

Figure 1-19 Programming Flow of Configuring Entrance/Exit Anti-Passing Back Based on Card

Note
Before setting the following parameters, you'd better pass through the each configuration URLs
with GET method to get the existing or configured parameters for reference.
1. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
SubmarineBackMode for setting anti-passing back mode and rule.

80
 Device Network SDK (Access Control on Person) Developer Guide

Note
• For route anti-passing back based on network, the mode must be set to "cardReadAndWrite"
and the rule should be set to "inOrOut".
• To get the capability of setting anti-passing back mode and rule, you should pass through the
request URL: GET /ISAPI/AccessControl/SubmarineBackMode/capabilities . And the
capability is returned in the message XML_Cap_SubmarineBackMode .

2. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/

ReaderAcrossHost for enabling anti-passing back of card readers.

Note
To get the capability of enabling anti-passing back of card readers, you should pass through the
request URL: GET /ISAPI/AccessControl/ReaderAcrossHost/capabilities . And the capability is
returned in the message XML_Cap_ReaderAcrossHost .
3. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
SubmarineBackHostInfo/ConfigureNo/<ID> for adding access controllers for anti-passing back
entrance/exit and set their parameters.

Note
To get the capability of adding access controllers to anti-passing back entrance/exit, you should
pass through the request URL: GET /ISAPI/AccessControl/SubmarineBackHostInfo/
capabilities . And the capability is returned in the message XML_Cap_SubmarineBackHostInfo .
4. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/
AccessControl/ClearSubmarineBack for clearing the cross-controller anti-passing back
parameters.

Note
To get the capability of clearing the cross-controller anti-passing back parameters, you should
pass through the request URL: GET /ISAPI/AccessControl/ClearSubmarineBack/capabilities .
And the capability is returned in message XML_Cap_ClearSubmarineBack

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release the resources.

2.14 Alarm/Event Receiving

The alarm/event information from the device can be received in third-party platform or system
when the alarms are triggered or event occurred. Two modes are available for receiving alarms,
including arming mode and listening mode.
Arming Mode

81
 Device Network SDK (Access Control on Person) Developer Guide

The third-party platform connects to device automatically, when the alarm is triggered, the
platform sends alarm uploading command to the device, and then the device will upload the
alarm to the platform.
Listening Mode
When alarm is triggered, the device automatically uploads the alarm, and then the third-party
platform receives the uploaded alarm via the configured listening host (listening address and port
should be configured). This mode is applicable for multiple devices uploading alarm/event
information to one third-party platform without logging in to devices, and the restart of devices
will not affect the alarm/event uploading. But a device can only support the configuration of one
or two listening addresses and ports.

2.14.1 Receive Alarm/Event in Arming Mode

When the alarm is triggered or the event occurred, the secondarily developed third-party platform
can automatically connect and send alarm/event uploading command to the device, and then the
device uploads the alarm/event information to the platform for receiving.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.
• Make sure you have configured the alarm/event parameters, refer to the typical alarm/event
configurations for details.
Steps

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

1. Call NET_DVR_SetDVRMessageCallBack_V50 to set callback function for returning alarm/event
information.

82
 Device Network SDK (Access Control on Person) Developer Guide

Note
• If the configured alarm is triggered or event occurred, the alarm/event information will be
uploaded by device and returned in the callback function. You can view the alarm/event and
do some processing operations.
• For the integration via device network SDK (HCNetSDK), to receive different types of alarm/
event information, the parameter lCommand (data type to be uploaded) in the configured
callback function should be different (refer to the typical alarm/event configurations). For the
integration via Intelligent Security API (ISAPI), the lCommand should be set to
"COMM_ISAPI_ALARM" (command No.: 0x6009).

2. Call NET_DVR_SetupAlarmChan_V50 to set up uploading channel.

3. Call NET_DVR_CloseAlarmChan_V30 to close uploading channel and stop receiving alarm or
event information.
Example
Sample Code of Receiving Alarm or Event in Arming Mode
#include <stdio.h>
#include <iostream>
#include "Windows.h"
#include "HCNetSDK.h"
using namespace std;

void main() {
//---------------------------------------
// Initialize
NET_DVR_Init();
//Set connection time and reconnection time
NET_DVR_SetConnectTime(2000, 1);
NET_DVR_SetReconnect(10000, true);
//---------------------------------------
// Log in to device
LONG lUserID;
//Login parameters, including device IP address, user name, password, and so on.
NET_DVR_USER_LOGIN_INFO struLoginInfo = {0};
struLoginInfo.bUseAsynLogin = 0; //Synchronous login mode
strcpy(struLoginInfo.sDeviceAddress, "192.0.0.64"); //Device IP address
struLoginInfo.wPort = 8000; //Service port No.
strcpy(struLoginInfo.sUserName, "admin"); //User name
strcpy(struLoginInfo.sPassword, "abcd1234"); //Password
//Device information, output parameter
NET_DVR_DEVICEINFO_V40 struDeviceInfoV40 = {0};
lUserID = NET_DVR_Login_V40(&struLoginInfo, &struDeviceInfoV40);
if (lUserID < 0)
{
printf("Login failed, error code: %d\n", NET_DVR_GetLastError());
NET_DVR_Cleanup();
return;
}

83
 Device Network SDK (Access Control on Person) Developer Guide

//Set alarm callback function

NET_DVR_SetDVRMessageCallBack_V50(0, MessageCallbackNo1, NULL);
NET_DVR_SetDVRMessageCallBack_V50(1, MessageCallbackNo2, NULL);

//Enable arming
NET_DVR_SETUPALARM_PARAM_V50 struSetupParamV50={0};
struSetupParamV50.dwSize=sizeof(NET_DVR_SETUPALARM_PARAM_V50);
//Alarm category to be uploaded
struSetupParamV50.byAlarmInfoType=1;
//Arming level
struSetupParamV50.byLevel=1;

char szSubscribe[1024] = {0};

//The following code is for alarm subscription (subscribe all)
memcpy(szSubscribe, "<SubscribeEvent version=\"2.0\" xmlns=\"http://www.isapi.org/ver20/XMLSchema\">\r
\n<eventMode>all</eventMode>\r\n", 1024);
LONG lHandle = -1;
if (0 == strlen(szSubscribe))
{
//Arm
lHandle = NET_DVR_SetupAlarmChan_V50(lUserID, &struSetupParamV50, NULL, strlen(szSubscribe));
}
else
{
//Subscribe
LlHandle = NET_DVR_SetupAlarmChan_V50(lUserID, &struSetupParamV50, szSubscribe, strlen(szSubscribe));
}

if (lHandle < 0)
{
printf("NET_DVR_SetupAlarmChan_V50 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

Sleep(20000);
//Disarm the uploading channel
if (!NET_DVR_CloseAlarmChan_V30(lHandle))
{
printf("NET_DVR_CloseAlarmChan_V30 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//Log out
NET_DVR_Logout(lUserID);
//Release resources
NET_DVR_Cleanup();
return;
}

84
 Device Network SDK (Access Control on Person) Developer Guide

What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out and release resources.

2.14.2 Receive Alarm/Event in Listening Mode

When alarm is triggered or event occurred, the device uploads the alarm/event information
automatically, so you can configure the listening address and port for listening and receiving the
alarm/event in the secondarily developed third-part platform.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have configured the alarm/event parameters, refer to the typical alarm/event
configurations for details.
Steps

Figure 1-21 Programming Flow of Receiving Alarm/Event in Listening Mode

1. Optional: Call NET_DVR_Login_V40 to log in to device.
2. Optional: Call NET_DVR_GetDVRConfig with "NET_DVR_GET_NETCFG_V50" (command No.:
1015) to get the existing listening configurations (i.e., listening address and port) for reference.

85
 Device Network SDK (Access Control on Person) Developer Guide

The listening parameters are retruned in the structure NET_DVR_NETCFG_V50 by the output
parameter pointer lpOutBuffer.
3. Call NET_DVR_SetDVRConfig with "NET_DVR_SET_NETCFG_V50" (command No.: 1016) and
specify the input parameter pointer lpInBuffer to the structure NET_DVR_NETCFG_V50 for
setting the listening address and port.
4. Call NET_DVR_StartListen_V30 to set callback function for returning alarm/event information
and start the listening.

Note
For the integration via device network SDK (HCNetSDK), to receive different types of alarm/
event information, the parameter lCommand (data type to be uploaded) in the configured
callback function should be different (refer to the typical alarm/event configurations). For the
integration via Intelligent Security API (ISAPI), the lCommand should be set to
"COMM_ISAPI_ALARM".
The alarm/event information is automatically uploaded by the device when the configured
alarm is triggered or event occurred, and the third-party platform or system gets the alarm/
event information from the configured callback function.
5. Call NET_DVR_StopListen_V30 to stop listening and receiving alarm or event information.
Example
Sample Code of Receiving Alarm/Event in Listening Mode
#include <stdio.h>
#include <iostream>
#include "Windows.h"
#include "HCNetSDK.h"
using namespace std;
void main() {
//---------------------------------------
// Initialize
NET_DVR_Init();
//Set connection time and reconnection time
NET_DVR_SetConnectTime(2000, 1);
NET_DVR_SetReconnect(10000, true);
//---------------------------------------
// Log in to device
LONG lUserID;
NET_DVR_DEVICEINFO_V30 struDeviceInfo;
lUserID = NET_DVR_Login_V30("172.0.0.100", 8000, "admin", "12345", &struDeviceInfo);
if (lUserID < 0)
{
printf("Login error, %d\n", NET_DVR_GetLastError());
NET_DVR_Cleanup();
return;
}
//Enable listening
LONG lHandle;
lHandle = NET_DVR_StartListen_V30(NULL,7200, MessageCallback, NULL);

86
 Device Network SDK (Access Control on Person) Developer Guide

if (lHandle < 0)
{
printf("NET_DVR_StartListen_V30 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}
Sleep(5000);
//Disable listening
if (!NET_DVR_StopListen_V30(lHandle))
{
printf("NET_DVR_StopListen_V30 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}
//Log out
NET_DVR_Logout(lUserID);
//Release SDK resource
NET_DVR_Cleanup();
return;
}

What to do next
Call NET_DVR_Logout (if logged in) and NET_DVR_Cleanup to log out and release resources.

2.15 Configure Attendance Status

The time and attendance refers to tracking and monitoring when employees start and stop
working, and working hours (including late arrivals, early departures, time taken on breaks and
absenteeism, etc.). You can set the manual or automatic time and attendance mode, or disable the
attendance mode. You can also set check in, check out, break out, break in, overtime in, or
overtime out to manually change the attendance status as needed.
Before You Start
• Make sure you have called NET_DVR_Init to initialize the development environment.
• Make sure you have called NET_DVR_Login_V40 to log in to the device.
• Make sure you have added at least one person, refer to Manage Person Information for details.

87
 Device Network SDK (Access Control on Person) Developer Guide

Steps

Figure 1-22 Programming Flow of Configuring Attendance Status

88
 Device Network SDK (Access Control on Person) Developer Guide

1. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/attendanceStatusModeCfg/capabilities?format=json to get the configuration
capability of the attendance mode and know the supported attendance modes.
The configuration capability is returned in the message JSON_Cap_AttendanceStatusModeCfg
by lpOutBuffer.
2. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/attendanceStatusModeCfg?format=json to get the default or configured
attendance mode for reference.
The attendance mode is returned in the message JSON_AttendanceStatusModeCfg by
lpOutBuffer.
3. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
attendanceStatusModeCfg?format=json and set lpInBuffer to the message
JSON_AttendanceStatusModeCfg to configure the attendance mode.
4. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/attendanceStatusRuleCfg/capabilities?format=json to get the configuration
capability of the attendance status and rule and know the supported attendance status and
rules.
The configuration capability of the attendance status and rule is returned in the message
JSON_Cap_AttendanceStatusRuleCfg by lpOutBuffer.
5. Optional: Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/
AccessControl/attendanceStatusRuleCfg?attendanceStatus=&format=json to get the default or
configured attendance status and rule for reference.
The attendance status and rules are returned in the message JSON_AttendanceStatusRuleCfg
by lpOutBuffer.
6. Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
attendanceStatusRuleCfg?attendanceStatus=&format=json and set lpInBuffer to the message
JSON_AttendanceStatusRuleCfg to configure the attendance status and rule.
What to do next
Call NET_DVR_Logout and NET_DVR_Cleanup to log out of the device and release the resources.

2.16 Other Applications

2.16.1 Device Settings

Fingerprint and Card Reader

Get fingerprint and card reader parameters
Call NET_DVR_GetDVRConfig with the command of NET_DVR_GET_CARD_READER_CFG_V50
(command No.: 2505).

89
 Device Network SDK (Access Control on Person) Developer Guide

And the configuration parameters are returned in the structure

NET_DVR_CARD_READER_CFG_V50 by the output buffer (lpOutBuffer).
Set fingerprint and card reader parameters
Call NET_DVR_SetDVRConfig with the command of NET_DVR_SET_CARD_READER_CFG_V50
(command No.: 2506) and set the input buffer (lpInBuffer) to the structure
NET_DVR_CARD_READER_CFG_V50 .
NFC (Near-Field Communication) Function
Get configuration capability of enabling or disabling NFC function
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
Configuration/NFCCfg/capabilities?format=json .
And the configuration capability is returned in the message JSON_NFCCfgCap by the output
parameter (lpOutputParam).
Get parameters of enabling or disabling NFC function
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
Configuration/NFCCfg?format=json .
And the parameters are returned in the message JSON_NFCCfg by lpOutBuffer of
lpOutputParam.
Set parameters of enabling or disabling NFC function
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
Configuration/NFCCfg?format=json and set lpInBuffer of lpInputParam to the message
JSON_NFCCfg .
RF (Radio Frequency) Card Recognition
Get configuration capability of enabling or disabling RF card recognition
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
Configuration/RFCardCfg/capabilities?format=json .
And the configuration capability is returned in the message JSON_RFCardCfgCap by the output
parameter (lpOutputParam).
Get parameters of enabling or disabling RF card recognition
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
Configuration/RFCardCfg?format=json
And the parameters are returned in the message JSON_RFCardCfg by lpOutBuffer of
lpOutputParam.
Set parameters of enabling or disabling RF card recognition
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
Configuration/RFCardCfg?format=json and set lpInBuffer of lpInputParam to the message
JSON_RFCardCfg .

90
 Device Network SDK (Access Control on Person) Developer Guide

Access Controller
Get access controller parameters
Call NET_DVR_GetDVRConfig with the command of NET_DVR_GET_ACS_CFG (command No.:
2159).
And the configuration parameters are returned in the structure NET_DVR_ACS_CFG by the
output buffer (lpOutBuffer).
Set access controller parameters
Call NET_DVR_SetDVRConfig with the command of NET_DVR_SET_ACS_CFG (command No.:
2160) and set the input buffer (lpInBuffer) to the structure NET_DVR_ACS_CFG .

Printer
Get printer configuration capability
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
PrinterCfg/capabilities?format=json .
And the configuration capability is returned in the message JSON_Cap_PrinterCfg by the output
parameter (lpOutputParam).
Get printer parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
PrinterCfg?format=json .
And the parameters are returned in the message JSON_PrinterCfg by the output buffer
(lpOutBuffer) of the output parameter (lpOutputParam).
Set printer parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
PrinterCfg?format=json and set the input buffer (lpInBuffer) of the input parameter
(lpInputParam) to the message JSON_PrinterCfg .

OSDP (Open Supervised Device Protocol) Card Reader

Get capability of getting the OSDP card reader status
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
OSDPStatus/capabilities?format=json .
And the capability is returned in the message JSON_Cap_OSDPStatus by the output parameter
(lpOutputParam).
Get OSDP card reader status
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
OSDPStatus/<ID>?format=json .
And the parameters are returned in the message JSON_OSDPStatus by the output buffer
(lpOutBuffer) of the output parameter (lpOutputParam).

91
 Device Network SDK (Access Control on Person) Developer Guide

Get capability of setting OSDP card reader ID

Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
OSDPModify/capabilities?format=json .
And the configuration capability is returned in the message JSON_Cap_OSDPModify by the
output parameter (lpOutputParam).
Set OSDP card reader ID
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
OSDPModify/<ID>?format=json and set the input buffer (lpInBuffer) of the input parameter
(lpInputParam) to the message JSON_OSDPModify .

Intelligent Identity Recognition Terminal

Get configuration capability of intelligent identity recognition terminal
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
IdentityTerminal/capabilities .
And the configuration capability is returned in the message XML_Cap_IdentityTerminal by the
output parameter (lpOutputParam).
Get parameters of intelligent identity recognition terminal
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
IdentityTerminal .
And the parameters are returned in the message XML_IdentityTerminal by the output buffer
(lpOutBuffer) of the output parameter (lpOutputParam).
Set parameters of intelligent identity recognition terminal
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
IdentityTerminal and set the input buffer (lpInBuffer) of the input parameter (lpInputParam) to
the message XML_IdentityTerminal .

Picture Storage Server

Get picture storage server parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/System/
PictureServer?format=json .
And the parameters are returned in the message JSON_PictureServerInformation by the output
parameter lpOutputParam.
Set picture storage server parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/System/
PictureServer?format=json and set the input parameter lpInputParam to the message
JSON_PictureServerInformation .

92
 Device Network SDK (Access Control on Person) Developer Guide

2.16.2 Multi-Factor Authentication

The multi-factor authentication is to manage the cards by group and set the authentication for
multiple cards of one access control point (door).

Parameter Settings
• Get multi-factor authentication parameters
Call NET_DVR_GetDVRConfig with the command of NET_DVR_GET_MULTI_CARD_CFG_V50
(command No.: 2515).
And the configuration parameters are returned in the structure
NET_DVR_MULTI_CARD_CFG_V50 by lpOutBuffer.
• Set multi-factor authentication parameters
Call NET_DVR_SetDVRConfig with the command of NET_DVR_SET_MULTI_CARD_CFG_V50
(command No.: 2516) and set lpInBuffer to the structure NET_DVR_MULTI_CARD_CFG_V50 .

Group Settings
• Get group parameters
Call NET_DVR_GetDVRConfig with the command of NET_DVR_GET_GROUP_CFG (command No.:
2112).
And the configuration parameters are returned in the structure NET_DVR_GROUP_CFG by
lpOutBuffer.
• Set group parameters
Call NET_DVR_SetDVRConfig with the command of NET_DVR_SET_GROUP_CFG (command No.:
2113) and set lpInBuffer to the structure NET_DVR_GROUP_CFG .

2.16.3 Other Configurations

Working Status
Call NET_DVR_GetDVRConfig with the command of
NET_DVR_GET_ACS_WORK_STATUS_V50
(command No.: 2180).
And the working status is returned in the structure NET_DVR_ACS_WORK_STATUS_V50 by the
output buffer (lpOutBuffer).
Log Mode
• Get configuration capability of log mode
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
LogModeCfg/capabilities?format=json .
And the configuration capability is returned in the message JSON_Cap_LogModeCfg by the
output parameter (lpOutputParam).
• Get log mode configuration parameters

93
 Device Network SDK (Access Control on Person) Developer Guide

Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/

LogModeCfg?format=json .
And the parameters are returned in the message JSON_LogModeCfg by the output buffer
(lpOutBuffer) of the output parameter (lpOutputParam).
• Set log mode parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
LogModeCfg?format=json and set the input buffer (lpInBuffer) of the input parameter
(lpInputParam) to the message JSON_LogModeCfg .

Event Optimization
• Get configuration capability of event optimization
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
EventOptimizationCfg/capabilities?format=json .
And the configuration capability is returned in the message JSON_Cap_EventOptimizationCfg by
the output parameter (lpOutputParam).
• Get event optimization configuration parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
EventOptimizationCfg?format=json .
And the parameters are returned in the message JSON_EventOptimizationCfg by the output
buffer (lpOutBuffer) of the output parameter (lpOutputParam).
• Set event optimization parameters
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
EventOptimizationCfg?format=json and set the input buffer (lpInBuffer) of the input parameter
(lpInputParam) to the message JSON_EventOptimizationCfg .

Get Face Modeling Failure Information after Upgrading Device

1. Call NET_DVR_GetDeviceAbility , set the capability type dwAbilityType to "ACS_ABILITY", and
set the input buffer (pInBuf) to XML_Desc_AcsAbility for getting the access control capability to
check if getting the information of face modeling failure after upgrading the device is supported.
The capability is returned in the message XML_AcsAbility by the output pointer (pOutBuf).

Note
If the node <isSupportGetFailedFaceInfo> is returned and is set to "true", it indicates that
getting the information of face modeling failure after upgrading the device is supported, and
you can continue to perform the following steps.
2. Call NET_DVR_StartRemoteConfig with
NET_DVR_GET_FAILED_FACE_INFO
(command No.: 2522) and set the input parameter lpInBuffer to the structure
NET_DVR_FAILED_FACE_COND to set up persistent connection and set callback function
fRemoteConfigCallback for getting the information.
3. Call NET_DVR_StopRemoteConfig to disconnect the persistent connection and finish getting the
information.

94
 Device Network SDK (Access Control on Person) Developer Guide

Active Infrared Intrusion Detection

• Get Configuration Capability of Active Infrared Intrusion Detection
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
Configuration/IRCfg/capabilities?format=json .
And the configuration capability is returned in the message JSON_IRCfgCap by lpOutputParam.
• Get Parameters of Active Infrared Intrusion Detection
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
Configuration/IRCfg?format=json .
And the parameters are returned in the message JSON_IRCfg by lpOutputParam.
• Set Parameters of Active Infrared Intrusion Detection
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
Configuration/IRCfg?format=json and set the lpInputParam to JSON_IRCfg .

Condition Parameters of Face Picture Comparison

• Get Condition Configuration Capability of Face Picture Comparison
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
FaceCompareCond/capabilities .
And the configuration capability is returned in the message XML_Cap_FaceCompareCond by
lpOutputParam.
• Get Conditions of Face Picture Comparison
Call NET_DVR_STDXMLConfig to pass through the request URL: GET /ISAPI/AccessControl/
FaceCompareCond .
And the conditions are returned in the message XML_FaceCompareCond by lpOutputParam.
• Set Conditions of Face Picture Comparison
Call NET_DVR_STDXMLConfig to pass through the request URL: PUT /ISAPI/AccessControl/
FaceCompareCond and set lpInputParam to XML_FaceCompareCond .

95
 Device Network SDK (Access Control on Person) Developer Guide

Chapter 3 API Reference

3.1 NET_DVR_Cleanup
Release the resources after the program is ended.

API Definition
BOOL NET_DVR_Cleanup(
);

Return Values
Returns TURE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
The available error codes may be returned by this API are 0 and 3. See details in Device Network
SDK Errors .
Remarks
• When calling this API, you cannot call other APIs at the same time.
• NET_DVR_Init and this API should be called by pair. That is, once the NET_DVR_Init is called, you
should call NET_DVR_Cleanup to release the resources when exiting the program.

3.2 NET_DVR_CloseAlarmChan_V30
Close alarm uploading channel.

API Definition
BOOL NET_DVR_CloseAlarmChan_V30(
LONG lAlarmHandle
);

Parameters
lAlarmHandle
Value returned by NET_DVR_SetupAlarmChan_V50 .

Return Values
Return TURE for success, and return FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
The available error codes of this API are 0, 3, 6, 12, 17, 41, and 47. See details in the Device
Network SDK Errors .

96
 Device Network SDK (Access Control on Person) Developer Guide

3.3 NET_DVR_ControlGateway
Call this API to remotely control the door or elevator.

API Definition
BOOL NET_DVR_ControlGateway(
LONG lUserID,
LONG lGatewayIndex,
DWORD dwStaic
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
lGatewayIndex
[IN] Door No. or floor No., which starts from 1, -1: Control all doors or elevators of floors.
dwStaic
[IN] Command No.: 0-Close (Under Control), 1-Open, 2-Remain Open (Free), 3-Remain Closed
(Disabled), 4-Recovery (only for elevator), 5-Vistor Call Elevator (only for elevator), 6-Resident
Call Elevator (only for elevator).

Return Values
Returns TRUE for success, and returns FALSE for failure.
If returning failed, you can call NET_DVR_GetLastError to get the error code.

3.4 NET_DVR_GetDeviceAbility
Get the device capabilities.

API Definition
BOOL NET_DVR_GetDeviceAbility(
LONG lUserID,
DWORD dwAbilityType,
char *pInBuf,
DWORD dwInLength,
char *pOutBuf,
DWORD dwOutLength
);

Parameters
lUserID

97
 Device Network SDK (Access Control on Person) Developer Guide

[IN] Value returned by NET_DVR_Login_V40 .

dwAbilityType
[IN] Capability types, which are different according to different devices and functions.
pInBuf
[IN] Input parameter buffer pointer, which are different according to different devices and
functions, and they are returned in the structure or messages.
dwInLength
[IN] Size of input buffer.
pOutBuf
[OUT] Output parameter buffer pointer, which are different according to different devices and
functions, and they are returned in the structure or messages.
dwOutLength
[OUT] Size of buffer for receiving data.

Return Values
Returns TRUE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.

3.5 NET_DVR_GetDeviceConfig
Get device configuration information in batch (with sending data).

API Definition
BOOL NET_DVR_GetDeviceConfig(
LONG lUserID,
DWORD dwCommand,
DWORD dwCount,
LPVOID lpInBuffer,
DWORD dwInBufferSize,
LPVOID lpStatusList,
LPVOID lpOutBuffer,
DWORD dwOutBufferSize
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
dwCommand
[IN] Device getting commands. The commands are different for different getting functions.

98
 Device Network SDK (Access Control on Person) Developer Guide

dwCount
[IN] Number of configurations (cameras) to get at a time. 0, 1-one camera, 2-two cameras, 3-
three cameras, and so on. Up to 64 cameras' configuration information can be obtained at a
time.
lpInBuffer
[IN] Pointer of configuration condition buffer, which specifies the number (dwCount) of
configurations to get, and relates to the getting commands.
dwInBufferSize
[IN] Size of configuration condition buffer, which saves the obtained configuration information
(the number is dwCount).
lpStatusList
[OUT] Error information list, and its memory is allocated by user, each error information
contains 4 bytes (a unsigned 32-bit integer).
There is a one-to-one correspondence between the errors in the list and the cameras need to
search, e.g., lpStatusList[2] corresponds to lpInBuffer[2].
If the parameter value is 0 or 1, it refers to getting succeeded, otherwise, this parameter value is
the error code.
lpOutBuffer
[OUT] Parameters returned by device, which relates to the getting commands. And there is a
one-to-one correspondence between the parameters and the cameras need to search.
If the lpStatusList of one camera is larger than 1, the corresponding lpOutBuffer is invalid.
dwOutBufferSize
[IN] Total size of returned results (the number is dwCount).

Return Values
Returns TRUE for success, and returns FALSE for failure. If returns TRUE, it does not mean that all
configurations are obtained, you can check the value of lpStatusList[n] to judge which one is
succeeded.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
See Also
NET_DVR_SetDeviceConfig

3.6 NET_DVR_GetDownloadState
Call this API to get the file downloading progress and status.

99
 Device Network SDK (Access Control on Person) Developer Guide

API Definition
LONG NET_DVR_GetDownloadState(
LONG lDownloadHandle,
LPDWORD pProgress
);

Parameters
lDownloadHandle
[IN] Handle for downloading files, which is returned by NET_DVR_StartDownload .
pProgress
[OUT] Returned progress value, which is ranging from 1 to 100.

Return Values
Returns -1 for calling failed, and returns other values as the downloading status codes: 1-
Downloaded, 2-Downloading, 3-Downloading Failed, 4-Network Disconnected, Unknown Status.
If returning failed, you can call NET_DVR_GetLastError to get the error code.

3.7 NET_DVR_GetDVRConfig
Get the device configuration information.

API Definition
BOOL NET_DVR_GetDVRConfig(
LONG lUserID,
DWORD dwCommand,
LONG lRuleID,
LONG lChannel,
LPVOID lpOutBuffer,
DWORD dwOutBufferSize,
LPDWORD lpBytesReturned
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
dwCommand
[IN] Device getting commands, which are different according to different getting functions.
lRuleID
[IN] Rule ID.
lChannel

100
 Device Network SDK (Access Control on Person) Developer Guide

[IN] Channel No. (NIC No.), which varies with different commands. 0xffffffff-invalid or all
channels, 1-main NIC, 2-extended NIC.
lpOutBuffer
[OUT] Pointer of buffer to receive data. For different getting functions, the structures of this
parameter are different.
dwOutBufferSize
[IN] Size of buffer to receive data (unit: byte). It cannot be 0.
lpBytesReturned
[OUT] Pointer of actually received data size. It cannot be NULL.

Return Values
Returns TRUE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
The following error codes may be returned by this API: 0, 3, 6, 7, 8, 9, 10, 12, 17, 41, 43, 44, 47, 72,
73, and 76. See the corresponding error types and descriptions in the Device Network SDK Errors .
See Also
NET_DVR_SetDVRConfig

3.8 NET_DVR_GetErrorMsg
Return the error information of the last operation.

API Definition
char *NET_DVR_GetErrorMsg(
LONG *pErrorNo
);

Parameters
pErrorNo
[OUT] Error code pointer.

Return Values
The return values are the pointers of error information, see Device Network SDK Errors for details.
Remarks
You can call NET_DVR_GetLastError to get the error codes.

101
 Device Network SDK (Access Control on Person) Developer Guide

3.9 NET_DVR_GetLastError
Return the error code of the last operation.

API Definition
DWORD NET_DVR_GetLastError(
);

Return Values
The return values are error codes, see Device Network SDK Errors for details.
Remarks
You can also call NET_DVR_GetErrorMsg to directly get the error information.

3.10 NET_DVR_GetNextRemoteConfig
Get the next search result.

API Definition
LONG NET_DVR_GetNextRemoteConfig(
LONG lHandle,
void *lpOutBuff,
DWORD dwOutBuffSize
);

Parameters
lHandle
[IN] Search handle, which is the value returned by NET_DVR_StartRemoteConfig .
lpOutBuff
[OUT] Output parameter buffer pointer, which relates to the commands (dwCommand) of
NET_DVR_StartRemoteConfig .
dwOutBuffSize
[IN] Buffer size.

Return Values
Returns -1 for failure, and returns other values for the current statuses, see details in the following
table.

102
 Device Network SDK (Access Control on Person) Developer Guide

Status Value Description

NET_SDK_GET_NEXT_STATUS_ 1000 The data is obtained. The API NET_​DVR_
SUCCESS GetNextRemoteConfig should be called again to
get the next item of data.
NET_SDK_GET_NETX_STATUS_ 1001 Waiting. The API NET_​DVR_​GetNextRemoteConfig
NEED_WAIT can be called again.
NET_SDK_GET_NEXT_STATUS_ 1002 All data is obtained. The API
FINISH NET_DVR_StopRemoteConfig can be called to end.
NET_SDK_GET_NEXT_STATUS_ 1003 Getting data exception. The API
FAILED NET_DVR_StopRemoteConfig can be called to end.

If -1 is returned, you can call NET_DVR_GetLastError to get the error code.

Remarks
To get all information, you should call this API repeatedly.

3.11 NET_DVR_GetUploadState
Get the file uploading progress and status.

API Definition
LONG NET_DVR_GetUploadState(
LONG lUploadHandle,
LPDWORD pProgress
);

Parameters
lUploadHandle
[IN] Handling for uploading files, which is returned by NET_DVR_UploadFile_V40 .
pProgress
[OUT] Returned progress value.

Return Values
Return -1 for failure, and return other values as the uploading status codes, see details in the
following table.

103
 Device Network SDK (Access Control on Person) Developer Guide

Table 2-1 Uploading Status Code

Return Value Description
1 Uploaded.
2 Uploading.
3 Uploading failed.
4 Network disconnected. Unknown status.
6 HDD error.
7 No HDD for saving inquest files.
8 Insufficient capacity.
9 Insufficient device resource.
10 No more files can be uploaded.
11 Too large file size.
12 File type error.
19 Invalid file format.
20 Incorrect file content.
21 The uploaded audio sampling rate is not
supported.
26 Name error.
27 Invalid picture resolution.
28 Too many targets in the picture.
30 Picture recognition failed.
31 Analysis engine exception.
32 Analyzing picture failed.
34 Incorrect security verification key.

3.12 NET_DVR_Init
Initialize the programming environment before calling other APIs.

API Definition
BOOL NET_DVR_Init(
);

104
 Device Network SDK (Access Control on Person) Developer Guide

Return Values
Returns TURE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
The available error codes of this API are 0, 41, and 53. See details in Device Network SDK Errors .
Remarks
Before initializing, you can call NET_DVR_SetSDKInitCfg to set the initialization parameters, such as
supported capabilities, loading path of component libraries (only supported by Linux system), and
so on.
See Also
NET_DVR_Cleanup

3.13 NET_DVR_Login_V40
Log in to the device (supports asynchronous login).

API Definition
LONG NET_DVR_Login_V40(
NET_DVR_USER_LOGIN_INFO pLoginInfo,
NET_DVR_DEVICEINFO_V40 lpDeviceInfo
);

Parameters
pLoginInfo
[IN] Login parameters, including device address, user name, password, and so on. See details in
the structure NET_DVR_USER_LOGIN_INFO .
lpDeviceInfo
[OUT] Device information. See details in the structure NET_DVR_DEVICEINFO_V40 .

Return Values
• For asynchronous login, the callback function ( fLoginResultCallBack ) configured in the
structure ( NET_DVR_USER_LOGIN_INFO ) returns the asynchronous login status, user ID and
device information.
• For synchronous login, this API returns -1 for logging failed, and returns other values for the
returned user IDs. The user ID is unique, and it helps to realize the further device operations.
• If -1 is returned, you can call NET_DVR_GetLastError to get the error code.

105
 Device Network SDK (Access Control on Person) Developer Guide

Remarks
• When bUseAsynLogin in pLoginInfo is 0, it indicates that login is in synchronous mode; when
bUseAsynLogin in pLoginInfo is 1, it indicates that login is in asynchronous mode.
• Up to 2048 users are allowed to log in to HCNetSDK at same time, and the values of returned
UserID are ranging from 0 to 2047.

See Also
NET_DVR_Logout

3.14 NET_DVR_Logout
Log out from devices.

API Definitions
BOOL NET_DVR_Logout(
LONG lUserID
);

Parameters
lUserID
[IN] User ID, which is returned by NET_DVR_Login_V40 .

Return Values
Returns TURE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
The available error codes may be returned by this API are 0, 3, 7, 8, 9, 10, 14, 17, 41, 44, 47, 72,
and 73. See details in Device Network SDK Errors .

3.15 NET_DVR_SendRemoteConfig
Send data via the persistent connection.

API Definition
BOOL NET_DVR_SendRemoteConfig(
LONG lHandle,
DWORD dwDataType,
char *pSendBuf,
DWORD dwBufSize
);

106
 Device Network SDK (Access Control on Person) Developer Guide

Parameters
lHandle
Persistent configuration handle, which is returned by NET_DVR_StartRemoteConfig .
dwDataType
[IN] Data type, which relates to the commands of NET_DVR_StartRemoteConfig .
pSendBuf
[IN] Buffer for saving data to be sent, which relates to dwDataType.
dwBufSize
[IN] Size of data to be sent.

Return Values
Returns TRUE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
Remarks
Before calling this API, you must call NET_DVR_StartRemoteConfig to get the persistent
connection handle.

3.16 NET_DVR_SetDeviceConfig
Set device parameters in batch (sending data is supported).

API Definition
BOOL NET_DVR_SetDeviceConfig(
LONG lUserID,
DWORD dwCommand,
DWORD dwCount,
LPVOID lpInBuffer,
DWORD dwInBufferSize,
LPVOID lpStatusList,
LPVOID lpInParamBuffer,
DWORD dwInParamBufferSize
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
dwCommand
[IN] Device configuration commands, which are different according to different configurations.
dwCount

107
 Device Network SDK (Access Control on Person) Developer Guide

[IN] Number of cameras to be set at a time. 0,1-one camera, 2-two cameras, 3-three cameras,
and so on. Up to 256 cameras can be configured at a time.
lpInBuffer
[IN] Pointer of configuration condition buffer, e.g., stream ID, which specifies the number
(dwCount) of cameras to set, and relates to the configuration commands.
dwInBufferSize
[IN] Size of configuration condition buffer, which saves the configured information of cameras
with the number of dwCount.
lpStatusList
[OUT] Error information list, and its memory is allocated by user, each error information
contains 4 bytes (a unsigned 32-bit integer).
There is a one-to-one correspondence between the errors in the list and the cameras that need
to be searched, e.g., lpStatusList[2] corresponds to lpInBuffer[2].
If the parameter value is 0, it refers to setting succeeded, otherwise, this parameter value is the
error code.
lpInParamBuffer
[IN] Device parameters to set, which relates to the configuration commands. And there is a one-
to-one correspondence between the parameters and the cameras that need to be searched.
dwInParamBufferSize
[IN] Set the size of content buffer.

Return Values
Returns TRUE for success, and returns FALSE for all failed. If returns TRUE, it does not indicate that
all settings are succeeded, you can get the value of lpStatusList[n] to check which one is
succeeded.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
See Also
NET_DVR_GetDeviceConfig

3.17 NET_DVR_SetDVRConfig
Set the device parameters.

API Definition
BOOL NET_DVR_SetDVRConfig(
LONG lUserID,
DWORD dwCommand,
LONG lChannel,
LPVOID lpInBuffer,

108
 Device Network SDK (Access Control on Person) Developer Guide

DWORD dwInBufferSize
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
dwCommand
[IN] Device configuration commands, which are different according to different configuration
functions.
lChannel
[IN] Channel No. (NIC No.), which varies with different commands. 0xFFFFFFFF-invalid, 1-main
NIC, 2-extended NIC.
lpInBuffer
[IN] Pointer of input data buffer. For different configuration functions, the structures of this
parameter are different.
dwInBufferSize
[IN] Size of input data buffer (unit: byte).

Return Values
Returns TRUE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
The following error codes may be returned by this API: 0, 3, 6, 7, 8, 9, 10, 12, 17, 41, 43, 44, 47, 72,
73, and 76. See the corresponding error types and descriptions in the Device Network SDK Errors .
See Also
NET_DVR_GetDVRConfig

3.18 NET_DVR_SetDVRMessageCallBack_V50
Set callback functions for getting the video data.

API Definition
BOOL NET_DVR_SetDVRMessageCallBack_V50(
int iIndex,
MSGCallBack fMessageCallBack,
void *pUser
);

Parameters
iIndex

109
 Device Network SDK (Access Control on Person) Developer Guide

[IN] Callback function index No., which ranges from 0 to 15.

fMessageCallBack
[IN] Callback function, see details in MSGCallBack .
pUser
[IN] User data.

Return Values
Return TRUE for success, and return FALSE for failure.
If FALSE returned, call NET_DVR_GetLastError to get the error code.
Remarks
• This API supports setting multiple callback functions for different channels (up to 16 channels are
supported) at same time, and the configured callback functions are distinguished by the index
No.
• All alarm/event information will be returned in each configured callback function, and you can
distinguish the devices via the pAlarmInfo in the callback function ( MSGCallBack ).
Example
Sample Code of Setting Multiple Callback Functions to Receive Different Alarms/Events in Arming
Mode
#include <stdio.h>
#include <iostream>
#include "Windows.h"
#include "HCNetSDK.h"
using namespace std;

int iNum=0;
void CALLBACK MessageCallbackNo1(LONG lCommand, NET_DVR_ALARMER *pAlarmer, char *pAlarmInfo, DWORD
dwBufLen, void* pUser)
{
int i=0;
char filename[100];
FILE *fSnapPic=NULL;
FILE *fSnapPicPlate=NULL;

//This sample code is for reference only. Actually, it is not recommended to process the data and save file in the
callback function directly.
//You'd better process the data in the message response funcion via message mode (PostMessage).

switch(lCommand)
{
case COMM_ALARM:
{
NET_DVR_ALARMINFO struAlarmInfo;
memcpy(&struAlarmInfo, pAlarmInfo, sizeof(NET_DVR_ALARMINFO));
switch (struAlarmInfo.dwAlarmType)
{

110
 Device Network SDK (Access Control on Person) Developer Guide

case 3: //Motion detection alarm

for (i=0; i<16; i++) //#define MAX_CHANNUM 16 //The maximum number of channels
{
if (struAlarmInfo.dwChannel[i] == 1)
{
printf("Channel Number with Motion Detection Alarm %d\n", i+1);
}
}
break;
default:
break;
}
break;
}
case COMM_UPLOAD_PLATE_RESULT:
{
NET_DVR_PLATE_RESULT struPlateResult={0};
memcpy(&struPlateResult, pAlarmInfo, sizeof(struPlateResult));
printf("License Plate Number: %s\n", struPlateResult.struPlateInfo.sLicense);//License plate number

switch(struPlateResult.struPlateInfo.byColor)//License plate color

{
case VCA_BLUE_PLATE:
printf("Vehicle Color: Blue\n");
break;
case VCA_YELLOW_PLATE:
printf("Vehicle Color: Yellow\n");
break;
case VCA_WHITE_PLATE:
printf("Vehicle Color: White\n");
break;
case VCA_BLACK_PLATE:
printf("Vehicle Color: Black\n");
break;
default:
break;
}
//Scene picture
if (struPlateResult.dwPicLen != 0 && struPlateResult.byResultType == 1 )
{
sprintf(filename,"testpic_%d.jpg",iNum);
fSnapPic=fopen(filename,"wb");
fwrite(struPlateResult.pBuffer1,struPlateResult.dwPicLen,1,fSnapPic);
iNum++;
fclose(fSnapPic);
}
//License plate picture
if (struPlateResult.dwPicPlateLen != 0 && struPlateResult.byResultType == 1)
{
sprintf(filename,"testPicPlate_%d.jpg",iNum);
fSnapPicPlate=fopen(filename,"wb");
fwrite(struPlateResult.pBuffer1,struPlateResult.dwPicLen,1,fSnapPicPlate);

111
 Device Network SDK (Access Control on Person) Developer Guide

iNum++;
fclose(fSnapPicPlate);
}
//Processing other data...
break;
}
case COMM_ITS_PLATE_RESULT:
{
NET_ITS_PLATE_RESULT struITSPlateResult={0};
memcpy(&struITSPlateResult, pAlarmInfo, sizeof(struITSPlateResult));

for (i=0;i<struITSPlateResult.dwPicNum;i++)
{
printf("License Plate Number: %s\n", struITSPlateResult.struPlateInfo.sLicense);//License plate number
switch(struITSPlateResult.struPlateInfo.byColor)//License plate color
{
case VCA_BLUE_PLATE:
printf("Vehicle Color: Blue\n");
break;
case VCA_YELLOW_PLATE:
printf("Vehicle Color: Yellow\n");
break;
case VCA_WHITE_PLATE:
printf("Vehicle Color: White\n");
break;
case VCA_BLACK_PLATE:
printf("Vehicle Color: Black\n");
break;
default:
break;
}
//Save scene picture
if ((struITSPlateResult.struPicInfo[i].dwDataLen != 0)&&(struITSPlateResult.struPicInfo[i].byType== 1)||
(struITSPlateResult.struPicInfo[i].byType == 2))
{
sprintf(filename,"testITSpic%d_%d.jpg",iNum,i);
fSnapPic=fopen(filename,"wb");
fwrite(struITSPlateResult.struPicInfo[i].pBuffer, struITSPlateResult.struPicInfo[i].dwDataLen,1,fSnapPic);
iNum++;
fclose(fSnapPic);
}
//License plate thumbnails
if ((struITSPlateResult.struPicInfo[i].dwDataLen != 0)&&(struITSPlateResult.struPicInfo[i].byType == 0))
{
sprintf(filename,"testPicPlate%d_%d.jpg",iNum,i);
fSnapPicPlate=fopen(filename,"wb");
fwrite(struITSPlateResult.struPicInfo[i].pBuffer, struITSPlateResult.struPicInfo[i].dwDataLen, 1, \
fSnapPicPlate);
iNum++;
fclose(fSnapPicPlate);
}
//Processing other data...

112
 Device Network SDK (Access Control on Person) Developer Guide

}
break;
}
default:
break;
}
}

void CALLBACK MessageCallbackNo2(LONG lCommand, NET_DVR_ALARMER *pAlarmer, char *pAlarmInfo, DWORD

dwBufLen, void* pUser)
{
int i=0;
char filename[100];
FILE *fSnapPic=NULL;
FILE *fSnapPicPlate=NULL;

//This sample code is for reference only. Actually, it is not recommended to process the data and save file in the
callback function directly.
//You'd better process the data in the message response funcion via message mode (PostMessage).

switch(lCommand)
{
case COMM_ALARM:
{
NET_DVR_ALARMINFO struAlarmInfo;
memcpy(&struAlarmInfo, pAlarmInfo, sizeof(NET_DVR_ALARMINFO));
switch (struAlarmInfo.dwAlarmType)
{
case 3: //Motion detection alarm
for (i=0; i<16; i++) //#define MAX_CHANNUM 16 //The maximum number of channel
{
if (struAlarmInfo.dwChannel[i] == 1)
{
printf("Channel No. with Motion Detection Alarm %d\n", i+1);
}
}
break;
default:
break;
}
break;
}
case COMM_UPLOAD_PLATE_RESULT:
{
NET_DVR_PLATE_RESULT struPlateResult={0};
memcpy(&struPlateResult, pAlarmInfo, sizeof(struPlateResult));
printf("License Plate Number: %s\n", struPlateResult.struPlateInfo.sLicense);//License plate number

switch(struPlateResult.struPlateInfo.byColor)//License plate color

{
case VCA_BLUE_PLATE:
printf("Vehicle Color: Blue\n");

113
 Device Network SDK (Access Control on Person) Developer Guide

break;
case VCA_YELLOW_PLATE:
printf("Vehicle Color: Yellow\n");
break;
case VCA_WHITE_PLATE:
printf("Vehicle color: White\n");
break;
case VCA_BLACK_PLATE:
printf("Vehicle Color: Black\n");
break;
default:
break;
}
//Scene picture
if (struPlateResult.dwPicLen != 0 && struPlateResult.byResultType == 1 )
{
sprintf(filename,"testpic_%d.jpg",iNum);
fSnapPic=fopen(filename,"wb");
fwrite(struPlateResult.pBuffer1,struPlateResult.dwPicLen,1,fSnapPic);
iNum++;
fclose(fSnapPic);
}
//License plate picture
if (struPlateResult.dwPicPlateLen != 0 && struPlateResult.byResultType == 1)
{
sprintf(filename,"testPicPlate_%d.jpg",iNum);
fSnapPicPlate=fopen(filename,"wb");
fwrite(struPlateResult.pBuffer1,struPlateResult.dwPicLen,1,fSnapPicPlate);
iNum++;
fclose(fSnapPicPlate);
}
//Processing other data...
break;
}
case COMM_ITS_PLATE_RESULT:
{
NET_ITS_PLATE_RESULT struITSPlateResult={0};
memcpy(&struITSPlateResult, pAlarmInfo, sizeof(struITSPlateResult));

for (i=0;i<struITSPlateResult.dwPicNum;i++)
{
printf("License Plate Number: %s\n", struITSPlateResult.struPlateInfo.sLicense);//License plate number
switch(struITSPlateResult.struPlateInfo.byColor)//License plate color
{
case VCA_BLUE_PLATE:
printf("Vehicle Color: Blue\n");
break;
case VCA_YELLOW_PLATE:
printf("Vehicle Color: Yellow\n");
break;
case VCA_WHITE_PLATE:
printf("Vehicle Color: White\n");

114
 Device Network SDK (Access Control on Person) Developer Guide

break;
case VCA_BLACK_PLATE:
printf("Vehicle Color: Black\n");
break;
default:
break;
}
//Save scene picture
if ((struITSPlateResult.struPicInfo[i].dwDataLen != 0)&&(struITSPlateResult.struPicInfo[i].byType== 1)||
(struITSPlateResult.struPicInfo[i].byType == 2))
{
sprintf(filename,"testITSpic%d_%d.jpg",iNum,i);
fSnapPic=fopen(filename,"wb");
fwrite(struITSPlateResult.struPicInfo[i].pBuffer, struITSPlateResult.struPicInfo[i].dwDataLen,1,fSnapPic);
iNum++;
fclose(fSnapPic);
}
//License plate thumbnails
if ((struITSPlateResult.struPicInfo[i].dwDataLen != 0)&&(struITSPlateResult.struPicInfo[i].byType == 0))
{
sprintf(filename,"testPicPlate%d_%d.jpg",iNum,i);
fSnapPicPlate=fopen(filename,"wb");
fwrite(struITSPlateResult.struPicInfo[i].pBuffer, struITSPlateResult.struPicInfo[i].dwDataLen, 1, \
fSnapPicPlate);
iNum++;
fclose(fSnapPicPlate);
}
//Processing other data...
}
break;
}
default:
break;
}
}

void main() {

//---------------------------------------
//Initialize
NET_DVR_Init();
//Set the connection time and reconnection time
NET_DVR_SetConnectTime(2000, 1);
NET_DVR_SetReconnect(10000, true);

//---------------------------------------
//Log in to device
LONG lUserID;
NET_DVR_DEVICEINFO_V30 struDeviceInfo;
lUserID = NET_DVR_Login_V30("172.0.0.100", 8000, "admin", "12345", &struDeviceInfo);
if (lUserID < 0)
{

115
 Device Network SDK (Access Control on Person) Developer Guide

printf("Login error, %d\n", NET_DVR_GetLastError());

NET_DVR_Cleanup();
return;
}

//Set alarm callback function

NET_DVR_SetDVRMessageCallBack_V50(0, MessageCallbackNo1, NULL);
NET_DVR_SetDVRMessageCallBack_V50(1, MessageCallbackNo2, NULL);

//Enable arming
NET_DVR_SETUPALARM_PARAM struSetupParam={0};
struSetupParam.dwSize=sizeof(NET_DVR_SETUPALARM_PARAM);

//Alarm information type to upload: 0-History Alarm (NET_DVR_PLATE_RESULT), 1-Real-Time Alarm

(NET_ITS_PLATE_RESULT)
struSetupParam.byAlarmInfoType=1;
//Arming Level: Level-2 arming (for traffic device)
struSetupParam.byLevel=1;

LONG lHandle = NET_DVR_SetupAlarmChan_V41(lUserID,&struSetupParam);

if (lHandle < 0)
{
printf("NET_DVR_SetupAlarmChan_V41 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

Sleep(20000);
//Disarm uploading channel
if (!NET_DVR_CloseAlarmChan_V30(lHandle))
{
printf("NET_DVR_CloseAlarmChan_V30 error, %d\n", NET_DVR_GetLastError());
NET_DVR_Logout(lUserID);
NET_DVR_Cleanup();
return;
}

//User logout
NET_DVR_Logout(lUserID);
//Release SDK resource
NET_DVR_Cleanup();
return;
}

See Also
NET_DVR_SetupAlarmChan_V50

116
 Device Network SDK (Access Control on Person) Developer Guide

3.19 NET_DVR_SetSDKInitCfg
Set initialization parameters.

API Parameters
BOOL NET_DVR_SetSDKInitCfg(
NET_SDK_INIT_CFG_TYPE enumType,
void* const lpInBuff
);

Parameters
enumType
[IN] Initialization parameter type. Different type values correspond to different parameters, see
details in the table below.

Table 2-2 NET_SDK_INIT_CFG_TYPE

enumType Value Description lpInBuff
NET_SDK_INIT_CFG_ 1 Capability supported by NET_DVR_INIT_CFG_A
ABILITY SDK. BILITY
NET_SDK_INIT_CFG_ 2 Set loading path for NET_DVR_LOCAL_SDK
SDK_PATH component libraries _PATH
(only supported by
Linux system).
NET_SDK_INIT_CFG_ 3 Set path (including Path in string format,
LIBEAY_PATH library name) for e.g., C:\\libeay32.dll.
libeay32.dll (Windows),
libcrypto.so (Linux),
and libcrypto.dylib
(Mac) of OpenSSL in
version 1.1.1 and 1.0.2.
NET_SDK_INIT_CFG_ 4 Set path (including Path in string format,
SSLEAY_PATH library name) for e.g., C:\\ssleay32.dll.
ssleay32.dll (Windows),
libssl.so (Linux),
libssl.dylib (Mac) of
OpenSSL in version
1.1.1 and 1.0.2.
lpInBuff

117
 Device Network SDK (Access Control on Person) Developer Guide

[IN] Input parameter. Different parameter types correspond to different structures, see details in
the table above.

Return Values
Returns TURE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
Remarks
This API should be called before calling NET_DVR_Init to initialize and check the dependent
libraries or capabilities.

3.20 NET_DVR_SetupAlarmChan_V50
Set up persistent connection to receive alarm/event information (supports alarm/event
subscription).

API Definition
LONG NET_DVR_SetupAlarmChan_V50(
LONG lUserID,
NET_DVR_SETUPALARM_PARAM_V50 lpSetupParam,
char *pData,
DWORD dwDataLen,
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
lpSetupParam
[IN] Arming parameters, refer to the structure NET_DVR_SETUPALARM_PARAM_V50 for
details.
pData
[IN] Alarm/event subscription conditions.
dwDataLen
[IN] Length of alarm/event subscription conditions.

Return Values
Return -1 for failure, and return other values as the handles of NET_DVR_CloseAlarmChan_V30 .
If -1 is returned, you can call NET_DVR_GetLastError to get the error code.

118
 Device Network SDK (Access Control on Person) Developer Guide

Remarks
This API supports alarm/event subscription, you can specify the types of alarm or event to be
uploaded by device by setting pData and dwDataLen.

3.21 NET_DVR_StartDownload
Call this API to download the files.

API Definition
LONG NET_DVR_StartDownload(
LONG lUserID,
DWORD dwDownloadType,
LPVOID lpInBuffer,
DWORD dwInBufferSize,
char const *sFileName
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
dwDownloadType
[IN] Downloading commands which specify the file type to download, see details in the
enumeration NET_SDK_DOWNLOAD_TYPE .
lpInBuffer
[IN] Input parameters, which are different according to different downloading commands.
dwInBufferSize
[IN] Input buffer size.
sFileName
[IN] Path for saving downloaded files (absolute path, includes file name).

Return Values
Returns -1 for failure, and returns other values as the parameters of NET_DVR_StopDownload and
NET_DVR_GetDownloadState .
If returning failed, you can call NET_DVR_GetLastError to get the error code.

3.22 NET_DVR_StartListen_V30
Register callback function for receiving alarm/event information and start listening (supports
multiple threads).

119
 Device Network SDK (Access Control on Person) Developer Guide

API Definition
LONG NET_DVR_StartListen_V30(
char *sLocalIP,
WORD wLocalPort,
MSGCallBack DataCallback,
void *pUserData
);

Parameters
sLocalIP
[IN] IP address of local PC. It can be set to null.
wLocalPort
[IN] Listening port No. of local PC. It is configured by user, and it should be the same with that of
device.
DataCallback
[IN] Alarm/event information callback function, see details in MSGCallBack .
pUserData
[IN] User data.

Return Values
Return -1 for failure, and return other values for the handle parameters of
NET_DVR_StopListen_V30 .
If -1 is returned, you can call NET_DVR_GetLastError to get the error code.
The available error codes of this API are 0, 3, 6, 12, 17, 41, 44, 47, 72, and 75. See details in the
Device Network SDK Errors .
Remarks
• To receive the alarm/event information sent by device, you should set the management host
server address or listening host server address of device to the IP address of PC (which is same
with the sLocalIP), or set the management host server port or listening host server port to the
listening port No. of PC (which is same with the wLocalPort).
• The callback function in this API is prior to other callback functions, that is, if the callback
function is configured in this API, other callback functions will not receive the alarm information.
All the device alarm information is returned in same callback function, and you can distinguish
the devices via the alarm device information (pAlarmInfo).

3.22.1 MSGCallBack
Alarm/event information callback function.

120
 Device Network SDK (Access Control on Person) Developer Guide

Callback Function Definition

typedef void(CALLBACK *MSGCallBack)(
LONG lCommand,
NET_DVR_ALARMER *pAlarmer,
char *pAlarmInfo,
DWORD dwBufLen,
void *pUser
);

Parameters
lCommand
[OUT] Uploaded message type. You can distinguish the alarm/event information via the type.
pAlarmer
[OUT] Alarm device information, including serial No., IP address, login handle, and so on, see
details in NET_DVR_ALARMER .
pAlarmInfo
[OUT] Alarm/event information, the details are returned in different structures according to
lCommand.
dwBufLen
[OUT] Size of alarm/event information buffer.
pUser
[OUT] User data.

3.23 NET_DVR_StartRemoteConfig
Enable remote configuration.

API Definition
LONG NET_DVR_StartRemoteConfig(
LONG lUserID,
DWORD dwCommand,
LPVOID lpInBuffer,
DWORD dwInBufferLen,
fRemoteConfigCallback cbStateCallback,
LPVOID pUserData
);

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .

121
 Device Network SDK (Access Control on Person) Developer Guide

dwCommand
[IN] Configuration commands. For different functions, the commands and lpInBuffer are
different.
lpInBuffer
Input parameter buffer pointer, which relates to the configuration command.
dwInBufferLen
[IN] Size of input buffer.
cbStateCallback
[IN] Status callback function, see the definition in fRemoteConfigCallback .
pUserData
[OUT] User data.

Return Values
Returns -1 for failure, and returns other values for the handles of NET_DVR_GetNextRemoteConfig
and NET_DVR_StopRemoteConfig .
If -1 is returned, you can call NET_DVR_GetLastError to get the error code.
Remarks
This API specifies the information to search. After calling this API, you can call
NET_DVR_GetNextRemoteConfig to get the information one by one.

3.23.1 fRemoteConfigCallback
Function for calling back the persistent connection status and data to be transmitted.

Callback Function Definition

void(CALLBACK *fRemoteConfigCallback)(
DWORD dwType,
void *lpBuffer,
DWORD dwBufLen,
void *pUserData
);

Parameters
dwType
[OUT] Connection statuses, see the macro definitions below:
enum _NET_SDK_CALLBACK_TYPE_{
NET_SDK_CALLBACK_TYPE_STATUS = 0,
NET_SDK_CALLBACK_TYPE_PROGRESS = 1,

122
 Device Network SDK (Access Control on Person) Developer Guide

NET_SDK_CALLBACK_TYPE_DATA =2
}NET_SDK_CALLBACK_TYPE

NET_SDK_CALLBACK_TYPE_STATUS
Connection status.
NET_SDK_CALLBACK_TYPE_PROGRESS
Connection progress.
NET_SDK_CALLBACK_TYPE_DATA
Related data to be called back.
lpBuffer
[OUT] Pointer of buffer for saving progress, status, and related data to be called back, which
relates to dwType, see details in the following table.

dwType lpBuffer
NET_SDK_CALLBACK_TYPE_STATUS If dwBufLen is 4, lpBuffer is 4-byte connection
status; if dwBufLen is 8, lpBuffer consists of 4-
byte connection status and 4-byte error code.
The connection status is enumerated in
NET_SDK_CALLBACK_STATUS_NORMAL
NET_SDK_CALLBACK_TYPE_PROGRESS Connection progress value.
NET_SDK_CALLBACK_TYPE_DATA Data structures to be returned, which are
different according to different commands
(dwCommand) in
NET_DVR_StartRemoteConfig .
dwBufLen
[OUT] Buffer size.
pUserData
[OUT] User data.

3.24 NET_DVR_STDXMLConfig
Transmit request URL with XML or JSON format to implement some typical functions.

API Definition
BOOL NET_DVR_STDXMLConfig(
LONG lUserID,
const NET_DVR_XML_CONFIG_INPUT *lpInputParam,
NET_DVR_XML_CONFIG_OUTPUT *lpOutputParam
);

123
 Device Network SDK (Access Control on Person) Developer Guide

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
lpInputParam
[IN] Input parameters, refer to the structure NET_DVR_XML_CONFIG_INPUT for details.
lpOutputParam
[IN][OUT] Output parameters, refer to the structure NET_DVR_XML_CONFIG_OUTPUT for
details.

Return Values
Return TRUE for success, and return FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
Remarks
The input parameter lpInputParam and output parameter lpOutputParam are different when
passing through request URLs for implementing different functions, and each parameter
corresponds to a component of ISAPI protocol, see the relations below:
Parameter of NET_​DVR_​STDXMLConfig Component of ISAPI Protocol
lpInputParam lpRequestUrl (see in structure Method+URL
NET_DVR_XML_CONFIG_INPU E.g., GET /​ISAPI/​System/
T) capabilities
lpInBuffer (see in structure Request Message
NET_DVR_XML_CONFIG_INPU
T)
lpOutputParam lpOutBuffer (see in structure Response Message
NET_DVR_XML_CONFIG_OUTP
UT )
lpStatusBuffer (see in structure Response Message
NET_DVR_XML_CONFIG_OUTP
UT )

3.25 NET_DVR_StopDownload
Call this API to stop downloading files.

124
 Device Network SDK (Access Control on Person) Developer Guide

API Definition
BOOL NET_DVR_StopDownload(
LONG lHandle
);

Parameters
lHandle
[IN] Handle for downloading files, which is returned by NET_DVR_StartDownload .

Return Values
Returns TRUE for success, and returns FALSE for failure.
If returning failed, you can call NET_DVR_GetLastError to get the error code.

3.26 NET_DVR_StopListen_V30
Stop listening (supports multiple threads).

API Definition
BOOL NET_DVR_StopListen_V30(
LONG lListenHandle
);

Parameters
lListenHandle
Listening handle, which is returned by NET_DVR_StartListen_V30 .

Return Values
Return TRUE for success, and return FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.
The available error codes of this API are 0, 3, 12, and 17. See details in the Device Network SDK
Errors .

3.27 NET_DVR_StopRemoteConfig
Disconnect the persistent connection to stop remote configuration, and release resources.

API Definition
BOOL NET_DVR_StopRemoteConfig(
LONG lHandle
);

125
 Device Network SDK (Access Control on Person) Developer Guide

Parameters
lHandle
[IN] Handle, which is returned by NET_DVR_StartRemoteConfig .

Return Values
Returns TRUE for success, and returns FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.

3.28 NET_DVR_UploadClose
Stop uploading files.

API Definition
BOOL NET_DVR_UploadClose(
LONG lUploadHandle
);

Parameters
lUploadHandle
[IN] Handle for uploading files, which is returned by NET_DVR_UploadFile_V40 .

Return Values
Return TRUE for success, and return FALSE for failure.
If FALSE is returned, you can call NET_DVR_GetLastError to get the error code.

3.29 NET_DVR_UploadFile_V40
Upload file.

API Definition
LONG NET_DVR_UploadFile_V40(
LONG lUserID,
DWORD dwUploadType,
LPVOID lpInBuffer,
DWORD dwInBufferSize,
char *sFileName,
LPVOID lpOutBuffer,
DWORD dwOutBufferSize
);

126
 Device Network SDK (Access Control on Person) Developer Guide

Parameters
lUserID
[IN] Value returned by NET_DVR_Login_V40 .
dwUploadType
[IN] Uploading commands, which specify the file type to upload, see details in the enumeration
NET_SDK_UPLOAD_TYPE .
lpInBuffer
[IN] Input parameters, which are different according to different uploading commands.
dwInBufferSize
[IN] Input buffer size.
sFileName
[IN] Name of the file to be uploaded. For the complete file path (including the file name), the
maximum size is 128 bytes, and the maximum size of the file name is 32 bytes.
lpOutBuffer
[OUT] Output parameters, which are different according to different uploading commands.
dwOutBufferSize
[OUT] Output buffer size.

Return Values
Return -1 for failure, and return other values as the parameter of NET_DVR_UploadClose and
NET_DVR_GetUploadState .
If -1 is returned, you can call NET_DVR_GetLastError to get the error code.

127
 Device Network SDK (Access Control on Person) Developer Guide

Chapter 4 Data Structure

4.1 NET_ALARM_RECORD_EXCEPTION

Structure about Recording Exception Alarm Information

Member Data Type Description

byReason BYTE Exception reason: 0-video volume full, 1-video
volume exception, 2-no available video volume.
byRes1 Array of BYTE Reserved, set to 0. The maximum size is 3 bytes.
sVolumeName Array of BYTE Video volume name, the maximum size is 32
bytes (value of macro definition "MAX_
VOLUMENAME_LEN").
dwVolumeID DWORD Video volume ID, or HDD No.
byRes Array of BYTE Reserved, set to 0. The maximum size is 452
bytes.

4.2 NET_ALARM_STREAM_EXCEPTION

Structure about Video Exception Alarm Information

Member Data Type Description

struIP NET_DVR_IPADDR IP address of video exception channel.
dwChanNo DWORD Channel No.
dwIDIndex DWORD Encoder ID.
sName Array of BYTE Encoder name, the maximum size is 32 bytes
(value of macro definition "STREAM_ID_LEN").
byExceptionCase BYTE Exception reason: 0-data writing exception, 1-
network exception.
byRes Array of BYTE Reserved, set to 0. The maximum size is 307
bytes.

4.3 NET_ALARM_RESOURCE_USAGE

128
 Device Network SDK (Access Control on Person) Developer Guide

Structure about Resource Usage Alarm Information

Member Data Type Description

byLevel BYTE Usage alarm level: 0-normal, 1-alarm level 1, 2-
alarm level 2, 3-alarm level 3.
byRes Array of BYTE Reserved, set to 0. The maximum size is 491
bytes.

4.4 NET_ALARM_RECORDFILE_LOSS

Structure about Video Loss Alarm Information

Member Data Type Description

struInspectStart NET_DVR_TIME_EX Start time of video loss check.
struInspectEnd NET_DVR_TIME_EX End time of video loss check.
struIP NET_DVR_IPADDR IP address of video loss channel.
dwChanNo DWORD Channel No.
dwIDIndex DWORD Encoder ID.
sName Array of BYTE Encoder name, the maximum size is 32 bytes
(value of macro definition "STREAM_ID_LEN").
struLossStartTime NET_DVR_TIME_EX Start time of video loss.
struLossEndTime NET_DVR_TIME_EX End time of video loss.
dwLostNum DWORD Number of lost video files, 0xffffffff-​all video
files are lost.
byRes Array of BYTE Reserved, set to 0. The maximum size is 240
bytes.

4.5 NET_ALARM_CVR_SUBINFO_UNION

129
 Device Network SDK (Access Control on Person) Developer Guide

Union about CVR Alarm Information

Member Data Type Description

byLen Array of BYTE Union size, the maximum size is 492 bytes.
struRecordLost NET_ALARM_RECORD Video loss alarm information, the value of
FILE_LOSS dwAlarmType in
NET_DVR_ALARMINFO_DEV_V40 is 8.
struStreamException NET_ALARM_STREAM Streaming exception alarm information, the
_EXCEPTION value of dwAlarmType in
NET_DVR_ALARMINFO_DEV_V40 is 9.
struResourceUsage NET_ALARM_RESOUR Resource usage alarm information, the value of
CE_USAGE dwAlarmType in
NET_DVR_ALARMINFO_DEV_V40 is 10.
struRecordException NET_ALARM_RECORD Recording exception alarm information, the
_EXCEPTION value of dwAlarmType in
NET_DVR_ALARMINFO_DEV_V40 is 12.

4.6 NET_DVR_ACS_ALARM_INFO_V50
Access control alarm/event information structure.

Structure Definition
struct{
DWORD dwSize;
DWORD dwMajor;
DWORD dwMinor;
NET_DVR_TIME struTime;
BYTE sNetUser[MAX_NAMELEN/*16*/];
NET_DVR_IPADDR struRemoteHostAddr;
NET_DVR_ACS_EVENT_INFO_V50 struAcsEventInfo;
DWORD dwPicDataLen;
char *pPicData;
WORD wInductiveEventType;
BYTE byPicTransType;
BYTE byRes1;
DWORD dwIOTChannelNo;
char *pAcsEventInfoExtend;
BYTE byAcsEventInfoExtend;
BYTE byTimeType;
BYTE byRes[10];
}NET_DVR_ACS_ALARM_INFO_V50, *LPNET_DVR_ACS_ALARM_INFO_V50;

130
 Device Network SDK (Access Control on Person) Developer Guide

Members
dwSize
Structure size.
dwMajor
Event major types, see details in Access Control Event Types .
dwMinor
Event minor types, see details in Access Control Event Types .
struTime
Time information, see NET_DVR_TIME for details.
sNetUser
User name.
struRemoteHostAddr
IP address of remote access controller, see NET_DVR_IPADDR for details.
struAcsEventInfo
Access control event details, see NET_DVR_ACS_EVENT_INFO_V50 for details.
dwPicDataLen
Picture size, non-0: picture data exists.
pPicData
Picture data.
wInductiveEventType
Inductive event type, 0-invalid. The alarm event types will be distinguished according to the
inductive event type if wInductiveEventType is not 0; otherwise, the alarm event types will be
distinguished according to dwMajor and dwMinor.
byPicTransType
Picture data transmission mode: 0-binary, 1-URL.
byRes1
Reserved.
dwIOTChannelNo
IOT channel No.
pAcsEventInfoExtend
When this member is set to 1, it points to the structure NET_DVR_ACS_EVENT_INFO_EXTEND .
byAcsEventInfoExtend
Whether pAcsEventInfoExtend is valid: 0-no, 1-yes.
byTimeType

131
 Device Network SDK (Access Control on Person) Developer Guide

Time type: 0-device's local time, 1-UTC time (which is the same as struTime).
byRes
Reserved, set to 0.

4.7 NET_DVR_ACS_CFG
Access controller configuration parameter structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byRS485Backup;
BYTE byShowCapPic;
BYTE byShowCardNo;
BYTE byShowUserInfo;
BYTE byOverlayUserInfo;
BYTE byVoicePrompt;
BYTE byUploadCapPic;
BYTE bySaveCapPic;
BYTE byInputCardNo;
BYTE byEnableWifiDetect;
BYTE byEnable3G4G;
BYTE byProtocol;
BYTE byRes[500];
}NET_DVR_ACS_CFG, *LPNET_DVR_ACS_CFG;

Members
dwSize
Structure size
byRS485Backup
Whether to enable downstream backup function of RS485: 0-no, 1-yes
byShowCapPic
Whether to display captured picture: 0-no, 1-yes
byShowCardNo
Whether to display card No.: 0-no, 1-yes
byShowUserInfo
Whether to display user information: 0-no, 1-yes
byOverlayUserInfo
Whether to display user information on video: 0-no, 1-yes
byVoicePrompt

132
 Device Network SDK (Access Control on Person) Developer Guide

Whether to enable voice prompt: 0-no, 1-yes

byUploadCapPic
Whether to upload captured picture: 0-no, 1-yes
bySaveCapPic
Whether to save captured picture: 0-no, 1-yes
byInputCardNo
Whether to allow entering card No. by keypad: 0-no, 1-yes
byEnableWifiDetect
Whether to enable Wi-Fi probe: 0-no, 1-yes
byEnable3G4G
Whether to enable 3G/4G: 0-no, 1-yes
byProtocol
Communication protocol type of the card reader: 0-private protocol (default), 1-OSDP protocol.
byRes
Reserved, set to 0

4.8 NET_DVR_ACS_EVENT_CFG
Access control event parameter structure.

Structure Definition
struct{
DWORD dwSize;
DWORD dwMajor;
DWORD dwMinor;
NET_DVR_TIME struTime;
BYTE sNetUser[MAX_NAMELEN/*16*/];
NET_DVR_IPADDR struRemoteHostAddr;
NET_DVR_ACS_EVENT_DETAIL struAcsEventInfo;
DWORD dwPicDataLen;
char *pPicData;
BYTE byTimeType;
BYTE byRes[61];
}NET_DVR_ACS_EVENT_CFG, *LPNET_DVR_ACS_EVENT_CFG;

Members
dwSize
Structure size.
dwMajor

133
 Device Network SDK (Access Control on Person) Developer Guide

Event major types, see details in Access Control Event Types .

dwMinor
Event minor types, see details in Access Control Event Types .
struTime
Time information, see NET_DVR_TIME for details.
sNetUser
User name.
struRemoteHostAddr
IP address of remote access controller, see NET_DVR_IPADDR for details.
struAcsEventInfo
Access control event details, see NET_DVR_ACS_EVENT_DETAIL for details.
dwPicDataLen
Picture size, non-0: picture data exists.
pPicData
Picture data.
byTimeType
Time type: 0-device local time (default), 1-UTC time (which is same as struTime).
byRes
Reserved, set to 0.

4.9 NET_DVR_ACS_EVENT_COND
Condition structure about getting access control events.

Structure Definition
struct{
DWORD dwSize;
DWORD dwMajor;
DWORD dwMinor;
NET_DVR_TIME struStartTime;
NET_DVR_TIME struEndTime;
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byName[NAME_LEN/*32*/];
BYTE byPicEnable;
BYTE byTimeType;
BYTE byRes2[2];
DWORD dwBeginSerialNo;
DWORD dwEndSerialNo;
DWORD dwIOTChannelNo;
WORD wInductiveEventType;

134
 Device Network SDK (Access Control on Person) Developer Guide

BYTE bySearchType;
BYTE byEventAttribute;
char szMonitorID[NET_SDK_MONITOR_ID_LEN/*64*/];
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byRes[140];
}NET_DVR_ACS_EVENT_COND,*LPNET_DVR_ACS_EVENT_COND;

Members
dwSize
Structure size.
dwMajor
Event major types, see details in Access Control Event Types , 0-all.
dwMinor
Event minor types, see details in Access Control Event Types , 0-all.
struStartTime
Start time, see NET_DVR_TIME for details.
struEndTime
End time, see NET_DVR_TIME for details.
byCardNo
Card No.
byName
Cardholder name.
byPicEnable
Whether contain pictures: 0-no, 1-yes.
byTimeType
Time type: 0-device local time (default), 1-UTC time (which is same as struStartTime and
struEndTime).
byRes2
Reserved, set to 0.
dwBeginSerialNo
Start serial No.: 0-all.
dwEndSerialNo
End serial No.: 0-all.
dwIOTChannelNo
IOT channel No., 0-invalid.
wInductiveEventType

135
 Device Network SDK (Access Control on Person) Developer Guide

Inductive event type, 0-invalid. The alarm event types will be distinguished according to the
inductive event type if wInductiveEventType is not 0; otherwise, the alarm event types will be
distinguished according to dwMajor and dwMinor.
bySearchType
Search mode: 0-reserved, 1-search by event source (the channel No. is the non-video channel
No.), 2-search by monitoring resource ID.
byEventAttribute
Event attribute: 0-undefined, 1-valid authentication, 2-other.
szMonitorID
Monitoring resource ID which consists of device serial No., channel type, and No. For example,
the access point ID is device serial No.+"DOOR"+door No.
byEmployeeNo
Employee No. (person ID)
byRes
Reserved, set to 0.

4.10 NET_DVR_ACS_EVENT_DETAIL
Access control event details structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byCardType;
BYTE byWhiteListNo;
BYTE byReportChannel;
BYTE byCardReaderKind;
DWORD dwCardReaderNo;
DWORD dwDoorNo;
DWORD dwVerifyNo;
DWORD dwAlarmInNo;
DWORD dwAlarmOutNo;
DWORD dwCaseSensorNo;
DWORD dwRs485No;
DWORD dwMultiCardGroupNo;
WORD wAccessChannel;
BYTE byDeviceNo;
BYTE byDistractControlNo;
DWORD dwEmployeeNo;
WORD wLocalControllerID;
BYTE byInternetAccess;
BYTE byType;

136
 Device Network SDK (Access Control on Person) Developer Guide

BYTE byMACAddr[MACADDR_LEN/*6*/];
BYTE bySwipeCardType;
BYTE byEventAttribute;
DWORD dwSerialNo;
BYTE byChannelControllerID;
BYTE byChannelControllerLampID;
BYTE byChannelControllerIRAdaptorID;
BYTE byChannelControllerIREmitterID;
DWORD dwRecordChannelNum;
char *pRecordChannelData;
BYTE byUserType;
BYTE byCurrentVerifyMode;
BYTE byAttendanceStatus;
BYTE byStatusValue;
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byRes[64];
}NET_DVR_ACS_EVENT_DETAIL, *LPNET_DVR_ACS_EVENT_DETAIL;

Members
dwSize
Structure size.
byCardNo
Card No.: 0-invalid.
byCardType
Card types: 0-invalid, 1-normal card, 2-disabled card, 3-blacklist card, 4-patrol card, 5-duress
card, 6-super card, 7-visitor card.
byWhiteListNo
Whitelist No., which is between 1 and 8, but if the value is 0, it is invalid.
byReportChannel
Event uploading channel types: 0-invalid, 1-upload in arming mode, 2-upload by central group 1,
3-upload by central group 2.
byCardReaderKind
Authentictaion device types: 0-invalid, 1-IC card reader, 2-ID card reader, 3-QR code scanner, 4-
fingerprint module.
dwCardReaderNo
Authentication device No.: 0-invalid.
dwDoorNo
Door or floor No.: 0-invalid. For Turnstile (swing barrier), door No.1 refers to entrance, and door
No.2 refers to exist.
dwVerifyNo
Multiple authentication No.: 0-invalid

137
 Device Network SDK (Access Control on Person) Developer Guide

dwAlarmInNo
Alarm input No.: 0-invalid
dwAlarmOutNo
Alarm output No.: 0-invalid
dwCaseSensorNo
Event trigger No.
dwRs485No
RS485 channel No.: 0-invalid.
dwMultiCardGroupNo
Group No.
wAccessChannel
Turnstile No.
byDeviceNo
Device No.: 0-invalid.
byDistractControlNo
Distributed controller No.: 0-invalid.
dwEmployeeNo
Employee No.: 0-invalid.
wLocalControllerID
Distributed access controller No.: 0-access controller, 0 to 64: distributed access controller.
byInternetAccess
Network interface No.: 1-upstream network interface No.1, 2-upstream network interface No.2,
3-downstream network interface No.1.
byType
Zone types: 0-instant alarm zone, 1-24-hour alarm zone, 2-delayed zone, 3-internal zone, 4-key
zone, 5-fire alarm zone, 6-perimeter protection, 7-24-hour silent alarm zone, 8-24-hour auxiliary
zone, 9-24-hour shock alarm zone, 10-emergency door open alarm zone, 11-emergency door
closed alarm zone, off-none
byMACAddr
Physical address, 0-invalid.
bySwipeCardType
Card swiping type: 0-invalid, 1-QR code.
byEventAttribute
Event attribute: 0-undefined, 1-valid authentication, 2-other.
dwSerialNo

138
 Device Network SDK (Access Control on Person) Developer Guide

Event serial No.: 0-invalid, which is used to judge whether the event loss occurred.
byChannelControllerID
Lane controller No.: 0-invalid, 1-master lane controller, 2-slave lane controller.
byChannelControllerLampID
Light board No. of lane controller, which is between 1 and 255, 0-invalid
byChannelControllerIRAdaptorID
IR adaptor No. of lane controller, which is between 1 and 255, 0-invalid.
byChannelControllerIREmitterID
Active infrared intrusion detector No. of lane controller, which is between 1 and 255, 0-invalid.
dwRecordChannelNum
Number of recording channels.
pRecordChannelData
Recording channel, the size depends on dwRecordChannelNum.
byUserType
Person type: 0-invalid, 1-resident, 2-visitor, 3-person in blacklist, 4-administrator.
byCurrentVerifyMode
Authentication mode: 0-invalid, 1-sleepy, 2-card+password, 3-card, 4-card or password, 5-
fingerprint, 6-fingerprint+password, 7-fingerprint or card, 8-fingerprint+card, 9-fingerprint+card
+password, 10-face or fingerprint or card or password, 11-face+fingerprint, 12-face+password,
13-face+card, 14-face, 15-employee No.+password, 16-fingerprint or password, 17-employee
No.+fingerprint, 18-employee No.+fingerprint+password, 19-face+fingerprint+card, 20-face
+password+fingerprint, 21-employee No.+face, 22-face or face+card, 23-fingerprint or face, 24-
card or face or password, 25-card or face, 26-card or face or fingerprint, 27-card or fingerprint
or password.
byAttendanceStatus
Attendance status: 0-undefined, 1-check in, 2-check out, 3-break out, 4-break in, 5-overtime in,
6-overtime out.
byStatusValue
Attendance status value.
byEmployeeNo
Employee No. (person ID). Both byEmployeeNo and dwEmployeeNo should be transferred by
the device. The byEmployeeNo will be parsed by the upper-level platform or client first. If the
byEmployeeNo is NULL, the dwEmployeeNo will be parsed.
byRes
Reserved, set to 0.

139
 Device Network SDK (Access Control on Person) Developer Guide

4.11 NET_DVR_ACS_EVENT_INFO_EXTEND
Structure about extended access control event information.

Structure Definition
struct{
DWORD dwFrontSerialNo;
BYTE byUserType;
BYTE byCurrentVerifyMode;
BYTE byCurrentEvent;
BYTE byRes1;
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byAttendanceStatus;
BYTE byStatusValue;
BYTE byRes2[2];
BYTE byUUID[NET_SDK_UUID_LEN/*36*/];
BYTE byRes[88];
}NET_DVR_ACS_EVENT_INFO_EXTEND, *LPNET_DVR_ACS_EVENT_INFO_EXTEND;

Members
dwFrontSerialNo
Event serial No., 0-invalid. If this member is set to 0, the platform will judge whether the event
is lost by dwSerialNo; otherwise, the platform will judge whether the event is lost by both
dwFrontSerialNo and dwSerialNo. This member is used for discontinuous dwSerialNo after
alarm subscription.
byUserType
Person type: 0-invalid, 1-resident, 2-visitor, 3-person in blacklist, 4-administrator.
byCurrentVerifyMode
Current authentication mode of the card reader: 0-invalid, 1-sleepy, 2-card+password, 3-card, 4-
card or password, 5-fingerprint, 6-fingerprint+password, 7-fingerprint or card, 8-fingerprint
+card, 9-fingerprint+card+password, 10-face or fingerprint or card or password, 11-face
+fingerprint, 12-face+password, 13-face+card, 14-face, 15-employee No.+password, 16-
fingerprint or password, 17-employee No.+fingerprint, 18-employee No.+fingerprint+password,
19-face+fingerprint+card, 20-face+password+fingerprint, 21-employee No.+face, 22-face or face
+card, 23-fingerprint or face, 24-card or face or password, 25-card or face, 26-card or face or
fingerprint, 27-card or fingerprint or password.
byCurrentEvent
Whether it is a real-time event: 0-invalid, 1-yes (real-time event), 2-no (offline event).
byRes1
Reserved.
byEmployeeNo

140
 Device Network SDK (Access Control on Person) Developer Guide

Employee No. (person ID). Both byEmployeeNo and dwEmployeeNo should be transferred by
the device. The byEmployeeNo will be parsed by the upper-level platform or client first. If the
byEmployeeNo is NULL, the dwEmployeeNo will be parsed.
byAttendanceStatus
Attendance status: 0-undefined, 1-check in, 2-check out, 3-break out, 4-break in, 5-overtime in,
6-overtime out.
byStatusValue
Attendance status value.
byRes2
Reserved.
byUUID
UUID, this member is only used when accessing EZVIZ platform.
byRes
Reserved.

See Also
NET_DVR_ACS_ALARM_INFO_V50

4.12 NET_DVR_ACS_EVENT_INFO_V50
Access control event details structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byCardType;
BYTE byWhiteListNo;
BYTE byReportChannel;
BYTE byCardReaderKind;
DWORD dwCardReaderNo;
DWORD dwDoorNo;
DWORD dwVerifyNo;
DWORD dwAlarmInNo;
DWORD dwAlarmOutNo;
DWORD dwCaseSensorNo;
DWORD dwRs485No;
DWORD dwMultiCardGroupNo;
WORD wAccessChannel;
BYTE byDeviceNo;
BYTE byDistractControlNo;
DWORD dwEmployeeNo;
WORD wLocalControllerID;

141
 Device Network SDK (Access Control on Person) Developer Guide

BYTE byInternetAccess;
BYTE byType;
BYTE byMACAddr[MACADDR_LEN/*6*/];
BYTE bySwipeCardType;
BYTE byRes2;
DWORD dwSerialNo;
BYTE byChannelControllerID;
BYTE byChannelControllerLampID;
BYTE byChannelControllerIRAdaptorID;
BYTE byChannelControllerIREmitterID;
BYTE byRes[4];
}NET_DVR_ACS_EVENT_INFO_V50, *LPNET_DVR_ACS_EVENT_INFO_V50;

Members
dwSize
Structure size.
byCardNo
Card number, some special cards' numbers are listed as the follows: "18446744073709551613"-
supper card, "18446744073709551614"-duress card, "18446744073709551615"-invalid card.
byCardType
Card types: 0-invalid, 1-normal card, 2-disabled card, 3-blacklist card, 4-patrol card, 5-duress
card, 6-super card, 7-visitor card.
byWhiteListNo
Whitelist No., which is between 1 and 8, but if the value is 0, it is invalid.
byReportChannel
Event uploading channel types: 0-invalid, 1-upload in arming mode, 2-upload by central group 1,
3-upload by central group 2.
byCardReaderKind
Authentictaion device types: 0-invalid, 1-IC card reader, 2-ID card reader, 3-QR code scanner, 4-
fingerprint module.
dwCardReaderNo
Authentication device No.: 0-invalid.
dwDoorNo
Door or floor No.: 0-invalid. For Turnstile (swing barrier), door No.1 refers to entrance, and door
No.2 refers to exit.
dwVerifyNo
Multiple authentication No.: 0-invalid
dwAlarmInNo
Alarm input No.: 0-invalid
dwAlarmOutNo

142
 Device Network SDK (Access Control on Person) Developer Guide

Alarm output No.: 0-invalid

dwCaseSensorNo
Event trigger No.
dwRs485No
RS485 channel No.: 0-invalid.
dwMultiCardGroupNo
Group No.
wAccessChannel
Turnstile No.
byDeviceNo
Device No.: 0-invalid.
byDistractControlNo
Distributed controller No.: 0-invalid.
dwEmployeeNo
Employee ID.: 0-invalid.
wLocalControllerID
Distributed access controller No.: 0-access controller, 0 to 64: distributed access controller.
byInternetAccess
Network interface No.: 1-upstream network interface No.1, 2-upstream network interface No.2,
3-downstream network interface No.1.
byType
Zone types: 0-instant alarm zone, 1-24-hour alarm zone, 2-delayed zone, 3-internal zone, 4-key
zone, 5-fire alarm zone, 6-perimeter protection, 7-24-hour silent alarm zone, 8-24-hour auxiliary
zone, 9-24-hour shock alarm zone, 10-emergency door open alarm zone, 11-emergency door
closed alarm zone, off-none
byMACAddr
Physical address, 0-invalid.
bySwipeCardType
Card swiping type: 0-invalid, 1-QR code.
byRes2
Reserved, set to 0.
dwSerialNo
Event serial No.: 0-invalid, which is used to judge whether the event loss occurred.
byChannelControllerID
Lane controller No.: 0-invalid, 1-master lane controller, 2-slave lane controller.

143
 Device Network SDK (Access Control on Person) Developer Guide

byChannelControllerLampID
Light board No. of lane controller, which is between 1 and 255, 0-invalid
byChannelControllerIRAdaptorID
IR adaptor No. of lane controller, which is between 1 and 255, 0-invalid.
byChannelControllerIREmitterID
Active infrared intrusion detector No. of lane controller, which is between 1 and 255, 0-invalid.
byRes
Reserved, set to 0.

4.13 NET_DVR_ACS_WORK_STATUS_V50
Access controller working status structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byDoorLockStatus[MAX_DOOR_NUM/*256*/];
BYTE byDoorStatus[MAX_DOOR_NUM/*256*/];
BYTE byMagneticStatus[MAX_DOOR_NUM/*256*/];
BYTE byCaseStatus[MAX_CASE_SENSOR_NUM/*8*/];
WORD wBatteryVoltage;
BYTE byBatteryLowVoltage;
BYTE byPowerSupplyStatus;
BYTE byMultiDoorInterlockStatus;
BYTE byAntiSneakStatus;
BYTE byHostAntiDismantleStatus;
BYTE byIndicatorLightStatus;
BYTE byCardReaderOnlineStatus[MAX_CARD_READER_NUM/*512*/];
BYTE byCardReaderAntiDismantleStatus[MAX_CARD_READER_NUM/*512*/];
BYTE byCardReaderVerifyMode[MAX_CARD_READER_NUM/*512*/];
BYTE bySetupAlarmStatus[MAX_ALARMHOST_ALARMIN_NUM/*512*/];
BYTE byAlarmInStatus[MAX_ALARMHOST_ALARMIN_NUM/*512*/];
BYTE byAlarmOutStatus[MAX_ALARMHOST_ALARMOUT_NUM/*512*/];
DWORD dwCardNum;
BYTE byFireAlarmStatus;
BYTE byBatteryChargeStatus;
BYTE byMasterChannelControllerStatus;
BYTE bySlaveChannelControllerStatus;
BYTE byAntiSneakServerStatus;
BYTE byRes3[3];
DWORD dwWhiteFaceNum;
DWORD dwBlackFaceNum;
BYTE byRes2[108];
}NET_DVR_ACS_WORK_STATUS_V50,*LPNET_DVR_ACS_WORK_STATUS_V50;

144
 Device Network SDK (Access Control on Person) Developer Guide

Members
dwSize
Structure size
byDoorLockStatus
Lock status (or elevator relay status), 0-closed, 1-open, 2-short circuit alarm, 3-open circuit
alarm, 4-exception alarm
byDoorStatus
Door status (or elevator status): 1-sleepy, 2-open (for elevator: free status), 3-closed (for
elevator: disabled status), 4-normal (for elevator: controlled status).
byMagneticStatus
Magnet status: 0-closed, 1-open, 2-short circuit alarm, 3-open circuit alarm, 4-exception alarm.
byCaseStatus
Alarm input status: 0-no input, 1-with input.
wBatteryVoltage
Storage battery voltage, the actual value equals to the 10 multiples of wBatteryVoltage, unit:
volt.
byBatteryLowVoltage
Whether the storage battery is in low voltage status: 0-no, 1-yes.
byPowerSupplyStatus
Device power supply status: 1-AC, 2-storage battery.
byMultiDoorInterlockStatus
Multi-door interlocking status: 0-disabled, 1-enabled.
byAntiSneakStatus
Anti-passing back status: 0-disabled, 1-enabled.
byHostAntiDismantleStatus
Controller tampering status: 0-disabled, 1-enabled.
byIndicatorLightStatus
Indicator status: 0-offline, 1-online.
byCardReaderOnlineStatus
Fingerprint and card reader status: 0-offline, 1-online.
byCardReaderAntiDismantleStatus
Fingerprint and card reader tampering status: 0-offline, 1-online.
byCardReaderVerifyMode

145
 Device Network SDK (Access Control on Person) Developer Guide

Authentication types: 0-invalid, 1-sleepy, 2-card+password, 3-card, 4-card or password, 5-

fingerprint, 6-fingerprint+password, 7-fingerprint or card, 8-fingerprint+card, 9-fingerprint+card
+password, 10-face+fingerprint+card+password, 11-face+fingerprint, 12-face+password, 13-face
+card, 14-face, 15-employee ID+password, 16-fingerprint or password, 17-employee ID
+fingerprint, 18-employee ID+fingerprint+password, 19-face+fingerprint+card, 20-face
+fingerprint+password, 21-employee ID+face, 22-face/face+card, 23-fingerprint/face, 24-card/
face/password.
bySetupAlarmStatus
Alarm input arming status: 0-disarmed, 1-armed
byAlarmInStatus
Alarm input status: 0-no alarm, 1-in alarm.
byAlarmOutStatus
Alarm output status: 0-no alarm, 1-in alarm.
dwCardNum
Number of added cards.
byFireAlarmStatus
Fire alarm status: 0-normal, 1-short circuit alarm, 2-open circuit alarm.
byBatteryChargeStatus
Battery charging status: 0-invalid, 1-charging, 2-unchanged.
byMasterChannelControllerStatus
Online status of master lane controller online status: 0-invalid, 1-offline, 2-online.
bySlaveChannelControllerStatus
Online status of slave lane controller online status: 0-invalid, 1-offline, 2-online.
byAntiSneakServerStatus
Anti-passing back server status: 0-invalid, 1-disabled, 2-normal, 3-disconnected.
byRes3
Reserved, set to 0.
dwWhiteFaceNum
The number of face pictures in whitelist.
wBlackFaceNum
The number of face pictures in blacklist.
byRes2
Reserved, set to 0

4.14 NET_DVR_ALARMER

146
 Device Network SDK (Access Control on Person) Developer Guide

Alarm Device Information Structure

Member Data Type Description

byUserIDValid BYTE Whether the user ID is valid: 0-no, 1-yes
bySerialValid BYTE Whether the serial No. is valid: 0-no, 1-yes
byVersionValid BYTE Whether the version No. is valid: 0-no, 1-yes
byDeviceNameValid BYTE Whether the device name is valid: 0-no, 1-yes
byMacAddrValid BYTE Whether the MAC address is valid: 0-no, 1-yes
byLinkPortValid BYTE Whether the login port No. is valid: 0-no, 1-yes
byDeviceIPValid BYTE Whether the device IP address is valid: 0-no, 1-
yes
bySocketIPValid BYTE Whether the Socket IP address is valid: 0-no, 1-
yes
lUserID LONG Value returned by NET_DVR_Login_V40 , it is
valid when arming.
sSerialNumber Array of BYTE Serial No.
dwDeviceVersion DWORD Version information
sDeviceName Array of char Device name
byMacAddr Array of BYTE MAC address
wLinkPort WORD Device communication port No.
sDeviceIP Array of char Device IP address
sSocketIP Array of char Socket IP address when actively uploading
alarm.
byIpProtocol BYTE Network protocol: 0-IPv4, 1-IPv6
byRes2 Array of BYTE Reserved, set to 0.

4.15 NET_DVR_ALARMINFO_DEV

Device Alarm Information Structure

Memeber Data Type Description

dwAlarmType DWORD Alarm types: 0-alarm input alarm of encoder, 1-
second private volume damaged, 2-NVR

147
 Device Network SDK (Access Control on Person) Developer Guide

Memeber Data Type Description

disconnected, 3-encoder exception, 4-system
clock exception, 5-the remaining capacity of the
recording volume is too low, 6-​motion detection
alarm of encoder or encoding channel, 7-video
tampering alarm of encoder or encoding
channel.
struTime Alarm time
byRes Array of BYTE Reserved, set to 0.
dwNumber DWORD Number of alarm triggered channels.
pNO WORD* Channel No. or disk No., which ranges from 0 to
65535.

Remarks
For pNO: if dwAlarmType is 0, 3, 6, or 7, it may be channel No.; if dwAlarmType is 5, it may be disk
No.

4.16 NET_DVR_ALARMINFO_DEV_V40

Structure about CVR Alarm Information

Member Data Type Description

dwAlarmType DWORD Alarm categories: 0-alarm input alarm of
encoder, 1-second private volume damaged, 2-
NVR disconnected, 3-encoder exception, 4-
system clock exception, 5-the remaining
capacity of the recording volume is too low, 6-
motion detection alarm of encoder or encoding
channel, 7-video tampering alarm of encoder or
encoding channel, 8-video loss alarm, 9-​real-
time health monitoring alarm, 10-usage alarm,
11-CVR exception recovered, 12-recording
exception.
struTime NET_DVR_TIME Alarm time
uSubAlarmInfo NET_ALARM_CVR_SU CVR alarm information structure, and it is valid
BINFO_UNION when the alarm type is 8, 9, 10, and 12.

148
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

byRes Array of BYTE Reserved, set to 0. The maximum size is 256
bytes.
dwNumber DWORD Number of alarm triggered channels.
pNO WORD* Channel No. or disk No., which ranges from 0 to
65535.

Remarks
For pNO: if dwAlarmType is 0, 3, 6, or 7, it may be channel No.; if dwAlarmType is 5, it may be disk
No.

4.17 NET_DVR_ALRAM_FIXED_HEADER

Structure About Constant Alarm Information

Member Data Type Description

dwAlarmType DWORD Alarm information type: 0-alarm input alarm, 1-
HDD full, 2-video loss, 3-​motion detection, 4-
HDD unformatted, 5-​writing to HDD failed, 6-
video tampering alarm, 7-standard mismatched,
8-invalid login, 9-video exception, 10-recording
exception, 11-scene change, 12-RAID exception,
13-​resolution mismatched, 15-VCA detection,
16- PoE power supply exception, 17-​education
sharing system alarm, 18-two-way audio
request alarm, 23-pulse alarm, 24-face picture
library HDD exception, 25-face picture library
changed, 26-picture of face picture library
changed, 27-POC exception, 28-camera FOV
exception, 30-no SD card, 31-supply voltage
exception
struAlarmTime NET_DVR_TIME_EX Alarm time
uStruAlarm union Alarm information union
struIOAlarm struct Structure about alarm input parameters,
byUnionLen Array of BYTE Union size, which is 128 bytes.
dwAlarmInputNo DWORD Alarm input No.

149
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

dwTrigerAlarmOutNum DWORD The number of triggered alarm outputs. It is
used for calculating the number of all triggered
alarm outputs by pAlarmData in
NET_DVR_ALARMINFO_V40 , each alarm
output is represented by 4 bytes.
dwTrigerRecordChanN DWORD The number of triggered recording channels. It
um is used for calculating the number of all
triggered recording channels by pAlarmData of
NET_DVR_ALARMINFO_V40 , each channel is
represented by 4 bytes.
struAlarmChannel struct Structure about alarm channel parameters
dwAlarmChanNum DWORD The number of alarm channels. It is used for
calculating the number of all alarm channels by
pAlarmData of NET_DVR_ALARMINFO_V40 ,
each alarm channel is represented by 4 bytes.
struAlarmHardDisk struct Structure about alarm HDD parameters
dwAlarmHardDiskNum DWORD The number of alarm HDD. It is used for
calculating the number of all alarm HDDs by
pAlarmData of NET_DVR_ALARMINFO_V40 ,
each alarm HDD is represented by 4 bytes.
struRecordingHost struct Structure about alarm parameters of education
sharing system
bySubAlarmType BYTE Alarm minor type: 1-one-touch post-record
byRes1 Array of BYTE Reserved, set to 0
struRecordEndTime NET_DVR_TIME_EX Recording end time
struVoltageInstable struct Structure about alarm parameters of supply
voltage exception
fVoltageValue float Supply voltage, unit: V, corrects to one decimal
place.
byVoltageAlarmType BYTE Supply voltage exception type: 0-high supply
voltage, 1-low supply voltage
byRes1 Array of BYTE Reserved, set to 0.
byTimeDiffFlag BYTE Whether the time difference parameter is valid:
0-invalid, 1-valid.

150
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

cTimeDifferenceH signed char Time difference between time and UTC time,
unit: hour, the value is between -12 and +14
("+" indicates the east time zone), it is valid
when byISO8601 is "1".
cTimeDifferenceM signed char Time difference between time and UTC time,
unit: minute, the value is -30, +30, or +45 ("+"
indicates the east time zone), it is valid when
byISO8601 is "1".
byRes Array of BYTE Reserved, set to 0.

Remarks
dwAlarmType==0, 23 corresponds to the structure struIOAlarm; dwAlarmType==
2/3/6/9/10/11/13/15/16/28 corresponds to the structure struAlarmChannel; dwAlarmType==
1/4/5 corresponds to the structure struAlarmHardDisk; dwAlarmType== 17 corresponds to the
structure struRecordingHost; dwAlarmType== 31 corresponds to the structure struVoltageInstable;
for other value, the union is not available.

4.18 NET_DVR_ALARMINFO_V30

Structure About Uploaded Alarm Information

Member Data Type Description

dwAlarmType DWORD Alarm types: 0-alarm input alarm of encoder, 1-
second private volume damaged, 2-NVR
disconnected, 3-encoder exception, 4-system
clock exception, 5-the remaining capacity of the
recording volume is too low, 6-​motion detection
alarm of encoder or encoding channel, 7-video
tampering alarm of encoder or encoding
channel, 8-video loss alarm, 9-​real-​time health
monitoring alarm, 10-usage alarm, 11-CVR
exception recovered, 12-recording exception.
dwAlarmInputNumber DWORD Alarm input No., it is valid when alarm type is 0
or 23
byAlarmOutputNumbe Array of BYTE The triggered alarm output No. E.g.
r dwAlarmOutputNumber[0]==1 indicates that
alarm output No.1 is triggered;

151
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

dwAlarmOutputNumber[1]==1 indicates that
alarm output No.2 is triggered.
byAlarmRelateChannel Array of BYTE The triggered recording channel No.: 0-not
triggered, 1-triggered. E.g.
dwAlarmRelateChannel[0]==1 indicates that the
channel No.1 is triggered to record.
byChannel Array of BYTE Alarm channel, it is valid when alarm type is 2,
3, 6, 9, 10 or 11. E.g. dwChannel[0]==1 indicates
that the channel No. is in alarm.
byDiskNumber Array of BYTE Alarm HDD, it is valid when alarm type is 1, 4, or
5. E.g. dwDiskNumber [0]==1 indicates that the
HDD No.1 is abnormal.

Remarks
The time interval to upload the alarm of face picture library changed is 1 hour; for other alarm
type, the alarm information is uploaded in real-time, and the time interval is 1s. Currently, editing
the time interval is not supported.

4.19 NET_DVR_ALARMINFO_V40

Structure About Uploaded Alarm Information

Member Data Type Description

struAlarmFixedHeader NET_DVR_ALRAM_FIX Constant content in alarm information, see
ED_HEADER details in the structure .
pAlarmData DWORD* Variable content in alarm information

Remarks
• The time interval to upload the alarm of face picture library changed is 1 hour; for other alarm
type, the alarm information is uploaded in real-time, and the time interval is 1s. Currently,
editing the time interval is not supported.
• The content of pAlarmData varies with the value of dwAlarmType in the structure
NET_DVR_ALRAM_FIXED_HEADER , see details in the table below:

152
 Device Network SDK (Access Control on Person) Developer Guide

Table 3-1 Relations Between pAlarmData and dwAlarmType

dwAlarmType Description pAlarmData
0, 23 Alarm input alarm, pulse alarm dwTrigerAlarmOutNum*(DWOR
D) Alarm output No.,
+dwTrigerRecordChanNum*(DW
ORD) Channel No.
2, 3, 6, 9, 10, 11, 13, 15, Video loss, motion detection, dwAlarmChanNum*(DWORD)
16, 19 video tampering alarm, video channel No.
exception, recording exception,
scene change, resolution
mismatched, VCA detection, PoE
power supply exception, audio
loss
1, 4, 5 HDD full, HDD uninitialized, dwAlarmHardDiskNum*(DWOR
writing to HDD failed D) HDD No.
7, 8, 12, 17, 18, 24, 25, 26 Standard mismatches, invalid None
login, array exception, education
sharing system alarm, two-way
audio request alarm, face library
HDD exception, face library
changed, picture changed in face
picture library

4.20 NET_DVR_CAPTURE_FACE_CFG
Collected face data structure

Structure Definition
struct{
DWORD dwSize;
DWORD dwFaceTemplate1Size;
char *pFaceTemplate1Buffer;
DWORD dwFaceTemplate2Size;
char *pFaceTemplate2Buffer;
DWORD dwFacePicSize;
char *pFacePicBuffer;
BYTE byFaceQuality1;
BYTE byFaceQuality2;
BYTE byCaptureProgress;
BYTE byFacePicQuality;
DWORD dwInfraredFacePicSize;
char *pInfraredFacePicBuffer;

153
 Device Network SDK (Access Control on Person) Developer Guide

BYTE byInfraredFacePicQuality;
BYTE byRes1[3];
NET_DVR_FACE_FEATURE struFeature;
BYTE byRes[56];
}NET_DVR_CAPTURE_FACE_CFG,*LPNET_DVR_CAPTURE_FACE_CFG;

Members
dwSize
Structure size.
dwFaceTemplate1Size
Size of face data template 1. When its value is 0, it indicates that there is no data template 1.
pFaceTemplate1Buffer
Buffer to save face data template 1, the buffer size should be smaller than or equal to 2.5 KB.
dwFaceTemplate2Size
Size of face data template 2. When its value is 0, it indicates that there is no data template 2.
pFaceTemplate2Buffer
Buffer to save face data template 2, the buffer size should be smaller than or equal to 2.5 KB.
dwFacePicSize
Size of face picture data. When its value is 0, it indicates that there is no face picture data.
pFacePicBuffer
Buffer to save face picture data.
byFaceQuality1
Face picture quality, it is between 1 and 100.
byFaceQuality2
Face picture quality, it is between 1 and 100.
byCaptureProgress
Collection progress: 0-no face data collected, 1-collected. The face information can be parsed
only when the progress value is 100.
byFacePicQuality
Face quality in the face picture.
dwInfraredFacePicSize
Size of infrared face picture data. When its value is 0, it indicates that there is no face picture
data.
pInfraredFacePicBuffer
Buffer to save infrared face picture data.
byInfraredFacePicQuality
Face quality in the infrared face picture.

154
 Device Network SDK (Access Control on Person) Developer Guide

byRes1
Reserved.
struFeature
Feature information in the matted face picture, see details in the structure
NET_DVR_FACE_FEATURE .
byRes
Reserved.

4.21 NET_DVR_CAPTURE_FACE_COND
Condition structure for collecting face data.

Structure Definition
struct{
DWORD dwSize;
BYTE byRes[128];
}NET_DVR_CAPTURE_FACE_COND,*LPNET_DVR_CAPTURE_FACE_COND;

Members
dwSize
Structure size.
byRes
Reserved.

4.22 NET_DVR_CAPTURE_FINGERPRINT_CFG
Fingerprint collection result structure

Structure Definition
struct{
DWORD dwSize;
DWORD dwFingerPrintDataSize;
BYTE byFingerData[MAX_FINGER_PRINT_LEN/*768*/];
DWORD dwFingerPrintPicSize;
char *pFingerPrintPicBuffer;
BYTE byFingerNo;
BYTE byFingerPrintQuality;
BYTE byRes[62];
}NET_DVR_CAPTURE_FINGERPRINT_CFG, *LPNET_DVR_CAPTURE_FINGERPRINT_CFG;

155
 Device Network SDK (Access Control on Person) Developer Guide

Members
dwSize
Structure size.
dwFingerPrintDataSize
Fingerprint data size.
byFingerData
Fingerprint details.
dwFingerPrintPicSize
Fingerprint picture size, 0-no fingerprint picture.
pFingerPrintPicBuffer
Buffer for saving fingerprint picture data.
byFingerNo
Finger No., which is between 1 and 10.
byFingerPrintQuality
Fingerprint quality, which is between 1 and 100.
byRes
Reserved, set to 0.

4.23 NET_DVR_CAPTURE_FINGERPRINT_COND
Fingerprint collection condition structure

Structure Definition
struct{
DWORD dwSize;
BYTE byFingerPrintPicType;
BYTE byFingerNo;
BYTE byRes[126];
}NET_DVR_CAPTURE_FINGERPRINT_COND, *LPNET_DVR_CAPTURE_FINGERPRINT_COND;

Members
dwSize
Structure size.
byFingerPrintPicType
Fingerprint picture type: 0-reserved.
byFingerNo
Finger No., which is between 1 and 10.

156
 Device Network SDK (Access Control on Person) Developer Guide

byRes
Reserved, set to 0.

4.24 NET_DVR_CARD_READER_PLAN
Parameter structure about configuration of authentication mode control schedule.

Structure Definition
struct{
DWORD dwSize;
DWORD dwTemplateNo;
BYTE byRes[64];
}NET_DVR_CARD_READER_PLAN,*LPNET_DVR_CARD_READER_PLAN;

Members
dwSize
Structure size.
dwTemplateNo
Schedule template No.: 0-cancel linking template with schedule, and restore to the default
settings (available for swiping card to open the door); non-0-link template with schedule by No.
byRes
Reserved, set to 0.

4.25 NET_DVR_CETTIFICATE_INFO
Certificate information structure

Structure Definition
struct{
DWORD dwSize;
char szIssuer[MAX_CERTIFICATE_ISSUER_LEN/*64*/];
char szSubject[MAX_CERTIFICATE_SUBJECT_LEN/*64*/];
NET_DVR_TIME struStartTime;
NET_DVR_TIME struEndTime;
BYTE byRes1[1024];
}NET_DVR_CETTIFICATE_INFO, *LPNET_DVR_CETTIFICATE_INFO;

Members
dwSize
Structure size.

157
 Device Network SDK (Access Control on Person) Developer Guide

szIssuer
Certificate issuer.
szSubject
Certificate holder.
struStartTime
Start time of expiry date, refer to the structure NET_DVR_TIME for details.
struEndTime
End time of expiry date, refer to the structure NET_DVR_TIME for details.
byRes1
Reserved.

4.26 NET_DVR_CARD_READER_CFG_V50
Fingerprint and card reader parameters structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byEnable;
BYTE byCardReaderType;
BYTE byOkLedPolarity;
BYTE byErrorLedPolarity;
BYTE byBuzzerPolarity;
BYTE bySwipeInterval;
BYTE byPressTimeout;
BYTE byEnableFailAlarm;
BYTE byMaxReadCardFailNum;
BYTE byEnableTamperCheck;
BYTE byOfflineCheckTime;
BYTE byFingerPrintCheckLevel;
BYTE byUseLocalController;
BYTE byRes1;
WORD wLocalControllerID;
WORD wLocalControllerReaderID;
WORD wCardReaderChannel;
BYTE byFingerPrintImageQuality;
BYTE byFingerPrintContrastTimeOut;
BYTE byFingerPrintRecogizeInterval;
BYTE byFingerPrintMatchFastMode;
BYTE byFingerPrintModuleSensitive;
BYTE byFingerPrintModuleLightCondition;
BYTE byFaceMatchThresholdN;
BYTE byFaceQuality;
BYTE byFaceRecogizeTimeOut;
BYTE byFaceRecogizeInterval;

158
 Device Network SDK (Access Control on Person) Developer Guide

WORD wCardReaderFunction;
BYTE byCardReaderDescription[CARD_READER_DESCRIPTION/*32*/];
WORD wFaceImageSensitometry;
BYTE byLivingBodyDetect;
BYTE byFaceMatchThreshold1;
WORD wBuzzerTime;
BYTE byFaceMatch1SecurityLevel;
BYTE byFaceMatchNSecurityLevel;
BYTE byEnvirMode;
BYTE byLiveDetLevelSet;
BYTE byLiveDetAntiAttackCntLimit;
BYTE byEnableLiveDetAntiAttack;
BYTE bySupportDelFPByID;
BYTE byRes1;
BYTE byFaceContrastMotionDetLevel;
BYTE byDayFaceMatchThresholdN;
BYTE byNightFaceMatchThresholdN;
BYTE byFaceRecogizeEnable;
BYTE byBlackFaceMatchThreshold;
BYTE byRes3[2];
BYTE byDefaultVerifyMode;
DWORD dwFingerPrintCapacity;
DWORD dwFingerPrintNum;
BYTE byEnableFingerPrintNum;
BYTE byRes[231];
}NET_DVR_CARD_READER_CFG_V50,*LPNET_DVR_CARD_READER_CFG_V50;

Members
dwSize
Structure size
byEnable
Whether to enable: 0-no, 1-yes.
byCardReaderType
Fingerprint and card reader types: 1-DS-K110XM/MK/C/CK, 7-Wiegand or RS485 offline, 8-DS-
K1101M/MK, 9-DS-K1101C/CK, 10-DS-K1102M/MK/M-A, 11-DS-K1102C/CK, 12-DS-
K1103M/MK, 13-DS-K1103C/CK, 14-DS-K1104M/MK, 15-DS-K1104C/CK, 16-DS-K1102S/SK/S-A,
19-DS-K1102EM, 20- DS-K1102E, 21-DS-K1200EF, 22-DS-K1200MF, 23-DS-K1200CF, 33-DS-
K1T200EF, 34- DS-K1T300EF
byOkLedPolarity
OK LED polarity: 0-negative pole, 1-positive pole.
byErrorLedPolarity
Error LED polarity: 0-negative pole, 1-positive pole.
byBuzzerPolarity
Buzzer polarity: 0-negative pole, 1-positive pole.

159
 Device Network SDK (Access Control on Person) Developer Guide

bySwipeInterval
Time interval of repeated authentication, which is valid for authentication modes such as
fingerprint, card, face, etc., unit: second.
byPressTimeout
Button pressing timeout, unit: second, which is ranging from 1 to 255.
byEnableFailAlarm
Whether to enable excessive failed authentication attempts alarm: 0-no, 1-yes.
byMaxReadCardFailNum
Maximum number of failed authentication attempts, which is ranging from 1 to 10.
byEnableTamperCheck
Whether to enable tampering detection: 0-no, 1-yes.
byOfflineCheckTime
Offline detection time, unit: second, which is ranging from 0 to 255.
byFingerPrintCheckLevel
Fingerprint recognition level: 1-1/10 error rate, 2-1/100error rate, 3-1/1000error rate,
4-1/10000error rate, 5-1/100000error rate, 6-1/1000000error rate, 7-1/10000000error rate, 8-
1/100000000error rate, 9-3/100error rate, 10-3/1000error rate, 11-3/10000error rate,
12-3/100000error rate, 13-3/1000000error rate, 14-3/10000000error rate,
15-3/100000000error rate, 16-Auto Normal, 17-Auto Secure, 18-Auto More Secure
byUseLocalController
Read-only, whether is it linked with distributed access controller or not? 0-no, 1-yes.
byRes1
Reserved, set to 0.
wLocalControllerID
Read-only, distributed access controller No. It is valid when byUseLocalController is 1, No.0
indicates that the controller is not registered, and the No. is ranging from 1 and 255.
wLocalControllerReaderID
Read-only, fingerprint and card reader No. of distributed access controller. It is valid when
byUseLocalController is 1, No.0 indicates that the controller is not registered.
wCardReaderChannel
Read-only, communication channel No. of fingerprint an card reader: 0-Wiegand or offline, 1-
RS485A, 2-RS485B. It is valid when byUseLocalController is 1.
byFingerPrintImageQuality
Fingerprint picture quality: 0-invalid, 1-low (V1), 2-medium (V1), 3-high (V1), 4-highest (V1), 5-
low (V2), 6-medium (V2), 7-high (V2), 8-highest (V2).
byFingerPrintContrastTimeOut

160
 Device Network SDK (Access Control on Person) Developer Guide

Fingerprint picture comparison timeout: 0-invalid, 1 to 20-1 to 20 second, 0xff-unlimited.

byFingerPrintRecogizeInterval
Fingerprint picture comparison interval: 0-invalid, 1 to 10-1 to 10 second, 0xff-no delay.
byFingerPrintMatchFastMode
Fingerprint matching mode: 0-invalid, 1 to 5-fast mode 1 to fast mode 5, 0xff-auto.
byFingerPrintModuleSensitive
Fingerprint module sensitive: 0-invalid, 1 to 8-sensitive level 1 to level 8.
byFingerPrintModuleLightCondition
Fingerprint module light condition: 0-invalid, 1-outdoor, 2-indoor.
byFaceMatchThresholdN
Face picture comparison threshold. which is ranging from 0 to 100.
byFaceQuality
Face picture quality, which is ranging from 0 to 100.
byFaceRecogizeTimeOut
Face recognition timeout: 1 to 20-1s to 20s, 0xff-unlimited.
byFaceRecogizeInterval
Face recognition interval: 0-invalid, 1 to 10-1s to 10s, 0xff-no delay.
wCardReaderFunction
Read-only, fingerprint and card reader types, which is represented by bit: bit1-fingerprint, bit2-
face, bit3-pulse; bit value: 0-no, 1-yes
byCardReaderDescription
Fingerprint and card reader description.
wFaceImageSensitometry
Read-only, face picture exposure, which is ranging from 0 to 65535.
byLivingBodyDetect
Live face detection: 0-invalid, 1-disable, 2-disable.
byFaceMatchThreshold1
Face picture 1:1 threshold, which is ranging from 0 to 100.
wBuzzerTime
Buzzing time, which is ranging from 0 to 5999s (0-long buzzing).
byFaceMatch1SecurityLevel
Face picture 1:1 security level: 0-invalid, 1-normal, 2-high, 3-higher
byFaceMatchNSecurityLevel
Face picture 1:N security level: 0-Invalid, 1-normal, 2-high, 3-higher
byEnvirMode

161
 Device Network SDK (Access Control on Person) Developer Guide

Face recognition environment mode: 0-invalid, 1-indoor, 2-other

byLiveDetLevelSet
Set threshold level of live face detection: 0-invalid, 1-low, 2-medium, 3-high
byLiveDetAntiAttackCntLimit
Anti-attacking times of live face detection: 0-invalid, ranging from 1 to 255.
byEnableLiveDetAntiAttack
Whether to enable the anti-attacking of live dace detection: 0-invalid, 1-no, 1-yes.
bySupportDelFPByID
Read-only, whether the fingerprint and card reader supports deleting fingerprint by finger ID: 0-
invalid, 1-no, 2-yes.
byRes1
Reserved.
byFaceContrastMotionDetLevel
Motion detection level during face picture comparison: 0-invalid, 1-low, 2-medium, 3-high.
byDayFaceMatchThresholdN
1:N face picture comparison threshold in day, which is between 0 and 100.
byNightFaceMatchThresholdN
1:N face picture comparison threshold at night, which is between 0 and 100.
byFaceRecogizeEnable
Whether to enable facial recognition: 0-invalid, 1-yes (one face), 2-no, 3-yes (multiple faces).
byBlackFaceMatchThreshold
Face picture comparison threshold in blacklist, which is between 0 and 100.
byRes3
Reserved.
byDefaultVerifyMode
Default authentication mode of the fingerprint and card reader (factory settings), read-only: 1-
sleepy, 2-card+password, 3-card, 4-card or password, 5-fingerprint, 6-fingerprint+password, 7-
fingerprint or card, 8-fingerprint+card, 9-fingerprint+card+password, 10-face or fingerprint or
card or password, 11-face+fingerprint, 12-face+password, 13-face+card, 14-face, 15-employee
No.+password, 16-fingerprint or password, 17-employee No.+fingerprint, 18-employee No.
+fingerprint+password, 19-face+fingerprint+card, 20-face+password+fingerprint, 21-employee
No.+face, 22-face or face+card, 23-fingerprint or face, 24-card or face or password, 25-card or
face, 26-card or face or fingerprint, 27-card or fingerprint or password.
dwFingerPrintCapacity
Read-only, fingerprint capability, it is valid only when byEnableFingerPrintNum is 1.
dwFingerPrintNum

162
 Device Network SDK (Access Control on Person) Developer Guide

Read-only, number of existing fingerprint pictures, it is valid only when

byEnableFingerPrintNum is 1.
byEnableFingerPrintNum
Read-only, whether to enable fingerprint capability: 0-no, 1-yes.
byRes
Reserved, set to 0.

4.27 NET_DVR_DATE
Date information structure.

Structure Definition
struct{
WORD wYear;
BYTE byMonth;
BYTE byDay;
}NET_DVR_DATE,*LPNET_DVR_DATE;

Members
wYear
Year
byMonth
Month
byDay
Day

4.28 NET_DVR_DEL_FINGER_PRINT_MODE_V50
Parameter union of fingerprint information deleting mode.

Structure Union Definition

union{
BYTE uLen[588];
NET_DVR_FINGER_PRINT_BYCARD_V50 struByCard;
NET_DVR_FINGER_PRINT_BYREADER_V50 struByReader;
}NET_DVR_DEL_FINGER_PRINT_MODE_V50,*LPNET_DVR_DEL_FINGER_PRINT_MODE_V50;

Members
uLen

163
 Device Network SDK (Access Control on Person) Developer Guide

Union size.
struByCard
Parameter of deleting fingerprint information by card No. (person ID), see details in the
structure NET_DVR_FINGER_PRINT_BYCARD_V50 .
struByReader
Parameters of deleting fingerprint information by fingerprint and card reader No., see details in
the structure NET_DVR_FINGER_PRINT_BYREADER_V50 .

See Also
NET_DVR_FINGER_PRINT_INFO_CTRL_V50

4.29 NET_DVR_DEVICEINFO_V30
Device parameter structure (V30).

Device Parameter Structure (V30)

Member Data Type Description

sSerialNumber BYTE Device serial No.
byAlarmInPortNum BYTE Number of analog alarm inputs
byAlarmOutPortNum BYTE Number of analog alarm outputs
byDiskNum BYTE Number of HDDs
byDVRType BYTE Device type
byChanNum BYTE Number of analog channels
byStartChan BYTE Start No. of analog channel, which starts from
1.
byAudioChanNum BYTE Number of two-way audio channels
byIPChanNum BYTE Number of digital channels, low 8-bit.
byZeroChanNum BYTE Number of channel-zero
byMainProto BYTE Transmission protocol type of main stream: 0-
Hikvision Private Protocol (default), 1-RTSP, 2-
Hikvision Private Protocol+RTSP
bySubProto BYTE Transmission protocol type of sub-stream: 0-
Hikvision Private Protocol (default), 1-RTSP, 2-
Hikvision Private Protocol+RTSP

164
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

bySupport BYTE Capabilities, if the result of bitwise operation is
0, it refers that the capability is not supported,
if the result is 1, it indicates that the capability
is supported.
• bySupport&0x1: whether supports VCA
search.
• bySupport&0x2: whether supports backup.
• bySupport&0x4: whether supports getting
encoding parameters.
• bySupport&0x8: whether supports dual-NIC.
• bySupport&0x10: whether supports remote
SADP.
• bySupport&0x20: whether supports RAID
card.
• bySupport&0x40: whether supports
searching in IPSAN directory.
• bySupport&0x80: whether supports RTP over
RTSP.
bySupport1 BYTE Extended capabilities, if the result of bitwise
operation is 0, it refers that the capability is not
supported, if the result is 1, it indicates that the
capability is supported.
• bySupport1&0x1: whether supports SNMP
with version 30.
• bySupport1&0x2: whether supports playback
and downloading video files.
• bySupport1&0x4: whether supports setting
the arming priority.
• bySupport1&0x8: whether supports
extending the arming time period.
• bySupport1&0x10: whether supports
multiple HDDs (more than 33).
• bySupport1&0x20: whether supports RTP
over RTSP.
• bySupport1&0x80: whether supports license
plate recognition alarm.
bySupport2 BYTE Extended capabilities, if the result of bitwise
operation is 0, it refers that the capability is not
supported, if the result is 1, it indicates that the
capability is supported.

165
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

• bySupport2&0x1: whether supports getting
stream via URL.
• bySupport2&0x2: whether supports FTP with
version 40.
• bySupport2&0x4: whether supports ANR.
• bySupport2&0x20: whether supports getting
device status.
• bySupport2&0x40: whether supports
encrypting stream.
wDevType WORD Device model
bySupport3 BYTE Extended capabilities, if the result of bitwise
operation is 0, it refers that the capability is not
supported, while, if the result is 1, it indicates
that the capability is supported.
• bySupport3&0x1: whether supports multi-
stream.
• bySupport3&0x4: whether supports
configuring by group (e.g., image, alarm
input, alarm output, user, device status, JPEG
picture capture, continuous and scheduled
capture, .HDD group management, and so
on).
• bySupport3&0x20: whether supports getting
stream via DDNS.
byMultiStreamProto BYTE Whether supports multi-​stream, if the result of
bitwise operation is 0, it refers to not support, if
the result is 1, it refers to support.
• byMultiStreamProto&0x1: whether supports
third-stream.
• byMultiStreamProto&0x2: whether supports
fourth-stream.
• byMultiStreamProto&0x40: whether
supports main stream.
• byMultiStreamProto&0x80: whether
supports sub-stream.
byStartDChan BYTE Start No. of digital channel, 0-no digital channel
(e.g., DVR, network camera).

166
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

byStartDTalkChan BYTE Start No. of two-way audio channel, 0-no two-
way audio channel.
byHighDChanNum BYTE Number of digital channels, high 8-bit.
bySupport4 BYTE Extended capabilities, if the result of bitwise
operation is 0, it refers that the capability is not
supported, if the result is 1, it indicates that the
capability is supported.
• bySupport4&0x01: whether all stream types
support RTSP and Hikvision Private Protocol.
• bySupport4&0x10: whether supports loading
network disk by domain name.
byLanguageType BYTE Supported language types, if the result of
bitwise operation is 0, it refers to not support, if
the result is 1, it refers to support.
• byLanguageType ==0: this field is not
supported by device.
• byLanguageType&0x1: whether supports
Chinese.
• byLanguageType&0x2: whether supports
English.
byVoiceInChanNum BYTE Number of audio input channels
byStartVoiceInChanNo BYTE Start No. of audio input channel, 0-invalid.
byRes3 Array of BYTE Reserved, set to 0.
byMirrorChanNum BYTE Number of mirror channels
wStartMirrorChanNo WORD Start No. of mirror channel
byRes2 Array of BYTE Reserved, set to 0.

Remarks
• The maximum number of digital channels equal to byIPChanNum+byHighDChanNum*256.
• For login via ISAPI Protocol, the following parameters are not supported: byMainProto,
bySubProto, bySupport, bySupport1, bySupport2, bySupport3, bySupport4, bySupport5,
bySupport6, bySupport7, byMultiStreamProto, byStartDTalkChan, byVoiceInChanNum,
byStartVoiceInChanNo, byMirrorChanNum, and wStartMirrorChanNo.

See Also
NET_DVR_DEVICEINFO_V40

167
 Device Network SDK (Access Control on Person) Developer Guide

4.30 NET_DVR_DEVICEINFO_V40

Device Parameter Structure (V40)

Member Data Type Description

struDeviceV30 NET_DVR_DEVICEINFO Device parameters
_V30
bySupportLock BYTE Whether supports locking function: 1-support.
byRetryLoginTime BYTE Remaining login attempts, it is valid when the
user name or password is incorrect and the
bySupportLock is 1.
byPasswordLevel BYTE Password strength: 0-invalid, 1-default
password, 2-valid password, 3-risky password.
For default password or risky password, the
users are reminded to change password.
byProxyType BYTE Proxy type: 0-no proxy, 1-standard proxy, 2-
EHome proxy.
dwSurplusLockTime DWORD Remaining locking time, unit: second. It is valid
only when bySupportLock is 1. During the
locing time, if the user try to log in to again, the
remaining locking time will resume to 30
minutes.
byCharEncodeType BYTE Character encodings. 0-no decoding
information, 1-GB2312 (Simplified Chinese), 2-
GBK, 3-BIG5 (Traditional Chinese), 4-Shift_​JIS
(Japanese), 5-EUC-KR (Korean), 6-UTF-8, 7-
ISO8859-1, 8-ISO8859-2, 9-ISO8859-3, …, 21-
ISO8859-15 (Western European)
bySupportDev5 BYTE Whether to support getting the parameters of
devices that support HCNetSDK version 5.0 or
above, the size of device name and type name
are extended to 64 bytes.
bySupport BYTE Whether it supports uploading changes, it
depends on the result of bitwise AND (&)
operation: 0-not support, 1-support. The result
of bySupport&0x1 indicates that this member is
reserved; the result of bySupport&0x2 indicates
that whether it supports uploading changes: 0-

168
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

not support, 1-support. This member is the
capability set extension.
byLoginMode BYTE Login mode: 0-login via Hikvision Private
Protocol, 1-login via ISAPI Protocol. For
Hikvision Private Protocol, the default login port
number is 8000, and for ISAPI Protocol, the
default login port number is 80 or 443.
dwOEMCode DWORD OEM code.
iResidualValidity int Remaining valid days of the user's password,
unit: day. If the negative number is returned, it
indicates that the password being used has
expired. For example, if -3 is returned, it
indicates that the password being used has
expired for three days.
byResidualValidity BYTE Whether the member iResidualValidity is valid:
0-invalid, 1-valid.
bySingleStartDTalkCha BYTE Start channel No. for connecting independent
n audio tracks to the device. The value 0 is
reserved and invalid. The channel No. of audio
tracks cannot start from 0.
bySingleDTalkChanNu BYTE Total number of channels of the device
ms connected with independent tracks, 0-not
support.
byPassWordResetLevel BYTE Whether to prompt the non-admin user to
change the password: 0 (invalid), 1 (If the
administrator created a non-admin user and set
an initial password for the user, the non-admin
user should be prompted "Please change the
initial password" after logging in to the device.
If the user does not change the initial password,
the user will be prompted each time he/she
logs in.), 2 (If the non-admin user's password
has been changed by the administrator, the
non-admin user should be prompted "Please
set a new password" after logging in to the
device. If the non-admin user does not change
the password, the user will be prompted each
time he/she logs in.).

169
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

bySupportStreamEncry BYTE Reserved, set to 0.
pt
byRes2 Array of BYTE • Four character types are allowed in the
password, including digits, lowercase letters,
uppercase letters and symbols. The maximum
password length is 16 bits, and there are four
password strength levels, see details below:
• Level 0 (Risky Password): The password
length is less than 8 bits, or only contains
one kind of the character types. Or the
password is the same with the user name,
or is the mirror writing of the user name.
• Level 1 (Weak Password): The password
length is more than or equal to 8 bits, and
contains two kinds of the character types.
Meanwhile, the combination should be
(digits + lowercase letters) or (digits +
uppercase letters).
• Level 2 (Medium Password): The password
length is more than or equal to 8 bits, and
contains two kinds of the character types.
Meanwhile, the combination cannot be
(digits + lowercase letters) and (digits +
uppercase letters).
• Level 3 (Strong Password): The password
length is more than or equal to 8 bits, and
at least contains three kinds of the
character types.
• For login via ISAPI Protocol, the following
parameters are not supported:
bySupportLock, byRetryLoginTime,
byPasswordLevel, byProxyType,
dwSurplusLockTime, byCharEncodeType,
and bySupportDev5.

4.31 NET_DVR_DOOR_FILE_UPLOAD_PARAM
Structure about the parameters of the access control file to be uploaded.

170
 Device Network SDK (Access Control on Person) Developer Guide

Structure Definition
struct{
DWORD dwSize;
DWORD dwFileSize;
BYTE byFileName[MAX_FILE_NAME_LEN/*100*/];
BYTE byRes1[256];
}NET_DVR_DOOR_FILE_UPLOAD_PARAM, *LPNET_DVR_DOOR_FILE_UPLOAD_PARAM;

Members
dwSize
Structure size.
dwFileSize
File size.
byFileName
File name.
byRes1
Reserved.

4.32 NET_DVR_DOOR_STATUS_PLAN
Parameter structure about door control schedule configuration.

Structure Definition
struct{
DWORD dwSize;
DWORD dwTemplateNo;
BYTE byRes[64];
}NET_DVR_DOOR_STATUS_PLAN,*LPNET_DVR_DOOR_STATUS_PLAN;

Members
dwSize
Structure size.
dwTemplateNo
Schedule template No.: 0-cancel linking the configured template with schedule, and restore to
the default settings; non-0-link the configured template with schedule.
byRes
Reserved, set to 0.

171
 Device Network SDK (Access Control on Person) Developer Guide

4.33 NET_DVR_ETHERNET_V30

Ethernet Configuration Structure

Member Data Type Description

struDVRIP NET_DVR_IPADDR Device IP address
struDVRIPMask NET_DVR_IPADDR Mask of device IP address
dwNetInterface DWORD Network interface type: 1-10MBase-T;
2-10MBase-T (full duplex); 3-100MBase-TX;
4-100M (full duplex); 5-10M/100M/1000M
(self-adaptive); 6-1000M (full duplex)
wDVRPort WORD Device port No.
wMTU WORD MTU settings, the default is 1500.
byMACAddr Array of BYTE Device physical address.
byEthernetPortNo BYTE Network interface No.: 0-invalid, 1-interface 0,
2-interface 1, and so on. This parameter is read-
only.
byRes Array of BYTE Reserved.

4.34 NET_DVR_EVENT_CARD_LINKAGE_CFG_V51
Parameter structure about event and card linkage configuration.

Structure Definition
struct{
DWORD dwSize;
BYTE byProMode;
BYTE byRes1[3];
DWORD dwEventSourceID;
NET_DVR_EVENT_CARD_LINKAGE_UNION uLinkageInfo;
BYTE byAlarmout[MAX_ALARMHOST_ALARMOUT_NUM/*512*/];
BYTE byRes2[32];
BYTE byOpenDoor[MAX_DOOR_NUM/*256*/];
BYTE byCloseDoor[MAX_DOOR_NUM/*256*/];
BYTE byNormalOpen[MAX_DOOR_NUM/*256*/];
BYTE byNormalClose[MAX_DOOR_NUM/*256*/];
BYTE byMainDevBuzzer;
BYTE byCapturePic;
BYTE byRecordVideo;
BYTE byMainDevStopBuzzer;

172
 Device Network SDK (Access Control on Person) Developer Guide

WORD wAudioDisplayID;
BYTE byAudioDisplayMode;
BYTE byRes3[25];
BYTE byReaderBuzzer[MAX_CARD_READER_NUM/*512*/];
BYTE byAlarmOutClose[MAX_ALARMHOST_ALARMOUT_NUM/*512*/];
BYTE byAlarmInSetup[MAX_ALARMHOST_ALARMOUT_NUM/*512*/];
BYTE byAlarmInClose[MAX_ALARMHOST_ALARMOUT_NUM/*512*/];
BYTE byReaderStopBuzzer[MAX_CARD_READER_NUM/*64*/];
BYTE byRes[512];
}NET_DVR_EVENT_CARD_LINKAGE_CFG_V51, *LPNET_DVR_EVENT_CARD_LINKAGE_CFG_V51;

Members
dwSize
Structure size.
byProMode
Linkage type: 0-event linkage, 1-card No. linkage, 2-MAC address linkage, 3- employee No.
(person ID) linkage.
byRes1
Reserved, set to 0.
dwEventSourceID
Event triggering source ID: 0xffffffff-all. For device events, this parameter is invalid; for door
events, it refers to door No.; for card reader events, it refers to card reader ID; for alarm input
events, it refers to zone or event alarm input ID.
uLinkageInfo
Linkage action parameter, see NET_DVR_EVETN_CARD_LINKAGE_UNION for details.
byAlarmout
Linked alarm output No., which is represented by byte. 0-not link, 1-link.
byRes2
Reserved, set to 0.
byOpenDoor
Whether to enable door opening linkage, which is represented by byte. 0-disable, 1-enable.
byCloseDoor
Whether to enable door closing linkage, which is represented by byte. 0-disable, 1-enable.
byNormalOpen
Whether to enable door remaining open linkage, which is represented by byte. 0-disable, 1-
enable.
byNormalClose
Whether to enable door remaining closed linkage, which is represented by byte. 0-disable, 1-
enable.

173
 Device Network SDK (Access Control on Person) Developer Guide

byMainDevBuzzer
Whether to enable access controller buzzing, 0-disable, 1-enable.
byCapturePic
Whether to enable capture linkage, 0-disable, 1-enable.
byRecordVideo
Whether to enable recording linkage, 0-disable, 1-enable.
byMainDevStopBuzzer
Whether to enable access controller stopping buzzing linkage, 0-disable, 1-enable.
wAudioDisplayID
Linked audio prompt ID, currently it is between 1 and 32, and 0 indicates no linkage.
byAudioDisplayMode
Linked audio prompt mode: 0-disable, 1-play once, 2-loop playing.
byRes3
Reserved.
byReaderBuzzer
Whether to enable buzzer linkage, which is represented by byte. 0-disable, 1-enable.
byAlarmOutClose
Whether to enable alarm output disabling linkage, which is represented by byte. 0-disable, 1-
enable.
byAlarmInSetup
Whether to enable zone arming linkage, which is represented by byte. 0-disable, 1-enable.
byAlarmInClose
Whether to enable zone disarming linkage, which is represented by byte. 0-disable, 1-enable.
byReaderStopBuzzer
Whether to enable card reader stopping buzzing linkage, which is represented by byte. 0-
disable, 1-enable.
byRes
Reserved, set to 0.

4.35 NET_DVR_EVENT_CARD_LINKAGE_COND
Condition structure about the event card linkage configuration.

Structure Definition
struct{
DWORD dwSize;

174
 Device Network SDK (Access Control on Person) Developer Guide

DWORD dwEventID;
WORD wLocalControllerID;
BYTE byRes[106];
}NET_DVR_EVENT_CARD_LINKAGE_COND,*LPNET_DVR_EVENT_CARD_LINKAGE_COND;

Members
dwSize
Structure size.
dwEventID
Event ID.
wLocalControllerID
Distributed access controller No. which is between 1 and 64, while, 0-access controller.
byRes
Reserved, set to 0.

4.36 NET_DVR_EVENT_LINKAGE_INFO
Event linkage parameter structure.

Structure Definition
struct{
WORD wMainEventType;
WORD wSubEventType;
BYTE byRes[28];
}NET_DVR_EVENT_LINKAGE_INFO,*LPNET_DVR_EVENT_LINKAGE_INFO;

Members
wMainEventType
Event major types, see Access Control Event Types for details.
wSubEventType
Event minor types, see Access Control Event Types for details.
byRes
Reserved, set to 0.

See Also
NET_DVR_EVETN_CARD_LINKAGE_UNION

175
 Device Network SDK (Access Control on Person) Developer Guide

4.37 NET_DVR_EVETN_CARD_LINKAGE_UNION
Parameter union about event and card linkage configuration.

Structure Definition
union{
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
NET_DVR_EVENT_LINKAGE_INFO struEventLinkage;
BYTE byMACAddr[MACADDR_LEN/*6*/];
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
}NET_DVR_EVETN_CARD_LINKAGE_UNION,*LPNET_DVR_EVETN_CARD_LINKAGE_UNION;

Members
byCardNo
Card No.
struEventLinkage
Event linkage parameters, see details in the structure NET_DVR_EVENT_LINKAGE_INFO .
byMACAddr
Physical MAC address.
byEmployeeNo
Employee No. (person ID)

See Also
NET_DVR_EVENT_CARD_LINKAGE_CFG_V51

4.38 NET_DVR_FACE_FEATURE
Structure about facial feature parameters.

Structure Definition
struct{
NET_VCA_RECT struFace;
NET_VCA_POINT struLeftEye;
NET_VCA_POINT struRightEye;
NET_VCA_POINT struLeftMouth;
NET_VCA_POINT struRightMouth;
NET_VCA_POINT struNoseTip;
}NET_DVR_FACE_FEATURE, *LPNET_DVR_FACE_FEATURE;

176
 Device Network SDK (Access Control on Person) Developer Guide

Members
struFace
Face sub-picture area, see details in the structure NET_VCA_RECT .
struLeftEye
Coordinates of the left eye, see details in the structure NET_VCA_POINT .
struRightEye
Coordinates of the right eye, see details in the structure NET_VCA_POINT .
struLeftMouth
Coordinates of the left mouth corner, see details in the structure NET_VCA_POINT .
struRightMouth
Coordinates of the right mouth corner, see details in the structure NET_VCA_POINT .
struNoseTip
Coordinates of the nose, see details in the structure NET_VCA_POINT .

4.39 NET_DVR_FAILED_FACE_COND
Condition structure of getting face picture information, of which modeling failed

Structure Definition
struct{
DWORD dwSize;
BYTE byRes[128];
}NET_DVR_FAILED_FACE_COND, *LPNET_DVR_FAILED_FACE_COND;

Members
dwSize
Structure size.
byRes
Reserved, set to 0

4.40 NET_DVR_FAILED_FACE_INFO
Structure of modeling failure information parameters

Structure Definition
struct{
DWORD dwSize;

177
 Device Network SDK (Access Control on Person) Developer Guide

BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byErrorCode;
BYTE byRes1[3];
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byRes[92];
}NET_DVR_FAILED_FACE_INFO, *LPNET_DVR_FAILED_FACE_INFO;

Members
dwSize
Structure size.
byCardNo
No. of the card linked to the face.
byErrorCode
Failure error code: 0-Invalid, 1-reading picture file failed, 2-opening picture file failed, 3-no
enough memory, 4-face modeling failed, 5-the pupillary distance is too small (less than 60), 6-
the card has no permission.
byRes1
Reserved.
byEmployeeNo
Employee No. (person ID)
byRes
Reserved, set to 0.

4.41 NET_DVR_FINGER_PRINT_BYCARD_V50
Parameter structure of deleting fingerprint information by card No. (person ID).

Structure Definition
struct{
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byEnableCardReader[MAX_CARD_READER_NUM/*512*/];
BYTE byFingerPrintID[MAX_FINGER_PRINT_NUM/*10*/];
BYTE byRes1[2];
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
}NET_DVR_FINGER_PRINT_BYCARD_V50,*LPNET_DVR_FINGER_PRINT_BYCARD_V50;

Members
byCardNo
No. of card linked with the fingerprint information.
byEnableCardReader

178
 Device Network SDK (Access Control on Person) Developer Guide

Fingerprint and card reader IDs, which are represented by array, and each member of array
refers to one reader ID, value: 0-not delete, 1-delete.
byFingerPrintID
Finger IDs, which are represented by array, and each member of the array refers to one
fingerprint ID, value: 0-not delete, 1-delete.
byRes1
Reserved.
byEmployeeNo
Employee ID (person ID).

See Also
NET_DVR_DEL_FINGER_PRINT_MODE_V50

4.42 NET_DVR_FINGER_PRINT_BYREADER_V50
Parameter structure of deleting fingerprint information by fingerprint and card reader No.

Structure Definition
struct{
DWORD dwCardReaderNo;
BYTE byClearAllCard;
BYTE byRes1[3];
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byRes[516];
}NET_DVR_FINGER_PRINT_BYREADER_V50,*LPNET_DVR_FINGER_PRINT_BYREADER_V50;

Members
dwCardReaderNo
Fingerprint and card reader No.
byClearAllCard
Whether to delete the fingerprint information of all cards: 0-no, delete by card No. (person ID);
1-yes.
byRes1
Reserved.
byCardNo
No. of card linked with the fingerprint information
byEmployeeNo
Employee ID (person ID)

179
 Device Network SDK (Access Control on Person) Developer Guide

byRes
Reserved.

See Also
NET_DVR_DEL_FINGER_PRINT_MODE_V50

4.43 NET_DVR_FINGER_PRINT_CFG_V50
Fingerprint configuration structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
DWORD dwFingerPrintLen;
BYTE byEnableCardReader[MAX_CARD_READER_NUM/*512*/];
BYTE byFingerPrintID;
BYTE byFingerType;
BYTE byRes1[30];
BYTE byFingerData[MAX_FINGER_PRINT_LEN/*768*/];
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byLeaderFP[MAX_DOOR_NUM_256/*256*/]
BYTE byRes[128];
}NET_DVR_FINGER_PRINT_CFG, *LPNET_DVR_FINGER_PRINT_CFG;

Members
dwSize
Structure size.
byCardNo
Card No., which is linked with the fingerprint.
dwFingerPrintLen
Size of fingerprint data. The fingerprint module and fingerprint recorder will be used in pair.
byEnableCardReader
Whether to apply fingerprint data to the fingerprint module, which is represented by array: 0-no
1-yes
byFingerPrintID
Finger No., which is between 1 and 10
byFingerType
Fingerprint type: 0-normal fingerprint, 1-duress fingerprint, 2-patrol fingerprint, 3-super
fingerprint, 4-dismiss fingerprint

180
 Device Network SDK (Access Control on Person) Developer Guide

byRes1
Reserved, set to 0
byFingerData
Fingerprint data
byEmployeeNo
Employee No. (person ID)
byLeaderFP
Whether to support first time authentication function (door, represented by byte): 0-no, 1-yes.
byRes
Reserved, set to 0

4.44 NET_DVR_FINGER_PRINT_INFO_COND_V50
Fingerprint parameter configuration structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byEnableCardReader[MAX_CARD_READER_NUM/*512*/];
DWORD dwFingerPrintNum;
BYTE byFingerPrintID;
BYTE byCallbackMode;
BYTE byRes2[2];
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byRes1[128];
}NET_DVR_FINGER_PRINT_INFO_COND_V50, *LPNET_DVR_FINGER_PRINT_INFO_COND_V50;

Members
dwSize
Structure size.
byCardNo
Card No. linked with the fingerprint. This parameter is invalid when setting fingerprint
parameters.
byEnableCardReader
Fingerprint module status: 0-invalid; 1-valid.
dwFingerPrintNum
Number of obtained or configured fingerprints, 0xffffffff-get all fingerprints' information.
byFingerPrintID

181
 Device Network SDK (Access Control on Person) Developer Guide

Finger No., which is between 1 and 10, 0xff indicates-all fingerprints of the card.
byCallbackMode
Device callback mode: 0-returned when applied all; 1-returned when applied a part.
byRes2
Reserved, set to 0.
byEmployeeNo
Employee No. (person ID).
byRes1
Reserved, set to 0.

Remarks
Two fingerprint applying modes are available: blocking mode and non-blocking mode.
• Blocking Mode: Set byCallbackMode to "0", and the applying status will be returned for once
only after applying each fingerprint.
• Non-blocking Mode: Set byCallbackMode to "1", and the applying status will be returned for
multiple times after applying each fingerprint. And the next fingerprint can be applied until the
previous fingerprint information is applied.

4.45 NET_DVR_FINGER_PRINT_INFO_CTRL_V50
Condition structure for deleting fingerprint information.

Structure Definition
struct{
DWORD dwSize;
BYTE byMode;
BYTE byRes1[3];
NET_DVR_DEL_FINGER_PRINT_MODE_V50 struProcessMode;
BYTE byRes[64];
}NET_DVR_FINGER_PRINT_INFO_CTRL_V50,*LPNET_DVR_FINGER_PRINT_INFO_CTRL_V50;

Members
dwSize
Structure size.
byMode
Deleting mode: 0-by card No. (person ID), 1-by fingerprint and card reader No.
byRes1
Reserved.
struProcessMode

182
 Device Network SDK (Access Control on Person) Developer Guide

Deleting mode parameters, refer to the data union NET_DVR_DEL_FINGER_PRINT_MODE_V50

for details.
byRes
Reserved.

4.46 NET_DVR_FINGER_PRINT_STATUS_V50
Fingerprint information applying or deleting status structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byCardNo[ACS_CARD_NO_LEN/*32*/];
BYTE byCardReaderRecvStatus[MAX_CARD_READER_NUM_512/*512*/];
BYTE byFingerPrintID;
BYTE byFingerType;
BYTE byTotalStatus;
BYTE byRecvStatus;
BYTE byErrorMsg[ERROR_MSG_LEN/*32*/];
DWORD dwCardReaderNo;
BYTE byEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byErrorEmployeeNo[NET_SDK_EMPLOYEE_NO_LEN/*32*/];
BYTE byRes[128];
}NET_DVR_FINGER_PRINT_STATUS_V50,*LPNET_DVR_FINGER_PRINT_STATUS_V50;

Members
dwSize
Structure size.
byCardNo
Card No. which is linked with the fingerprint.
byCardReaderRecvStatus
Fingerprint module status, which is represented by byte: 0-failed, 1-completed, 2-the fingerprint
module is offline, 3-try again or poor fingerprint quality, 4-memory is full, 5-the fingerprint
already exists, 6-the fingerprint ID already exists, 7-invalid fingerprint ID, 8-the fingerprint
module does not need to be configured, 10-the fingerprint module version is too old to support
the employee No.
byFingerPrintID
Finger No. which is between 1 and 10.
byFingerType
Fingerprint type: 0-normal fingerprint, 1-duress fingerprint, 2-patrol fingerprint, 3-super
fingerprint, 4-dismiss fingerprint.

183
 Device Network SDK (Access Control on Person) Developer Guide

byTotalStatus
Applying status: 0-applying, 1-applied to all (it does not mean that all the applying succeeded).
byRecvStatus
Device error status: 0-succeeded, 1-invalid finger No., 2-invalid fingerprint type, 3-invalid card
No. (the card No. does not meet the device requirements), 4-the fingerprint is not linked to
employee No. or card No. (the employee No. or the card No. is NULL), 5-the employee No. does
not exist, 6-the fingerprint data length is 0, 7-invalid card reader No., 8-invalid employee No., 9-
illegal first time authentication value, 10-other parameters error.
byErrorMsg
Apply error message. When byCardReaderRecvStatus is 5, it indicates that the card No. linked
to the fingerprint already exists.
dwCardReaderNo
When byCardReaderRecvStatus is 5, it indicates that the fingerprint module corresponding to
the fingerprint already exists. This member can be used to return applying error, and 0 refers to
no error message.
byEmployeeNo
Employee No. (person ID)
byErrorEmployeeNo
Apply error message. When byCardReaderRecvStatus is 5, it indicates that the employee No.
(person ID) linked to the fingerprint already exists.
byRes
Reserved.

Related API
NET_DVR_StartRemoteConfig

4.47 NET_DVR_GROUP_CFG
Group configuration structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byEnable;
BYTE byRes1[3];

NET_DVR_VALID_PERIOD_CFG
struValidPeriodCfg;
BYTE byGroupName[GROUP_NAME_LEN/*32*/];

184
 Device Network SDK (Access Control on Person) Developer Guide

BYTE byRes2[32];
}NET_DVR_GROUP_CFG,*LPNET_DVR_GROUP_CFG;

Members
dwSize
Structure size
byEnable
Whether to enable the group: 0-no, 1-yes.
byRes1
Reserved, set to 0.
struValidPeriodCfg
Group expiry date.
byGroupName
Group name
byRes2
Reserved, set to 0.

4.48 NET_DVR_GROUP_COMBINATION_INFO_V50
Group parameters structure.

Structure Definition
struct{
BYTE byEnable;
BYTE byMemberNum;
BYTE bySequenceNo;
BYTE byRes;
DWORD dwGroupNo;
}NET_DVR_MULTI_CARD_CFG_V50,*LPNET_DVR_MULTI_CARD_CFG_V50;

Members
byEnable
Whether to enable the group: 0-no, 1-yes
byMemberNum
Number of cards should be swiped in the group.
bySequenceNo
Card swiping order in the group.
byRes

185
 Device Network SDK (Access Control on Person) Developer Guide

Reserved, set to 0.
dwGroupNo
Group No., 0xffffffff-remotely open door, 0xfffffffe-open door by super password.

See Also
NET_DVR_MULTI_CARD_GROUP_CFG_V50

4.49 NET_DVR_HOLIDAY_GROUP_CFG
Holiday group configuration structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byEnable;
BYTE byRes1[3];
BYTE byGroupName[HOLIDAY_GROUP_NAME_LEN/*32*/];
DWORD dwHolidayPlanNo[MAX_HOLIDAY_PLAN_NUM/*16*/];
BYTE byRes2[32];
}NET_DVR_HOLIDAY_GROUP_CFG,*LPNET_DVR_HOLIDAY_GROUP_CFG;

Members
dwSize
Structure size.
byEnable
Whether to enable: 1-enable, 0-disable.
byRes1
Reserved, set to 0.
byGroupName
Holiday group name.
dwHolidayPlanNo
Holiday schedule No.: 0-invalid.
byRes2
Reserved, set to 0.

4.50 NET_DVR_HOLIDAY_PLAN_CFG
Holiday schedule configuration structure.

186
 Device Network SDK (Access Control on Person) Developer Guide

Structure Definition
struct{
DWORD dwSize;
BYTE byEnable;
BYTE byRes1[3];

NET_DVR_DATE
struBeginDate;

NET_DVR_DATE
struEndDate;

NET_DVR_SINGLE_PLAN_SEGMENT
struPlanCfg[MAX_DAYS][MAX_TIMESEGMENT_V30];
BYTE byRes2[16];
}NET_DVR_HOLIDAY_PLAN_CFG,*LPNET_DVR_HOLIDAY_PLAN_CFG;

Members
dwSize
Structure size.
byEnable
Enable? 0- No; 1- Yes
byRes1
Reserved, set to 0.
struBeginDate
Holiday start time, see NET_DVR_DATE for details.
struEndDate
Holiday end time, see NET_DVR_DATE for details.
struPlanCfg
Holiday schedule parameters, up to 7 days can be set in one week, and up to 8 time periods can
be set in one day, see NET_DVR_SINGLE_PLAN_SEGMENT for details.
byRes2
Reserved, set to 0.

4.51 NET_DVR_INIT_CFG_ABILITY

187
 Device Network SDK (Access Control on Person) Developer Guide

Initialization Capability Structure

Member Data Type Description

enumMaxLoginUsersN INIT_CFG_MAX_NUM Maximum number of users can log in, see
um details below:
enum _INIT_CFG_MAX_NUM_{
INIT_CFG_NUM_2048 = 2048,
INIT_CFG_NUM_5120 = 5120,
INIT_CFG_NUM_10240 = 10240,
INIT_CFG_NUM_15360 = 15360,
INIT_CFG_NUM_20480 = 20480
}INIT_CFG_MAX_NUM

enumMaxAlarmNum INIT_CFG_MAX_NUM Maximum number of alarm channels, see

details below:
enum _INIT_CFG_MAX_NUM_{
INIT_CFG_NUM_2048 = 2048,
INIT_CFG_NUM_5120 = 5120,
INIT_CFG_NUM_10240 = 10240,
INIT_CFG_NUM_15360 = 15360,
INIT_CFG_NUM_20480 = 20480
}INIT_CFG_MAX_NUM

byRes Array of BYTE Reserved, set to 0.

Remarks
By default, up to 2048 channels are supported. More channels require higher computer
performance and network bandwidth.
See Also
NET_DVR_SetSDKInitCfg

4.52 NET_DVR_IPADDR

IP Address Structure

Member Data Type Description

sIpV4 Array of char Device IPv4 address
sIpV6 Array of BYTE Device IPv6 address

188
 Device Network SDK (Access Control on Person) Developer Guide

4.53 NET_DVR_JSON_DATA_CFG
Structure about picture data in JSON format.

Structure Definition
struct{
DWORD dwSize;
void *lpJsonData;
DWORD dwJsonDataSize;
void *lpPicData;
DWORD dwPicDataSize;
DWORD dwInfraredFacePicSize;
char *lpInfraredFacePicBuffer;
BYTE byRes[248];
}NET_DVR_JSON_DATA_CFG,*LPNET_DVR_JSON_DATA_CFG;

Members
dwSize
Structure size.
lpJsonData
Returned message in JSON format.
dwJsonDataSize
Size of the message in JSON format.
lpPicData
Picture data. If the returned message is the response status message, this member is invalid; if
the returned message in JSON format does not contain faceURL, this member should contain
picture data in binary format.
dwPicDataSize
Picture data size, the maximum size is 200 KB.
dwInfraredFacePicSize
Data size of the infrared face picture. When this member is 0, it indicates that there is no face
picture data. When the response message is JSON_ResponseStatus , this member is
meaningless. When the request message in JSON format does not contain the value of
infraredFaceURL, this member should contain the binary picture.
lpInfraredFacePicBuffer
Buffer of infrared face picture data.
byRes
Reserved.

189
 Device Network SDK (Access Control on Person) Developer Guide

4.54 NET_DVR_LOCAL_SDK_PATH

Path Information Structure for Loading Component Libraries

Member Data Type Description

sPath Array of char Component libraries' addresses
byRes Array of BYTE Reserved.

Remarks
If the path of HCNetSDKCom folder and HCNetSDK libraries are same, but the path of executable
programs are different, you can call NET_DVR_SetSDKInitCfg to specify the path of HCNetSDKCom
folder to make sure the component libraries are loaded normally.

4.55 NET_DVR_MIME_UNIT

Input Content Details Structure of Message Transmission API (NET_DVR_STDXMLConfig)

Member Data Type Description

szContentType Array of char Content type (corresponds to Content-Type
field in the message), e.g., text/json. text/xml,
and so on. The content format must be
supported by HTTP.
szName Array of char Content name (corresponds to name field in the
message), e.g., name="upload".
szFilename Array of char Content file name (corresponds to filename
field in the message), e.g., filename=​"C:\Users
\test\Desktop\11.txt".
dwContentLen DWORD Content size
pContent char* Data point
byRes Array of BYTE Reserved, set to 0.

See Also
NET_DVR_XML_CONFIG_INPUT

190
 Device Network SDK (Access Control on Person) Developer Guide

4.56 NET_DVR_MULTI_CARD_CFG_V50
Multi-factor authentication parameter structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byEnable;
BYTE bySwipeIntervalTimeout;
BYTE byRes1[2];
NET_DVR_MULTI_CARD_GROUP_CFG_V50 struGroupCfg[NET_SDK_MULTI_CARD_GROUP_NUM/*20*/];
BYTE byRes2[32];
}NET_DVR_MULTI_CARD_CFG_V50,*LPNET_DVR_MULTI_CARD_CFG_V50;

Members
dwSize
Structure size
byEnable
Whether to enable multi-factor authentication: 0-no, 1-yes.
bySwipeIntervalTimeout
Card swiping interval timeout, which is ranging from 1 to 255, unit: second, default: 10s.
byRes1
Reserved, set to 0.
struGroupCfg
Card swiping parameters of group, see details in the structure
NET_DVR_MULTI_CARD_GROUP_CFG_V50 .
byRes2
Reserved, set to 0.

4.57 NET_DVR_MULTI_CARD_GROUP_CFG_V50
Card swiping parameter structure of card group.

Structure Definition
struct{
BYTE byEnable;
BYTE byEnableOfflineVerifyMode;
BYTE byRes1[2];
DWORD dwTemplateNo;

191
 Device Network SDK (Access Control on Person) Developer Guide

NET_DVR_GROUP_COMBINATION_INFO_V50 struGroupCombination[GROUP_COMBINATION_NUM];
}NET_DVR_MULTI_CARD_GROUP_CFG_V50,*LPNET_DVR_MULTI_CARD_GROUP_CFG_V50;

Members
byEnable
Whether to enable card group parameters of multi-factor authentication: 0-no, 1-yes.
bySwipeIntervalTimeout
Whether to enable access authentication when the access controller is offline (open door by
super password instead of remotely opening door): 0-no, 1-yes
byRes1
Reserved, set to 0.
dwTemplateNo
Template No. of multi-factor authentication schedule, which reuses the template of access
permission control schedule.
struGroupCombination
Group parameters, see details in the structure NET_DVR_GROUP_COMBINATION_INFO_V50 .

See Also
NET_DVR_MULTI_CARD_CFG_V50

4.58 NET_DVR_NETCFG_V50

Network Configuration Structure

Member Data Type Description

dwSize DWORD Structure size.
struEtherNet Array of Ethernet interface
NET_DVR_ETHERNET_
V30
struRes1 Array of Reserved, set to 0.
struAlarmHostIpAddr NET_DVR_IPADDR Listening service IP address
byRes2 Array of BYTE Reserved, set as 0
wAlarmHostIpPort WORD Listening service port No.
byUseDhcp BYTE Whether to enable DHCP: 0xff- invalid; 0-
disable, 1-enable

192
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

byIPv6Mode BYTE Allocation mode of IPv6 address: 0-by router
advertisement, 1-by manual setting, 2-by
enabling DHCP allocation.
struDnsServer1IpAddr NET_DVR_IPADDR IP address of domain name server 1
struDnsServer2IpAddr NET_DVR_IPADDR IP address of domain name server 2
byIpResolver Array of BYTE IP resolver domain name or IP address (if the
port No. of device is 8000, the domain name is
not supported).
wIpResolverPort WORD IP resolver port No.
wHttpPortNo WORD HTTP port No.
struMulticastIpAddr NET_DVR_IPADDR Multicast group address
struGatewayIpAddr NET_DVR_IPADDR Gateway address
struPPPoE NET_DVR_PPPOECFG PPPoE parameters
byEnablePrivateMultic BYTE Private multicast search (SADP): 0-default, 1-
astDiscovery enable, 2-disable
byEnableOnvifMulticas BYTE Onvif multicast search (SADP): 0-default, 1-
tDiscovery enable, 2-disable
wAlarmHost2IpPort WORD Port No. of listening host 2.
struAlarmHost2IpAddr NET_DVR_IPADDR IP address of listening host 2
byEnableDNS BYTE DNS address setting mode: 0-​automatically get,
1-manually set.
byRes Array of BYTE Reserved, set to 0

Remarks
• For device only supports the private protocol with version 3.0 or lower, when the parameter
byUseDhcp="0xff", you should set the device IP address to null, and then the device will
automatically get the DHCP information.
• When the parameter byIPv6Mode is set to 0 or 2, setting IPv6 address in the parameter
struEtherNet is not required, it will be obtained automatically by the device; when byIPv6Mode
is set to 1, you should set IPv6 address. As there are multiple IPv6 addresses, the IPv6 address of
current logged-in device may be different with that in struEtherNet.

193
 Device Network SDK (Access Control on Person) Developer Guide

4.59 NET_DVR_PLAN_TEMPLATE
Schedule template configuration structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byEnable;
BYTE byRes1[3];
BYTE byTemplateName[TEMPLATE_NAME_LEN/*32*/];
DWORD dwWeekPlanNo;
DWORD dwHolidayGroupNo[MAX_HOLIDAY_GROUP_NUM/*16*/];
BYTE byRes2[32];
}NET_DVR_PLAN_TEMPLATE,*LPNET_DVR_PLAN_TEMPLATE;

Members
dwSize
Structure size.
byEnable
Whether to enable: 1-enable, 0-disable.
byRes1
Reserved, set to 0.
byGroupName
Schedule template name.
byGroupName
Week schedule No.: 0-invalid.
dwHolidayGroupNo
Holiday group No.: 0-invalid.
byRes2
Reserved, set to 0.

4.60 NET_DVR_PPPOECFG

PPPoE Configuration Structure

Member Data Type Description

dwPPPOE DWORD Whether to enable PPPoE: 0-no, 1-yes.
sPPPoEUser Array of BYTE PPPoE user name.

194
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

sPPPoEPassword Array of char PPPoE password.
struPPPoEIP NET_DVR_IPADDR PPPoE IP address

4.61 NET_DVR_SETUPALARM_PARAM_V50

Arming Parameter Structure

Member Data Type Description

dwSize DWORD Structure size
byLevel BYTE Arming priority: 0-high, 1-medium, 2-low.
byAlarmInfoType BYTE Intelligent traffic alarm information type: 0-old
(NET_DVR_PLATE_RESULT),1-new (NET_ITS_
PLATE_RESULT)
byRetAlarmTypeV40 BYTE 0-motion detection, video loss, video
tampering, and alarm input alarm information
is uploaded in normal mode (alarm type:
COMM_ALARM_V30, alarm information
structure: NET_DVR_ALARMINFO_V30 ), 1-
alarm information is uploaded in variable size
(alarm type: COMM_ALARM_V40, alarm
information structure:
NET_DVR_ALARMINFO_V40 )
byRetDevInfoVersion BYTE Alarm types of CVR: 0-COMM_ALARM_DEVICE
(alarm information structure:
NET_DVR_ALARMINFO_DEV ), 1-COMM_
ALARM_DEVICE_V40 (alarm information
structure: NET_DVR_ALARMINFO_DEV_V40 ).
byRetVQDAlarmType BYTE VQD alarm types: 0-COMM_ALARM_VQD
(alarm information structure: NET_DVR_VQD_
DIAGNOSE_INFO), 1-COMM_ALARM_VQD_EX
(alarm information structure: NET_DVR_VQD_
ALARM, including camera information and
captured pictures)
byFaceAlarmDetection BYTE Face detection alarm types: 1-face detection
alarm (alarm type: COMM_ALARM_FACE_
DETECTION, alarm information structure: NET_

195
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

DVR_FACE_DETECTION), 0-face capture alarm
(alarm type: COMM_UPLOAD_FACESNAP_
RESULT, alarm information structure: NET_VCA_
FACESNAP_RESULT).
bySupport BYTE Capabilities, which is represented by bit:
• bit0-whether to upload picture: 0-yes, 1-no
• bit1-whether to enable ANR: 0-no, 1-yes
• bit4-whether to upload behavior analysis
events of all detection targets: 0-no, 1-yes. It
is used to enable the NVR to get events of all
targets detected by network cameras.
• bit5-whether to enable all-day event or alarm
uploading: 0-no, 1-yes. It is used to enable
the NVR to receive all alarms from network
cameras.
byBrokenNetHttp BYTE ANR type, which is represented by bit and
should be supported by device:
• bit0-whether to enable ANPR for ANPR: 0-no,
1-yes.
• bit1-whether to enable ANR for people
counting: 0-no, 1-yes.
• bit2-whetehr to enable ANR for heat map: 0-
no, 1-yes.
• bit3-whether to enable ANR for face capture:
0-no, 1-yes.
• bit4-whether to enable ANR for face picture
comparison: 0-no, 1-yes.
• bit5-whether to enable ANR for JSON
message transmission: 0-no, 1-yes.
• bit6: whether to enable ANR for uploading
heat map data by dwell time duration and by
people quantity: 0-no, 1-yes.
• bit7: whether to enable ANR for uploading
intersection analysis result: 0-no, 1-yes.
wTaskNo BYTE Task No.
byDeployType BYTE Arming type: 0-arm via client software, 1-​real-
time arming
byRes1 Array of BYTE Reserved, set to 0.

196
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

byAlarmTypeURL BYTE Alarm picture data type, which is represented
by bit, if the device supports uploading alarm
pictures in binary format and URL format, you
can specify the data type to be uploading via
this parameter, if the device only supports URL
format, this parameter is invalid. If the URL
format is selected, you should set the device
and enable the cloud storage, otherwise, the
picture will still be transmitted in binary format.
• bit0-type of captured face pictures: 0-binary
data, 1-URL
• bit1-type of picture uploaded in message: 0-
binary, 1-URL
• bit2-type of picture uploaded for face picture
comparison: 0-binary, 1-URL
byCustomCtrl BYTE Custom control type, which is represented by
bit, bit0-whether to upload the face thumbnail
of co-driver: 0-no, 1-yes
byRes4 Array of BYTE Reserved, set to 0.

Remarks
• The parameters byLevel and byAlarmInfoType are available for traffic cameras. Up to 1 cameras
can be armed in the priority of level 0, up to 3 cameras can be armed in the priority of level 1,
and up to 5 cameras can be armed in the priority of level 3, the alarm/event information from
the camera in highest priority will be uploaded first.
• For arming via client software, only supports arming one channel, and supports uploading the
alarm/event when device is offline; for real-time arming, up to four channels can be armed at
same time, but uploading alarm/event when device is offline is not supported.
• The parameter wTaskNo is used to distinguish different arming connections. If the value of this
parameter in different arming connections is same, error will be returned.

4.62 NET_DVR_SIMPLE_DAYTIME
Time parameter structure.

Structure Definition
struct{
BYTE byHour;
BYTE byMinute;
BYTE bySecond;

197
 Device Network SDK (Access Control on Person) Developer Guide

BYTE byRes;
}NET_DVR_SIMPLE_DAYTIME,*LPNET_DVR_SIMPLE_DAYTIME;

Members
byHour
Hour
byMinute
Minute
bySecond
Second
byRes
Reserved, set to 0.

4.63 NET_DVR_SINGLE_PLAN_SEGMENT
Parameter structure of a schedule

Structure Definition
struct{
BYTE byEnable;
BYTE byDoorStatus;
BYTE byVerifyMode;
BYTE byRes[5];
NET_DVR_TIME_SEGMENT struTimeSegment;
}NET_DVR_SINGLE_PLAN_SEGMENT, *LPNET_DVR_SINGLE_PLAN_SEGMENT;

Members
byEnable
Whether to enable: 1-no, 0-yes.
byDoorStatus
Door status: 0-invalid, 1-remain open (access without authentication), 2-remain closed (access
is not allowed), 3-normal (access by authentication).
byVerifyMode
Authentication mode: 0-invalid, 1-card, 2-card+password, 3-password, 4-card or password, 5-
fingerprint, 6-fingerprint+password, 7-fingerprint or password, 8-fingerprint+card, 9-fingerprint
+card+password, 10-face or fingerprint or card or password, 11-face+fingerprint, 12-face
+password, 13-face+card, 14-face, 15-employee ID+password, 16-fingerprint or password, 17-
employee ID+fingerprint, 18-employee ID+fingerprint+password, 19-face+fingerprint+card, 20-
face+password+fingerprint, 21-employee ID+face, 22-face or face+card, 23-fingerprint or face,

198
 Device Network SDK (Access Control on Person) Developer Guide

24-card or face or password, 25-card or face, 26-card or face or fingerprint, 27-card or

fingerprint or password.
byRes
Reserved, set to 0.
struTimeSegment
Time period parameters, see NET_DVR_TIME_SEGMENT for details.

4.64 NET_DVR_TIME

Time Parameter Structure

Member Data Type Description

dwYear DWORD Year
dwMonth DWORD Month
dwDay DWORD Day
dwHour DWORD Hour
dwMinute DWORD Minute
dwSecond DWORD Second

4.65 NET_DVR_TIME_EX

Extended Time Parameter Structure

Member Data Type Description

wYear WORD Year
byMonth BYTE Month
byDay BYTE Day
byHour BYTE Hour
byMinute BYTE Minute
bySecond BYTE Second
byRes BYTE Reserved.

199
 Device Network SDK (Access Control on Person) Developer Guide

4.66 NET_DVR_TIME_SEGMENT
Time period parameter structure.

Structure Definition
struct{
NET_DVR_SIMPLE_DAYTIME struBeginTime;
NET_DVR_SIMPLE_DAYTIME struEndTime;
}NET_DVR_TIME_SEGMENT, *LPNET_DVR_TIME_SEGMENT;

Members
struBeginTime
Start time of time period, refer to the structure NET_DVR_SIMPLE_DAYTIME for details.
struEndTime
End time of time period, refer to the structure NET_DVR_SIMPLE_DAYTIME for details.

4.67 NET_DVR_USER_LOGIN_INFO

Structure About User Login Parameters

Member Data Type Description

sDeviceAddress char Device IP address, or domain name.
byUseTransport BYTE Enable capability transmission or not: 0-no
(default), 1-yes.
wPort WORD Device port number, e.g., 8000 (when login by
private protocol), 80 (when login by ISAPI
protocol).
sUserName char User name for logging in to device.
sPassword char Login password.
cbLoginResult fLoginResultCallBack Callback function used to return login status, it
is valid only when bUseAsynLogin is "1", see
the callback function fLoginResultCallBack for
details.
pUser void* User data.
bUseAsynLogin BOOL Whether to enable asynchronous login: 0-no, 1-
yes.

200
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

byProxyType BYTE Proxy server type: 0-no proxy, 1-standard proxy,
2-EHome proxy.
byUseUTCTime BYTE 0-not convert (default), 1-input or output UTC
time, 2-input or output local time.
byLoginMode BYTE Login mode: 0-login by private protocol, 1-login
by ISAPI protocol, 2-​self-​adaptive (it is available
when the protocol type supported by device is
unknown, and this mode does not support
asynchronous login).
byHttps BYTE Whether to log in to based on TLS: 0-no, 1-yes,
2-​self-​adaptive (it is available when the protocol
type supported by device is unknown).
iProxyID LONG Proxy server No.
byRes3 Array of BYTE Reserved, set to 0.

4.67.1 fLoginResultCallBack

Login Status Callback Function

Member Data Type Description

lUserID LONG User ID, which is returned by
NET_DVR_Login_V40 .
dwResult DWORD Login status: 0-asynchronously logging in failed,
1-asynchronously logged in.
lpDeviceInfo NET_DVR_DEVICEINFO Device information, such as serial No., channel,
_V40 capability, and so on.
pUser void* User data.

4.68 NET_DVR_VALID_PERIOD_CFG
Expiry date configuration structure.

Structure Definition
struct{
BYTE byEnable;

201
 Device Network SDK (Access Control on Person) Developer Guide

BYTE byBeginTimeFlag;
BYTE byEnableTimeFlag;
BYTE byTimeDurationNo;
NET_DVR_TIME_EX struBeginTime;
NET_DVR_TIME_EX struEndTime;
BYTE byTimeType;
BYTE byRes2[32];
}NET_DVR_VALID_PERIOD_CFG,*LPNET_DVR_VALID_PERIOD_CFG;

Members
byEnable
Whether to enable the expiry date: 0-no, 1-yes.
byBeginTimeFlag
Whether to enable the flag to limit the start time: 0-no, 1-yes.
byEnableTimeFlag
Whether to enable the flag to limit the end time: 0-no, 1-yes.
byTimeDurationNo
Expiry date index No., which starts from 0.
struBeginTime
Start time of the expiry date, see details in the structure NET_DVR_TIME_EX .
struEndTime
End time of the expiry date, see details in the structure NET_DVR_TIME_EX ..
byTimeType
Time type: 0-device's local time (default), 1-UTC time. This member is valid for struBeginTime
and struEndTime.
byRes2
Reserved, set to 0.

See Also
NET_DVR_GROUP_CFG

4.69 NET_DVR_WEEK_PLAN_CFG
Week schedule parameter structure.

Structure Definition
struct{
DWORD dwSize;
BYTE byEnable;
BYTE byRes1[3];

202
 Device Network SDK (Access Control on Person) Developer Guide

NET_DVR_SINGLE_PLAN_SEGMENT struPlanCfg[MAX_DAYS/*7*/][MAX_TIMESEGMENT_V30/*8*/];
BYTE byRes2[16];
}NET_DVR_WEEK_PLAN_CFG, *LPNET_DVR_WEEK_PLAN_CFG;

Members
dwSize
Structure size.
byEnable
Whether to enable: 1-no, 0-yes.
byRes1
Reserved, set to 0.
struPlanCfg
Week schedule parameters, up to 7 days can be set in one week, and up to 8 time periods can
be set in one day, see NET_DVR_SINGLE_PLAN_SEGMENT for details.
byRes2
Reserved, set to 0.

4.70 NET_DVR_XML_CONFIG_INPUT

Input Parameter Structure of Message Transmission API (NET_DVR_STDXMLConfig)

Member Data Type Description

dwSize DWORD Structure size.
lpRequestUrl void* Request URL (command) for implement
different functions, and it is in string format.
dwRequestUrlLen DWORD Request URL size.
lpInBuffer void* Buffer for storing input parameters (request
messages), see the input content details
structure in NET_DVR_MIME_UNIT .
dwInBufferSize DWORD Input buffer size.
dwRecvTimeOut DWORD Receiving timeout, unit: ms, 0-5000ms (default).
byForceEncrpt BYTE Whether to enable force encryption (the
messages will be encrypted by AES algorithm
for transmission): 0-no, 1-yes.
byNumOfMultiPart BYTE Number of message segments: 0-invalid; other
values-number of message segments, which is

203
 Device Network SDK (Access Control on Person) Developer Guide

Member Data Type Description

transmitted by the parameter lpInBuffer in the
structure NET_DVR_MIME_UNIT .
byRes Array of BYTE Reserved, set to 0.

Related API
NET_DVR_STDXMLConfig

4.71 NET_DVR_XML_CONFIG_OUTPUT

Output Parameter Structure of Message Transmission API (NET_DVR_STDXMLConfig)

Member Data Type Description

dwSize DWORD Structure size.
lpOutBuffer void* Buffer for storing output parameters (response
messages), which is allocated when passing
through URL by GET method.
dwOutBufferSize DWORD Output buffer size.
dwReturnedXMLSize DWORD Actual size of response message.
lpStatusBuffer void* Response status (ResponseStatus message).
This parameter will not be assigned if
performing GET operation succeeded, and you
can also set it to "NULL" if not required.
dwStatusSize DWORD Size of response status buffer.
byRes Array of BYTE Reserved, set to 0.

Related API
NET_DVR_STDXMLConfig

4.72 NET_SDK_CALLBACK_STATUS_NORMAL

204
 Device Network SDK (Access Control on Person) Developer Guide

Enumeration About Persistent Connection Status

Member Marco Value Description

NET_SDK_CALLBACK_STATUS_ 1000 Succeeded.
SUCCESS
NET_SDK_CALLBACK_STATUS_ 1001 Connecting. The lpBuffer is 4-byte
PROCESSING status.
NET_SDK_CALLBACK_STATUS_ 1002 Failed. The lpBuffer is the value of
FAILED 4-byte status and 4-byte error
code.

4.73 NET_SDK_DOWNLOAD_TYPE
Enumerate file types to be downloaded.

Enumeration Definition
typedef enum {
NET_SDK_DOWNLOAD_CERT = 0,
NET_SDK_DOWNLOAD_IPC_CFG_FILE = 1,
NET_SDK_DOWNLOAD_BASELINE_SCENE_PIC = 2,
NET_SDK_DOWNLOAD_VQD_ALARM_PIC = 3,
NET_SDK_DOWNLOAD_CONFIGURATION_FILE = 4,
NET_SDK_DOWNLOAD_SCENE_CONFIGURATION_FILE = 5,
NET_SDK_DOWNLOAD_FILE_FORM_DB = 6,
NET_SDK_DOWNLOAD_TME_FILE = 7,
NET_SDK_DOWNLOAD_VEHICLE_BLACKWHITELST_FILE = 8,
NET_SDK_DOWNLOAD_GUID_FILE = 9,
NET_SDK_DOWNLOAD_FILE_FORM_CLOUD = 10,
NET_SDK_DOWNLOAD_PICTURE = 11,
NET_SDK_DOWNLOAD_VIDEO = 12,
NET_DVR_DOWNLOAD_SCREEN_FILE = 13,
NET_SDK_DOWNLOAD_PUBLISH_MATERIAL = 14,
NET_SDK_DOWNLOAD_THERMOMETRIC_FILE = 15,
NET_SDK_DOWNLOAD_LED_CHECK_FILE = 16,
NET_SDK_DOWNLOAD_VEHICLE_INFORMATION = 17,
NET_SDK_DOWNLOAD_CERTIFICATE_BLACK_LIST_TEMPLET = 18,
NET_SDK_DOWNLOAD_LOG_FILE = 19,
NET_SDK_DOWNLOAD_FILEVOLUME_DATA = 20,
NET_SDK_DOWNLOAD_FD_DATA = 21,
NET_SDK_DOWNLOAD_SECURITY_CFG_FILE = 22,
NET_SDK_DOWNLOAD_PUBLISH_SCHEDULE = 23,
NET_SDK_DOWNLOAD_RIGHT_CONTROLLER_AUDIO = 24,
NET_SDK_DOWNLOAD_MODBUS_CFG_FILE = 25,
NET_SDK_DOWNLOAD_RS485_PROTOCOL_DLL_FILE = 26,
NET_SDK_DOWNLOAD_CLUSTER_MAINTENANCE_LOG = 27,

205
 Device Network SDK (Access Control on Person) Developer Guide

NET_SDK_DOWNLOAD_SQL_ARCHIVE_FILE = 28,
NET_SDK_DOWNLOAD_SUBWIND_STREAM = 29,
NET_SDK_DOWNLOAD_DEVTYPE_CALIBFILE = 30,
NET_SDK_DOWNLOAD_HD_CAMERA_CORRECT_TABLE = 31,
NET_SDK_DOWNLOAD_CLIENT_CALIBFILE = 32,
NET_SDK_DOWNLOAD_FOUE_CAMERAS_PICTURES = 33,
NET_SDK_DOWNLOAD_DOOR_CONTENT = 34,
NET_SDK_DOWNLOAD_PUBLISH_MATERIAL_THUMBNAIL = 35,
NET_SDK_DOWNLOAD_PUBLISH_PROGRAM_THUMBNAIL = 36,
NET_SDK_DOWNLOAD_PUBLISH_TEMPLATE_THUMBNAIL = 37,
NET_SDK_DOWNLOAD_DARK_FIGHTER_X_CORRECT_TABLE_MAIN = 38,
NET_SDK_DOWNLOAD_DARK_FIGHTER_X_CORRECT_TABLE_BACKUP = 39,
NET_SDK_DOWNLOAD_OFFLINE_CAPTURE_INFO_TEMPLATE = 40,
NET_SDK_DOWNLOAD_CAPTURE_DATA = 41
} NET_SDK_DOWNLOAD_TYPE;

Members
NET_SDK_DOWNLOAD_CERT
Certificate.
NET_SDK_DOWNLOAD_IPC_CFG_FILE
Network camera configuration file.
NET_SDK_DOWNLOAD_BASELINE_SCENE_PIC
Base scene picture.
NET_SDK_DOWNLOAD_VQD_ALARM_PIC
VQD (video quality diagnosis) alarm picture.
NET_SDK_DOWNLOAD_CONFIGURATION_FILE
Configuration file.
NET_SDK_DOWNLOAD_SCENE_CONFIGURATION_FILE
Scene configuration file.
NET_SDK_DOWNLOAD_FILE_FORM_DB
File in the image and video library.
NET_SDK_DOWNLOAD_TME_FILE
Entrance and exit management file.
NET_SDK_DOWNLOAD_VEHICLE_BLACKWHITELST_FILE
Blacklist and whitelist configuration file.
NET_SDK_DOWNLOAD_GUID_FILE
GUID file.
NET_SDK_DOWNLOAD_FILE_FORM_CLOUD
Picture in the cloud storage.
NET_SDK_DOWNLOAD_PICTURE

206
 Device Network SDK (Access Control on Person) Developer Guide

Picture.
NET_SDK_DOWNLOAD_VIDEO
Video.
NET_DVR_DOWNLOAD_SCREEN_FILE
Screen server file.
NET_SDK_DOWNLOAD_PUBLISH_MATERIAL
Static material file of information release.
NET_SDK_DOWNLOAD_THERMOMETRIC_FILE
Thermometry calibration file.
NET_SDK_DOWNLOAD_LED_CHECK_FILE
LED correction file.
NET_SDK_DOWNLOAD_VEHICLE_INFORMATION
Vehicle information to be exported.
NET_SDK_DOWNLOAD_CERTIFICATE_BLACK_LIST_TEMPLET
ID card blacklist template.
NET_SDK_DOWNLOAD_LOG_FILE
Log to be exported.
NET_SDK_DOWNLOAD_FILEVOLUME_DATA
File volume data file, currently it is only supported by CVR (central video recorder) devices.
NET_SDK_DOWNLOAD_FD_DATA
Data in a specific face picture library to be exported.
NET_SDK_DOWNLOAD_SECURITY_CFG_FILE
Configuration file to be securely exported.
NET_SDK_DOWNLOAD_PUBLISH_SCHEDULE
Schedule to be exported.
NET_SDK_DOWNLOAD_RIGHT_CONTROLLER_AUDIO
Audio file of the main controller.
NET_SDK_DOWNLOAD_MODBUS_CFG_FILE
Configuration file of Modbus protocol.
NET_SDK_DOWNLOAD_RS485_PROTOCOL_DLL_FILE
Dynamic library file of RS-485 protocol.
NET_SDK_DOWNLOAD_CLUSTER_MAINTENANCE_LOG
Cluster maintenance log to be exported.
NET_SDK_DOWNLOAD_SQL_ARCHIVE_FILE

207
 Device Network SDK (Access Control on Person) Developer Guide

Archived record in the database to be exported.

NET_SDK_DOWNLOAD_SUBWIND_STREAM
Sub-window stream to be exported.
NET_SDK_DOWNLOAD_DEVTYPE_CALIBFILE
Model calibration file to be exported (*.cal).
NET_SDK_DOWNLOAD_HD_CAMERA_CORRECT_TABLE
24 MP/32 MP correction list to be exported (*.cal).
NET_SDK_DOWNLOAD_CLIENT_CALIBFILE
Client calibration file to be exported (*.pto).
NET_SDK_DOWNLOAD_FOUE_CAMERAS_PICTURES
Four-channel picture package to be exported (.tar).
NET_SDK_DOWNLOAD_DOOR_CONTENT
Door contact information.
NET_SDK_DOWNLOAD_PUBLISH_MATERIAL_THUMBNAIL
Thumbnail of static information release material.
NET_SDK_DOWNLOAD_PUBLISH_PROGRAM_THUMBNAIL
Thumbnail of information release program.
NET_SDK_DOWNLOAD_PUBLISH_TEMPLATE_THUMBNAIL
Thumbnail of information release template.
NET_SDK_DOWNLOAD_DARK_FIGHTER_X_CORRECT_TABLE_MAIN
DarkfighterX correction list file (main partition).
NET_SDK_DOWNLOAD_DARK_FIGHTER_X_CORRECT_TABLE_BACKUP
DarkfighterX correction list file (backup partition).
NET_SDK_DOWNLOAD_OFFLINE_CAPTURE_INFO_TEMPLATE
User list template of collection.
NET_SDK_DOWNLOAD_CAPTURE_DATA
Offline collected data.

4.74 NET_SDK_UPLOAD_TYPE
Enumerate file types to be uploaded.

Enumeration Definition
typedef enum {
UPGRADE_CERT_FILE = 0,
UPLOAD_CERT_FILE = 1,

208
 Device Network SDK (Access Control on Person) Developer Guide

TRIAL_CERT_FILE = 2,
CONFIGURATION_FILE = 3,
UPLOAD_RECORD_FILE = 4,
SCENE_CONFIGURATION_FILE = 5,
UPLOAD_PICTURE_FILE = 6,
UPLOAD_VIOLATION_FILE = 7,
UPLOAD_TG_FILE = 8,
UPLOAD_DATA_TO_DB = 9,
UPLOAD_BACKGROUND_PIC = 10,
UPLOAD_CALIBRATION_FILE = 11,
UPLOAD_TME_FILE = 12,
UPLOAD_VEHICLE_BLACKWHITELST_FILE = 13,
UPLOAD_PICTURE_TO_CLOUD = 15,
UPLOAD_VIDEO_FILE = 16,
UPLOAD_SCREEN_FILE = 17,
UPLOAD_PUBLISH_MATERIAL = 18,
UPLOAD_PUBLISH_UPGRADE_FILE = 19,
UPLOAD_RING_FILE = 20,
UPLOAD_ENCRYPT_CERT = 21,
UPLOAD_THERMOMETRIC_FILE = 22,
UPLOAD_SUBBRAND_FILE = 23,
UPLOAD_LED_CHECK_FILE = 24,
BATCH_UPLOAD_PICTURE_FILE = 25,
UPLOAD_EDID_CFG_FILE = 26,
UPLOAD_PANORAMIC_STITCH = 27,
UPLOAD_BINOCULAR_COUNTING = 28,
UPLOAD_AUDIO_FILE = 29,
UPLOAD_PUBLISH_THIRD_PARTY_FILE = 30,
UPLOAD_DEEPEYES_BINOCULAR = 31,
UPLOAD_CERTIFICATE_BLACK_LIST = 32,
UPLOAD_HD_CAMERA_CORRECT_TABLE = 33,
UPLOAD_FD_DATA = 35,
UPLOAD_FACE_DATA = 36,
UPLOAD_FACE_ANALYSIS_DATA = 37,
UPLOAD_FILEVOLUME_DATA = 38,
IMPORT_DATA_TO_FACELIB = 39,
UPLOAD_LEFTEYE_4K_CALIBFILE = 40,
UPLOAD_SECURITY_CFG_FILE = 41,
UPLOAD_RIGHT_CONTROLLER_AUDIO = 42,
UPLOAD_MODBUS_CFG_FILE = 43,
UPLOAD_NOTICE_VIDEO_DATA = 44,
UPLOAD_RS485_PROTOCOL_DLL_FILE = 45,
UPLOAD_PIC_BY_BUF = 46,
UPLOAD_CLIENT_CALIBFILE = 47,
UPLOAD_HD_CAMERA_CORRECT_TABLE_3200W = 48,
UPLOAD_APP_FILE = 51,
UPLOAD_OFFLINE_CAPTURE_INFO = 56
}NET_SDK_UPLOAD_TYPE;

Members
UPGRADE_CERT_FILE

209
 Device Network SDK (Access Control on Person) Developer Guide

Certificate file to be upgraded.

UPLOAD_CERT_FILE
Certificate file to be uploaded.
TRIAL_CERT_FILE
Trial license file.
CONFIGURATION_FILE
Configuration file.
UPLOAD_RECORD_FILE
Video file.
SCENE_CONFIGURATION_FILE
Scene configuration file.
UPLOAD_PICTURE_FILE
Picture file.
UPLOAD_VIOLATION_FILE
Violation dictionary file.
UPLOAD_TG_FILE
Timing generator file.
UPLOAD_DATA_TO_DB
File to be uploaded to picture and video library.
UPLOAD_BACKGROUND_PIC
Background picture.
UPLOAD_CALIBRATION_FILE
Calibration file.
UPLOAD_TME_FILE
Entrance and exiting management file.
UPLOAD_VEHICLE_BLACKWHITELST_FILE
Vehicle blacklist file.
UPLOAD_PICTURE_TO_CLOUD
Picture file to be uploaded to cloud storage.
UPLOAD_VIDEO_FILE
Video file.
UPLOAD_SCREEN_FILE
Screen server file.
UPLOAD_PUBLISH_MATERIAL

210
 Device Network SDK (Access Control on Person) Developer Guide

Static material file of information release system.

UPLOAD_PUBLISH_UPGRADE_FILE
Upgrade file of information release system.
UPLOAD_RING_FILE
Ringtone file.
UPLOAD_ENCRYPT_CERT
Encryption certificate.
UPLOAD_THERMOMETRIC_FILE
Calibration file for temperature measurement.
UPLOAD_SUBBRAND_FILE
Vehicle sub brand file.
UPLOAD_LED_CHECK_FILE
LED correction file.
BATCH_UPLOAD_PICTURE_FILE
Picture files for uploading in batch.
UPLOAD_EDID_CFG_FILE
EDID configuration file.
UPLOAD_PANORAMIC_STITCH
Panorama stitching configuration file.
UPLOAD_BINOCULAR_COUNTING
Binocular counting correction sheet.
UPLOAD_AUDIO_FILE
Audio file.
UPLOAD_PUBLISH_THIRD_PARTY_FILE
Third-party file.
UPLOAD_DEEPEYES_BINOCULAR
TX1 binocular correction sheet.
UPLOAD_CERTIFICATE_BLACK_LIST
ID card blacklist.
UPLOAD_HD_CAMERA_CORRECT_TABLE
HD camera correction sheet (CAL format).
UPLOAD_FD_DATA
Face data file to be imported to face picture library.
UPLOAD_FACE_DATA

211
 Device Network SDK (Access Control on Person) Developer Guide

Face picture file to be imported to face picture library.

UPLOAD_FACE_ANALYSIS_DATA
Picture file to be imported to picture recognition target.
UPLOAD_FILEVOLUME_DATA
File volume file
IMPORT_DATA_TO_FACELIB
Face data (face picture and picture additional information) to be imported to face picture library
of device.
UPLOAD_LEFTEYE_4K_CALIBFILE
Camera calibration parameter file.
UPLOAD_SECURITY_CFG_FILE
Configuration file for security importing.
UPLOAD_RIGHT_CONTROLLER_AUDIO
Audio file of main controller.
UPLOAD_MODBUS_CFG_FILE
Configuration file of Modbus protocol.
UPLOAD_NOTICE_VIDEO_DATA
Bulletin video file.
UPLOAD_RS485_PROTOCOL_DLL_FILE
Dynamic library file of RS485 protocol.
UPLOAD_PIC_BY_BUF
Picture file for importing by picture cache.
UPLOAD_CLIENT_CALIBFILE
User calibration file (PTO format).
UPLOAD_HD_CAMERA_CORRECT_TABLE_3200W
HD camera correction sheet (CAL format).
UPLOAD_APP_FILE
Application program file.
UPLOAD_OFFLINE_CAPTURE_INFO
User list of offline collection to be imported.

4.75 NET_VCA_POINT

212
 Device Network SDK (Access Control on Person) Developer Guide

Structure About Point Coordinates Parameters

Member Data Type Description

fX float X-coordinate, ranges from 0.000 to 1.
fY float Y-coordinate, ranges from 0.000 to 1.

4.76 NET_VCA_RECT

Structure About Rectangle Region Coordinate Parameters

Member Data Type Description

fX float X-coordinate of frame's upper-​left corner, it
ranges from 0.000 to 1.
fY float Y-coordinate of frame' upper-​left corner, it
ranges from 0.000 to 1.
fWidth float Frame width, it ranges from 0.000 to 1.
fHeight float Frame height, it ranges from 0.000 to 1.

213
 Device Network SDK (Access Control on Person) Developer Guide

Chapter 5 Request URL

The intelligent security API in request URL format for realizing the functions in this manual are
listed here for reference. You can search for the URLs and view their definitions.

5.1 /ISAPI/AccessControl/AcsEventTotalNum/capabilities?format=json
Get the capability of getting total number of access control events by specific conditions.

Request URL Definition

Table 4-1 GET /ISAPI/AccessControl/AcsEventTotalNum/capabilities?format=json
Method GET
Description Get the capability of getting total number of access control events by
specific conditions.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_AcsEventTotalNum
Failed: JSON_ResponseStatus

5.2 /ISAPI/AccessControl/AcsEventTotalNum?format=json
Get the total number of access control events by specific conditions.

Request URL Definition

Table 4-2 POST /ISAPI/AccessControl/AcsEventTotalNum?format=json
Method POST
Description Get the total number of access control events by specific conditions.
Query format: determine the format of request or response message.
Request JSON_AcsEventTotalNumCond
Response Succeeded: JSON_AcsEventTotalNum
Failed: JSON_ResponseStatus

214
 Device Network SDK (Access Control on Person) Developer Guide

5.3 /ISAPI/AccessControl/attendanceStatusModeCfg/capabilities?
format=json
Get the configuration capability of the attendance mode.

Request URL Definition

Table 4-3 GET /ISAPI/AccessControl/attendanceStatusModeCfg/capabilities?format=json
Method GET
Description Get the configuration capability of the attendance mode.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_AttendanceStatusModeCfg
Failed: JSON_ResponseStatus

5.4 /ISAPI/AccessControl/attendanceStatusModeCfg?format=json
Operations about the attendance mode configuration.

Request URL Definition

Table 4-4 GET /ISAPI/AccessControl/attendanceStatusModeCfg?format=json
Method GET
Description Get the attendance mode.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_AttendanceStatusModeCfg
Failed: JSON_ResponseStatus
Table 4-5 PUT /ISAPI/AccessControl/attendanceStatusModeCfg?format=json
Method PUT
Description Set the attendance mode.
Query format: determine the format of request or response message.
Request JSON_AttendanceStatusModeCfg
Response JSON_ResponseStatus

215
 Device Network SDK (Access Control on Person) Developer Guide

5.5 /ISAPI/AccessControl/attendanceStatusRuleCfg/capabilities?
format=json
Get the configuration capability of the attendance status and rule.

Request URL Definition

Table 4-6 GET /ISAPI/AccessControl/attendanceStatusRuleCfg/capabilities?format=json
Method GET
Description Get the configuration capability of the attendance status and rule.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_AttendanceStatusRuleCfg
Failed: JSON_ResponseStatus

5.6 /ISAPI/AccessControl/attendanceStatusRuleCfg?
attendanceStatus=&format=json
Operations about the configuration of the attendance status and rule.

Request URL Definition

Table 4-7 GET /ISAPI/AccessControl/attendanceStatusRuleCfg?attendanceStatus=&format=json
Method GET
Description Get the attendance status and rule.
Query format: determine the format of request or response message.
attendanceStatus: attendance status, it can be set to one of the
following values: "checkIn"-check in, "checkOut"-check out,
"breakOut"-break out, "breakIn"-break in, "overtimeIn"-​overtime in,
"overtimeOut"-​overtime out, e.g., /ISAPI/AccessControl/
attendanceStatusRuleCfg?attendanceStatus=checkIn&format=json.
Request None.
Response Succeeded: JSON_AttendanceStatusRuleCfg
Failed: JSON_ResponseStatus

216
 Device Network SDK (Access Control on Person) Developer Guide

Table 4-8 PUT /ISAPI/AccessControl/attendanceStatusRuleCfg?attendanceStatus=&format=json

Method PUT
Description Set the attendance status and rule.
Query format: determine the format of request or response message.
attendanceStatus: attendance status, it can be set to one of the
following values: "checkIn"-check in, "checkOut"-check out,
"breakOut"-break out, "breakIn"-break in, "overtimeIn"-​overtime in,
"overtimeOut"-​overtime out, e.g., /ISAPI/AccessControl/
attendanceStatusRuleCfg?attendanceStatus=checkIn&format=json.
Request JSON_AttendanceStatusRuleCfg
Response JSON_ResponseStatus

5.7 /ISAPI/AccessControl/CaptureCardInfo/capabilities?format=json
Get the capability of collecting card information.

Request URL Definition

Table 4-9 GET /ISAPI/AccessControl/CaptureCardInfo/capabilities?format=json
Method GET
Description Get the capability of collecting card information.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CardInfoCap
Failed: JSON_ResponseStatus

5.8 /ISAPI/AccessControl/CaptureCardInfo?format=json
Collect card information.

Request URL Definition

Table 4-10 GET /ISAPI/AccessControl/CaptureCardInfo?format=json
Method GET
Description Collect card information by the card reading module of the device.
Query format: determine the format of request or response message.

217
 Device Network SDK (Access Control on Person) Developer Guide

Request None.
Response Succeeded: JSON_CardInfo_Collection
Failed: JSON_ResponseStatus

5.9 /ISAPI/AccessControl/CaptureFingerPrint
Collect fingerprint information.

Request URL Definition

Table 4-11 POST /ISAPI/AccessControl/CaptureFingerPrint
Method POST
Description Collect fingerprint information.
Query None.
Request XML_CaptureFingerPrintCond
Response Succeeded: XML_CaptureFingerPrint
Failed: XML_ResponseStatus

5.10 /ISAPI/AccessControl/CaptureFingerPrint/capabilities
Get the fingerprint collection capability.

Request URL Definition

Table 4-12 GET /ISAPI/AccessControl/CaptureFingerPrint/capabilities
Method GET
Description Get the fingerprint collection capability.
Query None.
Request None.
Response Succeeded: XML_Cap_CaptureFingerPrint
Failed: XML_ResponseStatus

5.11 /ISAPI/AccessControl/CaptureIDInfo/capabilities?format=json
Get the capability of collecting ID card information.

218
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-13 GET /ISAPI/AccessControl/CaptureIDInfo/capabilities?format=json
Method GET
Description Get the capability of collecting ID card information.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_IdentityInfoCap
Failed: JSON_ResponseStatus

5.12 /ISAPI/AccessControl/CaptureIDInfo?format=json
Collect ID card information.

Request URL Definition

Table 4-14 POST /ISAPI/AccessControl/CaptureIDInfo?format=json
Method POST
Description Collect ID card information.
Query security: the version No. of encryption scheme. When security does
not exist, it indicates that the data is not encrypted; when security is
1, it indicates that the nodes of sensitive information in the message
are encrypted in AES128 CBC mode; when security is 2, it indicates
that the nodes of sensitive information in the message are encrypted
in AES256 CBC mode.
iv: the initialization vector, and it is required when security is 1 or 2.
format: determine the format of request or response message.
Request JSON_IdentityInfoCond
Response JSON_IdentityInfo

5.13 /ISAPI/AccessControl/CapturePresetParam/capabilities?
format=json
Get the configuration capability of online collection preset parameters.

219
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-15 GET /ISAPI/AccessControl/CapturePresetParam/capabilities?format=json
Method GET
Description Get the configuration capability of online collection preset
parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CapturePresetCap
Failed: JSON_ResponseStatus

5.14 /ISAPI/AccessControl/CapturePresetParam?format=json
Get or set the online collection preset parameters.

Request URL Definition

Table 4-16 GET /ISAPI/AccessControl/CapturePresetParam?format=json
Method GET
Description Get the online collection preset parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CapturePreset
Failed: JSON_ResponseStatus
Table 4-17 PUT /ISAPI/AccessControl/CapturePresetParam?format=json
Method PUT
Description Set the online collection preset parameters.
Query format: determine the format of request or response message.
Request JSON_CapturePreset
Response JSON_ResponseStatus

5.15 /ISAPI/AccessControl/CaptureRule/capabilities?format=json
Get the configuration capability of online collection rules.

220
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-18 GET /ISAPI/AccessControl/CaptureRule/capabilities?format=json
Method GET
Description Get the configuration capability of online collection rules.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CaptureRuleCap
Failed: JSON_ResponseStatus

5.16 /ISAPI/AccessControl/CaptureRule?format=json
Get or set the parameters of online collection rules.

Request URL Definition

Table 4-19 GET /ISAPI/AccessControl/CaptureRule?format=json
Method GET
Description Get the parameters of online collection rules.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CaptureRule
Failed: JSON_ResponseStatus
Table 4-20 PUT /ISAPI/AccessControl/CaptureRule?format=json
Method PUT
Description Set the parameters of online collection rules.
Query format: determine the format of request or response message.
Request JSON_CaptureRule
Response JSON_ResponseStatus

5.17 /ISAPI/AccessControl/CardInfo/capabilities?format=json
Get the card management capability.

221
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-21 GET /ISAPI/AccessControl/CardInfo/capabilities?format=json
Method GET
Description Get the card management capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_CardInfo
Failed: JSON_ResponseStatus

5.18 /ISAPI/AccessControl/CardInfo/Count?format=json
Get the total number of the added cards.

Request URL Definition

Table 4-22 GET /ISAPI/AccessControl/CardInfo/Count?format=json
Method GET
Description Get the total number of the added cards.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CardInfoCount
Failed: JSON_ResponseStatus

5.19 /ISAPI/AccessControl/CardInfo/Count?
format=json&employeeNo=<ID>
Get the number of cards linked with a specific person.

Request URL Definition

Table 4-23 GET /ISAPI/AccessControl/CardInfo/Count?format=json&employeeNo=<ID>
Method GET
Description Get the number of cards linked with a specific person.
Query format: determine the format of request or response message.

222
 Device Network SDK (Access Control on Person) Developer Guide

employeeNo: employee No.

Request None.
Response Succeeded: JSON_CardInfoCount
Failed: JSON_ResponseStatus

Remarks
The <ID> in the request URL refers to the actual person ID or employee No.

5.20 /ISAPI/AccessControl/CardInfo/Delete?format=json
Delete cards.

Request URL Definition

Table 4-24 PUT /ISAPI/AccessControl/CardInfo/Delete?format=json
Method PUT
Description Delete cards.
Query format: determine the format of request or response message.
Request JSON_CardInfoDelCond
Response JSON_ResponseStatus

5.21 /ISAPI/AccessControl/CardInfo/Modify?format=json
Edit card information.

Request URL Definition

Table 4-25 PUT /ISAPI/AccessControl/CardInfo/Modify?format=json
Method PUT
Description Edit card information.
Query format: determine the format of request or response message.
Request JSON_CardInfo
Response JSON_ResponseStatus

223
 Device Network SDK (Access Control on Person) Developer Guide

5.22 /ISAPI/AccessControl/CardInfo/Record?format=json
Add cards and link them with a person.

Request URL Definition

Table 4-26 POST /ISAPI/AccessControl/CardInfo/Record?format=json
Method POST
Description Add cards and link them with a person.
Query format: determine the format of request or response message.
Request JSON_CardInfo
Response JSON_ResponseStatus

5.23 /ISAPI/AccessControl/CardInfo/Search?format=json
Search for cards.

Request URL Definition

Table 4-27 POST /ISAPI/AccessControl/CardInfo/Search?format=json
Method POST
Description Search for cards.
Query format: determine the format of request or response message.
Request JSON_CardInfoSearchCond
Response JSON_CardInfoSearch

5.24 /ISAPI/AccessControl/CardInfo/SetUp?format=json
Set card information.

Request URL Definition

Table 4-28 PUT /ISAPI/AccessControl/CardInfo/SetUp?format=json
Method PUT
Description Set card information.
Query format: determine the format of request or response message.

224
 Device Network SDK (Access Control on Person) Developer Guide

Request JSON_CardInfo
Response JSON_ResponseStatus

Remarks
• If the device has checked that the card does not exist according to the card No., the card
information will be added.
• If the device has checked that the card already exists according to the card No., the card
information will be edited.
• If you want to delete a card for a person, you should set the employeeNo and cardNo, and set
the deleteCard to "true" in the message JSON_CardInfo . The success response message will be
returned no matter whether the card exists or not. Deleting the card will only delete the card's
information and will not delete the linked person information.
• If you want to delete all cards for a person, you should set the employeeNo, and set the
deleteCard to "true" in the message JSON_CardInfo . The success response message will be
returned no matter whether the person exists or not or whether the person has cards or not.
Deleting cards will only delete the cards' information and will not delete the linked person
information.

5.25 /ISAPI/AccessControl/CardOperations/capabilities?format=json
Get card operation capability.

Request URL Definition

Table 4-29 GET /ISAPI/AccessControl/CardOperations/capabilities?format=json
Method GET
Description Get card operation capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CardOperationsCap
Failed: JSON_ResponseStatus

5.26 /ISAPI/AccessControl/CardOperations/cardParam?format=json
Set card parameters (only available for CPU card).

225
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-30 PUT /ISAPI/AccessControl/CardOperations/cardParam?format=json
Method PUT
Description Set card parameters (only available for CPU card).
Query format: determine the format of request or response message.
Request JSON_CardParam
Response JSON_ResponseStatus

5.27 /ISAPI/AccessControl/CardOperations/controlBlock?format=json
Change the control block of a specific section (only available for M1 card).

Request URL Definition

Table 4-31 PUT /ISAPI/AccessControl/CardOperations/controlBlock?format=json
Method PUT
Description Change the control block of a specific section (only available for M1
card).
Query format: determine the format of request or response message.
Request JSON_ControlBlock
Response JSON_ResponseStatus

5.28 /ISAPI/AccessControl/CardOperations/dataBlock/<address>?
format=json
Read or write data block (only available for M1 card).

Request URL Definition

Table 4-32 GET /ISAPI/AccessControl/CardOperations/dataBlock/<address>?format=json
Method GET
Description Read data block (only available for M1 card).
Query format: determine the format of request or response message.

226
 Device Network SDK (Access Control on Person) Developer Guide

Request None.
Response Succeeded: JSON_DataBlock
Failed: JSON_ResponseStatus
Table 4-33 PUT /ISAPI/AccessControl/CardOperations/dataBlock/<address>?format=json
Method PUT
Description Write data block (only available for M1 card).
Query format: determine the format of request or response message.
Request JSON_DataBlock
Response JSON_ResponseStatus

Remarks
The <address> in the request URL refers to the block address, which is same as that in
JSON_DataBlock .

5.29 /ISAPI/AccessControl/CardOperations/dataBlock/control?
format=json
Do operations (i.e., plus, minus, copy, and paste) on the data block.

Request URL Definition

Table 4-34 PUT /ISAPI/AccessControl/CardOperations/dataBlock/control?format=json
Method PUT
Description Do operations (i.e., plus, minus, copy, and paste) on the data block.
Query format: determine the format of request or response message.
Request JSON_DataBlockCtrl
Response JSON_ResponseStatus

5.30 /ISAPI/AccessControl/CardOperations/dataTrans?format=json
Pass through the data package (only available for CPU card).

227
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-35 PUT /ISAPI/AccessControl/CardOperations/dataTrans?format=json
Method PUT
Description Pass through the data package (only available for CPU card).
Query format: determine the format of request or response message.
Request JSON_DataTrans
Response JSON_ResponseStatus

5.31 /ISAPI/AccessControl/CardOperations/encryption?format=json
Set card encryption parameters (only available for CPU card).

Request URL Definition

Table 4-36 PUT /ISAPI/AccessControl/CardOperations/encryption?format=json
Method PUT
Description Set card encryption parameters (only available for CPU card).
Query format: determine the format of request or response message.
Request JSON_CardEncryption
Response JSON_ResponseStatus and tryTimes field (card encryption attampts)

5.32 /ISAPI/AccessControl/CardOperations/protocol?format=json
Set operation protocol type for the card (only available when applying card).

Request URL Definition

Table 4-37 PUT /ISAPI/AccessControl/CardOperations/protocol?format=json
Method PUT
Description Set operation protocol type for the card (only available when
applying card).
Query format: determine the format of request or response message.
Request JSON_CardProto
Response JSON_ResponseStatus

228
 Device Network SDK (Access Control on Person) Developer Guide

5.33 /ISAPI/AccessControl/CardOperations/reset?format=json
Reset card parameters (only available for CPU card).

Request URL Definition

Table 4-38 GET /ISAPI/AccessControl/CardOperations/reset?format=json
Method GET
Description Reset card parameters (only available for CPU card).
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CardResetResponse
Failed: JSON_ResponseStatus

5.34 /ISAPI/AccessControl/CardOperations/sectionEncryption?
format=json
Set the encryption parameters of a specific section (only available for M1 card).

Request URL Definition

Table 4-39 PUT /ISAPI/AccessControl/CardOperations/sectionEncryption?format=json
Method PUT
Description Set the encryption parameters of a specific section (only available for
M1 card).
Query format: determine the format of request or response message.
Request JSON_SectionEncryption
Response JSON_ResponseStatus

5.35 /ISAPI/AccessControl/CardOperations/verification?format=json
Verify the password of the encrypted section (only available for M1 card).

229
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-40 PUT /ISAPI/AccessControl/CardOperations/verification?format=json
Method PUT
Description Verify the password of the encrypted section (only available for M1
card).
Query format: determine the format of request or response message.
Request JSON_Verification
Response JSON_ResponseStatus

5.36 /ISAPI/AccessControl/ClearCardRecord
Clear card swiping records in the cross-controller anti-passing back server.

Request URL Definition

Table 4-41 PUT /ISAPI/AccessControl/ClearCardRecord
Method PUT
Description Clear card swiping records in the cross-controller anti-​passing back
server.
Query None.
Request XML_ClearCardRecord
Response XML_ResponseStatus

Remarks
This request URL can only be used by the cross-controller anti-passing back server, and it is not
supported by the cross-controller anti-passing back devices based on card mode.

5.37 /ISAPI/AccessControl/ClearCardRecord/capabilities
Get the capability of clearing card swiping records in the cross-controller anti-passing back server.

230
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-42 GET /ISAPI/AccessControl/ClearCardRecord/capabilities
Method GET
Description Get the capability of clearing card swiping records in the cross-
controller anti-​passing back server.
Query None.
Request None.
Response Succeeded: XML_Cap_ClearCardRecord
Failed: XML_ResponseStatus

5.38 /ISAPI/AccessControl/ClearSubmarineBack
Clear cross-controller anti-passing back parameters.

Request URL Definition

Table 4-43 PUT /ISAPI/AccessControl/ClearSubmarineBack
Method PUT
Description Clear cross-controller anti-​passing back parameters.
Query None.
Request XML_ClearSubmarineBack
Response XML_ResponseStatus

5.39 /ISAPI/AccessControl/ClearSubmarineBack/capabilities
Get the capability of clearing cross-controller anti-passing back parameters.

Request URL Definition

Table 4-44 GET /ISAPI/AccessControl/ClearSubmarineBack/capabilities
Method GET
Description Get the capability of clearing cross-controller anti-​passing back
parameters.
Query None.

231
 Device Network SDK (Access Control on Person) Developer Guide

Request None.
Response Succeeded: XML_Cap_ClearSubmarineBack
Failed: XML_ResponseStatus

5.40 /ISAPI/AccessControl/Configuration/IRCfg/capabilities?format=json
Get active infrared intrusion capability.

Request URL Definition

Table 4-45 GET /ISAPI/AccessControl/Configuration/IRCfg/capabilities?format=json
Method GET
Description Get active infrared intrusion capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_IRCfgCap
Failed: JSON_ResponseStatus

5.41 /ISAPI/AccessControl/Configuration/IRCfg?format=json
Get or set active infrared intrusion parameters.

Request URL Definition

Table 4-46 GET /ISAPI/AccessControl/Configuration/IRCfg?format=json
Method GET
Description Get active infrared intrusion parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_IRCfg
Failed: JSON_ResponseStatus
Table 4-47 PUT /ISAPI/AccessControl/Configuration/IRCfg?format=json
Method PUT
Description Set active infrared intrusion parameters.
Query format: determine the format of request or response message.

232
 Device Network SDK (Access Control on Person) Developer Guide

Request JSON_IRCfg
Response JSON_ResponseStatus

5.42 /ISAPI/AccessControl/Configuration/NFCCfg/capabilities?
format=json
Get the configuration capability of enabling NFC (Near-Field Communication) function.

Request URL Definition

Table 4-48 GET /ISAPI/AccessControl/Configuration/NFCCfg/capabilities?format=json
Method GET
Description Get the configuration capability of enabling NFC (Near-Field
Communication) function.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_NFCCfgCap
Failed: JSON_ResponseStatus

5.43 /ISAPI/AccessControl/Configuration/NFCCfg?format=json
Operations about the configuration of enabling NFC (Near-Field Communication) function.

Request URL Definition

Table 4-49 GET /ISAPI/AccessControl/Configuration/NFCCfg?format=json
Method GET
Description Get the parameters of enabling NFC (Near-Field Communication)
function.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_NFCCfg
Failed: JSON_ResponseStatus

233
 Device Network SDK (Access Control on Person) Developer Guide

Table 4-50 PUT /ISAPI/AccessControl/Configuration/NFCCfg?format=json

Method PUT
Description Set the parameters of enabling NFC (Near-Field Communication)
function.
Query format: determine the format of request or response message.
Request JSON_NFCCfg
Response JSON_ResponseStatus

5.44 /ISAPI/AccessControl/Configuration/RFCardCfg/capabilities?
format=json
Get the configuration capability of enabling RF (Radio Frequency) card recognition.

Request URL Definition

Table 4-51 GET /ISAPI/AccessControl/Configuration/RFCardCfg/capabilities?format=json
Method GET
Description Get the configuration capability of enabling RF (Radio Frequency)
card recognition.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_RFCardCfgCap
Failed: JSON_ResponseStatus

5.45 /ISAPI/AccessControl/Configuration/RFCardCfg?format=json
Operations about the configuration of enabling RF (Radio Frequency) card recognition.

Request URL Definition

Table 4-52 GET /ISAPI/AccessControl/Configuration/RFCardCfg?format=json
Method GET
Description Get the parameters of enabling RF (Radio Frequency) card
recognition.
Query format: determine the format of request or response message.

234
 Device Network SDK (Access Control on Person) Developer Guide

Request None.
Response Succeeded: JSON_RFCardCfg
Failed: JSON_ResponseStatus
Table 4-53 PUT /ISAPI/AccessControl/Configuration/RFCardCfg?format=json
Method PUT
Description Set the parameters of enabling RF (Radio Frequency) card
recognition.
Query format: determine the format of request or response message.
Request JSON_RFCardCfg
Response JSON_ResponseStatus

5.46 /ISAPI/AccessControl/DeployInfo
Get the arming information (e.g., arming types).

Request URL Definition

Table 4-54 GET /ISAPI/AccessControl/DeployInfo
Method GET
Description Get the arming information (e.g., arming types).
Query None.
Request None.
Response Succeeded: XML_DeployInfo
Failed: XML_ResponseStatus

Remarks
The client arming supports arming of only one channel and can upload offline events. The real-
time arming is used for other devices to arm the access control devices, which supports arming of
up to four channels and cannot upload offline events.

5.47 /ISAPI/AccessControl/DeployInfo/capabilities
Get the capability of getting arming information.

235
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-55 GET /ISAPI/AccessControl/DeployInfo/capabilities
Method GET
Description Get the capability of getting arming information.
Query None.
Request None.
Response Succeeded: XML_Cap_DeployInfo
Failed: XML_ResponseStatus

5.48 /ISAPI/AccessControl/EventOptimizationCfg/capabilities?
format=json
Get the configuration capability of event optimization.

Request URL Definition

Table 4-56 GET /ISAPI/AccessControl/EventOptimizationCfg/capabilities?format=json
Method GET
Description Get the configuration capability of event optimization.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_EventOptimizationCfg
Failed: JSON_ResponseStatus

5.49 /ISAPI/AccessControl/EventOptimizationCfg?format=json
Operations about the event optimization configuration.

Request URL Definition

Table 4-57 GET /ISAPI/AccessControl/EventOptimizationCfg?format=json
Method GET
Description Get the event optimization configuration parameters.
Query format: determine the format of request or response message.

236
 Device Network SDK (Access Control on Person) Developer Guide

Request None.
Response Succeeded: JSON_EventOptimizationCfg
Failed: JSON_ResponseStatus
Table 4-58 PUT /ISAPI/AccessControl/EventOptimizationCfg?format=json
Method PUT
Description Set the event optimization parameters.
Query format: determine the format of request or response message.
Request JSON_EventOptimizationCfg
Response JSON_ResponseStatus

5.50 /ISAPI/AccessControl/FaceCompareCond
Get or set the condition parameters of face picture comparison.

Request URL Definition

Table 4-59 GET /ISAPI/AccessControl/FaceCompareCond
Method GET
Description Get the condition parameters of face picture comparison.
Query None.
Request None.
Response Succeeded: XML_FaceCompareCond
Failed: XML_ResponseStatus
Table 4-60 PUT /ISAPI/AccessControl/FaceCompareCond
Method PUT
Description Set the condition parameters of face picture comparison.
Query None.
Request XML_FaceCompareCond
Response XML_ResponseStatus

5.51 /ISAPI/AccessControl/FaceCompareCond/capabilities
Get condition configuration capability of face picture comparison.

237
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-61 GET /ISAPI/AccessControl/FaceCompareCond/capabilities
Method GET
Description Get condition configuration capability of face picture comparison.
Query None.
Request None.
Response Succeeded: XML_Cap_FaceCompareCond
Failed: XML_ResponseStatus

5.52 /ISAPI/AccessControl/FaceRecognizeMode/capabilities?
format=json
Get the configuration capability of the facial recognition mode.

Request URL Definition

Table 4-62 GET /ISAPI/AccessControl/FaceRecognizeMode/capabilities?format=json
Method GET
Description Get the configuration capability of the facial recognition mode.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_FaceRecognizeMode
Failed: JSON_ResponseStatus

Remarks
Switching facial recognition mode will clear face permission information in the device.

5.53 /ISAPI/AccessControl/FaceRecognizeMode?format=json
Operations about the configuration of the facial recognition mode.

238
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-63 GET /ISAPI/AccessControl/FaceRecognizeMode?format=json
Method GET
Description Get the parameters of the facial recognition mode.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_FaceRecognizeMode
Failed: JSON_ResponseStatus
Table 4-64 PUT /ISAPI/AccessControl/FaceRecognizeMode?format=json
Method PUT
Description Set the parameters of the facial recognition mode.
Query format: determine the format of request or response message.
Request JSON_FaceRecognizeMode
Response JSON_ResponseStatus

Remarks
Switching facial recognition mode will clear face permission information in the device.

5.54 /ISAPI/AccessControl/FingerPrint/DeleteProcess?format=json
Get the progress of deleting fingerprint data.

Request URL Definition

Table 4-65 GET /ISAPI/AccessControl/FingerPrint/DeleteProcess?format=json
Method GET
Description Get the progress of deleting fingerprint data.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_FingerPrintDeleteProcess
Failed: JSON_ResponseStatus

239
 Device Network SDK (Access Control on Person) Developer Guide

Remarks
When starting deleting fingerprint data, this URL will be repeatedly called to get the deleting
progress until "success" or "failed" is returned by the parameter status in the message
JSON_FingerPrintDeleteProcess .

5.55 /ISAPI/AccessControl/FingerPrint/Delete/capabilities?format=json
Get the capability of deleting fingerprint data.

Request URL Definition

Table 4-66 GET /ISAPI/AccessControl/FingerPrint/Delete/capabilities?format=json
Method GET
Description Get the capability of deleting fingerprint data.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_FingerPrintDelete
Failed: JSON_ResponseStatus

5.56 /ISAPI/AccessControl/FingerPrint/Delete?format=json
Start deleting the fingerprint data.

Request URL Definition

Table 4-67 PUT /ISAPI/AccessControl/FingerPrint/Delete?format=json
Method PUT
Description Start deleting the fingerprint data.
Query format: determine the format of request or response message.
Request JSON_FingerPrintDelete
Response JSON_ResponseStatus

Remarks
This URL is only used to start deleting. To judge whether the deleting is completed, you should call
the request URL /ISAPI/AccessControl/FingerPrint/DeleteProcess?format=json by GET method to
get the deleting status.

240
 Device Network SDK (Access Control on Person) Developer Guide

5.57 /ISAPI/AccessControl/FingerPrint/SetUp?format=json
Set the fingerprint parameters.

Request URL Definition

Table 4-68 POST /ISAPI/AccessControl/FingerPrint/SetUp?format=json
Method POST
Description Set the fingerprint parameters.
Query format: determine the format of request or response message.
Request JSON_FingerPrintCfg
Response JSON_FingerPrintStatus

Remarks
• If the fingerData is not applied, it indicates editing fingerprint parameters instead of applying
fingerprint data to the fingerprint module.
• If the fingerData is applied, the fingerprint data will be added if it does not exist in the
fingerprint module, or the original fingerprint data will be overwritten if it already exists in the
fingerprint module.
• There are four different methods for deleting one or more fingerprints:
• To delete a specific fingerprint in a specific fingerprint module linked with a specific employee
No., the employeeNo, enableCardReader, fingerPrintID, and deleteFingerPrint in the
message JSON_FingerPrintCfg should be configured, and the success response message will
be returned no matter whether the fingerprint exists or not.
• To delete a specific fingerprint in all fingerprint modules linked with a specific employee No.,
the employeeNo, fingerPrintID, and deleteFingerPrint in the message JSON_FingerPrintCfg
should be configured, and the success response message will be returned no matter whether
the fingerprints exist or not.
• To delete all fingerprints in a specific fingerprint module linked with a specific employee No.,
the employeeNo, enableCardReader, and deleteFingerPrint in the message
JSON_FingerPrintCfg should be configured, and the success response message will be
returned no matter whether the fingerprints exist or not.
• To delete all fingerprints in all fingerprint modules linked with a specific employee No., the
employeeNo and deleteFingerPrint in the message JSON_FingerPrintCfg should be
configured, and the success response message will be returned no matter whether the
fingerprints exist or not.

241
 Device Network SDK (Access Control on Person) Developer Guide

5.58 /ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json
Get the configuration capability of fingerprint parameters.

Request URL Definition

Table 4-69 GET /ISAPI/AccessControl/FingerPrintCfg/capabilities?format=json
Method GET
Description Get the configuration capability of fingerprint parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_FingerPrintCfg
Failed: JSON_ResponseStatus

5.59 /ISAPI/AccessControl/FingerPrintDownload?format=json
Set fingerprint parameters to link with a person, and apply the collected fingerprint data.

Request URL Definition

Table 4-70 POST /ISAPI/AccessControl/FingerPrintDownload?format=json
Method POST
Description Set fingerprint parameters to link with a person, and apply the
collected fingerprint data.
Query format: determine the format of request or response message.
Request JSON_FingerPrintCfg +fingerprint data (by boundary method)
Response JSON_ResponseStatus

Remarks
This URL is only used to start applying the fingerprint data. To check whether the applying is
completed, you should call the request URL /ISAPI/AccessControl/FingerPrintProgress?
format=json by GET method to get the applying status.

5.60 /ISAPI/AccessControl/FingerPrintModify?format=json
Edit fingerprint parameters.

242
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-71 POST /ISAPI/AccessControl/FingerPrintModify?format=json
Method POST
Description Edit fingerprint parameters.
Query format: determine the format of request or response message.
Request JSON_FingerPrintModify
Response JSON_ResponseStatus

Remarks
Only the fingerprint parameters can be edited. The collected fingerprint data will not be edited and
applied.

5.61 /ISAPI/AccessControl/FingerPrintProgress?format=json
Get the progress of applying fingerprint data.

Request URL Definition

Table 4-72 GET /ISAPI/AccessControl/FingerPrintProgress?format=json
Method GET
Description Get the progress of applying fingerprint data.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_FingerPrintStatus
Failed: JSON_ResponseStatus

Remarks
When starting applying fingerprint data, this URL will be repeatedly called to get the applying
progress until "1" is returned by the parameter totalStatus in the message
JSON_FingerPrintStatus .

5.62 /ISAPI/AccessControl/FingerPrintUpload?format=json
Get the fingerprint information, including fingerprint parameters and data.

243
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-73 POST /ISAPI/AccessControl/FingerPrintUpload?format=json
Method POST
Description Get the fingerprint information, including fingerprint parameters and
data.
Query format: determine the format of request or response message.
Request JSON_FingerPrintCond
Response JSON_FingerPrintInfo +fingerprint data (by boundary method)

Remarks
• To get the information of a specific fingerprint, the searchID, employeeNo, cardReaderNo, and
fingerPrintID in the message JSON_FingerPrintCond should be configured. If the fingerprint
matching the search conditions exists, the status will be set to "OK" and the corresponding
fingerprint information will be returned by FingerPrintList in the message
JSON_FingerPrintInfo ; otherwise, the status will be set to "NoFP" and the FingerPrintList will be
set to NULL in the message JSON_FingerPrintInfo .
• To get all fingerprints linked with a specific employee No. (person ID), the searchID and
employeeNo in the message JSON_FingerPrintCond should be configured. If the fingerprints
matching the search conditions exist, the status will be set to "OK" and the corresponding
fingerprint information will be returned by FingerPrintList in the message
JSON_FingerPrintInfo . The request URL /ISAPI/AccessControl/FingerPrintUpload?format=json
will be repeatedly called by POST method to get the information of multiple fingerprints
matching the search conditions until "NoFP" is returned by status in the message
JSON_FingerPrintInfo (it indicates that information of all fingerprints matching the search
conditions are obtained). If there is no fingerprint matching the search conditions, the status will
be set to "NoFP" and the FingerPrintList will be set to NULL in the message
JSON_FingerPrintInfo .

5.63 /ISAPI/AccessControl/GetAcsEvent/capabilities
Get capability of getting access control event.

Request URL Definition

Table 4-74 GET /ISAPI/AccessControl/GetAcsEvent/capabilities
Method GET
Description Get capability of getting access control event.
Query None.

244
 Device Network SDK (Access Control on Person) Developer Guide

Request None.
Response XML_Cap_GetAcsEvent

5.64 /ISAPI/AccessControl/IdentityTerminal
Operations about configuration of intelligent identity recognition terminal.

Request URL Definition

Table 4-75 GET /ISAPI/AccessControl/IdentityTerminal
Method GET
Description Get the configuration parameters of intelligent identity recognition
terminal.
Query None.
Request None.
Response Succeeded: XML_IdentityTerminal
Failed: XML_ResponseStatus
Table 4-76 PUT /ISAPI/AccessControl/IdentityTerminal
Method PUT
Description Set the parameters of intelligent identity recognition terminal.
Query None.
Request XML_IdentityTerminal
Response XML_ResponseStatus

5.65 /ISAPI/AccessControl/IdentityTerminal/capabilities
Get configuration capability of intelligent identity recognition terminal.

Request URL Definition

Table 4-77 GET /ISAPI/AccessControl/IdentityTerminal/capabilities
Method GET
Description Get configuration capability of intelligent identity recognition
terminal.
Query None.

245
 Device Network SDK (Access Control on Person) Developer Guide

Request None.
Response Succeeded: XML_Cap_IdentityTerminal
Failed: XML_ResponseStatus

5.66 /ISAPI/AccessControl/LogModeCfg/capabilities?format=json
Get the configuration capability of the log mode.

Request URL Definition

Table 4-78 GET /ISAPI/AccessControl/LogModeCfg/capabilities?format=json
Method GET
Description Get the configuration capability of the log mode.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_LogModeCfg
Failed: JSON_ResponseStatus

5.67 /ISAPI/AccessControl/LogModeCfg?format=json
Operations about the log mode configuration.

Request URL Definition

Table 4-79 GET /ISAPI/AccessControl/LogModeCfg?format=json
Method GET
Description Get the log mode configuration parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_LogModeCfg
Failed: JSON_ResponseStatus
Table 4-80 PUT /ISAPI/AccessControl/LogModeCfg?format=json
Method PUT
Description Set the log mode parameters.
Query format: determine the format of request or response message.

246
 Device Network SDK (Access Control on Person) Developer Guide

Request JSON_LogModeCfg
Response JSON_ResponseStatus

5.68 /ISAPI/AccessControl/OfflineCapture/capabilities?format=json
Get the online collection capability.

Request URL Definition

Table 4-81 GET /ISAPI/AccessControl/OfflineCapture/capabilities?format=json
Method GET
Description Get the online collection capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_OfflineCaptureCap
Failed: JSON_ResponseStatus

5.69 /ISAPI/AccessControl/OfflineCapture/DataCollections/
<captureNo>?format=json
Deleted a specific piece of offline collected data.

Request URL Definition

Table 4-82 DELETE /ISAPI/AccessControl/OfflineCapture/DataCollections/<captureNo>?
format=json
Method DELETE
Description Deleted a specific piece of offline collected data.
Query format: determine the format of request or response message.
Request None.
Response JSON_ResponseStatus

Remarks
The <captureNo> in the request URL refers to the collection No.

247
 Device Network SDK (Access Control on Person) Developer Guide

5.70 /ISAPI/AccessControl/OfflineCapture/DataCollections/searchTask?
format=json
Search for the collection data.

Request URL Definition

Table 4-83 POST /ISAPI/AccessControl/OfflineCapture/DataCollections/searchTask?format=json
Method POST
Description Search for the collection data.
Query format: determine the format of request or response message.
Request JSON_SearchTaskCond
Response Succeeded: JSON_SearchTaskResponse
Failed: JSON_ResponseStatus

5.71 /ISAPI/AccessControl/OfflineCapture/DataCollections?format=json
Delete all offline collected data.

Request URL Definition

Table 4-84 DELETE /ISAPI/AccessControl/OfflineCapture/DataCollections?format=json
Method DELETE
Description Delete all offline collected data.
Query format: determine the format of request or response message.
Request None.
Response JSON_ResponseStatus

5.72 /ISAPI/AccessControl/OfflineCapture/dataOutput/progress?
format=json
Get the progress of exporting the offline collected data.

248
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-85 GET /ISAPI/AccessControl/OfflineCapture/dataOutput/progress?format=json
Method GET
Description Get the progress of exporting the offline collected data.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_DataOutputProgress
Failed: JSON_ResponseStatus

5.73 /ISAPI/AccessControl/OfflineCapture/dataOutput?format=json
Export the offline collected data.

Request URL Definition

Table 4-86 PUT /ISAPI/AccessControl/OfflineCapture/dataOutput?format=json
Method PUT
Description Export the offline collected data.
Query format: determine the format of request or response message.
Request JSON_DataOutputCfg
Response JSON_ResponseStatus

5.74 /ISAPI/AccessControl/OfflineCapture/progress?format=json
Get the offline collection progress.

Request URL Definition

Table 4-87 GET /ISAPI/AccessControl/OfflineCapture/progress?format=json
Method GET
Description Get the offline collection progress.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CaptureProgress

249
 Device Network SDK (Access Control on Person) Developer Guide

Failed: JSON_ResponseStatus

5.75 /ISAPI/AccessControl/OfflineCapture/ruleInfo?format=json
Get or set the parameters of offline collection rules.

Request URL Definition

Table 4-88 GET /ISAPI/AccessControl/OfflineCapture/ruleInfo?format=json
Method GET
Description Get the parameters of offline collection rules.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_RuleInfo
Failed: JSON_ResponseStatus
Table 4-89 PUT /ISAPI/AccessControl/OfflineCapture/ruleInfo?format=json
Method PUT
Description Set the parameters of offline collection rules.
Query format: determine the format of request or response message.
Request JSON_RuleInfo
Response JSON_ResponseStatus

5.76 /ISAPI/AccessControl/UserInfo/capabilities?format=json
Get the person management capability.

Request URL Definition

Table 4-90 GET /ISAPI/AccessControl/UserInfo/capabilities?format=json
Method GET
Description Get the person management capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_UserInfo

250
 Device Network SDK (Access Control on Person) Developer Guide

Failed: JSON_ResponseStatus

5.77 /ISAPI/AccessControl/UserInfo/Count?format=json
Get the total number of the added persons.

Request URL Definition

Table 4-91 GET /ISAPI/AccessControl/UserInfo/Count?format=json
Method GET
Description Get the total number of the added persons.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_UserInfoCount
Failed: JSON_ResponseStatus

5.78 /ISAPI/AccessControl/UserInfo/Delete?format=json
Delete person information only.

Request URL Definition

Table 4-92 PUT /ISAPI/AccessControl/UserInfo/Delete?format=json
Method PUT
Description Delete person information only.
Query format: determine the format of request or response message.
Request JSON_UserInfoDelCond
Response JSON_ResponseStatus

5.79 /ISAPI/AccessControl/UserInfo/Modify?format=json
Edit person information.

251
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-93 PUT /ISAPI/AccessControl/UserInfo/Modify?format=json
Method PUT
Description Edit person information.
Query format: determine the format of request or response message.
Request JSON_UserInfo
Response JSON_ResponseStatus

5.80 /ISAPI/AccessControl/UserInfo/Record?format=json
Add a person.

Request URL Definition

Table 4-94 POST /ISAPI/AccessControl/UserInfo/Record?format=json
Method POST
Description Add a person.
Query format: determine the format of request or response message.
Request JSON_UserInfo
Response JSON_ResponseStatus

5.81 /ISAPI/AccessControl/UserInfo/Search?format=json
Search for person information.

Request URL Definition

Table 4-95 POST /ISAPI/AccessControl/UserInfo/Search?format=json
Method POST
Description Search for person information.
Query format: determine the format of request or response message.
Request JSON_UserInfoSearchCond
Response JSON_UserInfoSearch

252
 Device Network SDK (Access Control on Person) Developer Guide

Remarks
The Request (user information search condition JSON_UserInfoSearchCond ) depends on the user
information capability JSON_Cap_UserInfo (related node: <UserInfoSearchCond>).

5.82 /ISAPI/AccessControl/UserInfo/SetUp?format=json
Set person information.

Request URL Definition

Table 4-96 PUT /ISAPI/AccessControl/UserInfo/SetUp?format=json
Method PUT
Description Set person information.
Query format: determine the format of request or response message.
Request JSON_UserInfo
Response JSON_ResponseStatus

Remarks
• If the device has checked that the person does not exist according to the employee No. (person
ID), the person information will be added.
• If the device has checked that the person already exists according to the employee No. (person
ID), the person information will be edited.
• If a person needs to be deleted, the deleteUser in the message JSON_UserInfo should be set to
"true", and the success response message will be returned no matter whether the person
information exists or not. Deleting the person will only delete the person's information and will
not delete the linked cards, fingerprints, and face information.

5.83 /ISAPI/AccessControl/UserInfoDetail/Delete/capabilities?
format=json
Get the capability of deleting person information (including linked cards, fingerprints, and faces)
and permissions.

253
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-97 GET /ISAPI/AccessControl/UserInfoDetail/Delete/capabilities?format=json
Method GET
Description Get the capability of deleting person information (including linked
cards, fingerprints, and faces) and permissions.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_UserInfoDetail
Failed: JSON_ResponseStatus

5.84 /ISAPI/AccessControl/UserInfoDetail/Delete?format=json
Start deleting all person information and permissions by employee No.

Request URL Definition

Table 4-98 PUT /ISAPI/AccessControl/UserInfoDetail/Delete?format=json
Method PUT
Description Start deleting all person information (including linked cards,
fingerprints, and faces) and permissions by employee No.
Query format: determine the format of request or response message.
Request JSON_UserInfoDetail
Response JSON_ResponseStatus

Remarks
This URL is only used to start deleting. To check whether the deleting is completed, you should call
the request URL /ISAPI/AccessControl/UserInfoDetail/DeleteProcess?format=json by GET method
to get the deleting status.

5.85 /ISAPI/AccessControl/UserInfoDetail/DeleteProcess?format=json
Get the status of deleting all person information and permissions by employee No.

254
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-99 GET /ISAPI/AccessControl/UserInfoDetail/DeleteProcess?format=json
Method GET
Description Get the status of deleting all person information (including linked
cards, fingerprints, and faces) and permissions by employee No.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_UserInfoDetailDeleteProcess
Failed: JSON_ResponseStatus

Remarks
When starting deleting all person information (including linked cards, fingerprints, and faces) and
permissions by employee No., this URL will be repeatedly called to get the deleting status until
"success" or "failed" is returned by the parameter status in the message
JSON_UserInfoDetailDeleteProcess .

5.86 /ISAPI/AccessControl/RemoteControl/buzzer/<ID>?format=json
Remotely control the buzzer of the card reader.

Request URL Definition

Table 4-100 PUT /ISAPI/AccessControl/RemoteControl/buzzer/<ID>?format=json
Method PUT
Description Remotely control the buzzer of the card reader.
Query format: determine the format of request or response message.
Request JSON_RemoteControlBuzzer
Response JSON_ResponseStatus

Remarks
The <ID> in the request URL refers to the buzzer No., which is also the No. of the card reader. If the
<ID> is 65535, it refers to all buzzers (card readers).

255
 Device Network SDK (Access Control on Person) Developer Guide

5.87 /ISAPI/AccessControl/RemoteControl/buzzer/capabilities?
format=json
Get the capability of remotely controlling the buzzer of the card reader.

Request URL Definition

Table 4-101 GET /ISAPI/AccessControl/RemoteControl/buzzer/capabilities?format=json
Method GET
Description Get the capability of remotely controlling the buzzer of the card
reader.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_RemoteControlBuzzer
Failed: JSON_ResponseStatus

5.88 /ISAPI/AccessControl/OSDPModify/<ID>?format=json
Set the OSDP (Open Supervised Device Protocol) card reader ID.

Request URL Definition

Table 4-102 PUT /ISAPI/AccessControl/OSDPModify/<ID>?format=json
Method PUT
Description Set the OSDP (Open Supervised Device Protocol) card reader ID.
Query format: determine the format of request or response message.
Request JSON_OSDPModify
Response JSON_ResponseStatus

Remarks
The <ID> in the request URL refers to the original OSDP card reader ID which is between 0 and 126,
and 127 refers to broadcast.

5.89 /ISAPI/AccessControl/OSDPModify/capabilities?format=json
Get the capability of editing the OSDP (Open Supervised Device Protocol) card reader ID.

256
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-103 GET /ISAPI/AccessControl/OSDPModify/capabilities?format=json
Method GET
Description Get the capability of editing the OSDP (Open Supervised Device
Protocol) card reader ID.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_OSDPModify
Failed: JSON_ResponseStatus

5.90 /ISAPI/AccessControl/OSDPStatus/<ID>?format=json
Get the OSDP (Open Supervised Device Protocol) card reader status.

Request URL Definition

Table 4-104 GET /ISAPI/AccessControl/OSDPStatus/<ID>?format=json
Method GET
Description Get the OSDP (Open Supervised Device Protocol) card reader status.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_OSDPStatus
Failed: JSON_ResponseStatus

Remarks
The <ID> in the request URL refers to the OSDP card reader ID which is between 0 and 126, and
127 refers to broadcast. Limited by the device, the OSDP card reader status can only be obtained
one by one.

5.91 /ISAPI/AccessControl/OSDPStatus/capabilities?format=json
Get the capability of getting the OSDP (Open Supervised Device Protocol) card reader status.

257
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-105 GET /ISAPI/AccessControl/OSDPStatus/capabilities?format=json
Method GET
Description Get the capability of getting the OSDP (Open Supervised Device
Protocol) card reader status.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_OSDPStatus
Failed: JSON_ResponseStatus

5.92 /ISAPI/AccessControl/ReaderAcrossHost/capabilities
Get the configuration capability of cross-controller anti-passing back status of card readers.

Request URL Definition

Table 4-106 GET /ISAPI/AccessControl/ReaderAcrossHost/capabilities
Method GET
Description Get the configuration capability of cross-controller anti-​passing back
status of card readers.
Query None.
Request None.
Response Succeeded: XML_Cap_ReaderAcrossHost
Failed: XML_ResponseStatus

5.93 /ISAPI/AccessControl/ReaderAcrossHost
Operations about the cross-controller anti-passing back configuration of card readers.

Request URL Definition

Table 4-107 GET /ISAPI/AccessControl/ReaderAcrossHost
Method GET
Description Get the cross-controller anti-​passing back parameters of card
readers.

258
 Device Network SDK (Access Control on Person) Developer Guide

Query None.
Request None.
Response Succeeded: XML_ReaderAcrossHost
Failed: XML_ResponseStatus
Table 4-108 PUT /ISAPI/AccessControl/ReaderAcrossHost
Method PUT
Description Set the cross-controller anti-​passing back parameters of card readers.
Query None.
Request XML_ReaderAcrossHost
Response XML_ResponseStatus

5.94 /ISAPI/AccessControl/ServerDevice/capabilities
Get the configuration capability of cross-controller anti-passing back server information.

Request URL Definition

Table 4-109 GET /ISAPI/AccessControl/ServerDevice/capabilities
Method GET
Description Get the configuration capability of cross-controller anti-​passing back
server information.
Query None.
Request None.
Response Succeeded: XML_Cap_ServerDevice
Failed: XML_ResponseStatus

5.95 /ISAPI/AccessControl/ServerDevice
Operation about the configuration of cross-controller anti-passing back server information.

259
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-110 GET /ISAPI/AccessControl/ServerDevice
Method GET
Description Get the information (i.e., IP address and port No.) of the cross-
controller anti-​passing back server.
Query None.
Request None.
Response Succeeded: XML_ServerDevice
Failed: XML_ResponseStatus
Table 4-111 PUT /ISAPI/AccessControl/ServerDevice
Method PUT
Description Set the information (i.e., IP address and port No.) of the cross-
controller anti-​passing back server.
Query None.
Request XML_ServerDevice
Response XML_ResponseStatus

5.96 /ISAPI/AccessControl/SubmarineBackMode/capabilities
Get the configuration capability of cross-controller anti-passing back mode and rule.

Request URL Definition

Table 4-112 GET /ISAPI/AccessControl/SubmarineBackMode/capabilities
Method GET
Description Get the configuration capability of cross-controller anti-​passing back
mode and rule.
Query None.
Request None.
Response Succeeded: XML_Cap_SubmarineBackMode
Failed: XML_ResponseStatus

260
 Device Network SDK (Access Control on Person) Developer Guide

5.97 /ISAPI/AccessControl/SubmarineBackReader/capabilities
Get the configuration capability of card readers for cross-controller anti-passing back.

Request URL Definition

Table 4-113 GET /ISAPI/AccessControl/SubmarineBackReader/capabilities
Method GET
Description Get the configuration capability of card readers for cross-controller
anti-​passing back.
Query None.
Request None.
Response Succeeded: XML_Cap_SubmarineBackReader
Failed: XML_ResponseStatus

5.98 /ISAPI/AccessControl/SubmarineBackMode
Operations about the configuration of cross-controller anti-passing back mode and rule.

Request URL Definition

Table 4-114 GET /ISAPI/AccessControl/SubmarineBackMode
Method GET
Description Get the parameters of cross-controller anti-​passing back mode and
rule.
Query None.
Request None.
Response Succeeded: XML_SubmarineBackMode
Failed: XML_ResponseStatus
Table 4-115 PUT /ISAPI/AccessControl/SubmarineBackMode
Method PUT
Description Set the parameters of cross-controller anti-​passing back mode and
rule.
Query None.

261
 Device Network SDK (Access Control on Person) Developer Guide

Request XML_SubmarineBackMode
Response XML_ResponseStatus

5.99 /ISAPI/AccessControl/SubmarineBackReader/ConfigureNo/<ID>
Operations about the configuration of card readers for cross-controller anti-passing back.

Request URL Definition

Table 4-116 GET /ISAPI/AccessControl/SubmarineBackReader/ConfigureNo/<ID>
Method GET
Description Get the parameters of card readers for cross-controller anti-​passing
back.
Query None.
Request None.
Response Succeeded: XML_SubmarineBackReader
Failed: XML_ResponseStatus
Table 4-117 PUT /ISAPI/AccessControl/SubmarineBackReader/ConfigureNo/<ID>
Method PUT
Description Set the parameters of card readers for cross-controller anti-​passing
back.
Query None.
Request XML_SubmarineBackReader
Response XML_ResponseStatus

Remarks
The <ID> in the request URL refers to the configuration No., which is between 1 and 128.

5.100 /ISAPI/AccessControl/StartReaderInfo/capabilities
Get the configuration capability of the first card reader.

262
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-118 GET /ISAPI/AccessControl/StartReaderInfo/capabilities
Method GET
Description Get the configuration capability of the first card reader.
Query None.
Request None.
Response Succeeded: XML_Cap_StartReaderInfo
Failed: XML_ResponseStatus

5.101 /ISAPI/AccessControl/StartReaderInfo
Operations about first card reader configurations.

Request URL Definition

Table 4-119 GET /ISAPI/AccessControl/StartReaderInfo
Method GET
Description Get the configuration parameters of first card reader.
Query None.
Request None.
Response XML_StartReaderInfo
Table 4-120 PUT /ISAPI/AccessControl/StartReaderInfo
Method PUT
Description Set the parameters of first card reader.
Query None.
Request XML_StartReaderInfo
Response XML_ResponseStatus

5.102 /ISAPI/AccessControl/SubmarineBackHostInfo/capabilities
Get the configuration capability of access controllers for cross-controller anti-passing back.

263
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-121 GET /ISAPI/AccessControl/SubmarineBackHostInfo/capabilities
Method GET
Description Get the configuration capability of access controllers for cross-
controller anti-​passing back.
Query None.
Request None.
Response Succeeded: XML_Cap_SubmarineBackHostInfo
Failed: XML_ResponseStatus

5.103 /ISAPI/AccessControl/SubmarineBack/capabilities
Get the configuration capability of the cross-controller anti-passing back server.

Request URL Definition

Table 4-122 GET /ISAPI/AccessControl/SubmarineBack/capabilities
Method GET
Description Get the configuration capability of the cross-controller anti-​passing
back server.
Query None.
Request None.
Response Succeeded: XML_Cap_SubmarineBack
Failed: XML_ResponseStatus

5.104 /ISAPI/AccessControl/SubmarineBackHostInfo/ConfigureNo/<ID>
Operations about the configuration of access controllers for cross-controller anti-passing back.

Request URL Definition

Table 4-123 GET /ISAPI/AccessControl/SubmarineBackHostInfo/ConfigureNo/<ID>
Method GET
Description Get the parameters of access controllers for cross-controller anti-
passing back.

264
 Device Network SDK (Access Control on Person) Developer Guide

Query None.
Request None.
Response Succeeded: XML_SubmarineBackHostInfo
Failed: XML_ResponseStatus
Table 4-124 PUT /ISAPI/AccessControl/SubmarineBackHostInfo/ConfigureNo/<ID>
Method PUT
Description Set the parameters of access controllers for cross-controller anti-
passing back.
Query None.
Request XML_SubmarineBackHostInfo
Response XML_ResponseStatus

Remarks
The <ID> in the request URL refers to the configuration No., which is between 1 and 4. More
specifically, 1 refers to device No.1 to device No.16, 2refers to device No.17 to device No.32, 3
refers to device No.33 to device No.48, and 4 refers to device No.49 to device No.64.

5.105 /ISAPI/AccessControl/SubmarineBack
Operations about the configuration of the cross-controller anti-passing back server.

Request URL Definition

Table 4-125 GET /ISAPI/AccessControl/SubmarineBack
Method GET
Description Get the configuration parameters of the cross-controller anti-​passing
back server.
Query None.
Request None.
Response Succeeded: XML_SubmarineBack
Failed: XML_ResponseStatus
Table 4-126 PUT /ISAPI/AccessControl/SubmarineBack
Method PUT
Description Set the parameters of the cross-controller anti-​passing back server.

265
 Device Network SDK (Access Control on Person) Developer Guide

Query None.
Request XML_SubmarineBack
Response XML_ResponseStatus

5.106 /ISAPI/AccessControl/ClearAntiSneak?format=json
Clear anti-passing back records.

Request URL Definition

Table 4-127 PUT /ISAPI/AccessControl/ClearAntiSneak?format=json
Method PUT
Description Clear anti-​passing back records.
Query format: determine the format of request or response message.
Request JSON_ClearAntiSneak
Response JSON_ResponseStatus

5.107 /ISAPI/AccessControl/CardReaderAntiSneakCfg/<ID>?format=json
Operations about the anti-passing back configuration of a specified card reader.

Request URL Definition

Table 4-128 GET /ISAPI/AccessControl/CardReaderAntiSneakCfg/<ID>?format=json
Method GET
Description Get the anti-​passing back configuration parameters of a specified
card reader.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_CardReaderAntiSneakCfg
Failed: JSON_ResponseStatus
Table 4-129 PUT /ISAPI/AccessControl/CardReaderAntiSneakCfg/<ID>?format=json
Method PUT
Description Set the anti-​passing back parameters of a specified card reader.
Query format: determine the format of request or response message.

266
 Device Network SDK (Access Control on Person) Developer Guide

Request JSON_CardReaderAntiSneakCfg
Response JSON_ResponseStatus

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

5.108 /ISAPI/AccessControl/AcsEvent?format=json
Search for access control events.

Request URL Definition

Table 4-130 POST /ISAPI/AccessControl/AcsEvent?format=json
Method POST
Description Search for access control events.
Query format: determine the format of request or response message.
Request JSON_AcsEventCond
Response Succeeded: JSON_AcsEvent
Failed: JSON_ResponseStatus

5.109 /ISAPI/AccessControl/AntiSneakCfg/capabilities?format=json
Get the anti-passing back configuration capability.

Request URL Definition

Table 4-131 GET /ISAPI/AccessControl/AntiSneakCfg/capabilities?format=json
Method GET
Description Get the anti-​passing back configuration capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_AntiSneakCfg
Failed: JSON_ResponseStatus

267
 Device Network SDK (Access Control on Person) Developer Guide

5.110 /ISAPI/AccessControl/AntiSneakCfg?format=json
Operations about anti-passing back configuration.

Request URL Definition

Table 4-132 GET /ISAPI/AccessControl/AntiSneakCfg?format=json
Method GET
Description Get the anti-​passing back configuration parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_AntiSneakCfg
Failed: JSON_ResponseStatus
Table 4-133 PUT /ISAPI/AccessControl/AntiSneakCfg?format=json
Method PUT
Description Set the anti-​passing back parameters.
Query format: determine the format of request or response message.
Request JSON_AntiSneakCfg
Response JSON_ResponseStatus

5.111 /ISAPI/AccessControl/capabilities
Get the functional capability of access control.

Request URL Definition

Table 4-134 GET /ISAPI/AccessControl/capabilities
Method GET
Description Get the functional capability of access control.
Query None.
Request None.
Response Succeeded: XML_Cap_AccessControl
Failed: XML_ResponseStatus

268
 Device Network SDK (Access Control on Person) Developer Guide

5.112 /ISAPI/AccessControl/CardInfo/capabilities?format=json
Get the card management capability.

Request URL Definition

Table 4-135 GET /ISAPI/AccessControl/CardInfo/capabilities?format=json
Method GET
Description Get the card management capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_CardInfo
Failed: JSON_ResponseStatus

5.113 /ISAPI/AccessControl/AcsEvent/capabilities?format=json
Get the capability of searching for access control events

Request URL Definition

Table 4-136 GET /ISAPI/AccessControl/AcsEvent/capabilities?format=json
Method GET
Description Get the capability of searching for access control events.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_AcsEvent
Failed: JSON_ResponseStatus

5.114 /ISAPI/AccessControl/ClearAntiSneak/capabilities?format=json
Get the capability of clearing anti-passing back records.

269
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-137 GET /ISAPI/AccessControl/ClearAntiSneak/capabilities?format=json
Method GET
Description Get the capability of clearing anti-​passing back records.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_ClearAntiSneak
Failed: JSON_ResponseStatus

5.115 /ISAPI/AccessControl/ClearAntiSneakCfg?format=json
Clear anti-passing back parameters.

Request URL Definition

Table 4-138 PUT /ISAPI/AccessControl/ClearAntiSneakCfg?format=json
Method PUT
Description Clear anti-​passing back parameters.
Query format: determine the format of request or response message.
Request JSON_ClearAntiSneakCfg
Response JSON_ResponseStatus

5.116 /ISAPI/AccessControl/ClearAntiSneakCfg/capabilities?format=json
Get the capability of clearing anti-passing back parameters.

Request URL Definition

Table 4-139 GET /ISAPI/AccessControl/ClearAntiSneakCfg/capabilities?format=json
Method GET
Description Get the capability of clearing anti-​passing back parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_ClearAntiSneakCfg

270
 Device Network SDK (Access Control on Person) Developer Guide

Failed: JSON_ResponseStatus

5.117 /ISAPI/AccessControl/CardReaderAntiSneakCfg/capabilities?
format=json
Get the anti-passing back configuration capability of card readers.

Request URL Definition

Table 4-140 GET /ISAPI/AccessControl/CardReaderAntiSneakCfg/capabilities?format=json
Method GET
Description Get the anti-​passing back configuration capability of card readers.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_CardReaderAntiSneakCfg
Failed: JSON_ResponseStatus

5.118 /ISAPI/AccessControl/PrinterCfg/capabilities?format=json
Get the printer configuration capability.

Request URL Definition

Table 4-141 GET /ISAPI/AccessControl/PrinterCfg/capabilities?format=json
Method GET
Description Get the printer configuration capability.
Query format: determine the format of request or response message.
Request None.
Response JSON_Cap_PrinterCfg

5.119 /ISAPI/AccessControl/PrinterCfg?format=json
Operations about printer configurations.

271
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-142 GET /ISAPI/AccessControl/PrinterCfg?format=json
Method GET
Description Get the printer configuration parameters.
Query format: determine the format of request or response
message.
Request None.
Response JSON_PrinterCfg
Table 4-143 PUT /ISAPI/AccessControl/PrinterCfg?format=json
Method PUT
Description Set the printer parameters.
Query format: determine the format of request or response message.
Request JSON_PrinterCfg
Response JSON_ResponseStatus

5.120 /ISAPI/Intelligent/FDLib/capabilities?format=json
Get face picture library capability.

Request URL Definition

Table 4-144 GET /ISAPI/Intelligent/FDLib/capabilities?format=json
Method GET
Description Get face picture library capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_FPLibCap
Failed: JSON_ResponseStatus

5.121 /ISAPI/Intelligent/FDLib?format=json
Operations about the face picture library.

272
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-145 POST /ISAPI/Intelligent/FDLib?format=json
Method POST
Description Create a face picture library
Query format: determine the format of request or response message.
Request JSON_CreateFPLibCond
Response Succeeded: JSON_CreateFPLibResult
Failed: JSON_ResponseStatus
Table 4-146 GET /ISAPI/Intelligent/FDLib?format=json
Method GET
Description Get the information, including library ID, library type, name, and
custom information, of all face picture libraries.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_FPLibListInfo
Failed: JSON_ResponseStatus
Table 4-147 DELETE /ISAPI/Intelligent/FDLib?format=json
Method DELETE
Description Delete all face picture libraries.
Query format: determine the format of request or response message.
Request None
Response JSON_ResponseStatus

Remarks
After a face picture library is created, the face picture library ID will be returned. Each face picture
library ID of the same library type is unique.

5.122 /ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType=
Operations about the management of a specific face picture library.

273
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-148 GET /ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType=
Method GET
Description Get the information, including library ID, library type, name, and
custom information, of a specific face picture library.
Query format: determine the format of request or response message.
FDID: face picture library ID.
faceLibType: face picture library type.
Request None.
Response Succeeded: JSON_SingleFPLibInfo
Failed: JSON_ResponseStatus
Table 4-149 PUT /ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType=
Method PUT
Description Edit the information of a specific face picture library information,
including name and custom information.
Query format: determine the format of request or response message.
FDID: face picture library ID
faceLibType: face picture library type
Request JSON_EditFPlibInfo
Response JSON_ResponseStatus
Table 4-150 DELETE /ISAPI/Intelligent/FDLib?format=json&FDID=&faceLibType=
Method DELETE
Description Delete a specific face picture library.
Query format: determine the format of request or response message.
FDID: face picture library ID
faceLibType: face picture library type
Request None.
Response JSON_ResponseStatus

Remarks
In the URL, to specify a face picture library, both the library ID (FDID) and library type (faceLibType)
are required.

274
 Device Network SDK (Access Control on Person) Developer Guide

5.123 /ISAPI/Intelligent/FDLib/Count?format=json
Get the total number of face records in all face picture libraries.

Request URL Definition

Table 4-151 GET /ISAPI/Intelligent/FDLib/Count?format=json
Method GET
Description Get the total number of face records in all face picture libraries.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_FaceRecordNumInAllFPLib
Failed: JSON_ResponseStatus

5.124 /ISAPI/Intelligent/FDLib/Count?
format=json&FDID=&faceLibType=
Get the number of face records in a specific face picture library.

Request URL Definition

Table 4-152 GET /ISAPI/Intelligent/FDLib/Count?format=json&FDID=&faceLibType=
Method GET
Description Get the number of face records in a specific face picture library.
Query format: determine the format of request or response message.
FDID: face picture library ID.
faceLibType: face picture library type, which can equal to "blackFD"
(list library) and "staticFD" (static library).
Request None
Response Succeeded: JSON_FaceRecordNumInOneFPLib
Failed: JSON_ResponseStatus

Remarks
In the URL, to specify a face picture library, both the library ID (FDID) and library type (faceLibType)
are required, e.g., /ISAPI/Intelligent/FDLib/Count?
format=json&FDID=1223344455566788&faceLibType=blackFD.

275
 Device Network SDK (Access Control on Person) Developer Guide

5.125 /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json
Add the face record (face picture and person information) to a face picture library or multiple face
picture libraries.

Request URL Definition

Table 4-153 POST /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json
Method POST
Description Add a face record (including face picture and person information) to
the face picture library.
Query format: determine the format of request or response message.
Request JSON_AddFaceRecordCond
Response Succeeded: JSON_AddFaceRecordResult
Failed: JSON_ResponseStatus

5.126 /ISAPI/Intelligent/FDLib/FDSearch?format=json
Search for the face records in the face picture library.

Request URL Definition

Table 4-154 POST /ISAPI/Intelligent/FDLib/FDSearch?format=json
Method POST
Description Search for the face records in the a face picture library or multiple
face picture libraries. Fuzzy search is also supported.
Query format: determine the format of request or response message.
Request JSON_SearchFaceRecordCond
Response Succeeded: JSON_SearchFaceRecordResult
Failed: JSON_ResponseStatus

5.127 /ISAPI/Intelligent/FDLib/FDModify?format=json
Edit face records in the face picture library in a batch.

276
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-155 PUT /ISAPI/Intelligent/FDLib/FDModify?format=json
Method PUT
Description Edit face records in the face picture library in a batch.
Query format: determine the format of request or response message.
Request JSON_BatchEditFaceRecord
Response JSON_ResponseStatus

5.128 /ISAPI/Intelligent/FDLib/FDSearch/Delete?
format=json&FDID=&faceLibType=
Delete the face record(s) in a specific face picture library.

Request URL Definition

Table 4-156 PUT /ISAPI/Intelligent/FDLib/FDSearch/Delete?format=json&FDID=&faceLibType=
Method PUT
Description Delete the face record(s) in the face picture library.
Query format: determine the format of request or response message.
FDID: face picture library ID
faceLibType: face picture library type
Request JSON_DelFaceRecord
Response JSON_ResponseStatus

Remarks
In the URL, to specify a face picture library, both the library ID (FDID) and library type (faceLibType)
are required.

5.129 /ISAPI/Intelligent/FDLib/FDSetUp?format=json
Set the face record (including face picture, person information, etc.) in the face picture library.

277
 Device Network SDK (Access Control on Person) Developer Guide

Request URL Definition

Table 4-157 PUT /ISAPI/Intelligent/FDLib/FDSetUp?format=json
Method PUT
Description Set the face record (including face picture, person information, etc.)
in the face picture library.
Query format: determine the format of request or response message.
Request JSON_SetFaceRecord
Response JSON_ResponseStatus

Remarks
• If the face picture with the employee No. (person ID) does not exist, the face record will be
added.
• If the face picture with the employee No. (person ID) exists, the face record will be overwritten.
• When deleting the face record, the faceLibType, FDID, FPID, and deleteFP in the request
message JSON_SetFaceRecord should be configured, and the success response message will be
returned no matter whether deleting succeeded or not.

5.130 /ISAPI/System/PictureServer?format=json
Operations about the picture storage server configuration parameters.

Request URL Definition

Table 4-158 GET /ISAPI/System/PictureServer?format=json
Method GET
Description Get the picture storage server parameters.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_PictureServerInformation
Failed: JSON_ResponseStatus
Table 4-159 PUT /ISAPI/System/PictureServer?format=json
Method PUT
Description Set the picture storage server parameters.
Query format: determine the format of request or response message.

278
 Device Network SDK (Access Control on Person) Developer Guide

Request JSON_PictureServerInformation
Response JSON_ResponseStatus

279
 Device Network SDK (Access Control on Person) Developer Guide

Chapter 6 Request and Response Message

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

6.1 JSON_AcsEventCond
AcsEventCond message in JSON format
{
"AcsEventCond": {
"searchID": "",
/*required, string type, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"searchResultPosition": "",
/*required, integer, the start position of the search result in the result list. When there are multiple records and you
cannot get all search results at a time, you can search for the records after the specified position next time*/
"maxResults": "",
/*required, integer, maximum number of search results. If maxResults exceeds the range returned by the device
capability, the device will return the maximum number of search results according to the device capability and will not
return error message*/
"major": ,
/*required, integer, major alarm/event types (the type value should be transformed to the decimal number), see
Access Control Event Types
for details*/
"minor": ,
/*required, integer, minor alarm/event types (the type value should be transformed to the decimal number), see
Access Control Event Types
for details*/
"startTime": "",
/*optional, string, start time (UTC time), e.g., 2016-12-12T17:30:08+08:00*/
"endTime": "",
/*optional, string, end time (UTC time), e.g.,2017-12-12T17:30:08+08:00*/
"cardNo": "",
/*optional, string, card No.*/
"name": "",
/*optional, string，cardholder name*/
"picEnable": ,
/*optional, boolean, whether to contain pictures: "false"-no, "true"-yes*/
"beginSerialNo": ,
/*optional, integer, start serial No.*/
"endSerialNo": ,
/*optional, integer, end serial No.*/
"employeeNoString":"",
/*optional, string, employee No. (person ID)*/
"eventAttribute":"",
/*optional, string, event attribute: "attendance"-valid authentication, "other"*/

280
 Device Network SDK (Access Control on Person) Developer Guide

"employeeNo":""
/*optional, string, employee No. (person ID)*/
}
}

6.2 JSON_AcsEvent
AcsEvent message in JSON format
{
"AcsEvent":{
"searchID": "",
/*required, string type, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"responseStatusStrg": "",
/*required, string, search status: "OK"-searching completed, "MORE"-searching for more results, "NO MATCH"-no
matched results*/
"numOfMatches": "",
/*required, integer, number of returned results*/
"totalMatches": "",
/*required, integer, total number of matched results*/
"InfoList": [{
/*optional, event details*/
"major": ,
/*required, integer, major alarm/event types (the type value should be transformed to the decimal number), see
Access Control Event Types
for details*/
"minor": ,
/*required, integer, minor alarm/event types (the type value should be transformed to the decimal number), see
Access Control Event Types
for details*/
"time": "",
/*required, string, time (UTC time), e.g., "2016-12-12T17:30:08+08:00"*/
"netUser": "",
/*optional, string, user name*/
"remoteHostAddr": "",
/*optional, string, remote host address*/
"cardNo": "",
/*optional, string, card No.*/
"cardType": ,
/*optional, integer, card types: 1-normal card, 2-disabled card, 3-blacklist card, 4-patrol card, 5-duress card, 6-super
card, 7-visitor card, 8-dismiss card*/
"whiteListNo": ,
/*optional, integer, whitelist No., which is between 1 and 8*/
"reportChannel": ,
/*optional, integer, channel type for uploading alarm/event: 1-for uploading arming information, 2-for uploading by
central group 1, 3-for uploading by central group 2*/
"cardReaderKind": ,
/*optional, integer, authentication unit type: 1-IC card reader, 2-ID card reader, 3-QR code scanner, 4-fingerprint

281
 Device Network SDK (Access Control on Person) Developer Guide

module*/
"cardReaderNo": ,
/*Optional, integer, authentication unit No.*/
"doorNo": ,
/*optional, integer, door or floor No.*/
"verifyNo": ,
/*optional, integer, multiple authentication No.*/
"alarmInNo": ,
/*optional, integer, alarm input No.*/
"alarmOutNo": ,
/*optional, integer, alarm output No.*/
"caseSensorNo": ,
/*optional, integer, event trigger No.*/
"RS485No": ,
/*optional, integer, RS-485 channel No.*/
"multiCardGroupNo": ,
/*optional, integer, group No.*/
"accessChannel": ,
/*optional, integer, swing barrier No.*/
"deviceNo": ,
/*optional, integer, device No.*/
"distractControlNo": ,
/*optional, integer, distributed controller No.*/
"employeeNoString": "",
/*optional, integer, employee No. (person ID)*/
"localControllerID": ,
/*optional, integer, distributed access controller No.: 0-access controller, 1 to 64-distributed access controller No.1 to
distributed access controller No.64*/
"InternetAccess": ,
/*optional, integer, network interface No.: 1-upstream network interface No.1, 2-upstream network interface No.2, 3-
downstream network interface No.1*/
"type": ,
/*optional, integer, zone type: 0-instant alarm zone, 1-24-hour alarm zone, 2-delayed zone, 3-internal zone, 4-key
zone, 5-fire alarm zone, 6-perimeter protection, 7-24-hour silent alarm zone, 8-24-hour auxiliary zone, 9-24-hour
shock alarm zone, 10-emergency door open alarm zone, 11-emergency door closed alarm zone, 255-none*/
"MACAddr": "",
/*optional, string, physical address*/
"swipeCardType": ,
/*optional, integer, card swiping types: 0-invalid, 1-QR code*/
"serialNo": ,
/*optional, integer, event serial No., which is used to judge whether the event loss occurred*/
"channelControllerID": ,
/*optional, integer, lane controller No.: 1-master lane controller, 2-slave lane controller*/
"channelControllerLampID": ,
/*optional, integer, light board No. of lane controller, which is between 1 and 255*/
"channelControllerIRAdaptorID": ,
/*optional, integer, IR adapter No. of lane controller, which is between 1 and 255*/
"channelControllerIREmitterID": ,
/*optional, integer, active infrared intrusion detector No. of lane controller, which is between 1 and 255*/
"userType": "",
/*optional, string, person type: "normal"-normal person (household), "visitor"-visitor, "blacklist"-person in blacklist,
"administrators"-administrator*/

282
 Device Network SDK (Access Control on Person) Developer Guide

"currentVerifyMode": "",
/*optional, string, authentication mode: "cardAndPw"-card+password, "card", "cardOrPw"-card or password, "fp"-
fingerprint, "fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint+card,
"fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card or password,
"faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face", "employeeNoAndPw"-
employee No.+password, "fpOrPw"-fingerprint or password, "employeeNoAndFp"-employee No.+fingerprint,
"employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-face+fingerprint+card,
"faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face, "faceOrfaceAndCard"-
face or face+card, "fpOrface"-fingerprint or face, "cardOrfaceOrPw"-card or face or password, "cardOrFpOrPw"-card
or fingerprint or password*/
"picEnable": ,
/*optional, boolean, whether contains picture*/
"attendanceStatus":"",
/*optional, string, attendance status: "undefined", "checkIn"-check in, "checkOut"-check out, "breakOut"-break out,
"breakIn"-break in, "overtimeIn"-overtime in, "overTimeOut"-overtime out*/
"statusValue": ,
/*optional, integer, status value*/
"filename":
/*optional, string, file name. If multiple pictures are returned at a time, filename of each picture should be unique*/
}],
"picturesNumber":
/*optional, integer, number of captured pictures if the capture linkage action is configured. This node will be 0 or not
be returned if there is no picture*/
}
}

6.3 JSON_AcsEventTotalNum
AcsEventTotalNum message in JSON format
{
"AcsEventTotalNum":{
"totalNum":
/*required, integer, total number of events that match the search conditions*/
}
}

6.4 JSON_AcsEventTotalNumCond
AcsEventTotalNumCond message in JSON format
{
"AcsEventTotalNumCond":{
"major": ,
/*required, integer, major type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"minor": ,
/*required, integer, minor type (the type value should be transformed to the decimal number), refer to

283
 Device Network SDK (Access Control on Person) Developer Guide

Access Control Event Types

for details*/
"startTime":"",
/*optional, string, start time (UTC time), e.g., "2016-12-12T17:30:08+08:00"*/
"endTime":"",
/*optional, string, end time (UTC time), e.g., "2017-12-12T17:30:08+08:00"*/
"cardNo":"",
/*optional, string, card No.*/
"name":"",
/*optional, string, cardholder name*/
"picEnable": ,
/*optional, boolean, whether to contain pictures: "true"-yes, "false"-no*/
"beginSerialNo": ,
/*optional, integer, start serial No.*/
"endSerialNo": ,
/*optional, integer, end serial No.*/
"employeeNoString":"",
/*optional, string, employee No. (person ID)*/
"eventAttribute":""
/*optional, string, event attribute: "attendance"-valid authentication, "other"*/
}
}

6.5 JSON_AddFaceRecordCond
Message about conditions of adding face record, it is in JSON format
{
"faceURL": "",
/*optional, string type, picture storage URL inputted when uploading the face picture by URL, the maximum length is
256 bytes*/
"faceLibType": "",
/*required, face picture library type: "blackFD"-list library, "staticFD"-static library, string type, the maximum size is 32
bytes*/
"FDID": "",
/*required, face picture library ID, string type, the maximum size is 63 bytes*/
"FPID": "",
/*optional, string type, face record ID, it can be generated by device or inputted. If it is inputted, it should be the
unique ID with the combination of letters and digits, and the maximum length is 63 bytes; if it is generated by the
device automatically, it is the same as the employee No. (person ID)*/
"name": "",
/*required, name of person in the face picture, string type, the maximum size is 96 bytes*/
"gender": "",
/*optional, gender of person in the face picture: male, female, unknown, string type, the maximum size is 32 bytes*/
"bornTime": "",
/*required, birthday of person in the face picture, ISO8601 time format, string type, the maximum size is 20 bytes*/
"city": "",
/*optional, city code of birth for the person in the face picture, string type, the maximum size is 32 bytes*/
"certificateType": "",
/*optional, string type, the max. size is 10 bytes, certificate type: "officerID"-officer ID, "ID"-identify card, passport,

284
 Device Network SDK (Access Control on Person) Developer Guide

other*/
"certificateNumber": "",
/*optional, certificate No., string, the max. size is 32 bytes*/
"caseInfo": "",
/*optional, case information, string type, the max. size is 192 bytes, it is valid when faceLibType is "blackFD".*/
"tag": "",
/*optional, custom tag, up to 4 tags, which are separated by commas, string type, the max. size is 195 bytes, it is valid
when faceLibType is "blackFD".*/
"address": "",
/*optional, person address, string type, the max. size is 192 bytes, it is valid when faceLibType is "staticFD".*/
"customInfo": "",
/*optional, custom information, string type, the max. size is 192 bytes, it is valid when faceLibType is "staticFD".*/
"modelData":""
/*optional, string type, target model data, non-modeled binary data needs to be encrypted by Base64 during
transmission*/
"transfer":true
/*optional, boolean, whether to enable transfer*/
}

Remarks
If the field "faceURL" exists in the message, it indicates that the picture is uploaded via URL, and
the "faceURL" of message should be set to picture URL. Otherwise, the picture is uploaded as
binary data, which can be followed the message in JSON format, and separated by "boundary". See
the example below.
Example
Add Face Record When Binary Picture is Uploaded in Form Format
1) POST /ISAPI/Intelligent/FDLib/FaceDataRecord?format=json
2) Accept: text/html, application/xhtml+xml,
3) Accept-Language: us-EN
4) Content-Type: multipart/form-data; boundary=---------------------------7e13971310878
5) User-Agent: Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0)
6) Accept-Encoding: gzip, deflate
7) Host: 10.10.36.29:8080
8) Content-Length: 9907
9) Connection: Keep-Alive
10) Cache-Control: no-cache
11)
12) -----------------------------7e13971310878
13) Content-Disposition: form-data; name="FaceDataRecord";
14) Content-Type: application/json
15) Content-Length: 9907
16)
17) {
a) "faceLibType": "blackFD",
b) "FDID": "1223344455566788",
c) "FPID": "11111aa",
d) "name": "Eric",
e) "gender": "male",
f) "bornTime": "2004-05-03",

285
 Device Network SDK (Access Control on Person) Developer Guide

g) "city": “130100”,
h) "certificateType": "officerID",
i) "certificateNumber": "",
j) "caseInfo": "",
k) "tag": "aa,bb,cc,dd",
l) "address": "",
m) "customInfo": ""
18) }
19) -----------------------------7e13971310878
20) Content-Disposition: form-data; name="FaceImage";
21) Content-Type: image/jpeg
22) Content-Length: 9907
23)
24) ......JFIF.....`.`.....C........... .
25) ..
26) ................. $.' ",#..(7),01444.'9=82<.342...C. ....
27) -----------------------------7e13971310878--

Note
• In line 4, "Content-Type: multipart/form-data" indicates that the data is sent in form format. The
"boundary" is a delimiter, you can assign value to it for distinguishing other ones.
• In line 12, the request body consists of multiple same parts, and each part starts with "-" and
from the customized "boundary" delimiter, the contents after the delimiter is the description of
this part.
• In line 13, "Content-Disposition" refers to condition parameters, when adding face record, the
"name" must be set to "FaceDataRecord".
• In line 14, "Content-Type" refers to JSON format, which based on UTF-8 character set.
• In line 15, "Content-Length" refers to the size of data (contains the "\r\n" escape characters)
from line 16 to line 18.
• In line 16, the "\r\n\r\n" escape characters must be entered.
• Line 19 is the start delimiter of next part.
• Line 20 is the binary picture data, and the "name" must be set to "FaceImage".
• Line 21 is the format of the binary picture data. Here, "image/jpeg" indicates that the following
contents are JPEG format picture data.
• In line 23, the "\r\n\r\n" escape characters must be entered.
• In line 27, the customized "boundary" indicates the end of request body.

6.6 JSON_AddFaceRecordResult
Message about the result of adding the face record to face picture library, it is in JSON format.
{
"requestURL": "",
"statusCode": "",
"statusString": "",
"subStatusCode": "",

286
 Device Network SDK (Access Control on Person) Developer Guide

"errorCode": "",
"errorMsg": "",
/*see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"FPID": ""
/*optional, string type, face record ID returned when the face record is added, it is unique, and the maximum size is
63 bytes. This node is valid when errorCode is "1" and errorMsg is "ok"*/
}

See Also
JSON_ResponseStatus

6.7 JSON_AntiSneakCfg
AntiSneakCfg message in JSON format
{
"AntiSneakCfg": {
"enable": ,
/*required, boolean, whether to enable anti-passing back*/
"startCardReaderNo":
/*optional, integer, first card reader No., 0-no first card reader*/
}
}

6.8 JSON_AttendanceStatusModeCfg
AttendanceStatusModeCfg message in JSON format
{
"AttendanceStatusModeCfg":{
"mode":"",
/*optional, string type, attendance mode: "disable", "manual", "auto"-automatic, "manualAndAuto"-manual and
automatic*/
"manualStatusTime": ,
/*optional, integer type, duration of manual attendance status, unit: second. This node is valid when mode is
"manual" or "manualAndAuto"*/
"attendanceStatusEnable":
/*optional, boolean type, whether to enable attendance status: "true"-yes (if the device has not been configured with
start time and end time of the automatic attendance mode, the user will be prompted to select the attendance
status), "false"-no (if the device has not been configured with start time and end time of the automatic attendance
mode, there will be no prompt)*/
}
}

287
 Device Network SDK (Access Control on Person) Developer Guide

6.9 JSON_AttendanceStatusRuleCfg
AttendanceStatusRuleCfg message in JSON format
{
"AttendanceStatusRuleCfg":{
"statusKey":"",
/*optional, string type, status shortcut key: "Up", "Down", "Left", "Right", "ESC", "OK", "notConfig". If this node is not
configured, this node will be set to "notConfig" by default*/
"statusValue": ,
/*optional, integer type, status value*/
"WeekPlanCfg":[{
/*optional, schedule*/
"week":"",
/*optional, string type, day of the week: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday",
"Sunday"*/
"enable": ,
/*optional, boolean type, whether to enable: "true"-yes, "false"-no*/
"beginTime":""
/*optional, start time*/
}]
}
}

6.10 JSON_BatchEditFaceRecord
Message about editing face records in the face picture library in a batch, and it is in JSON format.
{
"faceURL":"",
/*optional, string type, picture storage URL inputted when uploading the face picture by URL, the maximum length is
256 bytes*/
"faceLibType":"",
/*required, string type, face picture library type: "blackFD"-list library, "staticFD"-static library, the maximum length is
32 bytes*/
"FDID":"",
/*required, string type, face picture library ID, the maximum length is 63 bytes, multiple face picture libraries should
be separated by commas*/
"FPID":"",
/*optional, string type, face record ID, it can be generated by the device or inputted. If it is inputted, it should be the
unique ID with the combination of letters and digits, and the maximum length is 63 bytes; if it is generated by the
device automatically, it is the same as the employee No. (person ID)*/
"name":"",
/*required, string type, name of the person in the face picture, the maximum length is 96 bytes*/
"gender":"",
/*optional, string type, gender of the person in the face picture: "male", "female", "unknown", the maximum length is
32 bytes*/
"bornTime":"",
/*required, string type, date of birth of the person in the face picture in ISO8601 time format, the maximum length is

288
 Device Network SDK (Access Control on Person) Developer Guide

20 bytes*/
"city":"",
/*optional, string type, code of the city of birth for the person in the face picture, the maximum length is 32 bytes*/
"certificateType ":"",
/*optional, string type, ID type: "officerID"-officer ID, "ID"-ID card. The maximum length is 10 bytes*/
"certificateNumber":"",
/*optional, string type, ID No., the maximum length is 32 bytes*/
"caseInfo":"",
/*optional, string type, case information, the maximum length is 192 bytes, it is valid when faceLibType is "blackFD"*/
"tag":"",
/*optional, string type, custom tag, up to 4 tags can be added and they should be separated by commas, the
maximum length of each tag is 48 bytes, and the maximum length of this node is 195 bytes. It is valid when
faceLibType is "blackFD"*/
"address":"",
/*optional, string type, person address, the maximum length is 192 bytes, it is valid when faceLibType is "staticFD"*/
"customInfo":"",
/*optional, string type, custom information, the maximum length is 192 bytes, it is valid when faceLibType is
"staticFD"*/
"modelData":""
/*optional, string type, target model data, non-modeled binary data needs to be encrypted by base64 during
transmission*/
}

6.11 JSON_Cap_AcsEvent
AcsEvent capability message in JSON format
{
"AcsEvent":{
"AcsEventCond":{
/*optional, search conditions*/
"searchID":{
/*required, string type, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"@min": ,
"@max":
},
"searchResultPosition":{
/*required, integer, the start position of the search result in the result list. When there are multiple records and you
cannot get all search results at a time, you can search for the records after the specified position next time*/
"@min": ,
"@max":
},
"maxResults":{
/*required, integer, maximum number of search results*/
"@min": ,
"@max":
},
"major":{

289
 Device Network SDK (Access Control on Person) Developer Guide

/*required, integer, major alarm/event types (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt": "0,1,2,3,5"
},
"minorAlarm":{
/*required, integer, minor alarm type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt": "1024,1025,1026,1027…"
},
"minorException":{
/*required, integer, minor exception type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt": "39,58,59,1024…"
},
"minorOperation":{
/*required, integer, minor operation type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt": "80,90,112,113…"
},
"minorEvent":{
/*required, integer, minor event type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt": "1,2,3,4…"
},
"startTime":{
/*optional, string, start time (UTC time)*/
"@min": ,
"@max":
},
"endTime":{
/*optional, string, end time (UTC time)*/
"@min": ,
"@max":
},
"cardNo":{
/*optional, string, card No.*/
"@min": ,
"@max":
},
"name":{
/*optional, string，cardholder name*/
"@min": ,
"@max":
},
"picEnable": "true,false",
/*optional, boolean, whether to contain pictures: "false"-no, "true"-yes*/
"beginSerialNo":{

290
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, integer, start serial No.*/

"@min": ,
"@max":
},
"endSerialNo":{
/*optional, integer, end serial No.*/
"@min": ,
"@max":
},
"employeeNoString":{
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
},
"eventAttribute":{
/*optional, string, event attribute: "attendance"-valid authentication, "other"*/
"@opt":"attendance,other"
},
"employeeNo": {
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
}
},
"InfoList":{
/*optional, event details*/
"maxSize": 10,
"time":{
/*required, string, time (UTC time)*/
"@min": ,
"@max":
},
"netUser":{
/*optional, string, user name*/
"@min": ,
"@max":
},
"remoteHostAddr":{
/*optional, string, remote host address*/
"@min": ,
"@max":
},
"cardNo":{
/*optional, string, card No.*/
"@min": ,
"@max":
},
"cardType":{
/*optional, integer, card type: "1"-normal card, "2"-disabled card, "3"-blacklist card, "4"-patrol card, "5"-duress card,
"6"-super card, "7"-visitor card, "8"-dismiss card*/
"@opt": "1,2,3,4,5,6,7,8"
},

291
 Device Network SDK (Access Control on Person) Developer Guide

"whiteListNo":{
/*optional, integer, whitelist No., which is between 1 and 8*/
"@min": ,
"@max":
},
"reportChannel":{
/*optional, integer, channel type for uploading alarm/event: "1"-for uploading arming information, "2"-for uploading
by central group 1, "3"-for uploading by central group 2*/
"@opt": "1,2,3"
},
"cardReaderKind":{
/*optional, integer, authentication unit type: "1"-IC card reader, "2"-ID card reader, "3"-QR code scanner, "4"-
fingerprint module*/
"@opt": "1,2,3,4"
},
"cardReaderNo":{
/*Optional, integer, authentication unit No.*/
"@min": ,
"@max":
},
"doorNo":{
/*optional, integer, door or floor No.*/
"@min": ,
"@max":
},
"verifyNo":{
/*optional, integer, multiple authentication No.*/
"@min": ,
"@max":
},
"alarmInNo":{
/*optional, integer, alarm input No.*/
"@min": ,
"@max":
},
"alarmOutNo":{
/*optional, integer, alarm output No.*/
"@min": ,
"@max":
},
"caseSensorNo":{
/*optional, integer, event trigger No.*/
"@min": ,
"@max":
},
"RS485No":{
/*optional, integer, RS-485 channel No.*/
"@min": ,
"@max":
},
"multiCardGroupNo":{
/*optional, integer, group No.*/

292
 Device Network SDK (Access Control on Person) Developer Guide

"@min": ,
"@max":
},
"accessChannel":{
/*optional, integer, swing barrier No.*/
"@min": ,
"@max":
},
"deviceNo":{
/*ptional, integer, device No.*/
"@min": ,
"@max":
},
"distractControlNo":{
/*optional, integer, distributed access controller No.*/
"@min": ,
"@max":
},
"employeeNo":{
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
},
"localControllerID":{
/*optional, integer, distributed access controller No.: "0"-access controller, "1" to "64"-distributed access controller
No.1 to distributed access controller No.64*/
"@min": ,
"@max":
},
"InternetAccess":{
/*optional, integer, network interface No.: "1"-upstream network interface No.1, "2"-upstream network interface No.
2, "3"-downstream network interface No.1*/
"@min": ,
"@max":
},
"type":{
/*optional, integer, zone type: "0"-instant alarm zone, "1"-24-hour alarm zone, "2"-delayed zone, "3"-internal zone,
"4"-key zone, "5"-fire alarm zone, "6"-perimeter protection, "7"-24-hour slient alarm zone, "8"-24-hour auxiliary zone,
"9"-24-hour shock alarm zone, "10"-emergency door open alarm zone, "11"-emergency door closed alarm zone,
"255"-none*/
"@opt": "0,1,2,3,4,5,6,7,8,9,10,11,255"
},
"MACAddr":{
/*optional, string, physical address*/
"@min": ,
"@max":
},
"swipeCardType":{
/*optional, integer, card swiping type: "0"-invalid, "1"-QR code*/
"@opt": "0,1"
},
"serialNo":{

293
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, integer, event serial No., which is used to judge whether the event loss occurred*/
"@min": ,
"@max":
},
"channelControllerID":{
/*optional, integer, lane controller No.: "1"-master lane controller, "2"-slave lane controller*/
"@opt": "0,1"
},
"channelControllerLampID":{
/*optional, integer, light board No. of lane controller, which is between 1 and 255*/
"@min": ,
"@max":
},
"channelControllerIRAdaptorID":{
/*optional, integer, IR adapter No. of lane controller, which is between 1 and 255*/
"@min": ,
"@max":
},
"channelControllerIREmitterID":{
/*optional, integer, active infrared intrusion detector No. of lane controller, which is between 1 and 255*/
"@min": ,
"@max":
},
"userType":{
/*optional, string, person types: "normal"-normal person (household), "visitor"-visitor, "blacklist"-person in blacklist,
"administrators"-administrator*/
"@opt": "normal,visitor,blackList,administrators"
},
"currentVerifyMode": {
/*optional, string, authentication modes: "cardAndPw"-card+password, "card", "cardOrPw"-card or password, "fp"-
fingerprint, "fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint+card,
"fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card or password,
"faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face", "employeeNoAndPw"-
employee No.+password, "fpOrPw"-fingerprint or password, "employeeNoAndFp"-employee No.+fingerprint,
"employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-face+fingerprint+card,
"faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face, "faceOrfaceAndCard"-
face or face+card, "fpOrface"-fingerprint or face, "cardOrfaceOrPw"-card or face or password, "cardOrFpOrPw"-card
or fingerprint or password*/
"@opt":
"cardAndPw,card,cardOrPw,fp,fpAndPw,fpOrCard,fpAndCard,fpAndCardAndPw,faceOrFpOrCardOrPw,faceAndFp,faceA
ndPw,faceAndCard,face,employeeNoAndPw,fpOrPw,employeeNoAndFp,employeeNoAndFpAndPw,faceAndFpAndCard,
faceAndPwAndFp,employeeNoAndFace,faceOrfaceAndCard,fpOrface,cardOrfaceOrPw,cardOrFpOrPw"
},
"picEnable": "true,false"
/*optional, boolean, whether to contain pictures*/
},
"picturesNumber":{
/*optional, integer, number of captured pictures if the capture linkage action is configured. This node will be 0 or not
be returned if there is no picture*/
"@min": ,
"@max":
},

294
 Device Network SDK (Access Control on Person) Developer Guide

"attendanceStatus":{
/*optional, string, attendance status: "undefined", "checkIn"-check in, "checkOut"-check out, "breakOut"-break out,
"breakIn"-break in, "overtimeIn"-overtime in, "overTimeOut"-overtime out*/
"@opt":"undefined,checkIn,checkOut,breakOut,breakIn,overtimeIn,overtimeOut"
},
"statusValue":{
/*optional, integer, status value*/
"@min":0,
"@max":255
}
}
}

6.12 JSON_Cap_AcsEventTotalNum
AcsEventTotalNum capability message in JSON format
{
"AcsEvent":{
"AcsEventTotalNumCond":{
/*optional, search conditions*/
"major":{
/*required, integer type, major type (the type value should be transformed to the decimal number): 0-all, 1-major
alarm type, 2-major exception type, 3-major operation type, 5-major event type, refer to
Access Control Event Types
for details*/
"@opt":"0,1,2,3,5"
},
"minorAlarm":{
/*required, integer, minor alarm type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt":"1024,1025,1026,1027…"
},
"minorException":{
/*required, integer, minor exception type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt":"39,58,59,1024…"
},
"minorOperation":{
/*required, integer, minor operation type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/
"@opt":"80,90,112,113…"
},
"minorEvent":{
/*required, integer, minor event type (the type value should be transformed to the decimal number), refer to
Access Control Event Types
for details*/

295
 Device Network SDK (Access Control on Person) Developer Guide

"@opt":"1,2,3,4…"
},
"startTime":{
/*optional, string, start time (UTC time)*/
"@min": ,
"@max":
},
"endTime":{
/*optional, string, end time (UTC time)*/
"@min": ,
"@max":
},
"cardNo":{
/*optional, string, card No.*/
"@min": ,
"@max":
},
"name":{
/*optional, string, cardholder name*/
"@min": ,
"@max":
},
"picEnable":"true,false",
/*optional, boolean, whether to contain pictures: "false"-no, "true"-yes*/
"beginSerialNo":{
/*optional, integer, start serial No.*/
"@min": ,
"@max":
},
"endSerialNo":{
/*optional, integer, end serial No.*/
"@min": ,
"@max":
},
"employeeNoString":{
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
},
"eventAttribute":{
/*optional, string, event attribute: "attendance"-valid authentication, "other"*/
"@opt":"attendance,other"
}
},
"totalNum":{
/*required, integer, total number of events that match the search conditions*/
"@min": ,
"@max":
}
}
}

296
 Device Network SDK (Access Control on Person) Developer Guide

6.13 JSON_Cap_AntiSneakCfg
AntiSneakCfg capability message in JSON format
{
"AntiSneakCfg": {
"enable": "true,false",
/*required, boolean, whether to enable anti-passing back*/
"startCardReaderNo": {
/*optional, integer, first card reader No., 0-no first card reader*/
"@min": 1,
"@max": 4
}
}
}

6.14 JSON_Cap_AttendanceStatusModeCfg
AttendanceStatusModeCfg capability message in JSON format
{
"AttendanceStatusModeCfg":{
"mode":{
/*optional, string type, attendance mode: "disable", "manual", "auto"-automatic, "manualAndAuto"-manual and
automatic*/
"@opt":"disable,manual,auto,manualAndAuto"
},
"manualStatusTime":{
/*optional, integer type, duration of manual attendance status, unit: second. This node is valid when mode is
"manual" or "manualAndAuto"*/
"@min":5,
"@max":999
},
"attendanceStatusEnable":"true,false"
/*optional, boolean type, whether to enable attendance status: "true"-yes (if the device has not been configured with
start time and end time of the automatic attendance mode, the user will be prompted to select the attendance
status), "false"-no (if the device has not been configured with start time and end time of the automatic attendance
mode, there will be no prompt)*/
}
}

6.15 JSON_Cap_AttendanceStatusRuleCfg
AttendanceStatusRuleCfg capability message in JSON format
{
"AttendanceStatusRuleCfg":{

297
 Device Network SDK (Access Control on Person) Developer Guide

"statusKey":{
/*optional, string type, status shortcut key: "Up", "Down", "Left", "Right", "ESC", "OK", "notConfig". If this node is not
configured, this node will be set to "notConfig" by default*/
"@opt":"Up,Down,Left,Right,ESC,OK"
},
"attendanceStatus":{
/*optional, string type, attendance status: "undefined", "checkIn"-check in, "checkOut"-check out, "breakOut"-break
out, "breakIn"-break in, "overtimeIn"-overtime in, "overTimeOut"-overtime out*/
"@opt":"undefined,checkIn,checkOut,breakOut,breakIn,overtimeIn,overtimeOut"
},
"statusValue":{
/*optional, integer type, status value*/
"@min":0,
"@max":255
},
"WeekPlanCfg":{
/*schedule*/
"maxSize":7,
"week":{
"@opt":"Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday"
},
"beginTime":"",
/*start time*/
"timeValid":"minute"
/*time accuracy: "day", "hour", "minute", "second"*/
}
}
}

6.16 JSON_Cap_CardInfo
CardInfo capability message in JSON format
{
"CardInfo":{
"supportFunction":{
/*required, supported functions of adding, editing, deleting, searching for card information, and getting the total
number of added cards: "post"-add, "delete", "put"-edit, "get"-search, "setUp"-set*/
"@opt":"post,delete,put,get,setUp"
},
"CardInfoSearchCond":{
/*optional, search conditions*/
"searchID":{
/*required, string type, search ID, which is used to check the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"@min":1,
"@max":36
},
"maxResults":{

298
 Device Network SDK (Access Control on Person) Developer Guide

/*required, integer32, maximum number of obtained records*/

"@min":1,
"@max":30
},
"EmployeeNoList":{
/*optional, person ID list*/
"maxSize":56,
"employeeNo":{
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
}
},
"CardNoList":{
/*optional, card No. list*/
"maxSize":56,
"cardNo":{
/*optional, string, card No.*/
"@min":1,
"@max":32
}
}
},
"CardInfoDelCond":{
/*optional, deleting conditions*/
"EmployeeNoList":{
/*optional, person ID list*/
"maxSize":56,
"employeeNo":{
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
}
},
"CardNoList":{
/*optional, card No. list*/
"maxSize":56,
"cardNo":{
/*optional, string, card No.*/
"@min":1,
"@max":32
}
}
},
"cardNo":{
/*required, string, card No.*/
"@min":1,
"@max":32
},
"employeeNo":{
/*required, string, employee No. (person ID)*/
"@min": ,

299
 Device Network SDK (Access Control on Person) Developer Guide

"@max":
},
"cardType":{
/*required, string, card type: "normalCard"-normal card, "patrolCard"-patrol card, "hijackCard"-duress card,
"superCard"-super card, "dismissingCard"-dismiss card, "emergencyCard"-emergency card (it is used to assign
permission to a temporary card, but it cannot open the door)*/
"@opt":"normalCard,patrolCard,hijackCard,superCard,dismissingCard,emergencyCard"
},
"leaderCard":{
/*optional, string, whether to support first card authentication function*/
"@min":1,
"@max":32
},
"checkCardNo":"true,false",
/*optional, boolean, whether to enable duplicated card verification: "false"-disable, "true"-enable. If this node is not
configured, the device will verify the duplicated card by default. When there is no card information, you can set
checkCardNo to "false" to speed up data applying; otherwise, it is not recommended to configure this node*/
"checkEmployeeNo":"true,false",
/*optional, boolean, whether to check the existence of the employee No. (person ID): "false"-no, "true"-yes. If this
node is not configured, the device will judge the existence of the employee No. (person ID) by default. If this node is
set to "false", the device will not judge the existence of the employee No. (person ID) to speed up data applying; if this
node is set to "true" or NULL, the device will judge the existence of the employee No. (person ID), and it is
recommended to set this node to "true" or NULL if there is no need to speed up data applying*/
"addCard":"true,false",
/*optional, boolean type, whether to add the card if the card information being edited does not exist: "false"-no (if
the device has checked that the card information being edited does not exist, the failure response message will be
returned along with the error code), "true"-yes (if the device has checked that the card information being edited does
not exist, the success response message will be returned, and the card will be added). If this node is not configured,
the card will not be added by default*/
"maxRecordNum":
/*required, integer type, supported maximum number of records (card records)*/
}
}

6.17 JSON_Cap_CardReaderAntiSneakCfg
CardReaderAntiSneakCfg capability message in JSON format
{
"CardReaderAntiSneakCfg": {
"cardReaderNo": {
/optional, string, card reader No.*/
"@min": ,
"@max":
}
"enable": "true,false",
/*equired, boolean, whether to enable the anti-passing back function of the card reader: "true"-enable, "false"-
disable*/
"followUpCardReader": {
/*optional, array, following card reader No. after the first card reader*/

300
 Device Network SDK (Access Control on Person) Developer Guide

"@min": ,
"@max":
}
}
}

6.18 JSON_Cap_EventOptimizationCfg
EventOptimizationCfg capability message in JSON format
{
"EventOptimizationCfg":{
"enable":"true,false"
/*optional, boolean, whether to enable event optimization: "true"-yes (default), "false"-no*/
}
}

6.19 JSON_Cap_ClearAntiSneak
ClearAntiSneak capability message in JSON format
{
"ClearAntiSneak": {
"clearAll": "true,false",
/*required, boolean, whether to clear all anti-passing back records: "true"-yes, "false"-no. Clearing all anti-passing
back records is not supported by access control devices version 2.1*/
"EmployeeNoList" : {
/*optional, person ID list, this node is valid when clearAll is "false"*/
"maxSize": ,
"employeeNo": {
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
}
}
}
}

6.20 JSON_Cap_ClearAntiSneakCfg
ClearAntiSneakCfg capability message in JSON format
{
"ClearAntiSneakCfg": {
"ClearFlags": {
"antiSneak": "true,false"
/*required, boolean, whether to clear the anti-passing back parameter*/

301
 Device Network SDK (Access Control on Person) Developer Guide

}
}
}

6.21 JSON_Cap_FaceRecognizeMode
FaceRecognizeMode capability message in JSON format
{
"FaceRecognizeMode":{
"mode":{
/*optional, string type, facial recognition mode: "normalMode"-normal mode, "deepMode"-deep mode*/
"@opt":"normalMode,deepMode"
}
}
}

6.22 JSON_Cap_FingerPrintCfg
FingerPrintCfg capability message in JSON format
{
"FingerPrintCfg":{
"searchID":{
/*required, string type, search ID*/
"@min":1,
"@max":36
},
"employeeNo":{
/*required, string, employee No. (person ID) linked with the fingerprint*/
"@min": ,
"@max":
},
"enableCardReader":{
/*required, array, fingerprint module to apply fingerprint data to*/
"@min": ,
"@max":
},
"fingerPrintID":{
/*required, integer, fingerprint No., which is between 1 and 10*/
"@min":1,
"@max":10
},
"fingerType":{
/*required, string, fingerprint type: "normalFP"-normal fingerprint, "hijackFP"-duress fingerprint, "patrolFP"-patrol
fingerprint, "superFP"-super fingerprint, "dismissingFP"-dismiss fingerprint*/
"@opt":"normalFP,hijackFP,patrolFP,superFP,dismissingFP"
},
"leaderFP":{

302
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, array, whether to support first time authentication function*/

"@min":1,
"@max":32
},
"checkEmployeeNo":"true,false",
/*optional, boolean, whether to judge the existence of the employee No. (person ID): "false"-no, "true"-yes. If this
node is not configured, the device will judge the existence of the employee No. (person ID) by default. If this node is
set to "false", the device will not judge the existence of the employee No. (person ID) to speed up data applying; if this
node is set to "true" or NULL, the device will judge the existence of the employee No. (person ID), and it is
recommended to set this node to "true" or NULL if there is no need to speed up data applying*/
"callbackMode":{
/*optional, integer, device callback mode: 0-return when applying to all fingerprint modules completed (blocking); 1-
return when applying to a part of fingerprint modules completed (unblocking). If this node is set to NULL, blocking
mode will be adopted.*/
"@opt":"0,1"
},
/*when blocking mode is adopted, the totalStatus must be 1 after FingerPrintStatus is returned, which indicates that
the fingerprint information is applied; when unblocking mode is adopted, if the totalStatus is 0 after FingerPrintStatus
is returned, you should repeatedly call the URL /ISAPI/AccessControl/FingerPrintProgress?format=json to get the
applying progress (which is also returned in FingerPrintStatus) until totalStatus equals to 1 (the fingerprint
information is applied)*/
"StatusList":{
/*optional, status list*/
"id":{
/*optional, integer, fingerprint module No.*/
"@min": ,
"@max":
},
"cardReaderRecvStatus":{
/*optional, integer, fingerprint module status: 0-connecting failed, 1-connected, 2-the fingerprint module is offline, 3-
the fingerprint quality is poor, try again, 4-the memory is full, 5-the fingerprint already exists, 6-the fingerprint ID
already exists, 7-invalid fingerprint ID, 8-this fingerprint module is already configured, 10-the fingerprint module
version is too old to support the employee No.*/
"@opt": "0,1,2,3,4,5,6,7,8,10"
},
"errorMsg":{
/*optional, string, error information*/
"@min": ,
"@max":
}
},
"totalStatus":{
/*required, integer, applying status: 0-applying, 1-applied*/
"@opt":"0,1"
},
"isSupportFingerCover":true,
/*whether to support overwriting the original fingerprint when applying new fingerprint linked with the same person
ID or employee No. If it is supported, this node will be set to "true"; otherwise, this node will not be returned*/
"isSupportSetUp":true
/*whether to support setting fingerprint parameters. If it is supported, this node will be set to "true"; otherwise, this
node will not be returned*/

303
 Device Network SDK (Access Control on Person) Developer Guide

}
}

6.23 JSON_Cap_FingerPrintDelete
FingerPrintDelete capability message in JSON format
{
"FingerPrintDelete":{
"mode":{
/*required, string, deleting mode: "byEmployeeNo"-delete by employee No. (person ID), "byCardReader"-delete by
fingerprint module*/
"@opt":"byEmployeeNo,byCardReader"
},
"EmployeeNoDetail":{
/*optional, delete by employee No. (person ID), this node is valid when mode is "byEmployeeNo"*/
"employeeNo":{
/*optional, string, employee No. (person ID) linked with the fingerprint*/
"@min": ,
"@max":
},
"enableCardReader":{
/*optional, array, fingerprint module whose fingerprints should be deleted*/
"@min": ,
"@max":
},
"fingerPrintID":{
/*optional, array, No. of fingerprint to be deleted*/
"@min": ,
"@max":
},
},
"CardReaderDetail":{
/*optional, delete by fingerprint module, this node is valid when mode is "byCardReader"*/
"cardReaderNo":{
/*optional, integer, fingerprint module No.*/
"@min": ,
"@max":
},
"clearAllCard":"true,false",
/*optional, boolean, whether to delete the fingerprint information of all cards: "false"-no (delete by employee No.),
"true"-yes (delete the fingerprint information of all employee No.)*/
"employeeNo":{
/*optional, string, employee No. (person ID) linked with the fingerprint, this node is valid when clearAllCard is
"false"*/
"@min": ,
"@max":
}
}

304
 Device Network SDK (Access Control on Person) Developer Guide

}
}

6.24 JSON_Cap_LogModeCfg
LogModeCfg capability message in JSON format
{
"LogModeCfg":{
"type":{
/*optional, integer, log mode: 1-16 bytes (the host log can be stored by 25w, and the employee No. can be stored by
16 bytes), 2-12 bytes (the host log can be stored by 25w, and the employee No. can be stored by 12 bytes). This node
will be set to 1 by default*/
"@opt":"1,2"
}
}
}

6.25 JSON_Cap_OSDPModify
OSDPModify capability message in JSON format
{
"OSDPModify":{
"id":{
/*required, integer, range of the original OSDP card reader ID*/
"@min": ,
"@max":
},
"newID":{
/*required, integer, new ID of the OSDP card reader*/
"@min": ,
"@max":
}
}
}

6.26 JSON_Cap_OSDPStatus
OSDPStatus capability message in JSON format
{
"OSDPStatus":{
"id":{
/*required, integer, range of the OSDP card reader ID*/
"@min": ,
"@max":

305
 Device Network SDK (Access Control on Person) Developer Guide

},
"status":"online,offline"
/*required, string, online status: "online", "offline"*/
}
}

6.27 JSON_Cap_PrinterCfg
PrinterCfg capability message in JSON format
{
"PrinterCfg":{
"enable":{
/*required, boolean, whether to enable the printer*/
"@opt":"true,false"
},
"printFormat":{
"vistorPic":{
/*optional, visitor picture*/
"enable":{
/*required, boolean, whether to print visitor picture*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,
"@max": 255,
}
},
"vistorName":{
/*optional, visitor name*/
"enable":{
/*required, boolean, whether to print visitor name*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,
"@max": 255,
}
},
"certificateNumber":{
/*optional, visitor's certificate No.*/
"enable":{
/*required, boolean, whether to print visitor's certificate No.*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,

306
 Device Network SDK (Access Control on Person) Developer Guide

"@max": 255,
}
},
"address":{
/*optional, visitor's address*/
"enable":{
/*required, boolean, whether to print visitor's address*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,
"@max": 255,
}
},
"validity":{
/*optional, expiry date*/
"enable":{
/*required, whether to print the expiry date*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,
"@max": 255,
}
},
"receptionDepartment":{
/*optional, reception department*/
"enable": {
/*required, boolean, whether to print the reception department*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,
"@max": 255,
}
},
"receptionStaff":{
/*optional, receptionist information*/
"enable":{
/*required, boolean, whether to print the receptionist information*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,
"@max": 255,
}
},
"registrationTime":{

307
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, registered time*/

"enable":{
/*optional, whether to print the registered time*/
"@opt":"true,false"
},
"lineNo":{
/*required, integer, line No.*/
"@min": 1,
"@max": 255,
}
},
}
}
}

6.28 JSON_Cap_RemoteControlBuzzer
RemoteControlBuzzer capability message in JSON format
{
"RemoteControlBuzzer":{
"cardReaderNo":{
/*optional, integer, card reader No. (buzzer No.)*/
"@min": ,
"@max":
},
"cmd":{
/*required, string, command: "start"-start buzzing, "stop"-stop buzzing*/
"@opt":"start,stop"
}
}
}

6.29 JSON_Cap_UserInfo
UserInfo capability message in JSON format
{
"UserInfo":{
"supportFunction":{
/*required, supported function of adding, deleting, editing, searching for person information, and getting total
number of the added persons: "post"-add, "delete", "put"-edit, "get"-search, "setUp"-set*/
"@opt":"post,delete,put,get,setUp"
},
"UserInfoSearchCond":{
/*optional, search conditions*/
"searchID":{
/*required, string type, search ID, which is used to check the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next

308
 Device Network SDK (Access Control on Person) Developer Guide

searching*/
"@min":1,
"@max":36
},
"maxResults":{
/*required, integer32, maximum number of search results*/
"@min":1,
"@max":30
},
"EmployeeNoList":{
/*optional, person ID list*/
"maxSize":56,
"employeeNo":{
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
}
}
},
"UserInfoDelCond":{
/*optional, deleting conditions*/
"EmployeeNoList":{
/*optional, person ID list (if this node does not exist, it indicates deleting all person information)*/
"maxSize":56,
"employeeNo":{
/*optional, string, employee No. (person ID)*/
"@min": ,
"@max":
}
}
},
"employeeNo":{
/*required, string, employee No. (person ID)*/
"@min": ,
"@max":
},
"name":{
/*optional, string, name*/
"@min":1,
"@max":32
},
"userType":{
/*required, string, person type: "normal"-normal person (household), "visitor", "blackList"-person in blacklist*/
"@opt":"normal,visitor,blackList"
},
"closeDelayEnabled":"true,false",
/*optional, boolean, whether to enable door close delay: "true"-yes, "false"-no*/
"Valid":{
/*required, parameters of the effective period*/
"enable":"true, false",
/*required, boolean, whether to enable the effective period: "false"-disable, "true"-enable. If this node is set to
"false", the effective period is permanent*/

309
 Device Network SDK (Access Control on Person) Developer Guide

"beginTime":{
/*required, start time of the effective period (if timeType does not exist or is "local", the beginTime is the device local
time, e.g.,: 2017-08-01T17:30:08; if timeType is "UTC", the beginTime is UTC time, e.g.,:
2017-08-01T17:30:08+08:00)*/
"@min":1,
"@max":32
},
"endTime":{
/*required, end time of the effective period (if timeType does not exist or is "local", the endTime is the device local
time, e.g.,: 2017-08-01T17:30:08; if timeType is "UTC", the endTime is UTC time, e.g.,: 2017-08-01T17:30:08+08:00)*/
"@min":1,
"@max":32
},
"timeRangeBegin":"",
/*optional, string, start time that can be configured for beginTime. If the device does not return this node, the default
start time that can be configured for beginTime is "1970-01-01T00:00:00"*/
"timeRangeEnd":"",
/*optional, string, end time that can be configured for endTime. If the device does not return this node, the default
end time that can be configured for endTime is "2037-12-31T23:59:59"*/
"timeType":{
/*optional, string, time type: "local"- device local time, "UTC"- UTC time*/
"@opt":"local,UTC"
}
},
"maxBelongGroup":4,
/*optional, integer, maximum number of groups that a person can belong to*/
"belongGroup":{
/*optional, string, group*/
"@min":1,
"@max":32
},
"password":{
/*optional, string, password*/
"@min":1,
"@max":32
},
"doorRight":{
/*optional, string, No. of door or lock that has access permission*/
"@min":1,
"@max":32
},
"RightPlan":{
/*optional, door permission schedule (lock permission schedule)*/
"maxSize":32,
"doorNo":{
/*optional, integer, door No. (lock ID)*/
"@min":1,
"@max":32
},
"maxPlanTemplate":4,
/*optional, integer, maximum number of schedule templates that can be configured for one door*/
"planTemplateNo":{

310
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, string, schedule template No.*/

"@min":1,
"@max":32
}
},
"maxOpenDoorTime":{
/*optional, integer, maximum authentication attempts, 0-unlimited*/
"@min":0,
"@max":100
},
"openDoorTime":{
/*optional, integer, read-only, authenticated attempts*/
"@min":0,
"@max":100
},
"roomNumber":{
/*optional, integer, room No.*/
"@min":0,
"@max":100
},
"floorNumber":{
/*optional, integer, floor No.*/
"@min":0,
"@max":100
},
"doubleLockRight":"true, false",
/*optional, boolean, whether to have the permission to open the double-locked door: "true"-yes, "false"-no*/
"localUIRight":"true, false",
/*optional, boolean, whether to have the permission to access the device local UI: "true"-yes, "false"-no*/
"userVerifyMode":{
/*optional, string, person authentication mode: "cardAndPw"-card+password, "card"-card, "cardOrPw"-card or
password, "fp"-fingerprint, "fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint
+card, "fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card or
password, "faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face"-face,
"employeeNoAndPw"-employee No.+password, "fpOrPw"-fingerprint or password, "employeeNoAndFp"-employee
No.+fingerprint, "employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-face
+fingerprint+card, "faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face,
"faceOrfaceAndCard"-face or face+card, "fpOrface"-fingerprint or face, "cardOrfaceOrPw"-card or face or password,
"cardOrFace"-card or face, "cardOrFaceOrFp"-card or face or fingerprint, "cardOrFpOrPw"-card or fingerprint or
password. The priority of the person authentication mode is higher than that of the card reader authentication
mode*/

"@opt":"cardAndPw,card,cardOrPw,fp,fpAndPw,fpOrCard,fpAndCard,fpAndCardAndPw,faceOrFpOrCardOrPw,faceAnd
Fp,faceAndPw,faceAndCard,face,employeeNoAndPw,fpOrPw,employeeNoAndFp,employeeNoAndFpAndPw,faceAndFp
AndCard,faceAndPwAndFp,employeeNoAndFace,faceOrfaceAndCard,fpOrface,cardOrfaceOrPw,cardOrFace,cardOrFac
eOrFp,cardOrFpOrPw"
},
"checkUser":"true, false",
/*optional, boolean, whether to verify the duplicated person information: "false"-no, "true"-yes. If checkUser is not
configured, the device will verify the duplicated person information by default. When there is no person information,
you can set checkUser to "false" to speed up data applying; otherwise, it is not recommended to configure this node*/
"addUser": "true,false",

311
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, boolean type, whether to add the person if the person information being edited does not exist: "false"-no
(if the device has checked that the person information being edited does not exist, the failure response message will
be returned along with the error code), "true"-yes (if the device has checked that the person information being edited
does not exist, the success response message will be returned, and the person will be added). If this node is not
configured, the person will not be added by default*/
"maxRecordNum":
/*required, integer type, supported maximum number of records (person records)*/
"callNumbers": {
/*optional, string type, room No. list to be called, which is extended from roomNumber and it is in higher priority; by
default, the No. format is X-X-X-X, e.g., 1-1-1-401, and for standard SIP, it can be the SIP number; this node must be
configured together with roomNumber*/
"maxSize": ,
/*range of members in the array*/
"@min": 0,
/*minimum string length*/
"@max": 100
/*maximum string length*/
},
"floorNumbers": {
/*optional, integer type, floor No. list, which is extended from floorNumber and it is in higher priority; this node must
be configured together with floorNumber*/
"maxSize": ,
/*range of members in the array*/
"@min": 0,
/*minimum floor No.*/
"@max": 100
/*maximum floor No.*/
}
}
}

6.30 JSON_Cap_UserInfoDetail
UserInfoDetail capability message in JSON format
{
"UserInfoDetail":{
"mode":{
"@opt":"all,byEmployeeNo"
/*required, string type, deleting mode: "all"-delete all, "byEmployeeNo"-delete by employee No. (person ID)*/
},
"EmployeeNoList":{
/*optional, person ID list*/
"maxSize": ,
"employeeNo":{
/*optional, string type, employee No. (person ID), it is valid when mode is "byEmployeeNo"*/
"@min": ,
"@max":
}
}

312
 Device Network SDK (Access Control on Person) Developer Guide

}
}

6.31 JSON_CapturePreset
CapturePreset message in JSON format
{
"CapturePreset":{
"name":""
/*optional, string, name, the maximum size is 128 bytes by default. This field is NULL by default*/
}
}

6.32 JSON_CapturePresetCap
CapturePresetCap capability message in JSON format
{
"CapturePresetCap":{
"name":{
/*optional, string, name*/
"@min":0,
"@max":0
}
}
}

6.33 JSON_CaptureProgress
CaptureProgress message in JSON format
{
"CaptureProgress":{
"reqCaptureNum": ,
/*optional, integer, total number of person to be collected*/
"completelyCaptureNum": ,
/*optional, integer, number of completely collected persons*/
"partiallyCaptureNum": ,
/*optional, integer, number of partially collected persons*/
"reqFaceNum": ,
/*optional, integer, number of faces to be collected*/
"faceNum": ,
/*optional, integer, number of collected faces*/
"reqFingerprintNum": ,
/*optional, integer, number of fingerprints to be collected*/
"fingerprintNum": ,

313
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, integer, number of collected fingerprints*/

"reqCardNum": ,
/*optional, integer, number of cards to be collected*/
"cardNum": ,
/*optional, integer, number of collected cards*/
"reqIDCardNum": ,
/*optional, integer, number of ID cards to be collected*/
"IDCardNum":
/*optional, integer, number of collected ID cards*/
}
}

6.34 JSON_CaptureRule
CaptureRule message in JSON format
{
"CaptureRule":{
"enableCardNoLenAuto": ,
/*optional, boolean, whether to enable length self-adaption of the card serial No.*/
"cardNoLen": ,
/*dependency, integer, length of the card serial No.: 3, 4, 7, 10, unit: byte. This field is valid when
enableCardNoLenAuto is "false". If this field is set to 3, it refers to Wiegand 26*/
"cardTimeout":
/*optional, integer, card collection timeout, unit: ms*/
}
}

6.35 JSON_CaptureRuleCap
CaptureRuleCap capability message in JSON format
{
"CaptureRuleCap":{
"enableCardNoLenAuto":[true,flase],
/*optional, boolean, whether to enable length self-adaption of the card serial No.*/
"cardNoLen":{
/*dependency, integer, length of the card serial No.: 3, 4, 7, 10*/
"@opt":[3,4,7,10]
},
"cardTimeout":{
/*optional, integer, card collection timeout, unit: ms*/
"@min":0,
"@max":0
}
}
}

314
 Device Network SDK (Access Control on Person) Developer Guide

6.36 JSON_CardEncryption
JSON message about card encryption parameters
{
"CardEncryption": {
"cardType": "",
/*required, string type, card types: "blank"-blank card, "private"-private CPU card, encrypted-other encrypted cards*/
"keyLen":,
/*depend, integer, size of key for external authentication, this field is valid only when cardType is set to "encrypted"*/
"key": ""
/*required, hexadecimal string, a 16-byte key content for external authentication*/
}
}

6.37 JSON_CardInfo
CardInfo message in JSON format
{
"CardInfo":{
"employeeNo":"",
/*required, string, employee No. (person ID)*/
"cardNo":"",
/*required, string, card No.*/
"deleteCard": ,
/*optional, boolean, whether to delete the card: "true"-yes. This node is required only when the card needs to be
deleted; for adding or editing card information, this node can be set to NULL*/
"cardType":"",
/*optional, string, card type: "normalCard"-normal card, "patrolCard"-patrol card, "hijackCard"-duress card,
"superCard"-super card, "dismissingCard"-dismiss card, "emergencyCard"-emergency card (it is used to assign
permission to a temporary card, but it cannot open the door)*/
"leaderCard":"",
/*optional, string, whether to support first card authentication function, e.g., the value "1,3,5" indicates that the
access control points No.1, No.3, and No.5 support first card authentication function*/
"checkCardNo":"",
/*optional, boolean, whether to enable duplicated card verification: "false"-disable, "true"-enable. If this node is not
configured, the device will verify the duplicated card by default. When there is no card information, you can set
checkCardNo to "false" to speed up data applying; otherwise, it is not recommended to configure this node*/
"checkEmployeeNo": ,
/*optional, boolean, whether to check the existence of the employee No. (person ID): "false"-no, "true"-yes. If this
node is not configured, the device will check the existence of the employee No. (person ID) by default. If this node is
set to "false", the device will not check the existence of the employee No. (person ID) to speed up data applying; if this
node is set to "true" or NULL, the device will check the existence of the employee No. (person ID), and it is
recommended to set this node to "true" or NULL if there is no need to speed up data applying*/
"addCard":
/*optional, boolean type, whether to add the card if the card information being edited does not exist: "false"-no (if
the device has checked that the card information being edited does not exist, the failure response message will be
returned along with the error code), "true"-yes (if the device has checked that the card information being edited does

315
 Device Network SDK (Access Control on Person) Developer Guide

not exist, the success response message will be returned, and the card will be added). If this node is not configured,
the card will not be added by default*/
}
}

Remarks
The employeeNo and cardNo cannot be edited. If you need to edit the cardNo, you should delete
the previous card and create a new card.

6.38 JSON_CardInfo_Collection
CardInfo message in JSON format
{
"CardInfo":{
"cardNo":"",
/*required, string, card No.*/
"cardType":""
/*optional, string, card type: "TypeA_M1", "TypeA_CPU", "TypeB", "ID_125K"*/
}
}

6.39 JSON_CardInfoCap
CardInfoCap capability message in JSON format
{
"CardInfoCap":{
"cardNo":{
/*required, string, card No.*/
"@min":1,
"@max":32
},
"cardType": ["TypeA_M1","TypeA_CPU","TypeB","ID_125K"]
/*optional, string, card type: "TypeA_M1", "TypeA_CPU", "TypeB", "ID_125K"*/
}
}

6.40 JSON_CardInfoCount
CardInfoCount message in JSON format
{
"CardInfoCount":{
"cardNumber":
/*number of cards*/

316
 Device Network SDK (Access Control on Person) Developer Guide

}
}

6.41 JSON_CardInfoDelCond
CardInfoDelCond message in JSON format
{
"CardInfoDelCond":{
"EmployeeNoList" :[{
/*optional, person ID list, if this node does not exist or is set to NULL, it indicates deleting all cards*/
"employeeNo":""
/*optional, string, employee No. (person ID)*/
}],
"CardNoList":[{
/*optional, card No. list (this node cannot exist together with the EmployeeNoList, and if this node does not exist or is
set to NULL, it indicates deleting all cards)*/
"cardNo":""
/*optional, string, card No.*/
}]
}
}

6.42 JSON_CardInfoSearch
CardInfoSearch message in JSON format
{
"CardInfoSearch":{
"searchID":"",
/*required, string, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"responseStatusStrg":"",
/*required, string, search status: "OK"-searching completed, "NO MATCH"-no matched results, "MORE"-searching for
more results*/
"numOfMatches": ,
/*required, integer32, number of returned results*/
"totalMatches": ,
/*required, integer32, total number of matched results*/
"CardInfo":[{
/*optional, person information*/
"employeeNo":"",
/*required, string, employee No. (person ID)*/
"cardNo":"",
/*required, string, card No.*/
"cardType":"",
/*required, string, card type: "normalCard"-normal card, "patrolCard"-patrol card, "hijackCard"-duress card,
"superCard"-super card, "dismissingCard"-dismiss card, "emergencyCard"-emergency card (it is used to assign

317
 Device Network SDK (Access Control on Person) Developer Guide

permission to a temporary card, but it cannot open the door)*/

"leaderCard":"",
/*optional, string, whether to support first card authentication function, e.g., the value "1,3,5" indicates that the
access control points No.1, No.3, and No.5 support first card authentication function*/
}]
}
}

6.43 JSON_CardInfoSearchCond
CardInfoSearchCond message in JSON format
{
"CardInfoSearchCond":{
"searchID":"",
/*required, string, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"searchResultPosition": ,
/*required, integer32, the start position of the search result in the result list. When there are multiple records and you
cannot get all search results at a time, you can search for the records after the specified position next time*/
"maxResults": ,
/*required, integer32, maximum number of search results. If maxResults exceeds the range returned by the device
capability, the device will return the maximum number of search results according to the device capability and will not
return error message*/
"EmployeeNoList":[{
/*optional, person ID list (if this node does not exist or is set to NULL, it indicates searching for all cards)*/
"employeeNo":""
/*optional, string, employee No. (person ID)*/
}],
"CardNoList":[{
/*optional, card No. list (this node cannot exist together with EmployeeNoList, and if this node does not exist or is set
to NULL, it indicates searching for all cards)*/
"cardNo":""
/*optional, string, card No.*/
}]
}
}

6.44 JSON_CardOperationsCap
JSON message about card operation capability
{
"CardOperationsCap":{
"SectionEncryption":{
"supportFunction":{
/*required, string, supported methods*/
"@opt": ["put", "get", "delete", "post"]

318
 Device Network SDK (Access Control on Person) Developer Guide

},
"sectionNo":{
/*required, integer, section No.*/
"@min": 0,
"@max": 0
},
"keyType":{
/*required, string, verification key types: "private"-private key, "normal"-other valid keys*/
"@opt": ["private", "normal"]
},
"password":{
/*optional, string, a hexadecimal verification key, this field is valid only when keyType is set to "nomal"*/
"@min": 0,
"@max": 0
},
"newKeyType":{
/*required, string, new key types: "private"-private key, "normal"-other valid keys*/
"@opt": ["private", "normal"]
},
"KeyA":{
/*optional, string, a hexadecimal key A password*/
"@min": 0,
"@max": 0
},
"KeyB":{
/*optional, string, a hexadecimal key B password*/
"@min": 0,
"@max": 0
},
"controlBits":{
/*optional, string, a hexadecimal control bit*/
"@min": 0,
"@max": 0
}
},
"Verification":{
"supportFunction":{
/*required, string, supported methods*/
"@opt": ["put", "get", "delete", "post"]
},
"sectionNo":{
/*required, integer, section No.*/
"@min": 0,
"@max": 0
},
"passwordType":{
/*optional, password types: "KeyA" (default), "KeyB"*/
"@opt": ["KeyA", "KeyB"]
},
"password":{
/*optional, string, a hexadecimal password*/
"@min": 0,

319
 Device Network SDK (Access Control on Person) Developer Guide

"@max": 0
}
},
"DataBlock":{
"supportFunction":{
/*required, string, supported methods*/
"@opt":["put", "get", "delete", "post"]
},
"addressOfBlock":{
/*optional, integer, block address*/
"@min": 0,
"@max": 0
},
"data":{
/*required, a hexBinary string, e.g., "f2345678abf2345678abf2345678abf2"*/
"@min": 0,
"@max": 0
},
},
"DataBlockCtrl":{
"supportFunction":{
/*required, string, supported methods*/
"@opt":["put", "get", "delete", "post"]
},
"addressOfBlock":{
/*required, integer, block address*/
"@min": 0,
"@max": 0
},
"command":{
/*required, string, control commands*/
"@opt": ["add", "minus", "copy", "paste"]
},
"value":{
/*depend, integer, relative value to be changed, this field is valid only when the command is set to "add" or "minus"*/
"@min": 0,
"@max": 0
},
},
"ControlBlock":{
"supportFunction":{
/*required, string, supported methods*/
"@opt": ["put", "get", "delete", "post"]
},
"sectionNo":{
/*required, integer, section No.*/
"@min": 0,
"@max": 0
},
"KeyA":{
/*optional, string, a hexadecimal key A*/
"@min": 0,

320
 Device Network SDK (Access Control on Person) Developer Guide

"@max": 0
},
"KeyB":{
/*optional, string, a hexadecimal key B*/
"@min": 0,
"@max": 0
},
"controlBits":{
/*optional, string, a hexadecimal control bit*/
"@min": 0,
"@max": 0
}
},
"CardProto":{
"supportFunction":{
/*required, string, supported methods*/
"@opt":["put", "get", "delete", "post"]
},
"protocol":{
/*required, string, operation protocol types*/
"@opt": ["TypeA", "TypeB", "TypeAB", "125K", "all"]
}
},
"CardEncryption":{
"supportFunction":{
/*required, string, supported methods*/
"@opt": ["put", "get", "delete", "post"]
},
"cardType":{
/*required, string, card types: "blank"-blank card, "private"-private CPU card, "encrypted"-other encrypted card*/
"@opt":[ "blank","private","encrypted"]
}
"keyLen":{
/*depend, integer, size of key for external authentication, this field is valid only when cardType is set to "encrypted"*/
"@min": 0,
"@max": 0
},
"key": {
/*required, hexadecimal string, a 16-byte key content for external authentication*/
"@min": 0,
"@max": 0
}
},
"CardParam":{
"supportFunction":{
/*required, string, supported methods*/
"@opt": ["put", "get", "delete", "post"]
},
"type":{
/*required, string, card types*/
"@opt": ["CPU1356", "PSAM1", "PSAM2","PSAM3","PSAM4"]
},

321
 Device Network SDK (Access Control on Person) Developer Guide

"protocol":{
/*required, string, card protocol types*/
"@opt": ["T0", "T1"]
}
},
"CardResetResponse":{
"supportFunction":{
/*required, string, supported methods*/
"@opt": ["put", "get", "delete", "post"]
},
"data":{
/*required, string, resetting response information (usually, it is manufacturer, which is encoded by Base64 and
specified by device*/
"@min": 0,
"@max": 0
}
},
"DataTrans":{
"supportFunction":{
/*required, string, supported methods*/
"@opt": ["put", "get", "delete", "post"]
},
"content":{
/*required, string, data to be passed through, which is encoded in Base64*/
"@min": 0,
"@max": 0
}
}
}
}

6.45 JSON_CardParam
JSON message about card parameters
{
"CardParam": {
"type": ""
/*required, string, card types: " CPU1356,PSAM1,PSAM2,PSAM3,PSAM4"*/
"protocol": ""
/*required, string, card protocol types: "T0,T1"*/
}
}

6.46 JSON_CardProto
JSON message about operation protocol types of card

322
 Device Network SDK (Access Control on Person) Developer Guide

{
"CardProto": {
"protocol": "TypeA"
/*required, string, operation protocol types: "TypeA,TypeB,TypeAB,125K,all"*/
}
}

6.47 JSON_CardReaderAntiSneakCfg
CardReaderAntiSneakCfg message in JSON format
{
"CardReaderAntiSneakCfg": {
"enable": ,
/*required, boolean, whether to enable the anti-passing back function of the card reader: "true"-enable, "false"-
disable*/
"followUpCardReader":
/*optional, array, following card reader No. after the first card reader, e.g., [2,3,4] indicates that card reader No. 2, No.
3, and No. 4 can be swiped after the first card reader*/
}
}

6.48 JSON_CardResetResponse
JSON message about card resetting response
{
"CardResetResponse": {
"data": ""
/*required, string, resetting response information (usually, it is manufacturer, which is encoded by Base64 and
specified by device*/
}
}

6.49 JSON_ClearAntiSneak
ClearAntiSneak message in JSON format
{
"ClearAntiSneak": {
"clearAll": ,
/*required, boolean, whether to clear all anti-passing back records: "true"-yes, "false"-no. Clearing all anti-passing
back records is not supported by access control devices version 2.1*/
"EmployeeNoList" : [{
/*optional, person ID list, this node is valid when clearAll is "false". For access control devices version 2.1, if this node
is not configured, failure response message will be returned*/

323
 Device Network SDK (Access Control on Person) Developer Guide

"employeeNo":""
/*optional, string, employee No. (person ID)*/
}]
}
}

6.50 JSON_ClearAntiSneakCfg
ClearAntiSneakCfg message in JSON format
{
"ClearAntiSneakCfg":{
"ClearFlags":{
"antiSneak":
/*required, boolean, whether to clear the anti-passing back parameters*/
}
}
}

6.51 JSON_ControlBlock
JSON message about the control block parameters of a specific section.
{
"ControlBlock": {
"sectionNo": ,
/*required, integer, section No.*/
"KeyA": "",
/*optional, string type, a hexadecimal key A password*/
"KeyB": "",
/*optional, string type, a hexadecimal key B password*/
"controlBits":""
/*optional, string type, a hexadecimal control bit*/
}
}

6.52 JSON_CreateFPLibCond
Message about the conditions of creating face picture library, and it is in JSON format.
{
"faceLibType": "",
/*required, string type, face picture library type: "infraredFD"-infrared face picture library, "blackFD"-list library,
"staticFD"-static library, the maximum size is 32 bytes*/
"name": "",
/*required, string type, face picture library name, it cannot be duplicated, the maximum size is 48 bytes*/
"customInfo": "",

324
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, string type, custom information, it is used to indicate the data property or uniqueness, the maximum size
is 192 bytes*/
}

6.53 JSON_CreateFPLibResult
Message about the results of creating face picture library, and it is in JSON format.
{
"requestURL": "",
"statusCode": "",
"statusString": "",
"subStatusCode": "",
"errorCode": "",
"errorMsg": "",
/*see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"FDID": ""
/*optional, string type, returned face picture library ID when it created, the library ID of the same type is unique, the
maximum length is 63 bytes. This node is valid when errorCode is 1 and errorMsg is "ok"*/
}

See Also
JSON_ResponseStatus

6.54 JSON_DataBlock
JSON message about data block details
{
"DataBlock": {
"addressOfBlock": ,
/*optional, integer, block address*/
"data": "",
/*required, string, a hexBinary character string, i.e., "f2345678abf2345678abf2345678abf2"*/
}
}

6.55 JSON_DataBlockCtrl
JSON message about operation parameters of data block
{
"DataBlockCtrl": {
"addressOfBlock": ,
/*required, integer, block address*/
"command":"",

325
 Device Network SDK (Access Control on Person) Developer Guide

/*required, string, control commands: "add, minus, copy, paste"*/

"value":,
/*depend, integer, relative value to be changed, this field is value only when the command is set to "add" or "minus"*/
}
}

6.56 JSON_DataOutputCfg
DataOutputCfg message in JSON format
{
"DataOutputCfg":{
"password":"",
/*required, string, password for exporting*/
"type":""
/*optional, string, exporting type, it is "USB" by default which refers to exporting via USB*/
}
}

6.57 JSON_DataOutputProgress
DataOutputProgress message in JSON format
{
"DataOutputProgress":{
"progress":
/*required, integer, exporting progress*/
}
}

6.58 JSON_DataTrans
JSON message about data package to be passed through
{
"DataTrans": {
"content": ""
/*required, string, data to be passed through, which is encoded by Base64*/
}
}

6.59 JSON_DelFaceRecord
Message about the parameters of deleting face records, and it is in JSON format.

326
 Device Network SDK (Access Control on Person) Developer Guide

{
"FPID":[
/*array, list of face record ID, it is the same as the employee No. (person ID). Deleting multiple face records in a batch
is supported*/
{
"value":""
/*required, string type, face record ID, the maximum length is 63 bytes*/
}
]
}

6.60 JSON_EditFPlibInfo
Message about the editing information of face picture library, and it is in JSON format.
{
"name": "",
/*optional, face picture library name, string type, the max. string length is 48 bytes*/
"customInfo": ""
/*optional, custom information, it is used to indicate the data property or uniqueness, string type, the max. string
length is 192 bytes*/
}

6.61 JSON_EventOptimizationCfg
EventOptimizationCfg message in JSON format
{
"EventOptimizationCfg":{
"enable":
/*optional, boolean, whether to enable event optimization: "true"-yes (default), "false"-no*/
}
}

6.62 JSON_FaceRecognizeMode
FaceRecognizeMode message in JSON format
{
"FaceRecognizeMode":{
/*required, facial recognition mode: "normalMode"-normal mode, "deepMode"-deep mode*/
"mode":""
}
}

327
 Device Network SDK (Access Control on Person) Developer Guide

6.63 JSON_FaceRecordNumInAllFPLib
Message about the total number of face records in all face picture libraries, and it is in JSON
format.
{
"requestURL": "",
"statusCode": "",
"statusString": "",
"subStatusCode": "",
"errorCode": "",
"errorMsg": "",
/*see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"FDRecordDataInfo":[{
/*optional, string type, information of face records in face picture library, this node is valid when errorCode is 1 and
errorMsg is "ok"*/
"FDID": "",
/*optional, face picture library ID, string type, the maximum size is 63 bytes*/
"faceLibType": "",
/*optional, face picture library type: "blackFD"-list library, "staticFD"-static library, string type, the maximum size is 32
bytes*/
"name": "",
/*optional, face picture library name, string type, the maximum size is 48 bytes*/
"recordDataNumber": ""
/*optional, number of records, integer32 type*/
}]
}

See Also
JSON_ResponseStatus

6.64 JSON_FaceRecordNumInOneFPLib
Message about the number of face records in a specific face picture library, and it is in JSON
format.
{
"requestURL": "",
"statusCode": "",
"statusString": "",
"subStatusCode": "",
"errorCode": "",
"errorMsg": "",
/*see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"FDID": "",
/*optional, face picture library ID, string type, the max. string length is 63 bytes*/
"faceLibType": "",
/*optional, face picture library type: "blackFD"-list library, "staticFD"-static library, string type, the max. string length is

328
 Device Network SDK (Access Control on Person) Developer Guide

32 bytes*/
"name": "",
/*optional, face picture library name, string type, the max. string length is 48 bytes*/
"recordDataNumber": ""
/*optional, number of records, integer32 type*/
}

See Also
JSON_ResponseStatus

6.65 JSON_FingerPrintCfg
FingerPrintCfg message in JSON format
{
"FingerPrintCfg":{
"employeeNo":"",
/*required, string, employee No. (person ID) linked with the fingerprint*/
"enableCardReader": ,
/*required, array, fingerprint modules to apply fingerprint data to, e.g., [1,3,5] indicates applying fingerprint data to
fingerprint modules No.1, No.3, and No.5*/
"fingerPrintID": ,
/*required, integer, fingerprint No., which is between 1 and 10*/
"deleteFingerPrint": ,
/*optional, boolean, whether to delete the fingerprint: "true"-yes. This node is required only when the fingerprint
needs to be deleted; for adding or editing fingerprint information, this node can be set to NULL*/
"fingerType":"",
/*required, string, fingerprint type: "normalFP"-normal fingerprint, "hijackFP"-duress fingerprint, "patrolFP"-patrol
fingerprint, "superFP"-super fingerprint, "dismissingFP"-dismiss fingerprint*/
"fingerData":"",
/*required, string, fingerprint data encoded by Base64*/
"leaderFP": ,
/*optional, array, whether the access control points support first fingerprint authentication function, e.g., [1,3,5]
indicates that access control points No.1, No.3, and No.5 support first fingerprint authentication function*/
"checkEmployeeNo":
/*optional, boolean, whether to check the existence of the employee No. (person ID): "false"-no, "true"-yes. If this
node is not configured, the device will check the existence of the employee No. (person ID) by default. If this node is
set to "false", the device will not check the existence of the employee No. (person ID) to speed up data applying; if this
node is set to "true" or NULL, the device will check the existence of the employee No. (person ID), and it is
recommended to set this node to "true" or NULL if there is no need to speed up data applying*/
}
}

6.66 JSON_FingerPrintCond
FingerPrintCond message in JSON format

329
 Device Network SDK (Access Control on Person) Developer Guide

{
"FingerPrintCond":{
"searchID":"",
/*required, string, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"employeeNo":"",
/*required, string, employee No. (person ID) linked with the fingerprint*/
"cardReaderNo": ,
/*optional, integer, fingerprint module No.*/
"fingerPrintID":
/*optional, integer, fingerprint No., which is between 1 and 10*/
}
}

6.67 JSON_FingerPrintDelete
FingerPrintDelete message in JSON format
{
"FingerPrintDelete":{
"mode":"",
/*required, string, deleting mode: "byEmployeeNo"-delete by employee No. (person ID), "byCardReader"-delete by
fingerprint module*/
"EmployeeNoDetail":{
/*optional, delete by employee No. (person ID), this node is valid when mode is "byEmployeeNo"*/
"employeeNo":"",
/*optional, string, employee No. (person ID) linked with the fingerprint*/
"enableCardReader": ,
/*optional, array, fingerprint module whose fingerprints should be deleted, e.g., [1,3,5] indicates that the fingerprints
of fingerprint modules No.1, No.3, and No.5 are deleted*/
"fingerPrintID":
/*optional, array, No. of fingerprint to be deleted, e.g., [1,3,5] indicates deleting fingerprint No.1, No.3, and No.5*/
},
"CardReaderDetail":{
/*optional, delete by fingerprint module, this node is valid when mode is "byCardReader"*/
"cardReaderNo": ,
/*optional, integer, fingerprint module No.*/
"clearAllCard": ,
/*optional, boolean, whether to delete the fingerprint information of all cards: "false"-no (delete by employee No.),
"true"-yes (delete the fingerprint information of all employee No.)*/
"employeeNo":""
/*optional, string, employee No. (person ID) linked with the fingerprint, this node is valid when clearAllCard is
"false"*/
}
}
}

330
 Device Network SDK (Access Control on Person) Developer Guide

6.68 JSON_FingerPrintDeleteProcess
FingerPrintDeleteProcess message in JSON format
{
"FingerPrintDeleteProcess":{
"status":""
/*required, string, deleting status: "processing"-deleting, "success"-deleted, "failed"-deleting failed*/
}
}

6.69 JSON_FingerPrintInfo
FingerPrintInfo message in JSON format
{
"FingerPrintInfo":{
"searchID":"",
/*required, string, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"status":"",
/*required, string, status: "OK"-the fingerprint exists, "NoFP"-the fingerprint does not exist*/
"FingerPrintList":[{
"cardReaderNo": ,
/*required, integer, fingerprint module No.*/
"fingerPrintID": ,
/*required, integer, fingerprint No., which is between 1 and 10*/
"fingerType":"",
/*required, string, fingerprint type: "normalFP"-normal fingerprint, "hijackFP"-duress fingerprint, "patrolFP"-patrol
fingerprint, "superFP"-super fingerprint, "dismissingFP"-dismiss fingerprint*/
"fingerData":"",
/*required, string, fingerprint data encoded by Base64*/
"leaderFP":
/*optional, array, whether the access control points support first fingerprint authentication function, e.g., [1,3,5]
indicates that access control points No.1, No.3, and No.5 support first fingerprint authentication function*/
}]
}
}

6.70 JSON_FingerPrintModify
FingerPrintModify message in JSON format
{
"FingerPrintModify":{
"employeeNo":"",

331
 Device Network SDK (Access Control on Person) Developer Guide

/*required, string, employee No. (person ID) linked with the fingerprint*/
"cardReaderNo": ,
/*required, integer, fingerprint module No.*/
"fingerPrintID": ,
/*required, integer, fingerprint No., which is between 1 and 10*/
"fingerType":"",
/*required, string, fingerprint type: "normalFP"-normal fingerprint, "hijackFP"-duress fingerprint, "patrolFP"-patrol
fingerprint, "superFP"-super fingerprint, "dismissingFP"-dismiss fingerprint. If this node is not configured, the
fingerprint type will be the original type*/
"leaderFP": ,
/*optional, array, whether the access control points support first fingerprint authentication function, e.g., [1,3,5]
indicates that access control points No.1, No.3, and No.5 support first fingerprint authentication function. If this node
is not configured, the first fingerprint authentication function will remain unchanged*/
}
}

6.71 JSON_FingerPrintStatus
FingerPrintStatus message in JSON format
{
"FingerPrintStatus":{
"status":"",
/*optional, string, status: "success", "failed". This node will be returned only when editing fingerprint parameters or
deleting fingerprints; for applying fingerprint data to the fingerprint module, this node will not be returned*/
"StatusList":[{
/*optional, status list. This node will be returned only when applying fingerprint data to the fingerprint module; for
editing fingerprint parameters or deleting fingerprints, this node will not be returned*/
"id": ,
/*optional, integer, fingerprint module No.*/
"cardReaderRecvStatus": ,
/*optional, integer, fingerprint module status: 0-connecting failed, 1-connected, 2-the fingerprint module is offline, 3-
the fingerprint quality is poor, try again, 4-the memory is full, 5-the fingerprint already exists, 6-the fingerprint ID
already exists, 7-invalid fingerprint ID, 8-this fingerprint module is already configured, 10-the fingerprint module
version is too old to support the employee No.*/
"errorMsg":"",
/*optional, string, error information*/
}],
"totalStatus":
/*required, integer, applying status: 0-applying, 1-applied*/
}
}

6.72 JSON_FPLibCap
Face picture library capability message, and it is in JSON format.
{
"requestURL":"",

332
 Device Network SDK (Access Control on Person) Developer Guide

"statusCode": ,
"statusString":"",
"subStatusCode":"",
"errorCode": ,
"errorMsg":" ",
/*see the description of this node and the above nodes in the message of JSON_ResponseStatus*/
"FDNameMaxLen": ,
/*required, integer32 type, maximum length of face picture library name, the default value is 64 bytes*/
"customInfoMaxLen": ,
/*required, integer32 type, maximum length of custom information, the default value is 256 bytes*/
"FDMaxNum": ,
/*required, integer32 type, maximum number of face picture libraries, the default value is 3*/
"FDRecordDataMaxNum": ,
/*required, integer type, maximum face records supported by face picture library*/
"supportFDFunction":"post,delete,put,get,setUp",
/*required, the supported operations on face picture library: "post"-create, "delete"-delete, "put"-edit, "get"-search,
"setUp"-set*/
"isSuportFDSearch": ,
/*required, boolean type, whether supports searching in face picture library: "true"-yes, "false"-no*/
"isSupportFDSearchDataPackage": ,
/*required, boolean type, whether supports packaging the found data in the face picture library: "true"-yes, "false"-
no*/
"isSuportFSsearchByPic": ,
/*required, boolean type, whether supports searching by picture in the face picture library: "true"-yes, "false"-no*/
"isSuportFSsearchByPicGenerate": ,
/*required, boolean type, whether supports exporting search by picture results from the face picture library: "true"-
yes, "false"-no*/
"isSuportFDSearchDuplicate": ,
/*required, boolean type, whether supports duplication checking: "true"-yes, "false"-no*/
"isSuportFDSearchDuplicateGenerate": ,
/*required, boolean type, whether supports exporting the duplication checking results: "true"-yes, "false"-no*/
"isSuportFCSearch": ,
/*required, boolen type, whether supports searching face picture comparison alarms: "true"-yes, "false"-no*/
"isSupportFCSearchDataPackage": ,
/*required, boolean, whether supports packaging the search results of face picture comparison alarms: "true"-yes,
"false"-no*/
"isSupportFDExecuteControl": ,
/*required, boolean, whether supports creating relation between face picture libraries and cameras: "true"-yes,
"false"-no*/
"generateMaxNum": ,
/*required, integer32 type, maximum face records can be exported from face picture library*/
"faceLibType":"blackFD,staticFD,infraredFD",
/*optional, string type, face picture library types: "blackFD"-list library, "staticFD"-static library, "infraredFD"-infrared
face picture library, the maximum size of value can be assigned to this node is 32 bytes*/
"modelMaxNum": ,
/*optional, integer type, the maximum number of search results, the default value is 100*/
"isSupportModelData":true
/*optional, boolean type, whether to support applying model data: "true"-yes, this node is not returned-no*/
}

333
 Device Network SDK (Access Control on Person) Developer Guide

See Also
JSON_ResponseStatus

6.73 JSON_FPLibListInfo
Message about the list of face picture libraries, and it is in JSON format.
{
"requestURL": "",
"statusCode": "",
"statusString": "",
"subStatusCode": "",
"errorCode": "",
"errorMsg": "",
/*see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"FDLib":[
/*optional, face picture library information, string type, this node is valid when errorCode is 1 and errorMsg is "ok"*/
{
"FDID": "",
/*optional, face picture library ID, string type, the maximum size is 63 bytes*/
"faceLibType": "",
/*optional, face picture library type: "blackFD"-list library, "staticFD"-static library, string type, the maximum size is 32
bytes*/
"name": "",
/*optional, face picture library name, string type, the maximum size is 48 bytes*/
"customInfo": ""
/*optional, custom information, string type, the maximum size is 192 bytes*/
}
]
}

See Also
JSON_ResponseStatus

6.74 JSON_IdentityInfo
IdentityInfo message in JSON format
{
"IdentityInfo":{
"chnName":"",
/*optional, string, reserved*/
"enName":"",
/*optional, string, English name*/
"sex":"",
/*optional, string, gender: "male", "female"*/
"birth":"",

334
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, string, date of birth, e.g., 1990-02-24*/

"addr":"",
/*optional, string, address*/
"IDCardNo":"",
/*optional, string, ID card No., it is the sensitive information that should be encrypted*/
"issuingAuthority":"",
/*optional, string, authority*/
"startDate":"",
/*optional, string, start time of the validity period*/
"endDate":"",
/*optional, string, end time of the validity period*/
"nation": ,
/*optional, integer, reserved*/
"passNo":"",
/*optional, string, entry-exit permit No.*/
"issueNumber":"",
/*optional, string, issuing times*/
"certificateType":"",
/*optional, string, certificate type*/
"permanentResidenceCardNo":"",
/*optional, string, permanent resident card No.*/
"nationalityOrAreaCode":"",
/*optional, string, country or region code*/
"version":"",
/*optional, string, certificate version No.*/
"receivingAuthorityCode":"",
/*optional, string, acceptance authority code*/
"FingerprintList":[{
"fingerprint":""
/*optional, string, fingerprint information, it is encoded using base64*/
}],
"pic":""
/*optional, string, ID photo information, it is encoded using base64. The encrypted data should be decrypted using
the specific decryption library*/
}
}

6.75 JSON_IdentityInfoCap
IdentityInfoCap capability message in JSON format
{
"IdentityInfoCap":{
"IdentityInfoCond":{ },
/*optional, conditions of collecting ID card information*/
"chnName":{
/*optional, string, reserved*/
"@min":0,
"@max":0
},

335
 Device Network SDK (Access Control on Person) Developer Guide

"enName":{
/*optional, string, English name*/
"@min":0,
"@max":0
},
"sex":{
/*optional, string, gender: "male", "female"*/
"@opt":["male", "female"]
},
"birth":{
/*optional, string, date of birth, e.g., 1990-02-24*/
"@min":0,
"@max":0
},
"addr":{
/*optional, string, address*/
"@min":0,
"@max":0
},
"IDCardNo":{
/*optional, string, ID card No.*/
"@min":0,
"@max":0
},
"issuingAuthority":{
/*optional, string, authority*/
"@min":0,
"@max":0
},
"startDate":{
/*optional, string, start time of the validity period*/
"@min":0,
"@max":0
},
"endDate":{
/*optional, string, end time of the validity period*/
"@min":0,
"@max":0
},
"nation":{
/*optional, integer, reserved*/
"@min":0,
"@max":0
},
"passNo":{
/*optional, string, entry-exit permit No.*/
"@min":0,
"@max":0
},
"issueNumber":{
/*optional, string, issuing times*/
"@min":0,

336
 Device Network SDK (Access Control on Person) Developer Guide

"@max":0
},
"certificateType":{
/*optional, string, certificate type*/
"@min":0,
"@max":0
},
"permanentResidenceCardNo":{
/*optional, string, permanent resident card No.*/
"@min":0,
"@max":0
},
"nationalityOrAreaCode":{
/*optional, string, country or region code*/
"@min":0,
"@max":0
},
"version":{
/*optional, string, certificate version No.*/
"@min":0,
"@max":0
},
"receivingAuthorityCode":{
/*optional, string, acceptance authority code*/
"@min":0,
"@max":0
},
"FingerprintList":{
"maxSize":0,
"fingerprint":{
/*optional, string, fingerprint information, it is encoded using base64. This field is the data size capability*/
"@min":0,
"@max":0
}
},
"pic":{
/*optional, string, ID photo information, it is encoded using base64. This field is the data size capability*/
"@min":0,
"@max":0
}
}
}

6.76 JSON_IdentityInfoCond
IdentityInfoCond message in JSON format
{
"IdentityInfoCond":{ }

337
 Device Network SDK (Access Control on Person) Developer Guide

/*currently there are no condition parameters, so this field can be set to NULL*/
}

6.77 JSON_IRCfg
JSON message about active infrared intrusion parameters
{
"IRCfg": {
"enable": ,
/*required, boolean, whether to enable: true (yes), false (no)*/
"distance":
/*optional, float, distance, unit: m*/
}
}

6.78 JSON_IRCfgCap
JSON message about active infrared intrusion capability
{
"IRCfgCap": {
"enable":[true,false],
/*required, boolean, whether to enable*/
"distance":{
"@opt":[0.5,1,1.5]
}
}
}

6.79 JSON_LogModeCfg
LogModeCfg message in JSON format
{
"LogModeCfg":{
"type":
/*optional, integer, log mode: 1-16 bytes (the host log can be stored by 25w, and the employee No. can be stored by
16 bytes), 2-12 bytes (the host log can be stored by 25w, and the employee No. can be stored by 12 bytes). This node
will be set to 1 by default*/
}
}

338
 Device Network SDK (Access Control on Person) Developer Guide

6.80 JSON_NFCCfg
NFCCfg message in JSON format
{
"NFCCfg":{
"enable":
/*required, boolean, whether to enable NFC function: "true"-yes, "false"-no*/
}
}

6.81 JSON_NFCCfgCap
NFCCfgCap capability message in JSON format
{
"NFCCfgCap":{
"enable":"true, false"
/*required, whether to enable NFC function: "true"-yes, "false"-no (default)*/
}
}

6.82 JSON_OfflineCaptureCap
OfflineCaptureCap capability message in JSON format
{
"OfflineCaptureCap":{
"isSuportDownloadOfflineCaptureInfoTemplate":true,
/*optional, whether it supports downloading template of offline user list: "true"-yes, this node is not returned-no*/
"isSuportUploadOfflineCaptureInfo":true,
/*optional, whether it supports uploading offline user list: "true"-yes, this node is not returned-no*/
"isSupportDownloadCaptureData":true,
/*optional, whether it supports downloading collected data: "true"-yes, this node is not returned-no*/
"isSupportDeleteAllData":true,
/*optional, whether it supports deleting all collected data: "true"-yes, this node is not returned-no*/
"isSupportDeleteTheData":true,
/*optional, whether it supports deleting specific collected data: "true"-yes, this node is not returned-no*/
"SearchTask":{
"supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
"@opt":["put", "get", "delete", "post"]
},
"searchID":{
/*required, string, search ID which is used to check whether the upper-layer clients are the same one*/
"@min":0,
"@max":0

339
 Device Network SDK (Access Control on Person) Developer Guide

},
"maxResults":{
"@min":0,
"@max":0
},
"captureNoList":{
"maxSize":0,
"@min":0,
"@max":0
},
"searchType":{
"@opt":["new", "modified"]
},
"DataCollections":{
/*optional, array, matched data information that has been searched*/
"maxSize":0,
"captureNo":{
/*optional, integer, collection No.*/
"@min":0,
"@max":0
},
"name":{
/*optional, string, name*/
"@min":0,
"@max":0
},
"employeeNo":{
/*optional, string, employee No.*/
"@min":0,
"@max":0
},
"CardNoList":{
/*optional, string, card No. list*/
"maxSize":0,
"@min":0,
"@max":0
},
"IDCardNo":{
/*optional, string, ID card No.*/
"@min":0,
"@max":0
},
"FingerprintList":{
"fingerprintID":{
"@min":0,
"@max":0
},
"fingerprint":{
/*optional, fingerprint information, it is encoded using base64*/
"@min":0,
"@max":0
}

340
 Device Network SDK (Access Control on Person) Developer Guide

},
"FaceFeature":{
/*optional, string, facial feature information*/
"isSupportFaceRegion":true,
/*optional, whether it supports facial feature area*/
"isSupportCommonPoint":true
/*optional, whether it supports feature point coordinates (e.g., left eye, right eye, left mouth corner, right mouth
corner, nose)*/
},
"isSupportRiskMark":true,
/*optional, whether it supports risk data mark*/
"dataType":{
/*optional, data type*/
"@opt":["new", "modified","normal"]
}
}
},
"RuleInfo":{
/*rule list, which lists rules for collecting different types of data*/
"reqAdminRights":[true,false],
/*required, boolean, whether the administrator permission is required: "true"-yes, "false"-no*/
"enableCardNoLenAuto":[true,false],
/*optional, boolean, whether to enable length self-adaption of the card serial No.*/
"maxSize":0,
"supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
"@opt":["put", "get", "delete", "post"]
},
"dataType":{
/*required, string, data type: "name", "employeeNo"-employee No., "IDCardNo"-ID card No., "IDCardSerialNo"-ID
card serial No., "IDCardDetails"-ID card details, "card", "fingprint"-fingerprint, "face"*/
"@opt":["name","employeeNo","IDCardNo","IDCardSerialNo", "IDCardDetails","card", "fingprint", "face"]
},
"enable":[true, false],
/*required, string, whether to collect and display: "true"-collect and display, "false"-not collect and display*/
"uniqueCheck":[true, false],
/*dependency, boolean, whether to enable uniqueness verification: "true"-yes, "false" (default) or this node is not
returned-no. This field is valid when dataType is "name". For other data types, the field is the read-only optional
parameter*/
"len":[{
/*dependency, integer, data length. If dataType is "name", it refers to the name length and the default value is 128.
For other data types, this field is the read-only optional parameter. This node will not be returned if it is not
supported. The capability list will be returned according to the data type*/
"dataType":"",
"@min":0,
"@max":0
}],
"num":[{
/*dependency, integer, number of collected data, this field is valid when dataType is "fingerprint" or "card". The
capability list will be returned according to the data type*/
"dataType":"",
"@min":0,

341
 Device Network SDK (Access Control on Person) Developer Guide

"@max":0
}],
"fingerprintIDs":{
/*dependency, integer, No. list of collected fingerprints, this field is valid when dataType is "fingerprint"*/
"maxSize":0,
"@min":0,
"@max":0
}
},
"CaptureProgress":{
"supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
"@opt":["put", "get", "delete", "post"]
},
"reqCaptureNum":{
/*optional, integer, total number of persons to be collected*/
"@min":0,
"@max":0
},
"completelyCaptureNum":{
/*optional, integer, number of completely collected persons*/
"@min":0,
"@max":0
},
"partiallyCaptureNum":{
/*optional, integer, number of partially collected persons*/
"@min":0,
"@max":0
},
"reqFaceNum":{
/*optional, integer, number of faces to be collected*/
"@min":0,
"@max":0
},
"faceNum":{
/*optional, integer, number of collected faces*/
"@min":0,
"@max":0
},
"reqFingerprintNum":{
/*optional, integer, number of fingerprints to be collected*/
"@min":0,
"@max":0
},
"fingerprintNum":{
/*optional, integer, number of collected fingerprints*/
"@min":0,
"@max":0
},
"reqCardNum":{
/*optional, integer, number of cards to be collected*/
"@min":0,

342
 Device Network SDK (Access Control on Person) Developer Guide

"@max":0
},
"cardNum":{
/*optional, integer, number of collected cards*/
"@min":0,
"@max":0
},
"reqIDCardNum":{
/*optional, integer, number of ID cards to be collected*/
"@min":0,
"@max":0
},
"IDCardNum":{
/*optional, integer, number of collected ID cards*/
"@min":0,
"@max":0
}
},
"DataOutput":{
"supportFunction":{
/*required, string, supported methods, actually supported methods will be returned*/
"@opt":["put", "get", "delete", "post"]
},
"password":{
/*required, string, password for exporting*/
"@min":0,
"@max":0
},
"type":{
/*optional, string, exporting method, the default method is "USB"*/
"@opt":"USB"
},
"progress":{
/*required, integer, exporting progress*/
"@min":0,
"@max":0
}
}
}
}

6.83 JSON_OSDPModify
OSDPModify message in JSON format
{
"OSDPModify":{
"newID":
/*required, integer, new ID of the OSDP card reader*/

343
 Device Network SDK (Access Control on Person) Developer Guide

}
}

6.84 JSON_OSDPStatus
OSDPStatus message in JSON format
{
"OSDPStatus":{
"status":""
/*required, string, online status: "online", "offline"*/
}
}

6.85 JSON_PictureServerInformation
PictureServerInformation message in JSON format
{
"PictureServerInformation":{
"pictureServerType":"",
/*required, string type, picture storage server type: "tomact,VRB,cloudStorage,KMS"*/
"addressingFormatType":"",
/*required, string type, format type of the picture storage server address: "ipaddress"-IP address (default),
"hostname"-host name*/
"hostName":"",
/*string type, domain name of the picture storage server, the string length is between 0 and 64. This field is valid
when addressingFormatType is "hostname"*/
"ipv4Address":"",
/*string type, IPv4 address of the picture storage server, the string length is between 0 and 64. This field is valid when
addressingFormatType is "ipaddress"*/
"ipv6Address":"",
/*string type, IPv6 address of the picture storage server, the string length is between 0 and 128. This field is valid
when addressingFormatType is "ipaddress"*/
"portNo": ,
/*required, integer type, port No. of the picture storage server, which is between 1024 and 65535*/
"underlyingProtocol":"",
/*optional, string, bottom-level protocol of the picture storage server: "HTTP", "HTTPS". This field is valid when
pictureServerType contains "cloudStorage". If this field does not exist, the default bottom-level protocol is HTTP*/
"cloudStorage":{
/*parameters of the clould storage server, which is valid when pictureServerType is "cloudStorage"*/
"cloudManageHttpPort": ,
/*required, integer type, HTTP port No. for central management of the cloud storage server, which is between 1024
and 65535*/
"cloudTransDataPort": ,
/*required, integer type, data transmission port No. of the cloud storage server, which is between 1024 and 65535*/
"cloudCmdPort": ,
/*required, integer type, signaling port No. of the cloud storage server, which is between 1024 and 65535*/
"cloudHeartBeatPort": ,

344
 Device Network SDK (Access Control on Person) Developer Guide

/*required, integer type, heartbeat port No. of the cloud storage server, which is between 1024 and 65535*/
"cloudStorageHttpPort": ,
/*required, integer type, HTTP port No. of the cloud storage server, which is between 1024 and 65535*/
"cloudUsername":"",
/*required, string type, user name of the cloud storage server, the string length is between 0 and 32*/
"cloudPassword":"",
/*required, string type, password of the cloud storage server, the string length is between 0 and 32*/
"cloudPoolId": ,
/*required, integer type, cloud storage pool ID, which is between 1 and 4294967295. If this field is not configured by
the upper-level, this field will be set to 1 by default*/
"cloudPoolIdEx":"",
/*optional, string type, cloud storage pool ID, this node is valid when cloud storage pool ID in string type is
supported*/
"clouldProtocolVersion":"",
/*required, string type, protocol version of the cloud storage server, the string length is between 0 and 32*/
"clouldAccessKey":"",
/*string type, cloud storage server access_key, the string length is between 0 and 64. This field is valid when
clouldProtocolVersion is "V2.0"*/
"clouldSecretKey":""
/*string type, cloud storage server secret_key, the string length is between 0 and 64. This field is valid when
clouldProtocolVersion is "V2.0"*/
}
}
}

6.86 JSON_PrinterCfg
PrinterCfg message in JSON format
{
"PrinterCfg": {
/*required, boolean, whether to enable the printer*/
"enable": ,
"printFormat": {
"vistorPic": {
/*optional, visitor picture*/
"enable": ,
/*required, boolean, whether to print visitor picture*/
"lineNo":
/*required, integer, line No.*/
},
"vistorName": {
/*optional, visitor name*/
"enable": ,
/*required, boolean, whether to print visitor name*/
"lineNo":
/*required, integer, line No.*/
},
"certificateNumber": {
/*optional, visitor's certificate No.*/

345
 Device Network SDK (Access Control on Person) Developer Guide

"enable": ,
/*required, boolean, whether to print visitor's certificate No.*/
"lineNo":
/*required, integer, line No.*/
},
"address": {
/*optional, visitor's address*/
"enable": ,
/*required, boolean, whether to print visitor's address*/
"lineNo":
/*required, integer, line No.*/
},
"validity": {
/*optional, expiry date*/
"enable": ,
/*required, whether to print the expiry date*/
"lineNo":
/*required, integer, line No.*/
},
"receptionDepartment": {
/*optional, reception department*/
"enable": ,
/*required, boolean, whether to print the reception department*/
"lineNo":
/*required, integer, line No.*/
},
"receptionStaff": {
/*optional, receptionist information*/
"enable": ,
/*required, boolean, whether to print the receptionist information*/
"lineNo":
/*required, integer, line No.*/
},
"registrationTime": {
/*optional, registered time*/
"enable": ,
/*optional, whether to print the registered time*/
"lineNo":
/*required, integer, line No.*/
},
}
}
}

6.87 JSON_RemoteControlBuzzer
RemoteControlBuzzer message in JSON format
{
"RemoteControlBuzzer":{

346
 Device Network SDK (Access Control on Person) Developer Guide

"cmd":""
/*required, string, command: "start"-start buzzing, "stop"-stop buzzing*/
}

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

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

6.89 JSON_RFCardCfg
RFCardCfg message in JSON format
{
"RFCardCfg":[{
"cardType":"",
/*required, string, card type: "EMCard"-EM card, "M1Card"-M1 card, "CPUCard"-CPU card, "IDCard"-ID card*/
"enabled":
/*required, boolean, whether to enable RF card recognition: "true"-yes, "false"-no*/
}]
}

6.90 JSON_RFCardCfgCap
RFCardCfgCap capability message in JSON format

347
 Device Network SDK (Access Control on Person) Developer Guide

{
"RFCardCfgCap":{
"cardType":{
/*required, string, card type: "EMCard"-EM card, "M1Card"-M1 card, "CPUCard"-CPU card, "IDCard"-ID card*/
"@opt":["EMCard","M1Card","CPUCard","IDCard"]
},
"enabled":{
/*required, boolean, whether to enable RF card recognition: "true"-yes, "false"-no*/
"@opt":[true,false]
}
}
}

6.91 JSON_RuleInfo
RuleInfo message in JSON format
{
"RuleInfo":{
"reqAdminRights": ,
/*required, boolean, whether the administrator permission is required: "true"-yes, "false"-no*/
"enableCardNoLenAuto": ,
/*optional, boolean, whether to enable length self-adaption of the card serial No. The priority of this field is higher
than len*/
"RuleList":[{
/*rule list, which contains rules for collecting different types of data*/
"dataType":"",
/*required, string, data type: "name", "employeeNo"-employee No., "IDCardNo"-ID card No., "IDCardSerialNo"-ID
card serial No., "IDCardDetails"-ID card details, "card", "fingprint"-fingerprint, "face"*/
"enable": ,
/*required, boolean, whether to collect and display: "true"-collect and display, "false"-not collect and display*/
"uniqueCheck": ,
/*dependency, boolean, whether to enable uniqueness verification: "true"-yes, "false" (default) or this field is not
returned-no. This field is valid when dataType is "name". For other data types, this field is the read-only optional
parameter*/
"len": ,
/*dependency, integer, data length, this field is valid when dataType is "name", "enployeeNo" or "card". The default
data length of name is 128. For other data types, this field is the read-only optional parameter. If it is not supported,
this field will not be returned*/
"num": ,
/*dependency, integer, number of collected data, this field is valid when dataType is "fingerprint" or "card"*/
"fingerprintIDs":
/*dependency, integer, ID list of fingerprints that need to be collected, this field is valid when dataType is
"fingerprint"*/
}]
}
}

348
 Device Network SDK (Access Control on Person) Developer Guide

6.92 JSON_SearchFaceRecordCond
Message about conditions of searching for face records, and it is in JSON format.
{
"searchResultPosition": "",
/*required, initial position of search result list, integer32 type. When there are multiple records, and cannot get all
records in one time searching, you can search the records followed specified position for next search*/
"maxResults": "",
/*required, int32 type, maximum number of records for single searching. If maxResults exceeds the range defined by
the device capability, the device will return the maximum number of records according to the device capability and
will not return error*/
"faceLibType": "",
/*required, face picture library type: "blackFD"-list library, "staticFD"-static library, string type, the maximum size is 32
bytes*/
"FDID": "",
/*required, face picture library ID, string type, the maximum size is 63*/
"FPID": "",
/*optional, string type, face record ID, it can be generated by device or inputted. If it is inputted, it should be the
unique ID with the combination of letters and digits, and the maximum length is 63 bytes; if it is generated by the
device automatically, it is the same as the employee No. (person ID)*/
"startTime": "",
/*optional, start time, ISO8601 time format, string type, the maximum size is 32 bytes*/
"endTime": "",
/*optional, end time, ISO8601 time format, string type, the maximum size is 32 bytes*/
"name": "",
/*optional, name, string type, the maximum size is 96 bytes*/
"gender": "",
/*optional, gender: male, female, unknown, string type, the maximum size is 10*/
"city": "",
/*optional, city code of birth for the person in the face picture, string type, the maximum size is 32 bytes*/
"certificateType": "",
/*optional, string type, the maximum size is 10 bytes, certificate type: "officerID"-officer ID, "ID"-identify card,
passport, other*/
"certificateNumber": ""
/*optional, certificate No., string, the maximum size is 32 bytes*/
"isInLibrary": "yes",
/*optional, string type, whether the picture is in library (whether modeling is successful): unknown, no, yes*/
"isDisplayCaptureNum": true,
/*optional, boolean type, whether to display number of captured pictures, true: display, false: hide, by default it is
false*/
"rowKey ":"",
/*optional, string type, face picture library main key. Search by rowKey can be more efficient, the maximum size is 64
bytes*/
"transfer":true
/*optional, boolean type, whether to enable transfer*/
}

349
 Device Network SDK (Access Control on Person) Developer Guide

6.93 JSON_SearchFaceRecordResult
Message about result of searching for face record.
{
"requestURL": "",
"statusCode": "",
"statusString": "",
"subStatusCode": "",
"errorCode": "",
"errorMsg": "",
/*see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"responseStatusStrg": "",
/*optional, searching status: "OK"-searching ended, "NO MATCHES"-no data found, "MORE"-searching, string type,
the max. size is 32 bytes. It is valid only when errorCode is 1 and errorMsgis ok*/
"searchResultPosition": "",
/*optional, initial position of search result list, integer32 type. It is valid only when errorCode is 1 and errorMsgis ok*/
"numOfMatches": "",
/*optional, returned number of results for current search, integer32. It is valid only when errorCode is 1 and
errorMsgis ok*/
"totalMatches": "",
/*optional, total number of matched results, integer32. It is valid only when errorCode is 1 and errorMsgis ok*/
"MatchList":[
/*optional, searched matched data information, array. It is valid only when errorCode is 1 and errorMsgis ok*/
{
"FPID":"",
/*optional, string type, face record ID (it is the same as the employee No. (person ID)), the maximum length is 63
bytes*/
"faceURL":"",
/*optional, face picture URL, string type, the maximum size is 128 bytes*/
"name":"",
/*required, name of person in the face picture, string type, the maximum size is 96 bytes*/
"gender": "",
/*optional, gender of person in the face picture: male, female, unknown, string type, the maximum size is 32 bytes*/
"bornTime": "",
/*required, birthday of person in the face picture, ISO8601 time format, string type, the maximum size is 20 bytes*/
"city": "",
/*optional, city code of birth for the person in the face picture, string type, the maximum size is 32 bytes*/
"certificateType": "",
/*optional, string type, the max. size is 10 bytes, certificate type: "officerID"-officer ID, "ID"-identify card, passport,
other*/
"certificateNumber": "",
/*optional, certificate No., string, the max. size is 32 bytes*/
"caseInfo": "",
/*optional, case information, string type, the max. size is 192 bytes, it is valid when faceLibType is blackFD.*/
"tag": "",
/*optional, custom tag, up to 4 tags, which are separated by commas, string type, the max. size is 195 bytes, it is valid
when faceLibType is blackFD.*/
"address": "",
/*optional, person address, string type, the max. size is 192 bytes, it is valid when faceLibType is staticFD.*/
"customInfo": "",

350
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, custom information, string type, the max. size is 192 bytes, it is valid when faceLibType is staticFD.*/
"modelData":""
/*optional, string type, target model data, non-modeled binary data needs to be encrypted by base64 during
transmission*/
"isInLibrary": "yes",
/*optional, string type, whether the picture is in library (whether modeling is successful): unknown, no, yes*/
"captureNum": 12,
/*optional, int, number of captured pictures*/
"rowKey": ""
/*optional, string type, face picture library main key. Search by rowKey can be more efficient, the maximum size is 64
bytes*/
}
]
}

See Also
JSON_ResponseStatus

6.94 JSON_SearchTaskCond
SearchTaskCond message in JSON format
{
"SearchTaskCond":{
"searchID":"",
/*required, string, search ID which is used to check whether the upper-layer clients are the same one*/
"searchResultPosition": ,
/*required, integer32, the start position of the search result in the result list. When there are multiple records and you
cannot get all search results at a time, you can search for the records after the specified position next time. If the
device returns the picture along with the response message, this field should be between 0 and totalMatches*/
"maxResults": ,
/*required, integer32, the maximum number of results that can be obtained by calling the URL at a time. If the device
returns the picture along with the response message, this field can only be set to 1*/
"captureNoList": ,
/*optional, integer, collection No. list. If the collection No. is not configured, it will search all data according to
searchResultPosition*/
"searchType":""
/*optional, search type: "new"-search and only return newly added data, "modified"-search and only return edited
data. By default all data will be searched*/
}
}

6.95 JSON_SearchTaskResponse
SearchTaskResponse message in JSON format
{
"SearchTaskResponse":{

351
 Device Network SDK (Access Control on Person) Developer Guide

"searchID":"",
/*required, string, search ID which is used to check whether the upper-layer clients are the same one*/
"responseStatusStrg":"",
/*optional, string, searching status: "OK"-searching completed, "NO MATCH"-no matched results, "MORE"-searching
for more results*/
"numOfMatches": ,
/*optional, integer32, number of returned results this time*/
"totalMatches": ,
/*optional, integer32, total number of matched results*/
"DataCollections":[{
/*optional, array, searched matched data information*/
"lastCaptureNo": ,
/*required, integer, last collection No., it is used to check whether there is data lost*/
"captureNo": ,
/*required, integer, current collection No.*/
"name":"",
/*optional, string, name*/
"employeeNo":"",
/*optional, string, employee No.*/
"IDCardNo":"",
/*optional, string, ID card No.*/
"CardNoList":["", ""],
/*optional, string, card No. list*/
"FingerprintList":[{
"fingerprintID": ,
/*optional, integer, fingerprint No.*/
"fingerprint":""
/*optional, string, fingerprint information which is encoded using base64*/
}],
"FaceFeature":{
/*optional, feature information of face picture matting*/
"Region":{
/*required, area coordinates of face picture matting, it is a rectangle*/
"height": ,
/*required, float, height*/
"width": ,
/*required, float, width*/
"x": ,
/*required, float, X-coordinate of the left corner*/
"y":
/*required, float, Y-coordinate of the left corner*/
},
"LeftEyePoint":{
/*optional, coordinates of the left eye*/
"x": ,
/*required, float, X-coordinate, it is between 0.000 and 1*/
"y":
/*required, float, Y-coordinate, it is between 0.000 and 1*/
},
"RightEyePoint":{
/*optional, coordiantes of the right eye*/
"x": ,

352
 Device Network SDK (Access Control on Person) Developer Guide

/*required, float, X-coordinate, it is between 0.000 and 1*/

"y":
/*required, float, Y-coordinate, it is between 0.000 and 1*/
},
"LeftMouthPoint":{
/*optional, coordinates of the left mouth corner*/
"x": ,
/*required, float, X-coordinate, it is between 0.000 and 1*/
"y":
/*required, float, Y-coordinate, it is between 0.000 and 1*/
},
"RightMouthPoint":{
/*optional, coordinates of the right mouth corner*/
"x": ,
/*required, float, X-coordinate, it is between 0.000 and 1*/
"y":
/*required, float, Y-coordinate, it is between 0.000 and 1*/
},
"NoseTipPoint":{
/*optional, coordinates of the nose*/
"x": ,
/*required, float, X-coordinate, it is between 0.000 and 1*/
"y":
/*required, float, Y-coordinate, it is between 0.000 and 1*/
}
},
"riskDataMark": ,
/*optional, boolean, whether to mark risk data: "true"-mark the data as the risk data and person and ID comparison
failed, "false" or this field is not returned-the data is normal*/
"dataType":""
/*optional, string, data type and status: "new"-newly added data, "modified"-edited data, "normal"-unchanged data*/
}]
}
}

6.96 JSON_SectionEncryption
JSON message about section encryption parameters
{
"SectionEncryption": {
"sectionNo": ,
/*required, integer, section No.*/
"keyType": "",
/*required, string, key types: "private"-private key, "normal"-other valid keys*/
"password": ""
/*depend, string, a hexadecimal verification key, this field is valid only when the keyType is "normal"*/
"newKeyType": "",
/*required, string, new key types: "private"-private key, "normal"-other valid keys*/
"KeyA": "",

353
 Device Network SDK (Access Control on Person) Developer Guide

/*depend, string, a hexadecimal password of key A, this field is valid only when the keyType is "normal"*/
"KeyB": "",
/*depend, string, a hexadecimal password of key B, this field is valid only when the keyType is "normal"*/
"controlBits":
/*depend, a hexadecimal control bit, this field is valid only when the keyType is "normal"*/
}
}

6.97 JSON_SetFaceRecord
Message about the setting information of face record, and it is in JSON format.
{
"faceURL":"",
/*optional, string type, picture storage URL inputted when uploading the face picture by URL, the maximum length is
256 bytes*/
"faceLibType":"",
/*required, string type, face picture library type: "blackFD"-list library, "staticFD"-static library, the maximum length is
32 bytes*/
"FDID":"",
/*required, string type, face picture library ID, the maximum length is 63 bytes*/
"FPID":"",
/*optional, string type, face record ID, it can be generated by the device or inputted. If it is inputted, it should be the
unique ID with the combination of letters and digits, and the maximum length is 63 bytes; if it is generated by the
device automatically, it is the same as the employee No. (person ID)*/
"deleteFP": ,
/*optional, boolean type, whether to delete the face record: "true"-yes. This node is required when the face record
needs to be deleted; for adding or editing the face record, this node should be set to NULL*/
"name":"",
/*required, string type, name of the person in the face picture, the maximum length is 96 bytes*/
"gender":"",
/*optional, string type, gender of the person in the face picture: "male", "female", "unknown", the maximum length is
32 bytes*/
"bornTime":"",
/*required, string type, date of birth of the person in the face picture in ISO8601 time format, the maximum length is
20 bytes*/
"city":"",
/*optional, string type, code of the city of birth for the person in the face picture, the maximum length is 32 bytes*/
"certificateType ":"",
/*optional, string type, ID type: "officerID"-officer ID, "ID"-ID card. The maximum length is 10 bytes*/
"certificateNumber":"",
/*optional, string type, ID No., the maximum length is 32 bytes*/
"caseInfo":"",
/*optional, string type, case information, the maximum length is 192 bytes, it is valid when faceLibType is "blackFD"*/
"tag":"",
/*optional, string type, custom tag, up to 4 tags can be added and they should be separated by commas, the
maximum length of each tag is 48 bytes, and the maximum length of this node is 195 bytes. It is valid when
faceLibType is "blackFD"*/
"address":"",
/*optional, string type, person address, the maximum length is 192 bytes, it is valid when faceLibType is "staticFD"*/

354
 Device Network SDK (Access Control on Person) Developer Guide

"customInfo":"",
/*optional, string type, custom information, the maximum length is 192 bytes, it is valid when faceLibType is
"staticFD"*/
"modelData":""
/*optional, string type, target model data, non-modeled binary data needs to be encrypted by base64 during
transmission*/
}

6.98 JSON_SingleFPLibInfo
Message about the information of a face picture library, and it is in JSON format.
{
"requestURL": "",
"statusCode": "",
"statusString": "",
"subStatusCode": "",
"errorCode": "",
"errorMsg": "",
/*see the description of this node and above nodes in the message of JSON_ResponseStatus*/
"faceLibType": "",
/*optional, face picture library type: "blackFD"-list library, "staticFD"-static library, string type, the max. string length is
32 bytes*/
"name": "",
/*optional, face picture library name, string type, the max. string length is 48 bytes*/
"customInfo": ""
/*optional, custom information, string type, the max. string length is 192 bytes*/
}

See Also
JSON_ResponseStatus

6.99 JSON_UserInfo
UserInfo message in JSON format
{
"UserInfo":{
"employeeNo":"",
/*required, string, employee No. (person ID)*/
"deleteUser": ,
/*optional, boolean, whether to delete the person: "true"-yes. This node is required only when the person needs to
be deleted; for adding or editing person information, this node can be set to NULL*/
"name":"",
/*optional, string, person name*/
"userType":"",
/*required, string, person type: "normal"-normal person (household), "visitor", "blackList"-person in blacklist*/
"closeDelayEnabled": ,

355
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, boolean, whether to enable door close delay: "true"-yes, "false"-no*/

"Valid":{
/*required, parameters of the effective period, the effective period can be a period of time between 1970-01-01
00:00:00 and 2037-12-31 23:59:59*/
"enable": ,
/*required, boolean, whether to enable the effective period: "false"-disable, "true"-enable. If this node is set to
"false", the effective period is permanent*/
"beginTime":"",
/*required, start time of the effective period (if timeType does not exist or is "local", the beginTime is the device local
time, e.g., 2017-08-01T17:30:08; if timeType is "UTC", the beginTime is UTC time, e.g., 2017-08-01T17:30:08+08:00)*/
"endTime":"",
/*required, end time of the effective period (if timeType does not exist or is "local", the endTime is the device local
time, e.g., 2017-08-01T17:30:08; if timeType is "UTC", the endTime is UTC time, e.g., 2017-08-01T17:30:08+08:00)*/
"timeType":""
/*optional, string, time type: "local"- device local time, "UTC"- UTC time*/
},
"belongGroup":"",
/*optional, string, group*/
"password":"",
/*optional, string, password*/
"doorRight":"",
/*optional, string, No. of the door or lock that has access permission, e.g., "1,3" indicates having permission to access
door (lock) No. 1 and No. 3*/
"RightPlan":[{
/*optional, door permission schedule (lock permission schedule)*/
"doorNo": ,
/*optional, integer, door No. (lock ID)*/
"planTemplateNo":""
/*optional, string, schedule template No.*/
}],
"maxOpenDoorTime": ,
/*optional, integer, maximum authentication attempts, 0-unlimited*/
"openDoorTime": ,
/*optional, integer, read-only, authenticated attempts*/
"roomNumber": ,
/*optional, integer, room No.*/
"floorNumber": ,
/*optional, integer, floor No.*/
"doubleLockRight": ,
/*optional, boolean, whether to have the permission to open the double-locked door: "true"-yes, "false"-no*/
"localUIRight": ,
/*optional, boolean, whether to have the permission to access the device local UI: "true"-yes, "false"-no*/
"userVerifyMode":"",
/*optional, string, person authentication mode: "cardAndPw"-card+password, "card"-card, "cardOrPw"-card or
password, "fp"-fingerprint, "fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint
+card, "fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card or
password, "faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face"-face,
"employeeNoAndPw"-employee No.+password, "fpOrPw"-fingerprint or password, "employeeNoAndFp"-employee
No.+fingerprint, "employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-face
+fingerprint+card, "faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face,
"faceOrfaceAndCard"-face or face+card, "fpOrface"-fingerprint or face, "cardOrfaceOrPw"-card or face or password,
"cardOrFace"-card or face, "cardOrFaceOrFp"-card or face or fingerprint, "cardOrFpOrPw"-card or fingerprint or

356
 Device Network SDK (Access Control on Person) Developer Guide

password. The priority of the person authentication mode is higher than that of the card reader authentication
mode*/
"checkUser": ,
/*optional, boolean, whether to verify the duplicated person information: "false"-no, "true"-yes. If checkUser is not
configured, the device will verify the duplicated person information by default. When there is no person information,
you can set checkUser to "false" to speed up data applying; otherwise, it is not recommended to configure this node*/
"addUser":
/*optional, boolean type, whether to add the person if the person information being edited does not exist: "false"-no
(if the device has checked that the person information being edited does not exist, the failure response message will
be returned along with the error code), "true"-yes (if the device has checked that the person information being edited
does not exist, the success response message will be returned, and the person will be added). If this node is not
configured, the person will not be added by default*/
"callNumbers": ["","",""],
/*optional, string type, room No. list to be called, by default, its format is X-X-X-X (e.g., 1-1-1-401), which is extended
from roomNumber; for standard SIP, it can be the SIP number*/
"floorNumbers": [ , ]
/*optional, integer type, floor No. list, which is extended from floorNumber*/
}
}

6.100 JSON_UserInfoCount
UserInfoCount message in JSON format
{
"UserInfoCount":{
"userNumber":
/*required, integer, number of persons*/
}
}

6.101 JSON_UserInfoDelCond
UserInfoDelCond message in JSON format
{
"UserInfoDelCond":{
"EmployeeNoList":[{
/*optional, person ID list (if this node does not exist or is set to NULL, it indicates deleting all person information)*/
"employeeNo":""
/*optional, string, employee No. (person ID)*/
}]
}
}

357
 Device Network SDK (Access Control on Person) Developer Guide

6.102 JSON_UserInfoDetail
UserInfoDetail message in JSON format
{
"UserInfoDetail":{
"mode":"",
/*required, string type, deleting mode: "all"-delete all, "byEmployeeNo"-delete by employee No. (person ID)*/
"EmployeeNoList":[{
/*optional, person ID list, if this node does not exist or is null, it indicates deleting all person information (including
linked cards and fingerprints) and permissions*/
"employeeNo":""
/*optional, string type, employee No. (person ID), it is valid when mode is "byEmployeeNo"*/
}]
}
}

6.103 JSON_UserInfoDetailDeleteProcess
UserInfoDetailDeleteProcess message in JSON format
{
"UserInfoDetailDeleteProcess":{
"status":""
/*required, string type, status: "processing", "success", "failed"*/
}
}

6.104 JSON_UserInfoSearch
UserInfoSearch message in JSON format
{
"UserInfoSearch":{
"searchID":"",
/*required, string type, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"responseStatusStrg":"",
/*required, string, search status: "OK"-searching completed, "NO MATCH"-no matched results, "MORE"-searching for
more results*/
"numOfMatches": ,
/*required, integer32, number of returned results this time*/
"totalMatches": ,
/*required, integer32, total number of matched results*/
"UserInfo":[{
/*optional, person information*/

358
 Device Network SDK (Access Control on Person) Developer Guide

"employeeNo":"",
/*required, string, employee No. (person ID)*/
"name":"",
/*optional, string, person name*/
"userType":"",
/*required, string, person type: "normal"-normal person (household), "visitor", "blackList"-person in blacklist*/
"closeDelayEnabled": ,
/*optional, boolean, whether to enable door close delay: "true"-yes, "false"-no*/
"Valid":{
/*required, parameters of the effective period*/
"enable":"",
/*required, boolean, whether to enable the effective period: "false"-disable, "true"-enable. If this node is set to
"false", the effective period is permanent*/
"beginTime":"",
/*required, start time of the effective period (if timeType does not exist or is "local", the beginTime is the device local
time, e.g., 2017-08-01T17:30:08; if timeType is "UTC", the beginTime is UTC time, e.g., 2017-08-01T17:30:08+08:00)*/
"endTime":"",
/*required, end time of the effective period (if timeType does not exist or is "local", the endTime is the device local
time, e.g., 2017-08-01T17:30:08; if timeType is "UTC", the endTime is UTC time, e.g., 2017-08-01T17:30:08+08:00)*/
"timeType":""
/*optional, string, time type: "local"- device local time, "UTC"- UTC time*/
},
"belongGroup":"",
/*optional, string, group*/
"password":"",
/*optional, string, password*/
"doorRight":"",
/*optional, string, No. of door or lock that has access permission, e.g., "1,3" indicates having permission to access
door (lock) No. 1 and No. 3*/
"RightPlan":[{
/*optional, access permission schedule of the door or lock*/
"doorNo": ,
/*optional, integer, door No. (lock ID)*/
"planTemplateNo":""
/*optional, string, schedule template No.*/
}],
"maxOpenDoorTime": ,
/*optional, integer, the maximum authentication attempts, 0-unlimited*/
"openDoorTime": ,
/*optional, integer, read-only, authenticated attempts*/
"roomNumber": ,
/*optional, integer, room No.*/
"floorNumber": ,
/*optional, integer, floor No.*/
"doubleLockRight": ,
/*optional, boolean, whether to have the permission to open the double-locked door: "true"-yes, "false"-no*/
"localUIRight": ,
/*optional, boolean, whether to have the permission to access the device local UI: "true"-yes, "false"-no*/
"userVerifyMode":""
/*optional, string, person authentication mode: "cardAndPw"-card+password, "card"-card, "cardOrPw"-card or
password, "fp"-fingerprint, "fpAndPw"-fingerprint+password, "fpOrCard"-fingerprint or card, "fpAndCard"-fingerprint
+card, "fpAndCardAndPw"-fingerprint+card+password, "faceOrFpOrCardOrPw"-face or fingerprint or card or

359
 Device Network SDK (Access Control on Person) Developer Guide

password, "faceAndFp"-face+fingerprint, "faceAndPw"-face+password, "faceAndCard"-face+card, "face"-face,

"employeeNoAndPw"-employee No.+password, "fpOrPw"-fingerprint or password, "employeeNoAndFp"-employee
No.+fingerprint, "employeeNoAndFpAndPw"-employee No.+fingerprint+password, "faceAndFpAndCard"-face
+fingerprint+card, "faceAndPwAndFp"-face+password+fingerprint, "employeeNoAndFace"-employee No.+face,
"faceOrfaceAndCard"-face or face+card, "fpOrface"-fingerprint or face, "cardOrfaceOrPw"-card or face or password,
"cardOrFace"-card or face, "cardOrFaceOrFp"-card or face or fingerprint, "cardOrFpOrPw"-card or fingerprint or
password. The priority of the person authentication mode is higher than that of the card reader authentication
mode*/
}]
}
}

6.105 JSON_UserInfoSearchCond
UserInfoSearchCond message in JSON format
{
"UserInfoSearchCond":{
"searchID":"",
/*required, string type, search ID, which is used to confirm the upper-level platform or system. If the platform or the
system is the same one during two searching, the search history will be saved in the memory to speed up next
searching*/
"searchResultPosition": ,
/*required, integer32 type, the start position of the search result in the result list. When there are multiple records
and you cannot get all search results at a time, you can search for the records after the specified position next time*/
"maxResults": ,
/*required, integer32 type, maximum number of search results. If maxResults exceeds the range returned by the
device capability, the device will return the maximum number of search results according to the device capability and
will not return error message*/
"EmployeeNoList":[{
/*optional, person ID list (if this node does not exist or is set to NULL, it indicates searching for all person
information)*/
"employeeNo":""
/*optional, string type, employee No. (person ID)*/
}]
}
}

6.106 JSON_Verification
JSON message about verification parameters of section password.
{
"Verification": {
"sectionNo": ,
/*requried, integer, section No.*/
"passwordType": "",
/*optional, string, password types: "KeyA" (default), "KeyB"*/
"password": ""

360
 Device Network SDK (Access Control on Person) Developer Guide

/*optional, string, a hexadecimal key, which depends on the password type*/

}
}

6.107 XML_AcsAbility
AcsAbility capability message in XML format
<AcsAbility version="2.0">
<channelControllerNo min="" max=""/>
<!--req, lane controller range-->
<doorNo min="" max=""/>
<!--req , door No. rang or floor No. range-->
<cardReaderNo min="" max=""/>
<!--req, card reader No. range-->
<maxCardNum></maxCardNum>
<!--req, supported card number-->
<caseSensorNo min="" max=""/>
<!--req, event trigger No.-->
<gateOpenDirectionNum opt="1,2"/>
<!--req, the number of door opening directions (e.g., for the flap barrier which has only one direction, the attribute
"opt" should be set to 1; for the swing barrier and the tripod turnstile which have two directions, the attribute "opt"
should be set to 2)-->
<DoorRelateCardReaderList>
<!--opt, card reader No., which is linked with the door No. (it will be returned only when the card reader has linked
with card reader, otherwise it will not be returned)-->
<Action>
<doorNo>1</doorNo>
<cardReaderNo>1,2</cardReaderNo>
</Action>
</DoorRelateCardReaderList>
<DoorStatusPlan>
<!--req, door status schedule capability -->
<WeekPlan>
<!--req, weekly schedule capability -->
<weekPlanNo min="" max=""/>
<!--req, weekly schedule No. range -->
<maxDaySegment>8</maxDaySegment>
<!--req, supported daily time segment number -->
<status opt="invalid,sleep,alwaysopen,alwaysclose,normal"/>
<!--req, status value range -->
<verifyType
opt="invalid,sleep,swipecard,swipecardandpassword,swipecardorpasswd,fingerPrint,fingerPrintAndPasswd,fingerPrint
orCard,fingerPrintAndCard,fingerPrintAndCardAndPasswd,faceOrFpOrCardOrPw,faceAndFingerPrint,faceAndPassword,
faceAndCard,face,employeeNoAndPassword,fingerPrintOrPassword,employeeNoAndFp,employeeNoAndFpAndPw,fac
eAndFpAndCard,faceAndPwAndFp,employeeNoAndface,cardOrFace,cardOrFaceOrFp,cardOrFpOrPw"/>
<!--req, authentication method range -->
<TimeAccuracy>
<!--req, time accuracy -->
<hour>enable</hour>

361
 Device Network SDK (Access Control on Person) Developer Guide

<minute>enable</minute>
<second>enable</second>
</TimeAccuracy>
</WeekPlan>
<HolidayPlan>
<!--req, holiday schedule -->
<holidayPlanNo min="" max=""/>
<!--req, holiday schedule No. range -->
<maxDaySegment>8</maxDaySegment>
<!--req, supported daily time segment number -->
<TimeAccuracy>
<!--req, time accuracy-->
<hour>enable</hour>
<minute>enable</minute>
<second>enable</second>
</TimeAccuracy>
</HolidayPlan>
<HolidayGroup>
<!--req, holiday group capability-->
<holidayGroupNo min="" max=""/>
<!--req, holiday group No. range -->
<holidayGroupName min="" max=""/>
<!--req, holiday group name length -->
<maxHolidayPlanNum></maxHolidayPlanNum>
<!--req, max. holiday schedule number for the holiday group -->
</HolidayGroup>
<PlanTemplate>
<!--req, schedule template capability -->
<templateNo min="" max=""/>
<!--opt, range of schedule template No.-->
<templateName min="" max=""/>
<!--req, schedule template name length -->
<maxHolidayGroupNum></maxHolidayGroupNum>
<!--req, max. holiday group number for the schedule template -->
</PlanTemplate>
<supportLocalController>enable</supportLocalController>
<!--req, support distributed access controller-->
</DoorStatusPlan>
<CardReaderVerifyTypePlan>
<!--req, card reader authentication schedule capability -->
<WeekPlan>
<!--req, weekly schedule capability -->
<weekPlanNo min="" max=""/>
<!--req, weekly schedule No. range -->
<maxDaySegment>8</maxDaySegment>
<!--req, supported daily time segment number -->
<status opt="invalid,sleep,alwaysopen,alwaysclose,normal"/>
<!--req, status value range -->
<verifyType
opt="invalid,sleep,swipecard,swipecardandpassword,swipecardorpasswd,fingerPrint,fingerPrintAndPasswd,fingerPrint
OrCard,fingerPrintAndCard,fingerPrintAndCardAndPasswd,fingerPrintorCard,fingerPrintAndCard,fingerPrintAndCardAn
dPasswd,faceOrFpOrCardOrPw,faceAndFingerPrint,

362
 Device Network SDK (Access Control on Person) Developer Guide

faceAndPassword,faceAndCard,face,employeeNoAndPassword,fingerPrintOrPassword,employeeNoAndFp,employeeN
oAndFpAndPw,faceAndFpAndCard,faceAndPwAndFp,employeeNoAndface,employeeNoAndFpAndPw,faceAndFpAndCa
rd,faceAndPwAndFp,employeeNoAndface,faceOrFaceAndCard,fingerPrintOrFace,swipecardOrFaceOrPw,cardOrFace,ca
rdOrFaceOrFp,cardOrFpOrPw"/>
<!--req,verification mode range: invalid, sleep, card, card and password, card or password, fingerprint, fingerprint
and password, fingerprint or card, fingerprint and card, fingerprint and card and password (no order), face or
fingerprint or card or password, face and fingerprint, face and password, face and card, face, employee No. and
password, fingerprint or password, employee No.and fingerprint, employee No. and fingerprint and password, face
and fingerprint and card, face and password and fingerprint, employee No. and face, employee No. and fingerprint
and password, face and fingerprint and card, face and password and fingerprint, employee No. and face, face or face
and card, fingerprint or face, card or face or password, card or face, card or face or fingerprint-->
<TimeAccuracy>
<!--req, time accuracy -->
<hour>enable</hour>
<minute>enable</minute>
<second>enable</second>
</TimeAccuracy>
</WeekPlan>
<HolidayPlan>
<!--req, holiday schedule -->
<holidayPlanNo min="" max=""/>
<!--req, holiday schedule No. range -->
<maxDaySegment>8</maxDaySegment>
<!--req, supported daily time segment number -->
<TimeAccuracy>
<!--req, time accuracy -->
<hour>enable</hour>
<minute>enable</minute>
<second>enable</second>
</TimeAccuracy>
</HolidayPlan>
<HolidayGroup>
<!--req, holiday group capability -->
<holidayGroupNo min="" max=""/>
<!--req, holiday group No. range -->
<holidayGroupName min="" max=""/>
<!--req, holiday group name length -->
<maxHolidayPlanNum></maxHolidayPlanNum>
<!--req, max. holiday schedule number for holiday group -->
</HolidayGroup>
<PlanTemplate>
<!--req, schedule template capability -->
<templateNo min="" max=""/>
<!--opt, range of schedule template No.-->
<templateName min="" max=""/>
<!--req, schedule template name lenghth -->
<maxHolidayGroupNum></maxHolidayGroupNum>
<!--req, max. holiday group number for schedule template -->
</PlanTemplate>
<supportLocalController>enable</supportLocalController>
<!--req, support distributed access controller-->
</CardReaderVerifyTypePlan>

363
 Device Network SDK (Access Control on Person) Developer Guide

<CardRightPlan>
<!--req, card permission schedule capability -->
<WeekPlan>
<!--req, weekly schedule capability -->
<weekPlanNo min="" max=""/>
<!--req, weekly schedule No. range -->
<maxDaySegment>8</maxDaySegment>
<!--req, supported daily time segment number -->
<status opt="invalid,sleep,alwaysopen,alwaysclose,normal"/>
<!--req, status value range -->
<verifyType opt="invalid,sleep,swipecard,swipecardandpassword"/>
<!--req, authentication method range -->
<TimeAccuracy>
<!--req, time accuracy -->
<hour>enable</hour>
<minute>enable</minute>
<second>enable</second>
</TimeAccuracy>
</WeekPlan>
<HolidayPlan><!--req, holiday schedule -->
<holidayPlanNo min="" max=""/><!--req, holiday schedule No. range -->
<maxDaySegment>8</maxDaySegment>
<!--req, supported daily time segment number -->
<TimeAccuracy>
<!--req, time accuracy -->
<hour>enable</hour>
<minute>enable</minute>
<second>enable</second>
</TimeAccuracy>
</HolidayPlan>
<HolidayGroup>
<!--req, holiday group capability-->
<holidayGroupNo min="" max=""/>
<!--req, holiday group No. range -->
<holidayGroupName min="" max=""/>
<!--req, holiday group name length -->
<maxHolidayPlanNum></maxHolidayPlanNum>
<!--req, max. holiday schedule number for holiday group -->
</HolidayGroup>
<PlanTemplate>
<!--req, schedule template capability -->
<templateNo min="" max=""/>
<!--opt, range of schedule template No.-->
<templateName min="" max=""/>
<!--req, schedule template name length -->
<maxHolidayGroupNum></maxHolidayGroupNum>
<!--req, max. holiday group number for schedule template -->
</PlanTemplate>
<supportLocalController>enable</supportLocalController>
<!--req, support distributed access controller-->
</CardRightPlan>
<Door>

364
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, door parameters capaility -->

<doorName min="" max=""/>
<!--req, door name length -->
<magneticMode opt="alwaysclose,alwaysopen"/>
<!--req, door magnetic type -->
<openButtonMode opt="alwaysclose,alwaysopen"/>
<!--req, exit button type-->
<openDuration min="" max=""/>
<!--req, door opening duration range, unit: second -->
<disabledOpenDuration min="" max=""/>
<!--req, disabled card opening door duration range, unit: second)-->
<magneticAlarmTimeout min="" max=""/>
<!--req, magnetic detection overtime alarm time, unit: second, 0 indicates not to alarm. -->
<doorLock>enable</doorLock>
<!--req,whether support locking door when door closed. -->
<leaderCard>enable</leaderCard>
<!--req, whether to enable first card opening door -->
<stressPassword min="" max=""/>
<!--req, duress password length -->
<superPassword min="" max=""/>
<!--req, super password length -->
<unlockPassword min="" max=""/>
<!--opt, unlocking password length -->
<leaderCardMode opt="close,alwaysopen,authorized"/>
<!--req, first card mode-->
<useLocalController>enable</useLocalController>
<!--req, whether the door is connected to distributed access controller-->
<localControllerID min="" max=""/>
<!--req, distributed access controller No.-->
<localControllerDoorNumber min="" max=""/>
<!--req, distributed access controller door No.-->
<localControllerStatus opt="offline,netOnline,authorized"/>
<!--req, distributed access controller online status-->
<lockInputCheck>enable</lockInputCheck>
<!--req, whether to enable door lock input check (1 byte, 0- disbale, 1- enable, default to disable)-->
<lockInputType opt="NormallyClose,NormallyOpen"/>
<!--req, door lock input type (1 byte, 0- normally closed, 1- normally open, default to normally closed)-->
<doorTerminalMode opt="PreventCutShort,Normal"/>
<!--req, door related terminal operating mode (1 byte, 0- anti-cut & short-circuit, 1- normal, default to anti-cut &
short-circuit)-->
<openButton>enable</openButton>
<!--req, whether to enable door button (1 byte, 0- yes, 1- no, default to yes)-->
</Door>
<DoorStatusPlan>
<!--req, door status schedule parameters -->
<enable>true</enable>
</DoorStatusPlan>
<Group>
<!--req, group parameters capability -->
<ValidCfg>
<!--req, validate capability -->
<TimeAccuracy>

365
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, time accuracy -->

<year>enable</year>
<month>enable</month>
<day>enable</day>
<hour>enable</hour>
<minute>enable</minute>
<second>enable</second>
</TimeAccuracy>
<timeType opt="local,UTC"/>
<!--opt, time type: "local"-device local time (default), "UTC"-UTC time>
</ValidCfg>
<groupName min="" max=""/>
<!--req, group name length -->
<groupNo min="" max=""/><!--req, group No. range. If this node cannot be parsed or is not returned, it will be set
to the default value-->
</Group>
<MultiCard>
<!--req, multi-card capability -->
<swipeIntervalTimeout min="" max=""/>
<!--req, multi-card swiping interval overtime, unit: second -->
<maxMultiCardGroupNum, min="1", max="20"></maxMultiCardGroupNum>
<!--req, max. multi-card group number >
<maxGroupCombinationNum></maxGroupCombinationNum>
<!--req, max. group number for a multi-card group -->
<remoteOpenDoor>enable</remoteOpenDoor>
<!--req, supports remote door opening authentication method -->
<offlineVerifyMode>enable</offlineVerifyMode>
<!--req, supported offline control panel authentication mode (super password replaces remote door opening
control) -->
</MultiCard>
<Card>
<!--req, card parameters capability -->
<cardNo min="" max=""/>
<!--req, card No. length -->
<modifyParamType opt="cardvalid,validtime,cardtype,doorright,leadercard,swipenum,group,password, rightplan,
swipednum, employeeno, name, departmentNo, schedulePlanNo,
schedulePlanType,roomNo,simNo,floorNo,userType"/>
<!--req,edit separately --> opt="cardvalid- card valid or not, validtime- expiry date, cardtype- card type, doorright-
door permission,
leadercard- first card, swipenum- max. card swiping times, group- group, password- card password,,rightplan- card
permission schedule,
swipednum- card swiped times, employeeno- employee No., name-Name, departmentNo-Apartment No.,
schedulePlanNo-Schedule No., schedulePlanType-Schedule Type-->
<cardValid>enable</cardValid>
<timeRangeBegin>
<!--opt, start time that can be configured by beginTime and endTime. If this node is not returned by the capability,
the start time that can be configured is 1970-01-01T00:00:00 by default-->
</timeRangeBegin>
<timeRangeEnd>
<!--opt, end time that can be configured by beginTime and endTime. If this node is not returned by the capability,
the end time that can be configured is 2037-12-31T23:59:59 by default-->
</timeRangeEnd>

366
 Device Network SDK (Access Control on Person) Developer Guide

<cardValidUnit opt="day,hour,minute,second">
<!--req, accuracy of card expiry date (if device supports correcting to minute, opt="minute"), if this node is not
returned, the default accuracy is day (opt="day")>
</cardValidUnit>
<!--req, whether the card is valid-->
<!--req, card type-->
<cardType opt="normalcard,disabledcard,blacklistcard,nightwatchcard,
stresscard,supercard,guestcard,mastercard,staffcard,normalopencard,cleancard,standbycard, unlockcard"/>
<doorRight>enable</doorRight>
<!--req, door permission-->
<leaderCard>enable</leaderCard>
<!--req, whether to enable the first card? -->
<swipeNum min="" max=""/>
<!--req, max. card swiping number, o indicates no limit-->
<maxBelongGroup></maxBelongGroup>
<!--req, max. group number belonged to -->
<cardPassword min="" max=""/>
<!--req, card password-->
<doorRightPlanNum></doorRightPlanNum>
<!--req, max. schedule template number for a single door -->
<swipeTime>enabled</swipeTime>
<!--req, swiping times -->
<onlyPasswdOpen opt="true,false"/>
<!--opt, whether to support password opening door, invalid currently -->
<roomNumber min="" max=""/>
<!--opt, Room No.-->
<floorNumber min="" max=""/>
<!--opt,Floor number-->
<employeeNo min="" max=""/>
<!--opt, employee No.-->
<name min="" max=""></name>
<!--req, name (if device returns this node, you can get and set the linked user name of the card by calling card
parameter API directly, so there is no need to API NET_DVR_SET_CARD_USERINFO_CFG and
NET_DVR_GET_CARD_USERINFO_CFG)-->
<departmentNo min="" max=""/>
<!--opt, department No.-->
<schedulePlanNo min="" max=""/>
<!--opt, shift schedule-->
<schedulePlanType opt="personal,department"/>
<!--opt, shift schedule type-->
<lockID min="" max=""/>
<!--req, lock ID-->
<roomCode min="" max=""/>
<!--req, room code-->
<cardRight opt="lowPowerAlarm,openDoorSound,customCardLimit,normalOpen,openLockedDoor,keepWatch"/>
<!--req, card permission-->
<supportLocalController>enable</supportLocalController>
<!--req, support distributed access controller-->
<roomNumber min="" max=""></roomNumber><!--req, room No.>
<floorNumber min="" max=""></floorNumber><!--req, floor No.>
<SIMNum min="" max=""></SIMNum><!--req, mobile phone number>
<isSupportCardModify>true</isSupportCardModify>

367
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, support downloading when card parameters changed (for video intercom device only, by default, this
function is supported by all access control devices)>
</Card>
<AntiSneak>
<!--req, anti-passback capability-->
<startCardReaderNo>enable</startCardReaderNo>
<!--req, anti-passback card reader No. configuration -->
<maxSneakPath></maxSneakPath>
<!--req, max. anti-passback follow-up card reader number-->
</AntiSneak>
<MultiDoorInterlock>
<!--req, multi-door interlocking parameters -->
<maxMultiDoorInterlockGroup></maxMultiDoorInterlockGroup>
<!--req, max. multi-door interlocking group number -->
<maxInterlockDoorNum></maxInterlockDoorNum>
<!--req, max. interlocked door number for one multi-door interlocking group -->
</MultiDoorInterlock>
<AcsWorkStatus>
<!--req, access controller working status parameters -->
<doorLogicalStatus>enable</doorLogicalStatus>
<!--req, door logic status -->
<doorStatus opt="alwaysopen,alwaysclose,normal"/>
<!--req, door status parameters -->
<magneticStatus>enable</magneticStatus>
<!--req, door magnetic status parameters -->
<relayStatus>enable</relayStatus>
<!--req, relay status-->
<caseSensorStatus>enable</caseSensorStatus>
<!--req, case trigger status-->
<BatteryVoltage>enable</BatteryVoltage>
<!--req, battery voltage value -->
<BatteryLowVoltage>enable</BatteryLowVoltage>
<!--req, battery low voltage detection -->
<PowerSupplyStatus>enable</PowerSupplyStatus>
<!--req, device power supply status-->
<multiDoorInterlockStatus>enable</multiDoorInterlockStatus>
<!--req, multi-door interlocking status parameters-->
<antiSneakStatus>enable</antiSneakStatus>
<!--req, anti-passback status parameters-->
<hostAntiDismantleStatus>enable</hostAntiDismantleStatus>
<!--req, control ler tamper ?proof status-->
<indicatorLightStatus>enable</indicatorLightStatus>
<!--req, Supports indicator status-->
<cardReaderOnlineStatus>enable</cardReaderOnlineStatus>
<!--req, card reader connection status -->
<cardReaderAntiDismantleStatus>enable</cardReaderAntiDismantleStatus>
<!--req, card reader tamper-proof status -->
<cardReaderVerifyMode opt="invalid,sleep,swipecard,swipecardandpassword, swipecardorpasswd,
fingerPrint,fingerPrintAndPasswd,fingerPrintor
Card,fingerPrintAndCard,fingerPrintAndCardAndPasswd,faceOrFpOrCardOrPw,
faceAndFingerPrint,faceAndPassword,faceAndCard,face,employeeNoAndPassword,fingerPrintOrPassword,employeeN
oAndFp,

368
 Device Network SDK (Access Control on Person) Developer Guide

employeeNoAndFpAndPw,faceAndFpAndCard,faceAndPwAndFp,employeeNoAndface,faceOrfaceAndCard,fingerPrintO
rFace,swipecardOrFaceOrPw,"/>
<!--req, supported card reader authentication modes: 0-invalid, 1-card, 2-card+password, 3-card, 4-card/password,
5-fingerprint, 6-fingerprint+password, 7-fingerprint/card, 8-fingerprint_card, 9-fingerprint_card+password, 10-face/
fingerprint/card/password, 11-face+fingerprint, 12-face+password, 13-face+card, 14-face, 15-employee No.
+password, 16-fingerprint/password, 17-employee No.+fingerprint, 18-employee No.+fingerprint+password, 19-face
+fingerprint+card, 20-face+password+fingerprint, 21-employee No.+face, 22-face/face+card, 23-fingerprint/face, 24-
card/face/password-->
<setupAlarmStatus>enable</setupAlarmStatus>
<!--req, zone arming status -->
<alarmInStatus>enable</alarmInStatus>
<!--req, alarm input status -->
<alarmOutStatus>enable</alarmOutStatus>
<!--req, alarm output status -->
<cardNum>enable</cardNum>
<!--req, added card number -->
<fireAlarmStatus opt="normal,shortCircuit,break"/>
<!--req, support fire alarm status-->
<supportLocalController>enable</supportLocalController>
<!--req, support distributed access controller-->
<batteryChargeStatus opt="InCharge,NotCharge"/>
<!--req, battery status: InCharge-Charging, NotCharge-Uncharged>
<masterChannelControllerStatus>enable</masterChannelControllerStatus>
<!--req, supports online status of main lane controller-->
<slaveChannelControllerStatus>enable</slaveChannelControllerStatus>
<!--req, supports online status of slave lane controller-->
<antiSneakServerStatus opt="disable,normal,disconnect"/>
<!--opt, anti-passing back server status: "disable"-disabled, "normal"-normal, "disconnect"-disconnected-->
<whiteFaceNum>enable</whitefaceNum>
<!--req, supports the parameters of face picture quantity in whitelist-->
<blackFaceNum>enable</blackfaceNum>
<!--req, supports the parameters of face picture quantity in blacklist-->
</AcsWorkStatus>
<CaseSensor>
<!--req, event trigger parameters capability -->
<triggerHostBuzzer>enable</triggerHostBuzzer>
<!--req, trigger controller buzzer -->
<triggerCardReaderBuzzer>enable</triggerCardReaderBuzzer>
<!--req, trigger card reader buzzer -->
<triggerAlarmOut>enable</triggerAlarmOut>
<!--req, trigger alarm output -->
<triggerDoorOpen>enable</triggerDoorOpen>
<!--req, support triggered open door by ID-->
<triggerAlarmOutClose>enable</triggerAlarmOutClose>
<!--req, support disable triggered alarm input-->
<triggerAlarmInSetup>enable</triggerAlarmInSetup>
<!--req, support triggered arming region arming-->
<triggerAlarmInClose>enable</triggerAlarmInClose>
<!--req, support triggered arming region disarming-->
</CaseSensor>
<CardReaderCfg>
<!--req, reader parameters capability-->

369
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, supported reader type-->

<cardReaderType opt="DS-K110XM/MK/C/CK,DS-K192AM/AMP,DS-K192BM/BMP,DS-K182AM/AMP,DS-K182BM/
BMP,DS-K182AMF/ACF,
Wiegand or RS485 offline,DS-K1101M/MK,DS-K1101C/CK,DS-K1102M/MK/M-A,DS-K1102C/CK,DS-K1103M/
MK,
DS-K1103C/CK,DS-K1104M/MK,DS-K1104C/CK,DS-K1102S/SK/S-A,DS-K1102G/GK,DS-K1100S-B,DS-
K1102EM/EMK,
DS-K1102E/EK,DS-K1200EF,DS-K1200MF,DS-K1200CF,DS-K1300EF,DS-K1300MF,DS-K1300CF,DS-K1105E,
DS-K1105M,DS-K1105C,DS-K182AMF,DS-K196AMF,DS-K194AMP, DS-K1T200EF/EF-C/MF-MF-C/CF/CF-C,
DS-K1T300EF/EF-C/MF-MF-C/CF/CF-C"/>
<okLedPolarity op="cathode,anode"/>
<!--req,OK LED polarity-->
<errorLedPolarity op="cathode,anode"/>
<!--req,ERROR LED polarity-->
<buzzerLedPolarity op="cathode,anode"/>
<!--req, buzzer polarity -->
<swipeInterval min="" max=""/>
<!--req, time interval of duplicated authentication, unit: second -->
<pressTimeout min="" max=""/>
<!--req, key pressing overtime, unit: second -->
<enableFailAlarm>enable</enableFailAlarm>
<!--req, whether to enable authentication failure over times alarm configuration-->
<maxReadCardFailNum min="" max=""/>
<!--req, max. times of authentication failure -->
<enableTamperCheck>enable</enableTamperCheck>
<!--opt, whether to support anti-tamper check-->
<offlineCheckTime min="" max=""/>
<!--opt, offline check time, unit:s-->
<fingerPrintCheckLevel
opt="1/10,1/100,1/1000,1/10000,1/100000,1/1000000,1/10000000,1/100000000,3/100,3/1000,
3/10000,3/100000,3/1000000,3/10000000,3/100000000,Automatic Normal,Automatic
Secure,Automatic More Secure"/>
<!--opt, fingerprint recognition level-->
<useLocalController>enable</useLocalController>
<!--req, whether door is connected to distributed access controller-->
<localControllerID min="" max=""/>
<!--opt, distributed access controller No.-->
<localControllerReaderID min="" max=""/>
<!--opt, ID of distributed access controller card reader-->
<cardReaderChannel opt="Wiegand/Offline,RS485A,RS485B"/>
<!--opt card reader communication channel No.-->
<fingerPrintImageQuality min="1" max="8"/>
<!--opt,fingerprint picture quality-->
<fingerPrintContrastTimeOut min="0" max="20"/>
<!--opt,fingerprint comparison overtime, 0 - infinite, that is 0xff-->
<fingerPrintRecogizeInterval min="0" max="10"/>
<!--opt,time interval of fingerprint continuous recognition, 0- no delay, that is 0xff-->
<fingerPrintMatchFastMode min="0" max="5"/>
<!--opt,fingerprint fast matching mode, 0- auto, that is 0xff-->
<fingerPrintModuleSensitive min="1" max="8"/>
<!--opt,fingerprint module sensitivity-->
<fingerPrintModuleLightCondition opt="outdoor,indoor"/>

370
 Device Network SDK (Access Control on Person) Developer Guide

<!--opt,light condition of fingerprint module-->

<faceMatchThresholdN min="0" max="100"/>
<!--opt,face 1:N matching threshold-->
<faceQuality min="0" max="100"/>
<!--opt,face picture quality-->
<faceRecogizeTimeOut min="0" max="20"/>
<!--opt,face recognition overtime, 0 - infinite, that is 0xff-->
<faceRecogizeInterval min="0" max="10"/>
<!--opt,time interval of face continuous recognition, 0- no delay, that is 0xff-->
<cardReaderFunction opt="fingerPrint,face,fingerVein"/>
<!--opt,card reader types-->
<cardReaderDescription min="1" max="32"/>
<!--opt,card reader description-->
<faceImageSensitometryl min="0" max="65535"/>
<!--opt, face picture exposure-->
<livingBodyDetect opt="disable,enable"/>
<!--opt, face detection-->
<faceMatchThreshold1 min="0" max="100"/>
<!--opt,Face 1:1 matching threshold-->
<buzzerTime min="0" max="5999"/>
<!--opt, buzzing time-->
<faceMatch1SecurityLevel opt="normal, more secure, extremely secure"/>
<!--opt, face picture 1:1 security level: 1-normal, 2-high, 3-higher-->
<faceMatchNSecurityLevel opt="0,1,2"/>
<!--opt, face picture 1:N security level: 1-normal, 2-high, 3-higher-->
<envirMode opt="normal, more secure, extremely secure"/>
<!--opt, face recognition environment mode: 0-invalid, 1-indoor, 2-other -->
<liveDetLevelSet opt="0,1,2,3"/>
<!--opt, set live face detection threshold level: 0-invalid, 1-low, 2-medium, 3-high-->
<liveDetAntiAttackCntLimit min="0"max="255"/>
<!--opt, max. live face detection failed attempts-->
<enableLiveDetAntiAttack opt="0,1,2"/>
<!--opt, whether enable locking face: 0-invalid, 1-disabled, 2-enabled-->
<fingerPrintCapacity min="" max=""/>
<!--ro, opt, xs:integer, fingerprint capacity-->
<fingerPrintNum min="" max=""/>
<!--ro, opt, xs:integer, the number of existed fingerprints-->
<enableFingerPrintNum opt="true"/>
<!--ro, opt, xs:boolean, enable fingerprint capacity or not (when it is "true", fingerPrintCapacity and fingerPrintNum
are valid)-->
<envirMode opt="0,1,2"></envirMode>
<!--opt, environment mode of face recognition, 0-invalid, 1-indoor, 2-other->
<liveDetLevelSet opt="0,1,2,3"></liveDetLevelSet>
<!--opt, set live face detection security level, 0-invalid, 1-normal, 2-high, 3-higher-->
<liveDetAntiAttackCntLimit min="0"max="255">/liveDetAntiAttackCntLimit>
<!--opt, maximum failed attempts-->
<enableLiveDetAntiAttack opt="0,1,2">
<!--opt, enable locking face, 0-invalid, 1-disable, 2-enable-->
</enableLiveDetAntiAttack>
<faceContrastMotionDetLevel opt="low,middle,high"/><!--opt, motion detection level during face picture
comparison: low, middle, high-->
<dayFaceMatchThresholdN min="0" max="100"/><!--opt, 1:N face picture comparison threshold in day-->

371
 Device Network SDK (Access Control on Person) Developer Guide

<nightFaceMatchThresholdN min="0" max="100"/><!--opt, 1:N face picture comparison threshold at night-->

<faceRecogizeEnable opt="true,false,multi"/><!-opt, whether to enable facial recognition: "true"-yes (one
face),"false"-no, "multi"-yes (multiple faces)-->
<supportDelFPByID opt="true"/>
<!--ro, opt, xs:boolean, whether the fingerprint module supports deleting fingerprint by fingerprint ID: "true"-yes,
"false"-no-->
<defaultVerifyMode opt="1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27"/>
<!--ro, opt, card reader authentication mode (factory default): 1-sleeping mode, 2-card swiping + password, 3-card
swiping, 4-card swiping or password, 5-fingerprint, 6-fingerprint + password, 7-fingerprint or card swiping, 8-
fingerprint + card swiping, 9-fingerprint + card swiping + password, 10-face or fingerprint or card swiping or password,
11-face + fingerprint, 12-face + password, 13-face + card swiping, 14-face, 15-employee ID + password, 16-fingerprint
or password, 17-employee ID + fingerprint, 18-employee ID + fingerprint + password, 19-face + fingerprint + card
swiping, 20-face + password + fingerprint, 21-employee ID + face, 22-face or face + card swiping, 23-fingerprint or
face, 24-card swiping or face or password, 25-card or face, 26-card or face or fingerprint, 27-card or fingerprint or
password-->
<fingerPrintCapacity min="" max=""/><!--ro, opt, xs: integer, fingerprint capacity, this node is valid only when
enableFingerPrintNum is "true"-->
<fingerPrintNum min="" max=""/><!--ro, opt, xs: integer, number of exiting fingerprints, this node is valid only when
enableFingerPrintNum is "true"-->
<enableFingerPrintNum opt="true"/><!--ro, opt, xs: boolean, whether to enable fingerprint capacity-->
<blackFaceMatchThreshold min="0" max="100"/><!--opt, face picture comparison threshold in blacklist-->
</CardReaderCfg>
<AcsUpgrade><!--req, upgrade capability of access control device-->
<hostUpgrade>
<!--req, whether to support upgrading main module-->
</hostUpgrade>
<cardReaderUpgrade>
<!--req, whether to support upgrading card reader-->
</cardReaderUpgrade>
<localControllerUpgrade>
<!--req, whether to support upgrading distributed access controller-->
</localControllerUpgrade>
<channelControllerUpgrade>
<!--req,whether to support upgrading lane access controller-- >
</channelControllerUpgrade>
<extensionModuleUpgrade>
<!--req, whether to support upgrading extension module-->
</extensionModuleUpgrade>
<smartLockUpgrade>
<!--req, whether to support upgrading smart lock-->
</smartLockUpgrade>
<cardReaderFPAlgorithmUpgrade>
<!--req, whether to support upgrading fingerprint algorithm program of fingerprint module-->
</cardReaderFPAlgorithmUpgrade>
<outdoorModules>
<!--opt, whether to support upgrading the modules of door station, if not support, this node will not be returned-->
</outdoorModules>
<modules opt="keybord,display,button,card,signal"/>
<!--opt，supported module type, “keybord”-keypad module, “display”-display module,”button”-nametag module.
“card”-card reader, “signal”-indicator module, if not support, this node will not be returned-->
</AcsUpgrade>
<clearAcsParam

372
 Device Network SDK (Access Control on Person) Developer Guide

opt="doorstatusweekplan,cardreaderverifyweek,cardrightweekplan,doorstatusholidayplan,cardreaderverifyholidaypla
n,cardrightholidayplan,doorstatusholidayplan,doorstatusholidaygroup,cardreaderverifyholidaygroup,cardrightplantem
plate,doorstatusplantemolate,cardreaderverifyplantemplate,card,group,antisneak,eventandCardLinkage,cardPasswdO
pendoor,personStatistics, blackListPicture, IDBlackList"/>
<!--req, supported parameters clearing option -->
<ACSClearParam>
<!--req, extend clear access control host parameter node-->
<localControllerID min="" max=""/>
<!--opt, distributed access controller No.-->
</ACSClearParam>
<MultiHostAntiSneak>
<!--req, over-controllers anti-passback -->
<startAntiSnealHost opt="true,false"/>
<!--opt, whether to enable anti-passback controller -->
<antiSnealHostNum min="" max=""/>
<!--req, controller number for anti-passback controller group -->
<ReadersCfg>
<!--req, over-controllers anti-passback card reader parameters -->
<maxRouteGroupNum></maxRouteGroupNum>
<!--req, max. path number -->
<oneRouteReadersNum min="" max=""/>
<!--req, follow-up card reader number for each path -->
</ReadersCfg>
</MultiHostAntiSneak>

<AcsHostCfg>
<!--opt, access control settings capability -->
<enableRS485Backup opt="true,false"/>
<!--req, whether to support downstream RS485 communication backup -->
<showCapPic opt="true,false"/>
<!--opt,whether to support displaying captured picture on LCD screen-->
<showCardNo opt="true,false"/>
<!--opt,whether to support displaying card No. on LCD screen-->
<showUserInfo opt="true,false"/>
<!--opt,whether to support displaying user information on LCD screen-->
<overlayUserInfo opt="true,false"/>
<!--opt,Whether to overlay user information on the captured picture-->
<voicePrompt opt="true,false"/>
<!--opt,Whether to support sound prompt-->
<uploadCapPic opt="true,false"/>
<!--opt, Whether to support uploading picture after capturing-->
<saveCapPic opt="true,false"/>
<!--opt,Whether to support saving captured picture-->
<inputCardNo opt="true,false"/>
<!--opt, whether supports inputting card No. by button-->
<wifiDetect opt="true,false"/>
<!--opt, whether supports enabling Wi-Fi probe-->
<enable3G4G opt="true,false"/>
<!--opt, enable 3G/4G-->
<protocol opt="Private,OSDP"/>
<!--opt, card reader communication protocol type: "Private"-private protocol (default), "OSDP"-OSDP protocol-->
</AcsHostCfg>

373
 Device Network SDK (Access Control on Person) Developer Guide

<EventLinkage>
<!--req, event card linkage-->
<maxEventNum></maxEventNum>
<!--req, max. event linkage number supported by the device -->
<supportMode opt="Event,CardNo,MAC,EmployeeNo"/>
<!--req, supported linkage method, "Event"-event linkage, "CardNo"-Card No. linkage, "MAC"-MAC address linkage,
"EmployeeNo"-Employee No. (person ID)-->
<isSupportRecordVideo opt="true,false"/>
<!--req, whether supports recording linkage-->
<supportLocalController>enable</supportLocalController>
<!--req, support distributed access controller-->
<isSupportAlarmOutClose opt="true,false"/>
<!--req, whether supports disabling linked alarm output-->
<isSupportAlarmInSetup opt="true,false"/>
<!--req, whether supports arming linked zone-->
<isSupportAlarmInClose opt="true,false"/>
<!--req, whether supports disarming linked zone-->
<isSupportMainDevStopBuzzer opt="true,false"/>
<!--req, whether supports stopping buzzing by access controller-->
<isSupportReaderStopBuzzer opt="true,false"/>
<!--req, whether supports stopping buzzing by linked card reader-->
<audioDisplayMode opt="Close,SinglePlay,CyclePlay"/>
<!--required, linked audio prompt mode: "Close"-disable, "SinglePlay"-play once, "CyclePlay"-loop playing-->
<audioDisplayID min="1" max="32"/>
<!--required, linked audio prompt mode: "Close"-disable, "SinglePlay"-play once, "CyclePlay"-loop playing-->
<isNotSupportOpenDoor>
<!--opt, whether the opening door linkage is not supported-->
</isNotSupportOpenDoor>
<isNotSupportCloseDoor>
<!--opt, whether the closing door linkage is not supported-->
</isNotSupportCloseDoor>
<isNotSupportNormalOpen>
<!--opt, whether the remaining door open is not supported-->
</isNotSupportNormalOpen>
<isNotSupportNormalClose>
<!--opt, whether the remaining door closed is not supported-->
</isNotSupportNormalClose>
<isNotSupportAlarmout>
<!--opt, whether the alarm output linkage is not supported-->
</isNotSupportAlarmout>
<isNotSupportCapturePic>
<!--opt, whether the capture linkage is not supported-->
</isNotSupportCapturePic>
<isNotSupportMainDevBuzzer>
<!--opt, whether not supports buzzing linkage of access controller, if supports, this node will not return-->
</isNotSupportMainDevBuzzer>
<isNotSupportReaderBuzzer>
<!--opt, whether not supports buzzing linkage of card reader, if supports, this node will not returned-->
</isNotSupportReaderBuzzer>
<EventList>
<EventEntry>

374
 Device Network SDK (Access Control on Person) Developer Guide

<Index>0</Index>
<mainEventName>DevEvent</mainEventName>
<SubEventNameList>
<subEventName>hostAntiDismantle</subEventName>
<!--req, controller tampering alarm -->
<subEventName>OfflineEcentNearlyFull</subEventName>
<!--req, alarm for offline event exceeding 90% -->
<subEventName>NetBroken</subEventName>
<!--req, network disconnected -->
<subEventName>NetRume</subEventName>
<!--req, network recovery -->
<subEventName>LowBattery</subEventName>
<!--req, battery low voltage -->
<subEventName>BatteryReume</subEventName>
<!--req, battery voltage recovered -->
<subEventName>ACOff</subEventName>
<!--req, AC power off -->
<subEventName>ACResume</subEventName>
<!--req, AC power recovery-->
<subEventName>SDCardFull</subEventName>
<!--req,SD card full alarm-->
<subEventName>LinkageCapturePic</subEventName>
<!--req,Linked capture event alarm-->
<subEventName>ImageQualityLow</subEventName>
<!--req,low face picture quality-->
<subEventName>FingerPrintQualityLow</subEventName>
<!--req,low fingerprint picture quality-->
<subEventName>BatteryElectricLow</subEventName>
<!--req,low battery voltage (for face device only)-->
<subEventName>BatteryElectricResume</subEventName>
<!--req,battery voltage recovery (for face device only)-->
<subEventName>FireImportShortCircuit</subEventName>
<!--req fire input short-circuit alarm-->
<subEventName>FireImportBrokenCircuit</subEventName>
<!--req fire input broken-circuit alarm-->
<subEventName>FireImportResume</subEventName>
<!--req fire input recovery-->
<subEventName>MasterRS485LoopnodeBroken</subEventName>
<!--req master controller RS485 loop node disconnection-->
<subEventName>MasterRS485LoopnodeResume</subEventName>
<!--req master controller RS485 loop node connection recovery-->
<subEventName>DistractControllerOnLine</subEventName>
<!--req,Distributed controller online-->
<subEventName>DistractControllerOffLine</subEventName>
<!--req,Distributed controller offline-->
<subEventName>FireButtonTrigger</subEventName>
<!--req,Fire button triggered-->
<subEventName>FireButtonResume</subEventName>
<!--req,Fire button recovered-->
<subEventName>MaintenanceButtonTrigger</subEventName>
<!--req,Maintenance button triggered-->
<subEventName>MaintenanceButtonResume</subEventName>

375
 Device Network SDK (Access Control on Person) Developer Guide

<!--req,Maintenance button recovered-->

<subEventName>EmergencyButtonTrigger</subEventName>
<!--req,Emergency button triggered-->
<subEventName>EmergencyButtonResume</subEventName>
<!--req,Emergency button recovered-->
<subEventName>LocalControlOffline</subEventName>
<!--req distributed access controller offline-->
<subEventName>LocalControlResume</subEventName>
<!--req, distributed access controller connection recovered-->
<subEventName>LocalDownsideRS485LoopNodeBroken</subEventName>
<!--req, distributed access controller downlink RS485 loop disconnection-->
<subEventName>LocalDownsideRS485LoopNodeResume</subEventName>
<!--req, distributed access controller downlink RS485 loop connection recovered-->
<subEventName>SubmarinebackCommBreak</subEventName>
<!--req, disconnected with anti-passing back server-->
<subEventName>SubmarinebackCommResume</subEventName>
<!--req, resume connection with anti-passing back server-->
<subEventName>RemoteActualGuard</subEventName>
<!--req, remote real-time arming-->
<subEventName>RemoteActualUnguard</subEventName>
<!--req, remote real-time disarming-->
<subEventName>MotorSensorException</subEventName>
<!--req, motor or sensor exception-->
<subEventName>CanBusException</subEventName>
<!--req, CAN bus exception-->
<subEventName>CanBusResume</subEventName>
<!--req, CAN bus restored-->
<subEventName>GateTemperatureOverrun</subEventName>
<!--req, too high pedestal temperature-->
<subEventName>IREmitterException</subEventName>
<!--req, active infrared intrusion detector exception-->
<subEventName>IREmitterResume</subEventName>
<!--req, active infrared intrusion detector restorted-->
<subEventName>LampBoardCommException</subEventName>
<!--req, communication with light board failed-->
<subEventName>LampBoardCommResume</subEventName>
<!--req, communication with light board restored-->
<subEventName>IRAdaptorBoardCommException</subEventName>
<!--req, communicated with IR adaptor exception-->
<subEventName>IRAdaptorBoardCommResume</subEventName>
<!--req, communication with IR adaptor restored-->
<subEventName>ChannelControllerDesmantleAlarm</subEventName>
<!--req, lane controller tampering alarm-->
<subEventName>ChannelControllerDesmantleResume</subEventName>
<!--req, lane controller tampering alarm restored-->
<subEventName>ChannelControllerFireImportAlarm</subEventName>
<!--req, lane controller fire input alarm-->
<subEventName>ChannelControllerFireImportResume</subEventName>
<!--req, lane controller fire input alarm restored-->
<subEventName>StayEvent</subEventName>
<!--opt, loitering event-->
<subEventName>LegalEventNearlyFull</subEventName>

376
 Device Network SDK (Access Control on Person) Developer Guide

<!--opt, alarm of no memory for legal offline event storage-->

</SubEventNameList>
</EventEntry>
<EventEntry>
<Index>1</Index>
<mainEventName>AlarmEvent</mainEventName>
<SubEventNameList>
<subEventName>AlarminShortCircuit</subEventName>
<!--req, zone short circuit alarm-->
<subEventName>AlarminBrokenCircuit</subEventName>
<!--req, zone open circuit alarm -->
<subEventName>AlarminException</subEventName>
<!--req, zone exception alarm -->
<subEventName>AlarmResume</subEventName>
<!--req, zone alarm recovery -->
<subEventName>CaseSensorAlarm</subEventName>
<!--req, event input alarm -->
<subEventName>CaseSensorResume</subEventName>
<!--req, event input recovery -->
</SubEventNameList>
</EventEntry>
<EventEntry>
<Index>2</Index>
<mainEventName>DoorEvent</mainEventName>
<SubEventNameList>
<subEventName>LeaderCardOpenBegin</subEventName>
<!--req, first card opening door starts -->
<subEventName>LeaderCardOpenStop</subEventName>
<!--req, first card open status door ends -->
<subEventName>AlwaysOpenBegin</subEventName>
<!--req, remained open status starts -->
<subEventName>AlwaysOpenStop</subEventName>
<!--req, remained open status ends -->
<subEventName>AlwaysCloseBegin</subEventName>
<!--req, remained closed status ends -->
<subEventName>AlwaysCloseStop</subEventName>
<!--req, remaining closed status ends-->
<subEventName>LockOpen</subEventName>
<!--req, open the door lock -->
<subEventName>LockClose</subEventName>
<!--req, close the lock -->
<subEventName>DoorButtonPress</subEventName>
<!--req, exit button pressed -->
<subEventName>DoorButtonRelease</subEventName>
<!--req, exit button released -->
<subEventName>DoorOpenNormal</subEventName>
<!--req, normally open the door (door magnetic) -->
<subEventName>DoorCloseNormal</subEventName>
<!--req, normally close the door (door magnetic) -->
<subEventName>DoorOpenAbnormal</subEventName>
<!--req, door opening exception (door magnetic )-->
<subEventName>DoorOpenTimeout</subEventName>

377
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, door opening timeout (door magnetic )-->

<subEventName>RemoteOpenDoor</subEventName>
<!--req, remotely open the door-->
<subEventName>RemoteCloseDoor</subEventName>
<!--req, remotely closed the door-->
<subEventName>RemoteAlwaysOpen</subEventName>
<!--req, remotely remain open -->
<subEventName>RemoteAlwaysClose</subEventName>
<!--req, remotely remain closed -->
<subEventName>NotBelongMultiCard</subEventName>
<!--req, the card is not associated to the multi-authentication group-->
<subEventName>InvalidMultiVerifyPeriod</subEventName>
<!--req, the card is not in the multi-authentication time period -->
<subEventName>MultiVerifySuperRightFail</subEventName>
<!--req, super password authentication failed -->
<subEventName>MultiVerifyRemoteRightFail</subEventName>
<!--req, remote authentication failed -->
<subEventName>MultiVerifySuccess</subEventName>
<!--req, successfully multi -authentication -->
<subEventName>MultiVerifyNeedRemoteOpen</subEventName>
<!--req, multi-authentication needs remote opening door -->
<subEventName>MultiVerifySuperRightSuccess</subEventName>
<!--req, successfully super password -->
<subEventName>MultiVerifyRepeatFail</subEventName>
<!--req, repeat authentication failed -->
<subEventName>MultiVerifyTimeout</subEventName>
<!--req, multi-authentication timeout -->
<subEventName>RemoteCapturePic</subEventName>
<!--req,remote capture-->
<subEventName>DoorBellRing</subEventName>
<!--req,door bell ringing-->
<subEventName>CallCenter</subEventName>
<!--req, call center-->
<subEventName>FirstCardAuthorizeBegin</subEventName>
<!--req,first card authorization started-->
<subEventName>FirstCardAuthorizeEnd</subEventName>
<!--req,first card authorization ended-->
<subEventName>FirstCardOpenWithoutAuthorize</subEventName>
<!--req,open door with unauthorized first card failed.-->
<subEventName>SecurityMoudleDesmantleAlarm</subEventName>
<!--req, door control security module anti-tamper alarm-->
<subEventName>FirstCardAuthorizeBegin</subEventName>
<!--req first card authorization start-->
<subEventName>FirstCardAuthorizeEnd</subEventName>
<!--req first card authorization end-->
<subEventName>DoorLockInputShortCircuit</subEventName>
<!--req door lock input short-circuit alarm-->
<subEventName>DoorLockInputBrokenCircuit</subEventName>
<!--req door lock input broken-circuit alarm-->
<subEventName>DoorLockInputException</subEventName>
<!--req door lock input exception alarm-->
<subEventName>DoorContactInputShortCircuit</subEventName>

378
 Device Network SDK (Access Control on Person) Developer Guide

<!--req magnet input short-circuit alarm-->

<subEventName>DoorContactInputBrokenCircuit</subEventName>
<!--req magnet input broken-circuit alarm-->
<subEventName>DoorContactInputException</subEventName>
<!--req magnet input exception alarm-->
<subEventName>OpenButtonInputShortCircuit</subEventName>
<!--req door button input short-circuit alarm-->
<subEventName>OpenButtonInputBrokenCircuit</subEventName>
<!--req door button input broken-circuit alarm-->
<subEventName>OpenButtonInputException</subEventName>
<!--req door button input exception alarm-->
<subEventName>DoorLockOpenException</subEventName>
<!--req door lock open exception-->
<subEventName>DoorLockOpenTimeout</subEventName>
<!--req door lock open timeout-->
<subEventName>FirstCardOpenWithoutAuthorize</subEventName>
<!--req first card failed to open door without authorization-->
<subEventName>CallLadderRelayBreak</subEventName>
<!--req,Elevator relay disconnected-->
<subEventName>CallLadderRelayClose</subEventName>
<!--req,Elevator relay connected-->
<subEventName>AutoKeyRelayBreak</subEventName>
<!--req,Auto-button relay disconnected-->
<subEventName>AutoKeyRelayClose</subEventName>
<!--req,Auto-button relay connected-->
<subEventName>KeyControlRelayBreak</subEventName>
<!--req,Button relay disconnected-->
<subEventName>KeyControlRelayClose</subEventName>
<!--req,Button relay connected-->
<subEventName>RemoteVisitorCallLadder</subEventName>
<!--req,Visitor called elevator-->
<subEventName>RemoteHouseholdCallLadder</subEventName>
<!--req,Resident called elevator-->
<subEventName>LegalMessage</subEventName>
<!--req, valid message-->
<subEventName>IllegalMessage</subEventName>
<!--req, invalid message-->
<subEventName>Trailing</subEventName>
<!--req, tailgating-->
<subEventName>ReverseAccess</subEventName>
<!--req, reserve passing-->
<subEventName>ForceAccess</subEventName>
<!--req, force accessing-->
<subEventName>ClimbingOverGate</subEventName>
<!--req, climbing over barrier-->
<subEventName>PassingTimeout</subEventName>
<!--req, passing timed out-->
<subEventName>IntrusionAlarm</subEventName>
<!--req, intrusion alarm-->
<subEventName>FreeGatePassNotAuth</subEventName>
<!--req, authentication failed when free passing the turnstile-->
<subEventName>DropArmBlock</subEventName>

379
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, barrier obstructed-->

<subEventName>DropArmBlockResume</subEventName>
<!--req, barrier obstruction restored-->
<subEventName>RemoteControlCloseDoor</subEventName>
<!--req, close door via keyfob-->
<subEventName>RemoteControlOpenDoor</subEventName>
<!--req, open door via keyfob-->
<subEventName>RemoteControlAlwaysOpenDoor</subEventName>
<!--req, remain door open via keyfob-->
</SubEventNameList>
</EventEntry>
<EventEntry>
<Index>3</Index>
<mainEventName>ReaderEvent</mainEventName>
<SubEventNameList>
<subEventName>StressAlarm</subEventName>
<!--req, duress alarm-->
<subEventName>ReaderDesmantleAlarm</subEventName>
<!--req, card reader tamper-proof alarm-->
<subEventName>LegalCardPass</subEventName>
<!--req, valid card successfully authenticated -->
<subEventName>CardAndPasswdPass</subEventName>
<!--req, card and password successfully authenticated -->
<subEventName>CardAndPasswdFail</subEventName>
<!--req, card and password authentication failed -->
<subEventName>CardAndPasswdTimeout</subEventName>
<!--req, card and password authentication timeout -->
<subEventName>CardMaxAuthenticateFail</subEventName>
<!--req, card reader authentication over times -->
<subEventName>CardNoRight</subEventName>
<!--req, no permission for the card -->
<subEventName>CardInvalidPeriod</subEventName>
<!--req, invalid time segment -->
<subEventName>CardOutofDate</subEventName>
<!--req, card exceeds the validate -->
<subEventName>InvalidCard</subEventName>
<!--req, invalid card No. -->
<subEventName>AntiSneakFail</subEventName>
<!--req, anti-passback authentication failed -->
<subEventName>InterlockDoorNotClose</subEventName>
<!--req, interlocking door not closed -->
<subEventName>FingerprintComparePass</subEventName>
<!--req, Fingerprint Recognition Passed-->
<subEventName>FingerprintCompareFail</subEventName>
<!--req, Fingerprint Recognition Failed-->
<subEventName>CardFingerprintVerifyPass</subEventName>
<!--req, Card + Fingerprint Authentication Passed-->
<subEventName>CardFingerprintVerifyFail</subEventName>
<!--req,Card + Fingerprint Authentication Failed-->
<subEventName>CardFingerprintVerifyTimeout</subEventName>
<!--req,Card + Fingerprint Authentication Timeout-->
<subEventName>CardFingerprintPasswdVerifyPass</subEventName>

380
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, Card + Fingerprint + Password Authentication Passed-->

<subEventName>CardFingerprintPasswdVerifyFail</subEventName>
<!--req, Card + Fingerprint + Password Authentication Failed-->
<subEventName>CardFingerprintPasswdVerifyTimeout</subEventName>
<!--req, Card + Fingerprint + Password Authentication Timeout-->
<subEventName>FingerprintPasswdVerifyPass</subEventName>
<!--req, Fingerprint + Password Authentication Passed-->
<subEventName>FingerprintPasswdVerifyFail</subEventName>
<!--req, Fingerprint + Password Authentication Failed-->
<subEventName>FingerprintPasswdVerifyTimeout</subEventName>
<!--req, Fingerprint + Password Authentication Timeout-->
<subEventName>FingerprintInexistence</subEventName>
<!--req, No Fingerprint-->
<subEventName>FaceVerifyPass</subEventName>
<!--req, Face Authentication Passed-->
<subEventName>FaceVerifyFail</subEventName>
<!--req, Face Authentication Failed-->
<subEventName>FaceAndFpVerifyPass</subEventName>
<!--req, Face + Fingerprint Authentication Passed-->
<subEventName>FaceAndFpVerifyFail</subEventName>
<!--req,Face + Fingerprint Authentication Failed-->
<subEventName>FaceAndFpVerifyTimeout</subEventName>
<!--req, Face + Fingerprint Authentication Timeout-->
<subEventName>FaceAndPwVerifyPass</subEventName>
<!--req, Face + Password Authentication Passed-->
<subEventName>FaceAndPwVerifyFail</subEventName>
<!--req, Face + Password Authentication Failed-->
<subEventName>FaceAndPwVerifyTimeout</subEventName>
<!--req, Face + Password Authentication Timeout-->
<subEventName>FaceAndCardVerifyPass</subEventName>
<!--req, Face + Card Authentication Passed-->
<subEventName>FaceAndCardVerifyFail</subEventName>
<!--req, Face + Card Authentication Failed-->
<subEventName>FaceAndCardVerifyTimeout</subEventName>
<!--req,Face + Card Authentication Timeout-->
<subEventName>FaceAndPwAndFpVerifyPass</subEventName>
<!--req,Face + Password + Fingerprint Authentication Passed-->
<subEventName>FaceAndPwAndFpVerifyFail</subEventName>
<!--req,Face + Password + Fingerprint Authentication Failed-->
<subEventName>FaceAndPwAndFpVerifyTimeout</subEventName>
<!--req,Face + Password + Fingerprint Authentication Timeout-->
<subEventName>FaceAndCardAndFpVerifyPass</subEventName>
<!--req,Face + Card + Fingerprint Authentication Passed-->
<subEventName>FaceAndCardAndFpVerifyFail</subEventName>
<!--req,Face + Card + Fingerprint Authentication Failed-->
<subEventName>FaceAndCardAndFpVerifyTimeout</subEventName>
<!--req,Face + Card + Fingerprint Authentication Timeout-->
<subEventName>EmployeeAndFpVerifyPass</subEventName>
<!--req,Employee No. + Fingerprint Authentication Passed-->
<subEventName>EmployeeAndFpVerifyFail</subEventName>
<!--req,Employee No. + Fingerprint Authentication Failed-->
<subEventName>EmployeeAndFpVerifyTimeout</subEventName>

381
 Device Network SDK (Access Control on Person) Developer Guide

<!--req,Employee No. + Fingerprint Authentication Timeout-->

<subEventName>EmployeeAndFpAndPwVerifyPass</subEventName>
<!--req,Employee No. + Fingerprint + Password Authentication Passed-->
<subEventName>EmployeeAndFpAndPwVerifyFail</subEventName>
<!--req,Employee No. + Fingerprint + Password Authentication Failed-->
<subEventName>EmployeeAndFpAndPwVerifyTimeout</subEventName>
<!--req,Employee No. + Fingerprint + Password Authentication Timeout-->
<subEventName>EmployeeAndFaceVerifyPass</subEventName>
<!--req,Employee No. + Face Authentication Passed-->
<subEventName>EmployeeAndFaceVerifyFail</subEventName>
<!--req,Employee No. + Face Authentication Failed-->
<subEventName>EmployeeAndFaceVerifyTimeout</subEventName>
<!--req,Employee No. + Face Authentication Timeout-->
<subEventName>FaceRecognizeFail</subEventName>
<!--req, Face picture recognization failed-->
<subEventName>EmployeeAndPwVerifyPass</subEventName>
<!--req,Employee No. + Password Authentication Passed-->
<subEventName>EmployeeAndPwVerifyFail</subEventName>
<!--req,Employee No. + Password Authentication Failed-->
<subEventName>EmployeeAndPwVerifyTimeout</subEventName>
<!--req,Employee No. + Password Authentication Timeout-->
<subEventName>DoorOpenOrDormantFail</subEventName>
<!--req,door remains closed or sleepy status authentication failed.-->
<subEventName>AuthPlanDormantFail</subEventName>
<!--req,authentication of sleepy mode in the schedule failed.-->
<subEventName>CardEncryptVerifyFail</subEventName>
<!--req,authentication of card encryption failed.-->
<subEventName>SubmarinebackReplyFail</subEventName>
<!--req,response of anti-passing back server failed.-->
<subEventName>PasswordMismatch</subEventName>
<!--opt, password mismatched.-->
<subEventName>EmployeeNoNotExist</subEventName>
<!--req, the employee ID does not exist.-->
<subEventName>CombinedVerifyPass</subEventName>
<!--req, authenticated .-->
<subEventName>CombinedVerifyTimeout</subEventName>
<!--req, authentication timed out.-->
<subEventName>VerifyModeMismatch</subEventName>
<!--req, authentication mode mismatched.-->
<subEventName>HumanDetectFail</subEventName>
<!--req,human detection failed.-->
<subEventName>PeopleAndIdCardComparePass</subEventName>
<!--req, face and ID card autheticated-->
<subEventName>PeopleAndIdCardCompareFail</subEventName>
<!--req, face and ID card authentication failed-->
<subEventName>InformalMifareCardVerifyFail</subEventName>
<!--opt, authentication failed: invalid Mifare card-->
<subEventName>CPUCardEncryptVerifyFail</subEventName>
<!--opt, verifying CPU card encryption failed-->
<subEventName>NFCDisableVerifyFail</subEventName>
<!--opt, disabling NFC verification failed-->
<subEventName>EMCardRecognizeNotEnabled</subEventName>

382
 Device Network SDK (Access Control on Person) Developer Guide

<!--opt, EM card recognition is disabled-->

<subEventName>M1CardRecognizeNotEnabled</subEventName>
<!--opt, M1 card recognition is disabled-->
<subEventName>CPUCardRecognizeNotEnabled</subEventName>
<!--opt, CPU card recognition is disabled-->
<subEventName>IDCardRecognizeNotEnabled</subEventName>
<!--opt, ID card recognition is disabled-->
<subEventName>CardSetSecretKeyFail</subEventName>
<!--opt, importing key to the card failed-->
</SubEventNameList>
</EventEntry>
</EventList>
</EventLinkage>

<FingerPrint>
<!--req, fingerprint parameters -->
<enable opt="true,false"/>
<!--req, whether to support fingerprint settings -->
<cardNo min="" max=""/>
<!--req, card No. length -->
<fingerPrintLen min="" max=""/>
<!--req, fingerprint data length-->
<EnableCardReader min="" max=""/>
<!--req, supported card reader No.-->
<fingerType opt="Normal,Stress,patrolFP,superFP,dismissingFP"/>
<!--req, "Normal"-normal fingerprint, "Stress"-duress fingerprint, "patrolFP"-patrol fingerprint, "superFP"-super
fingerprint, "dismissingFP"-dismiss fingerprint-->
<fingerPrintID min="" max=""/>
<!--req, finger ID-->
<callbackMode opt="allRetrun,partReturn"/>
<!--req, callback mode, allRetrun-block (return after all the card readers are offline), partReturn-non-block (return
after a part of card readers are offline)-->
<isSupportFingerNo/>
<!--opt, boolean, whether the device supports setting finger ID: "true"-yes-->
<recvStatus opt="0,1,2,3,4,5,6,7,8,9,10"/>
<!--opt, error status: 0-success, 1-incorrect finger ID, 2-incorrect fingerprint type, 3-invalid card No. (the card No.
does not meet the device requirements), 4-the fingerprint is not linked with employee No. or card No. (the employee
No. or the card No. is NULL), 5-the employee No. does not exist, 6-the fingerprint data length is 0, 7-invalid card
reader No., 8-invalid employee No., 9-invalid first-time authentication value, 10-other parameters error-->
<employeeNo min="" max=""/>
<!--opt, employee No. (person ID)-->
<leaderFP opt="true"/>
<!--opt, whether the fingerprint supports first-time authentication: "true"-yes, "false" or this node is not returned-
no-->
<isSupportFingerCover>
<!--opt, xs:boolean, whether to overwrite the old fingerprint information when applying a new fingerprint
information linked to the same employee No. (person ID): "true"-yes, this node is not returned-no-->
</isSupportFingerCover>
</FingerPrint>
<DelFingerPrint>
<!--req, delete fingerprint parameter, which corresponds to the command NET_DVR_DEL_FINGERPRINT_CFG_V50.
This node will not be returned if device does not support this function. After calling the API

383
 Device Network SDK (Access Control on Person) Developer Guide

NET_DVR_StartRemoteConfig with command NET_DVR_DEL_FINGERPRINT_CFG_V50, if this node is returned, you

should wait for the return of callback function to get the actual deleting result; if this node is not returned, the return
of API NET_DVR_StartRemoteConfig already indicates the deleting result-->
<delFingerPrintMode opt="byCard,byReader"/>
<!--req, deleting fingerprint mode: byCard-by card No., byReader- by card reader-->
<FingerPrintStatus>
<!--req, delete fingerprint status-->
<cardReaderNo min="" max=""/>
<!--req, fingerprint recorder No.-->
<status min="0" max="3"/>
<!--req, status: 0-invalid, 1-handling, 2-deleting failed, 3-completed-->
</FingerPrintStatus>
<employeeNo min="" max=""/>
<!--req, employee No. (person ID)-->
</DelFingerPrint>

<SMS>
<enable opt="true,false"/>
<!--req, whether to support SMS funtion -->
<PhoneLinkageDoor>
<!--req, mobile phone links with door -->
<openRight opt="true,false"/>
<!--req, door opening permission -->
<closeRight opt="true,false"/>
<!--req, door closing permission -->
<NormalOpenRight opt="true,false"/>
<!--req, door remained opening permission -->
<NormalCloseRight opt="true,false"/>
<!--req, door remained closing permission -->
<armRight opt="true,false"/>
<!--req, arming permission -->
<DisarmRight opt="true,false"/>
<!--req, disarming permission -->
</PhoneLinkageDoor>
<whiteListNum min="1" max="32"/>
<!--req, whitelist number-->
</SMS>
<RealteUserInfo>
<!--req, NET_DVR_CARD_CFG_SEND_DATA and NET_DVR_CARD_USER_INFO_CFG-->
<enabled opt="true,false"/>
<!--req, whether to support card No. being linked to user information-->
<userNameLen min="" max=""/>
<!--req, user name length-->
</RealteUserInfo>
<ContinuousShootCfg>
<!--req,NET_DVR_SNAPCFG-->
<enabled opt="true,false"/>
<!--req,whether to support triggering capture parameters configuration-->
<relatedDriveWay min="" max=""/>
<!--req, IO related vehicle lane No.-->
<snapTimes min="" max=""/>
<!--req, coil capture times:, 0-5-->

384
 Device Network SDK (Access Control on Person) Developer Guide

<snapWaitTime min="" max=""/>

<!--req, capture waiting time, unit:ms, value range[0,60000]-->
<IntervalTimeList size="4">
<intervalTime min="" max=""/>
<!--req,interval of continuous capture, unit:ms-->
</IntervalTimeList>
<JpegParam>
<picSize
opt="CIF,QCIF,D1,UXGA,SVGA,HD720P,VGA,XVGA,HD900p,HD1080,2560*1920,1600*304,2048*1536,2448*2048,2448
*1200,
2448*800,XGA,SXGA,WD1,1080i,
576*576,1536*1536,1920*1920,320*240,720*720,1024*768,1280*1280,1600*600,

2048*768,160*120,336*256,384*256,384*216,320*256,320*192,512*384,480*272,512*272,288*320,144*176,
480*640,240*320,120*160,576*720,720*1280,576*960, 180*240, 360*480, 540*720, 720*960, 960*1280,
1080*1440, Auto"/>
<!-- opt,image size-->
<picQuality opt="best,good,general" />
<!-- opt,image quality: 0-Best, 1- Better, 2- Good-->
</JpegParam>
</ContinuousShootCfg>
<PictureCfg>
<!--req,reuse some fields of NET_DVR_PICTURECFG-->
<enableUp opt="true,false"/>
<!--req, whether to support background picture uploading-->
<enableDel opt="true,false"/>
<!--req, whether to support deleting background picture-->
<useType min="" max=""/>
<!--req,picture type, 1- background picture, 2-GIF picture, 3-CAD picture-->
<sequence min="" max=""/>
<!--req, sequence No.-->
<BasemapCfg>
<sourWidth min="" max=""/>
<!--req, initial picture width-->
<sourHeight min="" max=""/>
<!--req, initial picture height-->
</BasemapCfg>
</PictureCfg>
<ExternalDevCfg>

<!--req,NET_DVR_ACS_EXTERNAL_DEV_CFG-->
<IDCardUpMode opt="number,all"/>
<!--req, ID information report, number: upload 18-digit ID number; all: upload all information-->
<cardVerifyMode opt="remoteCenter,clientPlatform"/>
<!--req, card verification mode, remoteCenter: remote center verification; clientPlatform: client platform
verification-->
<ACSDevType
opt="IDCardReader,ICReader,QRCodeReader,fingerPrintReader,QRCodeReaderandScreen,recycleCard,screen,fingerPrin
tModule,voiceModule,peopleAndIdCard"/>
<!--req, device model: 1- ID card reader, 2- IC card reader, 3- QR code reader, 4- Fingerprint reader, 5- Screen + QR
code reader, 6- Card collector, 7- Screen, 8- Fingerprint scanner, 9- Voice module, 10-person and ID card device-->
<doorMode opt="inDoor,outDoor"/>

385
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, door in/out type, inDoor: enter, outDoor: exit-->

<DevDetailType>
<IDCardReaderType opt="iDR210,IDM10,HikIDCardReader"/>
<!--req, ID card reader model-->
<screenType opt="DC48270RS043_01T,DC80480B070_03T"/>
<!--req,LCD model-->
</DevDetailType>
</ExternalDevCfg>
<PersonnelChannelCfg>
<!--req,NET_DVR_PERSONNEL_CHANNEL_CFG-->
<inMode opt="controlled,forbid,freedom"/>
<!--req, enter mode, 0- controlled; 1- denied; 2- free-->
<outMode opt="controlled,forbid,freedom"/>
<!--req, exit mode, 0- controlled; 1- denied; 2- free-->
<workMode opt="urgent,repair,normalClose,normalOpen"/>
<!--req, operating mode, 0- emergency, 1- maintenance, 2- normally closed, 3- normally open-->
</PersonnelChannelCfg>
<PlatformVerifyCfg>
<!--req,NET_DVR_PLATFORM_VERIFY_CFG-->
<doorNo min="" max=""/>
<!--req, door No.-->
<resultType opt="legal,illegal"/>
<!--req, verification result type, legal: illegal, illegal: legal-->
<screenDisplay min="" max=""/>
<!--req,LED display character length-->
</PlatformVerifyCfg>
<PersonStatisticsCfg>
<!--req,NET_DVR_PERSON_STATISTICS_CFG-->
<enableStatistics opt="true,false"/>
<!--req, whether to enable people counting-->
<enableOfflineStatistics opt="true,false"/>
<!--req, whether to enable offline people counting-->
<countSignalStatisticalStandard opt="IRDetectPass,AuthQuantity"/>
<!--req, people counting type: IRDetectPass- by IR detection, AuthQuantity- by authentication number-->
</PersonStatisticsCfg>
<ScreenDisplayCfg>
<!--req,NET_DVR_SCREEN_DISPLAY_CFG-->
<FontSize min="" max=""/>
<!--req, font size-->
<rowSpacing min="" max=""/>
<!--req, row space-->
<columnSpacing min="" max=""/>
<!--req, column space-->
<firstRowPosition opt="0,1/8,2/8,3/8,4/8,5/8,6/8,7/8"/>
<!--req, first row position-->
<degree opt="0,90"/>
<!--req, character display direction abgle, unit: degree-->
<screenType opt="DC48270RS043_01T,DC80480B070_03T"/>
<!--req, screen type-->
</ScreenDisplayCfg>
<GateTimeCfg>
<!--req,NET_DVR_GATE_TIME_CFG-->

386
 Device Network SDK (Access Control on Person) Developer Guide

<holdOnALarmTime min="" max=""/>

<!--req, extend alarm buzzer time, unit: ms -->
<holdOnGateOpenTime min="" max=""/>
<!--req, door open time before receiving close command, unit: ms-->
<postponeIntrusionAlarmTime min="" max=""/>
<!--req, delay trigger intrusion alarm time, unit: ms-->
<noLaneAccessTimeLimitTime min="" max=""/>
<!--req, timeout alarm time for no people passing after channel received valid passing verification signal, unit: s-->
<safetyZoneStayTime min="" max=""/>
<!--req, timeout alarm time for people staying in the channel when reached safety region after the channel received
valid passing verification signal, unit:s-->
<IRTriggerTimeoutTime min="0" max="255"/>
<!--req, IR triggering timeout, unit: s-->
</GateTimeCfg>
<LocalControllerStatus>enable</LocalControllerStatus>
<!--req, support getting distributed access controller status-->
<searchLocalController>enable</searchLocalController>
<!--req, support searching distributed access controller-->
<showDeviceType opt="Floor"/>
<!--opt,Display device type (by default, display the door parameters if there is no this field),Floor- Displayed floor-->

<FaceParam>
<!--req,Face parameter-->
<enable opt="true"/>
<!--req,whether to support face parameter configuration-->
<cardNo min="" max=""/>
<!--req,Card No. length-->
<faceLen min="" max=""/>
<!--req,Face data length-->
<enableCardReader min="" max=""/>
<!--req,Supported card reader No.-->
<faceID min="" max=""/>
<!--req,Face No.-->
<faceDataType opt="module,picture"/>
<!--req,Face data type (the default type is template if there is no this node)-->
<isSupportFaceCover>
<!--opt, whether supports covering existed data when applying face picture data-->
</isSupportFaceCover>
</FaceParam>
<isSupportGetDeviceEvent opt="true,false"/>
<!--opt, whether to support getting device event: "true"-yes, "false" or this node is not returned-no-->
<isSupportDeployType min="0" max="1"/>
<!--opt, supported arming type: 0-arm via client software, 1-real-time arming>
<UploadRightControllerAudio>
<!--req, uploading audio file of main controller-->
<audioID min="2" max="32"/>
<!--req, audio file ID. 0xffffffff indicates uploading all audio files, and currently the device only supports uploading
all audio files instead of uploading a single audio file by ID-->
</UploadRightControllerAudio>
<DownloadRightControllerAudio>
<!--req, downloading audio file of main controller-->
<audioID min="2" max="32"/>

387
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, audio file ID. 0xffffffff indicates downloading all audio files, and currently the device only supports
downloading all audio files instead of downloading a single audio file by ID-->
</DownloadRightControllerAudio>
<BlackListPictureParam>
<!--req, parameter of picture in blacklist (NET_DVR_BULK_UPLOAD_BLACK_LIST_PICTURE)-->
<BlackListPictureCond>
<!--req, blacklist picture condition-->
<pictureNum min="" max=""/>
<!--req, picture quantity-->
</BlackListPictureCond>
<cardNo min="" max=""/>
<!--req, card No.-->
<name min="" max=""/>
<!--req, name-->
<sex opt="male,female"/>
<!--req, gender: male- Male, female- Female-->
<pictureValid opt="invalid,valid"/>
<!--req, whether blacklist picture is valid: invalid- Invalid,valid? Valid-->
<pictureLen min="" max=""/>
<!--req, blacklist picture size-->
<BlackListPictureStatus>
<!--req, blacklist picture status-->
<cardNo min="" max=""/>
<!--req, card No.-->
<status opt=" processing,failed,success"/>
<!--req, status: processing- Processing, failed- Failed,success- Succeeded-->
</BlackListPictureStatus>
</BlackListPictureParam>
<IDBlackListParam>
<!--ID blacklist parameter (NET_DVR_BULK_UPLOAD_ID_BLACK_LIST)-->
<IDBlackListCond>
<!--req, ID blacklist condition-->
<blackListNum min="" max=""/>
<!--req, blacklist quantity-->
</IDBlackListCond>
<blackListValid opt="invalid,valid"/>
<!--req, whether ID card blacklist is valid or not-->
<IDBlackListStatus>
<!--req, ID card blacklist status-->
<IDNum min="" max=""/>
<!--req, ID number-->
<status opt=" processing,failed,success"/>
<!--req, status: processing- Processing, failed- Failed, success- Succeeded-->
</IDBlackListStatus>
</IDBlackListParam>
<CaptureFingerPrint>
<!--opt, xs:boolean, collect fingerprint information-->
<pictureType opt="full,quarter">
<!--req, xs:string, fingerprint picture type-->
</pictureType>
<fingerNo min="1" max="10">
<!--req, xs:integer, fingerprint No.-->

388
 Device Network SDK (Access Control on Person) Developer Guide

</fingerNo>
<isSupportFingerData opt="true,false">
<!--req, xs:boolen, fingerprint data-->
</isSupportFingerData>
<isSupportFingerPicture opt="true,false">
<!--req, xs:boolen, fingerprint picture-->
</isSupportFingerPicture>
<fingerPrintQuality min="1" max="100">
<!--req, xs:integer, fingerprint quality-->
</fingerPrintQuality>
</CaptureFingerPrint>
<CaptureFace>
<!--opt, xs:boolean, collect face information-->
<isSupportFaceTemplate1 opt="true,false">
<!--req, xs:boolen, face template data 1-->
</isSupportFaceTemplate1>
<isSupportFaceTemplate2 opt="true,false">
<!--req, xs:boolen, face template data 2-->
</isSupportFaceTemplate2>
<isSupportFacePic opt="true,false">
<!--req, xs:boolen, face picture data-->
</isSupportFacePic>
<faceQuality min="1" max="100">
<!--req, xs:integer, face quality-->
</faceQuality>
<captureProgress opt="0,100">
<!--req, xs:integer, collection progress-->
</captureProgress>
<isSupportInfraredFacePic opt="true,false"><!--req, xs:boolen, whether to support infrared face picture data></
isSupportInfraredFacePic>
</CaptureFace>
<isSupportUploadCertificateBlackList>
<!--opt, xs:boolean, Whether to support uploading ID Card blacklist-->
</isSupportUploadCertificateBlackList>
<isSupportGetRegisterInfo>
<!--opt, xs:boolean, Whether supports getting registered information-->
</isSupportGetRegisterInfo>
<isSupportDownloadCertificateBlackListTemplet>
<!--opt, xs:boolean, Whether to support downloading template of ID card blacklist-->
</isSupportDownloadCertificateBlackListTemplet>
<ScheduleInfo>
<!-- opt, xs:boolean, shift schedule information-->
<command opt="personal,everyone">
<!--req, xs:string, Search condition-->
</command>
<employeeNo min="" max="">
<!--req, xs:integer, Employee No.-->
</employeeNo>
<name min="1" max="32">
<!--req, xs:string, Name-->
</name>
<departmentName min="1" max="32">

389
 Device Network SDK (Access Control on Person) Developer Guide

<!--req, xs:string, Department name-->

</departmentName>
<schedulePlanNo min="" max="">
<!--req, xs:integer, Shift schedule No.-->
</schedulePlanNo>
<schedulePlanType opt="personal,department">
<!--req, xs:string, Shift schedule type-->
</schedulePlanType>
<enabled opt="true,false">
<!--req, xs:boolen, Enable-->
</enabled>
<scheduleType opt="noSchedule,ordinaryClass,workingClass">
<!--req, xs:string, Shift type-->
</scheduleType>
<scheduleNo min="" max="">
<!--req, xs:integer, Shift No.-->
</scheduleNo>
<scheduleStartTime>
<!--req, xs:time, ISO8601 time, "2016-01-01", Start time-->
</scheduleStartTime>
<scheduleEndTime>
<!--req, xs:time, ISO8601 time, "2016-02-17", End time-->
</scheduleEndTime>
<holidayNo min="" max="">
<!--req, xs:integer, Holiday group No.-->
</holidayNo>
</ScheduleInfo>
<AttendanceSummaryInfo>
<!-- opt, xs:boolean, Time and attendance information overview-->
<command opt="personal,everyone">
<!--req, xs:string, Search condition-->
</command>
<employeeNo min="" max="">
<!--req, xs:integer, Employee No.-->
</employeeNo>
<name min="1" max="32">
<!--req, xs:string, Name-->
</name>
<departmentName min="1" max="32">
<!--req, xs:string, Department name-->
</departmentName>
<workStandard min="" max="">
<!--req, xs:integer, Standard working time (minutes)-->
</workStandard>
<workActual min="" max="">
<!--req, xs:integer, Actual working time (minutes)-->
</workActual>
<lateTimes min="" max="">
<!--req, xs:integer, Late times-->
</lateTimes>
<lateMinutes min="" max="">
<!--req, xs:integer, Total late time (minutes)-->

390
 Device Network SDK (Access Control on Person) Developer Guide

</lateMinutes>
<leaveEarlyTimes min="" max="">
<!--req, xs:integer, Early Leave Times-->
</leaveEarlyTimes>
<leaveEarlyMinutes min="" max="">
<!--req, xs:integer, Total eearly leave time (minutes)-->
</leaveEarlyMinutes>
<overtimeStandard min="" max="">
<!--req, xs:integer, Standard Overtime (minutes)-->
</overtimeStandard>
<overtimeActual min="" max="">
<!--req, xs:integer, Actual Overtime (minutes)-->
</overtimeActual>
<attendanceStandard min="" max="">
<!--req, xs:integer, Standard Attendance (day)-->
</attendanceStandard>
<attendanceActual min="" max="">
<!--req, xs:integer, Actual Attendance (Day)-->
</attendanceActual>
<absentDays min="" max="">
<!--req, xs:integer, Absent (Day)-->
</absentDays>
</AttendanceSummaryInfo>
<AttendanceRecordInfo>
<!--opt, xs:boolean, Time and Attendance Records-->
<command opt="personal,everyone">
<!--req, xs:string, Search Condition-->
</command>
<employeeNo min="" max="">
<!--req, xs:integer, Employee No.-->
</employeeNo>
<name min="1" max="32">
<!--req, xs:string, Name-->
</name>
<departmentName min="1" max="32">
<!--req, xs:string, Department Name-->
</departmentName>
<attendanceTime>
<!--req, xs:time, ISO8601 time, "2016-02-17T17:30:08+08:00", Attendance Time-->
</attendanceTime>
</AttendanceRecordInfo>
<AbnormalInfo>
<!-- opt, xs:boolean, Exception Statistics Information-->
<command opt="personal,everyone">
<!--req, xs:string, Search Condition-->
</command>
<employeeNo min="" max="">
<!--req, xs:integer, Employee No.-->
</employeeNo>
<name min="1" max="32">
<!--req, xs:string, Name-->
</name>

391
 Device Network SDK (Access Control on Person) Developer Guide

<departmentName min="1" max="32">

<!--req, xs:string, Department Name-->
</departmentName>
<onDutyTime>
<!--req, xs:time, ISO8601 time, "2016-02-17T08:30:08+08:00", Start-Work Time-->
</onDutyTime>
<offDutyTime>
<!--req, xs:time, ISO8601 time, "2016-02-17T17:30:08+08:00", End-Work Time-->
</offDutyTime>
<lateMinutes min="" max="">
<!--req, xs:integer, Late Duration (minutes)-->
</lateMinutes>
<leaveEarlyMinutes min="" max="">
<!--req, xs:integer, Early Leave Duration (minutes)-->
</leaveEarlyMinutes>
<absenceMinutes min="" max="">
<!--req, xs:integer, Absent Duration (minutes)-->
</absenceMinutes>
<totalMinutes min="" max="">
<!--req, xs:integer, Total Duration (minutes)-->
</totalMinutes>
</AbnormalInfo>
<CheckFacePicture>
<!-- opt, xs:boolean, authenticate identity via 1:N face picture matching-->
<pictureNum min="" max="">
<!--req, xs:integer, picture number>
</pictureNum>
<checkStatus opt="1,2,3,4,5,6,7,8,9,10,11">
<!--req, xs:integer, matching result: 1-modeling completed, 2-modeling failed, 3-the communication with the face
picture module failed, 4-no face in the picture, 5-the face is too close to the top picture border, 6-the face is too close
to the bottom picture border, 7-the face is too close to the left picture border, 8-the face is too close to the right
picture border, 9-the face picture is clockwise, 10-the face picture is anticlockwise, 11-the proportion of the pupillary
distance is small, 12-face picture matches the template, 13-face picture mismatches the template>
</checkStatus>
<checkTemplate opt="0,1">
<!--opt, xs:integer, 0-picture verification, 1-picture and modeling data matching verification>
</checkTemplate>
</CheckFacePicture>
<supplementLightNo min="" max=""/>
<!--opt, supplement light number>
<maxWhiteFaceNum/>
<!--opt, the maximum number of face picture in whitelist>
<maxBlackFaceNum/>
<!--opt, the maximum number of face picture in blacklist>
<isSupportGetFailedFaceInfo>
<!--opt, xs:boolean, whether supports getting the information of face modeling failure after upgrading-->
</isSupportGetFailedFaceInfo>
<FailedFaceInfoParam>
<!--opt, xs:boolean, get the information of face modeling failure after upgrading-->
<FailedFaceInfoCond/>
<FailedFaceInfo>
<!--req, face modeling failure information-->

392
 Device Network SDK (Access Control on Person) Developer Guide

<cardNo min="" max=""/>

<!--req, card number-->
<errorCode min="" max=""/>
<!--req, face modeling failure error code-->
</FailedFaceInfo>
<isSupportFaceAndTemplate>
<!--opt, xs:boolean, whether supports configuring face picture and modeling data-->
</isSupportFaceAndTemplate>
<FaceAndTemplateParam>
<!--opt, face picture and modeling data configuration-->
<cardNo min="" max=""/>
<!--req, card number-->
<faceLen min="" max=""/>
<!--req, face picture size-->
<faceTemplateLen min="" max=""/>
<!--req, face picture template data size-->
</FaceAndTemplateParam>
</AcsAbility>

6.108 XML_CaptureFingerPrint
CaptureFingerPrint message in XML format
<CaptureFingerPrint version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<fingerData><!--dep, xs:string, fingerprint data, which is between 1 and 768, and it should be encoded by Base64--></
fingerData>
<fingerNo><!--req, xs:integer, finger No., which is between 1 and 10--></fingerNo>
<fingerPrintQuality><!--req, xs:integer, fingerprint quality, which is between 1 and 100--></fingerPrintQuality>
</CaptureFingerPrint>

6.109 XML_CaptureFingerPrintCond
CaptureFingerPrintCond message in XML format
<CaptureFingerPrintCond version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<fingerNo><!--req, xs: integer, finger No., which is between 1 and 10--></fingerNo>
</CaptureFingerPrintCond>

6.110 XML_Cap_AccessControl
AccessControl capability message in XML format
<AccessControl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportWiegandCfg>
<!--opt, xs:boolean, whether it supports Wiegand configuration-->
</isSupportWiegandCfg>
<isSupportModuleStatus>

393
 Device Network SDK (Access Control on Person) Developer Guide

<!--opt, xs:boolean, whether it supports getting the status of secure door control unit-->
</isSupportModuleStatus>
<isSupportSNAPConfig>
<!--opt, xs:boolean, whether it supports getting capture linkage parameters-->
</isSupportSNAPConfig>
<LocalController><!--opt-->
<isSupportLocalControllerManage>
<!--opt, xs:boolean, whether it supports distributed access controller management-->
</isSupportLocalControllerManage>
<isSupportLocalControllerControl>
<!--opt, xs:boolean, whether it supports distributed access controller control-->
</isSupportLocalControllerControl>
</LocalController>
<isSupportUSBManage>
<!--opt, xs:boolean, whether it supports USB management of access control device-->
</isSupportUSBManage>
<isSupportIdentityTerminal>
<!--opt, xs:boolean, whether it supports face recognition terminal configuration-->
</isSupportIdentityTerminal>
<isSupportDepartmentParam>
<!--opt, xs:boolean, whether it supports setting department parameters-->
</isSupportDepartmentParam>
<isSupportSchedulePlan>
<!--opt, xs:boolean, whether it supports setting shift schedule-->
</isSupportSchedulePlan>
<isSupportAttendanceRule>
<!--opt, xs:boolean, whether it supports setting time and attendance rule-->
</isSupportAttendanceRule>
<isSupportOrdinaryClass>
<!--opt, xs:boolean, whether it supports setting normal shift parameters-->
</isSupportOrdinaryClass>
<isSupportWorkingClass>
<!--opt, xs:boolean, whether it supports setting man-hour shift parameters-->
</isSupportWorkingClass>
<isSupportAttendanceHolidayGroup>
<!--opt, xs:boolean, whether it supports setting holiday group for time and attendance-->
</isSupportAttendanceHolidayGroup>
<isSupportAttendanceHolidayPlan>
<!--opt, xs:boolean, whether it supports setting holiday schedule for time and attendance-->
</isSupportAttendanceHolidayPlan>
<isSupportLadderControlRelay>
<!--opt, xs:boolean, whether it supports setting elevator controller relay-->
</isSupportLadderControlRelay>
<isSupportWiegandRuleCfg>
<!--opt, xs:boolean, whether it supports setting Wiegand rule-->
</isSupportWiegandRuleCfg>
<isSupportM1CardEncryptCfg>
<!--opt, xs:boolean, whether it supports M1 card encryption authentication-->
</isSupportM1CardEncryptCfg>
<isSupportDeployInfo>
<!--opt, xs:boolean, whether it supports getting arming information-->
</isSupportDeployInfo>

394
 Device Network SDK (Access Control on Person) Developer Guide

<isSupportSubmarineBack>
<!--opt, xs:boolean, whether it supports specifying anti-passing back server-->
</isSupportSubmarineBack>
<isSupportSubmarineBackHostInfo>
<!--opt, xs:boolean, whether it supports setting access controllers with anti-passing back enabled-->
</isSupportSubmarineBackHostInfo>
<isSupportStartReaderInfo>
<!--opt, xs:boolean, whether it supports setting first card reader-->
</isSupportStartReaderInfo>
<isSupportSubmarineBackReader>
<!--opt, xs:boolean, whether it supports setting anti-passing back card reader-->
</isSupportSubmarineBackReader>
<isSupportServerDevice>
<!--opt, xs:boolean, whether it supports setting anti-passing back server information-->
</isSupportServerDevice>
<isSupportReaderAcrossHost>
<!--opt, xs:boolean, whether it supports enabling cross-controller anti-passing back function of card reader-->
</isSupportReaderAcrossHost>
<isSupportClearCardRecord>
<!--opt, xs:boolean, whether it supports clearing card swiping records in anti-passing back server-->
</isSupportClearCardRecord>
<isSupportSubmarineBackMode>
<!--opt, xs:boolean, whether it supports setting anti-passing back mode-->
</isSupportSubmarineBackMode>
<isSupportClearSubmarineBack>
<!--opt, xs:boolean, whether it supports clearing cross-controller anti-passing back information-->
</isSupportClearSubmarineBack>
<isSupportRemoteControlDoor>
<!--opt, xs:boolean, whether it supports remote door, elevator, and lock control: "true"-yes, this node is not
returned-no-->
</isSupportRemoteControlDoor>
<isSupportUserInfo><!--opt, xs:boolean, whether it supports person management based on person--></
isSupportUserInfo>
<EmployeeNoInfo><!--dep, employee No. (person ID) information, this node is valid only when the
isSupportUserInfo is "true"-->
<employeeNo min="" max=""><!--opt, employee No. (person ID)--></employeeNo>
<characterType opt="any,number">
<!--opt, employee No. (person) ID type: "any"-any characters (default), "number"-digits (from 0 to 9), only one
value can be returned-->
</characterType>
<isSupportCompress>
<!--opt, xs:boolean, whether it supports compressing employee No. (person) ID for storage: "true"-yes, this node is
not returned-no-->
</isSupportCompress>
</EmployeeNoInfo>
<isSupportCardInfo><!--opt, xs:boolean, whether it supports card management based on person: "true"-yes, this
node is not returned-no--></isSupportCardInfo>
<isSupportUserInfoDetailDelete><!--opt, xs:boolean, whether it supports deleting person information and
permission: "true"-yes, this node is not returned-no--></isSupportUserInfoDetailDelete>
<isSupportAuthCodeInfo>
<!--opt, xs:boolean, whether it supports authentication password management: "true"-yes, this node is not
returned-no-->

395
 Device Network SDK (Access Control on Person) Developer Guide

</isSupportAuthCodeInfo>
<isSupportFingerPrintCfg>
<!--opt, xs:boolean, whether it supports configuring fingerprint parameters: "true"-yes, this node is not returned-
no-->
</isSupportFingerPrintCfg>
<isSupportFingerPrintDelete>
<!--opt, xs:boolean, whether it supports deleting fingerprint: "true"-yes, this node is not returned-no-->
</isSupportFingerPrintDelete>
<isSupportCaptureFingerPrint>
<!--opt, xs:boolean, whether it supports collecting fingerprint information: "true"-yes, this node is not returned-no--
>
</isSupportCaptureFingerPrint>
<isSupportDoorStatusWeekPlanCfg>
<!--opt, xs:boolean, whether it supports configuring door control week schedule: "true"-yes, this node is not
returned-no-->
</isSupportDoorStatusWeekPlanCfg>
<isSupportVerifyWeekPlanCfg>
<!--opt, xs:boolean, whether it supports configuring week schedule of the card reader authentication mode: "true"-
yes, this node is not returned-no-->
</isSupportVerifyWeekPlanCfg>
<isSupportCardRightWeekPlanCfg>
<!--opt, xs:boolean, whether it supports configuring week schedule of the access permission control: "true"-yes, this
node is not returned-no-->
</isSupportCardRightWeekPlanCfg>
<isSupportDoorStatusHolidayPlanCfg>
<!--opt, xs:boolean, whether it supports configuring door control holiday schedule: "true"-yes, this node is not
returned-no-->
</isSupportDoorStatusHolidayPlanCfg>
<isSupportVerifyHolidayPlanCfg>
<!--opt, xs:boolean, whether it supports configuring holiday schedule of the card reader authentication mode:
"true"-yes, this node is not returned-no-->
</isSupportVerifyHolidayPlanCfg>
<isSupportCardRightHolidayPlanCfg>
<!--opt, xs:boolean, whether it supports configuring holiday schedule of the access permission control: "true"-yes,
this node is not returned-no-->
</isSupportCardRightHolidayPlanCfg>
<isSupportDoorStatusHolidayGroupCfg>
<!--opt, xs:boolean, whether it supports configuring holiday group of the door control schedule: "true"-yes, this
node is not returned-no-->
</isSupportDoorStatusHolidayGroupCfg>
<isSupportVerifyHolidayGroupCfg>
<!--opt, xs:boolean, whether it supports configuring holiday group of the control schedule of the card reader
authentication mode: "true"-yes, this node is not returned-no-->
</isSupportVerifyHolidayGroupCfg>
<isSupportUserRightHolidayGroupCfg>
<!--opt, xs:boolean, whether it supports configuring holiday group of the access permission control schedule: "true"-
yes, this node is not returned-no-->
</isSupportUserRightHolidayGroupCfg>
<isSupportDoorStatusPlanTemplate>
<!--opt, xs:boolean, whether it supports configuring door control schedule template: "true"-yes, this node is not
returned-no-->
</isSupportDoorStatusPlanTemplate>

396
 Device Network SDK (Access Control on Person) Developer Guide

<isSupportVerifyPlanTemplate>
<!--opt, xs:boolean, whether it supports configuring schedule template of the card reader authentication mode:
"true"-yes, this node is not returned-no-->
</isSupportVerifyPlanTemplate>
<isSupportUserRightPlanTemplate>
<!--opt, xs:boolean, whether it supports configuring schedule template of the access permission control: "true"-yes,
this node is not returned-no-->
</isSupportUserRightPlanTemplate>
<isSupportDoorStatusPlan>
<!--opt, xs:boolean, whether it supports configuring door control schedule: "true"-yes, this node is not returned-no--
>
</isSupportDoorStatusPlan>
<isSupportCardReaderPlan>
<!--opt, xs:boolean, whether it supports configuring control schedule of the card reader authentication mode:
"true"-yes, this node is not returned-no-->
</isSupportCardReaderPlan>
<isSupportClearPlansCfg>
<!--opt, xs:boolean, whether it supports clearing the access control schedule parameters: "true"-yes, this node is
not returned-no-->
</isSupportClearPlansCfg>
<isSupportRemoteControlBuzzer>
<!--opt, xs:boolean, whether it supports remotely controlling the buzzer of the card reader: "true"-yes, this node is
not returned-no-->
</isSupportRemoteControlBuzzer>
<isSupportEventCardNoList>
<!--opt, xs:boolean, whether it supports getting the list of event and card linkage ID: "true"-yes, this node is not
returned-no-->
</isSupportEventCardNoList>
<isSupportEventCardLinkageCfg>
<!--opt, xs:boolean, whether it supports configuring event and card linkage parameters: "true"-yes, this node is not
returned-no-->
</isSupportEventCardLinkageCfg>
<isSupportClearEventCardLinkageCfg>
<!--opt, xs:boolean, whether it supports clearing event and card linkage parameters: "true"-yes, this node is not
returned-no-->
</isSupportClearEventCardLinkageCfg>
<isSupportAcsEvent>
<!--opt, xs:boolean, whether it supports searching for access control events: "true"-yes, this node is not returned-
no-->
</isSupportAcsEvent>
<isSupportAcsEventTotalNum>
<!--opt, xs:boolean, whether it supports getting total number of access control events by specific conditions: "true"-
yes, this node is not returned-no-->
</isSupportAcsEventTotalNum>
<isSupportDeployInfo>
<!--opt, xs:boolean, whether it supports getting the arming information: "true"-yes, this node is not returned-no-->
</isSupportDeployInfo>
<isSupportEventOptimizationCfg>
<!--opt, xs:boolean, whether it supports configuring event optimization: "true"-yes, this node is not returned-no-->
</isSupportEventOptimizationCfg>
<isSupportAcsWorkStatus>
<!--opt, xs:boolean, whether it supports getting working status of the access control device: "true"-yes, this node is

397
 Device Network SDK (Access Control on Person) Developer Guide

not returned-no-->
</isSupportAcsWorkStatus>
<isSupportDoorCfg>
<!--opt, xs:boolean, whether it supports configuring door parameters: "true"-yes, this node is not returned-no-->
</isSupportDoorCfg>
<isSupportCardReaderCfg>
<!--opt, xs:boolean, whether it supports configuring card reader parameters: "true"-yes, this node is not returned-
no-->
</isSupportCardReaderCfg>
<isSupportAcsCfg>
<!--opt, xs:boolean, whether it supports configuring parameters of access control device: "true"-yes, this node is not
returned-no-->
</isSupportAcsCfg>
<isSupportGroupCfg>
<!--opt, xs:boolean, whether it supports configuring group parameters: "true"-yes, this node is not returned-no-->
</isSupportGroupCfg>
<isSupportClearGroupCfg>
<!--opt, xs:boolean, whether it supports clearing group parameters: "true"-yes, this node is not returned-no-->
</isSupportClearGroupCfg>
<isSupportMultiCardCfg>
<!--opt, xs:boolean, whether it supports configuring multiple authentication mode: "true"-yes, this node is not
returned-no-->
</isSupportMultiCardCfg>
<isSupportMultiDoorInterLockCfg>
<!--opt, xs:boolean, whether it supports configuring multi-door interlocking parameters: "true"-yes, this node is not
returned-no-->
</isSupportMultiDoorInterLockCfg>
<isSupportAntiSneakCfg>
<!--opt, xs:boolean, whether it supports configuring anti-passing back parameters in the device: "true"-yes, this
node is not returned-no-->
</isSupportAntiSneakCfg>
<isSupportCardReaderAntiSneakCfg>
<!--opt, xs:boolean, whether it supports configuring anti-passing back parameters for the card reader in the device:
"true"-yes, this node is not returned-no-->
</isSupportCardReaderAntiSneakCfg>
<isSupportClearAntiSneakCfg>
<!--opt, xs:boolean, whether it supports clearing anti-passing back parameters: "true"-yes, this node is not returned-
no-->
</isSupportClearAntiSneakCfg>
<isSupportClearAntiSneak>
<!--opt, xs:boolean, whether it supports clearing anti-passing back records in the device: "true"-yes, this node is not
returned-no-->
</isSupportClearAntiSneak>
<isSupportSmsRelativeParam>
<!--opt, xs:boolean, whether it supports configuring message function: "true"-yes, this node is not returned-no-->
</isSupportSmsRelativeParam>
<isSupportPhoneDoorRightCfg>
<!--opt, xs:boolean, whether it supports configuring the door permission linked to the mobile phone number:
"true"-yes, this node is not returned-no-->
</isSupportPhoneDoorRightCfg>
<isSupportOSDPStatus>
<!--opt, xs:boolean, whether it supports searching for OSDP card reader status: "true"-yes, this node is not returned-

398
 Device Network SDK (Access Control on Person) Developer Guide

no-->
</isSupportOSDPStatus>
<isSupportOSDPModify>
<!--opt, xs:boolean, whether it supports editing OSDP card reader ID: "true"-yes, this node is not returned-no-->
</isSupportOSDPModify>
<isSupportLogModeCfg>
<!--opt, xs:boolean, whether it supports configuring log mode: "true"-yes, this node is not returned-no-->
</isSupportLogModeCfg>
<FactoryReset>
<isSupportFactoryReset><!--opt, xs: boolean, whether it supports restoring to default settings by condition--></
isSupportFactoryReset>
<mode opt="full,basic,part"><!--opt, xs: string, conditions for restoring to default settings--></mode>
</FactoryReset>
<isSupportNFCCfg><!--opt, xs:boolean，whether it supports enabling or disabling NFC function: "true"-yes, this node
is not returned-no--></isSupportNFCCfg>
<isSupportRFCardCfg><!--opt, xs:boolean，whether it supports enabling or disabling RF card recognition: "true"-yes,
this node is not returned-no--></isSupportRFCardCfg>
<isSupportCaptureFace>
<!--opt, xs:boolean, whether it supports collecting face pictures: "true"-yes, this node is not returned-no-->
</isSupportCaptureFace>
<isSupportCaptureInfraredFace>
<!--opt, xs:boolean, whether it supports collecting infrared face pictures: "true"-yes, this node is not returned-no-->
</isSupportCaptureInfraredFace>
<isSupportFaceRecognizeMode>
<!--opt, xs:boolean, whether it supports configuring facial recognition mode: "true"-yes, this node is not returned-
no-->
</isSupportFaceRecognizeMode>
<isSupportRemoteControlPWChcek>
<!--opt, xs:boolean, whether it supports verifying the password for remote door control: "true"-yes, this node is not
returned-no-->
</isSupportRemoteControlPWChcek>
<isSupportRemoteControlPWCfg>
<!--opt, xs:boolean, whether it supports configuring the password for remote door control: "true"-yes, this node is
not returned-no-->
</isSupportRemoteControlPWCfg>
<isSupportAttendanceStatusModeCfg>
<!--opt, xs:boolean, whether it supports configuring attendance mode: "true"-yes, this node is not returned-no-->
</isSupportAttendanceStatusModeCfg>
<isSupportAttendanceStatusRuleCfg>
<!--opt, xs:boolean, whether it supports configuring attendance status and rule: "true"-yes, this node is not
returned-no-->
</isSupportAttendanceStatusRuleCfg>
<isSupportCaptureCardInfo>
<!--opt, xs:boolean, whether it supports collecting card information: "true"-yes, this node is not returned-no-->
</isSupportCaptureCardInfo>
<isSupportCaptureIDInfo>
<!--opt, xs:boolean, whether it supports collecting ID card information: "true"-yes, this node is not returned-no-->
</isSupportCaptureIDInfo>
<isSupportCaptureRule>
<!--opt, xs:boolean, whether it supports configuring online collection rules: "true"-yes, this node is not returned-no--
>
</isSupportCaptureRule>

399
 Device Network SDK (Access Control on Person) Developer Guide

<isSupportCapturePresetParam>
<!--opt, xs:boolean, whether it supports configuring preset parameters of online collection: "true"-yes, this node is
not returned-no-->
</isSupportCapturePresetParam>
<isSupportOfflineCapture>
<!--opt, xs:boolean, whether it supports offline collection: "true"-yes, this node is not returned-no-->
</isSupportOfflineCapture>
<isSupportCardOperations>
<!--opt, xs:boolean, whether it supports card operation: "true"-yes, this node is not returned-no-->
</isSupportCardOperations>
<isSupportRightControllerAudio>
<!--optional, xs:boolean, whether it supports configuring audio file parameters of the main controller-->
</isSupportRightControllerAudio>
<isSupportChannelControllerCfg>
<!--optional, xs:boolean, whether it supports configuring lane controller-->
</isSupportChannelControllerCfg>
<isSupportGateDialAndInfo>
<!--optional, xs:boolean, whether it supports getting local DIP and information of the turnstile-->
</isSupportGateDialAndInfo>
<isSupportGateStatus>
<!--optional, xs:boolean, whether it supports getting turnstile status-->
</isSupportGateStatus>
<isSupportGateIRStatus>
<!--optional, xs:boolean, whether it supports getting the status of the active infrared intrusion detector of the
turnstile-->
</isSupportGateIRStatus>
<isSupportGateRelatedPartsStatus>
<!--optional, xs:boolean, whether it supports getting related components' status of the turnstile-->
</isSupportGateRelatedPartsStatus>
<isSupportChannelControllerAlarmLinkage>
<!--optional, xs:boolean, whether it supports configuring alarm linkage of the lane controller-->
</isSupportChannelControllerAlarmLinkage>
<isSupportChannelControllerAlarmOut>
<!--optional, xs:boolean, whether it supports configuring alarm output of the lane controller-->
</isSupportChannelControllerAlarmOut>
<isSupportChannelControllerAlarmOutControl>
<!--optional, xs:boolean, whether it supports controlling alarm output of the lane controller-->
</isSupportChannelControllerAlarmOutControl>
<isSupportChannelControllerTypeCfg>
<!--optional, xs:boolean, whether it supports configuring device type of the lane controller-->
</isSupportChannelControllerTypeCfg>
</AccessControl>

6.111 XML_Cap_CaptureFingerPrint
CaptureFingerPrint capability message in XML format
<CaptureFingerPrint version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<CaptureFingerPrintCond><!--req, xs: integer, finger No.-->
<fingerNo min="1" max="10"></fingerNo>

400
 Device Network SDK (Access Control on Person) Developer Guide

</CaptureFingerPrintCond>
<fingerData min="1" max="768"><!--dep, xs:string, fingerprint data--></fingerData>
<fingerNo min="1" max="10"><!--req, xs:integer, finger No.--></fingerNo>
<fingerPrintQuality min="1" max="100"><!--req, xs:integer, fingerprint quality--></fingerPrintQuality>
</CaptureFingerPrint>

6.112 XML_Cap_ClearCardRecord
ClearCardRecord capability message in XML format
<ClearCardRecord version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<clearAllCard opt="true,false">
<!--req, xs: boolean, whether to clear all card swiping records in the cross-controller anti-passing back server-->
</clearAllCard>
<CardList size="32">
<cardNo min="1" max="32"><!--opt, xs: string, card No.--></cardNo>
</CardList>
<EmployeeNoList size="32">
<employeeNo min="" max=""><!--opt, xs:string, employee No. (person ID)--></employeeNo>
</EmployeeNoList>
</ClearCardRecord>

6.113 XML_Cap_ClearSubmarineBack
ClearSubmarineBack capability message in XML format
<ClearSubmarineBack version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<clearHostInfo opt="true,false"><!--opt, xs: boolean, whether to clear access controller information--></
clearHostInfo>
<clearReaderInfo opt="true,false"><!--opt, xs: boolean, whether to clear card reader information--></
clearReaderInfo>
<clearSubmarineBack opt="true,false"><!--opt, xs: boolean, whether to clear anti-passing back server parameters--
></clearSubmarineBack>
<clearSubmarineBackHostInfo opt="true,false">
<!--opt, xs: boolean, whether to clear cross-controller anti-passing back parameters of access controllers-->
</clearSubmarineBackHostInfo>
<clearStartReaderInfo opt="true,false"><!--opt, xs: boolean, whether to clear first card reader parameters--></
clearStartReaderInfo>
<clearSubmarineBackReader opt="true,false">
<!--opt, xs: boolean, whether to clear cross-controller anti-passing back parameters of card readers-->
</clearSubmarineBackReader>
<clearSubmarineBackMode opt="true,false">
<!--opt, xs: boolean, whether to clear the cross-controller anti-passing back mode parameters-->
</clearSubmarineBackMode>
<clearServerDevice opt="true,false"><!--opt, xs: boolean, whether to clear the parameters of cross-controller anti-
passing back server--></clearServerDevice>
<clearReaderAcrossHost opt="true,false">
<!--opt, xs: boolean, whether to clear the cross-controller anti-passing back status of card readers-->

401
 Device Network SDK (Access Control on Person) Developer Guide

</clearReaderAcrossHost>
</ClearSubmarineBack>

6.114 XML_Cap_GetAcsEvent
GetAcsEvent capability message in XML format
<GetAcsEvent version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<EventCond><!--req, event search conditions-->
<majorType></majorType><!--req, event major type, see details in Access Control Event Types-->
<minorType></minorType><!--req, event minor type, see details in Access Control Event Types-->
<startTime></startTime><!--req, start time-->
<endTime></endTime><!--req, end time-->
<localOrUTC></localOrUTC><!--opt, time type: "Local"-device local time (default), "UTC"-UTC time. If this node is
not returned, the startTime and endTime will be used as the local time by default-->
<cardNo min="" max=""></cardNo><!--req, card No.-->
<name min="" max=""></name><!--req, cardholder name-->
<picEnable opt="true,false"></picEnable><!--req, whether contains picture-->
<beginSerialNo min="" max=""></beginSerialNo><!--req, start serial No.-->
<endSerialNo min="" max=""></endSerialNo><!--req, end serial No.-->
<employeeNo min="" max=""></employeeNo><!--opt, employee No. (person ID)-->
</EventCond>
<EventLog>
<majorType>0x1</majorType><!--req, alarm event-->
<MinorTypeList>
<minorType>0x400</minorType><!--req, Zone short circuit attempts alarm-->
<minorType>0x401</minorType><!--req, Zone open circuit attempts alarm-->
<!--See more minor types of alarm event in Access Control Event Types-->
<MinorTypeList>
</EventLog>
<EventLog>
<majorType>0x2</majorType><!--req, exception alarm-->
<MinorTypeList>
<minorType>0x27</minorType><!--req, Network disconnected-->
<minorType>0x3a</minorType><!--req, Connection exception-->
<!--See more minor types of exception event in Access Control Event Types-->
<MinorTypeList>
</EventLog>
<EventLog>
<majorType>0x3</majorType><!--req, operation event-->
<MinorTypeList>
<minorType>0x400</minorType><!--req, Remotely opened door-->
<minorType>0x401</minorType><!--req, remotely closed door-->
<!--See more minor types of operation event in Access Control Event Types-->
<MinorTypeList>
</EventLog>
<EventLog>
<majorType>0x5</majorType><!--req, other event-->
<MinorTypeList>
<minorType>0x01</minorType><!--req, Authenticated by valid card-->

402
 Device Network SDK (Access Control on Person) Developer Guide

<minorType>0x02</minorType><!--req, Authenticated by card and password-->

<!--See more minor types of other event in Access Control Event Types-->
<MinorTypeList>
</EventLog>
</GetAcsEvent>

See Also
Access Control Event Types

6.115 XML_Cap_DeployInfo
DeployInfo capability message in XML format
<DeployInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<DeployList size="5">
<Content>
<deployNo min="" max=""><!--req, xs: integer, arming No.--></deployNo>
<deployType opt="0,1,2"><!--req, xs: integer, arming type: 0-client arming to receive real-time or offline events via
platform or system (based on Hikvision private protocol), 1-real-time arming to receive real-time events (based on
Hikvision private protocol), 2-arm based on ISAPI protocol--></deployType>
<ipAddr min="" max=""><!--req, xs: string, IP address--></ipAddr>
</Content>
</DeployList>
</DeployInfo>

6.116 XML_Cap_FaceCompareCond
XML message about condition configuration capability of face picture comparison
<FaceCompareCond version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<faceWidthLowerLimit min="" max="">
<!--optional, xs:integer, face width threshold with highest priority, value range: [0, 100], when the detected face
width is larger than this threshold, the following conditions will be ignored and the face comparison will be executed--
>
</faceWidthLowerLimit>
<pitch min="" max=""><!--optional, xs:integer, face raising or bowing angle, value range: [0, 90], unit: degree, the
smaller the better--></pitch>
<yaw min="" max=""><!--optional, xs:integer, face siding left or right angle, value range: [0, 90], unit: degree, the
smaller the better--></yaw>
<width min="" max=""><!--optional, xs:integer, face width, value range: [0, 100]--></width>
<height min="" max=""><!--optional, xs:integer, face height, value range: [0, 100]--></height>
<leftBorder min="" max=""><!--optional, xs:integer, left border of face, value range: [0, 100]--></leftBorder>
<rightBorder min="" max=""><!--optional, xs:integer, right border of face, value range: [0, 100]--></rightBorder>
<upBorder min="" max=""><!--optional, xs:integer, top border of face, value range: [0, 100]--></upBorder>
<bottomBorder min="" max=""><!--optional, xs:integer, bottom border of face, value range: [0, 100]--></
bottomBorder>
<interorbitalDistance min="" max=""><!--optional, xs:integer, pupil distance, value range: [0, 100]--></
interorbitalDistance>

403
 Device Network SDK (Access Control on Person) Developer Guide

<faceScore min="" max=""><!--optional, xs:integer, face score, value range: [0, 100], the valid face score must be
larger than this score--></faceScore>
</FaceCompareCond>

6.117 XML_Cap_IdentityTerminal
IdentityTerminal capability message in XML format
<IdentityTerminal version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<terminalMode opt="authMode,registerMode">
<!--req, xs: string, terminal mode: "authMode"-authentication mode, "registerMode"-registration mode-->
</terminalMode>
<idCardReader opt="iDR210,DS-K1F110-I,DS-K1F1110-B，DS-K1F1110-AB, none">
<!--req, xs: string,ID card reader model-->
</idCardReader>
<camera opt="C270,DS-2CS5432B-S"><!--req, xs: string, camera--></camera>
<fingerPrintModule opt="ALIWARD,HikModule"><!--req, xs: string, fingerprint module--></fingerPrintModule>
<videoStorageTime min="0" max="10"><!--req, xs: integer, time for saving video (unit: second)--></
videoStorageTime>
<faceContrastThreshold min="0" max="100"><!--req, xs: integer, face picture comparison threshold--></
faceContrastThreshold>
<twoDimensionCode opt="enable,disable"><!--req, xs: string, whether to enable QR code recognition--></
twoDimensionCod>
<blackListCheck opt="enable,disable"><!--req, xs: string, whether to enable blacklist verification--></blackListCheck>
<idCardCheckCenter opt="local,server">
<!--req, xs: string, ID card comparison mode: local-compare with ID card of local storage, server-compare with ID
card of remote server storage-->
</idCardCheckCenter>
<faceAlgorithm opt="HIK-Z,HIK-H">
<!--req, xs: string, face picture algorithm: HIK-Z-Hikviison algorithm, HIK-H-third-party algorithm-->
</faceAlgorithm>
<comNo min="1" max="9"><!--req, xs: integer, COM No.--></comNo>
<memoryLearning opt="enable,disable"><!--req, xs: string, whether to enable learning and memory function--></
memoryLearning>
<saveCertifiedImage opt="enable,disable"><!--req, xs: string, whether to enable saving authenticated picture--></
saveCertifiedImage>
<MCUVersion min="" max=""><!--opt, xs: string, MCU version information--></MCUVersion>
<usbOutput opt="enable,disable"><!--req, xs: string, whether to enable USB output of ID card reader--></
usbOutput>
<serialOutput opt="enable,disable"><!--req, xs: string, whether to enable serial port output of ID card reader--></
serialOutput>
<readInfoOfCard opt="serialNo,file"><!--opt, xs: string, set content to be read from CPU card--></readInfoOfCard>
<workMode opt="passMode,accessControlMode"><!--opt, xs: string, authentication mode--></workMode>
<ecoMode>
<eco opt="enable,disable"><!--opt, xs: string, whether to enable ECO mode--></eco>
<faceMatchThreshold1 min="" max=""><!--req, xs: integer, 1V1 face picture comparison threshold of ECO mode,
which is between 0 and 100--></faceMatchThreshold1>
<faceMatchThresholdN min="" max=""><!--req, xs: integer, 1:N face picture comparison threshold of ECO mode,
which is between 0 and 100--></faceMatchThresholdN>
<changeThreshold min="" max=""><!--opt, xs: string, switching threshold of ECO mode, which is between 0 and 8--

404
 Device Network SDK (Access Control on Person) Developer Guide

></changeThreshold>
</ecoMode>
<readCardRule opt="wiegand26,wiegand34"><!--opt, xs: string, card No. setting rule: "wiegand26", "wiegand34"--></
readCardRule>
</IdentityTerminal>

6.118 XML_Cap_ReaderAcrossHost
ReaderAcrossHost capability message in XML format
<ReaderAcrossHost version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<AcrossHostList size="8">
<AcrossHostAction>
<readerNo min="1" max="8"><!--req, xs: integer, card reader No.--></readerNo>
<submarineBackEnabled opt="true,false">
<!--req, xs: boolean, whether to enable the cross-controller anti-passing back function of the card reader-->
</submarineBackEnabled>
</AcrossHostAction>
</AcrossHostList>
</ReaderAcrossHost>

6.119 XML_Cap_ServerDevice
ServerDevice capability message in XML format
<ServerDevice version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipAddr min="" max=""><!--req, xs: string, IP address of the cross-controller anti-passing back server--></ipAddr>
<port min="" max=""><!--req, xs: string, port No. of the cross-controller anti-passing back server--></port>
</ServerDevice>

6.120 XML_Cap_StartReaderInfo
StartReaderInfo capability message in XML format
<StartReaderInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<hostNo min="1" max="64"><!--req, xs: integer, access controller No.--></hostNo>
<readerNo min="1" max="8"><!--req, xs: integer, card reader No.--></readerNo>
</StartReaderInfo>

6.121 XML_Cap_SubmarineBack
SubmarineBack capability message in XML format
<SubmarineBack version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled opt="true,false"><!--req, xs: boolean, whether to specify this access controller as the cross-controller anti-

405
 Device Network SDK (Access Control on Person) Developer Guide

passing back server--></enabled>

</SubmarineBack>

6.122 XML_Cap_SubmarineBackHostInfo
SubmarineBackHostInfo capability message in XML format
<SubmarineBackHostInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ID min="1" max="4"><!--req, xs: integer, configuration No.--></ID>
<HostInfoList size="16">
<Action>
<deviceNo min="1" max="64"><!--req, xs: integer, device No.--></deviceNo>
<serial min="9" max="9"><!--req, xs: string, device serial No.--></serial>
</Action>
</HostInfoList>
</SubmarineBackHostInfo>

6.123 XML_Cap_SubmarineBackMode
SubmarineBackMode capability message in XML format
<SubmarineBackMode version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<mode opt="disable,internetCommunicate,cardReadAndWrite"><!--req, xs:string, anti-passing back mode--></mode>
<rule opt="line,inOrOut">
<!--req, xs:string, anti-passing back rule, this node is invalid when the mode is set to "disable"-->
</rule>
<sectionID min="1" max="100">
<!--req, xs:integer, section ID, this node is valid when mode is "cardReadAndWrite", and only one section ID can be
configured for one configuration-->
</sectionID>
</SubmarineBackMode>

6.124 XML_Cap_SubmarineBackReader
SubmarineBackReader capability message in XML format
<SubmarineBackReader version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ID min="1" max="128"><!--req, xs:integer, configuration No.--></ID>
<selfHostNo min="1" max="64"><!--req, xs:integer, access control No. of the configuration object--></selfHostNo>
<selfReaderNo min="1" max="8"><!--req, xs:integer, card reader No. of the configuration object--></selfReaderNo>
<FollowReaderList size="16">
<Action>
<followHostNo min="1" max="64"><!--req, xs:integer, following access controller No.--></followHostNo>
<followReaderNo min="1" max="8"><!--req, xs:integer, following card reader No.--></followReaderNo>
</Action>

406
 Device Network SDK (Access Control on Person) Developer Guide

</FollowReaderList>
</SubmarineBackReader>

6.125 XML_ClearCardRecord
ClearCardRecord message in XML format
<ClearCardRecord version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<clearAllCard>
<!--req, xs: boolean, whether to clear all card swiping records in the cross-controller anti-passing back server: "true"-
yes, "false"-no. If this node is set to "false", either CardList or EmployeeNoList is required. If CardList is configured, it
indicates clearing card swiping records by card No.; if EmployeeNoList is configured, it indicates clearing card swiping
records by employee No.-->
</clearAllCard>
<CardList size="32">
<cardNo><!--opt, xs: string, card No., min="1" max="32"--></cardNo>
</CardList>
<EmployeeNoList size="32">
<employeeNo><!--opt, xs:string, employee No. (person ID)--></employeeNo>
</EmployeeNoList>
</ClearCardRecord>

6.126 XML_ClearSubmarineBack
ClearSubmarineBack message in XML format
<ClearSubmarineBack version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<clearHostInfo><!--opt, xs: boolean, whether to clear access controller information: "true,false"--></clearHostInfo>
<clearReaderInfo><!--opt, xs: boolean, whether to clear card reader information: "true,false"--></clearReaderInfo>
<clearSubmarineBack><!--opt, xs: boolean, whether to clear anti-passing back server parameters: "true,false"--></
clearSubmarineBack>
<clearSubmarineBackHostInfo>
<!--opt, xs: boolean, whether to clear cross-controller anti-passing back parameters of access controllers:
"true,false"-->
</clearSubmarineBackHostInfo>
<clearStartReaderInfo><!--opt, xs: boolean, whether to clear first card reader parameters: "true,false"--></
clearStartReaderInfo>
<clearSubmarineBackReader>
<!--opt, xs: boolean, whether to clear cross-controller anti-passing back parameters of card readers: "true,false"-->
</clearSubmarineBackReader>
<clearSubmarineBackMode>
<!--opt, xs: boolean, whether to clear the cross-controller anti-passing back mode parameters: "true,false"-->
</clearSubmarineBackMode>
<clearServerDevice>
<!--opt, xs: boolean, whether to clear the parameters of cross-controller anti-passing back server: "true,false"-->
</clearServerDevice>
<clearReaderAcrossHost>
<!--opt, xs: boolean, whether to clear the cross-controller anti-passing back status of card readers: "true,false"-->

407
 Device Network SDK (Access Control on Person) Developer Guide

</clearReaderAcrossHost>
</ClearSubmarineBack>

6.127 XML_DeployInfo
DeployInfo message in XML format
<DeployInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<DeployList size="5">
<Content>
<deployNo><!--req, xs: integer, arming No.--></deployNo>
<deployType><!--req, xs: integer, arming type: 0-client arming to receive real-time or offline events via platform or
system (based on Hikvision private protocol), 1-real-time arming to receive real-time events (based on Hikvision
private protocol), 2-arm based on ISAPI protocol, opt="0,1,2"--></deployType>
<ipAddr><!--req, xs: string, IP address--></ipAddr>
</Content>
</DeployList>
</DeployInfo>

6.128 XML_Desc_AcsAbility
Input description message for getting access control capability.
<AcsAbility version="2.0">
<!--opt, specify child nodes about access control capabilities to be returned-->
</AcsAbility>
.

6.129 XML_FaceCompareCond
XML message about condition parameters of face picture comparison
<FaceCompareCond version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<faceWidthLowerLimit>
<!--optional, xs:integer, face width threshold with highest priority, value range: [0, 100], when the detected face
width is larger than this threshold, the following conditions will be ignored and the face comparison will be executed--
>
</faceWidthLowerLimit>
<pitch>
<!--optional, xs:integer, face raising or bowing angle, value range: [0, 90], unit: degree, the smaller the better-->
</pitch>
<yaw><!--optional, xs:integer, face siding left or right angle, value range: [0, 90], unit: degree, the smaller the better--
></yaw>
<width><!--optional, xs:integer, face width, value range: [0, 100]--></width>
<height><!--optional, xs:integer, face height, value range: [0, 100]--></height>
<leftBorder><!--optional, xs:integer, left border of face, value range: [0, 100]--></leftBorder>

408
 Device Network SDK (Access Control on Person) Developer Guide

<rightBorder><!--optional, xs:integer, right border of face, value range: [0, 100]--></rightBorder>

<upBorder><!--optional, xs:integer, top border of face, value range: [0, 100]--></upBorder>
<bottomBorder><!--optional, xs:integer, bottom border of face, value range: [0, 100]--></bottomBorder>
<interorbitalDistance><!--optional, xs:integer, pupil distance, value range: [0, 100]--></interorbitalDistance>
<faceScore><!--optional, xs:integer, face score, value range: [0, 100], the valid face score must be larger than this
score--></faceScore>
</FaceCompareCond>

6.130 XML_IdentityTerminal
IdentityTerminal message in XML format
<IdentityTerminal version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<terminalMode>
<!--req, xs: string, terminal mode: "authMode"-authentication mode, "registerMode"-registration mode-->
</terminalMode>
<idCardReader>
<!--req, xs: string, ID card reader model: iDR210, DS-K1F110-I, DS-K1F1110-B, DS-K1F1110-AB, none, DS-K1F1001-
I(USB), DS-K1F1002-I(USB), none-->
</idCardReader>
<camera><!--req, xs: string, camera model: C270, DS-2CS5432B-S--></camera>
<fingerPrintModule><!--req, xs: string, fingerprint module type: ALIWARD, HikModule--></fingerPrintModule>
<videoStorageTime><!--req, xs: integer, time for saving video (unit: second), which is between 0 and 10--></
videoStorageTime>
<faceContrastThreshold><!--req, xs: integer, face picture comparison threshold, which is between 0 and 100--></
faceContrastThreshold>
<twoDimensionCode><!--req, xs: string, whether to enable QR code recognition: enable, disable--></
twoDimensionCod>
<blackListCheck><!--req, xs: string, whether to enable blacklist verification: enable, disable--></blackListCheck>
<idCardCheckCenter>
<!--req, xs: string, ID card comparison mode: local-compare with ID card of local storage, server-compare with ID
card of remote server storage-->
</idCardCheckCenter>
<faceAlgorithm>
<!--req, xs: string, face picture algorithm: HIK-Z-Hikviison algorithm, HIK-H-third-party algorithm-->
</faceAlgorithm>
<comNo><!--req, xs: integer, COM No., which is between 1 and 9--></comNo>
<memoryLearning><!--req, xs: string, whether to enable learning and memory function: enable, disable--></
memoryLearning>
<saveCertifiedImage><!--req, xs: string, whether to enable saving authenticated picture: enable, disable--></
saveCertifiedImage>
<MCUVersion><!--opt, xs: string, MCU version information, read-only--></MCUVersion>
<usbOutput><!--opt, xs: string, whether to enable USB output of ID card reader: enable, disable--></usbOutput>
<serialOutput><!--opt, xs: string, whether to enable serial port output of ID card reader: enable, disable--></
serialOutput>
<readInfoOfCard><!--opt, xs: string, set content to be read from CPU card: serialNo-read serial No., file-read file--></
readInfoOfCard>
<workMode><!--opt, xs: string, authentication mode: passMode, accessControlMode--></workMode>
<ecoMode>
<eco><!--opt, xs: string, whether to enable ECO mode: enable, disable--></eco>

409
 Device Network SDK (Access Control on Person) Developer Guide

<faceMatchThreshold1><!--req, xs: integer, 1V1 face picture comparison threshold of ECO mode, which is between
0 and 100--></faceMatchThreshold1>
<faceMatchThresholdN><!--req, xs: integer, 1:N face picture comparison threshold of ECO mode, which is between
0 and 100--></faceMatchThresholdN>
<changeThreshold><!--opt, xs: string, switching threshold of ECO mode, which is between 0 and 8--></
changeThreshold>
</ecoMode>
<readCardRule><!--opt, xs: string, card No. setting rule: "wiegand26", "wiegand34"--></readCardRule>
</IdentityTerminal>

6.131 XML_ReaderAcrossHost
ReaderAcrossHost message in XML format
<ReaderAcrossHost version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<AcrossHostList size="8">
<AcrossHostAction>
<readerNo><!--req, xs: integer, card reader No., which is between 1 and 8--></readerNo>
<submarineBackEnabled>
<!--req, xs: boolean, whether to enable the cross-controller anti-passing back function of the card reader-->
</submarineBackEnabled>
</AcrossHostAction>
</AcrossHostList>
</ReaderAcrossHost>

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

410
 Device Network SDK (Access Control on Person) Developer Guide

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

6.133 XML_ServerDevice
ServerDevice message in XML format
<ServerDevice version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipAddr><!--req, xs: string, IP address of the cross-controller anti-passing back server--></ipAddr>
<port><!--req, xs: string, port No. of the cross-controller anti-passing back server--></port>
</ServerDevice>

6.134 XML_StartReaderInfo
StartReaderInfo message in XML format
<StartReaderInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<hostNo><!--req, xs: integer, access controller No., min="1" max="64"--></hostNo>
<readerNo><!--req, xs: integer, card reader No., min="1" max="8"--></readerNo>
</StartReaderInfo>

6.135 XML_SubmarineBack
SubmarineBack message in XML format
<SubmarineBack version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--req, xs: boolean, whether to specify this access controller as the cross-controller anti-passing back
server--></enabled>
</SubmarineBack>

6.136 XML_SubmarineBackHostInfo
SubmarineBackHostInfo message in XML format
<SubmarineBackHostInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<HostInfoList size="16">
<Action>
<deviceNo><!--req, xs: integer, device No., which is between 1 and 64--></deviceNo>
<serial><!--req, xs: string, device serial No., min="9" max="9"--></serial>
</Action>
</HostInfoList>
</SubmarineBackHostInfo>

411
 Device Network SDK (Access Control on Person) Developer Guide

6.137 XML_SubmarineBackMode
SubmarineBackMode message in XML format
<SubmarineBackMode version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<mode>
<!--req, xs:string, anti-passing back mode: "disable"-anti-passing back is disabled, "internetCommunicate"-based on
network, "cardReadAndWrite"-based on card-->
</mode>
<rule>
<!--req, xs:string, anti-passing back rule: "line"-route anti-passing back, "inOrOut"-entrance/exit anti-passing back.
This node is invalid when the mode is set to "disable"-->
</rule>
<sectionID>
<!--req, xs:integer, section ID, which is between 1 and 100. This node is valid when mode is "cardReadAndWrite",
and only one section ID can be configured for one configuration-->
</sectionID>
</SubmarineBackMode>

6.138 XML_SubmarineBackReader
SubmarineBackReader message in XML format
<SubmarineBackReader version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<selfHostNo><!--req, xs:integer, access controller No. of the configuration object, which is between 1 and 64--></
selfHostNo>
<selfReaderNo><!--req, xs:integer, card reader No. of the configuration object, which is between 1 and 8--></
selfReaderNo>
<FollowReaderList size="16">
<Action>
<followHostNo><!--req, xs:integer, following access controller No., which is between 1 and 64--></followHostNo>
<followReaderNo><!--req, xs:integer, following card reader No., which is between 1 and 8--></followReaderNo>
</Action>
</FollowReaderList>
</SubmarineBackReader>

6.139 XML_SubscribeEvent
SubscribeEvent message in XML format
<SubscribeEvent version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema" >
<heartbeat>
<!--optional, xs:integer, heartbeat interval, unit: second, the default value is 30s-->
</heartbeat>
<eventMode>
<!--required, xs:string, "all"-upload all alarms/events, "list"-upload specified alarm/event-->
</eventMode>

412
 Device Network SDK (Access Control on Person) Developer Guide

<EventList>
<Event><!--uploading mode of specified alarm/event, this node exists only when eventMode is "list"-->
<type>
<!--required, xs:string, alarm/event types, which are obtained from the capability, refer to Alarm/Event Types for
Subscription for its values-->
</type>
<minorAlarm>
<!--opt, xs:string, minor alarm type: "0x400,0x401,0x402,0x403", see details in Access Control Event Type. This
node is required when type is "AccessControllerEvent"-->
</minorAlarm>
<minorException>
<!--opt, xs:string, minor exception type: "0x400,0x401,0x402,0x403", see details in Access Control Event Type.
This node is required when type is "AccessControllerEvent"-->
</minorException>
<minorOperation>
<!--opt, xs:string, minor operation type: "0x400,0x401,0x402,0x403", see details in Access Control Event Type.
This node is required when type is "AccessControllerEvent"-->
</minorOperation>
<minorEvent>
<!--opt, xs:string, minor event type: "0x01,0x02,0x03,0x04", see details in Access Control Event Type. This node is
required when type is "AccessControllerEvent"-->
</minorEvent>
<pictureURLType>
<!--opt, xs:string, alarm picture format: "binary"-binary, "localURL"-device local URL, "cloudStorageURL"-cloud
storage URL-->
</pictureURLType>
</Event>
</EventList>
<channels>
<!--optional, xs:string, event linked channel information, and multiple channels can be linked, each channel is
separated by comma, e.g., "1,2,3,4…"-->
</channels>
<channels>
<!--optional, xs:string, specify channels (each channel is separated by comma, e.g., "1,2,3,4…") to be armed, this
node does not exist if you want to arm all channels, and if this node exists, the sub node <channels> in the node
<Event> is invalid-->
</channels>
<identityKey max="64"/>
<!--opt, xs: string, interaction command of subscription, supports subscribing comparison results of face picture
library (importing with this command), the maximum length is 64-->
</SubscribeEvent>

413
 Device Network SDK (Access Control on Person) Developer Guide

Appendix A. Appendixes

A.1 Access Control Event Types

The access control events are classified as four major types, i.e., alarm events
(MAJOR_ALARM-0x1), exception events (MAJOR_EXCEPTION-0x2), operation events
(MAJOR_OPERATION-0x3), and other events (MAJOR_EVENT-0x5). Each major type corresponds to
multiple minor types, see details below.

MAJOR_ALARM

Event Minor Type Value Description

MINOR_ALARMIN_SHORT_ 0x400 Zone Short Circuit Attempts
CIRCUIT Alarm
MINOR_ALARMIN_BROKEN_ 0x401 Zone Disconnected Alarm
CIRCUIT
MINOR_ALARMIN_EXCEPTION 0x402 Zone Exception Alarm
MINOR_ALARMIN_RESUME 0x403 Zone Restored
MINOR_HOST_DESMANTLE_ 0x404 Zone Tampering Alarm
ALARM
MINOR_HOST_DESMANTLE_ 0x405 Zone Tampering Restored
RESUME
MINOR_CARD_READER_ 0x406 Card Reader Tampering Alarm
DESMANTLE_ALARM
MINOR_CARD_READER_ 0x407 Card Reader Tampering
DESMANTLE_RESUME Restored
MINOR_CASE_SENSOR_ALARM 0x408 Alarm Input Alarm Triggered
MINOR_CASE_SENSOR_ 0x409 Alarm Input Restored
RESUME
MINOR_STRESS_ALARM 0x40a Duress Alarm
MINOR_OFFLINE_ECENT_ 0x40b No Memory for Offline Event
NEARLY_FULL Storage Alarm
MINOR_CARD_MAX_ 0x40c Maximum Failed Card
AUTHENTICATE_FAIL Authentications Alarm
MINOR_SD_CARD_FULL 0x40d SD Card Full Alarm

414
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Type Value Description

MINOR_LINKAGE_CAPTURE_ 0x40e Capture Linkage Alarm
PIC
MINOR_SECURITY_MODULE_ 0x40f Secure Door Control Unit
DESMANTLE_ALARM Tampering Alarm
MINOR_SECURITY_MODULE_ 0x410 Secure Door Control Unit
DESMANTLE_RESUME Tampering Restored
MINOR_FIRE_IMPORT_SHORT_ 0x415 Fire Input Short Circuit
CIRCUIT Attempts Alarm
MINOR_FIRE_IMPORT_ 0x416 Fire Input Open Circuit
BROKEN_CIRCUIT Attempts Alarm
MINOR_FIRE_IMPORT_ 0x417 Fire Input Restored
RESUME
MINOR_FIRE_BUTTON_ 0x418 Fire Button Triggered
TRIGGER
MINOR_FIRE_BUTTON_ 0x419 Fire Button Resumed
RESUME
MINOR_MAINTENANCE_ 0x41a Maintenance Button Triggered
BUTTON_TRIGGER
MINOR_MAINTENANCE_ 0x41b Maintenance Button Resumed
BUTTON_RESUME
MINOR_EMERGENCY_ 0x41c Panic Button Triggered
BUTTON_TRIGGER
MINOR_EMERGENCY_ 0x41d Panic Button Resumed
BUTTON_RESUME
MINOR_DISTRACT_ 0x41e Distributed Elevator Controller
CONTROLLER_ALARM Tampering Alarm
MINOR_DISTRACT_ 0x41f Distributed Elevator Controller
CONTROLLER_RESUME Tampering Restored
MINOR_CHANNEL_ 0x422 Lane Controller Tampering
CONTROLLER_DESMANTLE_ Alarm
ALARM
MINOR_CHANNEL_ 0x423 Lane Controller Tampering
CONTROLLER_DESMANTLE_ Alarm Restored
RESUME

415
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Type Value Description

MINOR_CHANNEL_ 0x424 Lane Controller Fire Input
CONTROLLER_FIRE_IMPORT_ Alarm
ALARM
MINOR_CHANNEL_ 0x425 Lane Controller Fire Input
CONTROLLER_FIRE_IMPORT_ Alarm Restored
RESUME
MINOR_PRINTER_OUT_OF_ 0x440 No Paper in Printer Alarm
PAPER
MINOR_LEGAL_EVENT_ 0x442 No Memory Alarm for Valid
NEARLY_FULL Offline Event Storage
MINOR_ALARM_CUSTOM1 to 0x900 to 0x93f Access Control: Custom Alarm
MINOR_ALARM_CUSTOM64 Event 1 to Custom Alarm Event
64

MAJOR_EXCEPTION

Event Minor Type Value Description

MINOR_NET_BROKEN 0x27 Network Disconnected
MINOR_RS485_DEVICE_ 0x3a RS485 Connection Exception
ABNORMAL
MINOR_RS485_DEVICE_ 0x3b RS485 Connection Restored
REVERT
MINOR_DEV_POWER_ON 0x400 Power on
MINOR_DEV_POWER_OFF 0x401 Power off
MINOR_WATCH_DOG_RESET 0x402 Watchdog Reset
MINOR_LOW_BATTERY 0x403 Low Battery Voltage
MINOR_BATTERY_RESUME 0x404 Battery Voltage Restored
MINOR_AC_OFF 0x405 AC Power Disconnected
MINOR_AC_RESUME 0x406 AC Power Restored
MINOR_NET_RESUME 0x407 Network Restored
MINOR_FLASH_ABNORMAL 0x408 Flash Reading and Writing
Exception
MINOR_CARD_READER_ 0x409 Card Reader Offline
OFFLINE

416
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Type Value Description

MINOR_CAED_READER_ 0x40a Card Reader Online
RESUME
MINOR_INDICATOR_LIGHT_ 0x40b Indicator Turns off
OFF
MINOR_INDICATOR_LIGHT_ 0x40c Indicator Resumed
RESUME
MINOR_CHANNEL_ 0x40d Lane Controller Offline
CONTROLLER_OFF
MINOR_CHANNEL_ 0x40e Lane Controller Online
CONTROLLER_RESUME
MINOR_SECURITY_MODULE_ 0x40f Secure Door Control Unit
OFF Offline
MINOR_SECURITY_MODULE_ 0x410 Secure Door Control Unit
RESUME Online
MINOR_BATTERY_ELECTRIC_ 0x411 Low Battery Voltage (Only for
LOW Face Recognition Terminal)
MINOR_BATTERY_ELECTRIC_ 0x412 Battery Voltage Recovered
RESUME (Only for Face Recognition
Terminal)
MINOR_LOCAL_CONTROL_ 0x413 Network of Distributed Access
NET_BROKEN Controller Disconnected
MINOR_LOCAL_CONTROL_ 0x414 Network of Distributed Access
NET_RSUME Controller Restored
MINOR_MASTER_RS485_ 0x415 RS485 Loop of Master Access
LOOPNODE_BROKEN Controller Disconnected
MINOR_MASTER_RS485_ 0x416 RS485 Loop of Master Access
LOOPNODE_RESUME Controller Connected
MINOR_LOCAL_CONTROL_ 0x417 Distributed Access Controller
OFFLINE Offline
MINOR_LOCAL_CONTROL_ 0x418 Distributed Access Controller
RESUME Online
MINOR_LOCAL_DOWNSIDE_ 0x419 Downstream RS485 Loop of
RS485_LOOPNODE_BROKEN Distributed Access Control
Disconnected

417
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Type Value Description

MINOR_LOCAL_DOWNSIDE_ 0x41a Downstream RS485 Loop of
RS485_LOOPNODE_RESUME Distributed Access Control
Connected
MINOR_DISTRACT_ 0x41b Distributed Elevator Controller
CONTROLLER_ONLINE Online
MINOR_DISTRACT_ 0x41c Distributed Elevator Controller
CONTROLLER_OFFLINE Offline
MINOR_ID_CARD_READER_ 0x41d ID Card Reader Disconnected
NOT_CONNECT
MINOR_ID_CARD_READER_ 0x41e ID Card Reader Connected
RESUME
MINOR_FINGER_PRINT_ 0x41f Fingerprint Module
MODULE_NOT_CONNECT Disconnected
MINOR_FINGER_PRINT_ 0x420 Fingerprint Module Connected
MODULE_RESUME
MINOR_CAMERA_NOT_ 0x421 Camera Disconnected
CONNECT
MINOR_CAMERA_RESUME 0x422 Camera Connected
MINOR_COM_NOT_CONNECT 0x423 COM Port Disconnected
MINOR_COM_RESUME 0x424 COM Port Connected
MINOR_DEVICE_NOT_ 0x425 Device Unauthorized
AUTHORIZE
MINOR_PEOPLE_AND_ID_ 0x426 Face Recognition Terminal
CARD_DEVICE_ONLINE Online
MINOR_PEOPLE_AND_ID_ 0x427 Face Recognition Terminal
CARD_DEVICE_OFFLINE Offline
MINOR_LOCAL_LOGIN_LOCK 0x428 Local Login Lock
MINOR_LOCAL_LOGIN_ 0x429 Local Login Unlock
UNLOCK
MINOR_SUBMARINEBACK_ 0x42a Communication with Anti-
COMM_BREAK passing Back Server Failed
MINOR_SUBMARINEBACK_ 0x42b Communication with Anti-
COMM_RESUME passing Back Server Restored

418
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Type Value Description

MINOR_MOTOR_SENSOR_ 0x42c Motor or Sensor Exception
EXCEPTION
MINOR_CAN_BUS_EXCEPTION 0x42d CAN Bus Exception
MINOR_CAN_BUS_RESUME 0x42e CAN Bus Exception Restored
MINOR_GATE_TEMPERATURE_ 0x42f Too High Pedestal Temperature
OVERRUN
MINOR_IR_EMITTER_ 0x430 Active Infrared Intrusion
EXCEPTION Detector Exception
MINOR_IR_EMITTER_RESUME 0x431 Active Infrared Intrusion
Detector Restored
MINOR_LAMP_BOARD_ 0x432 Communication with Light
COMM_EXCEPTION Board Failed
MINOR_LAMP_BOARD_ 0x433 Communication with Light
COMM_RESUME Board Restored
MINOR_IR_ADAPTOR_COMM_ 0x434 Communication with IR
EXCEPTION Adaptor Failed
MINOR_IR_ADAPTOR_COMM_ 0x435 Communication with IR
RESUME Adaptor Restored
MINOR_PRINTER_ONLINE 0x436 Printer Online
MINOR_PRINTER_OFFLINE 0x437 Printer Offline
MINOR_4G_MOUDLE_ONLINE 0x438 4G Module Online
MINOR_4G_MOUDLE_OFFLINE 0x439 4G Module Offline
MINOR_EXCEPTION_CUSTOM1 0x900 to 0x93f Access Control: Custom
to MINOR_EXCEPTION_ Exception Event 1 to Custom
CUSTOM64 Exception Event 64

MAJOR_OPERATION

Alarm Minor Types Value Description

MINOR_LOCAL_LOGIN 0x50 Local Login
MINOR_LOCAL_LOGOUT 0x51 Local Logout
MINOR_LOCAL_UPGRADE 0x5a Local Upgrade
MINOR_REMOTE_LOGIN 0x70 Remote Login

419
 Device Network SDK (Access Control on Person) Developer Guide

Alarm Minor Types Value Description

MINOR_REMOTE_LOGOUT 0x71 Remote Logout
MINOR_REMOTE_ARM 0x79 Remote Arming
MINOR_REMOTE_DISARM 0x7a Remote Disarming
MINOR_REMOTE_REBOOT 0x7b Remote Reboot
MINOR_REMOTE_UPGRADE 0x7e Remote Upgrade
MINOR_REMOTE_CFGFILE_ 0x86 Remote Operation: Export
OUTPUT Configuration File
MINOR_REMOTE_CFGFILE_ 0x87 Remote Operation: Import
INTPUT Configuration File
MINOR_REMOTE_ALARMOUT_ 0xd6 Remote Operation: Enable
OPEN_MAN Alarm Output Manually
MINOR_REMOTE_ALARMOUT_ 0xd7 Remote Operation: Disable
CLOSE_MAN Alarm Output Manually
MINOR_REMOTE_OPEN_DOOR 0x400 Door Remotely Open
MINOR_REMOTE_CLOSE_ 0x401 Door Remotely Closed
DOOR
MINOR_REMOTE_ALWAYS_ 0x402 Remain Open Remotely
OPEN
MINOR_REMOTE_ALWAYS_ 0x403 Remain Closed Remotely
CLOSE
MINOR_REMOTE_CHECK_TIME 0x404 Remote: Manual Time Sync
MINOR_NTP_CHECK_TIME 0x405 Network Time Protocol
Synchronization
MINOR_REMOTE_CLEAR_CARD 0x406 Remote Operation: Clear All
Card No.
MINOR_REMOTE_RESTORE_ 0x407 Remote Operation: Restore
CFG Defaults
MINOR_ALARMIN_ARM 0x408 Zone Arming
MINOR_ALARMIN_DISARM 0x409 Zone Disarming
MINOR_LOCAL_RESTORE_CFG 0x40a Local Operation: Restore
Defaults

420
 Device Network SDK (Access Control on Person) Developer Guide

Alarm Minor Types Value Description

MINOR_REMOTE_CAPTURE_ 0x40b Remote Operation: Capture
PIC
MINOR_MOD_NET_REPORT_ 0x40c Edit Network Parameters
CFG
MINOR_MOD_GPRS_REPORT_ 0x40d Edit GPRS Parameters
PARAM
MINOR_MOD_REPORT_ 0x40e Edit Control Center Parameters
GROUP_PARAM
MINOR_UNLOCK_PASSWORD_ 0x40f Enter Dismiss Code
OPEN_DOOR
MINOR_AUTO_RENUMBER 0x410 Auto Renumber
MINOR_AUTO_COMPLEMENT_ 0x411 Auto Supplement Number
NUMBER
MINOR_NORMAL_CFGFILE_ 0x412 Import Configuration File
INPUT
MINOR_NORMAL_CFGFILE_ 0x413 Export Configuration File
OUTTPUT
MINOR_CARD_RIGHT_INPUT 0x414 Import Card Permission
Parameters
MINOR_CARD_RIGHT_ 0x415 Export Card Permission
OUTTPUT Parameters
MINOR_LOCAL_USB_UPGRADE 0x416 Upgrade Device via USB flash
Drive
MINOR_REMOTE_VISITOR_ 0x417 Visitor Calling Elevator
CALL_LADDER
MINOR_REMOTE_ 0x418 Resident Calling Elevator
HOUSEHOLD_CALL_LADDER
MINOR_REMOTE_ACTUAL_ 0x419 Remotely Arming
GUARD
MINOR_REMOTE_ACTUAL_ 0x41a Remotely Disarming
UNGUARD
MINOR_REMOTE_CONTROL_ 0x41b Operation Failed: Keyfob Not
NOT_CODE_OPER_FAILED Pairing

421
 Device Network SDK (Access Control on Person) Developer Guide

Alarm Minor Types Value Description

MINOR_REMOTE_CONTROL_ 0x41c Keyfob Operation: Close Door
CLOSE_DOOR
MINOR_REMOTE_CONTROL_ 0x41d Keyfob Operation: Open Door
OPEN_DOOR
MINOR_REMOTE_CONTROL_ 0x41e Keyfob Operation: Remain
ALWAYS_OPEN_DOOR Door Open
MINOR_M1_CARD_ENCRYPT_ 0x41f M1 Card Encryption
VERIFY_OPEN Verification Enabled
MINOR_M1_CARD_ENCRYPT_ 0x420 M1 Card Encryption
VERIFY_CLOSE Verification Disabled
MINOR_NFC_FUNCTION_OPEN 0X421 Opening Door with NFC Card
Enabled
MINOR_NFC_FUNCTION_ 0X422 Opening Door with NFC Card
CLOSE Disabled
MINOR_OPERATION_CUSTOM1 0x900-0x93f Access Control: Custom
to MINOR_OPERATION_ Operation Event 1 to Custom
CUSTOM64 Operation Event 64

MAJOR_EVENT

Event Minor Types Value Description

MINOR_LEGAL_CARD_PASS 0x01 Valid Card Authentication
Completed
MINOR_CARD_AND_PSW_PASS 0x02 Card and Password
Authentication Completed
MINOR_CARD_AND_PSW_FAIL 0x03 Card and Password
Authentication Failed
MINOR_CARD_AND_PSW_ 0x04 Card and Password
TIMEOUT Authentication Timed Out
MINOR_CARD_AND_PSW_ 0x05 Card and Password
OVER_TIME Authentication Timed Out
MINOR_CARD_NO_RIGHT 0x06 No Permission
MINOR_CARD_INVALID_ 0x07 Invalid Card Swiping Time
PERIOD Period
MINOR_CARD_OUT_OF_DATE 0x08 Expired Card

422
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Types Value Description

MINOR_INVALID_CARD 0x09 Card No. Not Exist
MINOR_ANTI_SNEAK_FAIL 0x0a Anti-​passing Back
Authentication Failed
MINOR_INTERLOCK_DOOR_ 0x0b Interlocking Door Not Closed
NOT_CLOSE
MINOR_NOT_BELONG_MULTI_ 0x0c Card Not in Multiple
GROUP Authentication Group
MINOR_INVALID_MULTI_ 0x0d Card Not in Multiple
VERIFY_PERIOD Authentication Duration
MINOR_MULTI_VERIFY_ 0x0e Multiple Authentications:
SUPER_RIGHT_FAIL Super Password Authentication
Failed
MINOR_MULTI_VERIFY_ 0x0f Multiple Authentication
REMOTE_RIGHT_FAIL Completed
MINOR_MULTI_VERIFY_ 0x10 Multiple Authenticated
SUCCESS
MINOR_LEADER_CARD_OPEN_ 0x11 Open Door with First Card
BEGIN Started
MINOR_LEADER_CARD_OPEN_ 0x12 Open Door with First Card
END Stopped
MINOR_ALWAYS_OPEN_BEGIN 0x13 Remain Open Started
MINOR_ALWAYS_OPEN_END 0x14 Remain Open Stopped
MINOR_LOCK_OPEN 0x15 Door Unlocked
MINOR_LOCK_CLOSE 0x16 Door Locked
MINOR_DOOR_BUTTON_PRESS 0x17 Exit Button Pressed
MINOR_DOOR_BUTTON_ 0x18 Exit Button Released
RELEASE
MINOR_DOOR_OPEN_ 0x19 Door Open (Contact)
NORMAL
MINOR_DOOR_CLOSE_ 0x1a Door Closed (Contact)
NORMAL
MINOR_DOOR_OPEN_ 0x1b Door Abnormally Open
ABNORMAL (Contact)

423
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Types Value Description

MINOR_DOOR_OPEN_ 0x1c Door Open Timed Out
TIMEOUT (Contact)
MINOR_ALARMOUT_ON 0x1d Alarm Output Enabled
MINOR_ALARMOUT_OFF 0x1e Alarm Output Disabled
MINOR_ALWAYS_CLOSE_BEGIN 0x1f Remain Closed Started
MINOR_ALWAYS_CLOSE_END 0x20 Remain Closed Stopped
MINOR_MULTI_VERIFY_NEED_ 0x21 Multiple Authentications:
REMOTE_OPEN Remotely Open Door
MINOR_MULTI_VERIFY_ 0x22 Multiple Authentications:
SUPERPASSWD_VERIFY_ Super Password Authentication
SUCCESS Completed
MINOR_MULTI_VERIFY_ 0x23 Multiple Authentications:
REPEAT_VERIFY Repeated Authentication
MINOR_MULTI_VERIFY_ 0x24 Multiple Authentications Timed
TIMEOUT Out
MINOR_DOORBELL_RINGING 0x25 Doorbell Ring
MINOR_FINGERPRINT_ 0x26 Fingerprint Matched
COMPARE_PASS
MINOR_FINGERPRINT_ 0x27 Fingerprint Mismatched
COMPARE_FAIL
MINOR_CARD_FINGERPRINT_ 0x28 Card and Fingerprint
VERIFY_PASS Authentication Completed
MINOR_CARD_FINGERPRINT_ 0x29 Card and Fingerprint
VERIFY_FAIL Authentication Failed
MINOR_CARD_FINGERPRINT_ 0x2a Card and Fingerprint
VERIFY_TIMEOUT Authentication Timed Out
MINOR_CARD_FINGERPRINT_ 0x2b Card and Fingerprint and
PASSWD_VERIFY_PASS Password Authentication
Completed
MINOR_CARD_FINGERPRINT_ 0x2c Card and Fingerprint and
PASSWD_VERIFY_FAIL Password Authentication Failed

424
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Types Value Description

MINOR_CARD_FINGERPRINT_ 0x2d Card and Fingerprint and
PASSWD_VERIFY_TIMEOUT Password Authentication
Timed Out
MINOR_FINGERPRINT_ 0x2e Fingerprint and Password
PASSWD_VERIFY_PASS Authentication Completed
MINOR_FINGERPRINT_ 0x2f Fingerprint and Password
PASSWD_VERIFY_FAIL Authentication Failed
MINOR_FINGERPRINT_ 0x30 Fingerprint and Password
PASSWD_VERIFY_TIMEOUT Authentication Timed Out
MINOR_FINGERPRINT_ 0x31 Fingerprint Not Exists
INEXISTENCE
MINOR_CARD_PLATFORM_ 0x32 Card Platform Authentication
VERIFY
MINOR_CALL_CENTER 0x33 Call Center
MINOR_FIRE_RELAY_TURN_ 0x34 Fire Relay Closed: Door
ON_DOOR_ALWAYS_OPEN Remains Open
MINOR_FIRE_RELAY_ 0x35 Fire Relay Opened: Door
RECOVER_DOOR_RECOVER_ Remains Closed
NORMAL
MINOR_EMPLOYEENO_AND_ 0x45 Employee ID and Fingerprint
FP_VERIFY_PASS Authentication Completed
MINOR_EMPLOYEENO_AND_ 0x46 Employee ID and Fingerprint
FP_VERIFY_FAIL Authentication Failed
MINOR_EMPLOYEENO_AND_ 0x47 Employee ID and Fingerprint
FP_VERIFY_TIMEOUT Authentication Timed Out
MINOR_EMPLOYEENO_AND_ 0x48 Employee ID and Fingerprint
FP_AND_PW_VERIFY_PASS and Password Authentication
Completed
MINOR_EMPLOYEENO_AND_ 0x49 Employee ID and Fingerprint
FP_AND_PW_VERIFY_FAIL and Password Authentication
Failed
MINOR_EMPLOYEENO_AND_ 0x4a Employee ID and Fingerprint
FP_AND_PW_VERIFY_ and Password Authentication
TIMEOUT Timed Out

425
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Types Value Description

MINOR_FACE_VERIFY_PASS 0x4b Face Authentication Completed
MINOR_FACE_VERIFY_FAIL 0x4c Face Authentication Failed
MINOR_EMPLOYEENO_AND_ 0x4d Employee ID and Face
FACE_VERIFY_PASS Authentication Completed
MINOR_EMPLOYEENO_AND_ 0x4e Employee ID and Face
FACE_VERIFY_FAIL Authentication Failed
MINOR_EMPLOYEENO_AND_ 0x4f Employee ID and Face
FACE_VERIFY_TIMEOUT Authentication Timed Out
MINOR_FACE_RECOGNIZE_FAIL 0x50 Face Recognition Failed
MINOR_FIRSTCARD_ 0x51 First Card Authorization Started
AUTHORIZE_BEGIN
MINOR_FIRSTCARD_ 0x52 First Card Authorization Ended
AUTHORIZE_END
MINOR_DOORLOCK_INPUT_ 0x53 Lock Input Short Circuit
SHORT_CIRCUIT Attempts Alarm
MINOR_DOORLOCK_INPUT_ 0x54 Lock Input Open Circuit
BROKEN_CIRCUIT Attempts Alarm
MINOR_DOORLOCK_INPUT_ 0x55 Lock Input Exception Alarm
EXCEPTION
MINOR_DOORCONTACT_ 0x56 Contact Input Short Circuit
INPUT_SHORT_CIRCUIT Attempts Alarm
MINOR_DOORCONTACT_ 0x57 Contact Input Open Circuit
INPUT_BROKEN_CIRCUIT Attempts Alarm
MINOR_DOORCONTACT_ 0x58 Contact Input Exception Alarm
INPUT_EXCEPTION
MINOR_OPENBUTTON_INPUT_ 0x59 Exit Button Input Short Circuit
SHORT_CIRCUIT Attempts Alarm
MINOR_OPENBUTTON_INPUT_ 0x5a Exit Button Input Open Circuit
BROKEN_CIRCUIT Attempts Alarm
MINOR_OPENBUTTON_INPUT_ 0x5b Exit Button Input Exception
EXCEPTION Alarm
MINOR_DOORLOCK_OPEN_ 0x5c Unlocking Exception
EXCEPTION

426
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Types Value Description

MINOR_DOORLOCK_OPEN_ 0x5d Unlocking Timed Out
TIMEOUT
MINOR_FIRSTCARD_OPEN_ 0x5e Unauthorized First Card
WITHOUT_AUTHORIZE Opening Failed
MINOR_CALL_LADDER_RELAY_ 0x5f Call Elevator Relay Open
BREAK
MINOR_CALL_LADDER_RELAY_ 0x60 Call Elevator Relay Closed
CLOSE
MINOR_AUTO_KEY_RELAY_ 0x61 Auto Button Relay Open
BREAK
MINOR_AUTO_KEY_RELAY_ 0x62 Auto Button Relay Closed
CLOSE
MINOR_KEY_CONTROL_RELAY_ 0x63 Button Relay Open
BREAK
MINOR_KEY_CONTROL_RELAY_ 0x64 Button Relay Closed
CLOSE
MINOR_EMPLOYEENO_AND_ 0x65 Employee ID and Password
PW_PASS Authentication Completed
MINOR_EMPLOYEENO_AND_ 0x66 Employee ID and Password
PW_FAIL Authentication Failed
MINOR_EMPLOYEENO_AND_ 0x67 Employee ID and Password
PW_TIMEOUT Authentication Timed Out
MINOR_CERTIFICATE_BLACK_ 0x71 Blacklist Event
LIST
MINOR_LEGAL_MESSAGE 0x72 Valid Message
MINOR_ILLEGAL_MESSAGE 0x73 Invalid Message
MINOR_DOOR_OPEN_OR_ 0x75 Authentication Failed: Door
DORMANT_FAIL Remain Closed or Door in
Sleeping Mode
MINOR_AUTH_PLAN_ 0x76 Authentication Failed:
DORMANT_FAIL Authentication Schedule in
Sleeping Mode
MINOR_CARD_ENCRYPT_ 0x77 Card Encryption Verification
VERIFY_FAIL Failed

427
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Types Value Description

MINOR_SUBMARINEBACK_ 0x78 Anti-​passing Back Server
REPLY_FAIL Response Failed
MINOR_DOOR_OPEN_OR_ 0x82 Open Door via Exit Button
DORMANT_OPEN_FAIL Failed When Door Remain
Closed or in Sleeping Mode
MINOR_DOOR_OPEN_OR_ 0x84 Door Linkage Open Failed
DORMANT_LINKAGE_OPEN_ During Door Remain Close or
FAIL Sleeping
MINOR_TRAILING 0x85 Tailgating
MINOR_REVERSE_ACCESS 0x86 Reverse Passing
MINOR_FORCE_ACCESS 0x87 Force Accessing
MINOR_CLIMBING_OVER_ 0x88 Climb Over
GATE
MINOR_PASSING_TIMEOUT 0x89 Passing Timed Out
MINOR_INTRUSION_ALARM 0x8a Intrusion Alarm
MINOR_FREE_GATE_PASS_ 0x8b Authentication Failed When
NOT_AUTH Free Passing
MINOR_DROP_ARM_BLOCK 0x8c Barrier Obstructed
MINOR_DROP_ARM_BLOCK_ 0x8d Barrier Restored
RESUME
MINOR_PASSWORD_ 0x97 Passwords Mismatched
MISMATCH
MINOR_EMPLOYEE_NO_NOT_ 0x98 Employee ID Not Exists
EXIST
MINOR_COMBINED_VERIFY_ 0x99 Combined Authentication
PASS Completed
MINOR_COMBINED_VERIFY_ 0x9a Combined Authentication
TIMEOUT Timed Out
MINOR_VERIFY_MODE_ 0x9b Authentication Type
MISMATCH Mismatched
MINOR_INFORMAL_MIFARE_ 0xa2 Authentication Failed: Invalid
CARD_VERIFY_FAIL Mifare Card

428
 Device Network SDK (Access Control on Person) Developer Guide

Event Minor Types Value Description

MINOR_CPU_CARD_ENCRYPT_ 0xa3 Verifying CPU Card Encryption
VERIFY_FAIL Failed
MINOR_NFC_DISABLE_VERIFY_ 0xa4 Disabling NFC Verification
FAIL Failed
MINOR_EM_CARD_ 0xa8 EM Card Recognition Disabled
RECOGNIZE_NOT_ENABLED
MINOR_M1_CARD_ 0xa9 M1 Card Recognition Disabled
RECOGNIZE_NOT_ENABLED
MINOR_CPU_CARD_ 0xaa CPU Card Recognition Disabled
RECOGNIZE_NOT_ENABLED
MINOR_ID_CARD_RECOGNIZE_ 0xab ID Card Recognition Disabled
NOT_ENABLED
MINOR_CARD_SET_SECRET_ 0xac Importing Key to Card Failed
KEY_FAIL
MINOR_LOCAL_UPGRADE_FAIL 0xad Local Upgrade Failed
MINOR_REMOTE_UPGRADE_ 0xae Remote Upgrade Failed
FAIL
MINOR_REMOTE_EXTEND_ 0xaf Extension Module is Remotely
MODULE_UPGRADE_SUCC Upgraded
MINOR_REMOTE_EXTEND_ 0xb0 Upgrading Extension Module
MODULE_UPGRADE_FAIL Remotely Failed
MINOR_REMOTE_FINGER_ 0xb1 Fingerprint Module is Remotely
PRINT_MODULE_UPGRADE_ Upgraded
SUCC
MINOR_REMOTE_FINGER_ 0xb2 Upgrading Fingerprint Module
PRINT_MODULE_UPGRADE_ Remotely Failed
FAIL
MINOR_EVENT_CUSTOM1 to 0x500 to 0x53f Access Control: Custom Event 1
MINOR_EVENT_CUSTOM64 to Custom Event 64

A.2 Event Linkage Types

For event card linkages, if the linkage type is event, four major event linkage types are available: 0-
device event linkage, 1-alarm input event linkage, 2-access control point (e.g., doors, elevators,

429
 Device Network SDK (Access Control on Person) Developer Guide

etc.) event linkage, and 3-authentication unit (e.g., card reader, fingerprint module, etc.) event
linkage. Each major event linkage type corresponds multiple minor types of event linkage, see
details in the following content.

Device Event Linkage

Minor Type Value Description

EVENT_ACS_HOST_ANTI_ 0 Access Controller Tampering Alarm
DISMANTLE
EVENT_ACS_OFFLINE_ECENT_ 1 No Memory Alarm
NEARLY_FULL
EVENT_ACS_NET_BROKEN 2 Network Disconnected
EVENT_ACS_NET_RESUME 3 Network Connected
EVENT_ACS_LOW_BATTERY 4 Low Battery Voltage
EVENT_ACS_BATTERY_RESUME 5 Battery Fully Charged
EVENT_ACS_AC_OFF 6 AC Power Off
EVENT_ACS_AC_RESUME 7 AC Power On
EVENT_ACS_SD_CARD_FULL 8 SD Card Full Alarm
EVENT_ACS_LINKAGE_ 9 Capture Linkage Event Alarm
CAPTURE_PIC
EVENT_ACS_IMAGE_QUALITY_ 10 Low Face Picture Quality
LOW
EVENT_ACS_FINGER_PRINT_ 11 Low Fingerprint Picture Quality
QUALITY_LOW
EVENT_ACS_BATTERY_ 12 Low Battery Voltage
ELECTRIC_LOW
EVENT_ACS_BATTERY_ 13 Battery Fully Charged
ELECTRIC_RESUME
EVENT_ACS_FIRE_IMPORT_ 14 Fire Input Short Circuit Attempts Alarm
SHORT_CIRCUIT
EVENT_ACS_FIRE_IMPORT_ 15 Fire Input Open Circuit Attempts Alarm
BROKEN_CIRCUIT
EVENT_ACS_FIRE_IMPORT_ 16 Fire Input Alarm Restored
RESUME

430
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_MASTER_RS485_ 17 RS485 Loop of Master Access Controller
LOOPNODE_BROKEN Disconnected
EVENT_ACS_MASTER_RS485_ 18 RS485 Loop of Master Access Controller
LOOPNODE_RESUME Connected
EVENT_ACS_LOCAL_CONTROL_ 19 Distributed Access Controller Offline
OFFLINE
EVENT_ACS_LOCAL_CONTROL_ 20 Distributed Access Controller Online
RESUME
EVENT_ACS_LOCAL_ 21 Downstream RS485 Loop of Distributed Access
DOWNSIDE_RS485_ Control Disconnected
LOOPNODE_BROKEN
EVENT_ACS_LOCAL_ 22 Downstream RS485 Loop of Distributed Access
DOWNSIDE_RS485_ Control Connected
LOOPNODE_RESUME
EVENT_ACS_DISTRACT_ 23 Distributed Elevator Controller Online
CONTROLLER_ONLINE
EVENT_ACS_DISTRACT_ 24 Distributed Elevator Controller Offline
CONTROLLER_OFFLINE
EVENT_ACS_FIRE_BUTTON_ 25 Fire Button Pressed
TRIGGER
EVENT_ACS_FIRE_BUTTON_ 26 Fire Button Released
RESUME
EVENT_ACS_MAINTENANCE_ 27 Maintenance Button Pressed
BUTTON_TRIGGER
EVENT_ACS_MAINTENANCE_ 28 Maintenance Button Released
BUTTON_RESUME
EVENT_ACS_EMERGENCY_ 29 Panic Button Pressed
BUTTON_TRIGGER
EVENT_ACS_EMERGENCY_ 30 Panic Button Released
BUTTON_RESUME
EVENT_ACS_ 32 Communication with Anti-​passing Back Server
SUBMARINEBACK_COMM_ Failed
BREAK

431
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_ 33 Communication with Anti-​passing Back Server
SUBMARINEBACK_COMM_ Restored
RESUME
EVENT_ACS_REMOTE_ 34 Remotely Armed
ACTUAL_GUARD
EVENT_ACS_REMOTE_ 35 Remotely Disarmed
ACTUAL_UNGUARD
EVENT_ACS_MOTOR_SENSOR_ 36 Motor or Sensor Exception
EXCEPTION
EVENT_ACS_CAN_BUS_ 37 CAN Bus Exception
EXCEPTION
EVENT_ACS_CAN_BUS_ 38 CAN Bus Restored
RESUME
EVENT_ACS_GATE_ 39 Too High Pedestal Temperature
TEMPERATURE_OVERRUN
EVENT_ACS_IR_EMITTER_ 40 Active Infrared Intrusion Detector Exception
EXCEPTION
EVENT_ACS_IR_EMITTER_ 41 Active Infrared Intrusion Detector Restored
RESUME
EVENT_ACS_LAMP_BOARD_ 42 Communication with Light Board Failed
COMM_EXCEPTION
EVENT_ACS_LAMP_BOARD_ 43 Communication with Light Board Restored
COMM_RESUME
EVENT_ACS_IR_ADAPTOR_ 44 Communication with IR Adaptor Failed
BOARD_COMM_EXCEPTION
EVENT_ACS_IR_ADAPTOR_ 45 Communication with IR Adaptor Restored
BOARD_COMM_RESUME
EVENT_ACS_CHANNEL_ 46 Lane Controller Tampering Alarm
CONTROLLER_DESMANTLE_
ALARM
EVENT_ACS_CHANNEL_ 47 Lane Controller Tampering Alarm Restored
CONTROLLER_DESMANTLE_
RESUME

432
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_CHANNEL_ 48 Lane Controller Fire Input Alarm
CONTROLLER_FIRE_IMPORT_
ALARM
EVENT_ACS_CHANNEL_ 49 Lane Controller Fire Input Alarm Restored
CONTROLLER_FIRE_IMPORT_
RESUME
EVENT_ACS_STAY_EVENT / Staying Event
EVENT_ACS_LEGAL_EVENT_ / No Memory Alarm for Valid Offline Event Storage
NEARLY_FULL

Alarm Input Event Linkage

Minor Type Value Description

EVENT_ACS_ALARMIN_ 0 Zone Short Circuit Attempts
SHORT_CIRCUIT Alarm
EVENT_ACS_ALARMIN_ 1 Zone Open Circuit Attempts
BROKEN_CIRCUIT Alarm
EVENT_ACS_ALARMIN_ 2 Zone Exception Alarm
EXCEPTION
EVENT_ACS_ALARMIN_ 3 Zone Alarm Restored
RESUME
EVENT_ACS_CASE_SENSOR_ 4 Alarm Input Alarm
ALARM
EVENT_ACS_CASE_SENSOR_ 5 Alarm Input Alarm Restored
RESUME

Access Control Point Event Linkage

Minor Type Value Description

EVENT_ACS_LEADER_CARD_ 0 Open Door with First Card
OPEN_BEGIN Started
EVENT_ACS_LEADER_CARD_ 1 Open Door with First Card
OPEN_END Ended
EVENT_ACS_ALWAYS_OPEN_ 2 Remain Open Started
BEGIN

433
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_ALWAYS_OPEN_ 3 Remain Open Ended
END
EVENT_ACS_ALWAYS_CLOSE_ 4 Remain Closed Started
BEGIN
EVENT_ACS_ALWAYS_CLOSE_ 5 Remain Closed Ended
END
EVENT_ACS_LOCK_OPEN 6 Door Unlocked
EVENT_ACS_LOCK_CLOSE 7 Door Locked
EVENT_ACS_DOOR_BUTTON_ 8 Exit Button Pressed
PRESS
EVENT_ACS_DOOR_BUTTON_ 9 Exit Button Released
RELEASE
EVENT_ACS_DOOR_OPEN_ 10 Door Open (Contact)
NORMAL
EVENT_ACS_DOOR_CLOSE_ 11 Door Closed (Contact)
NORMAL
EVENT_ACS_DOOR_OPEN_ 12 Door Abnormally Open
ABNORMAL (Contact)
EVENT_ACS_DOOR_OPEN_ 13 Door Open Timed Out
TIMEOUT (Contact)
EVENT_ACS_REMOTE_OPEN_ 14 Door Remotely Open
DOOR
EVENT_ACS_REMOTE_CLOSE_ 15 Door Remotely Closed
DOOR
EVENT_ACS_REMOTE_ 16 Remain Open Remotely
ALWAYS_OPEN
EVENT_ACS_REMOTE_ 17 Remain Closed Remotely
ALWAYS_CLOSE
EVENT_ACS_NOT_BELONG_ 18 Card Not in Multiple
MULTI_GROUP Authentication Group
EVENT_ACS_INVALID_MULTI_ 19 Card Not in Multiple
VERIFY_PERIOD Authentication Duration

434
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_MULTI_VERIFY_ 20 Multiple Authentication Mode:
SUPER_RIGHT_FAIL Super Password Authentication
Failed
EVENT_ACS_MULTI_VERIFY_ 21 Multiple Authentication Mode:
REMOTE_RIGHT_FAIL Remote Authentication Failed
EVENT_ACS_MULTI_VERIFY_ 22 Multiple Authentication
SUCCESS Completed
EVENT_ACS_MULTI_VERIFY_ 23 Multiple Authentication:
NEED_REMOTE_OPEN Remotely Open Door
EVENT_ACS_MULTI_VERIFY_ 24 Multiple Authentication: Super
SUPERPASSWD_VERIFY_ Password Authentication
SUCCESS Completed
EVENT_ACS_MULTI_VERIFY_ 25 Multiple Authentication:
REPEAT_VERIFY_FAIL Repeated Authentication Failed
EVENT_ACS_MULTI_VERIFY_ 26 Multiple Authentication Timed
TIMEOUT Out
EVENT_ACS_REMOTE_ 27 Remote Capture
CAPTURE_PIC
EVENT_ACS_DOORBELL_ 28 Doorbell Ring
RINGING
EVENT_ACS_SECURITY_ 29 Secure Door Control Unit
MODULE_DESMANTLE_ALARM Tampering Alarm
EVENT_ACS_CALL_CENTER 30 Center Event
EVENT_ACS_FIRSTCARD_ 31 First Card Authentication
AUTHORIZE_BEGIN Started
EVENT_ACS_FIRSTCARD_ 32 First Card Authentication End
AUTHORIZE_END
EVENT_ACS_DOORLOCK_ 33 Lock Input Short Circuit
INPUT_SHORT_CIRCUIT Attempts Alarm
EVENT_ACS_DOORLOCK_ 34 Lock Input Open Circuit
INPUT_BROKEN_CIRCUIT Attempts Alarm
EVENT_ACS_DOORLOCK_ 35 Lock Input Exception Alarm
INPUT_EXCEPTION

435
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_DOORCONTACT_ 36 Contact Input Short Circuit
INPUT_SHORT_CIRCUIT Attempts Alarm
EVENT_ACS_DOORCONTACT_ 37 Contact Input Open Circuit
INPUT_BROKEN_CIRCUIT Attempts Alarm
EVENT_ACS_DOORCONTACT_ 38 Contact Input Exception Alarm
INPUT_EXCEPTION
EVENT_ACS_OPENBUTTON_ 39 Exit Button Input Short Circuit
INPUT_SHORT_CIRCUIT Attempts Alarm
EVENT_ACS_OPENBUTTON_ 40 Exit Button Input Open Circuit
INPUT_BROKEN_CIRCUIT Attempts Alarm
EVENT_ACS_OPENBUTTON_ 41 Exit Button Input Exception
INPUT_EXCEPTION Alarm
EVENT_ACS_DOORLOCK_ 42 Unlocking Exception
OPEN_EXCEPTION
EVENT_ACS_DOORLOCK_ 43 Unlocking Timed Out
OPEN_TIMEOUT
EVENT_ACS_FIRSTCARD_ 44 Unauthorized First Card
OPEN_WITHOUT_AUTHORIZE Opening Failed
EVENT_ACS_CALL_LADDER_ 45 Call Elevator Relay Open
RELAY_BREAK
EVENT_ACS_CALL_LADDER_ 46 Call Elevator Relay Closed
RELAY_CLOSE
EVENT_ACS_AUTO_KEY_ 47 Auto Button Relay Open
RELAY_BREAK
EVENT_ACS_AUTO_KEY_ 48 Auto Button Relay Closed
RELAY_CLOSE
EVENT_ACS_KEY_CONTROL_ 49 Button Relay Open
RELAY_BREAK
EVENT_ACS_KEY_CONTROL_ 50 Button Relay Closed
RELAY_CLOSE
EVENT_ACS_REMOTE_ 51 Visitor Calling Elevator
VISITOR_CALL_LADDER
EVENT_ACS_REMOTE_ 52 Resident Calling Elevator
HOUSEHOLD_CALL_LADDER

436
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_LEGAL_MESSAGE 52 Valid Message
EVENT_ACS_ILLEGAL_ 53 Invalid Message
MESSAGE
EVENT_ACS_TRAILING 54 Tailgating
EVENT_ACS_REVERSE_ACCESS 55 Reverse Passing
EVENT_ACS_FORCE_ACCESS 56 Force Collision
EVENT_ACS_CLIMBING_OVER_ 57 Climbing Over
GATE
EVENT_ACS_PASSING_ 58 Passing Timed Out
TIMEOUT
EVENT_ACS_INTRUSION_ 59 Intrusion Alarm
ALARM
EVENT_ACS_FREE_GATE_PASS_ 60 Authentication Failed When
NOT_AUTH Free Passing
EVENT_ACS_DROP_ARM_ 61 Barrier Obstructed
BLOCK
EVENT_ACS_DROP_ARM_ 62 Barrier Restored
BLOCK_RESUME
EVENT_ACS_REMOTE_ 63 Door Closed via Keyfob
CONTROL_CLOSE_DOOR
EVENT_ACS_REMOTE_ 64 Door Opened via Keyfob
CONTROL_OPEN_DOOR
EVENT_ACS_REMOTE_ 65 Remain Open via Keyfob
CONTROL_ALWAYS_OPEN_
DOOR

Authentication Unit Event Linkage

Minor Type Value Description

EVENT_ACS_STRESS_ALARM 0 Duress Alarm
EVENT_ACS_CARD_READER_ 1 Card Reader Tampering Alarm
DESMANTLE_ALARM
EVENT_ACS_LEGAL_CARD_ 2 Valid Card Authentication
PASS Completed

437
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_CARD_AND_PSW_ 3 Card and Password
PASS Authentication Completed
EVENT_ACS_CARD_AND_PSW_ 4 Card and Password
FAIL Authentication Failed
EVENT_ACS_CARD_AND_PSW_ 5 Card and Password
TIMEOUT Authentication Timed Out
EVENT_ACS_CARD_MAX_ 6 Card Authentication Attempts
AUTHENTICATE_FAIL Reach Limit
EVENT_ACS_CARD_NO_RIGHT 7 No Permission for Card
EVENT_ACS_CARD_INVALID_ 8 Invalid Card Swiping Time
PERIOD Period
EVENT_ACS_CARD_OUT_OF_ 9 Expired Card
DATE
EVENT_ACS_INVALID_CARD 10 Card No. Not Exist
EVENT_ACS_ANTI_SNEAK_FAIL 11 Anti-​passing Back
Authentication Failed
EEVENT_ACS_INTERLOCK_ 12 Interlocking Door Not Closed
DOOR_NOT_CLOSE
EVENT_ACS_FINGERPRINT_ 13 Fingerprint Matched
COMPARE_PASS
EVENT_ACS_FINGERPRINT_ 14 Fingerprint Mismatched
COMPARE_FAIL
EVENT_ACS_CARD_ 15 Card and Fingerprint
FINGERPRINT_VERIFY_PASS Authentication Completed
EVENT_ACS_CARD_ 16 Card and Fingerprint
FINGERPRINT_VERIFY_FAIL Authentication Failed
EVENT_ACS_CARD_ 17 Card and Fingerprint
FINGERPRINT_VERIFY_ Authentication Timed Out
TIMEOUT
EVENT_ACS_CARD_ 18 Card, Fingerprint, and
FINGERPRINT_PASSWD_ Password Authentication
VERIFY_PASS Completed

438
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_CARD_ 19 Card and Fingerprint
FINGERPRINT_PASSWD_ Authentication Failed
VERIFY_FAIL
EVENT_ACS_CARD_ 20 Card and Fingerprint
FINGERPRINT_PASSWD_ Authentication Timed Out
VERIFY_TIMEOUT
EVENT_ACS_FINGERPRINT_ 21 Fingerprint and Password
PASSWD_VERIFY_PASS Authentication Completed
EVENT_ACS_FINGERPRINT_ 22 Fingerprint and Password
PASSWD_VERIFY_FAIL Authentication Failed
EVENT_ACS_FINGERPRINT_ 23 Fingerprint and Password
PASSWD_VERIFY_TIMEOUT Authentication Timed Out
EVENT_ACS_FINGERPRINT_ 24 Fingerprint Not Exist
INEXISTENCE
EVENT_ACS_EMPLOYEENO_ 42 Employee ID and Fingerprint
AND_FP_VERIFY_PASS Authentication Completed
EVENT_ACS_EMPLOYEENO_ 43 Employee ID and Fingerprint
AND_FP_VERIFY_FAIL Authentication Failed
EVENT_ACS_EMPLOYEENO_ 44 Employee ID and Fingerprint
AND_FP_VERIFY_TIMEOUT Authentication Timed Out
EVENT_ACS_EMPLOYEENO_ 45 Employee ID, Fingerprint, and
AND_FP_AND_PW_VERIFY_ Password Authentication
PASS Completed
EVENT_ACS_EMPLOYEENO_ 46 Employee ID, Fingerprint, and
AND_FP_AND_PW_VERIFY_ Password Authentication Failed
FAIL
EVENT_ACS_EMPLOYEENO_ 47 Employee ID, Fingerprint, and
AND_FP_AND_PW_VERIFY_ Password Authentication
TIMEOUT Timed Out
EVENT_ACS_EMPLOYEENO_ 52 Employee ID and Password
AND_PW_PASS Authentication Completed
EVENT_ACS_EMPLOYEENO_ 52 Employee ID and Password
AND_PW_FAIL Authentication Failed
EVENT_ACS_EMPLOYEENO_ 53 Employee ID and Password
AND_PW_TIMEOUT Authentication Timed Out

439
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_DOOR_OPEN_OR_ 57 Authentication Failed When
DORMANT_FAIL Door Remain Closed or Door in
Sleeping Mode
EVENT_ACS_AUTH_PLAN_ 58 Authentication Failed When
DORMANT_FAIL Authentication Schedule in
Sleeping Mode
EVENT_ACS_CARD_ENCRYPT_ 59 Card Encryption Verification
VERIFY_FAIL Failed
EVENT_ACS_ 60 Anti-​passing Back Server
SUBMARINEBACK_REPLY_FAIL Response Failed
EVENT_ACS_PASSWORD_ 61 Password Mismatched
MISMATCH
EVENT_ACS_EMPLOYEE_NO_ 62 Employee ID Not Exist
NOT_EXIST
EVENT_ACS_COMBINED_ 63 Combined Authentication
VERIFY_PASS Completed
EVENT_ACS_COMBINED_ 64 Combined Authentication
VERIFY_TIMEOUT Timed Out
EVENT_ACS_VERIFY_MODE_ 65 Authentication Type
MISMATCH Mismatched
EVENT_ACS_PSW_ERROR_ 67 Maximum Password
OVER_TIMES Authentication Failure
Attempts
EVENT_ACS_PSW_VERIFY_PASS 68 Password Authenticated
EVENT_ACS_PSW_VERIFY_FAIL 69 Password Authentication Failed
EVENT_ACS_ORCODE_VERIFY_ 70 QR Code Authenticated
PASS
EVENT_ACS_ORCODE_VERIFY_ 71 QR Code Authentication Failed
FAIL
EVENT_ACS_HOUSEHOLDER_ 72 Resident Authorization
AUTHORIZE_PASS Authenticated
EVENT_ACS_BLUETOOTH_ 73 Bluetooth Authenticated
VERIFY_PASS

440
 Device Network SDK (Access Control on Person) Developer Guide

Minor Type Value Description

EVENT_ACS_BLUETOOTH_ 74 Bluetooth Authentication
VERIFY_FAIL Failed
EVENT_ACS_INFORMAL_ / Authentication Failed: Invalid
MIFARE_CARD_VERIFY_FAIL Mifare Card
EVENT_ACS_CPU_CARD_ / Verifying CPU Card Encryption
ENCRYPT_VERIFY_FAIL Failed
EVENT_ACS_NFC_DISABLE_ / Disabling NFC Verification
VERIFY_FAIL Failed
EVENT_ACS_EM_CARD_ / EM Card Recognition Disabled
RECOGNIZE_NOT_ENABLED
EVENT_ACS_M1_CARD_ / M1 Card Recognition Disabled
RECOGNIZE_NOT_ENABLED
EVENT_ACS_CPU_CARD_ / CPU Card Recognition Disabled
RECOGNIZE_NOT_ENABLED
EVENT_ACS_ID_CARD_ / ID Card Recognition Disabled
RECOGNIZE_NOT_ENABLED
EVENT_ACS_CARD_SET_ / Importing Key to Card Failed
SECRET_KEY_FAIL

A.3 Device Network SDK Errors

The errors that may occur during the device network SDK integration are listed here for reference.
You can search for the error descriptions according to the error codes or names returned by a
specific API (NET_DVR_GetLastError or NET_DVR_GetErrorMsg).

General Errors

Error Name Error Code Error Description

NET_DVR_NOERROR 0 No error.
NET_DVR_PASSWORD_ERROR 1 Incorrect user name or password.
NET_DVR_NOENOUGHPRI 2 No permission.
NET_DVR_NOINIT 3 Uninitialized.
NET_DVR_CHANNEL_ERROR 4 Incorrect channel No.
NET_DVR_OVER_MAXLINK 5 No more device can be connected.

441
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_VERSIONNOMATCH 6 Version mismatches.
NET_DVR_NETWORK_FAIL_CONNECT 7 Connecting to device failed. The
device is offline or network
connection timed out.
NET_DVR_NETWORK_SEND_ERROR 8 Sending data to device failed.
NET_DVR_NETWORK_RECV_ERROR 9 Receiving data from device failed.
NET_DVR_NETWORK_RECV_TIMEOUT 10 Receiving data from device timed out.
NET_DVR_NETWORK_ERRORDATA 11 The data sent to the device is illegal,
or the data received from the device
error. E.g. The input data is not
supported by the device for remote
configuration.
NET_DVR_ORDER_ERROR 12 API calling order error.
NET_DVR_OPERNOPERMIT 13 No permission for this operation.
NET_DVR_COMMANDTIMEOUT 14 Executing device command timed out.
NET_DVR_ERRORSERIALPORT 15 Incorrect serial port No. The specified
serial port does not exist.
NET_DVR_ERRORALARMPORT 16 Alarm port No. error. The alarm input
or output port of the specified device
does not exist.
NET_DVR_PARAMETER_ERROR 17 Incorrect parameter. The input or
output parameters of the SDK API is
empty, or the parameter value or
format is invalid.
NET_DVR_CHAN_EXCEPTION 18 Device channel is in exception status.
NET_DVR_NODISK 19 No HDD in the device.
NET_DVR_ERRORDISKNUM 20 Incorrect HDD No.
NET_DVR_DISK_FULL 21 HDD full.
NET_DVR_DISK_ERROR 22 HDD error.
NET_DVR_NOSUPPORT 23 Device does not support this function.
NET_DVR_BUSY 24 Device is busy.
NET_DVR_MODIFY_FAIL 25 Failed to edit device parameters.

442
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_PASSWORD_FORMAT_ 26 Invalid password format.
ERROR
NET_DVR_DISK_FORMATING 27 HDD is formatting. Failed to startup.
NET_DVR_DVRNORESOURCE 28 Insufficient device resources.
NET_DVR_DVROPRATEFAILED 29 Device operation failed.
NET_DVR_OPENHOSTSOUND_FAIL 30 Failed to collect local audio data or
open audio output during two-way
audio and broadcast.
NET_DVR_DVRVOICEOPENED 31 Two-way audio channel is occupied.
NET_DVR_TIMEINPUTERROR 32 Incorrect time input.
NET_DVR_NOSPECFILE 33 No video file for playback.
NET_DVR_CREATEFILE_ERROR 34 Failed to create a file during local
recording, saving picture, getting
configuration file or downloading
video file remotely.
NET_DVR_FILEOPENFAIL 35 Failed to open a file. The file does not
exist or directory error.
NET_DVR_OPERNOTFINISH 36 Operation conflicted.
NET_DVR_GETPLAYTIMEFAIL 37 Failed to get the current played time.
NET_DVR_PLAYFAIL 38 Failed to play.
NET_DVR_FILEFORMAT_ERROR 39 Invalid file format.
NET_DVR_DIR_ERROR 40 File directory error.
NET_DVR_ALLOC_RESOURCE_ERROR 41 Allocating resources failed.
NET_DVR_AUDIO_MODE_ERROR 42 Invalid sound card mode error. The
opened sound play mode and
configured mode mismatched.
NET_DVR_NOENOUGH_BUF 43 Insufficient buffer for receiving data
or saving picture.
NET_DVR_CREATESOCKET_ERROR 44 Failed to create SOCKET.
NET_DVR_SETSOCKET_ERROR 45 Failed to set SOCKET.
NET_DVR_MAX_NUM 46 No more registrations and live views
can be connected.

443
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_USERNOTEXIST 47 The user doest not exist. The user ID
is logged out or unavailable.
NET_DVR_WRITEFLASHERROR 48 Writing FLASH error during device
upgrade.
NET_DVR_UPGRADEFAIL 49 Failed to upgrade device. Network
problem or language mismatches.
NET_DVR_CARDHAVEINIT 50 The decoding card is already
initialized.
NET_DVR_PLAYERFAILED 51 Failed to call the function of player
SDK.
NET_DVR_MAX_USERNUM 52 No more users can log in to.
NET_DVR_GETLOCALIPANDMACFAIL 53 Failed to get the IP address or physical
address of local PC.
NET_DVR_NOENCODEING 54 The decoding function of this channel
is not enabled.
NET_DVR_IPMISMATCH 55 IP address mismatches.
NET_DVR_MACMISMATCH 56 MAC address mismatches.
NET_DVR_UPGRADELANGMISMATCH 57 The language of upgrade file
mismatches.
NET_DVR_MAX_PLAYERPORT 58 No more channels can be started to
play.
NET_DVR_NOSPACEBACKUP 59 Insufficient space to back up file.
NET_DVR_NODEVICEBACKUP 60 No backup device found.
NET_DVR_PICTURE_BITS_ERROR 61 Picture pixel bit mismatches. Only 24
bits are allowed.
NET_DVR_PICTURE_DIMENSION_ 62 Too large picture. The height*width
ERROR should be less than 128x256.
NET_DVR_PICTURE_SIZ_ERROR 63 Too large picture. The picture size
should be smaller than 100K.
NET_DVR_LOADPLAYERSDKFAILED 64 Failed to load the player(PlayCtrl.dll,
SuperRender.dll, AudioRender.dll) to
the current directory.

444
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_LOADPLAYERSDKPROC_ 65 Failed to find the function in player
ERROR SDK.
NET_DVR_LOADDSSDKFAILED 66 Failed to load the DS SDK to the
current directory.
NET_DVR_LOADDSSDKPROC_ERROR 67 Failed to find the function in the DS
SDK.
NET_DVR_DSSDK_ERROR 68 Failed to call the API in the hardware
decoding library.
NET_DVR_VOICEMONOPOLIZE 69 The sound card is exclusive.
NET_DVR_JOINMULTICASTFAILED 70 Failed to join to multicast group.
NET_DVR_CREATEDIR_ERROR 71 Failed to create log file directory.
NET_DVR_BINDSOCKET_ERROR 72 Failed to bind socket.
NET_DVR_SOCKETCLOSE_ERROR 73 Socket disconnected. Network
disconnected or the destination is
unreachable.
NET_DVR_USERID_ISUSING 74 Operation is executing. Failed to log
out.
NET_DVR_SOCKETLISTEN_ERROR 75 Failed to listen.
NET_DVR_PROGRAM_EXCEPTION 76 Program exception.
NET_DVR_WRITEFILE_FAILED 77 Failed to write file during local
recording, downloading file remotely
or saving picture.
NET_DVR_FORMAT_READONLY 78 The HDD is read-only. Formatting is
forbidden.
NET_DVR_WITHSAMEUSERNAME 79 The user name already exists.
NET_DVR_DEVICETYPE_ERROR 80 Device model mismatches when
importing parameters.
NET_DVR_LANGUAGE_ERROR 81 Language mismatches when
importing parameters.
NET_DVR_PARAVERSION_ERROR 82 Software version mismatches when
importing parameters.
NET_DVR_IPCHAN_NOTALIVE 83 The external IP channel is offline live
view.

445
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_RTSP_SDK_ERROR 84 Failed to load StreamTransClient.dll.
NET_DVR_CONVERT_SDK_ERROR 85 Failed to load SystemTransform.dll.
NET_DVR_IPC_COUNT_OVERFLOW 86 No more IP channels can access to.
NET_DVR_MAX_ADD_NUM 87 No more video tags can be added.
NET_DVR_PARAMMODE_ERROR 88 Invalid parameter mode of image
enhancement.
NET_DVR_CODESPITTER_OFFLINE 89 Code distributer is offline.
NET_DVR_BACKUP_COPYING 90 Device is backing up.
NET_DVR_CHAN_NOTSUPPORT 91 This operation is not supported by the
channel.
NET_DVR_CALLINEINVALID 92 The height line is too concentrated, or
the length line is not inclined enough.
NET_DVR_CALCANCELCONFLICT 93 Cancel calibration conflict, if the rule
and global actual size filter are
configured.
NET_DVR_CALPOINTOUTRANGE 94 The calibration point is out of
limitation.
NET_DVR_FILTERRECTINVALID 95 The size filter does not meet the
requirement.
NET_DVR_DDNS_DEVOFFLINE 96 Device has not registered to DDNS.
NET_DVR_DDNS_INTER_ERROR 97 DDNS internal error.
NET_DVR_FUNCTION_NOT_ 98 This function is not supported by this
SUPPORT_OS Operating system.
NET_DVR_DEC_CHAN_REBIND 99 Decoding channel binding display
output is limited.
NET_DVR_INTERCOM_SDK_ERROR 100 Failed to load the two-way audio SDK
of the current directory.
NET_DVR_NO_CURRENT_UPDATEFILE 101 No correct upgrade packet.
NET_DVR_USER_NOT_SUCC_LOGIN 102 Login failed.
NET_DVR_USE_LOG_SWITCH_FILE 103 The log switch file is under using.
NET_DVR_POOL_PORT_EXHAUST 104 No port can be bound in the port
pool.

446
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_PACKET_TYPE_NOT_ 105 Incorrect stream packaging format.
SUPPORT
NET_DVR_IPPARA_IPID_ERROR 106 Incorrect IPID for IP access
configuration.
NET_DVR_LOAD_HCPREVIEW_SDK_ 107 Failed to load the live view
ERROR component.
NET_DVR_LOAD_HCVOICETALK_SDK_ 108 Failed to load the audio component.
ERROR
NET_DVR_LOAD_HCALARM_SDK_ 109 Failed to load the alarm component.
ERROR
NET_DVR_LOAD_HCPLAYBACK_SDK_ 110 Failed to load the playback
ERROR component.
NET_DVR_LOAD_HCDISPLAY_SDK_ 111 Failed to load the display component.
ERROR
NET_DVR_LOAD_HCINDUSTRY_SDK_ 112 Failed to load application component.
ERROR
NET_DVR_LOAD_ 113 Failed to load the general
HCGENERALCFGMGR_SDK_ERROR configuration management
component.
NET_DVR_CORE_VER_MISMATCH 121 Component version and core version
mismatched when loading the
component singly.
NET_DVR_CORE_VER_MISMATCH_ 122 Live view component version and core
HCPREVIEW version mismatched.
NET_DVR_CORE_VER_MISMATCH_ 123 Audio component version and the
HCVOICETALK core version mismatched.
NET_DVR_CORE_VER_MISMATCH_ 124 Alarm component version and the
HCALARM core version mismatched.
NET_DVR_CORE_VER_MISMATCH_ 125 Playback component version and the
HCPLAYBACK core version mismatched.
NET_DVR_CORE_VER_MISMATCH_ 126 Display component version and the
HCDISPLAY core version mismatched.
NET_DVR_CORE_VER_MISMATCH_ 127 Application component version and
HCINDUSTRY the core version mismatched.

447
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_CORE_VER_MISMATCH_ 128 General configuration management
HCGENERALCFGMGR component version and the core
version mismatched.
NET_DVR_COM_VER_MISMATCH_ 136 Live view component version and SDK
HCPREVIEW version mismatched.
NET_DVR_COM_VER_MISMATCH_ 137 Audio component version and SDK
HCVOICETALKy version mismatched.
NET_DVR_COM_VER_MISMATCH_ 138 Alarm component version and SDK
HCALARM version mismatched.
NET_DVR_COM_VER_MISMATCH_ 139 Playback component version and SDK
HCPLAYBACK version mismatched.
NET_DVR_COM_VER_MISMATCH_ 140 Display component version and SDK
HCDISPLAY version mismatched.
NET_DVR_COM_VER_MISMATCH_ 141 Application component version and
HCINDUSTRY SDK version mismatched.
NET_DVR_COM_VER_MISMATCH_ 142 General configuration management
HCGENERALCFGMGR component version and SDK version
mismatched.
NET_DVR_ALIAS_DUPLICATE 150 Duplicated alias(for HiDDNS
configuration).
NET_DVR_USERNAME_NOT_EXIST 152 User name does not exist (error code
of network camera and network
speed dome with version from 5.1.7
to 5.3.1).
NET_ERR_USERNAME_LOCKED 153 The user name is locked.
NET_DVR_INVALID_USERID 154 Invalid user ID.
NET_DVR_LOW_LOGIN_VERSION 155 The version is too low.
NET_DVR_LOAD_LIBEAY32_DLL_ 156 Failed to load libeay32.dl.l
ERROR
NET_DVR_LOAD_SSLEAY32_DLL_ 157 Failed to load ssleay32.dll.
ERROR
NET_ERR_LOAD_LIBICONV 158 Failed to load libiconv.dll.
NET_ERR_SSL_CONNECT_FAILED 159 Connecting to SSL failed.

448
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_TEST_SERVER_FAIL_ 165 Failed to connect to test server.
CONNECT
NET_DVR_NAS_SERVER_INVALID_DIR 166 Failed to load NAS server to the
directory, Invalid directory, or
incorrect user name and password.
NET_DVR_NAS_SERVER_ 167 Failed to load NAS server th the
NOENOUGH_PRI directory. No permission.
NET_DVR_EMAIL_SERVER_NOT_ 168 The server uses domain name
CONFIG_DNS without configuring DNS, the domain
name may be invalid.
NET_DVR_EMAIL_SERVER_NOT_ 169 No gateway configured. Sending email
CONFIG_GATEWAY may be failed.
NET_DVR_TEST_SERVER_PASSWORD_ 170 Incorrect user name or password of
ERROR test server.
NET_DVR_EMAIL_SERVER_CONNECT_ 171 Interaction exception between device
EXCEPTION_WITH_SMTP and SMTP server.
NET_DVR_FTP_SERVER_FAIL_ 172 FTP server creating directory failed.
CREATE_DIR
NET_DVR_FTP_SERVER_NO_WRITE_ 173 FTP server has no wirting permission.
PIR
NET_DVR_IP_CONFLICT 174 IP conflicted.
NET_DVR_INSUFFICIENT_ 175 Storage pool space is full.
STORAGEPOOL_SPACE
NET_DVR_STORAGEPOOL_INVALID 176 Invalid cloud storage pool. No storage
pool configured or incorrect storage
pool ID.
NET_DVR_EFFECTIVENESS_REBOOT 177 Restart to take effect.
NET_ERR_ANR_ARMING_EXIST 178 The ANR arming connection already
exists( the error will be returned
when arming with ANR function if the
private SDK protocol arming
connection is established).
NET_ERR_UPLOADLINK_EXIST 179 The ANR uploading connection
already exists( the error will be
returned when EHome protocol and

449
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

private SDK protocol do not support
ANR at the same time).
NET_ERR_INCORRECT_FILE_FORMAT 180 The imported file format is incorrect.
NET_ERR_INCORRECT_FILE_CONTENT 181 The imported file content is incorrect.
NET_ERR_MAX_HRUDP_LINK 182 No more HRUDP can be connected to
device.
NET_ERR_MAX_PORT_MULTIPLEX 183 Maximum number of multiplexed
ports reaches.
NET_ERR_CREATE_PORT_MULTIPLEX 184 Creating port multiplier failed.
NET_SDK_ERR_FUNCTION_INVALID 186 Invalid function. The asynchronous
mode is enabled
NET_DVR_NAME_NOT_ONLY 200 This name already exists.
NET_DVR_OVER_MAX_ARRAY 201 The number of RAID reaches the
upper-limit.
NET_DVR_OVER_MAX_VD 202 The number of virtual disk reaches
the upper-limit.
NET_DVR_VD_SLOT_EXCEED 203 The virtual disk slots are full.
NET_DVR_PD_STATUS_INVALID 204 The physical disk for rebuilding RAID
is error.
NET_DVR_PD_BE_DEDICATE_SPARE 205 The physical disk for rebuilding RAID
is specified as hot spare.
NET_DVR_PD_NOT_FREE 206 The physical disk for rebuilding RAID
is busy.
NET_DVR_CANNOT_MIG2NEWMODE 207 Failed to migrate the current RAID
type to the new type.
NET_DVR_MIG_PAUSE 208 Migration is paused.
NET_DVR_MIG_ABOUTED 209 Migration is cancelled.
NET_DVR_EXIST_VD 210 Failed to delete RAID. Virtual disk
exists in the RAID.
NET_DVR_TARGET_IN_LD_ 211 Target physical disk is a part of the
FUNCTIONAL virtual disk and it is working normally.
NET_DVR_HD_IS_ASSIGNED_ 212 The specified physical disk is allocated
ALREADY as virtual disk.

450
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_INVALID_HD_COUNT 213 The number of physical disks and
specified RAID level mismatched.
NET_DVR_LD_IS_FUNCTIONAL 214 The RAID is normal. Failed to rebuild.
NET_DVR_BGA_RUNNING 215 Background task is executing.
NET_DVR_LD_NO_ATAPI 216 Failed to create virtual disk by ATAPI
disk.
NET_DVR_MIGRATION_NOT_NEED 217 There is no need to migrate the RAID.
NET_DVR_HD_TYPE_MISMATCH 218 The physical disk type is not allowed.
NET_DVR_NO_LD_IN_DG 219 No virtual disk. Operation failed.
NET_DVR_NO_ROOM_FOR_SPARE 220 Insufficient disk space. Failed to
allocate the disk as hot spare.
NET_DVR_SPARE_IS_IN_MULTI_DG 221 The disk is already allocated as the
hot spare of one RAID.
NET_DVR_DG_HAS_MISSING_PD 222 No disk in the RAID.
NET_DVR_NAME_EMPTY 223 The name is empty.
NET_DVR_INPUT_PARAM 224 Incorrect input parameters.
NET_DVR_PD_NOT_AVAILABLE 225 The physical disk is not available.
NET_DVR_ARRAY_NOT_AVAILABLE 226 The RAID is not available.
NET_DVR_PD_COUNT 227 Incorrect number of physical disks.
NET_DVR_VD_SMALL 228 Insufficient virtual disk space.
NET_DVR_NO_EXIST 229 Not exist.
NET_DVR_NOT_SUPPORT 230 This operation is not supported.
NET_DVR_NOT_FUNCTIONAL 231 The RAID status is exception.
NET_DVR_DEV_NODE_NOT_FOUND 232 The device node of virtual disk does
not exist.
NET_DVR_SLOT_EXCEED 233 No more slots are allowed.
NET_DVR_NO_VD_IN_ARRAY 234 No virtual disk exists in the RAID.
NET_DVR_VD_SLOT_INVALID 235 Invalid virtual disk slot.
NET_DVR_PD_NO_ENOUGH_SPACE 236 Insufficient physical disk space.

451
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ARRAY_NONFUNCTION 237 Only the RAID in normal status
supports to be migrated.
NET_DVR_ARRAY_NO_ENOUGH_ 238 Insufficient RAID space.
SPACE
NET_DVR_STOPPING_SCANNING_ 239 Pulling disk out safely or rescanning.
ARRAY
NET_DVR_NOT_SUPPORT_16T 240 Creating RAID with size larger than
16T is not supported.
NET_DVR_ERROR_DEVICE_NOT_ 250 The device is not activated (login
ACTIVATED failed.)
NET_DVR_ERROR_RISK_PASSWORD 251 Risky password.
NET_DVR_ERROR_DEVICE_HAS_ 252 The device is already activated.
ACTIVATED
NET_DVR_ID_ERROR 300 The configured ID is invalid.
NET_DVR_POLYGON_ERROR 301 Invalid polygon shape.
NET_DVR_RULE_PARAM_ERROR 302 Invalid rule parameters.
NET_DVR_RULE_CFG_CONFLICT 303 Configured information conflicted.
NET_DVR_CALIBRATE_NOT_READY 304 No calibration information.
NET_DVR_CAMERA_DATA_ERROR 305 Invalid camera parameters.
NET_DVR_CALIBRATE_DATA_UNFIT 306 Invalid inclination angle for
calibration.
NET_DVR_CALIBRATE_DATA_ 307 Calibration error.
CONFILICT
NET_DVR_CALIBRATE_CALC_FAIL 308 Failed to calculate calibration
parameter values of camera.
NET_DVR_CALIBRATE_LINE_OUT_ 309 The inputted calibration line exceeds
RECT the external sample rectangle.
NET_DVR_ENTER_RULE_NOT_READY 310 No region entrance is configured.
NET_DVR_AID_RULE_NO_INCLUDE_ 311 No lane configured in the traffic event
LANE rull(especially for traffic jam or driving
against the traffic).
NET_DVR_LANE_NOT_READY 312 Lane not configured.

452
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_RULE_INCLUDE_TWO_WAY 313 Two different directions are contained
in event rule.
NET_DVR_LANE_TPS_RULE_CONFLICT 314 Lane and data rule conflicted.
NET_DVR_NOT_SUPPORT_EVENT_ 315 This event type is not supported.
TYPE
NET_DVR_LANE_NO_WAY 316 The lane has no direction.
NET_DVR_SIZE_FILTER_ERROR 317 Invalid size of filter frame.
NET_DVR_LIB_FFL_NO_FACE 318 No face picture exists in the image
inputted when positioning feature
point.
NET_DVR_LIB_FFL_IMG_TOO_SMALL 319 The inputted image is too small when
positioning feature point.
NET_DVR_LIB_FD_IMG_NO_FACE 320 No face picture exists in the image
inputted when detecting single face
picture.
NET_DVR_LIB_FACE_TOO_SMALL 321 Face picture is too small when
building model.
NET_DVR_LIB_FACE_QUALITY_TOO_ 322 The face picture quality is too poor
BAD when building model.
NET_DVR_KEY_PARAM_ERR 323 The configured advanced parameter
is incorrect.
NET_DVR_CALIBRATE_DATA_ERR 324 Calibration sample number error, or
data value error, or the sample points
are beyond the horizontal line.
NET_DVR_CALIBRATE_DISABLE_FAIL 325 Cancelling calibration is not allowed
for configured rules.
NET_DVR_VCA_LIB_FD_SCALE_ 326 The minimum width and height of
OUTRANGE maximum filter frame are twice or
more larger than the maximum width
and height of minimum filter frame.
NET_DVR_LIB_FD_REGION_TOO_ 327 Too large detection region. The
LARGE maximum region should be 2/3 of the
image.
NET_DVR_TRIAL_OVERDUE 328 Trial period is ended.

453
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_CONFIG_FILE_CONFLICT 329 Device type and configuration file
conflicted.
NET_DVR_FR_FPL_FAIL 330 Failed to positioning face feature
points.
NET_DVR_FR_IQA_FAIL 331 Failed to test face picture quality.
NET_DVR_FR_FEM_FAIL 332 Failed to extract the face feature
points.
NET_DVR_FPL_DT_CONF_TOO_LOW 333 The face detection validity is too low
when positioning face feature points.
NET_DVR_FPL_CONF_TOO_LOW 334 The validity of feature points
positionong is too low.
NET_DVR_E_DATA_SIZE 335 Data size mismatches.
NET_DVR_FR_MODEL_VERSION_ERR 336 Incorrect model version in face model
library.
NET_DVR_FR_FD_FAIL 337 Failed to detect face in the face
recognition library.
NET_DVR_FA_NORMALIZE_ERR 338 Failed to normalize face attribute.
NET_DVR_DOG_PUSTREAM_NOT_ 339 Dongle type and camera type
MATCH mismatched.
NET_DVR_DEV_PUSTREAM_NOT_ 340 Camera version mismatches.
MATCH
NET_DVR_PUSTREAM_ALREADY_ 341 This camera is already added to other
EXISTS channels of devices.
NET_DVR_SEARCH_CONNECT_FAILED 342 Failed to connect to face retrieval
server.
NET_DVR_INSUFFICIENT_DISK_SPACE 343 Insufficient storage space.
NET_DVR_DATABASE_CONNECTION_ 344 Failed to connect to database.
FAILED
NET_DVR_DATABASE_ADM_PW_ 345 Incorrect database user name and
ERROR password.
NET_DVR_DECODE_YUV 346 Decoding failed.
NET_DVR_IMAGE_RESOLUTION_ 347 Invalid picture resolution
ERROR

454
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_CHAN_WORKMODE_ 348 Invalid channel working mode.
ERROR
NET_ERROR_SCENE_USING 717 The scene is being used.
NET_ERR_TERMINAL_BUSY 780 The terminal busy.
NET_DVR_FUNCTION_RESOURCE_ 791 Failed to enable this function. The
USAGE_ERROR resources is occupied by other
functions.
NET_DVR_DEV_NET_OVERFLOW 800 Network traffic is out of the
limitation.
NET_DVR_STATUS_RECORDFILE_ 801 Failed to lock. The video file is
WRITING_NOT_LOCK recording.
NET_DVR_STATUS_CANT_FORMAT_ 802 Failed to format HDD. The HDD space
LITTLE_DISK is too small.
NET_SDK_ERR_REMOTE_DISCONNEC 803 Failed to connect to the remote
terminal.
NET_SDK_ERR_RD_ADD_RD 804 Spare server cannot be added to
spare server.
NET_SDK_ERR_BACKUP_DISK_EXCEPT 805 Backup disk exception.
NET_SDK_ERR_RD_LIMIT 806 No more spare server can be added.
NET_SDK_ERR_ADDED_RD_IS_WD 807 The added spare server is a working
server.
NET_SDK_ERR_ADD_ORDER_WRONG 808 Adding flow error.
NET_SDK_ERR_WD_ADD_WD 809 Working server cannot be added to
working server.
NET_SDK_ERR_WD_SERVICE_EXCETP 810 CVR service exception (For N+1 mode,
it refers to CVR working server
exception).
NET_SDK_ERR_RD_SERVICE_EXCETP 811 Spare CVR server exception.
NET_SDK_ERR_ADDED_WD_IS_RD 812 The added working server is spare
server.
NET_SDK_ERR_PERFORMANCE_LIMIT 813 The performance reaches the upper-
limit.
NET_SDK_ERR_ADDED_DEVICE_EXIST 814 This device already exists.

455
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_SDK_ERR_INQUEST_RESUMING 815 Inquest resuming.
NET_SDK_ERR_RECORD_BACKUPING 816 Inquest video backing up.
NET_SDK_ERR_DISK_PLAYING 817 Playing.
NET_SDK_ERR_INQUEST_STARTED 818 Inquest started.
NET_SDK_ERR_LOCAL_OPERATING 819 Locally operating.
NET_SDK_ERR_INQUEST_NOT_START 820 Inquest is not started.
NET_SDK_ERR_CHAN_AUDIO_BIND 821 The channel is not bound or binding
two-way audio failed.
NET_DVR_N_PLUS_ONE_MODE 822 Ddevice is in N+1 mode. Cloud
storage is not supported.
NET_DVR_CLOUD_STORAGE_OPENED 823 Cloud storage mode is enbaled.
NET_DVR_ERR_OPER_NOT_ALLOWED 824 Operation failed. The device is in N+0
taken over status.
NET_DVR_ERR_NEED_RELOCATE 825 The device is in N+0 taken over status.
Get re-​positioning information and try
again.
NET_SDK_ERR_IR_PORT_ERROR 830 IR output error.
NET_SDK_ERR_IR_CMD_ERROR 831 IR output port command number
error
NET_SDK_ERR_NOT_INQUESTING 832 Device is not in inquest status.
NET_SDK_ERR_INQUEST_NOT_ 833 Device is not in paused status.
PAUSED
NET_DVR_CHECK_PASSWORD_ 834 Incorrect verification code.
MISTAKE_ERROR
NET_DVR_CHECK_PASSWORD_NULL_ 835 Verification code is required.
ERROR
NET_DVR_UNABLE_CALIB_ERROR 836 Failed to calibrate.
NET_DVR_PLEASE_CALIB_ERROR 837 Calibration first.
NET_DVR_ERR_PANORAMIC_CAL_ 838 Panoramic calibration is empty in
EMPTY Flash.
NET_DVR_ERR_CALIB_FAIL_ 839 Calibration failed, please try again.
PLEASEAGAIN

456
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_DETECTION_LINE 840 Rule line configuration error. Please
try again and make sure the line is
within the red region.
NET_DVR_EXCEED_FACE_IMAGES_ 843 No more face pictures can be added.
ERROR
NET_DVR_ANALYSIS_FACE_IMAGES_ 844 Picture recognition failed.
ERROR
NET_ERR_ALARM_INPUT_OCCUPIED 845 A<-1 alarm number is used for
triggering vehicle capture.
NET_DVR_FACELIB_DATABASE_ERROR 846 Database version in face picture
library mismatched.
NET_DVR_FACELIB_DATA_ERROR 847 Face picture library data error.
NET_DVR_FACE_DATA_ID_ERROR 848 Invalid face data PID.
NET_DVR_FACELIB_ID_ERROR 849 Invalid face picture library ID.
NET_DVR_EXCEED_FACE_LIBARY_ 850 No more face picture libraries can be
ERROR established..
NET_DVR_PIC_ANALYSIS_NO_ 851 No target recognized in the picture.
TARGET_ERROR
NET_DVR_SUBPIC_ANALYSIS_ 852 Sub picture modeling failed.
MODELING_ERROR
NET_DVR_PIC_ANALYSIS_NO_ 853 No VCA engine supports picture
RESOURCE_ERROR secondary recognition.
NET_DVR_ANALYSIS_ENGINES_NO_ 854 No VCA engine.
RESOURCE_ERROR
NET_DVR_ANALYSIS_ENGINES_ 855 Overload. The engine CPU reached
USAGE_EXCEED_ERROR 100%.
NET_DVR_EXCEED_HUMANMISINFO_ 856 No more false alarm channel can be
FILTER_ENABLED_ERROR enabled.
NET_DVR_NAME_ERROR 857 Name error.
NET_DVR_NAME_EXIST_ERROR 858 The name already exists.
NET_DVR_FACELIB_PIC_IMPORTING_ 859 The pictures is importing to face
ERROR picture library.
NET_DVR_PIC_FORMAT_ERROR 864 Invalid picture format.

457
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_PIC_RESOLUTION_ 865 Invalid picture resolution.
INVALID_ERROR
NET_DVR_PIC_SIZE_EXCEED_ERROR 866 The picture size is too large.
NET_DVR_PIC_ANALYSIS_TARGRT_ 867 Too many targets in the picture.
NUM_EXCEED_ERROR
NET_DVR_ANALYSIS_ENGINES_ 868 Initializing analysis engine.
LOADING_ERROR
NET_DVR_ANALYSIS_ENGINES_ 869 Analysis engine exception.
ABNORMA_ERROR
NET_DVR_ANALYSIS_ENGINES_ 870 Analysis engine is importing pictures
FACELIB_IMPORTING to face picture library.
NET_DVR_NO_DATA_FOR_ 871 No data for modeling.
MODELING_ERROR
NET_DVR_FACE_DATA_MODELING_ 872 Device is modeling picture.
ERROR Concurrent processing is not
supported.
NET_ERR_FACELIBDATA_OVERLIMIT 873 No more face picture can be added to
the device (the data of imported face
picture library)
NET_DVR_ANALYSIS_ENGINES_ 874 Channel is linked to the analysis
ASSOCIATED_CHANNEL engine.
NET_DVR_ERR_CUSTOMID_LEN 875 The minimum length of upper layer
custom ID is 32 bytes.
NET_DVR_ERR_CUSTOMFACELIBID_ 876 The applied custom face picture
REPEAT library ID is duplicated
NET_DVR_ERR_CUSTOMHUMANID_ 877 The applied custom person ID is
REPEAT duplicated.
NET_DVR_ERR_URL_DOWNLOAD_ 878 URL download failed.
FAIL
NET_DVR_ERR_URL_DOWNLOAD_ 879 URL download has not started.
NOTSTART
NET_DVR_CFG_FILE_SECRETKEY_ 880 The security verification key of
ERROR configuration file is error.

458
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_THERMOMETRY_REGION_ 883 Invalid thermometry region
OVERSTEP_ERROR
NET_DVR_ERR_TOO_SHORT_ 894 Too short time for calibration.
CALIBRATING_TIME
NET_DVR_ERR_AUTO_CALIBRATE_ 895 Auto calibration failed.
FAILED
NET_DVR_ERR_VERIFICATION_FAILED 896 Verification failed.
NET_DVR_NO_TEMP_SENSOR_ERROR 897 No temperature sensor.
NET_DVR_PUPIL_DISTANCE_ 898 The pupil distance is too large.
OVERSIZE_ERROR
NET_ERR_WINCHAN_IDX 901 Window channel index error.
NET_ERR_WIN_LAYER 902 Window layer number error(the
count of window layers on a single
screen exceeds the max number).
NET_ERR_WIN_BLK_NUM 903 Window block number error(the
count of screens that single window
overlays exceeds the max number).
NET_ERR_OUTPUT_RESOLUTION 904 The output resolution error.
NET_ERR_LAYOUT 905 Layout index error.
NET_ERR_INPUT_RESOLUTION 906 The input resolution is not supported.
NET_ERR_SUBDEVICE_OFFLINE 907 The sub-device is off-line.
NET_ERR_NO_DECODE_CHAN 908 There is no free decoding channel.
NET_ERR_MAX_WINDOW_ABILITY 909 The upper limit of window number.
NET_ERR_ORDER_ERROR 910 Calling order error.
NET_ERR_PLAYING_PLAN 911 Be playing plan.
NET_ERR_DECODER_USED 912 Decoder board is being used.
NET_ERR_OUTPUT_BOARD_DATA_ 913 Output board data overflow
OVERFLOW
NET_ERR_SAME_USER_NAME 914 Duplicate user name
NET_ERR_INVALID_USER_NAME 915 Invalid user name
NET_ERR_MATRIX_USING 916 Input matrix is in use.

459
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_ERR_DIFFERENT_CHAN_TYPE 917 Different channel type (the type of
matrix output channel mismatches
that of the controller input channel)
NET_ERR_INPUT_CHAN_BINDED 918 Input channel has been bound by
other matrix
NET_ERR_BINDED_OUTPUT_CHAN_ 919 The matrix output channels in use
OVERFLOW exceeded the number bound by
matrix and controller
NET_ERR_MAX_SIGNAL_NUM 920 Number of input signals reached
upper limit
NET_ERR_INPUT_CHAN_USING 921 Input channel is in use
NET_ERR_MANAGER_LOGON 922 Administrator has logged in,
operation failed
NET_ERR_USERALREADY_LOGON 923 The user has logged in, operation
failed
NET_ERR_LAYOUT_INIT 924 Scene is initializing, operation failed
NET_ERR_BASEMAP_SIZE_NOT_ 925 Base image size does not match
MATCH
NET_ERR_WINDOW_OPERATING 926 Window is in other operation,
operation failed
NET_ERR_SIGNAL_UPLIMIT 927 Number of signal source window
reached upper limit
NET_ERR_WINDOW_SIZE_OVERLIMIT 943 The window size exceeds the limit.
NET_ERR_MAX_WIN_OVERLAP 951 The number of windows overlap has
reached the maximum limit.
NET_ERR_STREAMID_CHAN_BOTH_ 952 stream ID and channel number are
VALID both valid.
NET_ERR_NO_ZERO_CHAN 953 The device has no zero channel.
NEED_RECONNECT 955 Need redirection (for transcoding
system)
NET_ERR_NO_STREAM_ID 956 The stream ID does not exist.
NET_DVR_TRANS_NOT_START 957 The transcoding has not been started.

460
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_ERR_MAXNUM_STREAM_ID 958 The number of stream ID has reached
the maximum limit.
NET_ERR_WORKMODE_MISMATCH 959 The work mode does not match with
the requirement.
NET_ERR_MODE_IS_USING 960 It Has been working in current mode.
NET_ERR_DEV_PROGRESSING 961 The device is in processing
NET_ERR_PASSIVE_TRANSCODING 962 It is in transcoding.
NET_DVR_ERR_WINDOW_SIZE_ 975 Wrong window position.
PLACE
NET_DVR_ERR_RGIONAL_ 976 Screen distance exceeds the limit.
RESTRICTIONS
NET_DVR_ERR_CLOSE_WINDOWS 984 Operation failed. Close the window
first.
NET_DVR_ERR_MATRIX_LOOP_ 985 Beyond the cycle decoding capacity.
ABILITY
NET_DVR_ERR_MATRIX_LOOP_TIME 986 Invalid cycle decoding time.
NET_DVR_ERR_LINKED_OUT_ABILITY 987 No more linked camera can be added.
NET_​ERR_​UnitConfig_​Failed 998 Unit configuration failed.
XML_ABILITY_NOTSUPPORT 1000 Getting capability node is not
supported
XML_ANALYZE_NOENOUGH_BUF 1001 Not enough output memory
XML_ANALYZE_FIND_LOCALXML_ 1002 Failed to find related local xml
ERROR
XML_ANALYZE_LOAD_LOCALXML_ 1003 Loading local xml error
ERROR
XML_NANLYZE_DVR_DATA_FORMAT_ 1004 Device capability data format error
ERROR
XML_ANALYZE_TYPE_ERROR 1005 Capability set type error
XML_ANALYZE_XML_NODE_ERROR 1006 XML capability node format error
XML_INPUT_PARAM_ERROR 1007 Input capability XML node value error
XML_VERSION_MISMATCH 1008 XML version does not match

461
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_ERR_TRANS_CHAN_START 1101 Transparent channel has been open,
operation failed
NET_ERR_DEV_UPGRADING 1102 Device is upgrading
NET_ERR_MISMATCH_UPGRADE_ 1103 Upgrade pack type does not match
PACK_TYPE
NET_ERR_DEV_FORMATTING 1104 Device is formatting
NET_ERR_MISMATCH_UPGRADE_ 1105 Upgrade pack version does not match
PACK_VERSION
NET_ERR_PT_LOCKED 1106 PT is locked.
NET_DVR_ERR_ILLEGAL_ 1111 Illegal verification code. Change the
VERIFICATION_CODE verification code.
NET_DVR_ERR_LACK_VERIFICATION_ 1112 No verification code. Enter the
CODE verification code.
NET_DVR_ERR_FORBIDDEN_IP 1113 The IP address cannot be configured.
NET_DVR_ERR_HTTP_BKN_EXCEED_ 1125 Up to one channel's ANR function can
ONE be enabled.
NET_DVR_ERR_FORMATTING_FAILED 1131 Formatting HDD failed.
NET_DVR_ERR_ENCRYPTED_ 1132 Formatting encrypted HDD failed.
FORMATTING_FAILED
NET_DVR_ERR_WRONG_PASSWORD 1133 Verifying password of SD card failed.
Incorrect password.
NET_ERR_SEARCHING_MODULE 1201 Searching peripherals.
NET_ERR_REGISTERING_MODULE 1202 Registering external module
NET_ERR_GETTING_ZONES 1203 Getting arming region parameter
NET_ERR_GETTING_TRIGGERS 1204 Getting trigger
NET_ERR_ARMED_STATUS 1205 System is in arming status
NET_ERR_PROGRAM_MODE_STATUS 1206 System is in programming mode
NET_ERR_WALK_TEST_MODE_STATUS 1207 System is in pacing measuring mode
NET_ERR_BYPASS_STATUS 1208 Bypass status
NET_ERR_DISABLED_MODULE_ 1209 Function not enabled
STATUS

462
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_ERR_NOT_SUPPORT_OPERATE_ 1210 Operation is not supported by arming
ZONE region
NET_ERR_NOT_SUPPORT_MOD_ 1211 Module address cannot be modified
MODULE_ADDR
NET_ERR_UNREGISTERED_MODULE 1212 Module is not registered
NET_ERR_PUBLIC_SUBSYSTEM_ 1213 Public sub system associate with its
ASSOCIATE_SELF self
NET_ERR_EXCEEDS_ASSOCIATE_ 1214 Number of associated public sub
SUBSYSTEM_NUM system reached upper limit
NET_ERR_BE_ASSOCIATED_BY_ 1215 Sub system is associated by other
PUBLIC_SUBSYSTEM public sub system
NET_ERR_ZONE_FAULT_STATUS 1216 Arming region is in failure status
NET_ERR_SAME_EVENT_TYPE 1217 Same event type exists in enable
event trigger alarm output and
disable event trigger alarm output
NET_ERR_ZONE_ALARM_STATUS 1218 Arming region is in alarm status
NET_ERR_EXPANSION_BUS_SHORT_ 1219 Extension bus short-circuit
CIRCUIT
NET_ERR_PWD_CONFLICT 1220 Password conflict, e.g., lock password
is identical with duress password
NET_ERR_DETECTOR_GISTERED_BY_ 1221 Detector has been registered by other
OTHER_ZONE arming regions
NET_ERR_DETECTOR_GISTERED_BY_ 1222 Detector has been registered by other
OTHER_PU hosts
NET_ERR_DETECTOR_DISCONNECT 1223 Detector offline
NET_ERR_CALL_BUSY 1224 Device in call
NET_ERR_FILE_NAME 1357 File name error, empty or invalid
NET_ERR_BROADCAST_BUSY 1358 Device in broadcast
NET_DVR_ERR_LANENUM_EXCEED 1400 Over the number of lanes.
NET_DVR_ERR_PRAREA_EXCEED 1401 Recognition area is too large.
NET_DVR_ERR_LIGHT_PARAM 1402 Signal lamp access parameters error.
NET_DVR_ERR_LANE_LINE_INVALID 1403 Lane configuration error.

463
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_STOP_LINE_INVALID 1404 Stop line configuration error.
NET_DVR_ERR_LEFTORRIGHT_LINE_ 1405 Turn left / right boundary
INVALID configuration error.
NET_DVR_ERR_LANE_NO_REPEAT 1406 Overlay lane number repetition.
NET_DVR_ERR_PRAREA_INVALID 1407 The polygon does not meet the
requirements.
NET_DVR_ERR_LIGHT_NUM_EXCEED 1408 Video detection of traffic light signal
exceeds the maximum number of.
NET_DVR_ERR_SUBLIGHT_NUM_ 1409 Video detection of traffic signal lamp
INVALID lights are not legitimate
NET_DVR_ERR_LIGHT_AREASIZE_ 1410 The size of the video detection of
INVALID traffic light input signal lamp is not
valid.
NET_DVR_ERR_LIGHT_COLOR_ 1411 The color of the video detection of
INVALID traffic light input signal lamp color is
not legitimate.
NET_DVR_ERR_LIGHT_DIRECTION_ 1412 The direction property of the video
INVALID detection of traffic light input light is
not valid.
NET_DVR_ERR_LACK_IOABLITY 1413 Lack of IO ablity.
NET_DVR_ERR_FTP_PORT 1414 FTP port error.
NET_DVR_ERR_FTP_CATALOGUE 1415 FTP catalogue error.
NET_DVR_ERR_FTP_UPLOAD_TYPE 1416 FTP upload type error.
NET_DVR_ERR_FLASH_PARAM_ 1417 Setting param flash write error.
WRITE
NET_DVR_ERR_FLASH_PARAM_READ 1418 Getting param flash read error.
NET_DVR_ERR_PICNAME_DELIMITER 1419 Pic name delimiter error.
NET_DVR_ERR_PICNAME_ITEM 1420 Pic name item error.
NET_DVR_ERR_PLATE_RECOGNIZE_ 1421 Plate recognize type error.
TYPE
NET_DVR_ERR_CAPTURE_TIMES 1422 Capture times error.
NET_DVR_ERR_LOOP_DISTANCE 1423 Loop distance error.

464
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_LOOP_INPUT_STATUS 1424 Loop input status error.
NET_DVR_ERR_RELATE_IO_CONFLICT 1425 Related IO conflict.
NET_DVR_ERR_INTERVAL_TIME 1426 Interval time error.
NET_DVR_ERR_SIGN_SPEED 1427 Sign speed error.
NET_DVR_ERR_PIC_FLIP 1428 Flip is used.
NET_DVR_ERR_RELATE_LANE_ 1429 Related lane number error.
NUMBER
NET_DVR_ERR_TRIGGER_MODE 1430 Trigger mode error.
NET_DVR_ERR_DELAY_TIME 1431 Delay time error.
NET_DVR_ERR_EXCEED_RS485_ 1432 Exceed RS485 count.
COUNT
NET_DVR_ERR_RADAR_TYPE 1433 Radar type error.
NET_DVR_ERR_RADAR_ANGLE 1434 Radar angle error.
NET_DVR_ERR_RADAR_SPEED_ 1435 Radar speed valid time error.
VALID_TIME
NET_DVR_ERR_RADAR_LINE_ 1436 Radar line correct error.
CORRECT
NET_DVR_ERR_RADAR_CONST_ 1437 Radar const correct error.
CORRECT
NET_DVR_ERR_RECORD_PARAM 1438 Record param error.
NET_DVR_ERR_LIGHT_WITHOUT_ 1439 Light number and other param error.
COLOR_AND_DIRECTION
NET_DVR_ERR_LIGHT_WITHOUT_ 1440 Light number and detection region
DETECTION_REGION error.
NET_DVR_ERR_RECOGNIZE_ 1441 Plate recognize Province param error.
PROVINCE_PARAM
NET_DVR_ERR_SPEED_TIMEOUT 1442 IO Speed TimeOut Param error.
NET_DVR_ERR_NTP_TIMEZONE 1443 NTP TimeZone Param error.
NET_DVR_ERR_NTP_INTERVAL_TIME 1444 NTP Interval Time error.
NET_DVR_ERR_NETWORK_CARD_ 1445 Network Card Num error.
NUM

465
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_DEFAULT_ROUTE 1446 Default Route error.
NET_DVR_ERR_BONDING_WORK_ 1447 Banding Work Mode error.
MODE
NET_DVR_ERR_SLAVE_CARD 1448 Slave Card error.
NET_DVR_ERR_PRIMARY_CARD 1449 Primary Card error.
NET_DVR_ERR_DHCP_PPOE_WORK 1450 DHCP and PPOE not Meanwhile start.
NET_DVR_ERR_NET_INTERFACE 1451 Net Interface invalid.
NET_DVR_ERR_MTU 1452 Invalid MTU parameters.
NET_DVR_ERR_NETMASK 1453 Netmask address invalid.
NET_DVR_ERR_IP_INVALID 1454 IP address invalid.
NET_DVR_ERR_MULTICAST_IP_ 1455 Multicast IP address invalid.
INVALID
NET_DVR_ERR_GATEWAY_INVALID 1456 Gateway address invalid.
NET_DVR_ERR_DNS_INVALID 1457 DNS Param invalid.
NET_DVR_ERR_ALARMHOST_IP_ 1458 AlarmHost IP invalid.
INVALID
NET_DVR_ERR_IP_CONFLICT 1459 IP address Conflict.
NET_DVR_ERR_NETWORK_SEGMENT 1460 IP not support Multi Network
segment.
NET_DVR_ERR_NETPORT 1461 NetPort error.
NET_DVR_ERR_PPPOE_NOSUPPORT 1462 PPPoE is not supported.
NET_DVR_ERR_DOMAINNAME_ 1463 Not Support Domain Name.
NOSUPPORT
NET_DVR_ERR_NO_SPEED 1464 Speed Not Enabled.
NET_DVR_ERR_IOSTATUS_INVALID 1465 IO Status invalid.
NET_DVR_ERR_BURST_INTERVAL_ 1466 Burst Interval invalid.
INVALID
NET_DVR_ERR_RESERVE_MODE 1467 Reserve Mode invalid.
NET_DVR_ERR_LANE_NO 1468 Lane No error.
NET_DVR_ERR_COIL_AREA_TYPE 1469 Coil Area Type error.

466
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_TRIGGER_AREA_ 1470 Trigger Area Param error.
PARAM
NET_DVR_ERR_SPEED_LIMIT_PARAM 1471 Speed Limit Param error.
NET_DVR_ERR_LANE_PROTOCOL_ 1472 Lane Protocol Type error.
TYPE
NET_DVR_ERR_INTERVAL_TYPE 1473 Capture Interval Type error.
NET_DVR_ERR_INTERVAL_DISTANCE 1474 Capture Interval Distance error.
NET_DVR_ERR_RS485_ASSOCIATE_ 1475 Rs485 Associate DevType error.
DEVTYPE
NET_DVR_ERR_RS485_ASSOCIATE_ 1476 Rs485 Associate LaneNo error.
LANENO
NET_DVR_ERR_LANENO_ASSOCIATE_ 1477 LaneNo Associate MulitRs485 error.
MULTIRS485
NET_DVR_ERR_LIGHT_DETECTION_ 1478 Light Detection Region error.
REGION
NET_DVR_ERR_DN2D_NOSUPPORT 1479 UnSupport Capture Frame 2D Noise
Reduction.
NET_DVR_ERR_IRISMODE_ 1480 UnSupport scene Mode.
NOSUPPORT
NET_DVR_ERR_WB_NOSUPPORT 1481 UnSupport White Balance Mode.
NET_DVR_ERR_IO_EFFECTIVENESS 1482 IO Effectiveness invalid.
NET_DVR_ERR_LIGHTNO_MAX 1483 Access Detector Lights Red / Yellow
Overrun.
NET_DVR_ERR_LIGHTNO_CONFLICT 1484 Access Detector Lights Red / Yellow
Conflict.
NET_DVR_ERR_CANCEL_LINE 1485 Trigger straight line error.
NET_DVR_ERR_STOP_LINE 1486 Subject line area stop line error.
NET_DVR_ERR_RUSH_REDLIGHT_LINE 1487 Red light trigger lines error.
NET_DVR_ERR_IOOUTNO_MAX 1488 IO out port error.
NET_DVR_ERR_IOOUTNO_ 1489 IO out ahead time error.
AHEADTIME_MAX

467
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_IOOUTNO_ 1490 IO out inwork time error.
IOWORKTIME
NET_DVR_ERR_IOOUTNO_ 1491 IO out frequency multiplication error.
FREQMULTI
NET_DVR_ERR_IOOUTNO_DUTYRATE 1492 IO out duty rate error.
NET_DVR_ERR_VIDEO_WITH_ 1493 IO out work mode error.
EXPOSURE
NET_DVR_ERR_PLATE_BRIGHTNESS_ 1494 Plate enable in plate compensate
WITHOUT_FLASHDET mode on.
NET_DVR_ERR_RECOGNIZE_TYPE_ 1495 Recognize Type error.
PARAM
NET_DVR_ERR_PALTE_RECOGNIZE_ 1496 Plate Recognize Area Param error.
AREA_PARAM
NET_DVR_ERR_PORT_CONFLICT 1497 Port Conflict.
NET_DVR_ERR_LOOP_IP 1498 IP cannot be the loopback address.
NET_DVR_ERR_DRIVELINE_SENSITIVE 1499 Driveline sensitivity error.
NET_ERR_VQD_TIME_CONFLICT 1500 The time period conflict.
NET_ERR_VQD_PLAN_NO_EXIST 1501 The diagnostic plan of VQD dese not
exist.
NET_ERR_VQD_CHAN_NO_EXIST 1502 The channel dese not exist.
NET_ERR_VQD_CHAN_MAX 1503 The total number of VQD plans
exceeds the max limit.
NET_ERR_VQD_TASK_MAX 1504 The total number of VQD tasks
exceeds the max limit.
NET_DVR_ERR_EXCEED_MAX_ 1600 Capture times exceed 2 in flash mode.
CAPTURE_TIMES
NET_DVR_ERR_REDAR_TYPE_ 1601 Radar type conflict.
CONFLICT
NET_DVR_ERR_LICENSE_PLATE_NULL 1602 The license plate is null.
NET_DVR_ERR_WRITE_DATABASE 1603 Failed to write data into the database.
NET_DVR_ERR_LICENSE_EFFECTIVE_ 1604 The effective time of license plate
TIME error.

468
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_PRERECORDED_ 1605 The pre recorded start time is greater
STARTTIME_LONG than the number of illegal capture.
NET_DVR_ERR_TRIGGER_RULE_LINE 1606 Trigger rule line error.
NET_DVR_ERR_LEFTRIGHT_ 1607 Left and right trigger line is not
TRIGGERLINE_NOTVERTICAL vertical.
NET_DVR_ERR_FLASH_LAMP_MODE 1608 Flash lamp mode error.
NET_DVR_ERR_ILLEGAL_SNAPSHOT_ 1609 Illegal capture number error.
NUM
NET_DVR_ERR_ILLEGAL_DETECTION_ 1610 Illegal detection type error.
TYPE
NET_DVR_ERR_POSITIVEBACK_ 1611 Positive back to trigger line height
TRIGGERLINE_HIGH error.
NET_DVR_ERR_MIXEDMODE_ 1612 Mixed mode only supports capture
CAPTYPE_ALLTARGETS type all targets.
NET_DVR_ERR_CARSIGNSPEED_ 1613 Car sign speed greater than speed
GREATERTHAN_LIMITSPEED limit value.
NET_DVR_ERR_BIGCARSIGNSPEED_ 1614 Big car sign speed limit greater than
GREATERTHAN_LIMITSPEED speed limit value.
NET_DVR_ERR_BIGCARSIGNSPEED_ 1615 Big car sign speed limit is greater than
GREATERTHAN_CARSIGNSPEED the car sign speed limit value.
NET_DVR_ERR_BIGCARLIMITSPEED_ 1616 Big car speed limit value is greater
GREATERTHAN_CARLIMITSPEED than the car speed limit value.
NET_DVR_ERR_ 1617 Big car low speed limit value is greater
BIGCARLOWSPEEDLIMIT_ than the car low speed limit value.
GREATERTHAN_CARLOWSPEEDLIMIT
NET_DVR_ERR_CARLIMITSPEED_ 1618 Car speed limit greater than exception
GREATERTHAN_EXCEPHIGHSPEED high speed value.
NET_DVR_ERR_BIGCARLIMITSPEED_ 1619 Big car speed limit greater than
GREATERTHAN_EXCEPHIGHSPEED exception high speed value.
NET_DVR_ERR_STOPLINE_ 1620 Stopping more than straight lines
MORETHAN_TRIGGERLINE trigger lines.
NET_ERR_TIME_OVERLAP 1900 Time periods overlap
NET_ERR_HOLIDAY_PLAN_OVERLAP 1901 Holiday plan overlap

469
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_ERR_CARDNO_NOT_SORT 1902 Card number is not sorted
NET_ERR_CARDNO_NOT_EXIST 1903 Card number does not exist
NET_ERR_ILLEGAL_CARDNO 1904 Card number error
NET_ERR_ZONE_ALARM 1905 Arming region is in arming status
(parameter cannot be modified)
NET_ERR_ZONE_OPERATION_NOT_ 1906 Arming region does not support the
SUPPORT operation
NET_ERR_INTERLOCK_ANTI_ 1907 Interlock and anti-passback
CONFLICT configuration conflict
NET_ERR_DEVICE_CARD_FULL 1908 Card full (return after card reached
10,000)
NET_ERR_HOLIDAY_GROUP_ 1909 Failed to download holiday group
DOWNLOAD
NET_ERR_LOCAL_CONTROL_OFF 1910 Distributed access controller offline
NET_ERR_LOCAL_CONTROL_DISADD 1911 Distributed access controller is not
added
NET_ERR_LOCAL_CONTROL_HASADD 1912 Distributed access controller is added
NET_ERR_LOCAL_CONTROL_ 1913 Conflict with added distributed access
DOORNO_CONFLICT controller
NET_ERR_LOCAL_CONTROL_ 1914 Distributed access controller
COMMUNICATION_FAIL communication failed
NET_ERR_OPERAND_INEXISTENCE 1915 Operation object does not exist
(operation to door, alarm output,
alarm input, return when the object is
not added)
NET_ERR_LOCAL_CONTROL_OVER_ 1916 Distributed access controller
LIMIT exceeded device capability upper limit
NET_ERR_DOOR_OVER_LIMIT 1917 Door exceeded device capability
upper limit
NET_ERR_ALARM_OVER_LIMIT 1918 Alarm input and output exceeded
device capability upper limit
NET_ERR_LOCAL_CONTROL_ 1919 Distributed access controller address
ADDRESS_INCONFORMITY_TYPE does not match with type

470
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_ERR_NOT_SUPPORT_ONE_ 1920 not support one person multi-card
MORE_CARD
NET_ERR_DELETE_NO_EXISTENCE_ 1921 The face picture does not exist.
FACE
NET_ERR_DOOR_SPECIAL_ 1922 Repeated door door duress code, the
PASSWORD_REPEAT super password, or the dismiss code.
NET_ERR_AUTH_CODE_REPEAT 1923 Repeated device authentication code
NET_ERR_DEPLOY_EXCEED_MAX 1924 No more devices can be armed.
NET_ERR_NOT_SUPPORT_DEL_FP_ 1925 The fingerprint module does not
BY_ID support deleting fingerprint by finger
ID.
NET_ERR_TIME_RANGE 1926 Invalid range of the effective period.
NET_ERR_CAPTURE_TIMEOUT 1927 Collection timed out.
NET_ERR_LOW_SCORE 1928 Low quality of collected data.
NET_ERR_OFFLINE_CAPTURING 1929 The device is collecting data offline
and cannot respond.
NET_DVR_ERR_OUTDOOR_ 1950 Communication exception with
COMMUNICATION outdoor terminal
NET_DVR_ERR_ROOMNO_ 1951 Room number is not set
UNDEFINED
NET_DVR_ERR_NO_CALLING 1952 No call
NET_DVR_ERR_RINGING 1953 Ringing
NET_DVR_ERR_IS_CALLING_NOW 1954 Call in progress
NET_DVR_ERR_LOCK_PASSWORD_ 1955 Incorrect smart lock password
WRONG
NET_DVR_ERR_CONTROL_LOCK_ 1956 Lock control failure
FAILURE
NET_DVR_ERR_CONTROL_LOCK_ 1957 Lock control timed out
OVERTIME
NET_DVR_ERR_LOCK_DEVICE_BUSY 1958 Smart lock device busy
NET_DVR_ERR_UNOPEN_REMOTE_ 1959 Remote lock control not enabled
LOCK_FUNCTION

471
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_FILE_NOT_COMPLETE 2100 Downloaded file is incomplete
NET_DVR_ERR_IPC_EXIST 2101 The camera already exists
NET_DVR_ERR_ADD_IPC 2102 Camera has been added to the
channel
NET_DVR_ERR_OUT_OF_RES 2103 Not enough network bandwidth
NET_DVR_ERR_CONFLICT_TO_ 2104 IP address of camera conflicts with
LOCALIP that of DVR
NET_DVR_ERR_IP_SET 2105 Invalid IP address
NET_DVR_ERR_PORT_SET 2106 Invalid port number
NET_ERR_WAN_NOTSUPPORT 2107 Not in the same LAN, cannot set
security question or export GUID file
NET_ERR_MUTEX_FUNCTION 2108 Mutually exclusive function
NET_ERR_QUESTION_CONFIGNUM 2109 Error in number of security question
configurations
NET_ERR_FACECHAN_NORESOURCE 2110 All the face VCA channels are
occupied.
NET_ERR_DATA_CALLBACK 2111 Data is calling back.
NET_ERR_ATM_VCA_CHAN_IS_ 2112 The VCA channel is already linked.
RELATED
NET_ERR_ATM_VCA_CHAN_IS_ 2113 The VCA channel is already overlayed.
OVERLAPED
NET_ERR _FACE_CHAN_UNOVERLAP_ 2114 The face channels cannot be
EACH_OTHER overlayed.
NET_DVR_SMD_ENCODING_ 2116 Insufficient SMD encoding resource
NORESOURSE
NET_DVR_SMD_DECODING_ 2117 Insufficient SMD decoding resource
NORESOURSE
NET_DVR_FACELIB_DATA_ 2118 Face picture library data is in
PROCESSING processing
NET_DVR_ERR_LARGE_TIME_ 2119 There is a great time difference
DIFFRENCE between device and server.
NET_DVR_NO_SUPPORT_WITH_ 2120 It is not supported. Playback is
PLAYBACK enabled.

472
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_CHANNEL_NO_SUPPORT_ 2121 It is not supported. SMD of channel is
WITH_SMD enabled.
NET_DVR_CHANNEL_NO_SUPPORT_ 2122 It is not supported. Face capture of
WITH_FD channel is enabled.
NET_DVR_ILLEGAL_PHONE_NUMBER 2123 Invalid telephone number
NET_DVR_ILLEGAL_CERITIFICATE_ 2124 Invalid ID No.
NUMBER
NET_DVR_ERR_CHANNEL_ 2125 The channel resolution is not
RESOLUTION_NO_SUPPORT supported
NET_DVR_ERR_CHANNEL_ 2126 The channel encoding format is not
COMPRESSION_NO_SUPPORT supported
NET_DVR_ERR_CLUSTER_DEVICE_ 2127 Deleting is not allowed. The number
TOO_LESS of devices is not enough
NET_DVR_ERR_CLUSTER_DEL_ 2128 Deleting is not allowed. The device is
DEVICE_CM_PLAYLOAD cluster host.
NET_DVR_ERR_CLUSTER_DEVNUM_ 2129 No more devices can be added.
OVER_UPPER_LIMIT
NET_DVR_ERR_CLUSTER_DEVICE_ 2130 Device type mismatched.
TYPE_INCONFORMITY
NET_DVR_ERR_CLUSTER_DEVICE_ 2131 Device version mismatched.
VERSION_INCONFORMITY
NET_DVR_ERR_CLUSTER_IP_ 2132 Cluster system IP address conflict:
CONFLICT ipv4 address conflict, invalid ipv6.
NET_DVR_ERR_CLUSTER_IP_INVALID 2133 Invalid cluster system IP address:
invalid ipv4, invalid ipv6.
NET_DVR_ERR_CLUSTER_PORT_ 2134 Cluster system port conflict
CONFLICT
NET_DVR_ERR_CLUSTER_PORT_ 2135 Invalid cluster system port
INVALID
NET_DVR_ERR_CLUSTER_ 2136 Invalid user name or password
USERNAEM_OR_PASSWORD_INVALID
NET_DVR_ERR_CLUSTER_DEVICE_ 2137 The device already exists.
ALREADY_EXIST

473
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_CLUSTER_DEVICE_ 2138 The device does not exist.
NOT_EXIST
NET_DVR_ERR_CLUSTER_NON_ 2139 The device working mode is not the
CLUSTER_MODE cluster mode .
NET_DVR_ERR_CLUSTER_IP_NOT_ 2140 IP addresses are in different LAN.
SAME_LAN Building cluster or extending capacity
for NVRs in different LAN is not
allowed.
NET_DVR_ERR_IDENTITY_KEY 2147 Incorrect interaction password
NET_DVR_MISSING_IDENTITY_KEY 2148 Interaction password is missing
NET_DVR_ERR_CAPTURE_PACKAGE_ 2141 Capturing packets failed.
FAILED
NET_DVR_ERR_CAPTURE_PACKAGE_ 2142 Capturing packet.
PROCESSING
NET_DVR_ERR_SAFETY_HELMET_NO_ 2143 No enough hard hat detection
RESOURCE resource.
NET_DVR_NO_SUPPORT_WITH_ 2144 This function is not supported. Video
ABSTRACT synopsis is already enabled.
NET_DVR_INSUFFICIENT_DEEP_ 2146 No more deep learning resources can
LEARNING_RESOURCES be added.
NET_DVR_NO_SUPPORT_WITH_ 2149 People gathering density is enabled, it
PERSON_DENSITY_DETECT is not supported
NET_DVR_IPC_RESOLUTION_ 2150 The network camera resolution is too
OVERFLOW large
NET_DVR_IPC_BITRATE_OVERFLOW 2151 The network camera bitrate is too
large
NET_DVR_ERR_INVALID_TASKID 2152 Invalid taskID
NET_DVR_PANEL_MODE_NOT_ 2153 The ATM panel mode is not
CONFIG configured.
NET_DVR_NO_HUMAN_ENGINES_ 2154 No enough engine resource
RESOURCE
NET_DVR_ERR_TASK_NUMBER_ 2155 No more task data is allowed
OVERFLOW

474
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_ERR_COLLISION_TIME_ 2156 Collision time is over the limit
OVERFLOW
NET_DVR_ERR_EVENT_NOTSUPPORT 2159 Subscribing alarm/event is not
supported.
NET_DVR_IPC_NUM_REACHES_LIMIT 2184 The max. number of network camera
channels reached.
NET_DVR_IOT_NUM_REACHES_LIMIT 2185 The max. number of IoT channels
reached
NET_DVR_IOT_CHANNEL_DEVICE_ 2186 Device of the IoT channel already
EXIST exists.
NET_DVR_IOT_CHANNEL_DEVICE_ 2187 Device of the IoT channel does not
NOT_EXIST exist.
NET_DVR_INVALID_IOT_PROTOCOL_ 2188 Invalid IoT protocol type
TYPE
NET_DVR_INVALID_EZVIZ_SECRET_ 2189 Invalid verification code
KEY
NET_DVR_DUPLICATE_IOT_DEVICE 2190 Duplicated IoT device
NET_DVR_ERROR_NEED_DOUBLE_ 2206 Double verification is required
VERIFICATION
NET_DVR_NO_DOUBLE_ 2207 No double verification user
VERIFICATION_USER
NET_DVR_TIMESPAN_NUM_OVER_ 2209 Max. number of time buckets reached
LIMIT
NET_DVR_CHANNEL_NUM_OVER_ 2210 Max. number of channels reached
LIMIT
NET_DVR_NO_SEARCH_ID_ 2211 Insufficient searchID resources
RESOURCE
NET_DVR_SWITCH_TIMEDIFF_LESS_ 2249 Time difference between power on
LIMIT and off should be less than 10
minutes.
NET_DVR_NO_SUPPORT_DELETE_ 2262 Deleting stranger library is not
STRANGER_LIB supported
NET_DVR_NO_SUPPORT_CREATE_ 2263 Creating stranger library is not
STRANGER_LIB supported

475
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_SSD_FILE_SYSTEM_ERROR 2266 SSD file system error
NET_DVR_INSUFFICIENT_SSD__FOR_ 2267 Insufficient SSD space for person
FPD frequency detection
NET_DVR_ERR_NOTSUPPORT_ 3001 Device does not support deicing
DEICING function under current status.(Deicing
function is only supported under the
power status of POE+, AC24V, and
DC12V).
NET_DVR_ERR_THERMENABLE_ 3002 Temperature measurement function
CLOSE is not enabled. (The enable function
in NET_DVR_THERMOMETRY_
BASICPARAM is not turned on)
NET_DVR_ERR_PANORAMIC_LIMIT_ 3004 Panoramic map and limit cannot be
OPERATED operated at same time
NET_DVR_ERR_SMARTH264_ROI_ 3005 SmartH264 and ROI cannot be
OPERATED enabled at the same time.
NET_DVR_ERR_RULENUM_LIMIT 3006 No more rules can be added.
NET_DVR_ERR_LASER_DEICING_ 3007 Laser and deicing function cannot be
OPERATED enabled at the same time.
NET_DVR_ERR_OFFDIGITALZOOM_ 3008 Please disable the digital zoom
OR_MINZOOMLIMIT function or set the zoom limit to the
minimum value. Otherwise, when
enabling smoke and fire detection,
behavior analysis, ship detection,
defective point correction,
temperature measurement, smoke
and fire shielding function, this error
code will be prompted.
NET_DVR_SYNCHRONIZEFOV_ERROR 3010 Field of view synchronization failed.
NET_DVR_RULE_SHIELDMASK_ 3013 The rule region conflicts with the
CONFLICT_ERROR shielded area.
NET_DVR_ERR_NO_SAFETY_HELMET_ 3501 The hard hat detection area is not
REGION configured.
NET_DVR_ERR_UNCLOSED_SAFETY_ 3502 The hard hat detection is enabled.
HELMET

476
 Device Network SDK (Access Control on Person) Developer Guide

RTSP Communication Library Related Errors

Error Name Error Code Error Description

NET_DVR_RTSP_ERROR_ 401 Authentication failed: if server
NOENOUGHPRI returns 401, it will change to this
error code
NET_DVR_RTSP_ERROR_ALLOC_ 402 Failed to allocate the resource
RESOURCE
NET_DVR_RTSP_ERROR_PARAMETER 403 Parameter error
NET_DVR_RTSP_ERROR_NO_URL 404 The assigned URL does not exist:
when the server returns 404, SDK
turns to this error code. E.g. the
channel is not available, or the
channel does not support sub
stream
NET_DVR_RTSP_ERROR_FORCE_STOP 406 The user forces to exit midway
NET_DVR_RTSP_GETPORTFAILED 407 RTSP port getting error.
NET_DVR_RTSP_DESCRIBERROR 410 RTSP DECRIBE communicate error
NET_DVR_RTSP_ 411 Sending "RTSP DECRIBE" is timeout.
DESCRIBESENDTIMEOUT
NET_DVR_RTSP_DESCRIBESENDERROR 412 Failed to send "RTSP DECRIBE".
NET_DVR_RTSP_ 413 Receiving "RTSP DECRIBE" is
DESCRIBERECVTIMEOUT timeout.
NET_DVR_RTSP_ 414 Receiving data of "RTSP DECRIBE"
DESCRIBERECVDATALOST error.
NET_DVR_RTSP_DESCRIBERECVERROR 415 Failed to receive "RTSP DECRIBE".
NET_DVR_RTSP_DESCRIBESERVERERR 416 "RTSP DECRIBE, the device returns
the error code: 501 (failed to
allocate the resource in the device)
NET_DVR_RTSP_SETUPERROR 420 (or 419), RTSP SETUP interaction
error. Generally, it is that the
address(URL) returned by the
device is not accessible, or it is
rejected by the server
NET_DVR_RTSP_SETUPSENDTIMEOUT 421 Sending "RTSP SETUP" is timeout.
NET_DVR_RTSP_SETUPSENDERROR 422 Sending "RTSP SETUP" error.

477
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_DVR_RTSP_SETUPRECVTIMEOUT 423 Receiving "RTSP SETUP" is timeout.
NET_DVR_RTSP_SETUPRECVDATALOST 424 Receiving data of "RTSP SETUP"
error.
NET_DVR_RTSP_SETUPRECVERROR 425 Failed to receive "RTSP SETUP".
NET_DVR_RTSP_OVER_MAX_CHAN 426 "RTSP SETUP" device returns the
error that values 401 or 501. It
exceeds the max connection
number.
NET_DVR_RTSP_PLAYERROR 430 RTSP PLAY interaction error.
NET_DVR_RTSP_PLAYSENDTIMEOUT 431 Sending "RTSP PLAY" is timeout.
NET_DVR_RTSP_PLAYSENDERROR 432 Sending "RTSP PLAY" error.
NET_DVR_RTSP_PLAYRECVTIMEOUT 433 Receiving "RTSP PLAY" is timeout.
NET_DVR_RTSP_PLAYRECVDATALOST 434 Receiving data of "RTSP PLAY" error.
NET_DVR_RTSP_PLAYRECVERROR 435 Failed to receive "RTSP PLAY".
NET_DVR_RTSP_PLAYSERVERERR 436 "RTSP PLAY" device returns the
error that values 401 or 501.
NET_DVR_RTSP_TEARDOWNERROR 440 RTSP TEARDOWN interaction error.
NET_DVR_RTSP_ 441 Sending "RTSP TEARDOWN" is
TEARDOWNSENDTIMEOUT timeout.
NET_DVR_RTSP_ 442 Sending "RTSP TEARDOWN" error.
TEARDOWNSENDERROR
NET_DVR_RTSP_ 443 Receiving "RTSP TEARDOWN" is
TEARDOWNRECVTIMEOUT timeout.
NET_DVR_RTSP_ 444 Receiving data of "RTSP
TEARDOWNRECVDATALOST TEARDOWN" error.
NET_DVR_RTSP_ 445 Failed to receive "RTSP
TEARDOWNRECVERROR TEARDOWN".
NET_DVR_RTSP_ 446 "RTSP TEARDOWN" device returns
TEARDOWNSERVERERR the error that values 401 or 501.

478
 Device Network SDK (Access Control on Person) Developer Guide

Software Decoding Library Related Errors

Error Name Error Code Error Description

NET_PLAYM4_NOERROR 500 No error.
NET_PLAYM4_PARA_OVER 501 Input parameter is invalid.
NET_PLAYM4_ORDER_ERROR 502 API calling order error.
NET_PLAYM4_TIMER_ERROR 503 Failed to create multimedia clock.
NET_PLAYM4_DEC_VIDEO_ERROR 504 Failed to decode video data.
NET_PLAYM4_DEC_AUDIO_ERROR 505 Failed to decode audio data.
NET_PLAYM4_ALLOC_MEMORY_ 506 Failed to allocate memory.
ERROR
NET_PLAYM4_OPEN_FILE_ERROR 507 Failed to open the file.
NET_PLAYM4_CREATE_OBJ_ERROR 508 Failed to create thread event.
NET_PLAYM4_CREATE_DDRAW_ 509 Failed to create DirectDraw object.
ERROR
NET_PLAYM4_CREATE_OFFSCREEN_ 510 Failed to create backstage cache for
ERROR OFFSCREEN mode.
NET_PLAYM4_BUF_OVER 511 Buffer overflow, failed to input stream.
NET_PLAYM4_CREATE_SOUND_ 512 Failed to create audio equipment.
ERROR
NET_PLAYM4_SET_VOLUME_ 513 Failed to set the volume.
ERROR
NET_PLAYM4_SUPPORT_FILE_ONLY 514 This API can be called only for file
playback mode.
NET_PLAYM4_SUPPORT_STREAM_ 515 This API can be called only when playing
ONLY stream.
NET_PLAYM4_SYS_NOT_SUPPORT 516 Not support by the system. Decoder can
only work on the system above Pentium
3.
NET_PLAYM4_FILEHEADER_ 517 There is no file header.
UNKNOWN
NET_PLAYM4_VERSION_ 518 The version mismatch between decoder
INCORRECT and encoder.

479
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_PLAYM4_INIT_DECODER_ 519 Failed to initialize the decoder.
ERROR
NET_PLAYM4_CHECK_FILE_ERROR 520 The file is too short, or the stream data
is unknown.
NET_PLAYM4_INIT_TIMER_ERROR 521 Failed to initialize multimedia clock.
NET_PLAYM4_BLT_ERROR 522 BLT failure.
NET_PLAYM4_UPDATE_ERROR 523 Failed to update overlay surface
NET_PLAYM4_OPEN_FILE_ERROR_ 524 Failed to open video & audio stream
MULTI file.
NET_PLAYM4_OPEN_FILE_ERROR_ 525 Failed to open video stream file.
VIDEO
NET_PLAYM4_JPEG_COMPRESS_ 526 JPEG compression error.
ERROR
NET_PLAYM4_EXTRACT_NOT_ 527 Don't support the version of this file.
SUPPORT
NET_PLAYM4_EXTRACT_DATA_ 528 Extract video data failed.
ERROR

Container Format Conversion Library Related Errors

Error Name Error Code Error Description

NET_CONVERT_ERROR_NOT_ 581 This container format is not supported.
SUPPORT

Two Way Audio Library Related Errors

Error Name Error Code Error Description

NET_AUDIOINTERCOM_OK 600 No error.
NET_AUDIOINTECOM_ERR_NOTSUPORT 601 Not support.
NET_AUDIOINTECOM_ERR_ALLOC_MEMERY 602 Memory allocation error.
NET_AUDIOINTECOM_ERR_PARAMETER 603 Parameter error.
NET_AUDIOINTECOM_ERR_CALL_ORDER 604 API calling order error.
NET_AUDIOINTECOM_ERR_FIND_DEVICE 605 No audio device
NET_AUDIOINTECOM_ERR_OPEN_DEVICE 606 Failed to open the audio device

480
 Device Network SDK (Access Control on Person) Developer Guide

Error Name Error Code Error Description

NET_AUDIOINTECOM_ERR_NO_CONTEXT 607 Context error.
NET_AUDIOINTECOM_ERR_NO_WAVFILE 608 WAV file error.
NET_AUDIOINTECOM_ERR_INVALID_TYPE 609 The type of WAV parameter is
invalid
NET_AUDIOINTECOM_ERR_ENCODE_FAIL 610 Failed to encode data
NET_AUDIOINTECOM_ERR_DECODE_FAIL 611 Failed to decode data
NET_AUDIOINTECOM_ERR_NO_PLAYBACK 612 Failed to play audio
NET_AUDIOINTECOM_ERR_DENOISE_FAIL 613 Failed to denoise
NET_AUDIOINTECOM_ERR_UNKOWN 619 Unknown

QoS Stream Control Library Related Errors

Error Name Error Code Error Description

NET_QOS_ERR_SCHEDPARAMS_BAD_ 678 Incorrect predefined minimum
MINIMUM_INTERVAL interval.
NET_QOS_ERR_SCHEDPARAMS_BAD_ 679 Incorrect predefined score.
FRACTION
NET_QOS_ERR_SCHEDPARAMS_INVALID_ 680 Invalid predefined bandwidth.
BANDWIDTH
NET_QOS_ERR_PACKET_TOO_BIG 687 The packet size is too large.
NET_QOS_ERR_PACKET_LENGTH 688 Invalid packet size.
NET_QOS_ERR_PACKET_VERSION 689 Incorrect packet versio
information.
NET_QOS_ERR_PACKET_UNKNOW 690 Unknown packet.
NET_QOS_ERR_OUTOFMEM 695 Out of memory.
NET_QOS_ERR_LIB_NOT_INITIALIZED 696 The library is not initialized.
NET_QOS_ERR_SESSION_NOT_FOUND 697 No session found.
NET_QOS_ERR_INVALID_ARGUMENTS 698 Invalid parameters.
NET_QOS_ERROR 699 QoS Stream Control Library
error.
NET_QOS_OK 700 No error.

481
 Device Network SDK (Access Control on Person) Developer Guide

NPQ (Network Protocol Quality) Related Error

Error Name Error Code Error Description

NET_ERR_NPQ_PARAM 8001 NPQ library: Incorrect parameter.
NET_ERR_NPQ_SYSTEM 8002 NPQ library: Operating system error.
NET_ERR_NPQ_GENRAL 8003 NPQ library: Internal error.
NET_ERR_NPQ_PRECONDITION 8004 NPQ library: Calling sequence error.
NET_ERR_NPQ_NOTSUPPORT 8005 NPQ library: This function is not
supported.
NET_ERR_NPQ_NOTCALLBACK 8100 No data is called back.
NET_ERR_NPQ_LOADLIB 8101 Loading NPQ library failed.
NET_ERR_NPQ_STEAM_CLOSE 8104 The NPQ function of this stream is not
enabled.
NET_ERR_NPQ_MAX_LINK 8110 No more streaming channel's NPQ
function can be enabled.
NET_ERR_NPQ_STREAM_CFG_ 8111 The configured encoding parameters
CONFLICT conflicted.

A.4 HCNetSDK Log Types

The logs generated by the devices during the HCNetSDK integration are classified as five major
types, i.e., alarm log (MAJOR_ALARM-01), exception log (MAJOR_EXCEPTION-0x2), operation log
(MAJOR_OPERATION-0x3), additional information log (MAJOR_INFORMATION-0x4), and event log
(MAJOR_EVENT-0x5). Each major log type corresponds to multiple minor types, see details below.

MAJOR_ALARM
Table A-1 Minor Types of Alarm Log
Log Minor Type Value Description
MINOR_ALARM_IN 0x1 Alarm Input
MINOR_ALARM_OUT 0x2 Alarm output
MINOR_MOTDET_START 0x3 Motion detection alarm started
MINOR_MOTDET_STOP 0x4 Motion detection alarm ended
MINOR_HIDE_ALARM_START 0x5 Tampering alarm started
MINOR_HIDE_ALARM_STOP 0x6 Tampering alarm ended

482
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_VCA_ALARM_START 0x7 VCA alarm started
MINOR_VCA_ALARM_STOP 0x8 VCA alarm ended
MINOR_ITS_ALARM_START 0x09 Traffic event alarm started
MINOR_ITS_ALARM_STOP 0x0a Traffic event alarm ended
MINOR_NETALARM_START 0x0b Network alarm started
MINOR_NETALARM_STOP 0x0c Network alarm ended
MINOR_NETALARM_RESUME 0x0d Network alarm recovery
MINOR_WIRELESS_ALARM_START 0x0e Wireless alarm started
MINOR_WIRELESS_ALARM_STOP 0x0f Wireless alarm ended
MINOR_PIR_ALARM_START 0x10 Human induction alarm started
MINOR_PIR_ALARM_STOP 0x11 Human induction alarm ended
MINOR_CALLHELP_ALARM_START 0x12 Emergency alarm started
MINOR_CALLHELP_ALARM_STOP 0x13 Emergency alarm ended
MINOR_DETECTFACE_ALARM_START 0x16 Face detection alarm started
MINOR_DETECTFACE_ALARM_STOP 0x17 Face detection alarm ended
MINOR_VCA_SECNECHANGE_ 0x1a Scene change detection alarm
DETECTION
MINOR_SMART_REGION_EXITING_ 0x1b Region exiting detection started
BEGIN
MINOR_SMART_REGION_EXITING_ 0x1c Region exiting detection ended
END
MINOR_SMART_LOITERING_BEGIN 0x1d Loitering detection started
MINOR_SMART_LOITERING_END 0x1e Loitering detection ended
MINOR_DREDGERDETECTION _ 0x11a Dredger detection alarm
ALARM
MINOR_VCA_ALARM_LINE_ 0x20 Line crossing detection started
DETECTION_BEGIN
MINOR_VCA_ALARM_LINE_ 0x21 Line crossing detection ended
DETECTION_END
MINOR_VCA_ALARM_INTRUDE_ 0x22 Intrusion detection started
BEGIN

483
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_VCA_ALARM_INTRUDE_END 0x23 Intrusion detection ended
MINOR_VCA_ALARM_AUDIOINPUT 0x24 Audio loss detection
MINOR_VCA_ALARM_ 0x25 Audio exception detection
AUDIOABNORMAL
MINOR_VCA_DEFOCUS_DETECTION_ 0x26 Defocus detection started
BEGIN
MINOR_VCA_DEFOCUS_DETECTION_ 0x27 Defocus detection ended
END
MINOR_VCA_FACE_ALARM_BEGIN 0x29 Face detection started
MINOR_SMART_REGION_ENTRANCE_ 0x2a Region entrance detection started
BEGIN
MINOR_SMART_REGION_ENTRANCE_ 0x2b Region entrance detection ended
END
MINOR_SMART_PEOPLE_ 0x2c People gathering detection started
GATHERING_BEGIN
MINOR_SMART_PEOPLE_ 0x2d People gathering detection ended
GATHERING_END
MINOR_SMART_FAST_MOVING_ 0x2e Fast moving detection started
BEGIN
MINOR_SMART_FAST_MOVING_END 0x2f Fast moving detection ended
MINOR_VCA_FACE_ALARM_END 0x30 Face detection ended
MINOR_VCA_SCENE_CHANGE_ 0x31 Scene change detection started
ALARM_BEGIN
MINOR_VCA_SCENE_CHANGE_ 0x32 Scene change detection ended
ALARM_END
MINOR_VCA_ALARM_AUDIOINPUT_ 0x33 Audio loss detection started
BEGIN
MINOR_VCA_ALARM_AUDIOINPUT_ 0x34 Audio loss detection ended
END
MINOR_VCA_ALARM_ 0x35 Sudden change of sound intensity
AUDIOABNORMAL_BEGIN detection started
MINOR_VCA_ALARM_ 0x36 Sudden change of sound intensity
AUDIOABNORMAL_END detection ended

484
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_VCA_ALARM_ 0x39 Sudden decrease of sound intensity
AUDIOSTEEPDROP detection
MINOR_SMART_PARKING_BEGIN 0x3c Parking detection started
MINOR_SMART_PARKING_END 0x3d Parking detection ended
MINOR_SMART_UNATTENDED_ 0x3e Unattended baggage detection
BAGGAGE_BEGIN started
MINOR_SMART_UNATTENDED_ 0x3f Unattended baggage detection ended
BAGGAGE_END
MINOR_SMART_OBJECT_REMOVAL_ 0x40 Object removal detection started
BEGIN
MINOR_SMART_OBJECT_REMOVAL_ 0x41 Object removal detection ended
END
MINOR_VCA_LEAVE_POSITION_START 0x42e Absence detection started
MINOR_VCA_LEAVE_POSITION_STOP 0x42f Absence detection ended
MINOR_VCA_PEOPLENUM_CHANGE_ 0x434 The people number change started
START
MINOR_VCA_PEOPLENUM_CHANGE_ 0x435 The people number change ended
STOP
MINOR_VCA_RUNNING_START 0x438 People running started
MINOR_VCA_RUNNING_STOP 0x439 People running ended
MINOR_VCA_VIOLENT_MOTION_ 0x43a Violent motion started
START
MINOR_VCA_VIOLENT_MOTION_ 0x43b Violent motion ended
STOP
MINOR_VCA_FAIL_DOWN_START 0x43c People falling started
MINOR_VCA_FAIL_DOWN_STOP 0x43d People falling ended
MINOR_VCA_RETENTION_START 0x43e Overstay detection started
MINOR_VCA_RETENTION_STOP 0x43f Overstay detection ended
MINOR_SMART_VEHICLE_ALARM_ 0x46 License plate detection started
START
MINOR_SMART_VEHICLE_ALARM_ 0x47 License plate detection ended
STOP

485
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_THERMAL_FIREDETECTION 0x48 Thermal imaging fire point detection
started
MINOR_THERMAL_FIREDETECTION_ 0x49 Thermal imaging fire point detection
END ended
MINOR_SMART_VANDALPROOF_ 0x50 Vandal-proof detection started
BEGIN
MINOR_SMART_VANDALPROOF_END 0x51 Vandal-proof detection ended
MINOR_FACESNAP_MATCH_ALARM_ 0x55 Face picture comparison alarm
START started
MINOR_FACESNAP_MATCH_ALARM_ 0x56 Face picture comparison alarm ended
STOP
MINOR_WHITELIST_FACESNAP_ 0x57 Face picture in whitelist comparison
MATCH_ALARM_START alarm started
MINOR_WHITELIST_FACESNAP_ 0x58 Face picture in whitelist comparison
MATCH_ALARM_STOP alarm ended
MINOR_THERMAL_SHIPSDETECTION 0x5a Thermal imaging ship detection
MINOR_THERMAL_THERMOMETRY_ 0x5b Thermal imaging temperature
EARLYWARNING_BEGIN measurement pre-alarm started
MINOR_THERMAL_THERMOMETRY_ 0x5c Thermal imaging temperature
EARLYWARNING_END measurement pre-alarm ended
MINOR_THERMAL_THERMOMETRY_ 0x5d Thermal imaging temperature
ALARM_BEGIN measurement alarm started
MINOR_THERMAL_THERMOMETRY_ 0x5e Thermal imaging temperature
ALARM_END measurement alarm ended
MINOR_THERMAL_THERMOMETRY_ 0x5f Thermal imaging temperature
DIFF_ALARM_BEGIN difference alarm started
MINOR_THERMAL_THERMOMETRY_ 0x60 Thermal imaging temperature
DIFF_ALARM_END difference alarm ended
MINOR_ FACE_THERMOMETRY_ 0x63 Body thermometry alarm
ALARM
MINOR_SAFETY_HELMET_ALARM_ 0x72 Hard hat detection alarm stated
START
MINOR_SAFETY_HELMET_ALARM_ 0x73 Hard hat detection alarm ended
STOP

486
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_HFPD_ALARM_START 0x74 Frequently appeared person
detection alarm started
MINOR_HFPD_ALARM_STOP 0x75 Frequently appeared person
detection alarm ended
MINOR_MIXED_TARGET_ALARM_ 0x76 Milti-target-type detection alarm
START started
MINOR_MIXED_TARGET_ALARM_ 0x77 Milti-target-type detection alarm
STOP ended
MINOR_VCA_GET_UP_ALARM_BEGIN 0x80 Getting up alarm started
MINOR_VCA_GET_UP_ALARM_END 0x81 Getting up alarm ended
MINOR_VCA_ADV_REACH_HEIGHT_ 0x82 Climbing alarm started
ALARM_BEGIN
MINOR_VCA_ADV_REACH_HEIGHT_ 0x83 Climbing alarm ended
ALARM_END
MINOR_VCA_TOILET_TARRY_ALARM_ 0x84 Toilet overtime alarm started
BEGIN
MINOR_VCA_TOILET_TARRY_ALARM_ 0x85 Toilet overtime alarm ended
END
MINOR_HUMAN_RECOGNITION_ 0x86 Target alarm started
ALARM_BEGIN
MINOR_HUMAN_RECOGNITION_ 0x87 Target alarm ended
ALARM_END
MINOR_ACCESS_CONTROLLER_ 0x100 Access controller event
EVENT
MINOR_VIDEO_INTERCOM_EVENT 0x101 Video intercom event
MINOR_GJD_EVENT 0x102 GJD security control panel event
MINOR_LUMINITE_EVENT 0x103 LUMINITE security control panel
event
MINOR_OPTEX_EVENT 0x104 OPTEX security control panel event
MINOR_CAMERA_DETECTOR_EVENT 0x105 Detector event
MINOR_SECURITY_CONTROL_PANEL_ 0x106 Hikvision security control panel event
EVENT
MINOR_LFPD_ALARM_START 0x124 Low frequency person alarm started

487
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LFPD_ALARM_STOP 0x125 Low frequency person alarm stopped
MINOR_ALARMIN_SHORT_CIRCUIT 0x400 Zone short circuited alarm
MINOR_ALARMIN_BROKEN_CIRCUIT 0x401 Zone disconnected alarm
MINOR_ALARMIN_EXCEPTION 0x402 Zone exception alarm
MINOR_ALARMIN_RESUME 0x403 Zone alarm recovery
MINOR_HOST_DESMANTLE_ALARM 0x404 Device anti-tamper alarm
MINOR_HOST_DESMANTLE_RESUME 0x405 Device anti-tamper recovery
MINOR_CARD_READER_DESMANTLE_ 0x406 Card reader anti-tamper alarm
ALARM
MINOR_CARD_READER_DESMANTLE_ 0x407 Card reader anti-tamper recovery
RESUME
MINOR_CASE_SENSOR_ALARM 0x408 Event input alarm
MINOR_CASE_SENSOR_RESUME 0x409 Event input recovery
MINOR_STRESS_ALARM 0x40a Duress alarm
MINOR_OFFLINE_ECENT_NEARLY_ 0x40b No memory alarm
FULL
MINOR_CARD_MAX_AUTHENTICATE_ 0x40c Card reading failure alarm
FAIL
MINOR_POS_START_ALARM 0x411 POS enabled
MINOR_POS_END_ALARM 0x412 POS disabled

MAJOR_EXCEPTION
Table A-2 Minor Types of Exception Log
Log Minor Type Value Description
MINOR_RAID_ERROR 0x20 RAID exception
MINOR_VI_LOST 0x21 Video loss
MINOR_ILLEGAL_ACCESS 0x22 Illegal login
MINOR_HD_FULL 0x23 HDD full
MINOR_HD_ERROR 0x24 HDD error
MINOR_DCD_LOST 0x25 MODEM offline (reserved)
MINOR_IP_CONFLICT 0x26 IP address conflicted

488
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_NET_BROKEN 0x27 Network disconnected
MINOR_REC_ERROR 0x28 Recording error
MINOR_IPC_NO_LINK 0x29 IPC connection exception
MINOR_VI_EXCEPTION 0x2a Video input exception (only for analog
channel)
MINOR_IPC_IP_CONFLICT 0x2b IP address conflicted of IPC
MINOR_SENCE_EXCEPTION 0x2c Sence exception
MINOR_PIC_REC_ERROR 0x2d Capture error. Failed to get pictures.
MINOR_VI_MISMATCH 0x2e Video format mismatches
MINOR_RESOLUTION_MISMATCH 0x2f Encoding resolution does not match
with the front-end resolution
MINOR_RS485_DEVICE_ABNORMAL 0x3a RS485 connection status exception
MINOR_RS485_DEVICE_REVERT 0x3b RS485 connection status exception
recovery
MINOR_SCREEN_SUBSYSTEM_ 0x3c Sub-board abnormal startup
ABNORMALREBOOT
MINOR_SCREEN_SUBSYSTEM_ 0x3d Sub-board inserted
ABNORMALINSERT
MINOR_SCREEN_SUBSYSTEM_ 0x3e Sub-board pulled out
ABNORMALPULLOUT
MINOR_SCREEN_ 0x3f Temperature exception
ABNARMALTEMPERATURE
MINOR_RECORD_OVERFLOW 0x41 Buffer overflow
MINOR_DSP_ABNORMAL 0x42 DSP exception
MINOR_ANR_RECORD_FAIED 0x43 ANR recordig failed
MINOR_SPARE_WORK_DEVICE_ 0x44 Hot spare device working exception
EXCEPT
MINOR_START_IPC_MAS_FAILED 0x45 Failed to enable IPC MAS
MINOR_IPCM_CRASH 0x46 IPCM abnormal rebooting
MINOR_POE_POWER_EXCEPTION 0x47 POE power supply exception
MINOR_UPLOAD_DATA_CS_ 0x48 Failed to upload data to cloud storage
EXCEPTION

489
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_DIAL_EXCEPTION 0x49 Dial-up exception
MINOR_DEV_EXCEPTION_OFFLINE 0x50 Device abnormal offline
MINOR_UPGRADEFAIL 0x51 Remote upgrading failed.
MINOR_AI_LOST 0x52 Audio loss
MINOR_SYNC_IPC_PASSWD 0x53 IPC password synchronization
exception
MINOR_EZVIZ_OFFLINE 0x54 Ezviz offline exception
MINOR_ACCESSORIES_PLATE 0x57 Accessory board exception
MINOR_CAMERA_ANGLE_ANOMALY 0x60 Camera view angle exception
MINOR_FACESNAP_RESOLUTION_ 0x63 Overlimit face capture stream
OVERFLOW resolution
MINOR_SMD_RESOLUTION_ 0x64 Overlimit SMD stream resolution
OVERFLOW
MINOR_AUDIO_LOSS_EXCEPTION 0x65 Audio loss
MINOR_SAFETY_HELMET_EXCEPTION 0x66 Hard hat detection exception
MINOR_VCA_PIC_LENGTH_ 0x67 The VCA picture size is too large
OVERFLOW
MINOR_FACE_MODEL_EXCEPTION 0x68 Face picture library model
synchronization error
MINOR_CLUSTER_DEVICE_OFFLINE 0x70 The device in cluster is offline
MINOR_CLUSTER_CONFIG_FAILED 0x71 Configuring the devices in cluster
failed.
MINOR_CLUSTER_DISASTER_ 0x72 Cluster disaster recovery exception:
TOLERANCE_EXCEPT cluster CM election failed, no enough
cluster storage period, no enough
cluster bandwidth, no enough
channel resource, no enough device.
MINOR_CLUSTER_STORFULL_ 0x73 The cluster HDD is full.
EXCEPTION
MINOR_CLUSTER_VERSION_ 0x74 Cluster version exception
EXCEPTION
MINOR_CLUSTER_OFFLINENODE_ 0x75 The offline devices in cluster exceed
EXCEPTION the limit.

490
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_CLUSTER_RECORDCYCLE_ 0x76 Cluster storage period is not enough.
EXCEPTION
MINOR_CLUSTER_IPCTRANSFER_ 0x77 Cluster network camera migration
EXCEPTION failed.
MINOR_CLUSTER_IPCONFLICT_ 0x78 Cluster IP conflict.
EXCEPTION
MINOR_EVENT_UPLOAD_EXCEPTION 0x7c Uploading event failed/Uploaded
event lost
MINOR_DEV_POWER_ON 0x400 Device power on
MINOR_DEV_POWER_OFF 0x401 Device power off
MINOR_WATCH_DOG_RESET 0x402 Watch dog resumed
MINOR_LOW_BATTERY 0x403 Low battery
MINOR_BATTERY_RESUME 0x404 Battery voltage recovery
MINOR_AC_OFF 0x405 AC power interrupt
MINOR_AC_RESUME 0x406 AC power recovery
MINOR_NET_RESUME 0x407 Network recovery
MINOR_FLASH_ABNORMAL 0x408 FLASH reading/writing exception
MINOR_CARD_READER_OFFLINE 0x409 Card reader offline
MINOR_CARD_READER_RESUME 0x40a Card reader offline recovery
MINOR_AUXILIARY_BOARD_OFFLINE 0x43c Auxiliary board disconnected
MINOR_AUXILIARY_BOARD_RESUME 0x43d Auxiliary board connected
MINOR_IDCARD_SECURITY_ 0x43e ID card module exception
MOUDLE_EXCEPTION
MINOR_IDCARD_SECURITY_ 0x43f ID card module restored
MOUDLE_RESUME
MINOR_FP_PERIPHERAL_EXCEPTION 0x440 Fingerprint recorder exception
MINOR_FP_PERIPHERAL_RESUME 0x441 Fingerprint recorder restored
MINOR_SUBSYSTEM_IP_CONFLICT 0x4000 IP conflicted of sub-board
MINOR_SUBSYSTEM_NET_BROKEN 0x4001 Sub-board offline
MINOR_FAN_ABNORMAL 0x4002 Fan exception

491
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_BACKPANEL_TEMPERATURE_ 0x4003 Back board temperature exception
ABNORMAL
MINOR_SDCARD_ABNORMAL 0x4004 SD card defective
MINOR_SDCARD_DAMAGE 0x4005 SD card damaged
MINOR_OVERVOLTAGE 0x4019 High supply voltage
MINOR_UNDERVOLTAGE 0x401a Low supply voltage
MINOR_HIGH_HD_TEMPERATURE 0x80 HDD high temperature
MINOR_LOW_HD_TEMPERATURE 0x81 HDD low temperature
MINOR_HD_IMPACT 0x82 HDD impact
MINOR_HD_BAD_BLOCK 0x83 HDD bad sector
MINOR_SEVERE_HD_FAILURE 0x84 HDD severe fault

MAJOR_OPERATION
Table A-3 Minor Types of Operation Log
Log Minor Type Value Description
MINOR_START_DVR 0x41 Power on
MINOR_STOP_DVR 0x42 Shutdown
MINOR_STOP_ABNORMAL 0x43 Abnormal shutdown
MINOR_REBOOT_DVR 0x44 Reboot device (local)
MINOR_LOCAL_LOGIN 0x50 Logged in (local)
MINOR_LOCAL_LOGOUT 0x51 Logged out (Local)
MINOR_LOCAL_CFG_PARM 0x52 Local configuration
MINOR_LOCAL_PLAYBYFILE 0x53 Playback or download by file (local)
MINOR_LOCAL_PLAYBYTIME 0x54 Playback or download by time (local)
MINOR_LOCAL_START_REC 0x55 Start recording (local)
MINOR_LOCAL_STOP_REC 0x56 Stop recording (local)
MINOR_LOCAL_PTZCTRL 0x57 PTZ control (local)
MINOR_LOCAL_PREVIEW 0x58 Live view (local,reserved)
MINOR_LOCAL_MODIFY_TIME 0x59 Edit time (local,reserved)
MINOR_LOCAL_UPGRADE 0x5a Local upgrade

492
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_RECFILE_OUTPUT 0x5b Backup video files (local)
MINOR_LOCAL_FORMAT_HDD 0x5c Initialize HDD (local)
MINOR_LOCAL_CFGFILE_OUTPUT 0x5d Export local configuration files
MINOR_LOCAL_CFGFILE_INPUT 0x5e Import local configuration files
MINOR_LOCAL_COPYFILE 0x5f Backup files (local)
MINOR_LOCAL_LOCKFILE 0x60 Lock video files (local)
MINOR_LOCAL_UNLOCKFILE 0x61 Unlock video files (local)
MINOR_LOCAL_DVR_ALARM 0x62 Clear manually and trigger alarm
(local)
MINOR_IPC_ADD 0x63 Add IPC (local)
MINOR_IPC_DEL 0x64 Delete IPC (local)
MINOR_IPC_SET 0x65 Set IPC (local)
MINOR_LOCAL_START_BACKUP 0x66 Start backup (local)
MINOR_LOCAL_STOP_BACKUP 0x67 Stop backup (local)
MINOR_LOCAL_COPYFILE_START_ 0x68 Start time of local backup
TIME
MINOR_LOCAL_COPYFILE_END_TIME 0x69 End time of local backup
MINOR_LOCAL_ADD_NAS 0x6a Add NetHDD (local)
MINOR_LOCAL_DEL_NAS 0x6b Delete NAS (local)
MINOR_LOCAL_SET_NAS 0x6c Set NAS (local)
MINOR_REMOTE_LOGIN 0x70 Login (remote)
MINOR_REMOTE_LOGOUT 0x71 Logout (local)
MINOR_REMOTE_START_REC 0x72 Start recording (remote)
MINOR_REMOTE_STOP_REC 0x73 Stop recording (remote)
MINOR_START_TRANS_CHAN 0x74 Start transparent transmission
MINOR_STOP_TRANS_CHAN 0x75 Stop transparent transmission
MINOR_REMOTE_GET_PARM 0x76 Get parameters (remote)
MINOR_REMOTE_CFG_PARM 0x77 Remote configuration
MINOR_REMOTE_GET_STATUS 0x78 Get status (remote)

493
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_REMOTE_ARM 0x79 Arm (remote)
MINOR_REMOTE_DISARM 0x7a Disarm (remote)
MINOR_REMOTE_REBOOT 0x7b Reboot (remote)
MINOR_START_VT 0x7c Start two-way audio
MINOR_STOP_VT 0x7d Stop two-way audio
MINOR_REMOTE_UPGRADE 0x7e Remote upgrade
MINOR_REMOTE_PLAYBYFILE 0x7f Playback by file (remote)
MINOR_REMOTE_PLAYBYTIME 0x80 Playback by time (remote)
MINOR_REMOTE_PTZCTRL 0x81 PTZ control (remote)
MINOR_REMOTE_FORMAT_HDD 0x82 Format HDD (remote)
MINOR_REMOTE_STOP 0x83 Shutdown (remote)
MINOR_REMOTE_LOCKFILE 0x84 Lock files (remote)
MINOR_REMOTE_UNLOCKFILE 0x85 Unlock files (remote)
MINOR_REMOTE_CFGFILE_OUTPUT 0x86 Export configuration files (remote)
MINOR_REMOTE_CFGFILE_INTPUT 0x87 Import configuration files (remote)
MINOR_REMOTE_RECFILE_OUTPUT 0x88 Export video files (remote)
MINOR_REMOTE_DVR_ALARM 0x89 Clear manually and trigger alarm
(remote)
MINOR_REMOTE_IPC_ADD 0x8a Add IPC (remote)
MINOR_REMOTE_IPC_DEL 0x8b Delete IPC (remote)
MINOR_REMOTE_IPC_SET 0x8c Set IPC (remote)
MINOR_REBOOT_VCA_LIB 0x8d Reboot intelligent library
MINOR_REMOTE_ADD_NAS 0x8e Add NAS (remote)
MINOR_REMOTE_DEL_NAS 0x8f Delete NAS (remote)
MINOR_REMOTE_SET_NAS 0x90 Set NAS (remote)
MINOR_LOCAL_START_REC_CDRW 0x91 Start burning (local)
MINOR_LOCAL_STOP_REC_CDRW 0x92 Stop burning (local)
MINOR_REMOTE_START_REC_CDRW 0x93 Start burning (remote)
MINOR_REMOTE_STOP_REC_CDRW 0x94 Stop burning (remote)

494
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_PIC_OUTPUT 0x95 Back up pictures (local)
MINOR_REMOTE_PIC_OUTPUT 0x96 Back up pictures (remote)
MINOR_LOCAL_INQUEST_RESUME 0x97 Resume inquest event (local)
MINOR_REMOTE_INQUEST_RESUME 0x98 Resume inquest event (remote)
MINOR_LOCAL_ADD_FILE 0x99 Import files (local)
MINOR_REMOTE_DELETE_HDISK 0x9a Delete exception or nonexistent HDD
MINOR_REMOTE_LOAD_HDISK 0x9b Load HDD (remote)
MINOR_REMOTE_UNLOAD_HDISK 0x9c Unload HDD (remote)
MINOR_LOCAL_OPERATE_LOCK 0x9d Lock (local)
MINOR_LOCAL_OPERATE_UNLOCK 0x9e Unlock (local)
MINOR_LOCAL_DEL_FILE 0x9f Delete inquest files (local)
MINOR_REMOTE_BYPASS 0xd0 Bypass (remote)
MINOR_REMOTE_UNBYPASS 0xd1 Bypass recovery (remote)
MINOR_REMOTE_SET_ALARMIN_CFG 0xd2 Set alarm input parameters (remote)
MINOR_REMOTE_GET_ALARMIN_ 0xd3 Get alarm input parameters (remote)
CFG
MINOR_REMOTE_SET_ALARMOUT_ 0xd4 Set alarm output parameters (remote)
CFG
MINOR_REMOTE_GET_ALARMOUT_ 0xd5 Get alarm output parameters
CFG (remote)
MINOR_REMOTE_ALARMOUT_OPEN_ 0xd6 Enable alarm output manually
MAN (remote)
MINOR_REMOTE_ALARMOUT_ 0xd7 Disable alarm output manually
CLOSE_MAN (remote)
MINOR_REMOTE_ALARM_ENABLE_ 0xd8 Enable/Disable RS-485 serial port of
CFG security control panel (remote)
MINOR_DBDATA_OUTPUT 0xd9 Export database records
MINOR_DBDATA_INPUT 0xda Import database records
MINOR_MU_SWITCH 0xdb Cascading switch
MINOR_MU_PTZ 0xdc Cascading PTZ control
MINOR_REMOTE_INQUEST_DEL_FILE 0xde Delete file (remote)

495
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_CONF_REB_RAID 0x101 Configure auto-rebuild (local)
MINOR_LOCAL_CONF_SPARE 0x102 Configure hot spare (local)
MINOR_LOCAL_ADD_RAID 0x103 Create array (local)
MINOR_LOCAL_DEL_RAID 0x104 Delete array (local)
MINOR_LOCAL_MIG_RAID 0x105 Migrate array (local)
MINOR_LOCAL_REB_RAID 0x106 Rebuild array manually (local)
MINOR_LOCAL_QUICK_CONF_RAID 0x107 One-touch configuration (local)
MINOR_LOCAL_ADD_VD 0x108 Create virtual disk (local)
MINOR_LOCAL_DEL_VD 0x109 Delete virtual disk (local)
MINOR_LOCAL_RP_VD 0x10a Repair virtual disk (local)
MINOR_LOCAL_FORMAT_EXPANDVD 0x10b Expand virtual disk (local)
MINOR_LOCAL_RAID_UPGRADE 0x10c Upgrade RAID (local)
MINOR_LOCAL_STOP_RAID 0x10d Pause RAID (local, unplug safely)
MINOR_REMOTE_CONF_REB_RAID 0x111 Configure auto-rebuild (remote)
MINOR_REMOTE_CONF_SPARE 0x112 Configure hot spare (remote)
MINOR_REMOTE_ADD_RAID 0x113 Create array (remote)
MINOR_REMOTE_DEL_RAID 0x114 Delete array (remote)
MINOR_REMOTE_MIG_RAID 0x115 Migrate array (remote)
MINOR_REMOTE_REB_RAID 0x116 Rebuild array manually (remote)
MINOR_REMOTE_QUICK_CONF_RAID 0x117 One-touch configuration (remote)
MINOR_REMOTE_ADD_VD 0x118 Create virtual disk (remote)
MINOR_REMOTE_DEL_VD 0x119 Delete virtual disk (remote)
MINOR_REMOTE_RP_VD 0x11a Repair virtual disk (remote)
MINOR_REMOTE_FORMAT_ 0x11b Expand virtual disk (remote)
EXPANDVD
MINOR_REMOTE_RAID_UPGRADE 0x11c Upgrade RAID (remote)
MINOR_REMOTE_STOP_RAID 0x11d Pause RAID (remote, unplug safely)
MINOR_LOCAL_START_PIC_REC 0x121 Start capture (local)
MINOR_LOCAL_STOP_PIC_REC 0x122 Stop capture (local)

496
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_SET_SNMP 0x125 Set SNMP (local)
MINOR_LOCAL_TAG_OPT 0x126 Tag operation (local)
MINOR_REMOTE_START_PIC_REC 0x131 Start capture (remote)
MINOR_REMOTE_STOP_PIC_REC 0x132 Stop capture (remote)
MINOR_REMOTE_SET_SNMP 0x135 Set SNMP (remote)
MINOR_REMOTE_TAG_OPT 0x136 Tag operation (remote)
MINOR_SCHEDULE_ 0x139 Scheduled angle calibration
ANGLECALIBRATION
MINOR_LOCAL_VOUT_SWITCH 0x140 Switch output (local)
MINOR_STREAM_CABAC 0x141 Encoding performance configuration
MINOR_LOCAL_SPARE_OPT 0x142 N+1 hot spare operation (local)
MINOR_REMOTE_SPARE_OPT 0x143 N+1 hot spare operation (remote)
MINOR_LOCAL_IPCCFGFILE_OUTPUT 0x144 Export IPC configuration file (local)
MINOR_LOCAL_IPCCFGFILE_INPUT 0x145 Import IPC configuration file (local)
MINOR_LOCAL_IPC_UPGRADE 0x146 Upgrade IPC (local)
MINOR_REMOTE_IPCCFGFILE_ 0x147 Export IPC configuration file (remote)
OUTPUT
MINOR_REMOTE_IPCCFGFILE_INPUT 0x148 Import IPC configuration file (remote)
MINOR_REMOTE_IPC_UPGRADE 0x149 Upgrade IPC (remote)
MINOR_LOCAL_UNLOAD_HDISK 0x150 Uninstall HDD (local)
MINOR_LOCAL_AUDIO_MIX 0x151 Set audio mix parameters (local)
MINOR_REMOTE_AUDIO_MIX 0x152 Set audio mix parameters (remote)
MINOR_LOCAL_TRIAL_PAUSE 0x153 Pause inquest (local)
MINOR_LOCAL_TRIAL_RESUME 0x154 Resume inquest (local)
MINOR_REMOTE_TRIAL_PAUSE 0x155 Pause inquest (remote)
MINOR_REMOTE_TRIAL_RESUME 0x156 Resume inquest (remote)
MINOR_REMOTE_MODIFY_ 0x157 Change the verification code of the
VERIFICATION_CODE system
MINOR_SET_MULTI_MASTER 0x201 Set main screen of multi-screen
controller

497
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_SET_MULTI_SLAVE 0x202 Set slave screen of multi-screen
controller
MINOR_CANCEL_MULTI_MASTER 0x203 Cancel master screen of multi-screen
controller
MINOR_CANCEL_MULTI_SLAVE 0x204 Cancel slave screen of multi-screen
controller
MINOR_SCREEN_SET_INPUT 0x251 Edit input source
MINOR_SCREEN_SET_OUTPUT 0x252 Edit output channel
MINOR_SCREEN_SET_OSD 0x253 Edit virtual LED
MINOR_SCREEN_SET_LOGO 0x254 Edit LOGO
MINOR_SCREEN_SET_LAYOUT 0x255 Set scene
MINOR_SCREEN_PICTUREPREVIEW 0x256 Display operation
MINOR_SCREEN_GET_OSD 0x257 Get virtual LED
MINOR_SCREEN_GET_LAYOUT 0x258 Get scene
MINOR_SCREEN_LAYOUT_CTRL 0x259 Scene control
MINOR_GET_ALL_VALID_WND 0x260 Get all the valid windows
MINOR_GET_SIGNAL_WND 0x261 Get single window information
MINOR_REMOTE_CLUSTER_MODE_ 0x261c Remote operation: cluster mode
CONFIG configuration
MINOR_LOCAL_CLUSTER_MODE_ 0x261d Local operation: cluster mode
CONFIG configuration
MINOR_REMOTE_CLUSTER_ 0x261e Remote operation: NVR in cluster
NETWORK_CONFIG configuration
MINOR_LOCAL_CLUSTER_NETWORK_ 0x261f Local operation: NVR in cluster
CONFIG configuration
MINOR_REMOTE_CLUSTER_ADD_ 0x2620 Remote operation: Add device to
DEVICE cluster
MINOR_WINDOW_CTRL 0x262 Window control
MINOR_LOCAL_CLUSTER_ADD_ 0x2621 Local operation: Add device to cluster
DEVICE
MINOR_REMOTE_CLUSTER_DEL_ 0x2622 Remote operation: Delete device
DEVICE from cluster

498
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_CLUSTER_DEL_ 0x2623 Local operation: Delete device from
DEVICE cluster
MINOR_REMOTE_HFPD_CFG 0x2624 Remote operation: frequently
appeared person detection
configuration
MINOR_REMOTE_FACE_CONTRAST_ 0x2625 Remote operation: face picture
TASK comparison task configuration
MINOR_REMOTE_LFPD_CFG 0x2626 Remote configuration of low
frequency person detection
MINOR_REMOTE_IOTCFGFILE_INPUT 0x2627 Remote operation: import IoT
configuration file
MINOR_REMOTE_IOTCFGFILE_ 0x2628 Remote operation: export IoT
OUTPUT configuration file
MINOR_LOCAL_IOT_ADD 0x2629 Local operation: add IoT channel
MINOR_REMOTE_IOT_ADD 0x262a Remote operation: add IoT channel
MINOR_LOCAL_IOT_DEL 0x262b Local operation: delete IoT channel
MINOR_REMOTE_IOT_DEL 0x262c Remote operation: delete IoT channel
MINOR_LOCAL_IOT_SET 0x262d Local operation: configure IoT channel
MINOR_REMOTE_IOT_SET 0x262e Remote operation: configure IoT
channel
MINOR_LOCAL_IOTCFGFILE_INPUT 0x262f Local operation: import IoT
configuration file
MINOR_LOCAL_IOTCFGFILE_OUTPUT 0x2630 Local operation: export IoT
configuration file
MINOR_GET_LAYOUT_LIST 0x263 Get scene list
MINOR_LOCAL_ADDRESS_FILTER_ 0x2633 Local address filter configuration
CONFIG
MINOR_REMOTE_ADDRESS_FILTER_ 0x2634 Remote address filter configuration
CONFIG
MINOR_LAYOUT_CTRL 0x264 Scene control
MINOR_SET_LAYOUT 0x265 Set single scene
MINOR_GET_SIGNAL_LIST 0x266 Get input signal source list

499
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_GET_PLAN_LIST 0x267 Get plan list
MINOR_SET_PLAN 0x268 Edit plan
MINOR_CTRL_PLAN 0x269 Control plan
MINOR_CTRL_SCREEN 0x270 Screen control
MINOR_ADD_NETSIG 0x271 Add signal source
MINOR_SET_NETSIG 0x272 Edit signal source
MINOR_SET_DECBDCFG 0x273 Set decoding board parameters
MINOR_GET_DECBDCFG 0x274 Get decoding board parameters
MINOR_GET_DEVICE_STATUS 0x275 Get device information
MINOR_UPLOAD_PICTURE 0x276 Upload background
MINOR_SET_USERPWD 0x277 Set password
MINOR_ADD_LAYOUT 0x278 Add scene
MINOR_DEL_LAYOUT 0x279 Delete scene
MINOR_DEL_NETSIG 0x280 Delete signal source
MINOR_ADD_PLAN 0x281 Add plan
MINOR_DEL_PLAN 0x282 Delete plan
MINOR_GET_EXTERNAL_MATRIX_CFG 0x283 Get external matrix settings
MINOR_SET_EXTERNAL_MATRIX_CFG 0x284 Set external matrix
MINOR_GET_USER_CFG 0x285 Get user settings
MINOR_SET_USER_CFG 0x286 Set user
MINOR_GET_DISPLAY_PANEL_LINK_ 0x287 Get video wall connection settings
CFG
MINOR_SET_DISPLAY_PANEL_LINK_ 0x288 Set video wall connection
CFG
MINOR_GET_WALLSCENE_PARAM 0x289 Get video wall scene
MINOR_SET_WALLSCENE_PARAM 0x28a Set video wall scene
MINOR_GET_CURRENT_WALLSCENE 0x28b Get current scene
MINOR_SWITCH_WALLSCENE 0x28c Scene switch
MINOR_LOCAL_LOAD_HDISK 0x300 Load HDD (local)

500
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_DELETE_HDISK 0x301 Delete exception or nonexistence
HDD (local)
MINOR_REMOTE_CFG_POE_WORK_ 0x361 Remotely set PoE working mode
MODE
MINOR_LOCAL_CFG_POE_WORK_ 0x362 Locally set PoE working mode
MODE
MINOR_REMOTE_CFG_FACE_ 0x363 Remotely set face comparison
CONTRAST
MINOR_LOCAL_CFG_FACE_CONTRAST 0x364 Locally set face comparison
MINOR_REMOTE_CFG_WHITELIST_ 0x365 Remotely set face comparison in
FACE_CONTRAST whitelist
MINOR_LOCAL_CFG_WHITELIST_ 0x366 Locally set face comparison in
FACE_CONTRAST whitelist
MINOR_REMOTE_OPEN_DOOR 0x400 Open door (remote)
MINOR_REMOTE_CLOSE_DOOR 0x401 Close door (remote)
MINOR_REMOTE_ALWAYS_OPEN 0x402 Remain open (remote)
MINOR_REMOTE_ALWAYS_CLOSE 0x403 Remain closed (remote)
MINOR_REMOTE_CHECK_TIME 0x404 Manual time synchronization
(remote)
MINOR_NTP_CHECK_TIME 0x405 NTP auto time synchronization
MINOR_REMOTE_CLEAR_CARD 0x406 Clear card No. (remote)
MINOR_REMOTE_RESTORE_CFG 0x407 Resume default parameters (remote)
MINOR_ALARMIN_ARM 0x408 Zone arming
MINOR_ALARMIN_DISARM 0x409 Zone disarming
MINOR_LOCAL_RESTORE_CFG 0x40a Resume default parameters (local)
MINOR_OFFLINE_DATA_OUTPUT 0x423 Exported offline collection data
MINOR_CREATE_SSH_LINK 0x42d Connected with SSH
MINOR_CLOSE_SSH_LINK 0x42e Disconnected with SSH
MINOR_SET_TRIGGERMODE_CFG 0x1001 Set trigger mode parameters
MINOR_GET_TRIGGERMODE_CFG 0x1002 Get trigger mode parameters
MINOR_SET_IOOUT_CFG 0x1003 Set IO output parameters

501
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_GET_IOOUT_CFG 0x1004 Get IO output parameters
MINOR_GET_TRIGGERMODE_ 0x1005 Get recommended parameters of
DEFAULT trigger mode
MINOR_GET_ITCSTATUS 0x1006 Get status detection parameters
MINOR_SET_STATUS_DETECT_CFG 0x1007 Set status detection parameters
MINOR_GET_STATUS_DETECT_CFG 0x1008 Get status detection parameters
MINOR_GET_VIDEO_TRIGGERMODE_ 0x1009 Gt parameters of video e-police mode
CFG
MINOR_SET_VIDEO_TRIGGERMODE_ 0x100a Set parameters of video e-police
CFG mode
MINOR_LOCAL_ADD_CAR_INFO 0x2001 Add vehicle information (local)
MINOR_LOCAL_MOD_CAR_INFO 0x2002 Edit vehicle information (local)
MINOR_LOCAL_DEL_CAR_INFO 0x2003 Delete vehicle information (local)
MINOR_LOCAL_FIND_CAR_INFO 0x2004 Search vehicle information (local)
MINOR_LOCAL_ADD_MONITOR_INFO 0x2005 Add arming information (local)
MINOR_LOCAL_MOD_MONITOR_ 0x2006 Edit arming information (local)
INFO
MINOR_LOCAL_DEL_MONITOR_INFO 0x2007 Delete arming information (local)
MINOR_LOCAL_FIND_MONITOR_ 0x2008 Search arming information (local)
INFO
MINOR_LOCAL_FIND_NORMAL_ 0x2009 Search normal passing information
PASS_INFO (local)
MINOR_LOCAL_FIND_ABNORMAL_ 0x200a Search abnormal passing information
PASS_INFO (local)
MINOR_LOCAL_FIND_PEDESTRIAN_ 0x200b Search normal passing information
PASS_INFO (local)
MINOR_LOCAL_PIC_PREVIEW 0x200c Preview local picture
MINOR_LOCAL_SET_GATE_PARM_ 0x200d Set local exit&entrance parameters
CFG
MINOR_LOCAL_GET_GATE_PARM_ 0x200e Get local exit&entrance parameters
CFG

502
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_SET_DATAUPLOAD_ 0x200f Set local data uploading parameters
PARM_CFG
MINOR_LOCAL_GET_DATAUPLOAD_ 0x2010 Get local data uploading parameters
PARM_CFG
MINOR_LOCAL_DEVICE_CONTROL 0x2011 Control local device (Open/close
barrier)
MINOR_LOCAL_ADD_EXTERNAL_ 0x2012 Add peripheral information (local)
DEVICE_INFO
MINOR_LOCAL_MOD_EXTERNAL_ 0x2013 Edit peripheral information (local)
DEVICE_INFO
MINOR_LOCAL_DEL_EXTERNAL_ 0x2014 Delete peripheral information (local)
DEVICE_INFO
MINOR_LOCAL_FIND_EXTERNAL_ 0x2015 Search peripheral information (local)
DEVICE_INFO
MINOR_LOCAL_ADD_CHARGE_RULE 0x2016 Add parking rule (local)
MINOR_LOCAL_MOD_CHARGE_RULE 0x2017 Edit parking rule (local)
MINOR_LOCAL_DEL_CHARGE_RULE 0x2018 Delete parking rule (local)
MINOR_LOCAL_FIND_CHARGE_RULE 0x2019 Search parking rule (local)
MINOR_LOCAL_COUNT_NORMAL_ 0x2020 Normal passing information statistics
CURRENTINFO (local)
MINOR_LOCAL_EXPORT_NORMAL_ 0x2021 Export normal passing information
CURRENTINFO_REPORT report (local)
MINOR_LOCAL_COUNT_ABNORMAL_ 0x2022 Abnormal passing information
CURRENTINFO statistics (local)
MINOR_LOCAL_EXPORT_ 0x2023 Export abnormal passing information
ABNORMAL_CURRENTINFO_REPORT report (local)
MINOR_LOCAL_COUNT_ 0x2024 Pedestrian passing information
PEDESTRIAN_CURRENTINFO statistics (local)
MINOR_LOCAL_EXPORT_ 0x2025 Export pedestrian passing information
PEDESTRIAN_CURRENTINFO_REPORT report (local)
MINOR_LOCAL_FIND_CAR_ 0x2026 Search vehicle passing fee
CHARGEINFO information (local)

503
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_COUNT_CAR_ 0x2027 Vehicle passing fee information
CHARGEINFO statistics (local)
MINOR_LOCAL_EXPORT_CAR_ 0x2028 Export vehicle passing fee information
CHARGEINFO_REPORT report (local)
MINOR_LOCAL_FIND_SHIFTINFO 0x2029 Search shift information (local)
MINOR_LOCAL_FIND_CARDINFO 0x2030 Search card information (local)
MINOR_LOCAL_ADD_RELIEF_RULE 0x2031 Add discount rule (local)
MINOR_LOCAL_MOD_RELIEF_RULE 0x2032 Edit discount rule (local)
MINOR_LOCAL_DEL_RELIEF_RULE 0x2033 Delete discount rule (local)
MINOR_LOCAL_FIND_RELIEF_RULE 0x2034 Search discount rule (local)
MINOR_LOCAL_GET_ENDETCFG 0x2035 Get configuration parameters for
entrance&exit station offline
detection (local)
MINOR_LOCAL_SET_ENDETCFG 0x2036 Set configuration parameters for
entrance&exit station offline
detection (local)
MINOR_LOCAL_SET_ENDEV_ 0x2037 Set card applying information for
ISSUEDDATA entrance&exit station (local)
MINOR_LOCAL_DEL_ENDEV_ 0x2038 Clear card applying information for
ISSUEDDATA entrance&exit station (local)
MINOR_REMOTE_DEVICE_CONTROL 0x2101 Remote device control
MINOR_REMOTE_SET_GATE_PARM_ 0x2102 Set entrance&exit parameters for
CFG remote configuration
MINOR_REMOTE_GET_GATE_PARM_ 0x2103 Get entrance&exit parameters for
CFG remote configuration
MINOR_REMOTE_SET_DATAUPLOAD_ 0x2104 Set data uploading parameters for
PARM_CFG remote configuration
MINOR_REMOTE_GET_DATAUPLOAD_ 0x2105 Get data uploading parameters for
PARM_CFG remote configuration
MINOR_REMOTE_GET_BASE_INFO 0x2106 Get terminal basic information
(remote)
MINOR_REMOTE_GET_OVERLAP_CFG 0x2107 Get text overlay parameters (remote)
MINOR_REMOTE_SET_OVERLAP_CFG 0x2108 Set text overlay parameters (remote)

504
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_REMOTE_GET_ROAD_INFO 0x2109 Get crossing information (remote)
MINOR_REMOTE_START_TRANSCHAN 0x210a Build data synchronizing server
(remote)
MINOR_REMOTE_GET_ 0x210b Get entrance&exit terminal working
ECTWORKSTATE status (remote)
MINOR_REMOTE_GET_ECTCHANINFO 0x210c Get entrance&exit terminal channel
status (remote)
MINOR_REMOTE_ADD_EXTERNAL_ 0x210d Add peripheral information (remote)
DEVICE_INFO
MINOR_REMOTE_MOD_EXTERNAL_ 0x210e Edit peripheral information (remote)
DEVICE_INFO
MINOR_REMOTE_GET_ENDETCFG 0x210f Get configuration parameters for
entrance&exit station offline
detection (remote)
MINOR_REMOTE_SET_ENDETCFG 0x2110 Set configuration parameters for
entrance&exit station offline
detection (remote)
MINOR_REMOTE_ENDEV_ 0x2111 Set card applying information for
ISSUEDDATA entrance&exit station (remote)
MINOR_REMOTE_DEL_ENDEV_ 0x2112 Clear card applying information for
ISSUEDDATA entrance&exit station (remote)
MINOR_REMOTE_ON_CTRL_LAMP 0x2115 Enable remote control parking
indicator
MINOR_REMOTE_OFF_CTRL_LAMP 0x2116 Disable remote control parking
indicator
MINOR_SET_VOICE_LEVEL_PARAM 0x2117 Set volume
MINOR_SET_VOICE_INTERCOM_ 0x2118 Set recording volume
PARAM
MINOR_SET_INTELLIGENT_PARAM 0x2119 VCA configuration
MINOR_LOCAL_SET_RAID_SPEED 0x211a Set raid speed (local)
MINOR_REMOTE_SET_RAID_SPEED 0x211b Set raid speed (remote)
MINOR_REMOTE_CREATE_STORAGE_ 0x211c Add storage pool (remote)
POOL

505
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_REMOTE_DEL_STORAGE_ 0x211d Delete storage pool (remote)
POOL
MINOR_REMOTE_DEL_PIC 0x2120 Delete picture data (remote)
MINOR_REMOTE_DEL_RECORD 0x2121 Delete recording data (remote)
MINOR_REMOTE_CLOUD_ENABLE 0x2123 Enable cloud storage (remote)
MINOR_REMOTE_CLOUD_DISABLE 0x2124 Disable cloud storage (remote)
MINOR_REMOTE_CLOUD_MODIFY_ 0x2125 Edit cloud storage pool parameters
PARAM (remote)
MINOR_REMOTE_CLOUD_MODIFY_ 0x2126 Edit cloud storage pool capacity
VOLUME (remote)
MINOR_REMOTE_CREATE_MOD_ 0x2200 Create/edit image library space
VIEWLIB_SPACE (remote)
MINOR_REMOTE_DELETE_VIEWLIB_ 0x2201 Delete image library file (remote)
FILE
MINOR_REMOTE_DOWNLOAD_ 0x2202 Download image library file(s)
VIEWLIB_FILE (remote)
MINOR_REMOTE_UPLOAD_VIEWLIB_ 0x2203 Upload image library file(s) (remote)
FILE
MINOR_LOCAL_CREATE_MOD_ 0x2204 Create/edit image library space (local)
VIEWLIB_SPACE
MINOR_REMOTE_CONFERENCE_ 0x2501 MCU meeting configuration
CONFIG
MINOR_REMOTE_TERMINAL_CONFIG 0x2502 MCU terminal configuration
MINOR_REMOTE_GROUP_CONFIG 0x2503 MCU group configuration
MINOR_REMOTE_CONFERENCE_CTRL 0x2504 MCU meeting control
MINOR_REMOTE_TERMINAL_CTRL 0x2505 MCU terminal control
MINOR_LOCAL_RESET_LOGIN_ 0x2600 Reset password for admin user (local)
PASSWORD
MINOR_REMOTE_RESET_LOGIN_ 0x2601 Reset password for admin user
PASSWORD (remote)
MINOR_LOCAL_FACE_BASE_CREATE 0x2602 Create local face picture library
MINOR_REMOTE_FACE_BASE_CREATE 0x2603 Create remote face picture library

506
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_FACE_BASE_MODIFY 0x2604 Edit local face picture library
MINOR_REMOTE_FACE_BASE_ 0x2605 Edit remote face picture library
MODIFY
MINOR_LOCAL_FACE_BASE_DELETE 0x2606 Delete local face picture library
MINOR_REMOTE_FACE_BASE_DELETE 0x2607 Delete remote face picture library
MINOR_LOCAL_FACE_DATA_APPEND 0x2608 Add face data locally
MINOR_REMOTE_FACE_DATA_ 0x2609 Add face data remotely
APPEND
MINOR_LOCAL_FACE_DATA_SEARCH 0x2610 Search local face comparison data
MINOR_REMOTE_FACE_DATA_ 0x2611 Search remote face comparison data
SEARCH
MINOR_LOCAL_FACE_DATA_ANALYSIS 0x2612 Analysis picture locally
MINOR_REMOTE_FACE_DATA_ 0x2613 Analysis picture remotely
ANALYSIS
MINOR_LOCAL_FACE_DATA_EDIT 0x2614 Edit local face data
MINOR_REMOTE_FACE_DATA_EDIT 0x2615 Edit remote face data
MINOR_LOCAL_FACE_DATA_DELETE 0x2616 Delete local face data
MINOR_REMOTE_FACE_DATA_DELET 0x2617 Delete remote face data
MINOR_LOCAL_VCA_ANALYSIS_CFG 0x2618 Set local intelligent analysis
MINOR_REMOTE_VCA_ANALYSIS_CFG 0x2619 Set remote intelligent analysis
MINOR_LOCAL_FACE_BASE_IMPORT 0x261a Import face picture library locally
MINOR_LOCAL_FACE_BASE_EXPORT 0x261b Export face picture library locally
MINOR_LOCAL_AUTO_SWITCH_ 0x2647 Configure auto power on or off locally
CONFIG
MINOR_REMOTE_AUTO_SWITCH_ 0x2648 Configure auto power on or off
CONFIG remotely
MINOR_REMOTE_CFG_WIRELESS_ 0x36c Configure wireless dial-up parameters
DIALPARAM remotely
MINOR_LOCAL_CFG_WIRELESS_ 0x36d Configure wireless dial-up parameters
DIALPARAM locally
MINOR_REMOTE_CFG_WIRELESS_ 0x36e Configure wireless message
SMSPARAM parameters remotely

507
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_LOCAL_CFG_WIRELESS_ 0x36f Configure wireless message
SMSPARAM parameters locally
MINOR_REMOTE_CFG_WIRELESS_ 0x370 Configure SMS self-service
SMSSElFHELP parameters remotely
MINOR_LOCAL_CFG_WIRELESS_ 0x371 Configure SMS self-service
SMSSElFHELP parameters locally
MINOR_REMOTE_CFG_WIRELESS_ 0x372 Configure wireless traffic parameters
NETFLOWPARAM remotely
MINOR_LOCAL_CFG_WIRELESS_ 0x373 Configure wireless traffic parameters
NETFLOWPARAM locally

MAJOR_INFORMATION
Table A-4 Minor Types of Additional Information Log
Log Minor Type Value Description
MINOR_HDD_INFO 0xa1 HDD Information
MINOR_SMART_INFO 0xa2 S.M.A.R.T Information
MINOR_REC_START 0xa3 Start recording
MINOR_REC_STOP 0xa4 Stop recording
MINOR_REC_OVERDUE 0xa5 Delete expired video files
MINOR_LINK_START 0xa6 Connect front-end device
MINOR_LINK_STOP 0xa7 Disconnect front-end device
MINOR_NET_DISK_INFO 0xa8 Network HDD information
MINOR_RAID_INFO 0xa9 raid related information
MINOR_RUN_STATUS_INFO 0xaa System running status information
MINOR_SPARE_START_BACKUP 0xab Hot spare system starts backing up
working device
MINOR_SPARE_STOP_BACKUP 0xac Hot spare system stops backing up
working device
MINOR_SPARE_CLIENT_INFO 0xad Hot spare customer device
information
MINOR_ANR_RECORD_START 0xae Start ANR recording
MINOR_ANR_RECORD_END 0xaf Stop ANR recording

508
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_ANR_ADD_TIME_QUANTUM 0xb0 Add ANR time period
MINOR_ANR_DEL_TIME_QUANTUM 0xb1 Delete ANR time period
MINOR_PIC_REC_START 0xb3 Start capturing
MINOR_PIC_REC_STOP 0xb4 Stop Capturing
MINOR_PIC_REC_OVERDUE 0xb5 Delete expired picture
MINOR_CLIENT_LOGIN 0xb6 Logging in to server completed
MINOR_CLIENT_RELOGIN 0xb7 Log in to server again
MINOR_CLIENT_LOGOUT 0xb8 Exiting server completed
MINOR_CLIENT_SYNC_START 0xb9 Start Synchronous Recording
MINOR_CLIENT_SYNC_STOP 0xba Stop Synchronous Recording
MINOR_CLIENT_SYNC_SUCC 0xbb Synchronous Recording Completed
MINOR_CLIENT_SYNC_EXCP 0xbc Synchronous recording exception
MINOR_GLOBAL_RECORD_ERR_INFO 0xbd Global Error Information
MINOR_BUFFER_STATE 0xbe Buffer Status Log File
MINOR_DISK_ERRORINFO_V2 0xbf HDD Error Details V2
MINOR_UNLOCK_RECORD 0xc3 Lock Record
MINOR_VIS_ALARM 0xc4 Zone Alarm
MINOR_TALK_RECORD 0xc5 Calling Record
MINOR_ACCESSORIES_MESSAGE 0xc6 Accessories Information
MINOR_IPC_CONNECT 0xc8 Network connection information
MINOR_INTELLIGENT_BOARD_ 0xc9 Intelligent board status
STATUS
MINOR_IPC_CONNECT_STATUS 0xca Network camera connection status
MINOR_EZVIZ_OPERATION 0xcc EZVIZ Running Status
MINOR_CLUSTER_DEVICE_ONLINE 0xcd Cluster device is online
MINOR_CLUSTER_MGR_SERVICE_ 0xce Cluster management service is
STARTUP enabled
MINOR_CLUSTER_BUSINESS_ 0xcf Cluster migration
TRANSFER
MINOR_CLUSTER_STATUS 0xd0 Cluster status information

509
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_CLUSTER_CS_STATUS 0xd1 Sending device status to CM failed.
Record the IP address of CS and CM.
MINOR_CLUSTER_CM_STATUS 0xd2 CM status switching.
MINOR_DOUBLE_VERIFICATION_PASS 0xd5 Double verification completed
MINOR_HD_FORMAT_START 0xd8 Formatting HDD started.
MINOR_HD_FORMAT_STOP 0xd9 Formatting HDD stopped.
MINOR_LIVE_DETECT_OPEN 0x400 Enabled face anti-​spoofing detection
MINOR_LIVE_DETECT_CLOSE 0x401 Disabled face anti-​spoofing detection
MINOR_CLEAR_DATA_COLLECTION 0x402 Cleared collected data
MINOR_DELETE_DATA_COLLECTION 0x403 Deleted collected data
MINOR_EXPORT_DATA_COLLECTION 0x404 Exported collected data
MINOR_CARD_LEN_CONFIG 0x405 Configured card number size
MINOR_DATA_BASE_INIT_FAILED 0x406 Initializing database failed
MINOR_DATA_BASE_PATCH_UPDATE 0x407 Upgraded database patch
MINOR_PSAM_CARD_INSERT 0x408 Inserted PSAM card
MINOR_PSAM_CARD_REMOVE 0x409 Pulled out PSAM card
MINOR_HARD_FAULT_REBOOT 0x40a Reboot as hardware exception
MINOR_PSAM_CARD_OCP 0x40b Overflow protection of PSAMc ard
MINOR_STACK_OVERFLOW 0x40c Stack overflow
MINOR_PARM_CFG 0x40d Parameter configuration
MINOR_IMPORT_USER_LIST 0x422 Imported user list (offline data
collection)
MINOR_WIRELESS_RUNNING_STATUS 0xd6 Wireless network running status

MAJOR_EVENT
Table A-5 Minor Types of Event Log
Log Minor Type Value Description
MINOR_LEGAL_CARD_PASS 0x01 Legal Card Authenticated
MINOR_CARD_AND_PSW_PASS 0x02 Card and Password Authenticated

510
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_CARD_AND_PSW_FAIL 0x03 Card and password authentication
failed.
MINOR_CARD_AND_PSW_TIMEOUT 0x04 Card and password authentication
timed out.
MINOR_CARD_AND_PSW_OVER_ 0x05 Card and password timed out.
TIME
MINOR_CARD_NO_RIGHT 0x06 No Permission
MINOR_CARD_INVALID_PERIOD 0x07 Invalid Duration
MINOR_CARD_OUT_OF_DATE 0x08 Expired Card
MINOR_INVALID_CARD 0x09 No card No.
MINOR_ANTI_SNEAK_FAIL 0x0a Anti-passing back authentication
failed.
MINOR_INTERLOCK_DOOR_NOT_ 0x0b Interlocking Door Not Closed
CLOSE
MINOR_NOT_BELONG_MULTI_ 0x0c The card does not belong to multiple
GROUP authentication group.
MINOR_INVALID_MULTI_VERIFY_ 0x0d The card is not in the multiple
PERIOD authentication duration.
MINOR_MULTI_VERIFY_SUPER_ 0x0e Multiple Authentication: Super
RIGHT_FAIL Permission Authentication Failed
MINOR_MULTI_VERIFY_REMOTE_ 0x0f Multiple Authentication: Remote
RIGHT_FAIL Authentication Failed
MINOR_MULTI_VERIFY_SUCCESS 0x10 Pass Multiple Authentication
MINOR_LEADER_CARD_OPEN_BEGIN 0x11 Open Door with First Card Started
MINOR_LEADER_CARD_OPEN_END 0x12 Open Door with First Card Stopped
MINOR_ALWAYS_OPEN_BEGIN 0x13 Remain Open Started
MINOR_ALWAYS_OPEN_END 0x14 Remain Open Stopped
MINOR_LOCK_OPEN 0x15 Unlock Door
MINOR_LOCK_CLOSE 0x16 Lock Door
MINOR_DOOR_BUTTON_PRESS 0x17 Press Door Button
MINOR_DOOR_BUTTON_RELEASE 0x18 Release Door Button
MINOR_DOOR_OPEN_NORMAL 0x19 Normal Open (Door Magnetic)

511
 Device Network SDK (Access Control on Person) Developer Guide

Log Minor Type Value Description

MINOR_DOOR_CLOSE_NORMAL 0x1a Normal Closed (Door Magnetic)
MINOR_DOOR_OPEN_ABNORMAL 0x1b Abnormal Open (Door Magnetic)
MINOR_DOOR_OPEN_TIMEOUT 0x1c Open Door Timeout (Door Magnetic)
MINOR_ALARMOUT_ON 0x1d Alarm Output On
MINOR_ALARMOUT_OFF 0x1e Alarm Output Off
MINOR_ALWAYS_CLOSE_BEGIN 0x1f Remain Open Started
MINOR_ALWAYS_CLOSE_END 0x20 Remain Open Stopped
MINOR_MULTI_VERIFY_NEED_ 0x21 Multiple Authentication: Remote
REMOTE_OPEN Open Door
MINOR_MULTI_VERIFY_ 0x22 Multiple Authentication: Super
SUPERPASSWD_VERIFY_SUCCESS Password Authentication Passed
MINOR_MULTI_VERIFY_REPEAT_ 0x23 Multiple Authentication: Repeat
VERIFY Authentication
MINOR_MULTI_VERIFY_TIMEOUT 0x24 Multiple Authentication: Repeat
Authentication Event

A.5 Error Codes in ResponseStatus

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

StatusCode=1

SubStatusCode Error Code Description

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

512
 Device Network SDK (Access Control on Person) Developer Guide

StatusCode=2

Sub Status Code Error Code Description

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

StatusCode=3

Sub Status Code Error Code Description

deviceError 0x30000001 Hardware error.
badFlash 0x30000002 Flash operation error.
28181Uninitialized 0x30000003 The 28181 configuration is not
initialized.
socketConnectError 0x30000005 Connecting to socket failed.
receiveError 0x30000007 Receive response message
failed.
deletePictureError 0x3000000A Deleting picture failed.
pictureSizeExceedLimit 0x3000000C Too large picture size.
clearCacheError 0x3000000D Clearing cache failed.
updateDatabasError 0x3000000F Updating database failed.
searchDatabaseError 0x30000010 Searching in the database
failed.

513
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

writeDatabaseError 0x30000011 Writing to database failed.
deleteDatabaseError 0x30000012 Deleting database element
failed.
searchDatabaseElementError 0x30000013 Getting number of database
elements failed.
cloudAutoUpgradeException 0x30000016 Downloading upgrade packet
from cloud and upgrading
failed.
HBPException 0x30001000 HBP exception.
UDEPException 0x30001001 UDEP exception
elasticSearchException 0x30001002 Elastic exception.
kafkaException 0x30001003 Kafka exception.
HBaseException 0x30001004 Hbase exception.
sparkException 0x30001005 Spark exception.
yarnException 0x30001006 Yarn exception.
cacheException 0x30001007 Cache exception.
trafficException 0x30001008 Monitoring point big data
server exception.
faceException 0x30001009 Human face big data server
exception.
SSDFileSystemIsError 0x30001013 SSD file system error (Error
occurs when it is non-Ext4 file
system)
insufficientSSDCapacityForFPD 0x30001014 Insufficient SSD space for
person frequency detection
wifiException 0x3000100A Wi-Fi big data server exception.
structException 0x3000100D Video parameters structure
server exception.
captureTimeout 0x30006000 Data collection timed out.
lowScore 0x30006001 Low quality of collected data.

514
 Device Network SDK (Access Control on Person) Developer Guide

StatusCode=4

Sub Status Code Error Code Description

notSupport 0x40000001 Not supported.
lowPrivilege 0x40000002 No permission.
badAuthorization 0x40000003 Authentication failed.
methodNotAllowed 0x40000004 Invalid HTTP method.
notSetHdiskRedund 0x40000005 Setting spare HDD failed.
invalidOperation 0x40000006 Invalid operation.
hdFormatFail \ Formatting HDD failed.
notActivated 0x40000007 Inactivated.
hasActivated 0x40000008 Activated.
certificateAlreadyExist 0x40000009 The certificate already exists.
operateFailed 0x4000000F Operation failed.
USBNotExist 0x40000010 USB device is not connected.
upgradePackageMoret 0x40001000 Up to 2GB upgrade package is allowed to be
han2GB uploaded.
IDNotexist 0x40001001 The ID does not exist.
synchronizationError 0x40001003 Synchronization failed.
synchronizing 0x40001004 Synchronizing.
importError 0x40001005 Importing failed.
importing 0x40001006 Importing.
fileAlreadyExists 0x40001007 The file already exists.
invalidID 0x40001008 Invalid ID.
backupnodeNotAllowe 0x40001009 Accessing to backup node is not allowed.
Log
exportingError 0x4000100A Exporting failed.
exporting 0x4000100B Exporting.
exportEnded 0x4000100C Exporting stopped.
exported 0x4000100D Exported.
IPOccupied 0x4000100E The IP address is already occupied.

515
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

IDAlreadyExists 0x4000100F The ID already exists.
exportItemsExceedLimi 0x40001010 No more items can be exported.
t
noFiles 0x40001011 The file does not exist.
beingExportedByAnoth 0x40001012 Being exported by others.
erUser
needReAuthentication 0x40001013 Authentication is needed after upgrade.
unitAddNotOnline 0x40001015 The added data analysis server is offline.
unitControl 0x40001016 The data analysis server is already added.
analysis unitFull 0x40001017 No more data analysis server can be added.
unitIDError 0x40001018 The data analysis server ID does not exist.
unitExit 0x40001019 The data analysis server already exists in the
list.
unitSearch 0x4000101A Searching data analysis server in the list failed.
unitNotOnline 0x4000101B The data analysis server is offline.
unitInfoEror 0x4000101C Getting data analysis server information failed.
unitGetNodeInfoError 0x4000101D Getting node information failed.
unitGetNetworkInfoErr 0x4000101E Getting the network information of data
or analysis server failed
unitSetNetworkInfoErr 0x4000101F Setting the network information of data analysis
or server failed
setSmartNodeInfoError 0x40001020 Setting node information failed.
setUnitNetworkInfoErr 0x40001021 Setting data analysis server network
or information failed.
unitRestartCloseError 0x40001022 Rebooting or shutting down data analysis server
failed.
virtualIPnotAllowed 0x40001023 Adding virtual IP address is not allowed.
unitInstalled 0x40001024 The data analysis server is already installed.
badSubnetMask 0x40001025 Invalid subnet mask.
uintVersionMismatche 0x40001026 Data analysis server version mismatches.
d

516
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

deviceMOdelMismatch 0x40001027 Adding failed. Device model mismatches.
ed
unitAddNotSelf 0x40001028 Adding peripherals is not allowed.
noValidUnit 0x40001029 No valid data analysis server.
unitNameDuplicate 0x4000102A Duplicated data analysis server name.
deleteUnitFirst 0x4000102B Delete the added data analysis server of the
node first.
getLocalInfoFailed 0x4000102C Getting the server information failed.
getClientAddedNodeFa 0x4000102D Getting the added node information of data
iled analysis server failed.
taskExit 0x4000102E The task already exists.
taskInitError 0x4000102F Initializing task failed.
taskSubmitError 0x40001030 Submiting task failed.
taskDelError 0x40001031 Deleting task failed.
taskPauseError 0x40001032 Pausing task failed.
taskContinueError 0x40001033 Starting task failed.
taskSeverNoCfg 0x40001035 Full-text search server is not configured.
taskPicSeverNoCfg 0x40001036 The picture server is not configured.
taskStreamError 0x40001037 Streaming information exception.
taskRecSDK 0x40001038 History recording is not supported.
taskCasaError 0x4000103A Cascading is not supported.
taskVCARuleError 0x4000103B Invalid VCA rule.
taskNoRun 0x4000103C The task is not executed.
unitLinksNoStorageNo 0x4000103D No node is linked with the data analysis server.
de Configure the node first.
searchFailed 0x4000103E Searching video files failed.
searchNull 0x4000103F No video clip.
userScheOffline 0x40001040 The task scheduler service is offline.
updateTypeUnmatche 0x40001041 The upgrade package type mismatches.
d

517
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

userExist 0x40001043 The user already exists.
userCannotDelAdmin 0x40001044 The administrator cannot be deleted.
userInexistence 0x40001045 The user name does not exist.
userCannotCreatAdmi 0x40001046 The administrator cannot be created.
n
monitorCamExceed 0x40001048 Up to 3000 cameras can be added.
monitorCunitOverLimit 0x40001049 Adding failed. Up to 5 lower-levels are
supported by the control center.
monitorReginOverLimit 0x4000104A Adding failed. Up to 5 lower-levels are
supported by the area.
monitorArming 0x4000104B The camera is already armed. Disarm the
camera and try again.
monitorSyncCfgNotSet 0x4000104C The system parameters are not configured.
monitorFdSyncing 0x4000104E Synchronizing. Try again after completing the
synchronization.
monitorParseFailed 0x4000104F Parsing camera information failed.
monitorCreatRootFaile 0x40001050 Creating resource node failed.
d
deleteArmingInfo 0x40001051 The camera is already . Disarm the camera and
try again.
cannotModify 0x40001052 Editing is not allowed. Select again.
cannotDel 0x40001053 Deletion is not allowed. Select again.
deviceExist 0x40001054 The device already exists.
IPErrorConnectFailed 0x40001056 Connection failed. Check the network port.
cannotAdd 0x40001057 Only the capture cameras can be added.
serverExist 0x40001058 The server already exists.
fullTextParamError 0x40001059 Incorrect full-text search parameters.
storParamError 0x4000105A Incorrect storage server parameters.
picServerFull 0x4000105B The storage space of picture storage server is
full.

518
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

NTPUnconnect 0x4000105C Connecting to NTP server failed. Check the
parameters.
storSerConnectFailed 0x4000105D Connecting to storage server failed. Check the
network port.
storSerLoginFailed 0x4000105E Logging in to storage server failed. Check the
user name and password.
searchSerConnectFaile 0x4000105F Connecting to full-text search server failed.
d Check the network port.
searchSerLoginFailed 0x40001060 Logging in to full-text search server failed.
Check the user name and password.
kafkaConnectFailed 0x40001061 Connecting to Kafka failed. Check the network
port.
mgmtConnectFailed 0x40001062 Connecting to system failed. Check the network
port.
mgmtLoginFailed 0x40001063 Logging in to system failed. Check the user
name and password.
TDAConnectFailed 0x40001064 Connecting to traffic data access server failed.
Checking the server status.
86sdkConnectFailed 0x40001065 Connecting to listening port of iVMS-8600
System failed. Check the parameters.
nameExist 0x40001066 Duplicated server name.
batchProcessFailed 0x40001067 Processing in batch failed.
IDNotExist 0x40001068 The server ID does not exist.
serviceNumberReache 0x40001069 No more service can be added.
sLimit
invalidServiceType. 0x4000106A Invalid service type.
clusterGetInfo 0x4000106B Getting cluster group information failed.
clusterDelNode 0x4000106C Deletion node failed.
clusterAddNode 0x4000106D Adding node failed.
clusterInstalling 0x4000106E Creating cluster…Do not operate.
clusterUninstall 0x4000106F Reseting cluster…Do not operate.
clusterInstall 0x40001070 Creating cluster failed.

519
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

clusterIpError 0x40001071 Invalid IP address of task scheduler server.
clusterNotSameSeg 0x40001072 The master node and slave node must be in the
same network segment.
clusterVirIpError 0x40001073 Automatically getting virtual IP address failed.
Enter manually.
clusterNodeUnadd 0x40001074 The specified master(slave) node is not added.
clusterNodeOffline 0x40001075 The task scheduler server is offline.
nodeNotCurrentIP 0x40001076 The analysis node of the current IP address is
required when adding master and slave nodes.
addNodeNetFailed 0x40001077 Adding node failed. The network disconnected.
needTwoMgmtNode 0x40001078 Two management nodes are required when
adding master and slave nodes.
ipConflict 0x40001079 The virtual IP address and data analysis server's
IP address conflicted.
ipUsed 0x4000107A The virtual IP address has been occupied.
cloudAlalyseOnline 0x4000107B The cloud analytic server is online.
virIP&mainIPnotSame 0x4000107C The virtual IP address is not in the same
NetSegment network segment with the IP address of
master/slave node.
getNodeDispatchInfoFa 0x4000107D Getting node scheduler information failed.
iled
unableModifyManage 0x4000107E Editing management network interface failed.
mentNetworkIP The analysis board is in the cluster.
notSpecifyVirtualIP 0x4000107F Virtual IP address should be specified for
master and slave cluster.
armingFull 0x40001080 No more device can be armed.
armingNoFind 0x40001081 The arming information does not exist.
disArming 0x40001082 Disarming failed.
getArmingError 0x40001084 Getting arming information failed.
refreshArmingError 0x40001085 Refreshing arming information failed.
ArmingPlateSame 0x40001086 The license plate number is repeatedly armed.
ArmingParseXLSError 0x40001087 Parsing arming information file failed.

520
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

ArmingTimeError 0x40001088 Invalid arming time period.
ArmingSearchTimeErro 0x40001089 Invalid search time period.
r
armingRelationshipRea 0x4000108A No more relation can be created.
chesLimit
duplicateAarmingNam 0x4000108B The relation name already exists.
e
noMoreArmingListAdd 0x4000108C No more blacklist library can be armed.
ed
noMoreCamerasAdded 0x4000108D No more camera can be armed.
noMoreArmingListAdd 0x4000108E No more library can be linked to the camera.
edWithCamera
noMoreArmingPeriodA 0x4000108F No more time period can be added to the
dded arming schedule.
armingPeriodsOverlap 0x40001090 The time periods in the arming schedule are
ped overlapped.
noArmingAlarmInfo 0x40001091 The alarm information does not exist.
armingAlarmUnRead 0x40001092 Getting number of unread alarms failed.
getArmingAlarmError 0x40001093 Getting alarm information failed.
searchByPictureTimed 0x40001094 Searching picture by picture timeout. Search
Out again.
comparisonTimeRange 0x40001095 Comparison time period error.
Error
selectMonitorNumber 0x40001096 No more monitoring point ID can be filtered.
UpperLimit
noMoreComparisonTas 0x40001097 No more comparison task can be executed at
ksAdded the same time.
GetComparisonResultF 0x40001098 Getting comparison result failed.
ailed
comparisonTypeError 0x40001099 Comparison type error.
comparisonUnfinished 0x4000109A The comparison is not completed.
facePictureModelInvali 0x4000109B Invalid face model.
d

521
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

duplicateLibraryName. 0x4000109C The library name already exists.
noRecord 0x4000109D No record found.
countingRecordsFailed. 0x4000109E Calculate the number of records failed.
getHumanFaceFrameF 0x4000109F Getting face thumbnail from the picture failed.
ailed
modelingFailed. 0x400010A0 Modeling face according to picture URL failed.
1V1FacePictureCompar 0x400010A1 Comparison 1 VS 1 face picture failed.
isonFailed
libraryArmed 0x400010A2 The blacklist library is armed.
licenseExeedLimit 0x400010A3 Dongle limited.
licenseExpired 0x400010A4 Dongle expired.
licenseDisabled 0x400010A5 Unavailable dongle.
licenseNotExist 0x400010A6 The dongle does not exist.
SessionExpired 0x400010A7 Session expired .
beyondConcurrentLimi 0x400010A8 Out of concurrent limit.
t
stopSync 0x400010A9 Synchronization stopped.
getProgressFaild 0x400010AA Getting progress failed.
uploadExtraCaps 0x400010AB No more files can be uploaded.
timeRangeError 0x400010AC Time period error.
dataPortNotConnected 0x400010AD The data port is not connected.
addClusterNodeFailed 0x400010AE Adding to the cluster failed. The device is
already added to other cluster.
taskNotExist 0x400010AF The task does not exist.
taskQueryFailed 0x400010B0 Searching task failed.
modifyTimeRuleFailed 0x400010B2 The task already exists. Editing time rule is not
allowed.
modifySmartRuleFailed 0x400010B3 The task already exists. Editing VAC rule is not
allowed.
queryHistoryVideoFaile 0x400010B4 Searching history video failed.
d

522
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

addDeviceFailed 0x400010B5 Adding device failed.
addVideoFailed 0x400010B6 Adding video files failed.
deleteAllVideoFailed 0x400010B7 Deleting all video files failed.
createVideoIndexFailed 0x400010B8 Indexing video files failed.
videoCheckTypeFailed 0x400010B9 Verifying video files types failed.
configStructuredAddre 0x400010BA Configuring IP address of structured server
ssFailed failed.
configPictureServerAd 0x400010BB Configuring IP address of picture storaged
dressFailed server failed.
storageServiceIPNotExi 0x400010BD The storage server IP address does not exist.
st
syncBackupDatabaseFa 0x400010BE Synchronizing slave database failed. Try again.
iled
syncBackupNTPTimeFa 0x400010BF Synchronizing NTP time of slave server failed.
iled
clusterNotSelectLoopb 0x400010C0 Loopbacl address is not supported by the
ackAddress master or slave cluster.
addFaceRecordFailed 0x400010C1 Adding face record failed.
deleteFaceRecordFaile 0x400010C2 Deleting face record failed.
d
modifyFaceRecordFaile 0x400010C3 Editing face record failed.
d
queryFaceRecordFailed 0x400010C4 Searching face record failed.
faceDetectFailed 0x400010C5 Detecting face failed.
libraryNotExist 0x400010C6 The library does not exist.
blackListQueryExportin 0x400010C7 Exporting matched blacklists.
g
blackListQueryExporte 0x400010C8 The matched blacklists are exported.
d
blackListQueryStopExp 0x400010C9 Exporting matched blacklists is stopped.
orting

523
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

blackListAlarmQueryEx 0x400010CA Exporting matched blacklist alarms.
porting
blackListAlarmQueryEx 0x400010CB The matched blacklists alarms are exported.
ported
blackListAlarmQuerySt 0x400010CC Exporting matched blacklist alarms is stopped.
opExporting
getBigDataCloudAnalys 0x400010CD Getting big data cloud analytic information
isFailed failed.
setBigDataCloudAnalys 0x400010CE Configuring big data cloud analytic failed.
isFailed
submitMapSearchFaile 0x400010CF Submitting search by picture task failed.
d
controlRelationshipNot 0x400010D0 The relation does not exist.
Exist
getHistoryAlarmInfoFai 0x400010D1 Getting history alarm information failed.
led
getFlowReportFailed 0x400010D2 Getting people counting report failed.
addGuardFailed 0x400010D3 Adding arming configuration failed.
deleteGuardFailed 0x400010D4 Deleting arming configuration failed.
modifyGuardFailed 0x400010D5 Editing arming configuration failed.
queryGuardFailed 0x400010D6 Searching arming configurations failed.
uploadUserSuperCaps 0x400010D7 No more user information can be uploaded.
bigDataServerConnect 0x400010D8 Connecting to big data server failed.
Failed
microVideoCloudRequ 0x400010D9 Adding response information of micro video
estInfoBuildFailed cloud failed.
microVideoCloudRespo 0x400010DA Parsing response information of micro video
nseInfoBuildFailed cloud failed.
transcodingServerRequ 0x400010DB Adding response information of transcoding
estInfoBuildFailed server failed.
transcodingServerResp 0x400010DC Parsing response information of transcoding
onseInfoParseFailed server failed.

524
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

transcodingServerOffli 0x400010DD Transcoding server is offline.
ne
microVideoCloudOfflin 0x400010DE Micro video cloud is offline.
e
UPSServerOffline 0x400010DF UPS monitor server is offline.
statisticReportRequestI 0x400010E0 Adding response information of statistics report
nfoBuildFailed failed.
statisticReportRespons 0x400010E1 Parsing response information of statistics report
eInfoParseFailed failed.
DisplayConfigInfoBuild 0x400010E2 Adding display configuration information failed.
Failed
DisplayConfigInfoParse 0x400010E3 Parsing display configuration information failed.
Failed
DisplayConfigInfoSaveF 0x400010E4 Saving display configuration information failed.
ailed
notSupportDisplayConf 0x400010E5 The display configuration type is not supported.
igType
passError 0x400010E7 Incorrect password.
upgradePackageLarge 0x400010EB Too large upgrade package.
sesssionUserReachesLi 0x400010EC No more user can log in via session.
mit
ISO 0x400010ED Invalid ISO8601 time format.
8601TimeFormatError
clusterDissolutionFaile 0x400010EE Deleting cluster failed.
d
getServiceNodeInfoFail 0x400010EF Getting service node information failed.
ed
getUPSInfoFailed 0x400010F0 Getting UPS configuration information failed.
getDataStatisticsRepor 0x400010F1 Getting data statistic report failed.
tFailed
getDisplayConfigInfoFai 0x400010F2 Getting display configuration failed.
led

525
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

namingAnalysisBoardN 0x400010F3 Renaming analysis board is not allowed.
otAllowed
onlyDrawRegionsOfCo 0x400010F4 Only drawing convex polygon area is supported.
nvexPolygon
bigDataServerRespons 0x400010F5 Parsing response message of big data service
eInfoParseFailed failed.
bigDataServerReturnFa 0x400010F6 No response is returned by big data service.
iled
microVideoReturnFaile 0x400010F7 No response is returned by micro video cloud
d service.
transcodingServerRetu 0x400010F8 No response is returned by transcoding service.
rnFailed
UPSServerReturnFailed 0x400010F9 No response is returned by UPS monitoring
service.
forwardingServer 0x400010FA No response is returned by forwarding service.
ReturnFailed
storageServer 0x400010FB No response is returned by storage service.
ReturnFailed
cloudAnalysisServerRet 0x400010FC No response is returned by cloud analytic
urnFailed service.
modelEmpty 0x400010FD No model is obtained.
mainAndBackupNodeC 0x400010FE Editing the management interface IP address of
annotModifyManagem master node and backup node is not allowed.
entNetworkInterfaceIP
IDTooLong 0x400010FF The ID is too long.
pictureCheckFailed 0x40001100 Detecting picture failed.
pictureModelingFailed 0x40001101 Modeling picture failed.
setCloudAnalsisDefault 0x40001102 Setting default province of cloud analytic
ProvinceFailed service failed.
InspectionAreasNumbe 0x40001103 No more detection regions can be added.
rExceedLimit
picturePixelsTooLarge 0x40001105 The picture resolution is too high.
picturePixelsTooSmall 0x40001106 The picture resolution is too low.

526
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

storageServiceIPEmpty 0x40001107 The storage server IP address is required.
bigDataServerRequestI 0x40001108 Creating request message of big data service
nfoBuildFail failed.
analysiTimedOut 0x40001109 Analysis time out.
high- 0x4000110A Please enable high-performance mode.
performanceModeDisa
bled.
configuringUPSMonito 0x4000110B Configurating the UPS monitoring server time
ringServerTimedOut out. Check IP address.
cloudAnalysisRequestI 0x4000110C Creating request message of cloud analytic
nformationBuildFailed service failed.
cloudAnalysisResponse 0x4000110D Parsing response message of cloud analytic
InformationParseFailed service failed.
allCloudAnalysisInterfa 0x4000110E Calling API for cloud analytic service failed.
ceFailed
cloudAnalysisModelCo 0x4000110F Model comparison of cloud analytic service
mpareFailed failed.
cloudAnalysisFacePictu 0x40001110 Getting face quality grading of cloud analytic
reQualityRatingFailed service failed.
cloudAnalysisExtractFe 0x40001111 Extracting feature of cloud analytic service
aturePointsFailed failed.
cloudAnalysisExtractPr 0x40001112 Extracting property of cloud analytic service
opertyFailed failed.
getAddedNodeInformat 0x40001113 Getting the added nodes information of data
ionFailed analysis server failed.
noMoreAnalysisUnitsA 0x40001114 No more data analysis servers can be added.
dded
detectionAreaInvalid 0x40001115 Invalid detection region.
shieldAreaInvalid 0x40001116 Invalid shield region.
noMoreShieldAreasAd 0x40001117 No more shield region can be drawn.
ded
onlyAreaOfRectangleS 0x40001118 Only drawing rectangle is allowed in detection
hapeAllowed area.

527
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

numberReachedLlimit 0x40001119 Number reached the limit.
wait1~3MinutesGetIPAf 0x4000111A Wait 1 to 3 minutes to get IP address after
terSetupDHCP configuring DHCP.
plannedTimeMustbeH 0x4000111B Schedule must be half an hour.
alfAnHour
oneDeviceCannotBuild 0x4000111C Creating master and backup cluster requires at
Cluster least two devices.
updatePackageFileNot 0x4000111E Upgrade package is not uploaded.
Uploaded
highPerformanceTasks 0x4000111F Drawing detection area is not allowed under
NotSupportDrawingDe high-performance mode.
tectionRegions
controlCenterIDDoesN 0x40001120 The control center ID does not exist.
otExist
regionIDDoesNotExist 0x40001121 The area ID does not exist.
licensePlateFormatErro 0x40001122 Invalid license plate format.
r
managementNodeDoe 0x40001123 The operation is not supported.
sNotSupportThisOperat
ion
searchByPictureResour 0x40001124 The conditions for searching picture by picture
ceNotConfiged are not configured.
videoFileEncapsulation 0x40001125 The video container format is not supported.
FormatNotSupported
videoPackageFailure 0x40001126 Converting video container format failed.
videoCodingFormatNot 0x40001127 Video coding format is not supported.
Supported
monitorOfDeviceArmin 0x40001129 The camera is armed. Disarm it and try again.
gdeleteArmingInfo
getVideoSourceTypeFai 0x4000112A Getting video source type failed.
led
smartRulesBuildFailed 0x4000112B Creating VAC rule failed.
smartRulesParseFailed 0x4000112C Parsing VAC rule failed.

528
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

timeRulesBuildFailed 0x4000112D Creating time rule failed.
timeRulesParseFailed 0x4000112E Parsing time rule failed.
monitoInfoInvalid 0x4000112F Invalid camera information.
addingFailedVersionMi 0x40001130 Adding failed. The device version mismatches.
smatches
theInformationReturne 0x40001131 No response is returned by the cloud analytic
dAfterCloudAnalysisIsE service.
mpty
selectingIpAddressOfH 0x40001132 Setting IP address for master node and backup
ostAndSpareNodeFaile node failed. Check the node status.
dCheckTheStatus
theSearchIdDoesNotEx 0x40001133 The search ID does not exist.
ist
theSynchronizationIdD 0x40001134 The synchronization ID does not exist.
oesNotExist
theUserIdDoesNotExist 0x40001136 The user ID does not exist.
theIndexCodeDoesNot 0x40001138 The index code does not exist.
Exist
theControlCenterIdDoe 0x40001139 The control center ID does not exist.
sNotExist
theAreaIdDoesNotExist 0x4000113A The area ID does not exist.
theArmingLinkageIdDo 0x4000113C The arming relationship ID does not exist.
esNotExist
theListLibraryIdDoesNo 0x4000113D The list library ID does not exist.
tExist
invalidCityCode 0x4000113E Invalid city code.
synchronizingThePass 0x4000113F Synchronizing backup system password failed.
wordOfSpareServerFail
ed
editingStreamingTypeIs 0x40001140 Editing streaming type is not supported.
NotSupported

529
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

switchingScheduledTas 0x40001141 Switching scheduled task to temporary task is
kToTemporaryTaskIsNo not supported.
tSupported
switchingTemporaryTas 0x40001142 Switching temporary task to scheduled task is
kToScheduledTaskIsNot not supported.
Supported
theTaskIsNotDispatche 0x40001143 The task is not dispatched or is updating.
dOrItIsUpdating
thisTaskDoesNotExist 0x40001144 This task does not exist in the cloud analytic
serice.
duplicatedSchedule 0x40001145 Schedule period cannot be overlapped.
continuousScheduleWi 0x40001146 The continuous schedule periods with same
thSameAlgorithmType algorithm type should be merged.
ShouldBeMerged
invalidStreamingTimeR 0x40001147 Invalid streaming time period.
ange
invalidListLibraryType 0x40001148 Invalid list library type.
theNumberOfMatched 0x40001149 The number of search results should be larger
ResultsShouldBeLarger than 0.
Than0
invalidValueRangeOfSi 0x4000114A Invalid similarity range.
milarity
invalidSortingType 0x4000114B Invalid sorting type.
noMoreListLibraryCanB 0x4000114C No more lists can be added to one device.
eLinkedToTheDevice
InvalidRecipientAddres 0x4000114D Invalid address format of result receiver.
sFormat
creatingClusterFailedT 0x4000114E Insert the dongle before creating cluster.
heDongleIsNotPlugged
In
theURLIsTooLong 0x4000114F No schedule configured for the task.
noScheduleIsConfigure 0x40001150 No schedule configured for the task.
dForTheTask
theDongleIsExpiried 0x40001151 Dongle has expired.

530
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

dongleException 0x40001152 Dongle exception.
invalidKey 0x40001153 Invalid authorization service key.
decryptionFailed 0x40001154 Decrypting authorization service failed.
encryptionFailed 0x40001155 Encrypting authorization service failed.
AuthorizeServiceRespo 0x40001156 Authorization service response exception.
nseError
incorrectParameter 0x40001157 Authorization service parameters error.
operationFailed 0x40001158 Operating authorization service error.
noAnalysisResourceOr 0x40001159 No cloud analytic resources or no data in the list
NoDataInTheListLibrary library.
calculationException 0x4000115A Calculation exception.
allocatingList 0x4000115B Allocating list.
thisOperationIsNotSup 0x4000115C This operation is not supported by the cloud
portedByTheCloudAnal analytic serice.
ytics
theCloudAnalyticsIsInt 0x4000115D The operation of cloud analytic serice is
errupted interrupted.
theServiceIsNotReady 0x4000115E The service is not ready.
searchingForExternalA 0x4000115F Searching external interfaces failed.
piFailed
noOnlineNode 0x40001160 No node is online.
noNodeAllocated 0x40001161 No allocated node.
noMatchedList 0x40001162 No matched list.
allocatingFailedTooMa 0x40001163 Allocation failed. Too many lists of big data
nyFacePictureLists service.
searchIsNotCompleted 0x40001164 Current searching is not completed. Search
SearchAgain again.
allocatingListIsNotCom 0x40001165 Allocating list is not completed.
pleted
searchingForCloudAnal 0x40001166 Searching cloud analytic serice overtime.
yticsResultsFailed

531
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

noDataOfTheCurrentLi 0x40001167 No data in the current library. Make sure there
braryFound is data in the Hbase.
noFacePictureLibraryIs 0x40001168 No face picture library is armed for big data
Armed service.
noAvailableDataSlicing 0x40001169 Invalid standard version information.
VersionInformationAr
mFirstAndSliceTheData
duplicatedOperationDa 0x4000116A Slicing failed. Duplicated operation.
taSlicingIsExecuting
slicinDataFailedNoArm 0x4000116B Slicing failed. No arming information in the face
edFacePictureLibrary big data.
GenerateBenchmarkFil 0x4000116C Generating sliced file failed. Slice again.
eFailedSlicingAgain
NonprimaryNodeIsPro 0x4000116D Slicing is not allowed by the backup node.
hibitedFromSlcingData
NoReadyNodeToCluste 0x4000116E Creating the cluster failed. No ready node.
rServers
NodeManagementServ 0x4000116F The node management server is offline.
iceIsOffline
theCamera(s)OfTheCo 0x40001170 Some cameras in control center are already
ntrolCenterAreAlready armed. Disarm them and try again.
Armed.DisarmThemFir
st
theCamera(s)OfTheAre 0x40001171 Some cameras in this area are already armed.
aAreAlreadyArmed.Dis Disarm them and try again.
armThemFirst
configuringHigh- 0x40001172 Configuring high frequency people detection
frequencyPeopleDetect failed.
ionFailed
searchingForHigh- 0x40001173 Searching detection event logs of high-
frequencyPeopleDetect frequency people detection failed.
ionLogsFailed.
gettingDetailsOfSearch 0x40001174 Getting the search result details of high
edHigh- frequency alarms failed.

532
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

frequencyPeopleDetect
ionLogsFailed.
theArmedCamerasAlre 0x40001175 Some cameras in control center are already
adyExistInTheControlC armed.
enter
disarmingFailedTheCa 0x40001177 Disarming failed. The camera is not armed.
meraIsNotArmed
noDataReturned 0x40001178 No response is returned by the big data service.
preallocFailure 0x40001179 Pre-​allocating algorithm resource failed.
overDogLimit 0x4000117A Configuration failed. No more resources can be
pre-allocated.
analysisServicesDoNot 0x4000117B Not supported.
Support
commandAndDispatch 0x4000117C Scheduling service of cloud analytic serice error.
ServiceError
engineModuleError 0x4000117D Engine module of cloud analytic serice error.
streamingServiceError 0x4000117E Streaming component of cloud analytic serice
error.
faceAnalysisModuleErr 0x4000117F Face analysis module of cloud analytic serice
or error.
vehicleAnalysisModule 0x40001180 Vehicle pictures analytic module of cloud
Error analytic serice error.
videoStructuralAnalysis 0x40001181 Video structuring module of cloud analytic
ModuleError serice error.
postprocessingModule 0x40001182 Post-processing module of cloud analytic serice
Error error.
frequentlyAppearedPe 0x40001183 High frequency alarm is already armed for
rsonAlarmIsAlreadyCo blacklist library.
nfiguredForListLibrary
creatingListLibraryFaile 0x40001184 Creating list library failed.
d
invalidIdentiryKeyOfLis 0x40001185 Invalid identity key of list library.
tLibrary

533
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

noMoreDevicesCanBe 0x40001186 No more camera can be added.
Armed
settingAlgorithmTypeF 0x40001187 Allocating task resource failed.
orDeviceFailed
gettingHighFrequencyP 0x40001188 Setting high frequency alarm failed.
ersonDetectionAlarmIn
formationFailed
invalidSearchConfition 0x40001189 Invalid result.
theTaskIsNotComplete 0x4000118B The task is not completed.
d
resourceOverRemainLi 0x4000118C No more resource can be pre-allocated.
mit
frequentlyAppearedPe 0x4000118D The high frequency alarm of this camera is
rsonAlarmIs configured. Delete the arming information and
AlreadyConfiguredForT try again.
heCameraDisarmFirstA
ndTryAgain
noClientCertificate 0x40002036 The client certificate is not installed.
noCACertificate 0x40002037 The CA certificate is not installed.
authenticationFailed 0x40002038 Authenticating certificate failed. Check the
certificate.
clientCertificateExpired 0x40002039 The client certificate is expired.
clientCertificateRevocat 0x4000203A The client certificate is revoked.
ion
CACertificateExpired 0x4000203B The CA certificate is expired.
CACertificateRevocatio 0x4000203C The CA certificate is revoked.
n
connectFail 0x4000203D Connection failed.
loginNumExceedLimit 0x4000203F No more user can log in.
formattingFailed 0x40002056 Formatting HDD failed.
encryptedFormattingFa 0x40002057 Formatting encrypted HDD failed.
iled

534
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

wrongPassword 0x40002058 Verifying password of SD card failed. Incorrect
password.
armingFailed 0x40008000 Arming failed.
disarmingFailed 0x40008001 Disarming failed.
clearAlarmFailed 0x40008002 Clearing alarm failed.
bypassFailed 0x40008003 Bypass failed.
bypassRecoverFailed 0x40008004 Bypass recovery failed.
outputsOpenFailed 0x40008005 Opening relay failed.
outputsCloseFailed 0x40008006 Closing relay failed.
registerTimeOut 0x40008007 Registering timed out.
registerFailed 0x40008008 Registering failed.
addedByOtherHost 0x40008009 The peripheral is already added by other
security control panel.
alreadyAdded 0x4000800A The peripheral is already added.
armedStatus 0x4000800B The partition is armed.
bypassStatus 0x4000800C Bypassed.
zoneNotSupport 0x4000800D This operation is not supported by the zone.
zoneFault 0x4000800E The zone is in fault status.
pwdConflict 0x4000800F Password conflicted.
audioTestEntryFailed 0x40008010 Enabling audio test mode failed.
audioTestRecoveryFaile 0x40008011 Disabling audio test mode failed.
d
addCardMode 0x40008012 Adding card mode.
searchMode 0x40008013 Search mode.
addRemoterMode 0x40008014 Adding keyfob mode.
registerMode 0x40008015 Registration mode.
exDevNotExist 0x40008016 The peripheral does not exist.
theNumberOfExDevLi 0x40008017 No peripheral can be added.
mited
sirenConfigFailed 0x40008018 Setting siren failed.

535
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

chanCannotRepeatedB 0x40008019 This channel is already linked by the zone.
inded
masterSlaveIsEnable 0x4000802c The master-slave relationship has taken effect,
the slave radar does not support this operation.
forceTrackNotEnabled 0x4000802d Mandatory tracking is disabled.
isNotSupportZoneConfi 0x4000802e This area does not support the zone type.
gByLocalArea
alarmLineCross 0x4000802f Trigger lines are overlapped.
zoneDrawingOutOfRan 0x40008030 The drawn zone is out of detection range.
ge
alarmLineDrawingOut 0x40008031 The drawn alarm trigger line is out of detection
OfRange range.
hasTargetInWarningAr 0x40008032 The warning zone already contains targets.
ea Whether to enable mandatory arming?
radarMoudleConnectF 0x40008033 Radar module communication failed.
ail
importCfgFilePassword 0x40008034 Incorrect password for importing configuration
Err files.
inProgramMode 0x4000801B The keypad is in programming mode.
inPaceTest 0x4000801C In pacing mode.
arming 0x4000801D Arming.
HDMIResolutionIllegal / The HDMI video resolution cannot be larger
than that of main and sub stream.
startAppFail / Starting running application program failed.
yuvconflict / The raw video stream conflicted.
overMaxAppNum / No more application program can be uploaded.
alreadyExist / The application program already exists.
noFlash / Insufficient flash.
noFlash / The platform mismatches.
alreadyRunning / The application program is running.
notRunning / The application program is stopped.

536
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

packNotFound / The software packet does not exist.
noMemory / Insufficient memory.
invalLicense / Invalid Licnese.
switchtimedifflesslimit 0x4000123b Time difference between power on and off
should be less than 10 minutes.

StatusCode=5

Sub Status Code Error Code Description

badXmlFormat 0x50000001 Invalid XML format.

StatusCode=6

Sub Status Code Error Code Description

badParameters 0x60000001 Invalid parameter.
badHostAddress 0x60000002 Invalid host IP address.
badXmlContent 0x60000003 Invalid XML content.
badIPv4Address 0x60000004 Invalid IPv4 address.
badIPv6Address 0x60000005 Invalid IPv6 address.
conflictIPv4Address 0x60000006 IPv4 address conflicted.
conflictIPv6Address 0x60000007 IPv6 address conflicted.
badDomainName 0x60000008 Invalid domain name.
connectSreverFail 0x60000009 Connecting to server failed.
conflictDomainName 0x6000000A Domain name conflicted.
badPort 0x6000000B Port number conflicted.
portError 0x6000000C Port error.
exportErrorData 0x6000000D Importing data failed.
badNetMask 0x6000000E Invalid sub-net mask.
badVersion 0x6000000F Version mismatches.
badDevType 0x600000010 Device type mismatches.
badLanguage 0x600000011 Language mismatches.

537
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

incorrentUserNameOrPasswor 0x600000012 Incorrect user name or
d password.
invalidStoragePoolOfCloudServ 0x600000013 Invalid storage pool. The
er storage pool is not configured
or incorrect ID.
noFreeSpaceOfStoragePool 0x600000014 Storage pool is full.
riskPassword 0x600000015 Risky password.
UnSupportCapture 0x600000016 Capturing in 4096*2160 or
3072*2048 resolution is not
supported when H.264+ is
enabled.
userPwdLenUnder8 0x60000023 At least two kinds of
characters, including digits,
letters, and symbols, should be
contained in the password.
userPwdNameSame 0x60000025 Duplicated password.
userPwdNameMirror 0x60000026 The password cannot be the
reverse order of user name.
beyondARGSRangeLimit 0x60000027 The parameter value is out of
limit.
DetectionLineOutofDetectionR 0x60000085 The rule line is out of region.
egion
DetectionRegionError 0x60000086 Rule region error. Make sure
the rule region is convex
polygon.
DetectionRegionOutOfCountin 0x60000087 The rule region must be
gRegion marked as red frame.
PedalAreaError 0x60000088 The pedal area must be in the
rule region.
DetectionAreaABError 0x60000089 The detection region A and B
must be in the a rule frame.
ABRegionCannotIntersect 0x6000008a Region A and B cannot be
overlapped.

538
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

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

539
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

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

540
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

noDoubleVerificationUser 0x60001043 No double verification user
timeSpanNumOverLimit 0x60001044 Max. number of time buckets
reached
channelNumOverLimit 0x60001045 Max. number of channels
reached
noSearchIDResource 0x60001046 Insufficient searchID resources
noSupportDeleteStrangerLib 0x60001051 Deleting stranger library is not
supported
noSupportCreateStrangerLib 0x60001052 Creating stranger library is not
supported
TransitionUseEmmc 0x60002000 Starting device failed. The
EMMC is overused.
AdaptiveStreamNotEnabled 0x60002001 The stream self-​adaptive
function is not enabled .
AdaptiveStreamAndVariableBit 0x60002002 Stream self-​adptive and
rateEnabled variable bitrate function cannot
be enabled at the same time.
noSafetyHelmetRegion 0x60002023 The hard hat detection area is
not configured (if users save
their settings without
configuring the arming area,
they should be prompted to
configure one).
unclosedSafetyHelmet 0x60002024 The hard hat detection is
enabled (If users save their
settings after deleting the
arming area, they should be
prompted to disable hard hat
detection first and then delete
the arming area).
detectorTypeMismatch 0x60008000 The detector type mismatched.
nameExist 0x60008001 The name already exists.
laneAndRegionOverlap None. The lanes are overlapped.
unitConfigurationNotInEffect / Invalid unit parameter.

541
 Device Network SDK (Access Control on Person) Developer Guide

Sub Status Code Error Code Description

ruleAndShieldingMaskConflict / The line-rule region overlaps
with the shielded area.
wholeRuleInShieldingMask / There are complete
thermometry rules in the
shielded area.

StatusCode=7

SubStatusCode Error Code Description

rebootRequired 0x70000001 Reboot to take effect.

542