Scribd
Upload
892 views492 pages

ISAPI - Traffic

The Intelligent Security API (Traffic) Developer Guide provides comprehensive information on the API's functionalities, including typical applications, subsystem management, and configuration. It includes detailed sections on various trigger modes, alarm/event receiving, and traffic data management. The document also outlines legal disclaimers and offers a list of request URIs for developers to utilize.

Uploaded by

carrider
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
892 views492 pages

ISAPI - Traffic

The Intelligent Security API (Traffic) Developer Guide provides comprehensive information on the API's functionalities, including typical applications, subsystem management, and configuration. It includes detailed sections on various trigger modes, alarm/event receiving, and traffic data management. The document also outlines legal disclaimers and offers a list of request URIs for developers to utilize.

Uploaded by

carrider
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 492

Intelligent Security API (Traffic)

Developer Guide
Intelligent Security API (Traffic) Developer Guide

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

i
Intelligent Security API (Traffic) Developer Guide

Contents
Chapter 1 Overview .................................................................................................................... 1
1.1 Introduction ........................................................................................................................... 1
1.2 Product Scopes ...................................................................................................................... 1
1.3 Update History ....................................................................................................................... 3
Chapter 2 Typical Applications .................................................................................................... 7
2.1 Capture Trigger Mode ............................................................................................................ 7
2.1.1 Trigger by Checkpoint Radar ......................................................................................... 8
2.1.2 Trigger by Checkpoint Single I/O ................................................................................... 9
2.1.3 Trigger by Entrance and Exit Video ............................................................................... 9
2.1.4 Trigger by Intersection Violation Video ....................................................................... 10
2.1.5 Trigger by Mixed Checkpoint ...................................................................................... 10
2.1.6 Trigger by Smart Surveillance ...................................................................................... 10
2.1.7 Trigger by Side-Mounted Radar .................................................................................. 11
2.2 Alarm or Event Receiving ..................................................................................................... 11
2.2.1 Traffic Alarm or Event Types ........................................................................................ 12
2.2.2 Configure ANPR Alarm ................................................................................................ 13
2.2.3 Configure Blacklist and Whitelist ANPR Alarm ............................................................ 16
2.2.4 Receive ANPR Alarm in Listening Mode ...................................................................... 20
2.2.5 Receive Alarm/Event in Arming Mode ........................................................................ 21
2.2.6 Receive Alarm/Event in Listening Mode ..................................................................... 23
2.3 Traffic Data and Statistics ..................................................................................................... 25
2.4 Subsystem Management ..................................................................................................... 26
2.5 Dock Station ......................................................................................................................... 27
2.5.1 Back Up File to Central Storage ................................................................................... 27
2.5.2 Upload Collected Data to Platform by Schedule ......................................................... 29
2.5.3 Dock Station Settings .................................................................................................. 31

ii
Intelligent Security API (Traffic) Developer Guide

2.6 Configuration and Maintenance .......................................................................................... 33


2.6.1 Algorithm Version ....................................................................................................... 33
2.6.2 Channel Linkage .......................................................................................................... 33
2.6.3 Channel Settings ......................................................................................................... 34
2.6.4 Data Dictionary ........................................................................................................... 34
2.6.5 Status Information ...................................................................................................... 35
2.7 Advanced Functions ............................................................................................................. 35
Appendix A. Request URIs ........................................................................................................ 39
A.1 /ISAPI/ContentMgmt/capabilities ........................................................................................ 39
A.2 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage ............................................................ 39
A.3 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID> ................................................... 40
A.4 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>/capabilities ............................... 40
A.5 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/serverParam ...................................... 41
A.6 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/test .................................................... 41
A.7 /ISAPI/ContentMgmt/count ................................................................................................ 42
A.8 /ISAPI/ContentMgmt/fileUpload?format=json ................................................................... 42
A.9 /ISAPI/ContentMgmt/police/<policeID>?format=json ........................................................ 43
A.10 /ISAPI/ContentMgmt/police?format=json ........................................................................ 44
A.11 /ISAPI/ContentMgmt/policeUpload?format=json ............................................................. 46
A.12 /ISAPI/ContentMgmt/record/control/centralStorageBackup/capabilities?format=json ... 46
A.13 /ISAPI/ContentMgmt/record/control/centralStorageBackup?format=json ...................... 47
A.14 /ISAPI/Event/notification/alertStream .............................................................................. 47
A.15 /ISAPI/Event/notification/httpHosts .................................................................................. 48
A.16 /ISAPI/Event/notification/httpHosts/<ID> ......................................................................... 49
A.17 /ISAPI/Event/notification/httpHosts/<ID>/test ................................................................. 51
A.18 /ISAPI/Event/notification/httpHosts/capabilities .............................................................. 51
A.19 /ISAPI/Event/schedules/blackList ...................................................................................... 51
A.20 /ISAPI/Event/schedules/blackList/<ID> ............................................................................. 52

iii
Intelligent Security API (Traffic) Developer Guide

A.21 /ISAPI/Event/schedules/vehicledetects ............................................................................. 53


A.22 /ISAPI/Event/schedules/vehicledetects/<ID> .................................................................... 53
A.23 /ISAPI/Event/schedules/whiteList ..................................................................................... 54
A.24 /ISAPI/Event/schedules/whiteList/<ID> ............................................................................ 55
A.25 /ISAPI/Event/triggers/<eventType>-<ID> .......................................................................... 55
A.26 /ISAPI/Event/triggersCap ................................................................................................... 56
A.27 http://<ipAddress>:<portNo>/<url> .................................................................................. 57
A.28 /ISAPI/ITC/capability .......................................................................................................... 57
A.29 /ISAPI/ITC/capabilities ....................................................................................................... 58
A.30 /ISAPI/ITC/carFeatureParam .............................................................................................. 58
A.31 /ISAPI/ITC/carFeatureParam/capabilities .......................................................................... 59
A.32 /ISAPI/ITC/continueCap ..................................................................................................... 59
A.33 /ISAPI/ITC/continueCap/capabilities ................................................................................. 59
A.34 /ISAPI/ITC/Entrance/barrierGateCtrl ................................................................................. 60
A.35 /ISAPI/ITC/Entrance/capabilities ....................................................................................... 60
A.36 /ISAPI/ITC/Entrance/entranceParam ................................................................................. 61
A.37 /ISAPI/ITC/Entrance/entranceParam/capbilities ............................................................... 61
A.38 /ISAPI/ITC/Entrance/lampCtrl ............................................................................................ 62
A.39 /ISAPI/ITC/Entrance/VCL ................................................................................................... 62
A.40 /ISAPI/ITC/Entrance/VCL/config ........................................................................................ 63
A.41 /ISAPI/ITC/Entrance/WizardDeviceInfo/<ID> .................................................................... 63
A.42 /ISAPI/ITC/Entrance/WizardDeviceInfo/capabilities .......................................................... 64
A.43 /ISAPI/ITC/Entrance/WizardFirstLogin/<ID> ...................................................................... 65
A.44 /ISAPI/ITC/Entrance/WizardFirstLogin/<ID>/capabilities .................................................. 65
A.45 /ISAPI/ITC/EvidenceDictionary .......................................................................................... 66
A.46 /ISAPI/ITC/EvidenceDictionary/capabilities ....................................................................... 66
A.47 /ISAPI/ITC/EvidenceDictionary/reset ................................................................................. 67
A.48 /ISAPI/ITC/illegalDictionary ............................................................................................... 67

iv
Intelligent Security API (Traffic) Developer Guide

A.49 /ISAPI/ITC/illegalDictionary/capabilities ............................................................................ 68


A.50 /ISAPI/ITC/illegalDictionary/reset ...................................................................................... 68
A.51 /ISAPI/ITC/ITCSetUp .......................................................................................................... 68
A.52 /ISAPI/ITC/ITCSetUp/capabilities ....................................................................................... 69
A.53 /ISAPI/ITC/ITCStatus/capabilities ....................................................................................... 69
A.54 /ISAPI/ITC/ITCStatus/detectorStatus ................................................................................. 70
A.55 /ISAPI/ITC/ITCStatus/fortifyLinkstatus?channelID= ........................................................... 70
A.56 /ISAPI/ITC/ITCStatus/previewStatus .................................................................................. 71
A.57 /ISAPI/ITC/PlateRecognitionParam .................................................................................... 71
A.58 /ISAPI/ITC/plateRecognitionParam/capabilities ................................................................ 72
A.59 /ISAPI/ITC/Entrance/entranceParam ................................................................................. 72
A.60 /ISAPI/ITC/radarMeasurement/capabilities?format=json ................................................. 73
A.61 /ISAPI/ITC/radarMeasurement?format=json .................................................................... 73
A.62 /ISAPI/ITC/radarSetUp ....................................................................................................... 74
A.63 /ISAPI/ITC/radarSetUp/capabilities ................................................................................... 74
A.64 /ISAPI/ITC/Snapshot/channels/<ID>/capabilities .............................................................. 75
A.65 /ISAPI/ITC/Snapshot/channels/<ID>/capResInfo ............................................................... 75
A.66 /ISAPI/ITC/TotalCap ........................................................................................................... 76
A.67 /ISAPI/ITC/trafficParam ..................................................................................................... 76
A.68 /ISAPI/ITC/trafficParam/capabilities .................................................................................. 77
A.69 /ISAPI/ITC/TriggerMode/capabilities ................................................................................. 77
A.70 /ISAPI/ITC/TriggerMode/plateRecognition ........................................................................ 77
A.71 /ISAPI/ITC/TriggerMode/plateRecognition/<ID> ............................................................... 78
A.72 /ISAPI/ITC/TriggerMode/plateRecognition/<ID>/capabilities ........................................... 79
A.73 /ISAPI/ITC/TriggerMode/postHVT ..................................................................................... 79
A.74 /ISAPI/ITC/TriggerMode/postHVT/capabilities .................................................................. 80
A.75 /ISAPI/ITC/TriggerMode/postPRS ...................................................................................... 80
A.76 /ISAPI/ITC/TriggerMode/postPRS/capabilities .................................................................. 81

v
Intelligent Security API (Traffic) Developer Guide

A.77 /ISAPI/ITC/TriggerMode/postRadar ................................................................................... 81


A.78 /ISAPI/ITC/TriggerMode/postRadar/capabilities ............................................................... 82
A.79 /ISAPI/ITC/TriggerMode/postRadar/param ....................................................................... 82
A.80 /ISAPI/ITC/TriggerMode/postRadar/recommendParam ................................................... 83
A.81 /ISAPI/ITC/TriggerMode/postRadar/recommendSpeed .................................................... 83
A.82 /ISAPI/ITC/TriggerMode/postRadar/speed ....................................................................... 83
A.83 /ISAPI/ITC/TriggerMode/postSideRadarSpeed .................................................................. 84
A.84 /ISAPI/ITC/TriggerMode/postSideRadarSpeed/capabilities .............................................. 85
A.85 /ISAPI/ITC/TriggerMode/postSideRadarSpeed/recommendation?constructionDirection=
.................................................................................................................................................... 85
A.86 /ISAPI/ITC/TriggerMode/postSingleIO ............................................................................... 86
A.87 /ISAPI/ITC/TriggerMode/postSingleIO/capabilities ........................................................... 86
A.88 /ISAPI/ITC/TriggerMode/videoEpolice ............................................................................... 87
A.89 /ISAPI/ITC/TriggerMode/videoEpolice/capabilities ........................................................... 87
A.90 /ISAPI/ITC/TriggerMode/videoMonitor ............................................................................. 88
A.91 /ISAPI/ITC/TriggerMode/videoMonitor/capabilities ......................................................... 88
A.92 /ISAPI/ITC/uploadPic ......................................................................................................... 89
A.93 /ISAPI/ITC/uploadPic/capabilities ...................................................................................... 89
A.94 /ISAPI/ITC/videoMark ........................................................................................................ 89
A.95 /ISAPI/ITC/videoMark/capabilities .................................................................................... 90
A.96 /ISAPI/Image/channels/<ID> ............................................................................................. 90
A.97 /ISAPI/Image/channels/<ID>/autoContrast ....................................................................... 91
A.98 /ISAPI/Image/channels/<ID>/autoContrast/capabilities ................................................... 92
A.99 /ISAPI/Image/channels/<ID>/brightEnhance .................................................................... 92
A.100 /ISAPI/Image/channels/<ID>/capabilities ........................................................................ 93
A.101 /ISAPI/Image/channels/<ID>/capture ............................................................................. 93
A.102 /ISAPI/Image/channels/<ID>/capture/capabilities .......................................................... 94
A.103 /ISAPI/Image/channels/<ID>/capture/color .................................................................... 95

vi
Intelligent Security API (Traffic) Developer Guide

A.104 /ISAPI/Image/channels/<ID>/capture/gain ..................................................................... 95


A.105 /ISAPI/Image/channels/<ID>/capture/LPDE .................................................................... 96
A.106 /ISAPI/Image/channels/<ID>/capture/noiseReduce2D ................................................... 97
A.107 /ISAPI/Image/channels/<ID>/capture/plateContrast ...................................................... 97
A.108 /ISAPI/Image/channels/<ID>/capture/plateSaturation ................................................... 98
A.109 /ISAPI/Image/channels/<ID>/capture/shadowHighlight ................................................. 99
A.110 /ISAPI/Image/channels/<ID>/capture/shutter .............................................................. 100
A.111 /ISAPI/Image/channels/<ID>/color ................................................................................ 100
A.112 /ISAPI/Image/channels/<ID>/DarkEnhance .................................................................. 101
A.113 /ISAPI/Image/channels/<ID>/DarkEnhance/capabilities ............................................... 102
A.114 /ISAPI/Image/channels/<ID>/dayNightGata .................................................................. 102
A.115 /ISAPI/Image/channels/<ID>/defog .............................................................................. 103
A.116 /ISAPI/Image/channels/<ID>/DSS ................................................................................. 104
A.117 /ISAPI/Image/channels/<ID>/exposure ......................................................................... 104
A.118 /ISAPI/Image/channels/<ID>/gain ................................................................................. 105
A.119 /ISAPI/Image/channels/<ID>/gammaCorrection ........................................................... 106
A.120 /ISAPI/Image/channels/<ID>/grayRange ....................................................................... 107
A.121 /ISAPI/Image/channels/<ID>/grayRange/capabilities ................................................... 107
A.122 /ISAPI/Image/channels/<ID>/hdr .................................................................................. 108
A.123 /ISAPI/Image/channels/<ID>/hdr/capabilities ............................................................... 108
A.124 /ISAPI/Image/Channels/<ID>/icr ................................................................................... 109
A.125 /ISAPI/Image/Channels/<ID>/icr/capabilities ................................................................ 110
A.126 /ISAPI/Image/channels/<ID>/ImageFlip ........................................................................ 110
A.127 /ISAPI/Image/channels/<ID>/JPEGParam ...................................................................... 111
A.128 /ISAPI/Image/channels/<ID>/JPEGParam/capabilities .................................................. 111
A.129 /ISAPI/Image/channels/<ID>/lse ................................................................................... 112
A.130 /ISAPI/Image/channels/<ID>/lse/capabilities ................................................................ 113
A.131 /ISAPI/Image/channels/<ID>/LSEDetail ......................................................................... 113

vii
Intelligent Security API (Traffic) Developer Guide

A.132 /ISAPI/Image/channels/<ID>/LSEDetail/capabilities ..................................................... 114


A.133 /ISAPI/Image/channels/<ID>/mce ................................................................................. 114
A.134 /ISAPI/Image/channels/<ID>/mce/capabilities ............................................................. 115
A.135 /ISAPI/Image/Channels/<ID>/multishut ........................................................................ 116
A.136 /ISAPI/Image/Channels/<ID>/multishut/capabilities .................................................... 116
A.137 /ISAPI/Image/channels/<ID>/noiseReduce ................................................................... 117
A.138 /ISAPI/Image/channels/<ID>/NoiseReduce2D .............................................................. 118
A.139 /ISAPI/Image/channels/<ID>/plateBright ...................................................................... 118
A.140 /ISAPI/Image/channels/<ID>/plateBright/capabilities .................................................. 119
A.141 /ISAPI/Image/Channels/<ID>/record ............................................................................. 119
A.142 /ISAPI/Image/Channels/<ID>/record/capabilities ......................................................... 120
A.143 /ISAPI/Image/Channels/<ID>/record/color ................................................................... 121
A.144 /ISAPI/Image/Channels/<ID>/record/gain .................................................................... 121
A.145 /ISAPI/Image/Channels/<ID>/record/noiseReduce2D .................................................. 122
A.146 /ISAPI/Image/Channels/<ID>/record/noiseReduceExt .................................................. 123
A.147 /ISAPI/Image/Channels/<ID>/record/sectionCtrl .......................................................... 124
A.148 /ISAPI/Image/Channels/<ID>/record/shutter ................................................................ 124
A.149 /ISAPI/Image/channels/<ID>/sectionCtrl ...................................................................... 125
A.150 /ISAPI/Image/channels/<ID>/sectionCtrl/capabilities ................................................... 126
A.151 /ISAPI/Image/channels/<ID>/sharpness ....................................................................... 126
A.152 /ISAPI/Image/channels/<ID>/shutter ............................................................................ 127
A.153 /ISAPI/Image/channels/<ID>/svce ................................................................................. 128
A.154 /ISAPI/Image/channels/<ID>/svce/capabilities ............................................................. 129
A.155 /ISAPI/Image/channels/<ID>/whiteBalance .................................................................. 129
A.156 /ISAPI/Parking/capabilities ............................................................................................ 130
A.157 /ISAPI/Parking/channels/<ID>/barrierGate ................................................................... 130
A.158 /ISAPI/Parking/channels/<ID>/LEDConfiguration/capabilities ...................................... 131
A.159 /ISAPI/Parking/channels/<ID>/LEDConfigurations ........................................................ 131

viii
Intelligent Security API (Traffic) Developer Guide

A.160 /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration ................................................ 132


A.161 /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration/capabilities ............................ 133
A.162 /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo ....................................................... 133
A.163 /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo/capabilities ................................... 134
A.164 /ISAPI/Parking/channels/<ID>/VoiceFileList .................................................................. 134
A.165 /ISAPI/Parking/TME/capabilities ................................................................................... 135
A.166 /ISAPI/Smart/capabilities .............................................................................................. 135
A.167 /ISAPI/Smart/imageROI/capabilities?format=json ........................................................ 135
A.168 /ISAPI/Smart/imageROI/channels/<ID>/regions/<ID>?format=json ............................. 136
A.169 /ISAPI/Smart/imageROI/channels/<ID>/regions?format=json ...................................... 137
A.170 /ISAPI/Smart/imageROI/channels/<ID>?format=json ................................................... 138
A.171 /ISAPI/Smart/imageROI/channels?format=json ............................................................ 139
A.172 /ISAPI/Smart/ROI/channels ........................................................................................... 139
A.173 /ISAPI/Smart/ROI/channels/<ID> .................................................................................. 140
A.174 /ISAPI/Smart/ROI/channels/<ID>/regions ..................................................................... 141
A.175 /ISAPI/Smart/ROI/channels/<ID>/regions/<ID> ............................................................ 142
A.176 /ISAPI/Smart/ROI/channels/<ID>/regions/<ID>/capabilities ........................................ 143
A.177 /ISAPI/Smart/ROI/channels/capabilities ....................................................................... 143
A.178 /ISAPI/System/deviceInfo .............................................................................................. 144
A.179 /ISAPI/System/deviceInfo/capabilities .......................................................................... 144
A.180 /ISAPI/Traffic/algLog ...................................................................................................... 145
A.181 /ISAPI/Traffic/algLog/capabilities .................................................................................. 145
A.182 /ISAPI/Traffic/algVersionInfo ......................................................................................... 145
A.183 /ISAPI/Traffic/ANPR/alarmHttpPushProtocol ................................................................ 146
A.184 /ISAPI/Traffic/capabilities .............................................................................................. 146
A.185 /ISAPI/Traffic/channels/<ID>/addrInfo/capabilities?format=json ................................. 147
A.186 /ISAPI/Traffic/channels/<ID>/addrInfo?format=json ..................................................... 147
A.187 /ISAPI/Traffic/channels/<ID>/baseParam/<SID> ........................................................... 148

ix
Intelligent Security API (Traffic) Developer Guide

A.188 /ISAPI/Traffic/channels/<ID>/capabilities ...................................................................... 149


A.189 /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode .................................................. 149
A.190 /ISAPI/Trafiic/channels/<ID>/edfForceManualCapSwitch ............................................. 150
A.191 /ISAPI/Traffic/channels/<ID>/edfManualItsCap ............................................................ 150
A.192 /ISAPI/Traffic/channels/<ID>/eventTrigger .................................................................... 151
A.193 /ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json ................................ 152
A.194 /ISAPI/Traffic/channels/<ID>/licensePlateAuditData .................................................... 152
A.195 /ISAPI/Trafiic/channels/<ID>/manualItsCap .................................................................. 153
A.196 /ISAPI/Traffic/channels/<ID>/picParam ......................................................................... 154
A.197 /ISAPI/Traffic/channels/<ID>/picParam/capabilities ..................................................... 154
A.198 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info .................................. 155
A.199 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info/<ID> .......................... 155
A.200 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlays ......................................... 156
A.201 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlays/capabilities ..................... 157
A.202 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays ........................................... 157
A.203 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/capabilities ....................... 158
A.204 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info ................................... 159
A.205 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info/<ID> .......................... 159
A.206 /ISAPI/Traffic/channels/<ID>/searchLPListAudit ........................................................... 160
A.207 /ISAPI/Traffic/channels/<ID>/vehicleDetect .................................................................. 161
A.208 /ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities .............................................. 161
A.209 /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/capabilities?format=json .............. 162
A.210 /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/lastUpdateTime?format=json ....... 162
A.211 /ISAPI/Traffic/ContentMgmt/autoUpdateblackList?format=json .................................. 163
A.212 /ISAPI/Traffic/ContentMgmt/capabilities ...................................................................... 163
A.213 /ISAPI/Traffic/ContentMgmt/chanDevStatus/<ID> ........................................................ 164
A.214 /ISAPI/Traffic/ContentMgmt/ChannelMatch ................................................................. 164
A.215 /ISAPI/Traffic/ContentMgmt/ChannelMatch/<ID> ........................................................ 165

x
Intelligent Security API (Traffic) Developer Guide

A.216 /ISAPI/Traffic/ContentMgmt/ChannelMatch/capabilities ............................................. 166


A.217 /ISAPI/Traffic/ContentMgmt/ChannelMatch/config ...................................................... 166
A.218 /ISAPI/Traffic/ContentMgmt/ChannelMatch/unusedChannel ...................................... 167
A.219 /ISAPI/Traffic/ContentMgmt/dataOperation ................................................................. 167
A.220 /ISAPI/Traffic/ContentMgmt/dataOperation/capabilities ............................................. 167
A.221 /ISAPI/Traffic/ContentMgmt/FaceEvidence/capabilities ............................................... 168
A.222 /ISAPI/Traffic/ContentMgmt/FaceEvidence/config ....................................................... 168
A.223 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch .................................. 169
A.224 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/<ID> .......................... 170
A.225 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/config ....................... 171
A.226 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/status ....................... 171
A.227 /ISAPI/Traffic/ContentMgmt/fortifyStatus .................................................................... 172
A.228 /ISAPI/Traffic/ContentMgmt/fortifyStatus/<ID> ............................................................ 172
A.229 /ISAPI/Traffic/ContentMgmt/GPS/capabilities .............................................................. 172
A.230 /ISAPI/Traffic/ContentMgmt/GPS/Status ...................................................................... 173
A.231 /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects ......................................................... 173
A.232 /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/<SID> ............................................... 174
A.233 /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/capabilities ...................................... 175
A.234 /ISAPI/Traffic/ContentMgmt/InputProxy/channels ....................................................... 175
A.235 /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID> .............................................. 176
A.236 /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>/basic .................................... 176
A.237 /ISAPI/Traffic/ContentMgmt/InputProxy/channels/capabilities .................................... 177
A.238 /ISAPI/Traffic/ContentMgmt/netPortStatus .................................................................. 178
A.239 /ISAPI/Traffic/ContentMgmt/picModel ......................................................................... 178
A.240 /ISAPI/Traffic/ContentMgmt/picModel/capabilities ...................................................... 179
A.241 /ISAPI/Traffic/ContentMgmt/picRecInfo ........................................................................ 179
A.242 /ISAPI/Traffic/ContentMgmt/Picture/<datatype> ......................................................... 179
A.243 /ISAPI/Traffic/ContentMgmt/realTrafficStats ................................................................. 180

xi
Intelligent Security API (Traffic) Developer Guide

A.244 /ISAPI/Traffic/ContentMgmt/RemoteHost .................................................................... 180


A.245 /ISAPI/Traffic/ContentMgmt/RemoteHost/<ID> ........................................................... 181
A.246 /ISAPI/Traffic/ContentMgmt/RemoteHost/capabilities ................................................. 181
A.247 /ISAPI/Traffic/ContentMgmt/RemoteHost/Statistics ..................................................... 182
A.248 /ISAPI/Traffic/ContentMgmt/RemoteHost/UploadCtrl ................................................. 182
A.249 /ISAPI/Traffic/ContentMgmt/Section ............................................................................ 183
A.250 /ISAPI/Traffic/ContentMgmt/Section/<ID> ................................................................... 183
A.251 /ISAPI/Traffic/ContentMgmt/Section/capabilities ......................................................... 184
A.252 /ISAPI/Traffic/ContentMgmt/Section/config ................................................................. 185
A.253 /ISAPI/Traffic/ContentMgmt/Section/unusedChannel .................................................. 185
A.254 /ISAPI/Traffic/ContentMgmt/SlaveSystem/capabilities ................................................. 186
A.255 /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LcdCfg ............................................. 186
A.256 /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LightCfg ........................................... 187
A.257 /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/PowerCfg ........................................ 187
A.258 /ISAPI/Traffic/ContentMgmt/SlaveSystem/searchData/powerData .............................. 188
A.259 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status ......................................................... 188
A.260 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/AnalogStatus ................................... 189
A.261 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LcdStatus ......................................... 189
A.262 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LightStatus ...................................... 189
A.263 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/OPTStatus ....................................... 190
A.264 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/PowerStatus .................................... 190
A.265 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/TX1Status ........................................ 191
A.266 /ISAPI/Traffic/ContentMgmt/Statistic/capabilities ........................................................ 191
A.267 /ISAPI/Traffic/ContentMgmt/Statistic/config ................................................................ 191
A.268 /ISAPI/Traffic/ContentMgmt/Statistic/operator ............................................................ 192
A.269 /ISAPI/Traffic/ContentMgmt/trafficLightStatus/<ID> .................................................... 192
A.270 /ISAPI/Traffic/ContentMgmt/uploadModuleStatus ....................................................... 193
A.271 /ISAPI/Traffic/ContentMgmt/uploadModuleStatus/<ID> .............................................. 193

xii
Intelligent Security API (Traffic) Developer Guide

A.272 /ISAPI/Traffic/ContentMgmt/wirelessDialStatus ........................................................... 194


A.273 /ISAPI/Traffic/dockStation/basicInfo?format=json ........................................................ 194
A.274 /ISAPI/Traffic/dockStation/deviceManagement/<ID>?format=json ............................. 195
A.275 /ISAPI/Traffic/dockStation/deviceManagement/capabilities?format=json ................... 195
A.276 /ISAPI/Traffic/dockStation/deviceManagement?format=json ...................................... 196
A.277 /ISAPI/Traffic/dockStation/information/capabilities?format=json ................................ 196
A.278 /ISAPI/Traffic/dockStation/information?format=json ................................................... 197
A.279 /ISAPI/Traffic/dockStation/personManagement/<ID>?format=json ............................. 197
A.280 /ISAPI/Traffic/dockStation/personManagement/capabilities?format=json .................. 198
A.281 /ISAPI/Traffic/dockStation/personManagement?format=json ...................................... 199
A.282 /ISAPI/Traffic/DockStation/PlatformConfig/schedule/capabilities?format=json .......... 199
A.283 /ISAPI/Traffic/dockStation/platformConfig/schedule?format=json .............................. 200
A.284 /ISAPI/Traffic/dockStation/slot/open?format=json ....................................................... 200
A.285 ISAPI/Traffic/dockStation/slot/priorityCollection?format=json ..................................... 201
A.286 /ISAPI/Traffic/MNPR/channels/<ID> .............................................................................. 201
A.287 /ISAPI/Traffic/plateList ................................................................................................... 203
A.288 /ISAPI/Traffic/signal/capabilities?format=json .............................................................. 203
A.289 /ISAPI/Traffic/signal?format=json .................................................................................. 204
A.290 /ISAPI/Traffic/slaveVersionInfo ...................................................................................... 204
A.291 /ISAPI/Traffic/upgradeByUSB/capabilities?format=json ................................................ 204
A.292 /ISAPI/Traffic/upgradeByUSB/progress?format=json .................................................... 205
A.293 /ISAPI/Traffic/upgradeByUSB?format=json ................................................................... 205
Appendix B. Request and Response Messages ........................................................................ 206
B.1 JSON_AddrInfo ................................................................................................................... 206
B.2 JSON_AutoUpdateblackList ............................................................................................... 206
B.3 JSON_AutoUpdateblackListCap ......................................................................................... 206
B.4 JSON_BasicInfo .................................................................................................................. 207
B.5 JSON_Cap_AddrInfo ........................................................................................................... 207

xiii
Intelligent Security API (Traffic) Developer Guide

B.6 JSON_Cap_CentralStorageBackupFileList .......................................................................... 208


B.7 JSON_Cap_DeviceInfo ........................................................................................................ 208
B.8 JSON_Cap_Information ...................................................................................................... 209
B.9 JSON_Cap_PersonInfo ....................................................................................................... 209
B.10 JSON_Cap_RadarMeasurement ....................................................................................... 210
B.11 JSON_Cap_UpgradeParam ............................................................................................... 211
B.12 JSON_CentralStorageBackupFileList ................................................................................ 211
B.13 JSON_DeviceInfo .............................................................................................................. 211
B.14 JSON_DeviceInfoList ........................................................................................................ 212
B.15 JSON_DockStation_FileUpload ........................................................................................ 212
B.16 JSON_EventNotificationAlert_Alarm/EventInfo ............................................................... 212
B.17 JSON_EventNotificationAlert_DockStationExceptionAlarmMsg ...................................... 213
B.18 JSON_EventNotificationAlert_DockStationFileUploadException ..................................... 214
B.19 JSON_EventNotificationAlert_DockStationInfo ............................................................... 215
B.20 JSON_EventNotificationAlert_DockStationPoliceInfo ...................................................... 216
B.21 JSON_EventNotificationAlert_DockStationStatusMsg ..................................................... 217
B.22 JSON_EventNotificationAlert_HeartBeat ......................................................................... 219
B.23 JSON_EventNotificationAlert_RadarMeasurementDataMsg ........................................... 220
B.24 JSON_Filtration ................................................................................................................ 221
B.25 JSON_ImageROI ............................................................................................................... 221
B.26 JSON_ImageROICap ......................................................................................................... 222
B.27 JSON_ImageROIList .......................................................................................................... 223
B.28 JSON_Information ............................................................................................................ 224
B.29 JSON_LastUpdateTimeList ............................................................................................... 224
B.30 JSON_PersonInfo ............................................................................................................. 224
B.31 JSON_PersonInfoList ........................................................................................................ 225
B.32 JSON_PoliceInfo ............................................................................................................... 226
B.33 JSON_PoliceInfoList ......................................................................................................... 226

xiv
Intelligent Security API (Traffic) Developer Guide

B.34 JSON_PoliceInfoUpload ................................................................................................... 226


B.35 JSON_PriorityCollection ................................................................................................... 227
B.36 JSON_RadarMeasurement ............................................................................................... 227
B.37 JSON_ResponseStatus ..................................................................................................... 227
B.38 JSON_ROIRegion .............................................................................................................. 228
B.39 JSON_ROIRegionList ......................................................................................................... 228
B.40 JSON_Schedule ................................................................................................................ 229
B.41 JSON_ScheduleCap .......................................................................................................... 229
B.42 JSON_TrafficSignal ........................................................................................................... 230
B.43 JSON_TrafficSignalCap ..................................................................................................... 230
B.44 JSON_UpgradeParam ....................................................................................................... 231
B.45 JSON_UpgradeProgress ................................................................................................... 231
B.46 JSON_UserInfo ................................................................................................................. 231
B.47 XML_AlarmHttpPushProtocol .......................................................................................... 232
B.48 XML_AlgLog ..................................................................................................................... 232
B.49 XML_AlgLogCap ............................................................................................................... 232
B.50 XML_AlgVersionInfo ......................................................................................................... 232
B.51 XML_AnalogStatus ........................................................................................................... 233
B.52 XML_AutoContrast .......................................................................................................... 233
B.53 XML_BarrierGate ............................................................................................................. 233
B.54 XML_BarrierGateCtrl ....................................................................................................... 234
B.55 XML_BaseParam .............................................................................................................. 234
B.56 XML_Device_BasicInfo ..................................................................................................... 235
B.57 XML_BlackListScheduleList .............................................................................................. 235
B.58 XML_BrightEnhance ........................................................................................................ 235
B.59 XML_CapturePicOverlays ................................................................................................. 236
B.60 XML_CapResolution ......................................................................................................... 237
B.61 XML_Cap_AutoContrast .................................................................................................. 238

xv
Intelligent Security API (Traffic) Developer Guide

B.62 XML_Cap_CapResInfo ...................................................................................................... 238


B.63 XML_Cap_CapturePicOverlays ......................................................................................... 238
B.64 XML_Cap_CarFeatureParam ............................................................................................ 241
B.65 XML_Cap_CloudStorage .................................................................................................. 243
B.66 XML_Cap_ContinueCapCmd ............................................................................................ 244
B.67 XML_Cap_DarkEnhance ................................................................................................... 245
B.68 XML_Cap_DeviceInfo ....................................................................................................... 245
B.69 XML_Cap_entranceParam ............................................................................................... 247
B.70 XML_Cap_FocusConfiguration ......................................................................................... 248
B.71 XML_Cap_GrayRange ...................................................................................................... 248
B.72 XML_Cap_Hdr .................................................................................................................. 249
B.73 XML_Cap_HVTVehicleDetectCfg ...................................................................................... 249
B.74 XML_Cap_IllegalDictionary .............................................................................................. 251
B.75 XML_Cap_ImageChannel ................................................................................................. 252
B.76 XML_Cap_ImageIcrE ........................................................................................................ 254
B.77 XML_Cap_ImageMultishut .............................................................................................. 256
B.78 XML_Cap_ITCSetUp ......................................................................................................... 257
B.79 XML_Cap_JPEGParam ...................................................................................................... 257
B.80 XML_Cap_LEDConfiguration ............................................................................................ 258
B.81 XML_Cap_LSE .................................................................................................................. 258
B.82 XML_Cap_LSEDetail ......................................................................................................... 259
B.83 XML_Cap_MCE ................................................................................................................ 259
B.84 XML_Cap_MergePicOverlays ........................................................................................... 259
B.85 XML_Cap_PicParam ......................................................................................................... 262
B.86 XML_Cap_PlateBright ...................................................................................................... 263
B.87 XML_Cap_PlateRecognition ............................................................................................. 263
B.88 XML_Cap_PlateRecognitionParam .................................................................................. 264
B.89 XML_Cap_PostHVT .......................................................................................................... 265

xvi
Intelligent Security API (Traffic) Developer Guide

B.90 XML_Cap_PostPRS ........................................................................................................... 268


B.91 XML_Cap_PostRadar ....................................................................................................... 270
B.92 XML_Cap_PostSideRadarSpeed ....................................................................................... 272
B.93 XML_Cap_PostSingleIO .................................................................................................... 276
B.94 XML_Cap_RadarSetUp ..................................................................................................... 278
B.95 XML_Cap_ROI .................................................................................................................. 279
B.96 XML_Cap_ROIRegion ....................................................................................................... 279
B.97 XML_Cap_SectionCtrl ...................................................................................................... 280
B.98 XML_Cap_Svce ................................................................................................................. 280
B.99 XML_Cap_TMEVoiceConfiguration .................................................................................. 280
B.100 XML_Cap_TrafficParam .................................................................................................. 281
B.101 XML_Cap_TriggerMode ................................................................................................. 281
B.102 XML_Cap_UploadPic ...................................................................................................... 281
B.103 XML_Cap_VehicleDetectCfg .......................................................................................... 282
B.104 XML_Cap_VideoEpolice ................................................................................................. 283
B.105 XML_Cap_VideoMarkInfo .............................................................................................. 289
B.106 XML_Cap_VideoMonitor ............................................................................................... 289
B.107 XML_Cap_VoiceBroadcastInfo ....................................................................................... 289
B.108 XML_Cap_WizardDeviceInfo .......................................................................................... 290
B.109 XML_Cap_WizardFirstLogin ........................................................................................... 290
B.110 XML_CarFeatureParam .................................................................................................. 291
B.111 XML_ChanCtrl ................................................................................................................ 293
B.112 XML_ChanDeviceStatus ................................................................................................. 293
B.113 XML_ChannelMatch ...................................................................................................... 293
B.114 XML_ChannelMatchCap ................................................................................................ 294
B.115 XML_ChannelMatchCfg ................................................................................................. 294
B.116 XML_ChannelMatchList ................................................................................................. 294
B.117 XML_CloudStorage ........................................................................................................ 295

xvii
Intelligent Security API (Traffic) Developer Guide

B.118 XML_CloudStorageList ................................................................................................... 296


B.119 XML_CloudStorageServerList ......................................................................................... 296
B.120 XML_CloudStorageTestDescription ................................................................................ 297
B.121 XML_CloudStorageTestResult ........................................................................................ 298
B.122 XML_CMSearchCount .................................................................................................... 298
B.123 XML_Color ..................................................................................................................... 298
B.124 XML_continueCapCmd .................................................................................................. 299
B.125 XML_CurVehicleDetectMode ......................................................................................... 299
B.126 XML_DataOperation ...................................................................................................... 299
B.127 XML_DataOperationCap ................................................................................................ 300
B.128 XML_DarkEnhance ......................................................................................................... 301
B.129 XML_DayNightGate ....................................................................................................... 301
B.130 XML_Defog .................................................................................................................... 301
B.131 XML_DetectorStatus ...................................................................................................... 302
B.132 XML_DeviceInfo ............................................................................................................. 302
B.133 XML_DockStation_CMSearchDescription ...................................................................... 305
B.134 XML_DSS ........................................................................................................................ 305
B.135 XML_edfForceManualCapSwitch ................................................................................... 306
B.136 XML_EdfManualIts ......................................................................................................... 306
B.137 XML_EntranceCap .......................................................................................................... 307
B.138 XML_EntranceParamList ................................................................................................ 307
B.139 XML_EventNotificationAlert_AlarmEventInfo ............................................................... 309
B.140 XML_EventNotificationAlert_ANPRMsg ........................................................................ 310
B.141 XML_EventNotificationAlert_HeartbeatInfo .................................................................. 316
B.142 XML_EventTrigger .......................................................................................................... 317
B.143 XML_EventTriggerCapType ............................................................................................ 318
B.144 XML_EventTriggerNotification ....................................................................................... 319
B.145 XML_EventTriggerNotificationList .................................................................................. 320

xviii
Intelligent Security API (Traffic) Developer Guide

B.146 XML_EventTriggersCap .................................................................................................. 320


B.147 XML_EvidenceDictionary ............................................................................................... 323
B.148 XML_EvidenceDictionaryCap ......................................................................................... 324
B.149 XML_Exposure ............................................................................................................... 324
B.150 XML_FaceChannelMatchCfg .......................................................................................... 325
B.151 XML_FaceChannelMatchElement .................................................................................. 325
B.152 XML_FaceChannelMatchList .......................................................................................... 325
B.153 XML_FaceChannelMatchStatus ..................................................................................... 326
B.154 XML_FaceEvidenceCap .................................................................................................. 326
B.155 XML_FaceEvidenceCfg ................................................................................................... 327
B.156 XML_FortifyLinkStatus ................................................................................................... 327
B.157 XML_FortifyStatus ......................................................................................................... 328
B.158 XML_FortifyStatusList .................................................................................................... 328
B.159 XML_Gain ...................................................................................................................... 328
B.160 XML_gammaCorrection ................................................................................................. 329
B.161 XML_GPSCap ................................................................................................................. 329
B.162 XML_GPSStatus .............................................................................................................. 329
B.163 XML_GrayRange ............................................................................................................ 329
B.164 XML_Hdr ........................................................................................................................ 330
B.165 XML_HttpHostNotification ............................................................................................. 330
B.166 XML_HttpHostNotificationCap ...................................................................................... 331
B.167 XML_HttpHostNotificationList ....................................................................................... 332
B.168 XML_HttpHostTestResult ............................................................................................... 333
B.169 XML_HVTVehicleDetectCfg ............................................................................................ 334
B.170 XML_HVTVehicleDetectScene ....................................................................................... 334
B.171 XML_IllegalDictionary .................................................................................................... 335
B.172 XML_ImageChannel ....................................................................................................... 336
B.173 XML_ImageFlip .............................................................................................................. 337

xix
Intelligent Security API (Traffic) Developer Guide

B.174 XML_ImageIcrE .............................................................................................................. 337


B.175 XML_ImageMultishut .................................................................................................... 340
B.176 XML_ImageRecord ......................................................................................................... 340
B.177 XML_ImageRecordCaps ................................................................................................. 340
B.178 XML_IrcutFilter .............................................................................................................. 341
B.179 XML_ITCCap ................................................................................................................... 342
B.180 XML_ITCImageSnap ....................................................................................................... 343
B.181 XML_ITCImageSnapCaps ................................................................................................ 344
B.182 XML_ITCSetUp ............................................................................................................... 345
B.183 XML_ITCStatusCap ......................................................................................................... 345
B.184 XML_ITCTotalCap ........................................................................................................... 346
B.185 XML_JPEGParam ............................................................................................................ 347
B.186 XML_LampCtrl ............................................................................................................... 347
B.187 XML_LcdCfg ................................................................................................................... 347
B.188 XML_LcdStatus .............................................................................................................. 347
B.189 XML_LEDConfigurationList ............................................................................................. 348
B.190 XML_LightCfg ................................................................................................................. 348
B.191 XML_LightStatus ............................................................................................................ 349
B.192 XML_LPListAuditSearchDescription ............................................................................... 349
B.193 XML_LPListAuditSearchResult ....................................................................................... 349
B.194 XML_LSE ........................................................................................................................ 350
B.195 XML_LSEDetail ............................................................................................................... 350
B.196 XML_ManualItsCap ........................................................................................................ 350
B.197 XML_MCE ...................................................................................................................... 351
B.198 XML_MergePicOverlays ................................................................................................. 351
B.199 XML_NetPortStatusList .................................................................................................. 352
B.200 XML_NoiseReduce ......................................................................................................... 353
B.201 XML_NoiseReduce2D .................................................................................................... 353

xx
Intelligent Security API (Traffic) Developer Guide

B.202 XML_OPTStatus ............................................................................................................. 353


B.203 XML_OverlayInfo ........................................................................................................... 353
B.204 XML_OverlayInfoList ...................................................................................................... 355
B.205 XML_ParkingCap ............................................................................................................ 355
B.206 XML_PicModel ............................................................................................................... 355
B.207 XML_PicModelCap ......................................................................................................... 355
B.208 XML_PicParam ............................................................................................................... 356
B.209 XML_PicRecInfoSearchDescription ................................................................................ 356
B.210 XML_PicRecInfoSearchResult ......................................................................................... 357
B.211 XML_PlateBright ............................................................................................................ 358
B.212 XML_PlateRecognition ................................................................................................... 359
B.213 XML_PlateRecognitionList ............................................................................................. 359
B.214 XML_PlateRecognitionParam ......................................................................................... 360
B.215 XML_PostHVT ................................................................................................................ 361
B.216 XML_PostPRS ................................................................................................................. 367
B.217 XML_PostRadar .............................................................................................................. 367
B.218 XML_PostRadarParam ................................................................................................... 370
B.219 XML_PostRadarSpeed .................................................................................................... 370
B.220 XML_PostSideRadarSpeed ............................................................................................. 371
B.221 XML_PostSingleIOList .................................................................................................... 376
B.222 XML_PowerDataSearchDescription ............................................................................... 377
B.223 XML_PowerDataSearchResult ....................................................................................... 378
B.224 XML_PreviewStatus ....................................................................................................... 378
B.225 XML_RacmCap ............................................................................................................... 379
B.226 XML_RadarSetUp ........................................................................................................... 383
B.227 XML_RealTrafficStats ..................................................................................................... 384
B.228 XML_RecordColor .......................................................................................................... 385
B.229 XML_RecordGain ........................................................................................................... 385

xxi
Intelligent Security API (Traffic) Developer Guide

B.230 XML_RecordNoiseReduce2D ......................................................................................... 385


B.231 XML_RecordNoiseReduceExt ......................................................................................... 386
B.232 XML_RecordSectionCtrl ................................................................................................. 386
B.233 XML_RecordShutter ....................................................................................................... 386
B.234 XML_RedLightStatus ...................................................................................................... 387
B.235 XML_RemoteHost .......................................................................................................... 387
B.236 XML_RemoteHostCap .................................................................................................... 388
B.237 XML_RemoteHostList .................................................................................................... 390
B.238 XML_ResponseStatus ..................................................................................................... 390
B.239 XML_ROI ........................................................................................................................ 390
B.240 XML_ROIList ................................................................................................................... 391
B.241 XML_ROIRegion ............................................................................................................. 391
B.242 XML_ROIRegionsList ...................................................................................................... 392
B.243 XML_Schedule ............................................................................................................... 392
B.244 XML_SectionCap ............................................................................................................ 393
B.245 XML_SectionCtrl ............................................................................................................ 393
B.246 XML_SectionCfg ............................................................................................................. 393
B.247 XML_SectionElement ..................................................................................................... 394
B.248 XML_SectionList ............................................................................................................. 394
B.249 XML_SetVCLData ........................................................................................................... 394
B.250 XML_Sharpness ............................................................................................................. 395
B.251 XML_Shutter .................................................................................................................. 396
B.252 XML_SlaveSystemCap .................................................................................................... 396
B.253 XML_SlaveSystemStatus ................................................................................................ 396
B.254 XML_SlaveVersionInfo ................................................................................................... 397
B.255 XML_SmartCap .............................................................................................................. 397
B.256 XML_SmartPowerCfg ..................................................................................................... 398
B.257 XML_SmartPowerStatus ................................................................................................ 400

xxii
Intelligent Security API (Traffic) Developer Guide

B.258 XML_SnapColor ............................................................................................................. 400


B.259 XML_SnapGain ............................................................................................................... 401
B.260 XML_SnapLPDE .............................................................................................................. 401
B.261 XML_SnapNoiseReduce2D ............................................................................................. 401
B.262 XML_SnapPlateContrast ................................................................................................ 401
B.263 XML_SnapPlateSaturation ............................................................................................. 402
B.264 XML_SnapShadowHighlight ........................................................................................... 402
B.265 XML_SnapShutter .......................................................................................................... 402
B.266 XML_StatisticCap ........................................................................................................... 402
B.267 XML_StatisticCfg ............................................................................................................ 403
B.268 XML_StatisticOperator ................................................................................................... 403
B.269 XML_StatisticOperatorResult ......................................................................................... 404
B.270 XML_StatisticsResult ...................................................................................................... 405
B.271 XML_StatisticsSearch ..................................................................................................... 405
B.272 XML_Svce ....................................................................................................................... 405
B.273 XML_TMECap ................................................................................................................. 406
B.274 XML_TMEVoiceConfiguration ........................................................................................ 406
B.275 XML_TrafficCap .............................................................................................................. 407
B.276 XML_TrafficContentMgmtCap ....................................................................................... 408
B.277 XML_TrafficChannelCap ................................................................................................. 409
B.278 XML_TrafficEventTrigger ................................................................................................ 411
B.279 XML_TrafficParam .......................................................................................................... 412
B.280 XML_TrafficSearchResult ............................................................................................... 412
B.281 XML_InputProxyChannel ............................................................................................... 414
B.282 XML_InputProxyChannelsCap ........................................................................................ 414
B.283 XML_InputProxyChannelsList ........................................................................................ 415
B.284 XML_TX1Status .............................................................................................................. 415
B.285 XML_UnusedChannel .................................................................................................... 416

xxiii
Intelligent Security API (Traffic) Developer Guide

B.286 XML_UploadCtrl ............................................................................................................. 416


B.287 XML_UploadModule ...................................................................................................... 416
B.288 XML_UploadModuleStateList ........................................................................................ 417
B.289 XML_UploadPic .............................................................................................................. 417
B.290 XML_VCLCfg ................................................................................................................... 417
B.291 XML_VCLData ................................................................................................................ 418
B.292 XML_VCLDelCond .......................................................................................................... 419
B.293 XML_VCLGetCond .......................................................................................................... 420
B.294 XML_VehicleDetectCfg ................................................................................................... 420
B.295 XML_VehicleDetectScheduleList .................................................................................... 421
B.296 XML_VideoEpolice ......................................................................................................... 422
B.297 XML_VideoMarkInfo ...................................................................................................... 428
B.298 XML_VideoMonitor ....................................................................................................... 429
B.299 XML_VoiceBroadcastInfo ............................................................................................... 430
B.300 XML_VoiceFile ............................................................................................................... 430
B.301 XML_VoiceFileList .......................................................................................................... 430
B.302 XML_WhiteBalance ....................................................................................................... 430
B.303 XML_WhiteListScheduleList ........................................................................................... 431
B.304 XML_wirelessDialStatus ................................................................................................. 431
B.305 XML_WizardDeviceInfo .................................................................................................. 431
B.306 XML_WizardFirstLogin ................................................................................................... 432
Appendix C. Response Codes of Text Protocol ......................................................................... 433

xxiv
Intelligent Security API (Traffic) Developer Guide

Chapter 1 Overview

1.1 Introduction
Traffic applications integrated by ISAPI protocol contains traffic capture, recording, violation
detection, traffic lights control, checkpoint management, ANPR, and so on, which are mainly for
traffic intelligent devices.
Refer to the following solutions of traffic products in different scenarios.

Figure 1-1 Checkpoint Solution of Traffic Products

Figure 1-2 Entrance and Exit Solution of Traffic Products

1.2 Product Scopes


Table 1-1 Supported Product Type and Model
Product Type Product Model
Traffic Camera iDS-TCV300-A6E with Software Version 4.3.1 or Above
iDS-TCV300-A6I with Software Version 4.3.1 or Above
iDS-TCE300-A6 with Software Version 4.3.1 or Above

1
Intelligent Security API (Traffic) Developer Guide

Product Type Product Model


iDS-TCV900-AE with Software Version 4.3.1 or Above
iDS-TCV900-AI with Software Version 4.3.1 or Above
iDS-TCE900-A with Software Version 4.3.1 or Above
iDS-TCM203-A with Software Version 4.3.1 or Above
iDS-TCM203-AI with Software Version 4.3.1 or Above
iDS-TCM403-A with Software Version 4.3.1 or Above
iDS-TCM403-AI with Software Version 4.3.1 or Above
iDS-TCE900-AE/P with Software Version 4.3.1 or Above
Capture Camera DS-TCG227-A with Software Version 4.3.1 or Above
DS-TCG227-AIR with Software Version 4.3.1 or Above
Portable Speed Dome DS-MH6171I
DS-MH6171I-A
Portable Box Camera DS-MCD201-A
DS-MCB401-A
Portable Speed Detector iDS-TDI300-A with Software Version 4.3.0
iDS-TDI900-A with Software Version 4.3.0
Terminal Server iDS-TP40-04L
iDS-TP40-16B
DS-TP50-12DT
iDS-TP60-12L
iDS-TSS300-C
iDS-TSS500-C
DS-TP50-16E
iDS-TSV300-C
iDS-TSI100-C
Desktop Body Camera Dock DS-MH4172I
Station
Wall-Mounted Dock Station DS-MDS003

2
Intelligent Security API (Traffic) Developer Guide

1.3 Update History

Summary of Changes in Version 2.6_July, 2020


Related Product: CTRL-NEX-001A Control Panel with Software Version 1.0.0
1. Extended parameter message of the audio file list XML_VoiceFileList (related URI: /ISAPI/
Parking/channels/<ID>/VoiceFileList ):
added a sub node <isSptDeleted> (whether it supports deleting the audio file) to the node
<VoiceFile>.
2. Extended configuration capability message of voice prompt XML_Cap_VoiceBroadcastInfo
(related URI: /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo/capabilities ):
added three nodes: <voiceFileName> (audio file name), <cycleTimes> (repetition times), and
<isSupportStopBroadcast> (whether it supports stopping voice prompt).
3. Extended parameter message of voice prompt XML_VoiceBroadcastInfo (related URI: /ISAPI/
Parking/channels/<ID>/voiceBroadcastInfo ):
added two nodes <cycleTimes> (repetition times) and <stopBroadcast> (whether to stop voice
prompt).
4. Added 8 sub status codes to status code 4 (Invalid Operation) in Response Codes of Text
Protocol :
0x40008038-"overAudioFileNumLimit" (The number of audio files exceeds the limit),
0x40008039-"audioFileNameIsLong" (The audio file name is too long),
0x4000803a-"audioFormatIsWrong" (The audio file format is invalid),
0x4000803b-"audioFileIsLarge" (The size of the audio file exceeds the limit),
0x4000803c-"pircamCapTimeOut" (Capturing of pircam timed out),
0x4000803d-"pircamCapFail" (Capturing of pircam failed), 0x4000803e-"pircamIsCaping" (The
pircam is capturing), and 0x4000803f-"audioFileHasExisted" (The audio file already exists).

Summary of Changes in Version 2.6_Mar., 2020


Related Product: iDS-2CD70 series box camera, iDS-2CD70 series shield, iDS-2CD71 and iDS-2CD75
series dome camera, iDS-2CD7A series bullet camera with software version 5.5.120
1. Extended traffic channel capability message XML_TrafficChannelCap (related URI: /ISAPI/
Traffic/channels/<ID>/capabilities ):
added one node <isSupportFiltration> (whether it supports filtering duplicated license plate).
2. Added URI of getting or setting parameters of filtering duplicated license plate: GET or PUT /
ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json .
3. Extended message about ANPR result XML_EventNotificationAlert_ANPRMsg :
added one sub node <vehicleListName> (name of the list that the vehicle belongs to) to the
node <ANPR>.
4. Extended capability message XML_Cap_HVTVehicleDetectCfg and configuration message
XML_HVTVehicleDetectCfg of mixed traffic detection (related URIs: /ISAPI/Traffic/channels/
<ID>/HVTVehicleDetects/capabilities and /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects ):

3
Intelligent Security API (Traffic) Developer Guide

added one node <CRIndex> (country/region No.).


5. Extended capability message XML_Cap_VehicleDetectCfg and configuration message
XML_VehicleDetectCfg of vehicle detection (related URIs: /ISAPI/Traffic/channels/<ID>/
vehicleDetect/capabilities and /ISAPI/Traffic/channels/<ID>/vehicleDetect ):
added two nodes <nation> (country and region) and <CRIndex> (country/region).

Summary of Changes in Version 2.6_Mov., 2019


Related Products: DS-MDS003 Wall-Mounted Dock Station in Software Version 1.0.0
1. Added two traffic event types, i.e., dock station status uploading (eventType:
"dockStationstatus"; event details: JSON_EventNotificationAlert_DockStationStatusMsg ) and
exception prompt uploading of dock station (eventType: "dockStationExceptionPrompt"; event
details: JSON_EventNotificationAlert_DockStationExceptionAlarmMsg ).
2. Added URIs to open storage bin of dock station and set the collection priority of bin, refer to
Storage Bin for details.
3. Extended device capability ( XML_Cap_DeviceInfo ) and parameters ( XML_DeviceInfo ) (related
URIs: /ISAPI/System/deviceInfo/capabilities and /ISAPI/System/deviceInfo ) to add platform
access function of dock station:
added a node, i.e., <DockStation> (dock station configuration).
4. Added URIs to configure basic parameters, manage persons and body cameras of dock station,
refer to Basic Configuration , Person Management , and Body Camera Management for
details.

Summary of Changes in Version 2.6_Nov., 2019


Related Products: DS-MH4172I Desktop Body Camera Dock Station with Software Version 2.1
1. Extended the access configuration capability ( XML_Cap_CloudStorage ) and parameters
( XML_CloudStorage ) of cloud storage (related URIs: /ISAPI/ContentMgmt/channels/<ID>/
cloudStorage/<ID>/capabilities and /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/
<ID> ):
added a node <bucketName> (bucket name of cloud storage).
2. Extended the condition of cloud storage test ( XML_CloudStorageTestDescription , related
URI: /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/test ):
added a node <bucketName> (bucket name of cloud storage).
3. Added an API calling flow of file backup, see details in Back Up File to Central Storage .
4. Added an API calling flow of uploading collected data to platform by schedule, see details in
Upload Collected Data to Platform by Schedule .
5. Extended event message about media information reported by dock station
JSON_EventNotificationAlert_DockStationInfo :
added four sub nodes: policeName (name of policeman), cloudStorageType (storage server
type), thumbnailUrl (thumbnail URL of picture or video), and encryption (encryption
configuration) to the node DockStationInfo.
6. Added function of setting information notification to notify the dock station:
Get capability: GET /ISAPI/Traffic/dockStation/information/capabilities?format=json ;

4
Intelligent Security API (Traffic) Developer Guide

Set information notification parameters and notify: PUT /ISAPI/Traffic/dockStation/


information?format=json .

Summary of Changes in Version 2.0_Sept., 2019


Related Product: iDS-TDI300-A and iDS-TDI900-A Portable Speed Detector with Software Version
4.3.0
1. Extended intelligent traffic capability message XML_ITCCap (related URL: /ISAPI/ITC/
capabilities ):
added two nodes: <isSupportRadarSetUp> (whether it supports radar construction parameters)
and <isSupportRadarMeasurement> (whether it supports radar measurement configuration).
2. Extended traffic channel capability message XML_TrafficChannelCap (related URL: /ISAPI/
Traffic/channels/<ID>/capabilities ):
added a node <isSupportAddrInfo> (whether it supports overlaying address information).
3. Added URLs of configuring parameters for overlaying address information on pictures:
Get configuration capability: GET /ISAPI/Traffic/channels/<ID>/addrInfo/capabilities?
format=json ;
Get or set parameters: GET or PUT /ISAPI/Traffic/channels/<ID>/addrInfo?format=json .
4. Added URLs of configuring radar construction parameters:
Get configuration capability: GET /ISAPI/ITC/radarSetUp/capabilities ;
Get or set parameters: GET or PUT /ISAPI/ITC/radarSetUp .
5. Added the function of triggering capture by the side-mounted radar, refer to Trigger by Side-
Mounted Radar .
6. Extended traffic service capability message XML_TrafficCap (related URL: /ISAPI/Traffic/
capabilities ):
added a node <isSupportUpgradeByUSB> (whether it supports upgrading via USB).
7. Added URLs of upgrading via USB:
Get capability: GET /ISAPI/Traffic/upgradeByUSB/capabilities?format=json ;
Upgrade via USB: PUT /ISAPI/Traffic/upgradeByUSB?format=json ;
Get progress: GET /ISAPI/Traffic/upgradeByUSB/progress?format=json .
8. Added URLs of configuring radar measurement mode:
Get configuration capability: GET /ISAPI/ITC/radarMeasurement/capabilities?format=json ;
Get or set parameters: GET or PUT /ISAPI/ITC/radarMeasurement?format=json .
9. Added URLs of searching for traffic flow statistics:
Get capability: GET /ISAPI/Traffic/ContentMgmt/Statistic/capabilities ;
Search for statistics: POST /ISAPI/Traffic/ContentMgmt/Statistic/operator .
10. Added a sub status code "0x40000010"-USBNotExist (USB device is not connected) to status
code 4 (Invalid Operation) in Response Codes of Text Protocol .

Summary of Changes in Version 2.0_Aug., 2019


Related Product: Traffic Terminal Server with Version 5.0.0

5
Intelligent Security API (Traffic) Developer Guide

1. Added URLs to configure traffic channels, set channel linkage, get algorithm version information,
set data dictionary, and get status, refer to Channel Settings , Channel Linkage , Algorithm
Version , Data Dictionary , and Status Information for details.
2. Added URLs to process traffic data and get data statistics, refer to Traffic Data and Statistics for
details.
3. Added URLs to manage traffic subsystems and get their status, refer to Subsystem Management
for details.
4. Added URLs to search picture by picture, perform manual law enforcement, and manage
blacklist and whitelist, refer to Advanced Functions for details.

Summary of Changes in Version 2.0_Jan., 2019


New document.

6
Intelligent Security API (Traffic) Developer Guide

Chapter 2 Typical Applications

2.1 Capture Trigger Mode


For the traffic cameras, there are multiple trigger modes (or working modes) that can be switched
to trigger traffic capture according to different scenes, such as triggering capture by mixed
checkpoint, intersection violation video, checkpoint radar, side-mounted radar, checkpoint single
I/O, entrance and exit video, and smart surveillance.

Note
• For details about triggering capture by mixed checkpoint, refer to Trigger by Mixed Checkpoint .
• For details about triggering capture by intersection violation video, refer to Trigger by
Intersection Violation Video .
• For details about triggering capture by checkpoint radar, refer to Trigger by Checkpoint Radar .
• For details about triggering capture by side-mounted radar, refer to Trigger by Side-Mounted
Radar .
• For details about triggering capture by checkpoint single I/O, refer to Trigger by Checkpoint
Single I/O .
• For details about triggering capture by entrance and exit video, refer to Trigger by Entrance and
Exit Video .
• For details about triggering capture by smart surveillance, refer to Trigger by Smart
Surveillance .

Get Trigger Mode Capability


Request URL: GET /ISAPI/ITC/TriggerMode/capabilities
Configure ANPR Region for Trigger Mode
Get ANPR Region Parameters of All Trigger Modes
Request URL: GET /ISAPI/ITC/TriggerMode/plateRecognition
Get ANPR Region Capability of One Trigger Mode
Request URL: GET /ISAPI/ITC/TriggerMode/plateRecognition/<ID>/capabilities
Get ANPR Region Parameters of One Trigger Mode
Request URL: GET /ISAPI/ITC/TriggerMode/plateRecognition/<ID>
Set ANPR Region of One Trigger Mode
Request URL: PUT /ISAPI/ITC/TriggerMode/plateRecognition/<ID>

7
Intelligent Security API (Traffic) Developer Guide

Example

Figure 2-1 Integration Example of Capture Trigger Mode

2.1.1 Trigger by Checkpoint Radar


When radar of the checkpoint detected the passed vehicles, capture and vehicle recognition will be
triggered. For this trigger mode, the checkpoint should be center mounted or side mounted.

Checkpoint Radar Configuration

Function Request URI


Get radar speed detection and GET /ISAPI/ITC/TriggerMode/postRadar/capabilities
configuration capability
Get or set trigger mode of GET or PUT /ISAPI/ITC/TriggerMode/postRadar
checkpoint radar
Get or set radar speed GET or PUT /ISAPI/ITC/TriggerMode/postRadar/speed
detection parameters

8
Intelligent Security API (Traffic) Developer Guide

Function Request URI


Get or set radar parameters GET or PUT /ISAPI/ITC/TriggerMode/postRadar/param
Get recommended GET /ISAPI/ITC/TriggerMode/postRadar/recommendSpeed
configurations of radar speed
detection
Get recommended radar GET /ISAPI/ITC/TriggerMode/postRadar/recommendParam
configurations

2.1.2 Trigger by Checkpoint Single I/O


When single I/O (input/output) status of the checkpoint changed, capture and vehicle recognition
will be triggered. For this trigger mode, the checkpoint should be center mounted or side
mounted.

Trigger Mode Configuration of Checkpoint Single I/O

Function Request URI


Get trigger mode capability of GET /ISAPI/ITC/TriggerMode/postSingleIO/capabilities
checkpoint single I/O
Get trigger mode parameters GET /ISAPI/ITC/TriggerMode/postSingleIO
of checkpoint single I/O
Set trigger mode of checkpoint PUT /ISAPI/ITC/TriggerMode/postSingleIO
single I/O

2.1.3 Trigger by Entrance and Exit Video


When video with violations of entrance and exit are analyzed or the single I/O (input/output)
status changed, capture and vehicle recognition will be triggered.

Trigger Mode Configuration of Entrance and Exit Video

Function Request URI


Get trigger mode capability of GET /ISAPI/ITC/TriggerMode/postPRS/capabilities
entrance and exit video
Get trigger mode parameters GET /ISAPI/ITC/TriggerMode/postPRS
of entrance and exit video
Set trigger mode of entrance PUT /ISAPI/ITC/TriggerMode/postPRS
and exit video

9
Intelligent Security API (Traffic) Developer Guide

2.1.4 Trigger by Intersection Violation Video


When video with traffic violations, such as red light running, driving in wrong lane at intersection,
driving on lane line, wrong-way driving, illegal lane change, and so on, of intersection violation
system are analyzed, capture will be triggered. For this trigger mode, the intersection violation
system should be center mounted.

Trigger Mode Configuration of Intersection Violation Video

Function Request URI


Get trigger mode capability of GET /ISAPI/ITC/TriggerMode/videoEpolice/capabilities
intersection violation video
Get trigger mode parameters GET /ISAPI/ITC/TriggerMode/videoEpolice
of intersection violation video
Set trigger mode of PUT /ISAPI/ITC/TriggerMode/videoEpolice
intersection violation video

2.1.5 Trigger by Mixed Checkpoint


When video with traffic violations of mixed checkpoint are analyzed, capture in flash or strobe light
for vehicle, non-vehicle, or human will be triggered. For this trigger mode, the checkpoint should
be center mounted or side mounted.

Trigger Mode Configuration of Mixed Checkpoint

Function Request URI


Get trigger mode capability of GET /ISAPI/ITC/TriggerMode/postHVT/capabilities
mixed checkpoint
Get trigger mode parameters GET /ISAPI/ITC/TriggerMode/postHVT
of mixed checkpoint
Set trigger mode of mixed PUT /ISAPI/ITC/TriggerMode/postHVT
checkpoint

2.1.6 Trigger by Smart Surveillance


When video with traffic violations of monitoring scene are analyzed, capture for vehicle, non-
vehicle, and human will be triggered.

10
Intelligent Security API (Traffic) Developer Guide

Trigger Mode Configuration of Smart Surveillance

Function Request URI


Get trigger mode capability of GET /ISAPI/ITC/TriggerMode/videoMonitor/capabilities
smart surveillance
Get trigger mode parameters GET /ISAPI/ITC/TriggerMode/videoMonitor
of smart surveillance
Set trigger mode of smart PUT /ISAPI/ITC/TriggerMode/videoMonitor
surveillance

2.1.7 Trigger by Side-Mounted Radar


When the radar of the checkpoint detected violations of overspeed, low speed, wrong-way driving,
or driving on the lane line, capture will be triggered. For this trigger mode, the radar should be side
mounted.

Trigger Mode Configuration of Side-Mounted Radar

Function Request URI


Get trigger mode capability of GET /ISAPI/ITC/TriggerMode/postSideRadarSpeed/capabilities
side-mounted radar speed
detection
Get trigger mode parameters GET /ISAPI/ITC/TriggerMode/postSideRadarSpeed
of side-mounted radar speed
detection
Set trigger mode of side- PUT /ISAPI/ITC/TriggerMode/postSideRadarSpeed
mounted radar speed
detection
Get recommended trigger GET /ISAPI/ITC/TriggerMode/postSideRadarSpeed/
mode parameters of side- recommendation?constructionDirection=
mounted radar speed
detection

2.2 Alarm or Event Receiving


When the alarm is triggered or the event occurred, if you have configured alarm/event uploading
parameters, you can receive and process the alarm/event information in the third-party platform

11
Intelligent Security API (Traffic) Developer Guide

or system. Two modes are available for receiving alarms, including arming mode and listening
mode.
Arming Mode
When the alarm is triggered or event occurred, the third-party platform or system can send the
request URL to the device for getting the alarm/event stream, and then the device uploads the
response message with alarm/event information.
Listening Mode
When alarm is triggered or event occurred, the device uploads the alarm information
automatically, and then the third-party platform or system can receives the alarm/event by
configuring listening port of HTTP host server.

Note
Currently, for traffic camera or capture camera, receiving alarm or event in arming mode is not
supported.

2.2.1 Traffic Alarm or Event Types


The traffic related alarm or event types include dock station status alarm, dock station exception
prompt alarm, file uploading (from dock station to platform) exception alarm, dock station
information uploading event, radar measurement data uploading event, and license plate
recognition alarm. Here shows the macro definitions of each event types and the corresponding
event details.

eventType Description Details


dockStationstatus Dock station status alarm, which can JSON_EventNotificationAlert_DockSt
be received in arming or listening ationStatusMsg
mode.
dockStationExcept Dock station exception prompt alarm, JSON_EventNotificationAlert_DockSt
ionPrompt which can be received in arming or ationExceptionAlarmMsg
listening mode.
dockStationFileUp File uploading (from dock station to JSON_EventNotificationAlert_DockSt
loadException platform) exception alarm, see ationFileUploadException
Upload Collected Data to Platform by
Schedule for details.
dockStationInfo Dock station information uploading JSON_EventNotificationAlert_DockSt
event, see Upload Collected Data to ationInfo
Platform by Schedule for details.

12
Intelligent Security API (Traffic) Developer Guide

eventType Description Details


dockStationPoliceI Policeman information uploading JSON_EventNotificationAlert_DockSt
nfo event, which can be received in ationPoliceInfo
arming or listening mode.
radarMeasureme Radar measurement data uploading JSON_EventNotificationAlert_Radar
nt event, which can be received in MeasurementDataMsg
arming or listening mode.
ANPR License plate recognition alarm, see XML_EventNotificationAlert_ANPRM
Configure ANPR Alarm and Configure sg
Blacklist and Whitelist ANPR Alarm
for alarm configurations.

2.2.2 Configure ANPR Alarm


If the vehicle appears in the monitoring image during a certain time period, while the recognition
parameters and alarm parameters are also configured, the ANPR camera captures the vehicle
picture automatically and analyzes the license plate to trigger ANPR alarm.

13
Intelligent Security API (Traffic) Developer Guide

Steps

Figure 2-2 Programming Flow of Configuring ANPR Alarm


1. Call /ISAPI/ITC/capability by GET method to check whether the device supports ANPR.

14
Intelligent Security API (Traffic) Developer Guide

The traffic capability is returned in the message XML_ITCCap .


If the node <isSupportVehicleDetection> is returned in the capability message and the value is
"true", it indicates that the device supports ANPR, and then you can perform the following steps
to realize the function.
Otherwise, the function is not supported by the device, please end the task.
2. Call /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode by PUT method to enable ANPR.
3. Call /ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities by GET method to get ANPR
configuration capability.
4. Optional: Call /ISAPI/Traffic/channels/<ID>/vehicleDetect by GET method to get default or
configured ANPR parameters for reference.
5. Call /ISAPI/Traffic/channels/<ID>/vehicleDetect by PUT method to set ANPR parameters.
6. Optional: Call /ISAPI/Traffic/channels/<ID>/picParam/capabilities by GET method to get OSD
configuration capability.
7. Optional: Call /ISAPI/Traffic/channels/<ID>/picParam by PUT method to set OSD parameters
for displaying information on alarm picture.

Note
Before setting OSD parameters, you'd better call the corresponding URI by GET method to get
the configured or existing parameters for reference.
8. Perform one of the following operations to set arming schedule of ANPR alarm.
- Call /ISAPI/Event/schedules/vehicledetects by PUT method to set arming schedule of all
channels.
- Call /ISAPI/Event/schedules/vehicledetects/<ID> by PUT method to set arming schedule by
channel.

Note
Before setting arming schedule, you'd better call the corresponding URI by GET method to get
the default or configured parameters for reference.
9. Perform one of the following operations to set ANPR alarm linkage.
- Call /ISAPI/Traffic/channels/<ID>/eventTrigger by PUT method.
- Call /ISAPI/Event/triggers/<eventType>-<ID> by PUT method and set the <ID> in the URI to
"vehicledetection-<channelID>" (e.g., /ISAPI/Event/triggers/vehicledetection-101).

Note
If you want to receive the alarm in the platform, the linkage action must be set as "center"
(upload to center).
10. Optional: Call /ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json by PUT
method to filter the duplicated license plates and receive the same alarm just for once.

15
Intelligent Security API (Traffic) Developer Guide

Note
To check whether the device supports filtering duplicated license plates, you can call /ISAPI/
Traffic/channels/<ID>/capabilities by GET method to get the traffic channel capability
( XML_TrafficChannelCap ). If it supports, the node <isSupportFiltration> will be returned in
the capability message and its value is "true".
11. Optional: Set eventType to "ANPR" and receive ANPR alarm in arming mode (see Receive
Alarm/Event in Arming Mode ) or listening mode (see Receive ANPR Alarm in Listening
Mode ).

Note
Currently, for traffic camera or capture camera, receiving alarm or event in arming mode is not
supported.
The ANPR alarm details are returned in the message XML_EventNotificationAlert_ANPRMsg .

2.2.3 Configure Blacklist and Whitelist ANPR Alarm


You can manage the vehicles in blacklist and whitelist to control the entry of vehicles. After
analyzing the captured vehicle picture, the license plate number will be compared with those in
blacklist or whitelist, if matched in blacklist, the entry of vehicles are not allowed; if matched in
whitelist, the vehicle are allowed to enter. The comparison results can be uploaded as the blacklist
and whitelist ANPR alarm to the platform.

16
Intelligent Security API (Traffic) Developer Guide

Steps

Figure 2-3 Programming Flow of Configuring Blacklist and Whitelist ANPR Alarm
1. Call /ISAPI/ITC/capability by GET method to check whether the device supports ANPR.

17
Intelligent Security API (Traffic) Developer Guide

The traffic capability is returned in the message XML_ITCCap .


If the node <isSupportVehicleDetection> is returned in the capability message and the value is
"true", it indicates that the device supports ANPR, and you can perform the following steps.
Otherwise, the function is not supported by the device, please end the task.
2. Call /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode by PUT method to enable ANPR.
3. Call /ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities by GET method to get the ANPR
configuration capability.
4. Optional: Call /ISAPI/Traffic/channels/<ID>/vehicleDetect by GET method to get default or
configured ANPR parameters for reference.
5. Call /ISAPI/Traffic/channels/<ID>/vehicleDetect by PUT method to set ANPR parameters.
6. Optional: Call /ISAPI/Traffic/channels/<ID>/picParam/capabilities by GET method to get OSD
configuration capability.
7. Optional: Call /ISAPI/Traffic/channels/<ID>/picParam by PUT method to set OSD parameters.

Note
Before setting OSD parameters, you'd better call the corresponding URL by GET method to get
the default or configured parameters for reference.
8. Optional: Call /ISAPI/Traffic/channels/<ID>/searchLPListAudit by POST method to search for
default or configured blacklist or whitelist.
9. Optional: Call /ISAPI/Traffic/plateList by GET method to export the default or configured
license plate blacklist or whitelist.
10. Call /ISAPI/Traffic/channels/<ID>/licensePlateAuditData by GET method to export the
template of license plate list.
11. Import the blacklist or whitelist to be compared.
- Call /ISAPI/Traffic/channels/<ID>/licensePlateAuditData by PUT method to fill in the
template and import the blacklist or whitelist.
- Call /ISAPI/Traffic/plateList by PUT to import the blacklist or whitelist.
12. Perform one of the following operations to set the arming schedule.
- Set the arming schedule of all channels.
• Call /ISAPI/Event/schedules/vehicledetects by PUT method to set the arming schedule for
blacklist and whitelist ANPR alarm.
• Call /ISAPI/Event/schedules/blackList by PUT method to set the arming schedule for
blacklist ANPR alarm.
• Call /ISAPI/Event/schedules/whiteList by PUT method to set the arming schedule for
whitelist ANPR alarm.
- Set the arming schedule of a specific channel.

18
Intelligent Security API (Traffic) Developer Guide

• Call /ISAPI/Event/schedules/vehicledetects/<ID> by PUT and set <ID> in the URI to


"vehicledetection-<channelID>" (e.g., /ISAPI/Event/schedules/vehicledetects/
vehicledetection-101) for setting the arming schedule of blacklist and whitelist ANPR.
• Call /ISAPI/Event/schedules/blackList/<ID> by PUT and set <ID> in the URI to "blacklist-
<channelID>" (e.g., /ISAPI/Event/schedules/vehicledetects/blacklist-101) for setting the
arming schedule of blacklist ANPR.
• Call /ISAPI/Event/schedules/whiteList/<ID> by PUT and set <ID> in the URI to "whitelist-
<channelID>" (e.g., /ISAPI/Event/schedules/vehicledetects/whitelist-101) for setting the
arming schedule of whitelist ANPR.
13. Optional: Call /ISAPI/Event/triggersCap by GET to get the configuration capability of ANPR
alarm linkage.
14. Perform one of the following operations to set the linkage action.
- Call /ISAPI/Event/triggers/<eventType>-<ID> by PUT method and set the <ID> in the URI to
"vehicledetection-<channelID>" (e.g., /ISAPI/Event/Trigger/vehicledetection-101) for setting
the linkage action of blacklist and whitelist ANPR alarm.

Note
You can also call /ISAPI/Traffic/channels/<ID>/eventTrigger by PUT method to set the
linkage action of blacklist and whitelist ANPR alarm.
- Call /ISAPI/Event/triggers/<eventType>-<ID> by PUT method and set the <ID> in the URI to
"blacklist-<channelID>" (e.g., /ISAPI/Event/Trigger/blacklist-101) for setting the linkage
action of blacklist ANPR alarm.
- Call /ISAPI/Event/triggers/<eventType>-<ID> by PUT method and set the <ID> in the URI to
"whitelist-<channelID>" (e.g., /ISAPI/Event/Trigger/whitelist-101) for setting the linkage
action of whitelist ANPR alarm.

Note
If you want to receive the alarm in the platform, the linkage action must be set as "center"
(upload to center).
15. Optional: Set eventType to "ANPR" and receive blacklist and whitelist ANPR alarm in arming
mode (see Receive Alarm/Event in Arming Mode ) or listening mode (see Receive ANPR Alarm
in Listening Mode ).

Note
Currently, for traffic camera or capture camera, receiving alarm or event in arming mode is not
supported.
The details of blacklist and whitelist ANPR alarm is returned in the message
XML_EventNotificationAlert_ANPRMsg .

19
Intelligent Security API (Traffic) Developer Guide

2.2.4 Receive ANPR Alarm in Listening Mode


When the ANPR alarm is triggered, and the alarm linkage is configured, the device will
automatically upload the alarm information, you can configure the listening address and port of
HTTP listening server to receive the alarm.
Before You Start
Make sure you have configured alarm parameters (refer to Configure ANPR Alarm and Configure
Blacklist and Whitelist ANPR Alarm for details) and the alarm is triggered.
Steps

Figure 2-4 API Calling Flow of Receiving ANPR Alarm in Listening Mode
1. Call /ISAPI/Event/notification/httpHosts/capabilities by GET method to get the capability of
HTTP listening server.
The HTTP listening server capability is returned in the message XML_HttpHostNotificationCap .
2. Check whether the node <ANPR> is returned in the listening server capability.
- If the node <ANPR> is returned in the capability, you can continue to perform the following
steps.

20
Intelligent Security API (Traffic) Developer Guide

- If the capability does not contain node <ANPR>, it indicates that receiving ANPR alarm in
listening mode is not supported, please end this task.
3. Check whether the value of sub node <alarmHttpPushProtocol> of node <ANPR> in the
listening server capability message is "custom".
- If the value of node <alarmHttpPushProtocol> is "custom", perform step 4.
- If the value of node <alarmHttpPushProtocol> is not "custom", please directly perform step
6.
4. Optional: Call /ISAPI/Traffic/ANPR/alarmHttpPushProtocol by GET method to get the current
alarm receiving protocol for reference.
The alarm receiving protocol information is returned in the message
XML_AlarmHttpPushProtocol .
5. Call /ISAPI/Traffic/ANPR/alarmHttpPushProtocol by PUT method to set the node
<baseLineProtocolEnabled> of XML_AlarmHttpPushProtocol to "true" for switching the alarm
receiving protocol.
6. Call /ISAPI/Event/notification/httpHosts/<ID> or /ISAPI/Event/notification/httpHosts by PUT
method to set the parameters (including listening address and listening port No.) of a or
multiple HTTP listening server(s).

Note
Before setting the listening server, you'd better call this URL by GET method to get default or
configured parameters for reference.
7. Call /ISAPI/Event/notification/httpHosts/<ID>/test by POST method to check whether the
listening server is working normally.
8. Call http://<ipAddress>:<portNo>/<url> by POST method to receive the ANPR alarm
information from the listening server.

2.2.5 Receive Alarm/Event in Arming Mode


When alarm is triggered or event occurred, and the alarm/event linkage is configured, you can
send request message to device for getting the alarm/event stream, and then the device uploads
the corresponding response message, which contains alarm/event information.
Before You Start
Make sure you have configured alarm/event and triggered the alarm/event. For configuring alarm/
event parameters, refer to the some typical applications of alarm/event configuration.

21
Intelligent Security API (Traffic) Developer Guide

Steps

Figure 2-5 API Calling Flow of Receiving Alarm/Event in Arming Mode


1. Call /ISAPI/Event/notification/alertStream by GET to get the alarm/event stream.
2. Check if the heartbeat receiving timed out or network disconnected.
- If the heartbeat keeps alive and the network still connected, perform the following step to
continue.
- If the heartbeat receiving timed out or network disconnected, perform the above step
repeatedly until reconnected.
3. Receive and process the alarm/event information.
Example
Sample Code of Receiving Alarm/Event in Arming Mode (without Binary Picture Data)
GET /ISAPI/Event/notification/alertStream HTTP/1.1
Host: data_gateway_ip
Connection: Keep-Alive

HTTP/1.1 401 Unauthorized


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

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


Authorization: Digest username="admin",

22
Intelligent Security API (Traffic) Developer Guide

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

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

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

<EventNotificationAlert/>
--<frontier>

Note
Some alarm data is in JSON format, so the Content-Type may be "application/xml" or "application/
json".

2.2.6 Receive Alarm/Event in Listening Mode


When alarm is triggered or event occurred, and the alarm/event linkage is configured, the device
uploads the alarm/event information automatically, you can receive the alarm/event by
configuring the listening port of HTTP host server.
Before You Start
Make sure you have configured alarm/event and triggered the alarm/event. For configuring alarm/
event parameters, refer to the some typical applications of alarm/event configuration.

23
Intelligent Security API (Traffic) Developer Guide

Steps

Figure 2-6 API Calling Flow of Receiving Alarm/Event in Listening Mode


1. Optional: Call /ISAPI/Event/notification/httpHosts/capabilities by GET method to get the
capability of HTTP listening server.
2. Call /ISAPI/Event/notification/httpHosts by PUT method to set the parameters (including
listening address and listening port) of HTTP listening server.

Note
Before setting the listening server, you'd better call the URI by GET method to get the default or
configured parameters for reference.
3. Call /ISAPI/Event/notification/httpHosts/<ID>/test by POST method to check if the listening
server is working normally.
4. Call http://<ipAddress>:<portNo>/<url> by POST method to receive the alarm/event
information from the listening server.
Example
Sample Code of Receiving Alarm/Event in Listening Mode
• with Binary Picture Data
//Request
POST requestUrl HTTP/1.1
Host: data_gateway_ip:port
Accept-Language: en-US
Date: YourDate
Content-Type: multipart/form-data;boundary=<frontier>
Content-Length: body_length
Connection: keep-alive

--<frontier>

24
Intelligent Security API (Traffic) Developer Guide

Content-Disposition: form-data; name="Event_Type"


Content-Type: text/xml
Content-Length: xml_length

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

[binary picture data]


--<frontier>--

//Response
HTTP/1.1 HTTP statusCode
Date: YourDate
Connection: close
• without Binary Picture Data
//Request
POST requestUrl HTTP/1.1
Host: data_gateway_ip:port
Accept-Language: en-US
Date: YourDate
Content-Type: text/xml;
Content-Length: text_length
Connection: Close

<EventNotificationAlert/>

//Response
HTTP/1.1 HTTP statusCode
Date: YourDate
Connection: close

Note
• The Host is the HTTP server domain name or IP address and port No.
• Some alarm data is in JSON format, so the Content-Type may be "text/xml" or "text/json".

2.3 Traffic Data and Statistics

Data Processing
• Get capability of searching for or deleting vehicle passing data
Request URL: GET /ISAPI/Traffic/ContentMgmt/dataOperation/capabilities
• Search for or delete vehicle passing data
Request URL: POST /ISAPI/Traffic/ContentMgmt/dataOperation
• Search for picture and video according to vehicle passing data

25
Intelligent Security API (Traffic) Developer Guide

Request URL: POST /ISAPI/Traffic/ContentMgmt/picRecInfo


• Get data of a picture
Request URL: GET /ISAPI/Traffic/ContentMgmt/Picture/<datatype>

Data Uploading
• Get data uploading capability
Request URL: GET /ISAPI/Traffic/ContentMgmt/RemoteHost/capabilities
• Get parameters of remote host servers
Request URL: GET /ISAPI/Traffic/ContentMgmt/RemoteHost
• Get or set parameters of a remote host server
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/RemoteHost/<ID>
• Upload data again
Request URL: PUT /ISAPI/Traffic/ContentMgmt/RemoteHost/UploadCtrl
• Search for the uploaded and uploading data statistics by time
Request URL: POST /ISAPI/Traffic/ContentMgmt/RemoteHost/Statistics

Traffic Flow Statistics


• Get traffic flow statistics capability
Request URL: GET /ISAPI/Traffic/ContentMgmt/Statistic/capabilities
• Get or set parameters of traffic flow statistics
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/Statistic/config
• Search for, delete, or format the traffic flow statistics
Request URL: POST /ISAPI/Traffic/ContentMgmt/Statistic/operator

2.4 Subsystem Management

Configuration
• Get configuration capability of traffic subsystem
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/capabilities
• Get or set parameters of traffic light detection system
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LightCfg
• Get or set parameters of power system
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/PowerCfg

Note
To search for the power system data, you can call the request URL /ISAPI/Traffic/ContentMgmt/
SlaveSystem/searchData/powerData by POST method.
• Get or set parameters of LCD control system
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LcdCfg

26
Intelligent Security API (Traffic) Developer Guide

Status
• Get statuses of all subsystems
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status
• Get status of traffic light detection system
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LightStatus
• Get status of power system
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/PowerStatus
• Get status of LCD control system
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LcdStatus
• Get status of analog system
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/AnalogStatus
• Get status of optical terminal
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/OPTStatus
• Get status of TX1 subsystem
Request URL: GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/TX1Status

2.5 Dock Station


Dock station works with Digital Evidence Management System. It provides you a simplified way to
access, back up, store data, and play audio and video files in body camera. You can associate user
accounts and body cameras with platform, search collection records, and upload data in the
platform.

Note
The body camera is a wearable forensic equipment with the functions of video and audio
recording, real-time location and 4G network transmission. It is used by the police officers to
record law enforcement.

2.5.1 Back Up File to Central Storage


Storage server can be connected to the body camera to extend the data storage space of the
camera. You can save or back up the files to the central storage.

27
Intelligent Security API (Traffic) Developer Guide

Steps

Figure 2-7 Programming Flow of Backing Up File to Central Storage

28
Intelligent Security API (Traffic) Developer Guide

1. Call /ISAPI/System/deviceInfo/capabilities by GET method to get device configuration


capability and check whether the device supports enabling backup in central storage.
The device configuration capability is returned in the message XML_Cap_DeviceInfo .
If the node centralStorageBackupEnabled exists in the returned message and its value is "true",
it indicates that enabling backup in central storage is supported and you can perform the
following steps; otherwise, this function is not supported, please end this task.
2. Configure cloud storage parameters.
1) Optional: Call /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>/capabilities by GET
method to get cloud storage capability.
2) Optional: Call /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID> by GET method to
get default or configured cloud storage parameters for reference.
3) Call /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID> by PUT method to set cloud
storage parameters.

Note
You can call /ISAPI/ContentMgmt/channels/<ID>/cloudStorage by GET or PUT method to
get or set parameters of cloud storage in a batch.
4) Optional: Call /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/test by POST method to
perform cloud storage test to check whether it is working normally.
3. Call /ISAPI/System/deviceInfo by PUT method to set centralStorageBackupEnabled to "true" to
enable backup in the central storage.
4. Optional: Call /ISAPI/ContentMgmt/record/control/centralStorageBackup/capabilities?
format=json by GET method to get backup capability of central storage.
5. Call /ISAPI/ContentMgmt/record/control/centralStorageBackup?format=json by PUT method
to back up data files to central storage.

2.5.2 Upload Collected Data to Platform by Schedule


You can set schedules for uploading collected data to the platform and set listening server to
receive data in listening mode.

29
Intelligent Security API (Traffic) Developer Guide

Steps

Figure 2-8 Programming Flow of Uploading Collected Data to Platform by Schedule


1. Optional: Call /ISAPI/Traffic/DockStation/PlatformConfig/schedule/capabilities?format=json
by GET method to get schedule configuration capability of uploading collected data to platform.
2. Optional: Call /ISAPI/Traffic/dockStation/platformConfig/schedule?format=json by GET
method to get default or configured uploading schedule for reference.
3. Call /ISAPI/Traffic/dockStation/platformConfig/schedule?format=json by PUT method to set
uploading schedule.
4. Set listening server and enable listening to receive collected data or exception information from
dock station, refer to Receive Alarm/Event in Listening Mode .

Note
If exception occurred during the uploading, the exception details and the heartbeat information
will also be uploaded in the message
JSON_EventNotificationAlert_DockStationFileUploadException and
JSON_EventNotificationAlert_HeartBeat for further processing and checking.
The data is uploaded in the message JSON_EventNotificationAlert_DockStationInfo .

30
Intelligent Security API (Traffic) Developer Guide

2.5.3 Dock Station Settings

Information Notification

Get information notification GET /ISAPI/Traffic/dockStation/information/capabilities?


capability format=json
Set information notification PUT /ISAPI/Traffic/dockStation/information?format=json
parameters and notify

Storage Bin

Open storage bin of dock PUT /ISAPI/Traffic/dockStation/slot/open?format=json


station
Set collection priority of PUT ISAPI/Traffic/dockStation/slot/priorityCollection?
storage bin format=json

Basic Configuration

Get or set basic parameters of GET or PUT /ISAPI/Traffic/dockStation/basicInfo?format=json


dock station

Person Management

Get person management GET /ISAPI/Traffic/dockStation/personManagement/


capability of dock station capabilities?format=json
Get or set all persons' GET or PUT /ISAPI/Traffic/dockStation/personManagement?
information of dock station format=json
Add a person to dock station POST /ISAPI/Traffic/dockStation/personManagement?
format=json
Delete all persons of dock DELETE /ISAPI/Traffic/dockStation/personManagement?
station format=json
Get or set a person's GET or PUT /ISAPI/Traffic/dockStation/personManagement/
information of dock station <ID>?format=json
Delete a person of dock station DELETE /ISAPI/Traffic/dockStation/personManagement/<ID>?
format=json

31
Intelligent Security API (Traffic) Developer Guide

Body Camera Management

Get body camera management GET /ISAPI/Traffic/dockStation/deviceManagement/


capability of dock station capabilities?format=json
Get all body cameras' GET /ISAPI/Traffic/dockStation/deviceManagement?
information of dock station format=json
Add a body camera to dock POST /ISAPI/Traffic/dockStation/deviceManagement?
station format=json
Get or set a body camera's GET or PUT /ISAPI/Traffic/dockStation/deviceManagement/
information of dock station <ID>?format=json
Delete a body camera of dock DELETE /ISAPI/Traffic/dockStation/deviceManagement/<ID>?
station format=json

Policeman Management

Function Request URI


Get or set parameters of GET or PUT /ISAPI/ContentMgmt/policeUpload?format=json
uploading policeman
information to dock station.
Get or set information of a GET or PUT /ISAPI/ContentMgmt/police/<policeID>?
policeman format=json
Delete a policeman DELETE /ISAPI/ContentMgmt/police/<policeID>?format=json
Get or set information of all GET or PUT /ISAPI/ContentMgmt/police?format=json
policemen
Add a policeman POST /ISAPI/ContentMgmt/police?format=json

File Uploading

Function Request URI


Get file quantity of dock station GET /ISAPI/ContentMgmt/count

Note
To check whether it supports getting the file quantity, you can
call /ISAPI/ContentMgmt/capabilities by GET method to get
the device storage capability ( XML_RacmCap ). If supports, the
node <CMSearchCount> will be returned.

Get or set file uploading GET or PUT /ISAPI/ContentMgmt/fileUpload?format=json


parameters of dock station

32
Intelligent Security API (Traffic) Developer Guide

2.6 Configuration and Maintenance

2.6.1 Algorithm Version


• Get algorithm version information of traffic device
Request URL: GET /ISAPI/Traffic/algVersionInfo
• Get algorithm version information of traffic subsystem
Request URL: GET /ISAPI/Traffic/slaveVersionInfo
• Get algorithm log capability
Request URL: GET /ISAPI/Traffic/algLog/capabilities
• Get algorithm log status
Request URL: GET /ISAPI/Traffic/algLog

2.6.2 Channel Linkage

Face Evidence Channel


• Get linkage configuration capability of face evidence channel
Request URL: GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/capabilities

Note
To get or set face evidence parameters, you can call the request URL /ISAPI/Traffic/
ContentMgmt/FaceEvidence/config by GET or PUT method.
• Get or set linkage parameters of all face evidence channels
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/
config
• Get linkages of all face evidence channels or add a linkage for face evidence channel
Request URL: GET or POST /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch
• Get, edit, or delete linkages of a face evidence channel
Request URL: GET, PUT, or DELETE /ISAPI/Traffic/ContentMgmt/FaceEvidence/
FaceChannelMatch/<ID>
• Get linkage statuses of all face evidence channels
Request URL: GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/status

Normal Channel
• Get configuration capability of channel linkage
Request URL: GET /ISAPI/Traffic/ContentMgmt/ChannelMatch/capabilities
• Get or set linkage parameters of all channels
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/ChannelMatch/config
• Get linkages of all channels or add a linkage for channel
Request URL: GET or POST /ISAPI/Traffic/ContentMgmt/ChannelMatch

33
Intelligent Security API (Traffic) Developer Guide

• Get, edit, or delete linkages of a channel


Request URL: GET, PUT, or DELETE /ISAPI/Traffic/ContentMgmt/ChannelMatch/<ID>
• Get information of channels with no linkage configured
Request URL: GET /ISAPI/Traffic/ContentMgmt/ChannelMatch/unusedChannel

Section Speed Detection Channel


• Get linkage configuration capability of section speed detection channel
Request URL: GET /ISAPI/Traffic/ContentMgmt/Section/capabilities

Note
To get or set section speed detection parameters, you can call the request URL /ISAPI/Traffic/
ContentMgmt/Section/config by GET or PUT method.
• Get linkages of all section speed detection channels or add a linkage for section speed detection
channel
Request URL: GET or POST /ISAPI/Traffic/ContentMgmt/Section
• Get, edit, or delete linkages of a section speed detection channel
Request URL: GET, PUT, or DELETE /ISAPI/Traffic/ContentMgmt/Section/<ID>
• Get information of section speed detection channels with no linkage configured
Request URL: GET /ISAPI/Traffic/ContentMgmt/Section/unusedChannel

2.6.3 Channel Settings


• Get capability of a traffic channel
Request URL: GET /ISAPI/Traffic/channels/<ID>/capabilities
• Get configuration capability of traffic channels or cameras
Request URL: GET /ISAPI/Traffic/ContentMgmt/InputProxy/channels/capabilities
• Get or set parameters of multiple traffic channels
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/InputProxy/channels
• Get or set parameters of a traffic channel
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>
• Get or set parameters of a traffic camera
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>/basic

2.6.4 Data Dictionary


• Get traffic violation dictionary capability
Request URL: GET /ISAPI/ITC/illegalDictionary/capabilities
• Get or set traffic violation dictionary
Request URL: GET or PUT /ISAPI/ITC/illegalDictionary
• Reset traffic violation dictionary
Request URL: PUT /ISAPI/ITC/illegalDictionary/reset
• Get capability of traffic law enforcement dictionary

34
Intelligent Security API (Traffic) Developer Guide

Request URL: GET /ISAPI/ITC/EvidenceDictionary/capabilities

Note
You can call the request URL /ISAPI/ITC/capabilities by GET method to check if the traffic law
enforcement dictionary is supported.
• Get or set traffic law enforcement dictionary
Request URL: GET or PUT /ISAPI/ITC/EvidenceDictionary
• Reset traffic law enforcement dictionary
Request URL: PUT /ISAPI/ITC/EvidenceDictionary/reset

2.6.5 Status Information


• Get connection status of network interface
Request URL: GET /ISAPI/Traffic/ContentMgmt/netPortStatus
• Get network status of a or multiple data uploading module(s)
Request URL: GET /ISAPI/Traffic/ContentMgmt/uploadModuleStatus or /ISAPI/Traffic/
ContentMgmt/uploadModuleStatus/<ID>
• Get status information of a traffic light
Request URL: GET /ISAPI/Traffic/ContentMgmt/trafficLightStatus/<ID>
• Get camera status by channel
Request URL: GET /ISAPI/Traffic/ContentMgmt/chanDevStatus/<ID>
• Get the latest traffic status
Request URL: GET /ISAPI/Traffic/ContentMgmt/realTrafficStats
• Get GPS status of terminal server
Request URL: GET /ISAPI/Traffic/ContentMgmt/GPS/Status
• Get arming status of a or multiple device(s) that linked with terminal server
Request URL: GET /ISAPI/Traffic/ContentMgmt/fortifyStatus or /ISAPI/Traffic/ContentMgmt/
fortifyStatus/<ID>
• Get wireless module status
Request URL: GET /ISAPI/Traffic/ContentMgmt/wirelessDialStatus

2.7 Advanced Functions

Search Picture by Picture


• Get capability of searching picture by picture
Request URL: GET /ISAPI/Traffic/ContentMgmt/picModel/capabilities
• Get or set parameters of searching picture by picture
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/picModel

Manage Blacklist and Whitelist


• Automatically Update Blacklist

35
Intelligent Security API (Traffic) Developer Guide

• Get configuration capability of automatic blacklist update


Request URL: GET /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/capabilities?
format=json
• Get or set parameters of automatic blacklist update
Request URL: GET or PUT /ISAPI/Traffic/ContentMgmt/autoUpdateblackList?format=json
• Get last updated time of blacklist
Request URL: GET /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/lastUpdateTime?
format=json
• Import or Export Blacklist and Whitelist
• Import or delete list, or search items in the list
Request URL: PUT, POST, or DELETE /ISAPI/ITC/Entrance/VCL
• Get or set parameters of blacklist and whitelist
Request URL: GET or PUT /ISAPI/ITC/Entrance/VCL/config

Overlay Address Information


• Get capability of overlaying address information
Request URL: GET /ISAPI/Traffic/channels/<ID>/addrInfo/capabilities?format=json
• Get or set parameters of overlaying address information
Request URL: GET or PUT /ISAPI/Traffic/channels/<ID>/addrInfo?format=json

Note
To check if overlaying address information is supported by the device, you can call the request URL:
GET /ISAPI/Traffic/channels/<ID>/capabilities to get the traffic channel capability
( XML_TrafficChannelCap ). If this function is supported, the node <isSupportAddrInfo> will be
returned and its value is "true".

Configure Radar Construction Parameters


• Get configuration capability of radar construction
Request URL: GET /ISAPI/ITC/radarSetUp/capabilities
• Get or set radar construction parameters
Request URL: GET or PUT /ISAPI/ITC/radarSetUp

Note
To check if configuring radar construction is supported by the device, you can call the request URL:
GET /ISAPI/ITC/capabilities to get the intelligent traffic configuration capability ( XML_ITCCap ). If
this function is supported, the node <isSupportRadarSetUp> will be returned and its value is
"true".

Configure Radar Measurement Mode


• Get configuration capability of radar measurement mode
Request URL: GET /ISAPI/ITC/radarMeasurement/capabilities?format=json
• Get or set radar measurement mode

36
Intelligent Security API (Traffic) Developer Guide

Request URL: GET or PUT /ISAPI/ITC/radarMeasurement?format=json

Note
• To check if configuring radar measurement mode is supported by the device, you can call GET /
ISAPI/ITC/capabilities to get the intelligent traffic configuration capability ( XML_ITCCap ). If this
function is supported, the node <isSupportRadarMeasurement> will be returned and its value is
"true".
• After the radar measurement is enabled, the radar measurement data will be uploaded in the
message JSON_EventNotificationAlert_RadarMeasurementDataMsg .

Upgrade via USB


• Get capability of upgrading via USB
Request URL: GET /ISAPI/Traffic/upgradeByUSB/capabilities?format=json
• Upgrade via USB
Request URL: PUT /ISAPI/Traffic/upgradeByUSB?format=json
• Get progress of upgrading via USB
Request URL: GET /ISAPI/Traffic/upgradeByUSB/progress?format=json

Note
To check if upgrading via USB is supported by the device, you can call the request URL: GET /ISAPI/
Traffic/capabilities to get the traffic capability ( XML_TrafficCap ). If this function is supported, the
node <isSupportUpgradeByUSB> will be returned and its value is "true".

Mixed Traffic Detection


• Get capability of mixed traffic detection
Request URL: GET /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/capabilities
• Get or set parameters of mixed traffic detection
Request URL: GET or PUT /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects
• Get or set parameters of mixed traffic detection by scene
Request URL: GET or PUT /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/<SID>

Manage Audio File List


• Get Audio File List
Request URI: GET /ISAPI/Parking/channels/<ID>/VoiceFileList
• Delete Audio File List
Request URI: DELETE /ISAPI/Parking/channels/<ID>/VoiceFileList

Note
To check whether the device supports getting or deleting the audio file list, you can call /ISAPI/
Parking/TME/capabilities by GET method to get the ticket dispenser device capability.

37
Intelligent Security API (Traffic) Developer Guide

The capability is returned in the message XML_TMECap . If this function is supported, the node
<isSupportVoiceFileList> will be returned in the message and its value is true.

Configure Voice Prompt


• Get Voice Prompt Configuration Capability
Request URI: GET /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo/capabilities
• Get Voice Prompt Parameters
Request URI: GET /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo
• Set Voice Prompt Parameters
Request URI: PUT /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo

38
Intelligent Security API (Traffic) Developer Guide

Appendix A. Request URIs

A.1 /ISAPI/ContentMgmt/capabilities
Get storage capability.

Request URI Definition


Table A-1 GET /ISAPI/ContentMgmt/capabilities
Method GET
Description Get storage capability.
Query None.
Request None.
Response Succeeded: XML_RacmCap
Failed: XML_ResponseStatus

A.2 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage
Get or set the access parameters of cloud storage in a batch.

Request URI Definition


Table A-2 GET /ISAPI/ContentMgmt/channels/<ID>/cloudStorage
Method GET
Description Get the access parameters of cloud storage in a batch.
Query None.
Request None.
Response Succeeded: XML_CloudStorageList
Failed: XML_ResponseStatus
Table A-3 PUT /ISAPI/ContentMgmt/channels/<ID>/cloudStorage
Method PUT
Description Set the access parameters of cloud storage in a batch.
Query None.

39
Intelligent Security API (Traffic) Developer Guide

Request XML_CloudStorageList
Response XML_ResponseStatus

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

A.3 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>
Get or set access parameters of specified cloud storage.

Request URI Definition


Table A-4 GET /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>
Method GET
Description Get the access parameters of specified cloud storage.
Query None.
Request None.
Response Succeeded: XML_CloudStorage
Failed: XML_ResponseStatus
Table A-5 PUT /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>
Method PUT
Description Set the access parameters of specified cloud storage.
Query None.
Request XML_CloudStorage
Response XML_ResponseStatus

Remarks
The first <ID> in the URI refers to the channel ID, and the second <ID> in the URI refers to cloud
storage server ID.

A.4 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>/capabilities
Get the cloud storage access capability.

40
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-6 GET /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>/capabilities
Method GET
Description Get the cloud storage access capability.
Query None.
Request None.
Response XML_Cap_CloudStorage

Remarks
The first <ID> in the URI refers to channel No., the default value is 1, and second <ID> refers to
cloud storage server ID, which starts from 1.

A.5 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/serverParam
Get the parameters of accessed cloud storage. Now this API only supports getting the parameters
of the video and image cloud storage server.

Request URI Definition


Table A-7 GET /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/serverParam
Method GET
Description Get the server parameters of accessed cloud storage.
Query None.
Request None.
Response Succeeded: XML_CloudStorageServerList
Failed: XML_ResponseStatus

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

A.6 /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/test
Test accessing cloud storage.

41
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-8 POST /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/test
Method POST
Description Test accessing cloud storage.
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.
Request XML_CloudStorageTestDescription
Response Succeeded: XML_CloudStorageTestResult
Failed: XML_ResponseStatus

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

A.7 /ISAPI/ContentMgmt/count
Get the file quantity of dock station.

Request URI Definition


Table A-9 GET /ISAPI/ContentMgmt/count
Method GET
Description Get the file quantity of dock station.
Query None.
Request XML_DockStation_CMSearchDescription
Response Succeeded: XML_CMSearchCount
Failed: XML_ResponseStatus

A.8 /ISAPI/ContentMgmt/fileUpload?format=json
Get or set the file upload parameters of dock station.

42
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-10 GET /ISAPI/ContentMgmt/fileUpload?format=json
Method GET
Description Get the file upload parameters of dock station.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_DockStation_FileUpload
Failed: JSON_ResponseStatus
Table A-11 PUT /ISAPI/ContentMgmt/fileUpload?format=json
Method PUT
Description Set the file upload parameters of dock station.
Query format: determine the format of request or response message.
Request JSON_DockStation_FileUpload
Response JSON_ResponseStatus

A.9 /ISAPI/ContentMgmt/police/<policeID>?format=json
Operate the information of a specified policeman.

Request URI Definition


Table A-12 GET /ISAPI/ContentMgmt/police/<policeID>?format=json
Method GET
Description Get the information of a specified policeman.
Query format: determine the format of request or response message.
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.
Request None.
Response Succeeded: JSON_PoliceInfo

43
Intelligent Security API (Traffic) Developer Guide

Failed: JSON_ResponseStatus
Table A-13 PUT /ISAPI/ContentMgmt/police/<policeID>?format=json
Method PUT
Description Edit the information of a specified policeman.
Query format: determine the format of request or response message.
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.
Request JSON_PoliceInfo
Response JSON_ResponseStatus
Table A-14 DELETE /ISAPI/ContentMgmt/police/<policeID>?format=json
Method DELETE
Description Delete the information of a specified policeman.
Query format: determine the format of request or response message.
Request None.
Response JSON_ResponseStatus

A.10 /ISAPI/ContentMgmt/police?format=json
Operate the information of multiple policemen.

Request URI Definition


Table A-15 GET /ISAPI/ContentMgmt/police?format=json
Method GET
Description Get the information of multiple policemen.
Query format: determine the format of request or response message.
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

44
Intelligent Security API (Traffic) Developer Guide

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.
Request None.
Response Succeeded: JSON_PoliceInfoList
Failed: JSON_ResponseStatus
Table A-16 PUT /ISAPI/ContentMgmt/police?format=json
Method PUT
Description Edit the information of multiple policemen.
Query format: determine the format of request or response message.
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.
Request JSON_PoliceInfoList
Response JSON_ResponseStatus
Table A-17 POST /ISAPI/ContentMgmt/police?format=json
Method POST
Description Add the information of multiple policemen in a batch.
Query format: determine the format of request or response message.
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.
Request JSON_PoliceInfoList
Response JSON_ResponseStatus

45
Intelligent Security API (Traffic) Developer Guide

A.11 /ISAPI/ContentMgmt/policeUpload?format=json
Get or set the configuration parameters of uploading policeman information to dock station.

Request URI Definition


Table A-18 GET /ISAPI/ContentMgmt/policeUpload?format=json
Method GET
Description Get the configuration parameters of uploading policeman
information to dock station.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_PoliceInfoUpload
Failed: JSON_ResponseStatus
Table A-19 PUT /ISAPI/ContentMgmt/policeUpload?format=json
Method PUT
Description Set the parameters of uploading policeman information to dock
station.
Query format: determine the format of request or response message.
Request JSON_PoliceInfoUpload
Response JSON_ResponseStatus

A.12 /ISAPI/ContentMgmt/record/control/centralStorageBackup/
capabilities?format=json
Get the capability of central storage backup.

Request URI Definition


Table A-20 GET /ISAPI/ContentMgmt/record/control/centralStorageBackup/capabilities?
format=json
Method GET
Description Get the capability of central storage backup.
Query format: determine the format of request or response message.

46
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: JSON_Cap_CentralStorageBackupFileList
Failed: JSON_ResponseStatus

A.13 /ISAPI/ContentMgmt/record/control/centralStorageBackup?
format=json
Set parameters of central storage backup.

Request URI Definition


Table A-21 PUT /ISAPI/ContentMgmt/record/control/centralStorageBackup?format=json
Method PUT
Description Set parameters of central storage backup.
Query format: determine the format of request or response message.
Request JSON_CentralStorageBackupFileList
Response JSON_ResponseStatus

A.14 /ISAPI/Event/notification/alertStream
Get the uploaded heartbeat or alarm/event information.

Request URI Definition


Table A-22 GET /ISAPI/Event/notification/alertStream
Method GET
Description Get the heartbeat or uploaded alarm/event information.
Query None.
Request None.
Response Option 1: XML_EventNotificationAlert_AlarmEventInfo or
XML_EventNotificationAlert_HeartbeatInfo
Option 2: JSON_EventNotificationAlert_Alarm/EventInfo

47
Intelligent Security API (Traffic) Developer Guide

Note
The messages here only show the format of alarm/event
information to be uploaded. For details, refer to the corresponding
alarm/event configuration chapters.

Remarks
• After calling this URI, a persistent connection is set up between the device and the platform, and
the alarm or event information will be uploaded from device continuously once the alarm is
triggered or event occurred.
• You can check if the XML response message is the heartbeat information according to the nodes
<eventType> and <eventState>. If the values of these two node are "videoloss" and "inactive",
respectively, the returned message is the heartbeat information.

A.15 /ISAPI/Event/notification/httpHosts
Get or set parameters of all HTTP listening servers, add a HTTP listening server, and delete all HTTP
listening servers.

Request URI Definition


Table A-23 GET /ISAPI/Event/notification/httpHosts
Method GET
Description Get parameters of all HTTP listening servers.
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.
Request None
Response Succeeded: XML_HttpHostNotificationList
Failed: XML_ResponseStatus
Table A-24 PUT /ISAPI/Event/notification/httpHosts
Method PUT
Description Set parameters of all HTTP listening servers.
Query security: the version No. of encryption scheme. When security does
not exist, it indicates that the data is not encrypted; when security is

48
Intelligent Security API (Traffic) Developer Guide

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.
Request XML_HttpHostNotificationList
Response XML_ResponseStatus
Table A-25 POST /ISAPI/Event/notification/httpHosts
Method POST
Description Add a HTTP listening server.
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.
Request XML_HttpHostNotification
Response XML_ResponseStatus
Table A-26 DELETE /ISAPI/Event/notification/httpHosts
Method DELETE
Description Delete all HTTP listening servers.
Query None
Request None
Response XML_ResponseStatus

A.16 /ISAPI/Event/notification/httpHosts/<ID>
Get or set the parameters of a HTTP listening server, and delete a HTTP listening server.

Request URI Definition


Table A-27 GET /ISAPI/Event/notification/httpHosts/<ID>
Method GET
Description Get the parameters of a HTTP listening server.

49
Intelligent Security API (Traffic) Developer Guide

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.
Request None
Response Succeeded: XML_HttpHostNotification
Failed: XML_ResponseStatus
Table A-28 PUT /ISAPI/Event/notification/httpHosts/<ID>
Method PUT
Description Set the parameters of a HTTP listening server.
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.
Request XML_HttpHostNotification
Response XML_ResponseStatus
Table A-29 DELETE /ISAPI/Event/notification/httpHosts/<ID>
Method DELETE
Description Delete a HTTP listening server.
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.
Request None
Response XML_ResponseStatus

Remarks
The <ID> in the request URI refers to the HTTP listening server No.

50
Intelligent Security API (Traffic) Developer Guide

A.17 /ISAPI/Event/notification/httpHosts/<ID>/test
Check whether the HTTP listening server is working normally.

Request URI Definition


Table A-30 POST /ISAPI/Event/notification/httpHosts/<ID>/test
Method POST
Description Check whether the HTTP listening server is working normally.
Query None
Request XML_HttpHostNotification
Response Succeeded: XML_HttpHostTestResult
Failed: XML_ResponseStatus

Remarks
The <ID> in the request URI refers to the HTTP listening server ID.

A.18 /ISAPI/Event/notification/httpHosts/capabilities
Get the configuration capabilities of all HTTP listening servers.

Request URI Definition


Table A-31 GET /ISAPI/Event/notification/httpHosts/capabilities
Method GET
Description Get the configuration capabilities of all HTTP listening servers.
Query None
Request None
Response Succeeded: XML_HttpHostNotificationCap
Failed: XML_ResponseStatus

A.19 /ISAPI/Event/schedules/blackList
Get or set arming schedule of blacklist ANPR of all channels.

51
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-32 GET /ISAPI/Event/schedules/blackList
Method GET
Description Get arming schedule of blacklist ANPR of all channels.
Query None
Request None
Response Succeeded: XML_BlackListScheduleList
Failed: XML_ResponseStatus
Table A-33 PUT /ISAPI/Event/schedules/blackList
Method PUT
Description Set arming schedule of blacklist ANPR of all channels.
Query None
Request XML_BlackListScheduleList
Response XML_ResponseStatus

A.20 /ISAPI/Event/schedules/blackList/<ID>
Get or set arming schedule of blacklist ANPR by channel.

Request URI Definition


Table A-34 GET /ISAPI/Event/schedules/blackList/<ID>
Method GET
Description Get arming schedule of blacklist ANPR by channel.
Query None
Request None
Response Succeeded: XML_Schedule
Failed: XML_ResponseStatus
Table A-35 PUT /ISAPI/Event/schedules/blackList/<ID>
Method PUT
Description Set arming schedule of blacklist ANPR by channel.
Query None

52
Intelligent Security API (Traffic) Developer Guide

Request XML_Schedule
Response XML_ResponseStatus

Remarks
The <ID> in the request URI consists of alarm category string (e.g., blacklist) and alarm triggered
channel ID (e.g., 101). For example, "blacklist-101".

A.21 /ISAPI/Event/schedules/vehicledetects
Get or set ANPR arming schedules of all channels.

Request URL Definition


Table A-36 GET /ISAPI/Event/schedules/vehicledetects
Method GET
Description Get ANPR arming schedules of all channels.
Query None
Request None
Response Succeeded: XML_VehicleDetectScheduleList
Failed: XML_ResponseStatus
Table A-37 PUT /ISAPI/Event/schedules/vehicledetects
Method PUT
Description Set ANPR arming schedules of all channels.
Query None
Request XML_VehicleDetectScheduleList
Response XML_ResponseStatus

A.22 /ISAPI/Event/schedules/vehicledetects/<ID>
Get or set the arming schedule of blacklist and whitelist ANPR by channel.

Request URI Definition


Table A-38 GET /ISAPI/Event/schedules/vehicledetects/<ID>
Method GET
Description Get the arming schedule of blacklist and whitelist ANPR by channel.

53
Intelligent Security API (Traffic) Developer Guide

Query None
Request None
Response Succeeded: XML_Schedule
Failed: XML_ResponseStatus
Table A-39 PUT /ISAPI/Event/schedules/vehicledetects/<ID>
Method PUT
Description Set the arming schedule of blacklist and whitelist ANPR by channel.
Query None
Request XML_Schedule
Response XML_ResponseStatus

Remarks
The <ID> in the request URI consists of alarm category string (e.g., vehicledetection) and alarm
triggered channel ID (e.g., 101). For example, "vehicledetection-101".

A.23 /ISAPI/Event/schedules/whiteList
Get or set arming schedule of whitelist ANPR of all channels.

Request URI Definition


Table A-40 GET /ISAPI/Event/schedules/whiteList
Method GET
Description Get arming schedule of whitelist ANPR of all channels.
Query None
Request None
Response Succeeded: XML_WhiteListScheduleList
Failed: XML_ResponseStatus
Table A-41 PUT /ISAPI/Event/schedules/whiteList
Method PUT
Description Set arming schedule of whitelist ANPR of all channels.
Query None
Request XML_WhiteListScheduleList
Response XML_ResponseStatus

54
Intelligent Security API (Traffic) Developer Guide

A.24 /ISAPI/Event/schedules/whiteList/<ID>
Get or set arming schedule of whitelist ANPR by channel.

Request URI Definition


Table A-42 GET /ISAPI/Event/schedules/whiteList/<ID>
Method GET
Description Get arming schedule of whitelist ANPR by channel.
Query None
Request None
Response Succeeded: XML_Schedule
Failed: XML_ResponseStatus
Table A-43 PUT /ISAPI/Event/schedules/whiteList/<ID>
Method PUT
Description Set arming schedule of whitelist ANPR by channel.
Query None
Request XML_Schedule
Response XML_ResponseStatus

Remarks
The <ID> in the request URI consists of alarm category string (e.g.,whitelist) and alarm triggered
channel ID (e.g., 101). For example, "whitelist-101".

A.25 /ISAPI/Event/triggers/<eventType>-<ID>
Get, set, or delete the alarm linkage action by channel.

Request URI Definition


Table A-44 GET /ISAPI/Event/triggers/<eventType>-<ID>
Method GET
Description Get the alarm linkage action by channel.
Query None

55
Intelligent Security API (Traffic) Developer Guide

Request None
Response Succeeded: XML_EventTrigger
Failed: XML_ResponseStatus
Table A-45 PUT /ISAPI/Event/triggers/<eventType>-<ID>
Method PUT
Description Set the alarm linkage action by channel.
Query None
Request XML_EventTrigger
Response XML_ResponseStatus
Table A-46 DELETE /ISAPI/Event/triggers/<eventType>-<ID>
Method DELETE
Description Delete the alarm linkage action by channel.
Query None
Request None
Response XML_ResponseStatus

Remarks
The <eventType> in the request URI refers to the predefined event or alarm type name, and the
<ID> is the No. of the event detection channel. For example, if the No. of the face capture channel
is 101, the "<eventType>-<ID>" is "faceSnap-101".

A.26 /ISAPI/Event/triggersCap
Get alarm linkage capability.

Request URI Definition


Table A-47 GET /ISAPI/Event/triggersCap
Method GET
Description Get alarm linkage capability.
Query None
Request None
Response Succeeded: XML_EventTriggersCap
Failed: XML_ResponseStatus

56
Intelligent Security API (Traffic) Developer Guide

A.27 http://<ipAddress>:<portNo>/<url>
HTTP listening sever sends alarm information to alarm center.

Request URL Definition


Table A-48 POST http://<ipAddress>:<portNo>/<url>
Method POST
Description HTTP listening sever sends alarm information to alarm center.
Query None
Request None
Response Succeeded: XML_EventNotificationAlert_AlarmEventInfo or
JSON_EventNotificationAlert_Alarm/EventInfo
Failed: XML_ResponseStatus

Remarks
• The <ipAddress> in the request URL refers to the IP address or domain name of HTTP listening
server, the <portNo> is the port No. of HTTP listening server, and the <url> represents the
streaming URL, which is configured via the HTTP listening server.
• The default port No. is 80, so the request URL without port No. is also valid.

A.28 /ISAPI/ITC/capability
Get intelligent traffic capability.

Request URI Definition


Table A-49 GET /ISAPI/ITC/capability
Method GET
Description Get intelligent traffic capability
Query None.
Request None.
Response Succeeded: XML_ITCCap
Failed: XML_ResponseStatus

57
Intelligent Security API (Traffic) Developer Guide

A.29 /ISAPI/ITC/capabilities
Get the intelligent traffic configuration capability.

Request URI Definition


Table A-50 GET /ISAPI/ITC/capabilities
Method GET
Description Get the intelligent traffic configuration capability.
Query None.
Request None.
Response Succeeded: XML_ITCCap
Failed: XML_ResponseStatus

A.30 /ISAPI/ITC/carFeatureParam
Operations about the vehicle feature configuration parameters.

Request URI Definition


Table A-51 GET /ISAPI/ITC/carFeatureParam
Method GET
Description Get the vehicle feature configuration parameters.
Query None.
Request None.
Response Succeeded: XML_CarFeatureParam
Failed: XML_ResponseStatus
Table A-52 PUT /ISAPI/ITC/carFeatureParam
Method PUT
Description Set the vehicle feature configuration parameters.
Query None.
Request XML_CarFeatureParam
Response XML_ResponseStatus

58
Intelligent Security API (Traffic) Developer Guide

A.31 /ISAPI/ITC/carFeatureParam/capabilities
Get the vehicle feature parameters capability.

Request URI Definition


Table A-53 GET /ISAPI/ITC/carFeatureParam/capabilities
Method GET
Description Get the vehicle feature parameters capability.
Query None.
Request None.
Response Succeeded: XML_Cap_CarFeatureParam
Failed: XML_ResponseStatus

A.32 /ISAPI/ITC/continueCap
Upload captured pictures and information.

Request URI Definition


Table A-54 PUT /ISAPI/ITC/continueCap
Method PUT
Description Upload captured pictures and information.
Query None.
Request XML_continueCapCmd
Response Picture data.

A.33 /ISAPI/ITC/continueCap/capabilities
Get the continuous capture capability when illegal actions are detected.

59
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-55 GET /ISAPI/ITC/continueCap/capabilities
Method GET
Description Get the continuous capture capability when illegal actions are
detected.
Query None.
Request None.
Response Succeeded: XML_Cap_ContinueCapCmd
Failed: XML_ResponseStatus

A.34 /ISAPI/ITC/Entrance/barrierGateCtrl
Set parameters to control the barrier gate.

Request URI Definition


Table A-56 PUT /ISAPI/ITC/Entrance/barrierGateCtrl
Method PUT
Description Set parameters to control the barrier gate, such as falling the gate,
rising the gate, stopping the gate at a certain position, and locking
the gate.
Query None
Request XML_BarrierGateCtrl
Response XML_ResponseStatus

A.35 /ISAPI/ITC/Entrance/capabilities
Get entrance and exit capability.

Request URI Definition


Table A-57 GET /ISAPI/ITC/Entrance/capabilities
Method GET
Description Get entrance and exit capability.
Query None.

60
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_EntranceCap
Failed: XML_ResponseStatus

A.36 /ISAPI/ITC/Entrance/entranceParam
Operations about the entrance and exit configuration of traffic cameras.

Request URI Definition


Table A-58 GET /ISAPI/ITC/Entrance/entranceParam
Method GET
Description Get the entrance and exit parameters of traffic cameras.
Query None.
Request None.
Response Succeeded: XML_EntranceParamList
Failed: XML_ResponseStatus
Table A-59 PUT /ISAPI/ITC/Entrance/entranceParam
Method PUT
Description Set the entrance and exit parameters of traffic cameras.
Query None.
Request XML_EntranceParamList
Response XML_ResponseStatus

A.37 /ISAPI/ITC/Entrance/entranceParam/capbilities
Get the entrance and exit parameter capability of traffic cameras.

Request URI Definition


Table A-60 GET /ISAPI/ITC/Entrance/entranceParam/capbilities
Method GET
Description Get the entrance and exit parameter capability of traffic cameras.
Query None.

61
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_Cap_entranceParam
Failed: XML_ResponseStatus

A.38 /ISAPI/ITC/Entrance/lampCtrl
Set the supplement light control configuration of the entrance and exit device.

Request URI Definition


Table A-61 PUT /ISAPI/ITC/Entrance/lampCtrl
Method PUT
Description Set the supplement light control parameters of the entrance and exit
device to turn on or turn off the supplement light.
Query None.
Request XML_LampCtrl
Response XML_ResponseStatus

A.39 /ISAPI/ITC/Entrance/VCL
Import or delete blacklist and whitelist, or search items in the list.

Request URI Definition


Table A-62 PUT /ISAPI/ITC/Entrance/VCL
Method PUT
Description Import blacklist and whitelist.
Query None.
Request XML_SetVCLData
Response XML_ResponseStatus
Table A-63 POST /ISAPI/ITC/Entrance/VCL
Method POST
Description Search items in the list.
Query None.

62
Intelligent Security API (Traffic) Developer Guide

Request XML_VCLGetCond
Response XML_VCLData
Table A-64 DELETE /ISAPI/ITC/Entrance/VCL
Method DELETE
Description Delete blacklist and whitelist.
Query None.
Request XML_VCLDelCond
Response XML_ResponseStatus

A.40 /ISAPI/ITC/Entrance/VCL/config
Get or set parameters of blacklist and whitelist.

Request URI Definition


Table A-65 GET /ISAPI/ITC/Entrance/VCL/config
Method GET
Description Get parameters of blacklist and whitelist.
Query None.
Request None.
Response Succeeded: XML_VCLCfg
Failed: XML_ResponseStatus
Table A-66 PUT /ISAPI/ITC/Entrance/VCL/config
Method PUT
Description Set parameters of blacklist and whitelist.
Query None.
Request XML_VCLCfg
Response XML_ResponseStatus

A.41 /ISAPI/ITC/Entrance/WizardDeviceInfo/<ID>
Operations about the device information configuration in wizard for entrance and exit capture unit.

63
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-67 GET /ISAPI/ITC/Entrance/WizardDeviceInfo/<ID>
Method GET
Description Get the device information configuration parameters in wizard for
entrance and exit capture unit.
Query None.
Request None.
Response Succeeded: XML_WizardDeviceInfo
Failed: XML_ResponseStatus
Table A-68 PUT /ISAPI/ITC/Entrance/WizardDeviceInfo/<ID>
Method PUT
Description Set the device information configuration parameters in wizard for
entrance and exit capture unit.
Query None.
Request XML_WizardDeviceInfo
Response XML_ResponseStatus

A.42 /ISAPI/ITC/Entrance/WizardDeviceInfo/capabilities
Get the configuration capability of device information in wizard for entrance and exit capture unit.

Request URI Definition


Table A-69 GET /ISAPI/ITC/Entrance/WizardDeviceInfo/capabilities
Method GET
Description Get the configuration capability of device information in wizard for
entrance and exit capture unit.
Query None.
Request None.
Response Succeeded: XML_Cap_WizardDeviceInfo
Failed: XML_ResponseStatus

64
Intelligent Security API (Traffic) Developer Guide

A.43 /ISAPI/ITC/Entrance/WizardFirstLogin/<ID>
Operations about the wizard configuration of login for the first time.

Request URI Definition


Table A-70 GET /ISAPI/ITC/Entrance/WizardFirstLogin/<ID>
Method GET
Description Get the wizard parameters of login for the first time.
Query None.
Request None.
Response Succeeded: XML_WizardFirstLogin
Failed: XML_ResponseStatus
Table A-71 PUT /ISAPI/ITC/Entrance/WizardFirstLogin/<ID>
Method PUT
Description Set the wizard parameters of login for the first time.
Query None.
Request XML_WizardFirstLogin
Response XML_ResponseStatus

A.44 /ISAPI/ITC/Entrance/WizardFirstLogin/<ID>/capabilities
Get the wizard capability of login for the first time.

Request URI Definition


Table A-72 GET /ISAPI/ITC/Entrance/WizardFirstLogin/<ID>/capabilities
Method GET
Description Get the wizard capability of login for the first time.
Query None.
Request None.
Response Succeeded: XML_Cap_WizardFirstLogin
Failed: XML_ResponseStatus

65
Intelligent Security API (Traffic) Developer Guide

A.45 /ISAPI/ITC/EvidenceDictionary
Get or set parameters of traffic law enforcement dictionary.

Request URI Definition


Table A-73 GET /ISAPI/ITC/EvidenceDictionary
Method GET
Description Get parameters of traffic law enforcement dictionary.
Query None.
Request None.
Response Succeeded: XML_EvidenceDictionary
Failed: XML_ResponseStatus
Table A-74 PUT /ISAPI/ITC/EvidenceDictionary
Method PUT
Description Set parameters of traffic law enforcement dictionary.
Query None.
Request XML_EvidenceDictionary
Response XML_ResponseStatus

A.46 /ISAPI/ITC/EvidenceDictionary/capabilities
Get capability of traffic law enforcement dictionary.

Request URI Definition


Table A-75 GET /ISAPI/ITC/EvidenceDictionary/capabilities
Method GET
Description Get capability of traffic law enforcement dictionary.
Query None.
Request None.
Response Succeeded: XML_EvidenceDictionaryCap
Failed: XML_ResponseStatus

66
Intelligent Security API (Traffic) Developer Guide

A.47 /ISAPI/ITC/EvidenceDictionary/reset
Restore traffic law enforcement dictionary to default settings.

Request URI Definition


Table A-76 PUT /ISAPI/ITC/EvidenceDictionary/reset
Method PUT
Description Restore traffic law enforcement dictionary to default settings.
Query None.
Request None.
Response XML_ResponseStatus

A.48 /ISAPI/ITC/illegalDictionary
Get or set parameters of traffic violation dictionary.

Request URI Definition


Table A-77 GET /ISAPI/ITC/illegalDictionary
Method GET
Description Get parameters of traffic violation dictionary.
Query None.
Request None.
Response Succeeded: XML_IllegalDictionary
Failed: XML_ResponseStatus
Table A-78 PUT /ISAPI/ITC/illegalDictionary
Method PUT
Description Set parameters of traffic violation dictionary.
Query None.
Request XML_IllegalDictionary
Response XML_ResponseStatus

67
Intelligent Security API (Traffic) Developer Guide

A.49 /ISAPI/ITC/illegalDictionary/capabilities
Get the traffic violation dictionary capability.

Request URI Definition


Table A-79 GET /ISAPI/ITC/illegalDictionary/capabilities
Method GET
Description Get the traffic violation dictionary capability.
Query None.
Request None.
Response XML_Cap_IllegalDictionary

A.50 /ISAPI/ITC/illegalDictionary/reset
Restore the traffic violation dictionary to default settings.

Request URI Definition


Table A-80 PUT /ISAPI/ITC/illegalDictionary/reset
Method PUT
Description Restore the traffic violation dictionary to default settings.
Query None.
Request None.
Response XML_ResponseStatus

A.51 /ISAPI/ITC/ITCSetUp
Operations about the camera construction configuration.

Request URI Definition


Table A-81 GET /ISAPI/ITC/ITCSetUp
Method GET
Description Get the camera construction parameters.
Query None.

68
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_ITCSetUp
Failed: XML_ResponseStatus
Table A-82 PUT /ISAPI/ITC/ITCSetUp
Method PUT
Description Set the camera construction parameters,
Query None.
Request XML_ITCSetUp
Response XML_ResponseStatus

A.52 /ISAPI/ITC/ITCSetUp/capabilities
Get the camera construction capability.

Request URI Definition


Table A-83 GET /ISAPI/ITC/ITCSetUp/capabilities
Method GET
Description Get the camera construction capability.
Query None.
Request None.
Response Succeeded: XML_Cap_ITCSetUp
Failed: XML_ResponseStatus

A.53 /ISAPI/ITC/ITCStatus/capabilities
Get the device status capability.

Request URI Definition


Table A-84 GET /ISAPI/ITC/ITCStatus/capabilities
Method GET
Description Get the device status capability.
Query None.

69
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_ITCStatusCap
Failed: XML_ResponseStatus

A.54 /ISAPI/ITC/ITCStatus/detectorStatus
Get the vehicle detector status.

Request URI Definition


Table A-85 GET /ISAPI/ITC/ITCStatus/detectorStatus
Method GET
Description Get the vehicle detector status.
Query None.
Request None.
Response Succeeded: XML_DetectorStatus
Failed: XML_ResponseStatus

A.55 /ISAPI/ITC/ITCStatus/fortifyLinkstatus?channelID=
Specify a channel to get the corresponding arming status or get the arming status of channel No.1.

Request URI Definition


Table A-86 GET /ISAPI/ITC/ITCStatus/fortifyLinkstatus
Method GET
Description Specify a channel to get the corresponding arming status or get the
arming status of channel No.1.
Query (Optional) channelID: this parameter is used to specify a channel to
get the corresponding arming status; if this parameter is not
contained in the URL, by default, the arming status of channel No.1
will be obtained.
Request None.
Response Succeeded: XML_FortifyLinkStatus
Failed: XML_ResponseStatus

70
Intelligent Security API (Traffic) Developer Guide

A.56 /ISAPI/ITC/ITCStatus/previewStatus
Get the live view status.

Request URI Definition


Table A-87 GET /ISAPI/ITC/ITCStatus/previewStatus
Method GET
Description Get the live view status.
Query None.
Request None.
Response Succeeded: XML_PreviewStatus
Failed: XML_ResponseStatus

A.57 /ISAPI/ITC/PlateRecognitionParam
Get or set ANPR parameters.

Request URI Definition


Table A-88 GET /ISAPI/ITC/PlateRecognitionParam
Method GET
Description Get ANPR parameters.
Query None
Request None
Response Succeeded: XML_PlateRecognitionParam
Failed: XML_ResponseStatus
Table A-89 PUT /ISAPI/ITC/PlateRecognitionParam
Method PUT
Description Set ANPR parameters.
Query None
Request XML_PlateRecognitionParam
Response XML_ResponseStatus

71
Intelligent Security API (Traffic) Developer Guide

A.58 /ISAPI/ITC/plateRecognitionParam/capabilities
Get ANPR configuration capability.

Request URI Definition


Table A-90 GET /ISAPI/ITC/plateRecognitionParam/capabilities
Method GET
Description Get ANPR configuration capability.
Query None
Request None
Response Succeeded: XML_Cap_PlateRecognitionParam
Failed: XML_ResponseStatus

A.59 /ISAPI/ITC/Entrance/entranceParam
Operations about the entrance and exit configuration of traffic cameras.

Request URI Definition


Table A-91 GET /ISAPI/ITC/Entrance/entranceParam
Method GET
Description Get the entrance and exit parameters of traffic cameras.
Query None.
Request None.
Response Succeeded: XML_EntranceParamList
Failed: XML_ResponseStatus
Table A-92 PUT /ISAPI/ITC/Entrance/entranceParam
Method PUT
Description Set the entrance and exit parameters of traffic cameras.
Query None.
Request XML_EntranceParamList
Response XML_ResponseStatus

72
Intelligent Security API (Traffic) Developer Guide

A.60 /ISAPI/ITC/radarMeasurement/capabilities?format=json
Get the configuration capability of the radar measurement mode.

Request URI Definition


Table A-93 GET /ISAPI/ITC/radarMeasurement/capabilities?format=json
Method GET
Description Get the configuration capability of the radar measurement mode.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_RadarMeasurement
Failed: JSON_ResponseStatus

A.61 /ISAPI/ITC/radarMeasurement?format=json
Get or set the radar measurement mode.

Request URI Definition


Table A-94 GET /ISAPI/ITC/radarMeasurement?format=json
Method GET
Description Get the radar measurement mode.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_RadarMeasurement
Failed: JSON_ResponseStatus
Table A-95 PUT /ISAPI/ITC/radarMeasurement?format=json
Method PUT
Description Set the radar measurement mode.
Query format: determine the format of request or response message.
Request JSON_RadarMeasurement
Response JSON_ResponseStatus

73
Intelligent Security API (Traffic) Developer Guide

A.62 /ISAPI/ITC/radarSetUp
Get or set the radar construction parameters.

Request URI Definition


Table A-96 GET /ISAPI/ITC/radarSetUp
Method GET
Description Get the radar construction parameters.
Query None.
Request None.
Response Succeeded: XML_RadarSetUp
Failed: XML_ResponseStatus
Table A-97 PUT /ISAPI/ITC/radarSetUp
Method PUT
Description Set the radar construction parameters.
Query None.
Request XML_RadarSetUp
Response XML_ResponseStatus

A.63 /ISAPI/ITC/radarSetUp/capabilities
Get the configuration capability of radar construction.

Request URI Definition


Table A-98 GET /ISAPI/ITC/radarSetUp/capabilities
Method GET
Description Get the configuration capability of radar construction.
Query None.
Request None.
Response Succeeded: XML_Cap_RadarSetUp
Failed: XML_ResponseStatus

74
Intelligent Security API (Traffic) Developer Guide

A.64 /ISAPI/ITC/Snapshot/channels/<ID>/capabilities
Get the captured picture encoding capability.

Request URI Definition


Table A-99 GET /ISAPI/ITC/Snapshot/channels/<ID>/capabilities
Method GET
Description Get the captured picture encoding capability.
Query None.
Request None.
Response Succeeded: XML_Cap_CapResInfo
Failed: XML_ResponseStatus

A.65 /ISAPI/ITC/Snapshot/channels/<ID>/capResInfo
Operations about the captured picture encoding configuration.

Request URI Definition


Table A-100 GET /ISAPI/ITC/Snapshot/channels/<ID>/capResInfo
Method GET
Description Get the captured picture encoding parameters.
Query None.
Request None.
Response Succeeded: XML_CapResolution
Failed: XML_ResponseStatus
Table A-101 PUT /ISAPI/ITC/Snapshot/channels/<ID>/capResInfo
Method PUT
Description Set the captured picture encoding parameters.
Query None.
Request XML_CapResolution
Response XML_ResponseStatus

75
Intelligent Security API (Traffic) Developer Guide

A.66 /ISAPI/ITC/TotalCap
Get the device capability.

Request URI Definition


Table A-102 GET /ISAPI/ITC/TotalCap
Method GET
Description Get the device capability.
Query None.
Request None.
Response Succeeded: XML_ITCTotalCap
Failed: XML_ResponseStatus

A.67 /ISAPI/ITC/trafficParam
Operations about the configuration of traffic parameters of cameras.

Request URI Definition


Table A-103 GET /ISAPI/ITC/trafficParam
Method GET
Description Get the traffic parameters of cameras.
Query None.
Request None.
Response Succeeded: XML_TrafficParam
Failed: XML_ResponseStatus
Table A-104 PUT /ISAPI/ITC/trafficParam
Method PUT
Description Set the traffic parameters of cameras.
Query None.
Request XML_TrafficParam
Response XML_ResponseStatus

76
Intelligent Security API (Traffic) Developer Guide

A.68 /ISAPI/ITC/trafficParam/capabilities
Get the traffic parameters capability of cameras.

Request URI Definition


Table A-105 GET /ISAPI/ITC/trafficParam/capabilities
Method GET
Description Get the traffic parameters capability of cameras.
Query None.
Request None.
Response Succeeded: XML_Cap_TrafficParam
Failed: XML_ResponseStatus

A.69 /ISAPI/ITC/TriggerMode/capabilities
Get trigger mode capability of traffic cameras.

Request URI Definition


Table A-106 GET /ISAPI/ITC/TriggerMode/capabilities
Method GET
Description Get trigger mode capability of traffic cameras.
Query None.
Request None.
Response Succeeded: XML_Cap_TriggerMode
Failed: XML_ResponseStatus

A.70 /ISAPI/ITC/TriggerMode/plateRecognition
Get the license plate recognition configuration parameters of all trigger modes.

77
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-107 GET /ISAPI/ITC/TriggerMode/plateRecognition
Method GET
Description Get the license plate recognition parameters of all trigger modes.
Query None.
Request None.
Response XML_PlateRecognitionList

A.71 /ISAPI/ITC/TriggerMode/plateRecognition/<ID>
Operations about the license plate recognition configuration of a specific trigger mode.

Request URI Definition


Table A-108 GET /ISAPI/ITC/TriggerMode/plateRecognition/<ID>
Method GET
Description Get the license plate recognition parameters of a specific trigger
mode.
Query None.
Request None.
Response Succeeded: XML_PlateRecognition
Failed: XML_ResponseStatus
Table A-109 PUT /ISAPI/ITC/TriggerMode/plateRecognition/<ID>
Method PUT
Description Set the license plate recognition parameters of a specific trigger
mode.
Query None.
Request XML_PlateRecognition
Response XML_ResponseStatus

Remarks
The <ID> in the request URI refers to the trigger mode ID.

78
Intelligent Security API (Traffic) Developer Guide

A.72 /ISAPI/ITC/TriggerMode/plateRecognition/<ID>/capabilities
Get the license plate recognition configuration capability of a specific trigger mode.

Request URI Definition


Table A-110 GET /ISAPI/ITC/TriggerMode/plateRecognition/<ID>/capabilities
Method GET
Description Get the license plate recognition configuration capability of a specific
trigger mode.
Query None.
Request None.
Response XML_Cap_PlateRecognition

Remarks
The <ID> in the request URI refers to the trigger mode ID.

A.73 /ISAPI/ITC/TriggerMode/postHVT
Operations about the trigger mode configuration of checkpoint mixed lanes.

Request URI Definition


Table A-111 GET /ISAPI/ITC/TriggerMode/postHVT
Method GET
Description Get the trigger mode parameters of checkpoint mixed lanes.
Query None.
Request None.
Response Succeeded: XML_PostHVT
Failed: XML_ResponseStatus
Table A-112 PUT /ISAPI/ITC/TriggerMode/postHVT
Method PUT
Description Set the trigger mode of checkpoint mixed lanes.
Query None.

79
Intelligent Security API (Traffic) Developer Guide

Request XML_PostHVT
Response XML_ResponseStatus

A.74 /ISAPI/ITC/TriggerMode/postHVT/capabilities
Get the trigger mode configuration capability of checkpoint mixed lanes.

Request URI Definition


Table A-113 GET /ISAPI/ITC/TriggerMode/postHVT/capabilities
Method GET
Description Get the trigger mode configuration capability of checkpoint mixed
lanes.
Query None.
Request None.
Response Succeeded: XML_Cap_PostHVT
Failed: XML_ResponseStatus

A.75 /ISAPI/ITC/TriggerMode/postPRS
Operations about the trigger mode configuration of ANPR system.

Request URI Definition


Table A-114 GET /ISAPI/ITC/TriggerMode/postPRS
Method GET
Description Get the trigger mode parameters of ANPR system.
Query None.
Request None.
Response Succeeded: XML_PostPRS
Failed: XML_ResponseStatus
Table A-115 PUT /ISAPI/ITC/TriggerMode/postPRS
Method PUT
Description Set the trigger mode parameters of ANPR system.
Query None.

80
Intelligent Security API (Traffic) Developer Guide

Request XML_PostPRS
Response XML_ResponseStatus

A.76 /ISAPI/ITC/TriggerMode/postPRS/capabilities
Get the trigger mode configuration capability of ANPR system.

Request URI Definition


Table A-116 GET /ISAPI/ITC/TriggerMode/postPRS/capabilities
Method GET
Description Get the trigger mode configuration capability of ANPR system.
Query None.
Request None.
Response Succeeded: XML_Cap_PostPRS
Failed: XML_ResponseStatus

A.77 /ISAPI/ITC/TriggerMode/postRadar
Operations about radar trigger mode configuration of checkpoints.

Request URI Definition


Table A-117 GET /ISAPI/ITC/TriggerMode/postRadar
Method GET
Description Get radar trigger mode parameters of checkpoints.
Query None.
Request None.
Response XML_PostRadar
Table A-118 PUT /ISAPI/ITC/TriggerMode/postRadar
Method PUT
Description Set radar trigger mode parameters of checkpoints.
Query None.

81
Intelligent Security API (Traffic) Developer Guide

Request XML_PostRadar
Response XML_ResponseStatus

A.78 /ISAPI/ITC/TriggerMode/postRadar/capabilities
Get radar trigger mode capability of checkpoints.

Request URI Definition


Table A-119 GET /ISAPI/ITC/TriggerMode/postRadar/capabilities
Method GET
Description Get radar trigger mode capability of checkpoints, i.e., speed
detection parameters and capability.
Query None.
Request None.
Response XML_Cap_PostRadar

A.79 /ISAPI/ITC/TriggerMode/postRadar/param
Operations about radar configuration.

Request URI Definition


Table A-120 GET /ISAPI/ITC/TriggerMode/postRadar/param
Method GET
Description Get radar configuration parameters.
Query None.
Request None.
Response XML_PostRadarParam
Table A-121 PUT /ISAPI/ITC/TriggerMode/postRadar/param
Method PUT
Description Set radar parameters.
Query None.

82
Intelligent Security API (Traffic) Developer Guide

Request XML_PostRadarParam
Response XML_ResponseStatus

A.80 /ISAPI/ITC/TriggerMode/postRadar/recommendParam
Get recommended values for radar configuration.

Request URI Definition


Table A-122 GET /ISAPI/ITC/TriggerMode/postRadar/recommendParam
Method GET
Description Get recommended values for radar configuration.
Query None.
Request None.
Response XML_PostRadarParam

A.81 /ISAPI/ITC/TriggerMode/postRadar/recommendSpeed
Get recommended values for radar speed detection configuration.

Request URI Definition


Table A-123 GET /ISAPI/ITC/TriggerMode/postRadar/recommendSpeed
Method GET
Description Get recommended values for radar speed detection configuration.
Query None.
Request None.
Response XML_PostRadarSpeed

A.82 /ISAPI/ITC/TriggerMode/postRadar/speed
Operations about radar speed detection configuration.

83
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-124 GET /ISAPI/ITC/TriggerMode/postRadar/speed
Method GET
Description Get configuration parameters of radar speed detection.
Query None.
Request None.
Response XML_PostRadarSpeed
Table A-125 PUT /ISAPI/ITC/TriggerMode/postRadar/speed
Method PUT
Description Set parameters of radar speed detection.
Query None.
Request XML_PostRadarSpeed
Response XML_ResponseStatus

A.83 /ISAPI/ITC/TriggerMode/postSideRadarSpeed
Get or set the trigger mode parameters of side-mounted radar speed detection.

Request URI Definition


Table A-126 GET /ISAPI/ITC/TriggerMode/postSideRadarSpeed
Method GET
Description Get the trigger mode parameters of side-mounted radar speed
detection.
Query None.
Request None.
Response Succeeded: XML_PostSideRadarSpeed
Failed: XML_ResponseStatus
Table A-127 PUT /ISAPI/ITC/TriggerMode/postSideRadarSpeed
Method PUT
Description Set the trigger mode parameters of side-mounted radar speed
detection.

84
Intelligent Security API (Traffic) Developer Guide

Query None.
Request XML_PostSideRadarSpeed
Response XML_ResponseStatus

A.84 /ISAPI/ITC/TriggerMode/postSideRadarSpeed/capabilities
Get the trigger mode configuration capability of side-mounted radar speed detection.

Request URI Definition


Table A-128 GET /ISAPI/ITC/TriggerMode/postSideRadarSpeed/capabilities
Method GET
Description Get the trigger mode configuration capability of side-mounted radar
speed detection.
Query None.
Request None.
Response Succeeded: XML_Cap_PostSideRadarSpeed
Failed: XML_ResponseStatus

A.85 /ISAPI/ITC/TriggerMode/postSideRadarSpeed/recommendation?
constructionDirection=
Get the recommended trigger mode parameters of side-mounted radar speed detection.

Request URI Definition


Table A-129 GET /ISAPI/ITC/TriggerMode/postSideRadarSpeed/recommendation?
constructionDirection=
Method GET
Description Get the recommended trigger mode parameters of side-mounted
radar speed detection.
Query constructionDirection: radar construction direction, string, it can be
set to one of the following values: "left"-​construct at left, "right"-
construct at right.
Request None.
Response Succeeded: XML_PostSideRadarSpeed

85
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus

A.86 /ISAPI/ITC/TriggerMode/postSingleIO
Operations about single I/O trigger mode configuration of checkpoints.

Request URI Definition


Table A-130 GET /ISAPI/ITC/TriggerMode/postSingleIO
Method GET
Description Get single I/O trigger mode parameters of checkpoints.
Query None.
Request None.
Response XML_PostSingleIOList
Table A-131 PUT /ISAPI/ITC/TriggerMode/postSingleIO
Method PUT
Description Set single I/O trigger mode parameters of checkpoints.
Query None.
Request XML_PostSingleIOList
Response XML_ResponseStatus

A.87 /ISAPI/ITC/TriggerMode/postSingleIO/capabilities
Get configuration capability of single I/O trigger mode of checkpoints.

Request URI Definition


Table A-132 GET /ISAPI/ITC/TriggerMode/postSingleIO/capabilities
Method GET
Description Get configuration capability of single I/O trigger mode of
checkpoints.
Query None.
Request None.
Response XML_Cap_PostSingleIO

86
Intelligent Security API (Traffic) Developer Guide

A.88 /ISAPI/ITC/TriggerMode/videoEpolice
Operations about the trigger mode configuration of video intersection violation system.

Request URI Definition


Table A-133 GET /ISAPI/ITC/TriggerMode/videoEpolice
Method GET
Description Get the trigger mode parameters of video intersection violation
system.
Query None.
Request None.
Response Succeeded: XML_VideoEpolice
Failed: XML_ResponseStatus
Table A-134 PUT /ISAPI/ITC/TriggerMode/videoEpolice
Method PUT
Description Set the trigger mode parameters of video intersection violation
system.
Query None.
Request XML_VideoEpolice
Response XML_ResponseStatus

A.89 /ISAPI/ITC/TriggerMode/videoEpolice/capabilities
Get the trigger mode capability of video intersection violation system.

Request URI Definition


Table A-135 GET /ISAPI/ITC/TriggerMode/videoEpolice/capabilities
Method GET
Description Get the trigger mode capability of video intersection violation
system.
Query None.
Request None.
Response Succeeded: XML_Cap_VideoEpolice

87
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus

A.90 /ISAPI/ITC/TriggerMode/videoMonitor
Operations about the trigger mode configuration of smart surveillance.

Request URI Definition


Table A-136 GET /ISAPI/ITC/TriggerMode/videoMonitor
Method GET
Description Get the trigger mode parameters of smart surveillance.
Query None.
Request None.
Response Succeeded: XML_VideoMonitor
Failed: XML_ResponseStatus
Table A-137 PUT /ISAPI/ITC/TriggerMode/videoMonitor
Method PUT
Description Set the trigger mode parameters of smart surveillance.
Query None.
Request XML_VideoMonitor
Response XML_ResponseStatus

A.91 /ISAPI/ITC/TriggerMode/videoMonitor/capabilities
Get the multiple-frame recognition mode capability of smart surveillance.

Request URI Definition


Table A-138 GET /ISAPI/ITC/TriggerMode/videoMonitor/capabilities
Method GET
Description Get the multiple-​frame recognition mode capability of smart
surveillance.
Query None.
Request None.
Response Succeeded: XML_Cap_VideoMonitor

88
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus

A.92 /ISAPI/ITC/uploadPic
Upload picture data and information.

Request URI Definition


Table A-139 PUT /ISAPI/ITC/uploadPic
Method PUT
Description Upload picture data and information.
Query None.
Request XML_UploadPic
Response Succeeded: Picture data.
Failed: XML_ResponseStatus

A.93 /ISAPI/ITC/uploadPic/capabilities
Get the picture uploading capability.

Request URI Definition


Table A-140 GET /ISAPI/ITC/uploadPic/capabilities
Method GET
Description Get the picture uploading capability.
Query None.
Request None.
Response Succeeded: XML_Cap_UploadPic
Failed: XML_ResponseStatus

A.94 /ISAPI/ITC/videoMark
Operations about the video mark configuration.

89
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-141 GET /ISAPI/ITC/videoMark
Method GET
Description Get the video mark parameters.
Query None.
Request None.
Response Succeeded: XML_VideoMarkInfo
Failed: XML_ResponseStatus
Table A-142 PUT /ISAPI/ITC/videoMark
Method PUT
Description Set the video mark parameters.
Query None.
Request XML_VideoMarkInfo
Response XML_ResponseStatus

A.95 /ISAPI/ITC/videoMark/capabilities
Get the video tag capability.

Request URI Definition


Table A-143 GET /ISAPI/ITC/videoMark/capabilities
Method GET
Description Get the video tag capability.
Query None.
Request None.
Response Succeeded: XML_Cap_VideoMarkInfo
Failed: XML_ResponseStatus

A.96 /ISAPI/Image/channels/<ID>
Operations about image configuration of a specific channel.

90
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-144 GET /ISAPI/Image/channels/<ID>
Method GET
Description Get image parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_ImageChannel
Failed: XML_ResponseStatus
Table A-145 PUT /ISAPI/Image/channels/<ID>
Method PUT
Description Set image parameters of a specific channel.
Query None.
Request XML_ImageChannel
Response XML_ResponseStatus

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

A.97 /ISAPI/Image/channels/<ID>/autoContrast
Operations about the automatic contrast configuration of a specific channel.

Request URI Definition


Table A-146 GET /ISAPI/Image/channels/<ID>/autoContrast
Method GET
Description Get the automatic contrast parameters of a specific channel..
Query None.
Request None.
Response Succeeded: XML_AutoContrast
Failed: XML_ResponseStatus

91
Intelligent Security API (Traffic) Developer Guide

Table A-147 PUT /ISAPI/Image/channels/<ID>/autoContrast


Method PUT
Description Set the automatic contrast parameters of a specific channel..
Query None.
Request XML_AutoContrast
Response XML_ResponseStatus

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

A.98 /ISAPI/Image/channels/<ID>/autoContrast/capabilities
Get the automatic contrast capability of a specific channel.

Request URI Definition


Table A-148 GET /ISAPI/Image/channels/<ID>/autoContrast/capabilities
Method GET
Description Get the automatic contrast capability of a specific channel..
Query None.
Request None.
Response Succeeded: XML_Cap_AutoContrast
Failed: XML_ResponseStatus

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

A.99 /ISAPI/Image/channels/<ID>/brightEnhance
Operations about the brightness enhancement parameters of a specific channel.

Request URI Definition


Table A-149 GET /ISAPI/Image/channels/<ID>/brightEnhance
Method GET
Description Get the brightness enhancement parameters of a specific channel.

92
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_BrightEnhance
Failed: XML_ResponseStatus
Table A-150 PUT /ISAPI/Image/channels/<ID>/brightEnhance
Method PUT
Description Set the brightness enhancement parameters of a specific channel.
Query None.
Request XML_BrightEnhance
Response XML_ResponseStatus

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

A.100 /ISAPI/Image/channels/<ID>/capabilities
Get image configuration capability of a specific channel.

Request URI Definition


Table A-151 GET /ISAPI/Image/channels/<ID>/capabilities
Method GET
Description Get image configuration capability of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_ImageChannel
Failed: XML_ResponseStatus

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

A.101 /ISAPI/Image/channels/<ID>/capture
Operations about the captured picture configuration of a specific channel.

93
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-152 GET /ISAPI/Image/channels/<ID>/capture
Method GET
Description Get the captured picture parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_ITCImageSnap
Failed: XML_ResponseStatus
Table A-153 PUT /ISAPI/Image/channels/<ID>/capture
Method PUT
Description Set the captured picture parameters of a specific channel.
Query None.
Request XML_ITCImageSnap
Response XML_ResponseStatus

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

A.102 /ISAPI/Image/channels/<ID>/capture/capabilities
Get the configuration capability for the captured pictures of a specific channel.

Request URI Definition


Table A-154 GET /ISAPI/Image/channels/<ID>/capture/capabilities
Method GET
Description Get the configuration capability for the captured pictures of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_ITCImageSnapCaps
Failed: XML_ResponseStatus

94
Intelligent Security API (Traffic) Developer Guide

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

A.103 /ISAPI/Image/channels/<ID>/capture/color
Operations about the color configuration for captured pictures of a specific channel.

Request URI Definition


Table A-155 GET /ISAPI/Image/channels/<ID>/capture/color
Method GET
Description Get the color parameters for captured pictures of a specific channel.
Query None.
Request None.
Response Succeeded: XML_SnapColor
Failed: XML_ResponseStatus
Table A-156 PUT /ISAPI/Image/channels/<ID>/capture/color
Method PUT
Description Set the color parameters for captured pictures of a specific channel.
Query None.
Request XML_SnapColor
Response XML_ResponseStatus

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

A.104 /ISAPI/Image/channels/<ID>/capture/gain
Operations about the gain configuration for captured pictures of a specific channel.

Request URI Definition


Table A-157 GET /ISAPI/Image/channels/<ID>/capture/gain
Method GET
Description Get the gain parameters for captured pictures of a specific channel.

95
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_SnapGain
Failed: XML_ResponseStatus
Table A-158 PUT /ISAPI/Image/channels/<ID>/capture/gain
Method PUT
Description Set the gain parameters for captured pictures of a specific channel.
Query None.
Request XML_SnapGain
Response XML_ResponseStatus

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

A.105 /ISAPI/Image/channels/<ID>/capture/LPDE
Operations about the license plate enhancement configuration of the captured pictures of a
specific channel.

Request URI Definition


Table A-159 GET /ISAPI/Image/channels/<ID>/capture/LPDE
Method GET
Description Get the license plate enhancement parameters of the captured
pictures of a specific channel.
Query None.
Request None.
Response Succeeded: XML_SnapLPDE
Failed: XML_ResponseStatus
Table A-160 PUT /ISAPI/Image/channels/<ID>/capture/LPDE
Method PUT
Description Set the license plate enhancement parameters of the captured
pictures of a specific channel.
Query None.

96
Intelligent Security API (Traffic) Developer Guide

Request XML_SnapLPDE
Response XML_ResponseStatus

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

A.106 /ISAPI/Image/channels/<ID>/capture/noiseReduce2D
Operations about the 2D noise reduction configuration for captured pictures of a specific channel.

Request URI Definition


Table A-161 GET /ISAPI/Image/channels/<ID>/capture/noiseReduce2D
Method GET
Description Get the 2D noise reduction parameters for captured pictures of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_SnapNoiseReduce2D
Failed: XML_ResponseStatus
Table A-162 PUT /ISAPI/Image/channels/<ID>/capture/noiseReduce2D
Method PUT
Description Set the 2D noise reduction parameters for captured pictures of a
specific channel.
Query None.
Request XML_SnapNoiseReduce2D
Response XML_ResponseStatus

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

A.107 /ISAPI/Image/channels/<ID>/capture/plateContrast
Operations about the license plate contrast configuration of the captured images of a specific
channel.

97
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-163 GET /ISAPI/Image/channels/<ID>/capture/plateContrast
Method GET
Description Get the license plate contrast parameters of the captured images of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_SnapPlateContrast
Failed: XML_ResponseStatus
Table A-164 PUT /ISAPI/Image/channels/<ID>/capture/plateContrast
Method PUT
Description Set the license plate contrast parameters of the captured images of a
specific channel.
Query None.
Request XML_SnapPlateContrast
Response XML_ResponseStatus

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

A.108 /ISAPI/Image/channels/<ID>/capture/plateSaturation
Operations about the license plate saturation configuration of the captured pictures of a specific
channel.

Request URI Definition


Table A-165 GET /ISAPI/Image/channels/<ID>/capture/plateSaturation
Method GET
Description Get the license plate saturation parameters of the captured pictures
of a specific channel.
Query None.
Request None.
Response Succeeded: XML_SnapPlateSaturation

98
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus
Table A-166 PUT /ISAPI/Image/channels/<ID>/capture/plateSaturation
Method PUT
Description Set the license plate saturation parameters of the captured pictures
of a specific channel.
Query None.
Request XML_SnapPlateSaturation
Response XML_ResponseStatus

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

A.109 /ISAPI/Image/channels/<ID>/capture/shadowHighlight
Operations about the shadow and highlight configuration for captured images of a specific
channel.

Request URI Definition


Table A-167 GET /ISAPI/Image/channels/<ID>/capture/shadowHighlight
Method GET
Description Get the shadow and highlight parameters for captured images of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_SnapShadowHighlight
Failed: XML_ResponseStatus
Table A-168 PUT /ISAPI/Image/channels/<ID>/capture/shadowHighlight
Method PUT
Description Set the shadow and highlight parameters for captured images of a
specific channel.
Query None.
Request XML_SnapShadowHighlight
Response XML_ResponseStatus

99
Intelligent Security API (Traffic) Developer Guide

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

A.110 /ISAPI/Image/channels/<ID>/capture/shutter
Operations about the shutter configuration in exposure for captured pictures of a specific channel.

Request URI Definition


Table A-169 GET /ISAPI/Image/channels/<ID>/capture/shutter
Method GET
Description Get the shutter parameters in exposure for captured pictures of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_SnapShutter
Failed: XML_ResponseStatus
Table A-170 PUT /ISAPI/Image/channels/<ID>/capture/shutter
Method PUT
Description Set the shutter parameters in exposure for captured pictures of a
specific channel.
Query None.
Request XML_SnapShutter
Response XML_ResponseStatus

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

A.111 /ISAPI/Image/channels/<ID>/color
Operations about the image adjustment parameters of a specific channel.

100
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-171 GET /ISAPI/Image/channels/<ID>/color
Method GET
Description Get the image adjustment parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Color
Failed: XML_ResponseStatus
Table A-172 PUT /ISAPI/Image/channels/<ID>/color
Method PUT
Description Set the image adjustment parameters of a specific channel.
Query None.
Request XML_Color
Response XML_ResponseStatus

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

A.112 /ISAPI/Image/channels/<ID>/DarkEnhance
Operations about the dark space enhancement configuration of a specific channel.

Request URI Definition


Table A-173 GET /ISAPI/Image/channels/<ID>/DarkEnhance
Method GET
Description Get the dark space enhancement parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_DarkEnhance
Failed: XML_ResponseStatus

101
Intelligent Security API (Traffic) Developer Guide

Table A-174 PUT /ISAPI/Image/channels/<ID>/DarkEnhance


Method PUT
Description Set the dark space enhancement parameters of a specific channel.
Query None.
Request XML_DarkEnhance
Response XML_ResponseStatus

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

A.113 /ISAPI/Image/channels/<ID>/DarkEnhance/capabilities
Get the dark space enhancement capability of a specific channel.

Request URI Definition


Table A-175 GET /ISAPI/Image/channels/<ID>/DarkEnhance/capabilities
Method GET
Description Get the dark space enhancement capability of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_DarkEnhance
Failed: XML_ResponseStatus

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

A.114 /ISAPI/Image/channels/<ID>/dayNightGata
Operations about the day/night auto switch configuration of a specific channel.

Request URI Definition


Table A-176 GET /ISAPI/Image/channels/<ID>/dayNightGata
Method GET
Description Get the day/night auto switch parameters of a specific channel.

102
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_DayNightGate
Failed: XML_ResponseStatus
Table A-177 PUT /ISAPI/Image/channels/<ID>/dayNightGata
Method PUT
Description Set the day/night auto switch parameters of a specific channel.
Query None.
Request XML_DayNightGate
Response XML_ResponseStatus

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

A.115 /ISAPI/Image/channels/<ID>/defog
Operations about the electronic defogging configuration of a specific channel.

Request URI Definition


Table A-178 GET /ISAPI/Image/channels/<ID>/defog
Method GET
Description Get the electronic defogging parameters of a specific channel..
Query None.
Request None.
Response Succeeded: XML_Defog
Failed: XML_ResponseStatus
Table A-179 PUT /ISAPI/Image/channels/<ID>/defog
Method PUT
Description Set the electronic defogging parameters of a specific channel..
Query None.
Request XML_Defog
Response XML_ResponseStatus

103
Intelligent Security API (Traffic) Developer Guide

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

A.116 /ISAPI/Image/channels/<ID>/DSS
Operations about the configuration of the low illumination electronic shutter of a specific channel.

Request URI Definition


Table A-180 GET /ISAPI/Image/channels/<ID>/DSS
Method GET
Description Get the configuration parameters of the low illumination electronic
shutter of a specific channel.
Query None.
Request None.
Response Succeeded: XML_DSS
Failed: XML_ResponseStatus
Table A-181 PUT /ISAPI/Image/channels/<ID>/DSS
Method PUT
Description Set the configuration parameters of the low illumination electronic
shutter of a specific channel.
Query None.
Request XML_DSS
Response XML_ResponseStatus

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

A.117 /ISAPI/Image/channels/<ID>/exposure
Operations about exposure mode configuration of a specific channel.

104
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-182 GET /ISAPI/Image/channels/<ID>/exposure
Method GET
Description Get the exposure mode of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Exposure
Failed: XML_ResponseStatus
Table A-183 PUT /ISAPI/Image/channels/<ID>/exposure
Method PUT
Description Set the exposure mode of a specific channel.
Query None.
Request XML_Exposure
Response XML_ResponseStatus

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

A.118 /ISAPI/Image/channels/<ID>/gain
Operations about gain configuration in exposure of a specific channel.

Request URI Definition


Table A-184 GET /ISAPI/Image/channels/<ID>/gain
Method GET
Description Get gain parameters in exposure of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Gain
Failed: XML_ResponseStatus

105
Intelligent Security API (Traffic) Developer Guide

Table A-185 PUT /ISAPI/Image/channels/<ID>/gain


Method PUT
Description Set gain parameters in exposure of a specific channel.
Query None.
Request XML_Gain
Response XML_ResponseStatus

Remarks
• The <ID> in the request URI refers to the channel ID.
• PUT method is only valid when the node <ExposureType> in the message XML_Exposure is set
to "GainFirst".

A.119 /ISAPI/Image/channels/<ID>/gammaCorrection
Operations about the gamma correction parameters of a specific channel.

Request URI Definition


Table A-186 GET /ISAPI/Image/channels/<ID>/gammaCorrection
Method GET
Description Get the gamma correction parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_gammaCorrection
Failed: XML_ResponseStatus
Table A-187 PUT /ISAPI/Image/channels/<ID>/gammaCorrection
Method PUT
Description Set the gamma correction parameters of a specific channel.
Query None.
Request XML_gammaCorrection
Response XML_ResponseStatus

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

106
Intelligent Security API (Traffic) Developer Guide

A.120 /ISAPI/Image/channels/<ID>/grayRange
Operations about the grayscale range configuration of a specific channel.

Request URI Definition


Table A-188 GET /ISAPI/Image/channels/<ID>/grayRange
Method GET
Description Get the grayscale range parameters of a specific channel..
Query None.
Request None.
Response Succeeded: XML_GrayRange
Failed: XML_ResponseStatus
Table A-189 PUT /ISAPI/Image/channels/<ID>/grayRange
Method PUT
Description Set the grayscale range parameters of a specific channel..
Query None.
Request XML_GrayRange
Response XML_ResponseStatus

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

A.121 /ISAPI/Image/channels/<ID>/grayRange/capabilities
Get the grayscale range capability of a specific channel..

Request URI Definition


Table A-190 GET /ISAPI/Image/channels/<ID>/grayRange/capabilities
Method GET
Description Get the grayscale range capability of a specific channel..
Query None.
Request None.
Response Succeeded: XML_Cap_GrayRange

107
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus

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

A.122 /ISAPI/Image/channels/<ID>/hdr
Operations about WDR (Wide Dynamic Range) configuration of a specific channel.

Request URI Definition


Table A-191 GET /ISAPI/Image/channels/<ID>/hdr
Method GET
Description Get the WDR (Wide Dynamic Range) parameters of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_Hdr
Failed: XML_ResponseStatus
Table A-192 PUT /ISAPI/Image/channels/<ID>/hdr
Method PUT
Description Set the WDR (Wide Dynamic Range) parameters of a specific channel.
Query None.
Request XML_Hdr
Response XML_ResponseStatus

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

A.123 /ISAPI/Image/channels/<ID>/hdr/capabilities
Get the WDR (Wide Dynamic Range) capability of a specific channel.

108
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-193 GET /ISAPI/Image/channels/<ID>/hdr/capabilities
Method GET
Description Get the WDR (Wide Dynamic Range) capability of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_Hdr
Failed: XML_ResponseStatus

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

A.124 /ISAPI/Image/Channels/<ID>/icr
Operations about the IR-cut filter configuration for cameras of a specific channel.

Request URI Definition


Table A-194 GET /ISAPI/Image/Channels/<ID>/icr
Method GET
Description Get the IR-cut filter parameters for cameras of a specific channel.
Query None.
Request None.
Response Succeeded: XML_ImageIcrE
Failed: XML_ResponseStatus
Table A-195 PUT /ISAPI/Image/Channels/<ID>/icr
Method PUT
Description Set the IR-cut filter parameters for cameras of a specific channel.
Query None.
Request XML_ImageIcrE
Response XML_ResponseStatus

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

109
Intelligent Security API (Traffic) Developer Guide

A.125 /ISAPI/Image/Channels/<ID>/icr/capabilities
Get the IR-cut filter capability for cameras of a specific channel.

Request URI Definition


Table A-196 GET /ISAPI/Image/Channels/<ID>/icr/capabilities
Method GET
Description Get the IR-cut filter capability for cameras of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_ImageIcrE
Failed: XML_ResponseStatus

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

A.126 /ISAPI/Image/channels/<ID>/ImageFlip
Operations about the image flipping status of a specific channel.

Request URI Definition


Table A-197 GET /ISAPI/Image/channels/<ID>/ImageFlip
Method GET
Description Get the image flipping status of a specific channel.
Query None.
Request None.
Response Succeeded: XML_ImageFlip
Failed: XML_ResponseStatus
Table A-198 PUT /ISAPI/Image/channels/<ID>/ImageFlip
Method PUT
Description Update the image flipping status of a specific channel.
Query None.

110
Intelligent Security API (Traffic) Developer Guide

Request XML_ImageFlip
Response XML_ResponseStatus

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

A.127 /ISAPI/Image/channels/<ID>/JPEGParam
Operations about the JPEG picture size configuration of a specific channel.

Request URI Definition


Table A-199 GET /ISAPI/Image/channels/<ID>/JPEGParam
Method GET
Description Get the JPEG picture size parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_JPEGParam
Failed: XML_ResponseStatus
Table A-200 PUT /ISAPI/Image/channels/<ID>/JPEGParam
Method PUT
Description Set the JPEG picture size parameters of a specific channel.
Query None.
Request XML_JPEGParam
Response XML_ResponseStatus

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

A.128 /ISAPI/Image/channels/<ID>/JPEGParam/capabilities
Get the JPEG picture size capability of a specific channel.

111
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-201 GET /ISAPI/Image/channels/<ID>/JPEGParam/capabilities
Method GET
Description Get the JPEG picture size capability of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_JPEGParam
Failed: XML_ResponseStatus

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

A.129 /ISAPI/Image/channels/<ID>/lse
Operations about the contrast enhancement configuration of a specific channel.

Request URI Definition


Table A-202 GET /ISAPI/Image/channels/<ID>/lse
Method GET
Description Get the contrast enhancement parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_LSE
Failed: XML_ResponseStatus
Table A-203 PUT /ISAPI/Image/channels/<ID>/lse
Method PUT
Description Set the contrast enhancement parameters of a specific channel.
Query None.
Request XML_LSE
Response XML_ResponseStatus

112
Intelligent Security API (Traffic) Developer Guide

Remarks
• The <ID> in the request URI refers to the channel No.
• After enabling contrast enhancement, the color contrast of the view will be optimized and
enhanced automatically to improve its clarity. As a configuration item of the contrast
enhancement, halo inhibition can be used to inhibit the halo of high beam light from the vehicle
to make the view, especially the license plate, much clearer.

A.130 /ISAPI/Image/channels/<ID>/lse/capabilities
Get the contrast enhancement capability of a specific channel.

Request URI Definition


Table A-204 GET /ISAPI/Image/channels/<ID>/lse/capabilities
Method GET
Description Get the contrast enhancement capability of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_LSE
Failed: XML_ResponseStatus

Remarks
• The <ID> in the request URI refers to the channel No.
• After enabling contrast enhancement, the color contrast of the view will be optimized and
enhanced automatically to improve its clarity. As a configuration item of the contrast
enhancement, halo inhibition can be used to inhibit the halo of high beam headlight from the
vehicle to make the view, especially the license plate, much clearer.

A.131 /ISAPI/Image/channels/<ID>/LSEDetail
Operations about the DDE (Digital Detail Enhancement) configuration of a specific channel.

Request URI Definition


Table A-205 GET /ISAPI/Image/channels/<ID>/LSEDetail
Method GET
Description Get the DDE (Digital Detail Enhancement) parameters of a specific
channel.

113
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_LSEDetail
Failed: XML_ResponseStatus
Table A-206 PUT /ISAPI/Image/channels/<ID>/LSEDetail
Method PUT
Description Set the DDE (Digital Detail Enhancement) parameters of a specific
channel.
Query
Request XML_LSEDetail
Response XML_ResponseStatus

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

A.132 /ISAPI/Image/channels/<ID>/LSEDetail/capabilities
Get the DDE (Digital Detail Enhancement) capability of a specific channel.

Request URI Definition


Table A-207 GET /ISAPI/Image/channels/<ID>/LSEDetail/capabilities
Method GET
Description Get the DDE (Digital Detail Enhancement) capability of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_Cap_LSEDetail
Failed: XML_ResponseStatus

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

A.133 /ISAPI/Image/channels/<ID>/mce
Operations about the memory color enhancement configuration of a specific channel.

114
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-208 GET /ISAPI/Image/channels/<ID>/mce
Method GET
Description Get the memory color enhancement parameters of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_MCE
Failed: XML_ResponseStatus
Table A-209 PUT /ISAPI/Image/channels/<ID>/mce
Method PUT
Description Set the memory color enhancement parameters of a specific
channel.
Query None.
Request XML_MCE
Response XML_ResponseStatus

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

A.134 /ISAPI/Image/channels/<ID>/mce/capabilities
Get the memory color enhancement capability of a specific channel.

Request URI Definition


Table A-210 GET /ISAPI/Image/channels/<ID>/mce/capabilities
Method GET
Description Get the memory color enhancement capability of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_MCE
Failed: XML_ResponseStatus

115
Intelligent Security API (Traffic) Developer Guide

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

A.135 /ISAPI/Image/Channels/<ID>/multishut
Operations about the multi-shutter configuration of a specific channel.

Request URI Definition


Table A-211 GET /ISAPI/Image/Channels/<ID>/multishut
Method GET
Description Get the multi-​shutter parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_ImageMultishut
Failed: XML_ResponseStatus
Table A-212 PUT /ISAPI/Image/Channels/<ID>/multishut
Method PUT
Description Set the multi-​shutter parameters of a specific channel.
Query None.
Request XML_ImageMultishut
Response XML_ResponseStatus

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

A.136 /ISAPI/Image/Channels/<ID>/multishut/capabilities
Get the multi-shutter capability of a specific channel.

Request URI Definition


Table A-213 GET /ISAPI/Image/Channels/<ID>/multishut/capabilities
Method GET
Description Get the multi-​shutter capability of a specific channel.

116
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_Cap_ImageMultishut
Failed: XML_ResponseStatus

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

A.137 /ISAPI/Image/channels/<ID>/noiseReduce
Operations about 3D DNR (Digital Noise Reduction) configuration in auto mode of a specific
channel.

Request URI Definition


Table A-214 GET /ISAPI/Image/channels/<ID>/noiseReduce
Method GET
Description Get 3D DNR (Digital Noise Reduction) parameters in auto mode of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_NoiseReduce
Failed: XML_ResponseStatus
Table A-215 PUT /ISAPI/Image/channels/<ID>/noiseReduce
Method PUT
Description Set 3D DNR (Digital Noise Reduction) parameters in auto mode of a
specific channel.
Query None.
Request XML_NoiseReduce
Response XML_ResponseStatus

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

117
Intelligent Security API (Traffic) Developer Guide

A.138 /ISAPI/Image/channels/<ID>/NoiseReduce2D
Operations about the 2D noise reduction configuration for video images of a specific channel.

Request URI Definition


Table A-216 GET /ISAPI/Image/channels/<ID>/NoiseReduce2D
Method GET
Description Get the 2D noise reduction parameters for video images of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_NoiseReduce2D
Failed: XML_ResponseStatus
Table A-217 PUT /ISAPI/Image/channels/<ID>/NoiseReduce2D
Method PUT
Description Set the 2D noise reduction parameters for video images of a specific
channel.
Query None.
Request XML_NoiseReduce2D
Response XML_ResponseStatus

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

A.139 /ISAPI/Image/channels/<ID>/plateBright
Operations about the license plate brightness compensation configuration of a specific channel.

Request URI Definition


Table A-218 GET /ISAPI/Image/channels/<ID>/plateBright
Method GET
Description Get the license plate brightness compensation parameters of a
specific channel.
Query None.

118
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_PlateBright
Failed: XML_ResponseStatus
Table A-219 PUT /ISAPI/Image/channels/<ID>/plateBright
Method PUT
Description Set the license plate brightness compensation parameters of a
specific channel.
Query None.
Request XML_PlateBright
Response XML_ResponseStatus

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

A.140 /ISAPI/Image/channels/<ID>/plateBright/capabilities
Get the license plate brightness compensation capability of a specific channel.

Request URI Definition


Table A-220 GET /ISAPI/Image/channels/<ID>/plateBright/capabilities
Method GET
Description Get the license plate brightness compensation capability of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_Cap_PlateBright
Failed: XML_ResponseStatus

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

A.141 /ISAPI/Image/Channels/<ID>/record
Operations about the image configuration in the recorded video of a specific channel.

119
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-221 GET /ISAPI/Image/Channels/<ID>/record
Method GET
Description Get the image parameters in the recorded video of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_ImageRecord
Failed: XML_ResponseStatus
Table A-222 PUT /ISAPI/Image/Channels/<ID>/record
Method PUT
Description Set the image parameters in the recorded video of a specific channel.
Query None.
Request XML_ImageRecord
Response XML_ResponseStatus

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

A.142 /ISAPI/Image/Channels/<ID>/record/capabilities
Get the configuration capability for images in the recorded video of a specific channel.

Request URI Definition


Table A-223 GET /ISAPI/Image/Channels/<ID>/record/capabilities
Method GET
Description Get the configuration capability for images in the recorded video of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_ImageRecordCaps
Failed: XML_ResponseStatus

120
Intelligent Security API (Traffic) Developer Guide

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

A.143 /ISAPI/Image/Channels/<ID>/record/color
Operations about the color configuration for images in the recorded video of a specific channel.

Request URI Definition


Table A-224 GET /ISAPI/Image/Channels/<ID>/record/color
Method GET
Description Get the color parameters for images in the recorded video of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_RecordColor
Failed: XML_ResponseStatus
Table A-225 PUT /ISAPI/Image/Channels/<ID>/record/color
Method PUT
Description Set the color parameters for images in the recorded video of a
specific channel.
Query None.
Request XML_RecordColor
Response XML_ResponseStatus

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

A.144 /ISAPI/Image/Channels/<ID>/record/gain
Operations about the gain configuration for images in the recorded video of a specific channel.

121
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-226 GET /ISAPI/Image/Channels/<ID>/record/gain
Method GET
Description Get the gain parameters for images in the recorded video of a
specific channel.
Query None.
Request None.
Response Succeeded: XML_RecordGain
Failed: XML_ResponseStatus
Table A-227 PUT /ISAPI/Image/Channels/<ID>/record/gain
Method PUT
Description Set the gain parameters for images in the recorded video of a specific
channel.
Query None.
Request XML_RecordGain
Response XML_ResponseStatus

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

A.145 /ISAPI/Image/Channels/<ID>/record/noiseReduce2D
Operations about the 2D noise reduction configuration for images in the recorded video of a
specific channel.

Request URI Definition


Table A-228 GET /ISAPI/Image/Channels/<ID>/record/noiseReduce2D
Method GET
Description Get the 2D noise reduction parameters for images in the recorded
video of a specific channel.
Query None.
Request None.
Response Succeeded: XML_RecordNoiseReduce2D

122
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus
Table A-229 PUT /ISAPI/Image/Channels/<ID>/record/noiseReduce2D
Method PUT
Description Set the 2D noise reduction parameters for images in the recorded
video of a specific channel.
Query None.
Request XML_RecordNoiseReduce2D
Response XML_ResponseStatus

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

A.146 /ISAPI/Image/Channels/<ID>/record/noiseReduceExt
Operations about the 3D DNR (Digital Noise Reduction) configuration for images in the recorded
video of a specific channel.

Request URI Definition


Table A-230 GET /ISAPI/Image/Channels/<ID>/record/noiseReduceExt
Method GET
Description Get the 3D DNR (Digital Noise Reduction) parameters for images in
the recorded video of a specific channel.
Query None.
Request None.
Response Succeeded: XML_RecordNoiseReduceExt
Failed: XML_ResponseStatus
Table A-231 PUT /ISAPI/Image/Channels/<ID>/record/noiseReduceExt
Method PUT
Description Set the 3D DNR (Digital Noise Reduction) parameters for images in
the recorded video of a specific channel.
Query None.
Request XML_RecordNoiseReduceExt
Response XML_ResponseStatus

123
Intelligent Security API (Traffic) Developer Guide

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

A.147 /ISAPI/Image/Channels/<ID>/record/sectionCtrl
Operations about the configuration of picture exposure control by video segment in the recorded
video of a specific channel.

Request URI Definition


Table A-232 GET /ISAPI/Image/Channels/<ID>/record/sectionCtrl
Method GET
Description Get the configuration parameters of picture exposure control by
video segment in the recorded video of a specific channel.
Query None.
Request None.
Response Succeeded: XML_RecordSectionCtrl
Failed: XML_ResponseStatus
Table A-233 PUT /ISAPI/Image/Channels/<ID>/record/sectionCtrl
Method PUT
Description Set the configuration parameters of picture exposure control by
video segment in the recorded video of a specific channel.
Query None.
Request XML_RecordSectionCtrl
Response XML_ResponseStatus

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

A.148 /ISAPI/Image/Channels/<ID>/record/shutter
Operations about the shutter configuration in exposure for images in the recorded video of a
specific channel.

124
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-234 GET /ISAPI/Image/Channels/<ID>/record/shutter
Method GET
Description Get the shutter parameters in exposure for images in the recorded
video of a specific channel.
Query None.
Request None.
Response Succeeded: XML_RecordShutter
Failed: XML_ResponseStatus
Table A-235 PUT /ISAPI/Image/Channels/<ID>/record/shutter
Method PUT
Description Set the shutter parameters in exposure for images in the recorded
video of a specific channel.
Query None.
Request XML_RecordShutter
Response XML_ResponseStatus

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

A.149 /ISAPI/Image/channels/<ID>/sectionCtrl
Operations about the configuration of picture exposure control by video segment of a specific
channel.

Request URI Definition


Table A-236 GET /ISAPI/Image/channels/<ID>/sectionCtrl
Method GET
Description Get the configuration parameters of picture exposure control by
video segment of a specific channel.
Query None.
Request None.
Response Succeeded: XML_SectionCtrl

125
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus
Table A-237 PUT /ISAPI/Image/channels/<ID>/sectionCtrl
Method PUT
Description Set the configuration parameters of picture exposure control by
video segment of a specific channel.
Query None.
Request XML_SectionCtrl
Response XML_ResponseStatus

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

A.150 /ISAPI/Image/channels/<ID>/sectionCtrl/capabilities
Get the configuration capability of picture exposure control by video segment of a specific channel.

Request URI Definition


Table A-238 GET /ISAPI/Image/channels/<ID>/sectionCtrl/capabilities
Method GET
Description Get the configuration capability of picture exposure control by video
segment of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_SectionCtrl
Failed: XML_ResponseStatus

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

A.151 /ISAPI/Image/channels/<ID>/sharpness
Operations about the sharpness parameters of s specific channel.

126
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-239 GET /ISAPI/Image/channels/<ID>/sharpness
Method GET
Description Get the sharpness parameters of s specific channel.
Query None.
Request None.
Response Succeeded: XML_Sharpness
Failed: XML_ResponseStatus
Table A-240 PUT /ISAPI/Image/channels/<ID>/sharpness
Method PUT
Description Set the sharpness parameters of s specific channel.
Query None.
Request XML_Sharpness
Response XML_ResponseStatus

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

A.152 /ISAPI/Image/channels/<ID>/shutter
Operations about shutter configuration in exposure of a specific channel.

Request URI Definition


Table A-241 GET /ISAPI/Image/channels/<ID>/shutter
Method GET
Description Get shutter parameters in exposure of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Shutter
Failed: XML_ResponseStatus

127
Intelligent Security API (Traffic) Developer Guide

Table A-242 PUT /ISAPI/Image/channels/<ID>/shutter


Method PUT
Description Set shutter parameters in exposure of a specific channel.
Query None.
Request XML_Shutter
Response XML_ResponseStatus

Remarks
• The <ID> in the request URI refers to the channel ID.
• PUT method is only valid when the node <ExposureType> in the message XML_Exposure is set
to "ShutterFirst".

A.153 /ISAPI/Image/channels/<ID>/svce
Operations about the part contrast configuration of a specific channel.

Request URI Definition


Table A-243 GET /ISAPI/Image/channels/<ID>/svce
Method GET
Description Get the part contrast parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Svce
Failed: XML_ResponseStatus
Table A-244 PUT /ISAPI/Image/channels/<ID>/svce
Method PUT
Description Set the part contrast parameters of a specific channel.
Query None.
Request XML_Svce
Response XML_ResponseStatus

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

128
Intelligent Security API (Traffic) Developer Guide

A.154 /ISAPI/Image/channels/<ID>/svce/capabilities
Get the part contrast capability of a specific channel.

Request URI Definition


Table A-245 GET /ISAPI/Image/channels/<ID>/svce/capabilities
Method GET
Description Get the part contrast capability of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_Svce
Failed: XML_ResponseStatus

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

A.155 /ISAPI/Image/channels/<ID>/whiteBalance
Operations about the white balance parameters of s specific channel.

Request URI Definition


Table A-246 GET /ISAPI/Image/channels/<ID>/whiteBalance
Method GET
Description Get the white balance parameters of s specific channel.
Query None.
Request None.
Response Succeeded: XML_WhiteBalance
Failed: XML_ResponseStatus
Table A-247 PUT /ISAPI/Image/channels/<ID>/whiteBalance
Method PUT
Description Set the white balance parameters of s specific channel.
Query None.

129
Intelligent Security API (Traffic) Developer Guide

Request XML_WhiteBalance
Response XML_ResponseStatus

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

A.156 /ISAPI/Parking/capabilities
Get the parking lot service capability.

Request URL Definition


Table A-248 GET /ISAPI/Parking/capabilities
Method GET
Description Get the parking lot service capability.
Query None.
Request None.
Response Succeeded: XML_ParkingCap
Failed: XML_ResponseStatus

A.157 /ISAPI/Parking/channels/<ID>/barrierGate
Set the barrier gate control parameters supported by the device.

Request URL Definition


Table A-249 PUT /ISAPI/Parking/channels/<ID>/barrierGate
Method PUT
Description Set the barrier gate control parameters supported by the device to
open, close, lock or unlock the barrier gate.
Query None.
Request XML_BarrierGate
Response XML_ResponseStatus

130
Intelligent Security API (Traffic) Developer Guide

A.158 /ISAPI/Parking/channels/<ID>/LEDConfiguration/capabilities
Get the configuration capability of LED screen display.

Request URL Definition


Table A-250 GET /ISAPI/Parking/channels/<ID>/LEDConfiguration/capabilities
Method GET
Description Get the configuration capability of LED screen display.
Query None.
Request None.
Response Succeeded: XML_Cap_LEDConfiguration
Failed: XML_ResponseStatus

A.159 /ISAPI/Parking/channels/<ID>/LEDConfigurations
Operations about the batch configuration of LED screen display.

Request URL Definition


Table A-251 GET /ISAPI/Parking/channels/<ID>/LEDConfigurations
Method GET
Description Get the configuration parameters of LED screen display in a batch.
Query None.
Request None.
Response Succeeded: XML_LEDConfigurationList
Failed: XML_ResponseStatus
Table A-252 PUT /ISAPI/Parking/channels/<ID>/LEDConfigurations
Method PUT
Description Set the configuration parameters of LED screen display in a batch.
Query None.
Request XML_LEDConfigurationList
Response XML_ResponseStatus

131
Intelligent Security API (Traffic) Developer Guide

Remarks
This URL is supported only when the node <ledCount> is included in the message of
XML_Cap_LEDConfiguration .

A.160 /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration
Operations about the control configuration of audio announcement.

Request URL Definition


Table A-253 GET /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration
Method GET
Description Get the control parameters of audio announcement.
Query None.
Request None.
Response Succeeded: XML_TMEVoiceConfiguration
Failed: XML_ResponseStatus
Table A-254 PUT /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration
Method PUT
Description Set the control parameters of audio announcement.
Query None.
Request XML_TMEVoiceConfiguration
Response XML_ResponseStatus
Table A-255 DELETE /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration
Method DELETE
Description Delete the control parameters of audio announcement.
Query None.
Request None.
Response XML_ResponseStatus

132
Intelligent Security API (Traffic) Developer Guide

A.161 /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration/
capabilities
Get the control capability of audio announcement.

Request URL Definition


Table A-256 GET /ISAPI/Parking/channels/<ID>/TMEVoiceConfiguration/capabilities
Method GET
Description Get the control capability of audio announcement.
Query None.
Request None.
Response Succeeded: XML_Cap_TMEVoiceConfiguration
Failed: XML_ResponseStatus

A.162 /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo
Get or set the voice prompt parameters.

Request URI Definition


Table A-257 GET /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo
Method GET
Description Get the voice prompt parameters.
Query None.
Request None.
Response Succeeded: XML_VoiceBroadcastInfo
Failed: XML_ResponseStatus
Table A-258 PUT /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo
Method PUT
Description Set the voice prompt parameters.
Query None.
Request XML_VoiceBroadcastInfo
Response XML_ResponseStatus

133
Intelligent Security API (Traffic) Developer Guide

A.163 /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo/capabilities
Get the voice prompt configuration capability.

Request URI Definition


Table A-259 GET /ISAPI/Parking/channels/<ID>/voiceBroadcastInfo/capabilities
Method GET
Description Get the voice prompt configuration capability.
Query None.
Request None.
Response Succeeded: XML_Cap_VoiceBroadcastInfo
Failed: XML_ResponseStatus

A.164 /ISAPI/Parking/channels/<ID>/VoiceFileList
Get or delete the list of audio files.

Request URI Definition


Table A-260 GET /ISAPI/Parking/channels/<ID>/VoiceFileList
Method GET
Description Get the list of audio files.
Query None.
Request None.
Response Succeeded: XML_VoiceFileList
Failed: XML_ResponseStatus
Table A-261 DELETE /ISAPI/Parking/channels/<ID>/VoiceFileList
Method DELETE
Description Delete the list of audio files.
Query None.
Request None.
Response JSON_ResponseStatus

134
Intelligent Security API (Traffic) Developer Guide

Remarks
The <ID> in the request URI refers to the channel No., and it is 1 by default.

A.165 /ISAPI/Parking/TME/capabilities
Get the ticket dispenser device capability.

Request URI Definition


Table A-262 GET /ISAPI/Parking/TME/capabilities
Method GET
Description Get the ticket dispenser device capability.
Query None.
Request None.
Response Succeeded: XML_TMECap
Failed: XML_ResponseStatus

A.166 /ISAPI/Smart/capabilities
Get the capability of smart devices.

Request URI Definition


Table A-263 GET /ISAPI/Smart/capabilities
Method GET
Description Get the capability of smart devices.
Query None
Request None
Response Succeeded: XML_SmartCap
Failed: XML_ResponseStatus

A.167 /ISAPI/Smart/imageROI/capabilities?format=json
Get the picture ROI (Region of Interest) capability.

135
Intelligent Security API (Traffic) Developer Guide

Request URL Definition


Table A-264 GET /ISAPI/Smart/imageROI/capabilities?format=json
Method GET
Description Get the picture ROI (Region of Interest) capability.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_ImageROICap
Failed: JSON_ResponseStatus

A.168 /ISAPI/Smart/imageROI/channels/<ID>/regions/<ID>?
format=json
Operations about the configuration of a picture ROI (Region of Interest) region of a specific
channel.

Request URL Definition


Table A-265 GET /ISAPI/Smart/imageROI/channels/<ID>/regions/<ID>?format=json
Method GET
Description Get the configuration parameters of a picture ROI (Region of Interest)
region of a specific channel.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_ROIRegion
Failed: JSON_ResponseStatus
Table A-266 PUT /ISAPI/Smart/imageROI/channels/<ID>/regions/<ID>?format=json
Method PUT
Description Set the configuration parameters of a picture ROI (Region of Interest)
region of a specific channel.
Query format: determine the format of request or response message.
Request JSON_ROIRegion
Response JSON_ResponseStatus

136
Intelligent Security API (Traffic) Developer Guide

Table A-267 DELETE /ISAPI/Smart/imageROI/channels/<ID>/regions/<ID>?format=json


Method DELETE
Description Delete the configuration parameters of a picture ROI (Region of
Interest) region of a specific channel.
Query format: determine the format of request or response message.
Request None.
Response JSON_ResponseStatus

Remarks
The first <ID> in the request URL refers to the channel No., and the second <ID> in the request URL
refers to the region ID.

A.169 /ISAPI/Smart/imageROI/channels/<ID>/regions?format=json
Operations about the picture ROI (Region of Interest) region configuration of a specific channel.

Request URL Definition


Table A-268 GET /ISAPI/Smart/imageROI/channels/<ID>/regions?format=json
Method GET
Description Get the picture ROI (Region of Interest) region parameters of a
specific channel.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_ROIRegionList
Failed: JSON_ResponseStatus
Table A-269 PUT /ISAPI/Smart/imageROI/channels/<ID>/regions?format=json
Method PUT
Description Set the picture ROI (Region of Interest) region parameters of a
specific channel.
Query format: determine the format of request or response message.
Request JSON_ROIRegionList
Response JSON_ResponseStatus

137
Intelligent Security API (Traffic) Developer Guide

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

A.170 /ISAPI/Smart/imageROI/channels/<ID>?format=json
Operations about the picture ROI (Region of Interest) configuration of a specific channel.

Request URL Definition


Table A-270 GET /ISAPI/Smart/imageROI/channels/<ID>?format=json
Method GET
Description Get the picture ROI (Region of Interest) parameters of a specific
channel.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_ImageROI
Failed: JSON_ResponseStatus
Table A-271 PUT /ISAPI/Smart/imageROI/channels/<ID>?format=json
Method PUT
Description Set the picture ROI (Region of Interest) parameters of a specific
channel.
Query format: determine the format of request or response message.
Request JSON_ImageROI
Response JSON_ResponseStatus
Table A-272 DELETE /ISAPI/Smart/imageROI/channels/<ID>?format=json
Method DELETE
Description Delete the picture ROI (Region of Interest) parameters of a specific
channel.
Query format: determine the format of request or response message.
Request None.
Response JSON_ResponseStatus

138
Intelligent Security API (Traffic) Developer Guide

Remarks
The <ID> in the request URL refers to the channel No., which should be the same as the streaming
ID. For example, the returned ID 104/105 refers to supporting stream 4 and stream 5.

A.171 /ISAPI/Smart/imageROI/channels?format=json
Operations about the picture ROI (Region of Interest) configuration of multiple channels.

Request URL Definition


Table A-273 GET /ISAPI/Smart/imageROI/channels?format=json
Method GET
Description Get the picture ROI (Region of Interest) parameters of multiple
channels.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_ImageROIList
Failed: JSON_ResponseStatus
Table A-274 PUT /ISAPI/Smart/imageROI/channels?format=json
Method PUT
Description Set the picture ROI (Region of Interest) parameters of multiple
channels.
Query format: determine the format of request or response message.
Request JSON_ImageROIList
Response JSON_ResponseStatus

A.172 /ISAPI/Smart/ROI/channels
Operations about ROI (Region of Interest) configuration of all channels.

Request URL Definition


Table A-275 GET /ISAPI/Smart/ROI/channels
Method GET
Description Get the ROI (Region of Interest) parameters of all channels.

139
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_ROIList
Failed: XML_ResponseStatus
Table A-276 PUT /ISAPI/Smart/ROI/channels
Method PUT
Description Set the ROI (Region of Interest) parameters of all channels.
Query None.
Request XML_ROIList
Response XML_ResponseStatus

A.173 /ISAPI/Smart/ROI/channels/<ID>
Operations about ROI (Region of Interest) configuration of a specific channel.

Request URL Definition


Table A-277 GET /ISAPI/Smart/ROI/channels/<ID>
Method GET
Description Get the ROI (Region of Interest) parameters of a specific channel.
Query None.
Request None.
Response Succeeded: XML_ROI
Failed: XML_ResponseStatus
Table A-278 PUT /ISAPI/Smart/ROI/channels/<ID>
Method PUT
Description Set the ROI (Region of Interest) parameters of a specific channel.
Query None.
Request XML_ROI
Response XML_ResponseStatus

140
Intelligent Security API (Traffic) Developer Guide

Table A-279 DELETE /ISAPI/Smart/ROI/channels/<ID>


Method DELETE
Description Delete the ROI (Region of Interest) parameters of a specific channel.
Query None.
Request None.
Response XML_ResponseStatus

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

A.174 /ISAPI/Smart/ROI/channels/<ID>/regions
Operations about the ROI (Region of Interest) region configuration of a specific channel.

Request URL Definition


Table A-280 GET /ISAPI/Smart/ROI/channels/<ID>/regions
Method GET
Description Get the ROI (Region of Interest) region parameters of a specific
channel.
Query None.
Request None.
Response Succeeded: XML_ROIRegionsList
Failed: XML_ResponseStatus
Table A-281 PUT /ISAPI/Smart/ROI/channels/<ID>/regions
Method PUT
Description Set the ROI (Region of Interest) region parameters of a specific
channel.
Query None.
Request XML_ROIRegionsList
Response XML_ResponseStatus

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

141
Intelligent Security API (Traffic) Developer Guide

A.175 /ISAPI/Smart/ROI/channels/<ID>/regions/<ID>
Operations about the ROI (Region of Interest) encoding configuration of a specific region of a
specific channel.

Request URL Definition


Table A-282 GET /ISAPI/Smart/ROI/channels/<ID>/regions/<ID>
Method GET
Description Get the ROI (Region of Interest) encoding parameters of a specific
region of a specific channel.
Query None.
Request None.
Response Succeeded: XML_ROIRegion
Failed: XML_ResponseStatus
Table A-283 PUT /ISAPI/Smart/ROI/channels/<ID>/regions/<ID>
Method PUT
Description Set the ROI (Region of Interest) encoding parameters of a specific
region of a specific channel.
Query None.
Request XML_ROIRegion
Response XML_ResponseStatus
Table A-284 DELETE /ISAPI/Smart/ROI/channels/<ID>/regions/<ID>
Method DELETE
Description Delete the ROI (Region of Interest) encoding parameters of a specific
region of a specific channel.
Query None.
Request None.
Response XML_ResponseStatus

Remarks
The first <ID> in the request URL refers to the channel No., and the second <ID> in the request URL
refers to the region No.

142
Intelligent Security API (Traffic) Developer Guide

A.176 /ISAPI/Smart/ROI/channels/<ID>/regions/<ID>/capabilities
Get the ROI (Region of Interest) encoding configuration capability of a specific region of a specific
channel.

Request URL Definition


Table A-285 GET /ISAPI/Smart/ROI/channels/<ID>/regions/<ID>/capabilities
Method GET
Description Get the ROI (Region of Interest) encoding configuration capability of
a specific region of a specific channel.
Query None.
Request None.
Response Succeeded: XML_Cap_ROIRegion
Failed: XML_ResponseStatus

Remarks
The first <ID> in the request URL refers to the channel No., and the second <ID> in the request URL
refers to the region No.

A.177 /ISAPI/Smart/ROI/channels/capabilities
Get the ROI (Region of Interest) configuration capability of all channels.

Request URL Definition


Table A-286 GET /ISAPI/Smart/ROI/channels/capabilities
Method GET
Description Get the ROI (Region of Interest) configuration capability of all
channels.
Query None.
Request None.
Response Succeeded: XML_Cap_ROI
Failed: XML_ResponseStatus

143
Intelligent Security API (Traffic) Developer Guide

A.178 /ISAPI/System/deviceInfo
Operations about the device information.

Request URI Definition


Table A-287 GET /ISAPI/System/deviceInfo
Method GET
Description Get the device information.
Query None
Request None.
Response Succeeded: XML_DeviceInfo
Failed: XML_ResponseStatus
Table A-288 PUT /ISAPI/System/deviceInfo
Method PUT
Description Set the device information.
Query None
Request XML_DeviceInfo
Response XML_ResponseStatus

A.179 /ISAPI/System/deviceInfo/capabilities
Get the device information configuration capability.

Request URI Definition


Table A-289 GET /ISAPI/System/deviceInfo/capabilities
Method GET
Description Get the device information configuration capability.
Query None.
Request None.
Response Succeeded: XML_Cap_DeviceInfo
Failed: XML_ResponseStatus

144
Intelligent Security API (Traffic) Developer Guide

A.180 /ISAPI/Traffic/algLog
Get algorithm log status.

Request URI Definition


Table A-290 GET /ISAPI/Traffic/algLog
Method GET
Description Get algorithm log status
Query None.
Request None.
Response Succeeded: XML_AlgLog
Failed: XML_ResponseStatus

A.181 /ISAPI/Traffic/algLog/capabilities
Get algorithm log status.
Table A-291 GET /ISAPI/Traffic/algLog/capabilities
Method GET
Description Get algorithm log status
Query None.
Request None.
Response Succeeded: XML_AlgLogCap
Failed: XML_ResponseStatus

A.182 /ISAPI/Traffic/algVersionInfo
Get algorithm version information of traffic device.

Request URI Definition


Table A-292 GET /ISAPI/Traffic/algVersionInfo
Method GET
Description Get algorithm version information of traffic device
Query None.

145
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_AlgVersionInfo
Failed: XML_ResponseStatus

Remarks
If <isImageMergeSupport> supports picture collaging and reverse capabilities, which is used to
control picture collaging and displayed in Web interface.
If <isNotSupportOverlaps> supports text overlay and reverse capabilities.
If <isSupportEdfAlg></isSupportEdfAlg> supports smart analysis of parameter configuration.
If <isSupportEvidenceParam></ isSupportEvidenceParam> supports enforcement configuration.

A.183 /ISAPI/Traffic/ANPR/alarmHttpPushProtocol
Get or set alarm receiving protocol.

Request URI Definition


Table A-293 GET /ISAPI/Traffic/ANPR/alarmHttpPushProtocol
Method GET
Description Get alarm receiving protocol.
Query None
Request None
Response Succeeded: XML_AlarmHttpPushProtocol
Failed: XML_ResponseStatus
Table A-294 PUT /ISAPI/Traffic/ANPR/alarmHttpPushProtocol
Method PUT
Description Set alarm receiving protocol.
Query None
Request XML_AlarmHttpPushProtocol
Response XML_ResponseStatus

A.184 /ISAPI/Traffic/capabilities
Get the traffic service capability.

146
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-295 GET /ISAPI/Traffic/capabilities
Method GET
Description Get the traffic service capability.
Query None.
Request None.
Response Succeeded: XML_TrafficCap
Failed: XML_ResponseStatus

A.185 /ISAPI/Traffic/channels/<ID>/addrInfo/capabilities?format=json
Get the capability of overlaying address information.

Request URI Definition


Table A-296 GET /ISAPI/Traffic/channels/<ID>/addrInfo/capabilities?format=json
Method GET
Description Get the capability of overlaying address information.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_AddrInfo
Failed: JSON_ResponseStatus

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

A.186 /ISAPI/Traffic/channels/<ID>/addrInfo?format=json
Get or set parameters for overlaying address information.

Request URI Definition


Table A-297 GET /ISAPI/Traffic/channels/<ID>/addrInfo?format=json
Method GET
Description Get parameters of overlaying address information.

147
Intelligent Security API (Traffic) Developer Guide

Query format: determine the format of request or response message.


Request None.
Response Succeeded: JSON_AddrInfo
Failed: JSON_ResponseStatus
Table A-298 PUT /ISAPI/Traffic/channels/<ID>/addrInfo?format=json
Method PUT
Description Set parameters for overlaying address information.
Query format: determine the format of request or response message.
Request JSON_AddrInfo
Response JSON_ResponseStatus

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

A.187 /ISAPI/Traffic/channels/<ID>/baseParam/<SID>
Get or set basic parameters of a scene by channel.

Request URI Definition


Table A-299 GET /ISAPI/Traffic/channels/<ID>/baseParam/<SID>
Method GET
Description Get basic parameters of a scene by channel.
Query None.
Request None.
Response Succeeded: XML_BaseParam
Failed: XML_ResponseStatus
Table A-300 PUT /ISAPI/Traffic/channels/<ID>/baseParam/<SID>
Method PUT
Description Set basic parameters of a scene by channel.
Query None.
Request XML_BaseParam
Response XML_ResponseStatus

148
Intelligent Security API (Traffic) Developer Guide

Remarks
The <ID> in the request URI refers to the channel ID, and the <SID> is the scene ID.

A.188 /ISAPI/Traffic/channels/<ID>/capabilities
Get traffic channel capability.

Request URI Definition


Table A-301 GET /ISAPI/Traffic/channels/<ID>/capabilities
Method GET
Description Get traffic channel capability.
Query None
Request None
Response Succeeded: XML_TrafficChannelCap
Failed: XML_ResponseStatus

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

A.189 /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode
Get or set ANPR mode parameters.

Request URI Definition


Table A-302 GET /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode
Method GET
Description Get ANPR mode parameters.
Query None
Request None
Response Succeeded: XML_CurVehicleDetectMode
Failed: XML_ResponseStatus
Table A-303 PUT /ISAPI/Traffic/channels/<ID>/CurVehicleDetectMode
Method PUT
Description Set ANPR mode parameters.

149
Intelligent Security API (Traffic) Developer Guide

Query None
Request XML_CurVehicleDetectMode
Response XML_ResponseStatus

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

A.190 /ISAPI/Trafiic/channels/<ID>/edfForceManualCapSwitch
Set mandatory manual evidence capture mode.

Request URI Definition


Table A-304 PUT /ISAPI/Trafiic/channels/<ID>/edfForceManualCapSwitch
Method PUT
Description Set mandatory manual evidence capture mode.
Query None.
Request XML_edfForceManualCapSwitch
Response Succeeded: XML_edfForceManualCapSwitch
Failed: XML_ResponseStatus

A.191 /ISAPI/Traffic/channels/<ID>/edfManualItsCap
Get or set parameters of manual evidence capture.

Request URI Definition


Table A-305 GET /ISAPI/Traffic/channels/<ID>/edfManualItsCap
Method Get
Description Get parameters of manual evidence capture.
Query None.
Request None.
Response Succeeded: XML_EdfManualIts
Failed: XML_ResponseStatus

150
Intelligent Security API (Traffic) Developer Guide

Table A-306 PUT /ISAPI/Traffic/channels/<ID>/edfManualItsCap


Method PUT
Description Set parameters of manual evidence capture.
Query None.
Request XML_EdfManualIts
Response XML_ResponseStatus

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

A.192 /ISAPI/Traffic/channels/<ID>/eventTrigger
Get or set ANPR alarm linkage action by channel.

Request URI Definition


Table A-307 GET /ISAPI/Traffic/channels/<ID>/eventTrigger
Method GET
Description Get ANPR alarm linkage action by channel.
Query None
Request None
Response Succeeded: XML_TrafficEventTrigger
Failed: XML_ResponseStatus
Table A-308 PUT /ISAPI/Traffic/channels/<ID>/eventTrigger
Method PUT
Description Set ANPR alarm linkage action by channel.
Query None
Request XML_TrafficEventTrigger
Response XML_ResponseStatus

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

151
Intelligent Security API (Traffic) Developer Guide

A.193 /ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json
Get or set the parameters of filtering duplicated license plate.

Request URI Definition


Table A-309 GET /ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json
Method GET
Description Get the parameters of filtering duplicated license plate.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Filtration
Failed: JSON_ResponseStatus
Table A-310 PUT /ISAPI/Traffic/channels/<ID>/licensePlate/filtration?format=json
Method PUT
Description Set the parameters of filtering duplicated license plate.
Query format: determine the format of request or response message.
Request JSON_Filtration
Response JSON_ResponseStatus

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

A.194 /ISAPI/Traffic/channels/<ID>/licensePlateAuditData
Export license plate list template (XML or EXCEL file) and import list.

Request URI Definition


Table A-311 GET /ISAPI/Traffic/channels/<ID>/licensePlateAuditData
Method GET
Description Export license plate list template.
Query fileType: determine the format of exported file, if the value is "xml"
(i.e., /ISAPI/Traffic/channels/<ID>/licensePlateAuditData?
fileType=xml), the exported file is in XML format, if the value is

152
Intelligent Security API (Traffic) Developer Guide

"excel" or the URI does not contain this query parameter, it will
export an EXCEL file.
Request None.
Response Opaque data (binary data, in the EXCEL format)
Table A-312 PUT /ISAPI/Traffic/channels/<ID>/licensePlateAuditData
Method PUT
Description Import license plate list.
Query fileType: determine the format of exported file, if the value is "xml"
(i.e., /ISAPI/Traffic/channels/<ID>/licensePlateAuditData?
fileType=xml), the exported file is in XML format, if the value is
"excel" or the URI does not contain this query parameter, it will
export an EXCEL file.
Request Opaque data (binary data, in the EXCEL format)
Response XML_ResponseStatus

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

A.195 /ISAPI/Trafiic/channels/<ID>/manualItsCap
Perform manual traffic law enforcement.

Request URI Definition


Table A-313 PUT /ISAPI/Trafiic/channels/<ID>/manualItsCap
Method PUT
Description Perform manual traffic law enforcement.
Query None.
Request XML_ManualItsCap
Response XML_ResponseStatus

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

153
Intelligent Security API (Traffic) Developer Guide

A.196 /ISAPI/Traffic/channels/<ID>/picParam
Get or set the parameters of captured vehicle pictures by channel.

Request URI Definition


Table A-314 GET /ISAPI/Traffic/channels/<ID>/picParam
Method GET
Description Get the parameters of captured vehicle pictures by channel.
Query None
Request None
Response Succeeded: XML_PicParam
Failed: XML_ResponseStatus
Table A-315 PUT /ISAPI/Traffic/channels/<ID>/picParam
Method PUT
Description Set the parameters of captured vehicle pictures by channel.
Query None
Request XML_PicParam
Response XML_ResponseStatus

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

A.197 /ISAPI/Traffic/channels/<ID>/picParam/capabilities
Get captured picture configuration capability.

Request URI Definition


Table A-316 GET /ISAPI/Traffic/channels/<ID>/picParam/capabilities
Method GET
Description Get captured picture configuration capability.
Query None
Request None
Response Succeeded: XML_Cap_PicParam

154
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus

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

A.198 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info
Operations about the configuration of overlaying all OSD text information on a captured picture.

Request URI Definition


Table A-317 GET /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info
Method GET
Description Get the configuration parameters of overlaying all OSD text
information on a captured picture.
Query None.
Request None.
Response Succeeded: XML_OverlayInfoList
Failed: XML_ResponseStatus
Table A-318 PUT /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info
Method PUT
Description Set the configuration parameters for overlaying all OSD text
information on a captured picture.
Query None.
Request XML_OverlayInfoList
Response XML_ResponseStatus

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

A.199 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info/
<ID>
Operations about the configuration of overlaying a piece of OSD text information on a captured
picture.

155
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-319 GET /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info/<ID>
Method GET
Description Get the configuration parameters of overlaying a piece of OSD text
information on a captured picture.
Query None.
Request None.
Response Succeeded: XML_OverlayInfo
Failed: XML_ResponseStatus
Table A-320 PUT /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlay/info/<ID>
Method PUT
Description Set the configuration parameters for overlaying a piece of OSD text
information on a captured picture.
Query None.
Request XML_OverlayInfo
Response XML_ResponseStatus

Remarks
The first <ID> in the request URI refers to the channel No., and the second <ID> in the request URL
refers to the overlayed text information ID.

A.200 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlays
Get or set overlay parameters of captured traffic pictures by channel.

Request URI Definition


Table A-321 GET /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlays
Method GET
Description Get overlay parameters of captured traffic pictures by channel.
Query None
Request None
Response Succeeded: XML_CapturePicOverlays
Failed: XML_ResponseStatus

156
Intelligent Security API (Traffic) Developer Guide

Table A-322 PUT /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlays


Method PUT
Description Set overlay parameters of captured traffic pictures by channel.
Query None
Request XML_CapturePicOverlays
Response XML_ResponseStatus

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

A.201 /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlays/
capabilities
Get the capability of OSD overlay on a captured picture.

Request URI Definition


Table A-323 GET /ISAPI/Traffic/channels/<ID>/picParam/capturePicOverlays/capabilities
Method GET
Description Get the capability of OSD overlay on a captured picture.
Query None.
Request None.
Response Succeeded: XML_Cap_CapturePicOverlays
Failed: XML_ResponseStatus

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

A.202 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays
Operations about the configuration of OSD overlay on the composite captured picture.

157
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-324 GET /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays
Method GET
Description Get the parameters of OSD overlay on the composite captured
picture.
Query None.
Request None.
Response Succeeded: XML_MergePicOverlays
Failed: XML_ResponseStatus
Table A-325 PUT /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays
Method PUT
Description Set the parameters of OSD overlay on the composite captured
picture.
Query None.
Request XML_MergePicOverlays
Response XML_ResponseStatus

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

A.203 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/
capabilities
Get the capability of OSD overlay on the composite captured picture.

Request URI Definition


Table A-326 GET /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/capabilities
Method GET
Description Get the capability of OSD overlay on the composite captured picture.
Query None.
Request None.
Response Succeeded: XML_Cap_MergePicOverlays
Failed: XML_ResponseStatus

158
Intelligent Security API (Traffic) Developer Guide

A.204 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info
Operations about the configuration of overlaying all OSD text information on the composite
captured picture.

Request URI Definition


Table A-327 GET /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info
Method GET
Description Get the configuration parameters of overlaying all OSD text
information on the composite captured picture.
Query None.
Request None.
Response Succeeded: XML_OverlayInfoList
Failed: XML_ResponseStatus
Table A-328 PUT /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info
Method PUT
Description Set the configuration parameters for overlaying all OSD text
information on the composite captured picture.
Query None.
Request XML_OverlayInfoList
Response XML_ResponseStatus

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

A.205 /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info/
<ID>
Operations about the configuration of overlaying a piece of OSD text information on the composite
captured picture.

159
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-329 GET /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info/<ID>
Method GET
Description Get the configuration parameters of overlaying a piece of OSD text
information on the composite captured picture.
Query None.
Request None.
Response Succeeded: XML_OverlayInfo
Failed: XML_ResponseStatus
Table A-330 PUT /ISAPI/Traffic/channels/<ID>/picParam/mergePicOverlays/info/<ID>
Method PUT
Description Set the configuration parameters for overlaying a piece of OSD text
information on the composite captured picture.
Query None.
Request XML_OverlayInfo
Response XML_ResponseStatus

Remarks
The first <ID> in the request URI refers to the channel No., and the second <ID> in the request URL
refers to the overlayed text information ID.

A.206 /ISAPI/Traffic/channels/<ID>/searchLPListAudit
Search for license plate list by channel.

Request URI Definition


Table A-331 POST /ISAPI/Traffic/channels/<ID>/searchLPListAudit
Method POST
Description Search for license plate list by channel.
Query None
Request XML_LPListAuditSearchDescription
Response XML_LPListAuditSearchResult

160
Intelligent Security API (Traffic) Developer Guide

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

A.207 /ISAPI/Traffic/channels/<ID>/vehicleDetect
Get or set vehicle detection parameters.

Request URI Definition


Table A-332 GET /ISAPI/Traffic/channels/<ID>/vehicleDetect
Method GET
Description Get vehicle detection parameters.
Query None
Request None
Response Succeeded: XML_VehicleDetectCfg
Failed: XML_ResponseStatus
Table A-333 PUT /ISAPI/Traffic/channels/<ID>/vehicleDetect
Method PUT
Description Set vehicle detection parameters.
Query None
Request XML_VehicleDetectCfg
Response XML_ResponseStatus

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

A.208 /ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities
Get the vehicle detection configuration capability.

Request URI Definition


Table A-334 GET /ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities
Method GET
Description Get the vehicle detection configuration capability.

161
Intelligent Security API (Traffic) Developer Guide

Query None
Request None
Response Succeeded: XML_Cap_VehicleDetectCfg
Failed: XML_ResponseStatus

A.209 /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/capabilities?
format=json
Get configuration capability of automatic blacklist update.

Request URI Definition


Table A-335 GET /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/capabilities?format=json
Method GET
Description Get configuration capability of automatic blacklist update.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_AutoUpdateblackListCap
Failed: JSON_ResponseStatus

A.210 /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/
lastUpdateTime?format=json
Get last updated time of blacklist.

Request URI Definition


Table A-336 GET /ISAPI/Traffic/ContentMgmt/autoUpdateblackList/lastUpdateTime?format=json
Method GET
Description Get last updated time of blacklist.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_LastUpdateTimeList
Failed: JSON_ResponseStatus

162
Intelligent Security API (Traffic) Developer Guide

A.211 /ISAPI/Traffic/ContentMgmt/autoUpdateblackList?format=json
Get or set parameters of automatic blacklist update.

Request URI Definition


Table A-337 GET /ISAPI/Traffic/ContentMgmt/autoUpdateblackList?format=json
Method GET
Description Get parameters of automatic blacklist update.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_AutoUpdateblackList
Failed: JSON_ResponseStatus
Table A-338 PUT /ISAPI/Traffic/ContentMgmt/autoUpdateblackList?format=json
Method PUT
Description Set parameters of automatic blacklist update.
Query format: determine the format of request or response message.
Request JSON_AutoUpdateblackList
Response JSON_ResponseStatus

A.212 /ISAPI/Traffic/ContentMgmt/capabilities
Get capability of terminal server.

Request URI Definition


Table A-339 GET /ISAPI/Traffic/ContentMgmt/capabilities
Method GET
Description Get capability of terminal server.
Query None.
Request None.
Response Succeeded: XML_TrafficContentMgmtCap
Failed: XML_ResponseStatus

163
Intelligent Security API (Traffic) Developer Guide

A.213 /ISAPI/Traffic/ContentMgmt/chanDevStatus/<ID>
Get camera status by channel.

Request URI Definition


Table A-340 GET /ISAPI/Traffic/ContentMgmt/chanDevStatus/<ID>
Method GET
Description Get camera status by channel.
Query None.
Request None.
Response Succeeded: XML_ChanDeviceStatus
Failed: XML_ResponseStatus

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

A.214 /ISAPI/Traffic/ContentMgmt/ChannelMatch
Get linkages of all channels or add a linkage for channel.

Request URI Definition


Table A-341 GET /ISAPI/Traffic/ContentMgmt/ChannelMatch
Method GET
Description Get linkages of all channels.
Query None.
Request None.
Response Succeeded: XML_ChannelMatchList
Failed: XML_ResponseStatus
Table A-342 POST /ISAPI/Traffic/ContentMgmt/ChannelMatch
Method POST
Description Add a linkage for channel.
Query None.

164
Intelligent Security API (Traffic) Developer Guide

Request XML_ChannelMatch
Response XML_ResponseStatus

A.215 /ISAPI/Traffic/ContentMgmt/ChannelMatch/<ID>
Get, edit, or delete linkages of a channel.

Request URI Definition


Table A-343 GET /ISAPI/Traffic/ContentMgmt/ChannelMatch/<ID>
Method GET
Description Get linkages of a channel.
Query None.
Request None.
Response Succeeded: XML_ChannelMatch
Failed: XML_ResponseStatus
Table A-344 PUT /ISAPI/Traffic/ContentMgmt/ChannelMatch/<ID>
Method PUT
Description Edit linkages of a channel.
Query None.
Request XML_ChannelMatch
Response XML_ResponseStatus
Table A-345 DELETE /ISAPI/Traffic/ContentMgmt/ChannelMatch/<ID>
Method DELETE
Description Delete linkages of a channel.
Query None.
Request None.
Response XML_ResponseStatus

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

165
Intelligent Security API (Traffic) Developer Guide

A.216 /ISAPI/Traffic/ContentMgmt/ChannelMatch/capabilities
Get configuration capability of channel linkage.

Request URI Definition


Table A-346 GET /ISAPI/Traffic/ContentMgmt/ChannelMatch/capabilities
Method GET
Description Get configuration capability of channel linkage.
Query None.
Request None.
Response Succeeded: XML_ChannelMatchCap
Failed: XML_ResponseStatus

A.217 /ISAPI/Traffic/ContentMgmt/ChannelMatch/config
Get or set linkage parameters of all channels.

Request URI Definition


Table A-347 GET /ISAPI/Traffic/ContentMgmt/ChannelMatch/config
Method GET
Description Get linkage parameters of all channels.
Query None.
Request None.
Response Succeeded: XML_ChannelMatchCfg
Failed: XML_ResponseStatus
Table A-348 PUT /ISAPI/Traffic/ContentMgmt/ChannelMatch/config
Method PUT
Description Set linkage parameters of all channels.
Query None.
Request XML_ChannelMatchCfg
Response XML_ResponseStatus

166
Intelligent Security API (Traffic) Developer Guide

A.218 /ISAPI/Traffic/ContentMgmt/ChannelMatch/unusedChannel
Get information of channels with no linkage configured.

Request URI Definition


Table A-349 GET /ISAPI/Traffic/ContentMgmt/ChannelMatch/unusedChannel
Method GET
Description Get information of channels with no linkage configured.
Query None.
Request None.
Response Succeeded: XML_UnusedChannel
Failed: XML_ResponseStatus

A.219 /ISAPI/Traffic/ContentMgmt/dataOperation
Search for or delete vehicle passing data.

Request URL Definition


Table A-350 POST /ISAPI/Traffic/ContentMgmt/dataOperation
Method POST
Description Search for or delete vehicle passing data.
Query None.
Request XML_DataOperation
Response Succeeded: XML_TrafficSearchResult
Failed: XML_ResponseStatus

A.220 /ISAPI/Traffic/ContentMgmt/dataOperation/capabilities
Get capability of searching for or deleting vehicle passing data.

167
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-351 GET /ISAPI/Traffic/ContentMgmt/dataOperation/capabilities
Method GET
Description Get capability of searching for or deleting vehicle passing data.
Query None.
Request None.
Response Succeeded: XML_DataOperationCap
Failed: XML_ResponseStatus

A.221 /ISAPI/Traffic/ContentMgmt/FaceEvidence/capabilities
Get face evidence capability.

Request URI Definition


Table A-352 GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/capabilities
Method GET
Description Get face evidence capability.
Query None.
Request None.
Response Succeeded: XML_FaceEvidenceCap
Failed: XML_ResponseStatus

A.222 /ISAPI/Traffic/ContentMgmt/FaceEvidence/config
Get or set face evidence parameters.

Request URI Definition


Table A-353 GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/config
Method GET
Description Get face evidence parameters.
Query None.

168
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_FaceEvidenceCfg
Failed: XML_ResponseStatus
Table A-354 PUT /ISAPI/Traffic/ContentMgmt/FaceEvidence/config
Method PUT
Description Set face evidence parameters.
Query None.
Request XML_FaceEvidenceCfg
Response XML_ResponseStatus

A.223 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch
Get linkages of all face evidence channels or add a linkage for face evidence channel.

Request URI Definition


Table A-355 GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch
Method GET
Description Get linkages of all face evidence channels.
Query None.
Request None.
Response Succeeded: XML_FaceChannelMatchList
Failed: XML_ResponseStatus
Table A-356 POST /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch
Method POST
Description Add a linkage for face evidence channel.
Query None.
Request XML_FaceChannelMatchElement
Response XML_ResponseStatus

169
Intelligent Security API (Traffic) Developer Guide

A.224 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/
<ID>
Get, edit, or delete linkages of a face evidence channel.

Request URI Definition


Table A-357 GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/<ID>
Method GET
Description Get linkages of a face evidence channel
Query None.
Request None.
Response Succeeded: XML_FaceChannelMatchElement
Failed: XML_ResponseStatus
Table A-358 PUT /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/<ID>
Method PUT
Description Edit linkages of a face evidence channel.
Query None.
Request XML_FaceChannelMatchElement
Response XML_ResponseStatus
Table A-359 DELETE /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/<ID>
Method DELETE
Description Delete linkages of a face evidence channel.
Query None.
Request None.
Response XML_ResponseStatus

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

170
Intelligent Security API (Traffic) Developer Guide

A.225 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/
config
Get or set linkage parameters of all face evidence channels.

Request URI Definition


Table A-360 GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/config
Method GET
Description Get linkage parameters of all face evidence channels.
Query None.
Request None.
Response Succeeded: XML_FaceChannelMatchCfg
Failed: XML_ResponseStatus
Table A-361 PUT /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/config
Method PUT
Description Set linkage parameters of all face evidence channels.
Query None.
Request XML_FaceChannelMatchCfg
Response XML_ResponseStatus

A.226 /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/
status
Get channel linkage status.

Request URI Definition


Table A-362 GET /ISAPI/Traffic/ContentMgmt/FaceEvidence/FaceChannelMatch/status
Method GET
Description Get channel linkage status.
Query None.
Request None.
Response Succeeded: XML_FaceChannelMatchStatus

171
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus

A.227 /ISAPI/Traffic/ContentMgmt/fortifyStatus
Get the arming status of all devices linked with terminal server.

Request URI Definition


Table A-363 GET /ISAPI/Traffic/ContentMgmt/fortifyStatus
Method GET
Description Get the arming status of devices linked with terminal server.
Query None.
Request None.
Response Succeeded: XML_FortifyStatusList
Failed: XML_ResponseStatus

A.228 /ISAPI/Traffic/ContentMgmt/fortifyStatus/<ID>
Get the arming status of a device linked with terminal server.

Request URI Definition


Table A-364 GET /ISAPI/Traffic/ContentMgmt/fortifyStatus/<ID>
Method GET
Description Get the arming status of a device linked with terminal server.
Query None.
Request None.
Response Succeeded: XML_FortifyStatus
Failed: XML_ResponseStatus

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

A.229 /ISAPI/Traffic/ContentMgmt/GPS/capabilities
Get GPS capability of terminal server.

172
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-365 GET /ISAPI/Traffic/ContentMgmt/GPS/capabilities
Method GET
Description Get GPS capability of terminal server.
Query None.
Request None.
Response Succeeded: XML_GPSCap
Failed: XML_ResponseStatus

A.230 /ISAPI/Traffic/ContentMgmt/GPS/Status
Get GPS status of terminal server.

Request URI Definition


Table A-366 GET /ISAPI/Traffic/ContentMgmt/GPS/Status
Method GET
Description Get GPS status of terminal server.
Query None.
Request None.
Response Succeeded: XML_GPSStatus
Failed: XML_ResponseStatus

A.231 /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects
Get or set parameters of mixed traffic detection.

Request URI Definition


Table A-367 GET /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects
Method GET
Description Get parameters of mixed traffic detection.
Query None.

173
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_HVTVehicleDetectCfg
Failed: XML_ResponseStatus
Table A-368 PUT /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects
Method PUT
Description Set parameters of mixed traffic detection.
Query None.
Request XML_HVTVehicleDetectCfg
Response XML_ResponseStatus

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

A.232 /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/<SID>
Get or set parameters of mixed traffic detection (single scene).

Request URI Definition


Table A-369 GET /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/<SID>
Method GET
Description Get parameters of mixed traffic detection (single scene).
Query None.
Request None.
Response Succeeded: XML_HVTVehicleDetectScene
Failed: XML_ResponseStatus
Table A-370 PUT /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/<SID>
Method PUT
Description Set parameters of mixed traffic detection (single scene).
Query None.
Request XML_HVTVehicleDetectScene
Response XML_ResponseStatus

174
Intelligent Security API (Traffic) Developer Guide

Remarks
The <ID> in the request URI refers to channel ID, and the <SID> refers to scene ID.

A.233 /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/capabilities
Get the capability of mixed traffic detection.

Request URI Definition


Table A-371 GET /ISAPI/Traffic/channels/<ID>/HVTVehicleDetects/capabilities
Method GET
Description Get the capability of mixed traffic detection.
Query None.
Request None.
Response Succeeded: XML_Cap_HVTVehicleDetectCfg
Failed: XML_ResponseStatus

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

A.234 /ISAPI/Traffic/ContentMgmt/InputProxy/channels
Get or set parameters of all traffic channels.

Request URI Definition


Table A-372 GET /ISAPI/Traffic/ContentMgmt/InputProxy/channels
Method GET
Description Get parameters of all traffic channels.
Query None.
Request None.
Response Succeeded: XML_InputProxyChannelsList
Failed: XML_ResponseStatus
Table A-373 PUT /ISAPI/Traffic/ContentMgmt/InputProxy/channels
Method PUT
Description Set parameters of all traffic channels.

175
Intelligent Security API (Traffic) Developer Guide

Query None.
Request XML_InputProxyChannelsList
Response XML_ResponseStatus

A.235 /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>
Get or set parameters of a specific traffic channel.

Request URI Definition


Table A-374 GET /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>
Method GET
Description Get parameters of a specific traffic channel.
Query None.
Request None.
Response Succeeded: XML_InputProxyChannel
Failed: XML_ResponseStatus
Table A-375 PUT /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>
Method PUT
Description Set parameters of a specific traffic channel.
Query None.
Request XML_InputProxyChannel
Response XML_ResponseStatus

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

A.236 /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>/basic
Get or set parameters of a specific monitoring point.

176
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-376 GET /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>/basic
Method GET
Description Get parameters of a specific monitoring point.
Query None.
Request None.
Response Succeeded: XML_Device_BasicInfo
Failed: XML_ResponseStatus
Table A-377 PUT /ISAPI/Traffic/ContentMgmt/InputProxy/channels/<ID>/basic
Method PUT
Description Set parameters of a specific monitoring point.
Query None.
Request XML_Device_BasicInfo
Response XML_ResponseStatus

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

A.237 /ISAPI/Traffic/ContentMgmt/InputProxy/channels/capabilities
Get capability of traffic channels.

Request URI Definition


Table A-378 GET /ISAPI/Traffic/ContentMgmt/InputProxy/channels/capabilities
Method GET
Description Get capability of traffic related channels.
Query None.
Request None.
Response Succeeded: XML_InputProxyChannelsCap
Failed: XML_ResponseStatus

177
Intelligent Security API (Traffic) Developer Guide

A.238 /ISAPI/Traffic/ContentMgmt/netPortStatus
Get the connection status of network interface.

Request URI Definition


Table A-379 GET /ISAPI/Traffic/ContentMgmt/netPortStatus
Method GET
Description Get the connection status of network interface.
Query None.
Request None.
Response Succeeded: XML_NetPortStatusList
Failed: XML_ResponseStatus

A.239 /ISAPI/Traffic/ContentMgmt/picModel
Get or set parameters of searching picture by picture.

Request URI Definition


Table A-380 GET /ISAPI/Traffic/ContentMgmt/picModel
Method GET
Description Get parameters of searching picture by picture.
Query None.
Request None.
Response Succeeded: XML_PicModel
Failed: XML_ResponseStatus
Table A-381 PUT /ISAPI/Traffic/ContentMgmt/picModel
Method PUT
Description Set parameters of searching picture by picture.
Query None.
Request XML_PicModel
Response XML_ResponseStatus

178
Intelligent Security API (Traffic) Developer Guide

A.240 /ISAPI/Traffic/ContentMgmt/picModel/capabilities
Get capability of searching picture by picture.

Request URI Definition


Table A-382 GET /ISAPI/Traffic/ContentMgmt/picModel/capabilities
Method GET
Description Get capability of searching picture by picture.
Query None.
Request None.
Response Succeeded: XML_PicModelCap
Failed: XML_ResponseStatus

A.241 /ISAPI/Traffic/ContentMgmt/picRecInfo
Search for picture and video according to vehicle passing data.

Request URI Definition


Table A-383 POST /ISAPI/Traffic/ContentMgmt/picRecInfo
Method POST
Description Search for picture and video according to vehicle passing data.
Query None.
Request XML_PicRecInfoSearchDescription
Response Succeeded: XML_PicRecInfoSearchResult
Failed: XML_ResponseStatus

A.242 /ISAPI/Traffic/ContentMgmt/Picture/<datatype>
Get a picture.

179
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-384 GET /ISAPI/Traffic/ContentMgmt/Picture/<datatype>
Method GET
Description Get a picture.
Query None.
Request None.
Response Succeeded: a binary picture
Failed: XML_ResponseStatus

Remarks
The <datatype> in the request URI refers to the picture data type to be obtained.

A.243 /ISAPI/Traffic/ContentMgmt/realTrafficStats
Get latest traffic statistics data.

Request URI Definition


Table A-385 GET /ISAPI/Traffic/ContentMgmt/realTrafficStats
Method GET
Description Get latest traffic statistics data.
Query None.
Request None.
Response Succeeded: XML_RealTrafficStats
Failed: XML_ResponseStatus

A.244 /ISAPI/Traffic/ContentMgmt/RemoteHost
Get parameters of remote host servers.

Request URI Definition


Table A-386 GET /ISAPI/Traffic/ContentMgmt/RemoteHost
Method GET
Description Get parameters of remote host servers.

180
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_RemoteHostList
Failed: XML_ResponseStatus

A.245 /ISAPI/Traffic/ContentMgmt/RemoteHost/<ID>
Get or set parameters of a remote host server.

Request URI Definition


Table A-387 GET /ISAPI/Traffic/ContentMgmt/RemoteHost/<ID>
Method GET
Description Get parameters of a remote host server.
Query None.
Request None.
Response Succeeded: XML_RemoteHost
Failed: XML_ResponseStatus
Table A-388 PUT /ISAPI/Traffic/ContentMgmt/RemoteHost/<ID>
Method PUT
Description Set parameters of a remote host server.
Query None.
Request XML_RemoteHost
Response XML_ResponseStatus

Remarks
The <ID> in the request URI refers to the remote host server No., which can be 1 or 2.

A.246 /ISAPI/Traffic/ContentMgmt/RemoteHost/capabilities
Get capability of data uploading.

181
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-389 GET /ISAPI/Traffic/ContentMgmt/RemoteHost/capabilities
Method GET
Description Get capability of data uploading.
Query None.
Request None.
Response Succeeded: XML_RemoteHostCap
Failed: XML_ResponseStatus

A.247 /ISAPI/Traffic/ContentMgmt/RemoteHost/Statistics
Search for the uploaded and uploading data statistics by time.

Request URI Definition


Table A-390 POST /ISAPI/Traffic/ContentMgmt/RemoteHost/Statistics
Method POST
Description Search for the uploaded and uploading data statistics by time.
Query None.
Request XML_StatisticsSearch
Response Succeeded: XML_StatisticsResult
Failed: XML_ResponseStatus

A.248 /ISAPI/Traffic/ContentMgmt/RemoteHost/UploadCtrl
Upload data again.

Request URI Definition


Table A-391 PUT /ISAPI/Traffic/ContentMgmt/RemoteHost/UploadCtrl
Method PUT
Description Upload data again.
Query None.

182
Intelligent Security API (Traffic) Developer Guide

Request XML_UploadCtrl
Response XML_ResponseStatus

A.249 /ISAPI/Traffic/ContentMgmt/Section
Get linkages of all section speed detection channels or add a linkage for section speed detection
channel.

Request URI Definition


Table A-392 GET /ISAPI/Traffic/ContentMgmt/Section
Method GET
Description Get linkages of all section speed detection channels.
Query None.
Request None.
Response Succeeded: XML_SectionList
Failed: XML_ResponseStatus
Table A-393 POST /ISAPI/Traffic/ContentMgmt/Section
Method POST
Description Add a linkage for section speed detection channel
Query None.
Request XML_SectionElement
Response XML_ResponseStatus

A.250 /ISAPI/Traffic/ContentMgmt/Section/<ID>
Get, edit, or delete linkages of a section speed detection channel.

Request URI Definition


Table A-394 GET /ISAPI/Traffic/ContentMgmt/Section/<ID>
Method GET
Description Get linkages of a section speed detection channel.
Query None.

183
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_SectionElement
Failed: XML_ResponseStatus
Table A-395 PUT /ISAPI/Traffic/ContentMgmt/Section/<ID>
Method PUT
Description Edit, or delete linkages of a section speed detection channel.
Query None.
Request XML_SectionElement
Response XML_ResponseStatus
Table A-396 DELETE /ISAPI/Traffic/ContentMgmt/Section/<ID>
Method DELETE
Description Delete linkages of a section speed detection channel.
Query None.
Request None.
Response XML_ResponseStatus

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

A.251 /ISAPI/Traffic/ContentMgmt/Section/capabilities
Get capability of section speed detection.

Request URI Definition


Table A-397 GET /ISAPI/Traffic/ContentMgmt/Section/capabilities
Method GET
Description Get capability of section speed detection.
Query None.
Request None.
Response Succeeded: XML_SectionCap
Failed: XML_ResponseStatus

184
Intelligent Security API (Traffic) Developer Guide

A.252 /ISAPI/Traffic/ContentMgmt/Section/config
Get or set parameters of section speed detection.

Request URI Definition


Table A-398 GET /ISAPI/Traffic/ContentMgmt/Section/config
Method GET
Description Get parameters of section speed detection.
Query None.
Request None.
Response Succeeded: XML_SectionCfg
Failed: XML_ResponseStatus
Table A-399 PUT /ISAPI/Traffic/ContentMgmt/Section/config
Method PUT
Description Set parameters of section speed detection.
Query None.
Request XML_SectionCfg
Response XML_ResponseStatus

A.253 /ISAPI/Traffic/ContentMgmt/Section/unusedChannel
Get information of section speed detection channels with no linkage configured.

Request URI Definition


Table A-400 GET /ISAPI/Traffic/ContentMgmt/Section/unusedChannel
Method GET
Description Get information of section speed detection channels with no linkage
configured
Query None.
Request None.
Response Succeeded: XML_UnusedChannel
Failed: XML_ResponseStatus

185
Intelligent Security API (Traffic) Developer Guide

A.254 /ISAPI/Traffic/ContentMgmt/SlaveSystem/capabilities
Get capability of getting subsystem status and parameters.

Request URI Definition


Table A-401 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/capabilities
Method GET
Description Get capability of getting subsystem status and parameters.
Query None.
Request None.
Response Succeeded: XML_SlaveSystemCap
Failed: XML_ResponseStatus

A.255 /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LcdCfg
Get or set parameters of LCD control system.

Request URI Definition


Table A-402 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LcdCfg
Method GET
Description Get parameters of LCD control system.
Query None.
Request None.
Response Succeeded: XML_LcdCfg
Failed: XML_ResponseStatus
Table A-403 PUT /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LcdCfg
Method PUT
Description Set parameters of LCD control system.
Query None.
Request XML_LcdCfg
Response XML_ResponseStatus

186
Intelligent Security API (Traffic) Developer Guide

A.256 /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LightCfg
Get or set parameters of traffic light detection system.

Request URI Definition


Table A-404 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LightCfg
Method GET
Description Get parameters of traffic light detection system.
Query None.
Request None.
Response Succeeded: XML_LightCfg
Failed: XML_ResponseStatus
Table A-405 PUT /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/LightCfg
Method PUT
Description Set parameters of traffic light detection system.
Query None.
Request XML_LightCfg
Response XML_ResponseStatus

A.257 /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/PowerCfg
Get or set parameters of power system.

Request URI Definition


Table A-406 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/PowerCfg
Method GET
Description Get parameters of power system.
Query None.
Request None.
Response Succeeded: XML_SmartPowerCfg
Failed: XML_ResponseStatus

187
Intelligent Security API (Traffic) Developer Guide

Table A-407 PUT /ISAPI/Traffic/ContentMgmt/SlaveSystem/config/PowerCfg


Method PUT
Description Set parameters of power system.
Query None.
Request XML_SmartPowerCfg
Response XML_ResponseStatus

A.258 /ISAPI/Traffic/ContentMgmt/SlaveSystem/searchData/powerData
Search for power system data.

Request URI Definition


Table A-408 POST /ISAPI/Traffic/ContentMgmt/SlaveSystem/searchData/powerData
Method POST
Description Search for power system data.
Query None.
Request XML_PowerDataSearchDescription
Response Succeeded: XML_PowerDataSearchResult
Failed: XML_ResponseStatus

A.259 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status
Get statuses of subsystems.

Request URI Definition


Table A-409 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status
Method GET
Description Get statuses of subsystems.
Query None.
Request None.
Response Succeeded: XML_SlaveSystemStatus
Failed: XML_ResponseStatus

188
Intelligent Security API (Traffic) Developer Guide

A.260 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/AnalogStatus
Get status of analog system.

Request URI Definition


Table A-410 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/AnalogStatus
Method GET
Description Get status of analog system.
Query None.
Request None.
Response Succeeded: XML_AnalogStatus
Failed: XML_ResponseStatus

A.261 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LcdStatus
Get status of LCD control system.

Request URI Definition


Table A-411 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LcdStatus
Method GET
Description Get status of LCD control system.
Query None.
Request None.
Response Succeeded: XML_LcdStatus
Failed: XML_ResponseStatus

A.262 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LightStatus
Get status of traffic light detection system.

189
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-412 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/LightStatus
Method GET
Description Get status of traffic light detection system.
Query None.
Request None.
Response Succeeded: XML_LightStatus
Failed: XML_ResponseStatus

A.263 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/OPTStatus
Get status of optical terminal.

Request URI Definition


Table A-413 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/OPTStatus
Method GET
Description Get status of optical terminal.
Query None.
Request None.
Response Succeeded: XML_OPTStatus
Failed: XML_ResponseStatus

A.264 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/PowerStatus
Get status of power system.

Request URI Definition


Table A-414 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/PowerStatus
Method GET
Description Get status of power system.
Query None.

190
Intelligent Security API (Traffic) Developer Guide

Request None.
Response Succeeded: XML_SmartPowerStatus
Failed: XML_ResponseStatus

A.265 /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/TX1Status
Get status of TX1 subsystem.

Request URI Definition


Table A-415 GET /ISAPI/Traffic/ContentMgmt/SlaveSystem/status/TX1Status
Method GET
Description Get status of TX1 subsystem.
Query None.
Request None.
Response Succeeded: XML_TX1Status
Failed: XML_ResponseStatus

A.266 /ISAPI/Traffic/ContentMgmt/Statistic/capabilities
Get traffic flow statistics capability.

Request URI Definition


Table A-416 GET /ISAPI/Traffic/ContentMgmt/Statistic/capabilities
Method GET
Description Get traffic flow statistics capability.
Query None.
Request None.
Response Succeeded: XML_StatisticCap
Failed: XML_ResponseStatus

A.267 /ISAPI/Traffic/ContentMgmt/Statistic/config
Get or set parameters of traffic flow statistics.

191
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-417 GET /ISAPI/Traffic/ContentMgmt/Statistic/config
Method GET
Description Get parameters of traffic flow statistics.
Query None.
Request None.
Response Succeeded: XML_StatisticCfg
Failed: XML_ResponseStatus
Table A-418 PUT /ISAPI/Traffic/ContentMgmt/Statistic/config
Method PUT
Description Set parameters of traffic flow statistics.
Query None.
Request XML_StatisticCfg
Response XML_ResponseStatus

A.268 /ISAPI/Traffic/ContentMgmt/Statistic/operator
Search for, delete, or format the traffic flow statistics.

Request URI Definition


Table A-419 POST
Method POST
Description Search for, delete, or format the traffic flow statistics.
Query None.
Request XML_StatisticOperator
Response Succeeded: XML_StatisticOperatorResult
Failed: XML_ResponseStatus

A.269 /ISAPI/Traffic/ContentMgmt/trafficLightStatus/<ID>
Get traffic light status by channel.

192
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-420 GET /ISAPI/Traffic/ContentMgmt/trafficLightStatus/<ID>
Method GET
Description Get traffic light status by channel.
Query None.
Request None.
Response Succeeded: XML_RedLightStatus
Failed: XML_ResponseStatus

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

A.270 /ISAPI/Traffic/ContentMgmt/uploadModuleStatus
Get network status of all data uploading modules.

Request URI Definition


Table A-421 GET /ISAPI/Traffic/ContentMgmt/uploadModuleStatus
Method GET
Description Get network status of module that the data is uploaded to.
Query None.
Request None.
Response Succeeded: XML_UploadModuleStateList
Failed: XML_ResponseStatus

A.271 /ISAPI/Traffic/ContentMgmt/uploadModuleStatus/<ID>
Get network status of a data uploading module.

Request URI Definition


Table A-422 GET /ISAPI/Traffic/ContentMgmt/uploadModuleStatus/<ID>
Method GET
Description Get network status of a data uploading module.

193
Intelligent Security API (Traffic) Developer Guide

Query None.
Request None.
Response Succeeded: XML_UploadModule
Failed: XML_ResponseStatus

Remarks
The <ID> in the request URI refers to the data uploading module ID.

A.272 /ISAPI/Traffic/ContentMgmt/wirelessDialStatus
Get status of wireless module.

Request URI Definition


Table A-423 GET /ISAPI/Traffic/ContentMgmt/wirelessDialStatus
Method GET
Description Get status of wireless module.
Query None.
Request None.
Response Succeeded: XML_wirelessDialStatus
Failed: XML_ResponseStatus

A.273 /ISAPI/Traffic/dockStation/basicInfo?format=json
Get or set basic parameters of dock station.

Request URI Definition


Table A-424 GET /ISAPI/Traffic/dockStation/basicInfo?format=json
Method GET
Description Get basic parameters of dock station.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_BasicInfo
Failed: JSON_ResponseStatus

194
Intelligent Security API (Traffic) Developer Guide

Table A-425 PUT /ISAPI/Traffic/dockStation/basicInfo?format=json


Method PUT
Description Set basic parameters of dock station.
Query format: determine the format of request or response message.
Request JSON_BasicInfo
Response JSON_ResponseStatus

A.274 /ISAPI/Traffic/dockStation/deviceManagement/<ID>?format=json
Set a body camera's information, or delete a body camera.

Request URI Definition


Table A-426 PUT /ISAPI/Traffic/dockStation/deviceManagement/<ID>?format=json
Method PUT
Description Set a body camera's information.
Query format: determine the format of request or response message.
Request JSON_DeviceInfo
Response JSON_ResponseStatus
Table A-427 DELETE /ISAPI/Traffic/dockStation/deviceManagement/<ID>?format=json
Method DELETE
Description Delete a body camera.
Query format: determine the format of request or response message.
Request None
Response JSON_ResponseStatus

Remarks
The <ID> in the request URI refers to the body camera ID.

A.275 /ISAPI/Traffic/dockStation/deviceManagement/capabilities?
format=json
Get capability of body camera management.

195
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-428 GET /ISAPI/Traffic/dockStation/deviceManagement/capabilities?format=json
Method GET
Description Get capability of body camera management.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_Cap_DeviceInfo
Failed: JSON_ResponseStatus

A.276 /ISAPI/Traffic/dockStation/deviceManagement?format=json
Get information of all body cameras, or add a body camera.

Request URI Definition


Table A-429 GET /ISAPI/Traffic/dockStation/deviceManagement?format=json
Method GET
Description Get information of all body cameras.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_DeviceInfoList
Failed: JSON_ResponseStatus
Table A-430 POST /ISAPI/Traffic/dockStation/deviceManagement?format=json
Method POST
Description Add a body camera.
Query format: determine the format of request or response message.
Request JSON_DeviceInfo
Response JSON_ResponseStatus

A.277 /ISAPI/Traffic/dockStation/information/capabilities?format=json
Get the capability of information notification.

196
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-431 GET /ISAPI/Traffic/dockStation/information/capabilities?format=json
Method GET
Description Get the capability of information notification.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_Cap_Information
Failed: JSON_ResponseStatus

A.278 /ISAPI/Traffic/dockStation/information?format=json
Set information notification parameters to notify the dock station.

Request URI Definition


Table A-432 PUT /ISAPI/Traffic/dockStation/information?format=json
Method PUT
Description Set information notification parameters to notify the dock station.
Query format: determine the format of request or response message.
Request JSON_Information
Response JSON_ResponseStatus

A.279 /ISAPI/Traffic/dockStation/personManagement/<ID>?
format=json
Set a person's information, or delete a person.

Request URI Definition


Table A-433 PUT /ISAPI/Traffic/dockStation/personManagement/<ID>?format=json
Method PUT
Description Set a person's information.
Query format: determine the format of request or response message.

197
Intelligent Security API (Traffic) Developer Guide

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.
Request JSON_PersonInfo
Response JSON_ResponseStatus
Table A-434 DELETE /ISAPI/Traffic/dockStation/personManagement/<ID>?format=json
Method DELETE
Description Delete a person.
Query format: determine the format of request or response message.
Request None
Response JSON_ResponseStatus

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

A.280 /ISAPI/Traffic/dockStation/personManagement/capabilities?
format=json
Get person management capability.

Request URI Definition


Table A-435 GET /ISAPI/Traffic/dockStation/personManagement/capabilities?format=json
Method GET
Description Get person management capability.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_Cap_PersonInfo
Failed: JSON_ResponseStatus

198
Intelligent Security API (Traffic) Developer Guide

A.281 /ISAPI/Traffic/dockStation/personManagement?format=json
Get all persons' information, or add a person.

Request URI Definition


Table A-436 GET /ISAPI/Traffic/dockStation/personManagement?format=json
Method GET
Description Get all persons' information.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_PersonInfoList
Failed: JSON_ResponseStatus
Table A-437 POST /ISAPI/Traffic/dockStation/personManagement?format=json
Method POST
Description Add a person.
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_PersonInfo
Response JSON_ResponseStatus

A.282 /ISAPI/Traffic/DockStation/PlatformConfig/schedule/capabilities?
format=json
Get schedule configuration capability of uploading files to platform.

199
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-438 GET /ISAPI/Traffic/DockStation/PlatformConfig/schedule/capabilities?format=json
Method GET
Description Get schedule configuration capability of uploading files to platform.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_ScheduleCap
Failed: JSON_ResponseStatus

A.283 /ISAPI/Traffic/dockStation/platformConfig/schedule?format=json
Get or set schedule parameters of uploading files to platform.

Request URI Definition


Table A-439 GET /ISAPI/Traffic/dockStation/platformConfig/schedule?format=json
Method GET
Description Get schedule parameters of uploading files to platform.
Query format: determine the format of request or response message.
Request None
Response Succeeded: JSON_Schedule
Failed: JSON_ResponseStatus
Table A-440 PUT /ISAPI/Traffic/dockStation/platformConfig/schedule?format=json
Method PUT
Description Set schedule parameters of uploading files to platform.
Query format: determine the format of request or response message.
Request JSON_Schedule
Response JSON_ResponseStatus

A.284 /ISAPI/Traffic/dockStation/slot/open?format=json
Open the storage bin.

200
Intelligent Security API (Traffic) Developer Guide

Request URI Definition


Table A-441 PUT /ISAPI/Traffic/dockStation/slot/open?format=json
Method PUT
Description Open the storage bin.
Query format: determine the format of request or response message.
Request JSON_UserInfo
Response JSON_ResponseStatus

A.285 ISAPI/Traffic/dockStation/slot/priorityCollection?format=json
Set priority parameters of collection.

Request URI Definition


Table A-442 PUT ISAPI/Traffic/dockStation/slot/priorityCollection?format=json
Method PUT
Description Set priority parameters of collection.
Query format: determine the format of request or response message.
Request JSON_PriorityCollection
Response JSON_ResponseStatus

A.286 /ISAPI/Traffic/MNPR/channels/<ID>
Get the manual license plate recognition result by channel.

Request URI Definition


Table A-443 GET /ISAPI/Traffic/MNPR/channels/<ID>
Method GET
Description Get the manual license plate recognition result by channel.
Query None
Request None
Response Succeeded: XML_EventNotificationAlert_ANPRMsg and picture data
in form format

201
Intelligent Security API (Traffic) Developer Guide

Failed: XML_ResponseStatus

Remarks
The <ID> in the request URI refers to the channel ID.
Example
Returned Picture Data in Form Format
GET /ISAPI/Traffic/MNPR/channels/<ID>

HTTP/1.1 200 OK
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary=boundary
Content-Length: 9907

--boundary
Content-Disposition: form-data; name="anpr.xml";filename="anpr.xml";
Content-Type: text/xml
Content-Length: 150

<EventNotificationAlert/>
--boundary
Content-Disposition: form-data; name="licensePlatePicture.jpg";filename="licensePlatePicture.jpg";
Content-Type: image/pjpeg
Content-Length: 200

......JFIF.....`.`.....C........... .
..
................. $.' ",#..(7),01444.'9=82<.342...C. ....

.2!.!22222222222222222222222222222222222222222222222222...
.....................}........!1A..Qa."q.2....#B...R..$3br.
.....%&'()*456789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz..............
.....................w.......!1..AQ.aq."2...B.... #3R..br.
.$4.
--boundary
Content-Disposition: form-data; name="detectionPicture.jpg";filename="detectionPicture.jpg";
Content-Type: image/pjpeg
Content-Length: 9907

......JFIF.....`.`.....C........... .
..
................. $.' ",#..(7),01444.'9=82<.342...C. ....

.2!.!22222222222222222222222222222222222222222222222222...
.....................}........!1A..Qa."q.2....#B...R..$3br.
.....%&'()*456789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz..............
.....................w.......!1..AQ.aq."2...B.... #3R..br.
.$4.
--boundary--

202
Intelligent Security API (Traffic) Developer Guide

A.287 /ISAPI/Traffic/plateList
Import and export vehicle blacklist and whitelist.

Request URI Definition


Table A-444 GET /ISAPI/Traffic/plateList
Method GET
Description Export the vehicle blacklist and whitelist.
Query None
Request None
Response Opaque data (binary data in the EXCEL format).
Table A-445 PUT /ISAPI/Traffic/plateList
Method PUT
Description Import the vehicle blacklist and whitelist.
Query None
Request Opaque data (binary data in the EXCEL format).
Response XML_ResponseStatus

A.288 /ISAPI/Traffic/signal/capabilities?format=json
Get the capability of traffic light control commands.

Request URI Definition


Table A-446 GET /ISAPI/Traffic/signal/capabilities?format=json
Method GET
Description Get the capability of traffic light control commands.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_TrafficSignalCap
Failed: JSON_ResponseStatus

203
Intelligent Security API (Traffic) Developer Guide

A.289 /ISAPI/Traffic/signal?format=json
Send traffic light control command.

Request URI Definition


Table A-447 PUT /ISAPI/Traffic/signal?format=json
Method PUT
Description Send traffic light control command.
Query format: determine the format of request or response message.
Request JSON_TrafficSignal
Response JSON_ResponseStatus

A.290 /ISAPI/Traffic/slaveVersionInfo
Get version information of traffic subsystem.

Request URI Definition


Table A-448 GET /ISAPI/Traffic/slaveVersionInfo
Method GET
Description Get version information of traffic subsystem.
Query None.
Request None.
Response Succeeded: XML_SlaveVersionInfo
Failed: XML_ResponseStatus

A.291 /ISAPI/Traffic/upgradeByUSB/capabilities?format=json
Get the capability of upgrading via USB.

Request URI Definition


Table A-449 GET /ISAPI/Traffic/upgradeByUSB/capabilities?format=json
Method GET
Description Get the capability of upgrading via USB.

204
Intelligent Security API (Traffic) Developer Guide

Query format: determine the format of request or response message.


Request None.
Response Succeeded: JSON_Cap_UpgradeParam
Failed: JSON_ResponseStatus

A.292 /ISAPI/Traffic/upgradeByUSB/progress?format=json
Get the progress of upgrading via USB.

Request URI Definition


Table A-450 GET /ISAPI/Traffic/upgradeByUSB/progress?format=json
Method GET
Description Get the progress of upgrading via USB.
Query format: determine the format of request or response message.
Request None.
Response Succeeded: JSON_UpgradeProgress
Failed: JSON_ResponseStatus

A.293 /ISAPI/Traffic/upgradeByUSB?format=json
Upgrade via USB.

Request URI Definition


Table A-451 PUT /ISAPI/Traffic/upgradeByUSB?format=json
Method PUT
Description Upgrade via USB.
Query format: determine the format of request or response message.
Request JSON_UpgradeParam
Response JSON_ResponseStatus

Remarks
You can get the upgrading progress by calling the request URI: GET /ISAPI/Traffic/upgradeByUSB/
progress?format=json .

205
Intelligent Security API (Traffic) Developer Guide

Appendix B. Request and Response Messages

B.1 JSON_AddrInfo
AddrInfo message in JSON format
{
"AddrInfo":{
/*required, address information*/
"size": ,
/*required, int, supported size of the address list*/
"AddrList":
/*required, array, address list*/
}
}

B.2 JSON_AutoUpdateblackList
AutoUpdateblackList message in JSON format.
{
"AutoUpdateblackList": {
/*required, string type, time point array of automatic update*/
"time": ["",""]
/*time format is hh:mm:ss, e.g., 00:00:00*/
}
}

B.3 JSON_AutoUpdateblackListCap
AutoUpdateblackListCap capability message in JSON format.
{
"AutoUpdateblackListCap": {
"time": {
"@min": 1,
/*required, integer type, minimum number of time points*/
"@max": 3,
/*required,integer type, maximum number of time points*/
"#text": ""
/*required,integer type, time format, e.g., 00:00*/
},
"lastUpdateTime":
/*number of last updated time points*/

206
Intelligent Security API (Traffic) Developer Guide

}
}

B.4 JSON_BasicInfo
JSON message about basic parameters of dock station
{
"BasicInfo":{
"dockStationID":"",
/*required, string, dock station No., if this node is not returned, it indicates that the ID cannot be edited*/
"videoFormatList":[{
/*required, array, video format, the value can be "mp4", "MP4", "Mp4", and "mP4"; the maximum size is 32 bytes*/
"type":""
}
{
"type":""
}],
"imageFormatList":[{
/*required, array, picture format, the value can be "JPG", "JPg", "JpG", "Jpg", "jpg", "jpG", "jPg", and "jPG"; the
maximum size is 32 bytes*/
"type":""
}
{
"type":""
}],
"audioFormatList":[{
/*required, array, audio format, the value can be "WAV", "Wav", "WAv", "WaV", "wAV", "wAv", "waV", and "wav"; the
maximum size is 32 bytes*/
"type": ""
}
{
"type": ""
}]
}
}

B.5 JSON_Cap_AddrInfo
AddrInfo capability message in JSON format
{
"AddrInfo":{
/*required, address information*/
"size":{
/*required, supported size of the address list*/
"@min":1,
/*required, int, the minimum number of addresses in the list*/
"@max":5

207
Intelligent Security API (Traffic) Developer Guide

/*required, int, the maximum number of addresses in the list*/


},
"AddrList":{
/*required, address list*/
"@min":32,
/*required, int, the minimum length of the address*/
"@max":256
/*required, int, the maximum length of the address*/
}
}
}

B.6 JSON_Cap_CentralStorageBackupFileList
JSON message about central storage backup capability
{
"CentralStorageBackupFileList": {
"@size": 1000,
/*required, int, the maximum number of files supported in a single backup*/
"trackId":
/*required, boolean, supported file No., read-only, user should configure the node and apply it to the device*/
}
}

B.7 JSON_Cap_DeviceInfo
JSON message about capability of body camera management
{
"DeviceInfo":{
"deviceId":{
/*optional, string, body camera No.*/
"@min":4,
/*minimum value of length range*/
"@max":32
/*maximum value of length range*/
},
"deviceName":{
/*required, string, body camera name*/
"@min":4,
/*minimum value of length range*/
"@max":32
/*maximum value of length range*/
},
"deviceUserList":{
/*required, user information list*/
"userId":{
"@min":4,

208
Intelligent Security API (Traffic) Developer Guide

/*minimum value of length range*/


"@max":32
/*maximum value of length range*/
}
}
}
}

B.8 JSON_Cap_Information
Message about getting the capability of information notification in JSON format

{
"Information":{
"infoType":{
/*required, information type*/
"@opt":""
/*required, string, available information types: normalInfo,emergencyInfo*/
},
"infoContent":{
/*required, string, information content*/
"@min":,
/*required, int, minimum size of information content*/
"@max":
/*required, int, maximum size of information content*/
}
}
}

B.9 JSON_Cap_PersonInfo
JSON message about person management capability
{
"PersonInfo":{
"id":{
/*required, string, user No.*/
"@min":4,
/*minimum value of length range*/
"@max":32
/*maximum value of length range*/
},
"name":{
/*requird, string, user name*/
"@min":4,
/*minimum value of length range*/
"@max":32
/*maximum value of length range*/

209
Intelligent Security API (Traffic) Developer Guide

},
"password":{
/*required, string, user password*/
"@min":6,
/*minimum value of length range*/
"@max":32
/*maximum value of length range*/
},
"filePermission":{
/*required, boolean, whether to assign file search permission*/
"@opt":"true,false"
},
"mobile":{
/*optional, string, user contacts*/
"@min":4,
/*minimum value of length range*/
"@max":12
/*maximum value of length range*/
},
"filePermissionsuper":{
/*required, boolean, whether it has the permission of super administrator*/
"@opt":"true,false"
},
"collectStatus":{
/*required, boolean, whether the face data is collected by this person, it is read-only*/
"@opt":"true,false"
},
"deviceId":{
/*required, string, body camera ID*/
"@min":4,
/*minimum length of the range*/
"@max":12
/*maximum length of the range*/
},
}
}

B.10 JSON_Cap_RadarMeasurement
RadarMeasurement capability message in JSON format
{
"RadarMeasurement":{
/*required, radar measurement parameters*/
"enabled":{
/*whether to enable radar measurement*/
"@opt":"true,false"
},
"MeasurementMode":{
/*required, measurement mode: "radiationPatternDetection"-radiation pattern detection,

210
Intelligent Security API (Traffic) Developer Guide

"simulatedSpeedDetection"-simulated speed detection, "measuredSpeedDetection"-measurement speed detection*/


"@opt":"radiationPatternDetection,simulatedSpeedDetection,measuredSpeedDetection"
}
}
}

B.11 JSON_Cap_UpgradeParam
UpgradeParam capability message in JSON format
{
"UpgradeParam":{
"upgradeType":{
/*required, upgrading type*/
"@opt":["radarUpgrade", "systemUpgrade"]
}
}
}

B.12 JSON_CentralStorageBackupFileList
JSON message about central storage backup parameters
{
"CentralStorageBackupFileList": [{
"trackId ": "",
/*required, string, file No.*/
}]
}

B.13 JSON_DeviceInfo
JSON message about a body camera's information
{
"DeviceInfo":{
"deviceId":"",
/*optional, string, body camera No.*/
"deviceName":"",
/*required, string, body camera name*/
"deviceUserList":[{
/*required, user information list*/
"userId":""
}]
}
}

211
Intelligent Security API (Traffic) Developer Guide

B.14 JSON_DeviceInfoList
JSON message about information list of body camera
{
"DeviceInfoList":[{
"DeviceInfo":{
"deviceId":"",
/*optional, string, body camera No.*/
"deviceName":"",
/*required, string, body camera name*/
"deviceUserList":[{
/*required, user information list*/
"userId":""
}]
}
}]
}

B.15 JSON_DockStation_FileUpload
JSON message about parameters of file upload of dock station.
{
"FileUpload": {
"enabled":
}
}

B.16 JSON_EventNotificationAlert_Alarm/EventInfo
EventNotificationAlert message with alarm or event information in JSON format.
{
"ipAddress": "",
/*required, device IPv4 address , string, the maximum size is 32 bytes*/
"ipv6Address": "",
/*optional, device IPv6 address, string, the maximum size is 128 bytes*/
"portNo": ,
/*optional, device port No., integer32*/
"protocol": "",
/*optional, protocol type, "HTTP, HTTPS", string, the maximum size is 32 bytes*/
"macAddress": "",
/*optional, MAC address, string, the maximum size is 32 bytes, e.g., 01:17:24:45:D9:F4*/
"channelID": "",
/*optional, device channel No., integer32*/
"dateTime": "",

212
Intelligent Security API (Traffic) Developer Guide

/*optional, string, alarm/event triggered or occurred time based on ISO8601, the maximum size is 32 bytes, e.g.,
2009-11-14T15:27Z*/
"activePostCount": "",
/*required, alarm/event frequency, integer32*/
"eventType": "",
/*required, alarm/event type, "captureResult, faceCapture,...", string, the maximum size is 128 bytes*/
"eventState": "",
/*required, string, the maximum size is 32 bytes, durative alarm/event status: "active"-valid, "inactive"-invalid*/
"eventDescription": "",
/*required, event description, string, the maximum size is 128 bytes*/
"deviceID":"",
/*string type, device ID*/
"uuid":"",
/*string type, event UUID, which is used to uniquely identify an event, the standard UUID format is xxxxxxxx-xxxx-xxxx-
xxxx-xxxxxxxxxxxx*/
...
/*optional, for different alarm/event types, the nodes are different, see the message examples in different
applications*/
}

B.17 JSON_EventNotificationAlert_DockStationExceptionAlarmMsg
JSON message about alarm details of dock station exception
{
"ipAddress": "",
/*required, string, IPv4 address of alarm device, the maximum value size is 32 bytes, e.g., 172.6.64.7*/
"ipv6Address": "",
/*required, string, IPv6 address of alarm device, the maximum value size is 128 bytes*/
"portNo": ,
/*optional, integer32, port No. of alarm device*/
"protocol": "",
/*optional, string, protocol type: "HTTP"-for device network SDK, "HTTPS", "EHome"-for ISUP SDK; the maximum
value size is 32 bytes*/
"macAddress": "",
/*optional, string, MAC address, the maximum value size is 32 bytes, e.g., 01:17:24:45:D9:F4*/
"channelID": ,
/*optional, integer32, No. of alarm triggered channel*/
"dateTime": "",
/*required, string, alarm triggered time (ISO 8601 format), the maximum value size is 32 bytes, e.g.,
2004-05-03T17:30:08+08:00*/
"activePostCount": ,
/*required, integer32, uploaded times of one alarm*/
"eventType": "",
/*required, string, occurred event type, here it should be set to "dockStationExceptionPrompt"; the maximum value
size is 128 bytes*/
"eventState": "",
/*required, string, event status: "active"-occurred, "inactive"-unoccurred (heartbeat data); the maximum value size is
32 bytes*/
"eventDescription": "",

213
Intelligent Security API (Traffic) Developer Guide

/*required, event description, the maximum value size is 128 bytes*/


"deviceID": "",
/*optional, string, device ID, it must be returned during the integration of ISUP SDK*/
"DockStationExceptionPrompt": {
"exception ": ""
/*string, exception status: "diskexception"-HDD exception, "485DIPConflict"-RS-485 dial-up conflicted,
"notEnoughSpace"-memory full*/
}
}

B.18 JSON_EventNotificationAlert_DockStationFileUploadException
Message about uploading exception event to platform from the dock station in JSON format

{
"ipAddress": "",
/*required, string, IPv4 address of alarm device, the maximum length is 32 bytes*/
"ipv6Address": "",
/*optional, IPv6 address of alarm device, the maximum length is 128 bytes*/
"portNo": ,
/*optional, integer32, port No. of the alarm device*/
"protocolType": "",
/*optional, string, protocol type: HTTP or HTTPS, the maximum length is 32 bytes*/
"macAddress": "",
/*optional, string, MAC address, the maximum length is 32 bytes*/
"channelID": ,
/*optional, integer32, No. of the device channel that triggers alarm*/
"dateTime": "",
/*required, string, time of triggering alarm, ISO8601 time format, e.g., 2009-11-14T15:27Z, the maximum length is 32
bytes*/
"activePostCount": ,
/*required, integer32, number of times that an alarm has been uploaded*/
"eventType": "",
/*required, string, event type that triggers the alarm: dockStationFileUploadException-dock station reports exception
event, the maximum length is 128 bytes*/
"eventState": "",
/*required, string, status of event that can triggers alarm: active-alarm is triggered, inactive-alarm is not
triggered(heartbeat data), the maximum length is 32 bytes*/
"eventDescription": "",
/*required, string, event description: DockStationFileUploadException-dock station reports exception event*/
"deviceID": "",
/*optioanl, PUID, which is required for ISUP alarm, e.g., test0123*/
"DockStationFileUploadException": {
/*dock station reports exception event*/
"exceptionType":"",
/*required, string, exception status*/
"stationCode": "",
/*required, string, No. of dock station*/
"recorderCode": "",

214
Intelligent Security API (Traffic) Developer Guide

/*required, string, No, of recorder*/


"mediaName": "",
/*required, string, name of the file*/
"cloudStorageType":,
/*required, int, storage type: 0-cloud storage, 1-CVR, 2-pcnvr2.0*/
"cloudStorageIP":""
/*required, string, cloud storage*/
}
}

B.19 JSON_EventNotificationAlert_DockStationInfo
Message about media information reported by dock station in JSON format

{
"ipAddress": "",
/*required, string, IPv4 address of alarm device, e.g., 172.6.64.7, the maximum length is 32 bytes*/
"ipv6Address": "",
/*optional, string, IPv6 address of alarm device, the maximum length is 128 bytes*/
"portNo": ,
/*optional, integer32, port No. of alarm device*/
"protocol": "",
/*optional, string, protocol type: HTTP or HTTPS, the maximum length is 32 bytes*/
"macAddress": "",
/*optional, string, MAC address, e.g., 01:17:24:45:D9:F4, the maximum length is 32 bytes*/
"channelID": ,
/*optional, integer32, No. of the channel that triggers alarm*/
"dateTime": "",
/*required, string, time of triggering alarm, ISO8601 time format, e.g., 2009-11-14T15:27Z, the maximum length is 32
bytes*/
"activePostCount": ,
/*required, integer32, number of times that an alarm has been uploaded*/
"eventType": "",
/*required, string, event type that triggers the alarm: dockStationInfo-dock station reports information, the maximum
length is 128 bytes*/
"eventState": "",
/*required, string, status of event that can triggers alarm: active-alarm is triggered, inactive-alarm is not
triggered(heartbeat data), the maximum length is 32 bytes*/
"eventDescription": "",
/*required, string, event description:Dock Station Information-dock station reports information*/
"deviceID": "",
/*optional, PUID, e.g., test0123*/
"stationCode": "",
/*optional, string, dock station No.*/
"DockStationInfo": {
/*dock station reports information*/
"mediaName": "",
/*required, string, file name*/
"mediaID": ,

215
Intelligent Security API (Traffic) Developer Guide

/*required, int, file No.*/


"recorderCode": "",
/*required, string, device No., e.g., cq00001*/
"stationCode": "",
/*required, string, dock station No.*/
"takeTime": "",
/*required, time to start recording video, e.g., 2015-05-26T15:12:13+08:00*/
"duration": ,
/*required, float, video length, unit: s*/
"endTime": "",
/*required, time to end recording video, e.g., 2015-05-26T15:12:13+08:00*/
"uploadTime": "",
/*required, time to upload video, e.g., 2015-05-26T6:30:14+08:00*/
"policeCode": "",
/*required, string, policeman No.*/
"mediaSize": ,
/*required, int, file size*/
"mediaType": ,
/*required, int, file type*/
"isLock": ,
/*required, int, file status:0-unlocked, 1-locked）*/
"remark": "",
/*optional, string, remarks*/
"url": "",
/*required, string, URL of uploading video to cloud storage*/
"policeName":"",
/*optional, string, name of policeman, sensitive information should be encrypted*/
"cloudStorageType":,
/*optional,int, storage server type:0-cloud storage, 1-cvr, 2-pstor, which should be consistent with cloudStorageType
in /ISAPI/ContentMgmt/channels/<ID>/cloudStorage/<ID>*/
"thumbnailUrl":"",
/*optional, string, thumbnail picture URL of picture or video*/
"encryption":{
"enabled":true,
/*optional, boolean, whether to encrypt file*/
"encryptionkey":"",
/*optional, string, encryption key, which is returned when enabled is set to true*/
"encryptionLevel":
/*optional, int, encryption level: 1-AES128, 2-AES256, which is returned when enabled is set to true*/
}
}
}

B.20 JSON_EventNotificationAlert_DockStationPoliceInfo
JSON message about policeman information uploaded by dock station
{
"ipAddress":"",
/*required, string, IPv4 address of the alarm device, the maximum size is 32 bytes*/

216
Intelligent Security API (Traffic) Developer Guide

"ipv6Address":"",
/*optional, string, IPv6 address of the alarm device, the maximum size is 128 bytes*/
"portNo": ,
/*optional, integer32, port No. of the alarm device*/
"protocol": "",
/*optional, string, protocol type: "HTTP" or "HTTPS", the maximum size is 32 bytes*/
"macAddress": "",
/*optional, string, MAC address, the maximum size is 32 bytes*/
"channelID": ,
/*optional, integer32, device channel No. that triggers alarm*/
"dateTime": "",
/*required, string, time in ISO8601 time format when the alarm is triggered, the maximum size is 32 bytes*/
"activePostCount": ,
/*required, integer32, times of the same alarm being uploaded*/
"eventType": "",
/*required, string, event type that triggers alarm, the maximum size is 128 bytes. Here it should be set to
"dockStationPoliceInfo" (policeman information uploaded by dock station)*/
"eventState": "",
/*required, string, event status: "active"-triggered, "inactive"-not triggered (heartbeat data), the maximum size is 32
bytes*/
"eventDescription": "",
/*required, string, event description: "Dock Station Information"*/
"deviceID": "",
/*optional, PUID, which should be returned in ISUP alarm*/
"DockStationPoliceInfo": {
/*policeman information uploaded by dock station*/
"policeID": "",
/*required, string*/
"policeCode": "",
/*required, string, policeman ID, should be encrypted to protect sensitive message*/
"policeName": "",
/*required, string, policeman name, should be encrypted to protect sensitive message*/
"deviceID": ""
/*optional, string, device ID, multiple devices should be separated by comma, if it is empty, it indicates all devices*/
}
}
}

B.21 JSON_EventNotificationAlert_DockStationStatusMsg
JSON message about status information of dock station
{
"ipAddress": "",
/*required, string, IPv4 address of alarm device, the maximum value size is 32 bytes, e.g., 172.6.64.7*/
"ipv6Address": "",
/*required, string, IPv6 address of alarm device, the maximum value size is 128 bytes*/
"portNo": ,
/*optional, integer32, port No. of alarm device*/
"protocol": "",

217
Intelligent Security API (Traffic) Developer Guide

/*optional, string, protocol type: "HTTP"-for device network SDK, "HTTPS", "EHome"-for ISUP SDK; the maximum
value size is 32 bytes*/
"macAddress": "",
/*optional, string, MAC address, the maximum value size is 32 bytes, e.g., 01:17:24:45:D9:F4*/
"channelID": ,
/*optional, integer32, No. of alarm triggered channel*/
"dateTime": "",
/*required, string, alarm triggered time (ISO 8601 format), the maximum value size is 32 bytes, e.g.,
2004-05-03T17:30:08+08:00*/
"activePostCount": ,
/*required, integer32, uploaded times of one alarm*/
"eventType": "",
/*required, string, occurred event type, here it should be set to "dockStationExceptionPrompt"; the maximum value
size is 128 bytes*/
"eventState": "",
/*required, string, event status: "active"-occurred, "inactive"-unoccurred (heartbeat data); the maximum value size is
32 bytes*/
"eventDescription": "",
/*required, event description, the maximum value size is 128 bytes*/
"deviceID": "",
/*optional, string, device ID, it must be returned during the integration of ISUP SDK*/
"DockStationstatus":{
/*required, dock station status*/
"networkStatus":"" ,
/*required, string, network connection status of dock station: "disconnected", "connected"*/
"platformConnectionStatus":"" ,
/*required, string, connection status between dock station and platform: "disconnected", "connected"*/
"SlotInfo":[{
/*optional, storage bin information*/
"slotID": ,
/*required, int, storage bin ID*/
"connectionStatus":"",
/*required, string, connection status of body camera: "unconnected", "connected"*/
"BodyCameraInfo": {
/*dependent, body camera information, this node is valid only when ConnectionStatus is "connected"*/
"BasicInfo":{
"deviceNo":"",
/*required, int, body camera ID*/
"personNo":"",
/*required, int, law enforcement person ID*/
"personName":""
/*required, int, law enforcement person name*/
},
"BatteryInfo":{
"Remaining":
/*required, int, current power, which is between 0 and 100*/
},
"isCollecting": ,
/*required, whether it is in collection status*/
"CollectionProgress": {
/*dependent, this node is valid only when isCollecting is true*/
"numberofCollectedFiles": ,

218
Intelligent Security API (Traffic) Developer Guide

/*required, int, number of collected files*/


"numberofAudios": ,
/*required, int, number of audio files to be collected*/
"numberofVideos":,
/*required, int, number of video files to be collected*/
"numberofPictures": ,
/*required, int, number of picture files to be collected*/
"totalNumberofFiles":
/*required, int, total number of files to be collected*/
}
}
}]
}
}

B.22 JSON_EventNotificationAlert_HeartBeat
Message about listening heartbeat in JSON format

{
"ipAddress": "",
/*required, string, IPv4 address of alarm device, the maximum length is 32 bytes*/
"ipv6Address": "",
/*optional, string, IPv6 address of alarm device, the maximum length is 128 bytes*/
"portNo": ,
/*optional, integer32, port No. of the alarm device*/
"protocol": "",
/*optional, string, protocol type: HTTP or HTTPS, the maximum length is 32 bytes*/
"macAddress": "",
/*optional, string, MAC address, the maximum length is 32 bytes*/
"channelID": ,
/*optional, integer32, No. of the device channel that triggers alarm*/
"dateTime": "",
/*required, string, time of triggering alarm, ISO8601 time format, e.g., 2009-11-14T15:27Z, the maximum length is 32
bytes*/
"activePostCount": ,
/*required, integer32, number of times that an alarm has been uploaded*/
"eventType": "",
/*required, string, event type that triggers the alarm: dockStationFileUploadException-dock station reports exception
event, the maximum length is 128 bytes*/
"eventState": "",
/*required, string, status of event that can triggers alarm: active-alarm is triggered, inactive-alarm is not
triggered(heartbeat data), the maximum length is 32 bytes*/
"eventDescription": "",
/*required, string, event description: Dock Station Information-dock station reports information*/
"deviceID": "",
/*optioanl, PUID, which is required for ISUP alarm, e.g., test0123*/
"stationCode": "",

219
Intelligent Security API (Traffic) Developer Guide

/*optional, string, No. of dock station that reports alarm information*/


}

B.23 JSON_EventNotificationAlert_RadarMeasurementDataMsg
The radar measurement data is uploaded in JSON format of EventNotificationAlert message, here
shows an example.
{
"ipAddress":172.6.64.7,
"ipv6Address":"",
"portNo":80,
"protocol":"HTTP",
"macAddress":"01:17:24:45:D9:F4",
"channelID":"1",
"dateTime":"2004-05-03T17:30:08+08:00",
"activePostCount":1,
"eventType":"radarMeasurement ",
"eventState":"active",
"eventDescription":"radarMeasurement ",
/*refer to the message JSON_EventNotificationAlert_Alarm/EventInfo for description details of the above nodes*/
"deviceID":"",
/*optional, string, device ID, it is uploaded by ISUP*/
" radarMeasurement":{
"measurementMode":"simulatedSpeedDetection",
/*required, string, measurement mode: "radiationPatternDetection"-radiation pattern detection,
"simulatedSpeedDetection"-simulated speed detection, "measuredSpeedDetection"-measurement speed detection*/
"speed":100
/*required, integer, speed, unit: km/h*/
}
}

See Also
JSON_EventNotificationAlert_Alarm/EventInfo
Example
Interaction Example of Receiving Radar Measurement Data
Content-Type: multipart/form-data; boundary=MIME_boundary
--MIME_boundary
Content-Type: application/json
Content-Length: 480

{JSON_EventNotificationAlert_RadarMeasurementDataMsg}
--MIME_boundary--

220
Intelligent Security API (Traffic) Developer Guide

B.24 JSON_Filtration
Message about license plate filtration in JSON format
{
"Filtration": {
"enabled":
/*optional, boolean, whether to enable filtering duplicated license plate, by default, it is "false"*/
}
}

B.25 JSON_ImageROI
ImageROI message in JSON format
{
"ImageROI":{
"id":"",
/*req, string type, ID*/
"enabled": ,
/*req, boolean type, whether to enable picture ROI: "true"-yes, "false"-no*/
"mode":"",
/*req, string type, mode: "auto"-algorithm recognizes the region automatically, "manual"-draw the region manually*/
"normalizedScreenSize":{
/*normalized screen size*/
"width": ,
/*req, integer type, normalized width of the screen*/
"height":
/*req, integer type, normalized height of the screen*/
},
"ROIRegionList":[{
/*list of ROI regions*/
"ROIRegion":{
"id": ,
/*req, integer type, region ID, which starts from 1*/
"enabled": ,
/*req, boolean type, whether to enable ROI: "true"-yes, "false"-no*/
"name":"",
/*opt, string type, region name*/
"qualityLevelOfROI": ,
/*req, integer type, quality level, which is between 1 and 6*/
"Region":[{
"x": ,
/*req, float type, X-coordinate, which is between 0 and width*/
"y":
/*req, float type, Y-coordinate, which is between 0 and height*/
}]
}
}]

221
Intelligent Security API (Traffic) Developer Guide

}
}

B.26 JSON_ImageROICap
ImageROICap capability message in JSON format
{
"ImageROICap":{
"ImageROI":{
"id":{
"@size":64
/*req, integer type, maximum length of ID*/
},
"enabled":{
"@opt":"true,false",
},
/*req, boolean type, whether to enable picture ROI*/
"mode":{
"@opt":"auto,manual"
},
/*req, string type, mode: "auto"-algorithm recognizes the region automatically, "manual"-draw the region manually*/
"normalizedScreenSize":{
"width": 1000,
/*req, integer type, normalized width of the screen*/
"height": 1000
/*req, integer type, normalized height of the screen*/
},
"ROIRegionListCap":{
"maxSize":8,
/*req, integer type, maximum number of ROI regions*/
"ROIRegionCap":{
"id":{
/*req, integer type, region ID, which starts from 1*/
"@min": 1,
"@max": 8
},
"enabled":{
/*req, boolean type, whether to enable ROI*/
"@opt": "true,false"
},
"name":{
/*opt, string type, region name*/
"@size":64
},
"qualityLevelOfROI":{
/*req, integer type, quality level, which is between 1 and 6*/
"@min":1,
"@max":6
},

222
Intelligent Security API (Traffic) Developer Guide

"RegionCap":{
"minSize":3,
/*req, integer type, capability of minimum number of the rule area sides*/
"maxSize":10,
/*req, integer type, capability of maximum number of the rule area sides*/
"x":{
/*req, float type, X-coordinate, which is between 0 and width*/
"@min":0,
"@max":1000
},
"y":{
/*req, float type, Y-coordinate, which is between 0 and height*/
"@min": 0,
"@max": 1000
}
}
}
}
}
}
}

B.27 JSON_ImageROIList
ImageROIList message in JSON format
{
"ImageROIList":[{
"ImageROI":{
"id":"",
/*req, string type, ID*/
"enabled":,
/*req, boolean type, whether to enable picture ROI: "true"-yes, "false"-no*/
"mode":"",
/*req, string type, mode: "auto"-algorithm recognizes the region automatically, "manual"-draw the region manually*/
"normalizedScreenSize":{
"width": ,
/*req, integer type, normalized width of the screen*/
"height":
/*req, integer type, normalized height of the screen*/
},
"ROIRegionList":[{
/*This node is valid when mode is "manual"*/
"ROIRegion":{
"id": ,
/*req, integer type, region ID, which starts from 1*/
"enabled":,
/*req, boolean type, whether to enable ROI*/
"name":"",
/*opt, string type, region name*/

223
Intelligent Security API (Traffic) Developer Guide

"qualityLevelOfROI": ,
/*req, integer type, quality level, which is between 1 and 6*/
"Region":[{
"x": ,
/*req, float type, X-coordinate, which is between 0 and width*/
"y":
/*req, float type, Y-coordinate, which is between 0 and height*/
}]
}
}]
}
}]
}

B.28 JSON_Information
Message about transmitting notification to dock station from the platform in JSON format

{
"Information":
{
"infoType":"",
/*required, string, notification types: normalInfo, emergencyInfo*/
"infoContent":""
/*required, string, content of notification*/
}
}

B.29 JSON_LastUpdateTimeList
LastUpdateTimeList message in JSON format.
{
"LastUpdateTimeList": {
/*last updated time list*/
"lastUpdateTime": ["","",""]
/*time format is YYYY-MM-DDThh:mm:ss+(UTC Zone), e.g., 2004-05-03T17:30:08+08:00*/
}
}

B.30 JSON_PersonInfo
JSON message a person's information
{
"PersonInfo":{

224
Intelligent Security API (Traffic) Developer Guide

"id":"",
/*required, string, user No.*/
"name":"",
/*required, string, user name*/
"password":"",
/*optional, string, user password, which should be encrypted and it will not be returned*/
"filePermission": ,
/*required, boolean, whether to assign file search permission*/
"mobile":
/*optional, string, user contacts*/
"filePermissionsuper": ,
/*required, boolean, whether it has the permission of super administrator*/
"collectStatus": ,
/*required, boolean, whether the face data is collected by this person, it is read-only*/
"deviceId":""
/*optional, string, body camera ID*/
}
}

B.31 JSON_PersonInfoList
JSON message about person information list
{
"PersonInfoList":[{
"PersonInfo":{
"id":"",
/*required, string, user No.*/
"name":"",
/*required, string, user name*/
"password":"",
/*optional, string, user password, which should be encrypted and it will not be returned*/
"filePermission": ,
/*required, boolean, whether to assign file search permission*/
"mobile":
/*optional, string, user contacts*/
"filePermissionsuper": ,
/*required, boolean, whether it has the permission of super administrator*/
"collectStatus":
/*required, boolean, whether the face data is collected by this person, it is read-only*/
"deviceId":""
/*optional, string, body camera ID*/
}
}]
}

225
Intelligent Security API (Traffic) Developer Guide

B.32 JSON_PoliceInfo
JSON message about policeman information
{
"PoliceInfo": {
"policeID": "",
/*required*/
"policeCode": "",
/*required, policeman ID, should be encrypted to protect sensitive message*/
"policeName": "",
/*required, policeman name, should be encrypted to protect sensitive message*/
"password": "",
/*optional, password, should be encrypted to protect sensitive message*/
"deviceID": ""
/*optional, device ID*/
}
}

B.33 JSON_PoliceInfoList
JSON message about information list of multiple policemen
{
"PoliceInfoList": [
{
"policeID": "",
/*required, string*/
"policeCode": "",
/*required, string, policeman ID, should be encrypted to protect sensitive message*/
"policeName": "",
/*required, string, policeman name, should be encrypted to protect sensitive message*/
"password": "",
/*optional, string, password, should be encrypted to protect sensitive message*/
"deviceID": ""
/*optional, string, device ID, multiple devices should be separated by comma, if it is empty, it indicates all devices*/
}
]
}

B.34 JSON_PoliceInfoUpload
JSON message about configuration parameters of uploading policeman information from dock
station
{
"PoliceInfoUpload": {

226
Intelligent Security API (Traffic) Developer Guide

"enabled":
}
}

B.35 JSON_PriorityCollection
JSON message about collection priority parameters
{
"PriorityCollection":{
"slotID": ,
/*required, int, storage bin ID*/
"enable":
/*required, boolean, whether to enable the priority collection of this storage bin*/
}
}

B.36 JSON_RadarMeasurement
RadarMeasurement message in JSON format
{
"RadarMeasurement":{
/*required, radar measurement parameters*/
"enabled": ,
/*required, boolean, whether to enable radar measurement: "true"-enter radar measurement mode, "false"-exit
radar measurement mode*/
"measurementMode":""
/*required, string, measurement mode: "radiationPatternDetection"-radiation pattern detection,
"simulatedSpeedDetection"-simulated speed detection, "measuredSpeedDetection"-measurement speed detection*/
}
}

B.37 JSON_ResponseStatus
JSON message about response status
{
"requestURL":"",
/*optional, string, request URL*/
"statusCode": ,
/*required, int, status code*/
"statusString":"",
/*required, string, status description*/
"subStatusCode":"",
/*required, string, sub status code*/
"errorCode": ,

227
Intelligent Security API (Traffic) Developer Guide

/*optional, int, error code, which corresponds to subStatusCode, this field is required when statusCode is not 1. The
returned value is the transformed decimal number*/
"errorMsg":"",
/*optional, string, error details, this field is required when statusCode is not 1*/
}

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

B.38 JSON_ROIRegion
ROIRegion message in JSON format
{
"ROIRegion":{
"id": ,
/*req, integer type, ID, which starts from 1*/
"enabled": ,
/*req, boolean type, whether to enable ROI: "true"-yes, "false"-no*/
"name":"",
/*opt, string type, region name*/
"qualityLevelOfROI": ,
/*req, integer type, quality level, which is between 1 and 6*/
"Region":[{
"x": ,
/*req, float type, X-coordinate, which is between 0 and width*/
"y":
/*req, float type, Y-coordinate, which is between 0 and height*/
}]
}
}

B.39 JSON_ROIRegionList
ROIRegionList message in JSON format
{
"ROIRegionList":[{
"ROIRegion":{
"id": ,
/*req, integer type, ID, which starts from 1*/
"enabled": ,
/*req, boolean type, whether to enable ROI: "true"-yes, "false"-no*/
"name":"",
/*opt, string type, region name*/
"qualityLevelOfROI": ,
/*req, integer type, quality level, which is between 1 and 6*/

228
Intelligent Security API (Traffic) Developer Guide

"Region":[{
"x": ,
/*req, float type, X-coordinate, which is between 0 and width*/
"y":
/*req, float type, Y-coordinate, which is between 0 and height*/
}]
}
}]
}

B.40 JSON_Schedule
JSON message about schedule parameters of uploading files to platform
{
"Schedule":{
"enabled":,
/*required, boolean, whether to enable uploading schedule settings*/
"TimeBlockList":[{
/*optional, only the first group of TimeRange will be used, and the time is only accurate to minute*/
"TimeBlock":{
"dayOfWeek":,
/*required, int, days of the week: 1-Monday, 2-Tuesday, 3-Wednesday, 4-Thursday, 5-Friday, 6-Saturday, 7-Sunday*/
"TimeRange":{
"beginTime":"",
/*required, string，start time of a time period, e.g., "08:30:00"*/
"endTime":""
/*required, string, end time of a time period, e.g., "10:30:00"*/
}
}
}]
}
}

B.41 JSON_ScheduleCap
JSON message about schedule configuration capability of uploading files to platform
{
"ScheduleCap":{
"enabled":{
/*required, whether to enable this capability*/
"opt":"true,false"
},
"TimeBlockList":{
"size": ,
/*number of time periods that can be contained in the schedule*/
"TimeBlock":{
/*days of the week: 1-Monday, 2-Tuesday, 3-Wednesday, 4-Thursday, 5-Friday, 6-Saturday, 7-Sunday*/

229
Intelligent Security API (Traffic) Developer Guide

"dayOfWeek":{
"@opt":"1,2,3,4,5,6,7"
},
"TimeRange":{
"supportBeginTime": ,
/*boolean, whether it supports setting start time: true; this node will not be returned if it is not supported*/
"supportEndTime":
/*boolean, whether it supports setting end time: true; this node will not be returned if it is not supported*/
}
}
}
}
}

Remarks
Setting different time periods for each day in a week is not supported; if different time periods are
configured for each day, only the first group of TimeRange will be used, and the time is only
accurate to minute.

B.42 JSON_TrafficSignal
TrafficSignal message in JSON format
{
"TrafficSignal":{
"messageType":"",
/*req, string, message type: "on"-power on，"changed"-hopping，"heartbeat"*/
"channelState":[{
"state":""
/*req, string, traffic light status: "on", "off"*/
}]
}
}

B.43 JSON_TrafficSignalCap
TrafficSignalCap capability message in JSON format
{
"TrafficSignalCap":{
"messageType":{
"@opt":"on,changed,heartbeat"
/*req, string, message type: "on"-power on, "changed"-hopping, "heartbeat"*/
},
"channelState":{
"@min":1,
"@max":16,
"state":{

230
Intelligent Security API (Traffic) Developer Guide

"@opt":"on,off"
/*req, string, traffic light status: "on", "off"*/
}
}
}
}

B.44 JSON_UpgradeParam
UpgradeParam message in JSON format
{
"UpgradeParam":{
"upgradeType": ""
/*required, string, upgrading type: "radarUpgrade", "systemUpgrade"*/
}
}

B.45 JSON_UpgradeProgress
UpgradeProgress message in JSON format
{
"UpgradeProgress":{
"upgradeType":"",
/*required, string, upgrading type: "radarUpgrade", "systemUpgrade"*/
"UpgradeStatus":{
"status":"",
/*required, string, upgrading status: "upgrading", "failed", "success"*/
"progress":
/*required, int, upgrading progress, it is between 1 and 100*/
}
}
}

B.46 JSON_UserInfo
JSON message about information of storage bin to be controlled
{
"UserInfo":{
"peopleNo":"",
/*required, string, person No.*/
"deviceNo":"",
/*required, string, device No.*/
"id":""
/*required, string, storage bin ID*/

231
Intelligent Security API (Traffic) Developer Guide

}
}

B.47 XML_AlarmHttpPushProtocol
XML message about alarm receiving protocol
<AlarmHttpPushProtocol version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<baseLineProtocolEnabled>
<!--required, xs:boolean, value: true, false-->
</baseLineProtocolEnabled>
</AlarmHttpPushProtocol>

B.48 XML_AlgLog
AlgLog message in XML format.
<AlgLog version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable><!--optional, boolean type, whether to save algorithm logs--></enable>
</AlgLog>

B.49 XML_AlgLogCap
AlgLogCap capability message in XML format.
<AlgLogCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable opt="true,false"><!--required, boolean type, whether to save algorithm logs--></enable>
<DspLogTypeList>
<DspLogType>
<LogType><!--required, string type, log type 1--></LogType>
<LogIndex><!--required, integer type, log No.--></LogIndex>
</DspLogType>
<DspLogType>
<LogType><!--required, string type, log type 2--></LogType>
<LogIndex><!--required, integer type, log No.--></LogIndex>
</DspLogType>
</DspLogTypeList>
</AlgLogCap>

B.50 XML_AlgVersionInfo
AlgVersionInfo message in XML format.
<AlgVersionInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<AlgItemList>

232
Intelligent Security API (Traffic) Developer Guide

<AlgItem>
<id><!--required, string type, algorithm ID--></id>
<algName><!--required, string type, algorithm name--></algName>
<buildDate><!--required, string type, build date--></buildDate>
</AlgItem>
</AlgItemList>
</AlgVersionInfo>

B.51 XML_AnalogStatus
AnalogStatus message in XML format
<AnalogStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Analog min="" max="">
<!--req, xs: integer, analog system status: 0-offline, 1-normal, 2-exception-->
</Analog>
</AnalogStatus>

B.52 XML_AutoContrast
AutoContrast message in XML format
<AutoContrast>
<enable>
<!--req, xs:boolean, whether to enable automatic contrast: "true"-yes, "false"-no-->
</enable>
<level>
<!--req, xs:integer, automatic contrast level, which ranges from 0 to 100, the default value is 50-->
</level>
</AutoContrast>

B.53 XML_BarrierGate
BarrierGate message in XML format
<BarrierGate version="2.0" xmlns="http://www.std-cgi.org/ver20/XMLSchema"><!--barrier gate control-->
<ctrlMode opt="open,close,lock,unlock">
<!--req, xs:string, barrier gate control mode: "open"-open the barrier gate, "close"-close the barrier gate, "lock"-lock
the barrier gate, "unlock"-unlock the barrier gate-->
</ctrlMode>
</BarrierGate>

233
Intelligent Security API (Traffic) Developer Guide

B.54 XML_BarrierGateCtrl
XML message about the control parameters of barrier gate
<BarrierGateCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<barrietGateNum>
<!--opt, xs:integer, barrier gate No., which is between 1 and 2-->
</barrietGateNum>
<BarrierGateCtrlList>
<barrietGateOper>
<!--opt, xs:string, barrier gate control types: "off"-fall, "on"-rise, "stop"-stop at a certain position, "locked"-lock-->
</barrietGateOper>
</BarrierGateCtrlList>
</BarrierGateCtrl>

B.55 XML_BaseParam
BaseParam message in XML format.
<BaseParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<scenesID><!--required, string type, scene ID, which is between 1 and 16--></scenesID>
<isIvtEnable>
<!--required, boolean type, whether to enable law enforcement for illegal parking: 0-no, 1-yes (default)-->
</isIvtEnable>
<isPlateRec>
<!--requried, boolean type, whether to capture the vehicle without license plate: 0-no, 1-yes (default)-->
</isPlateRec>
<isEventDetEnable><!--required, boolean type, whether to enable event alarm--></isEventDetEnable>
<platFilterTime>
<!--required, integer type, filtering time duration of license plate, unit: second, and it is between 600 s and 86400 s--
>
</platFilterTime>
<nSnapOneTimeOut>
<!--required, integer type, enforcement timeout of a picture, which is between 2 and 60, the default value is 20,
unit: second-->
</nSnapOneTimeOut>
<nTskTimeOut>
<!--required, integer type, timeout of enforcement task, which is between 10 and 7200, the default value is 1800,
unit: second-->
</nTskTimeOut>
<nPlateMatchRatio><!--required, integer type, matching rate (%) of license plate, which is between 0 and 100--></
nPlateMatchRatio>
<zoomRectRatio><!--required, float type, zooming rate, which is between 0.1 and 5.0--></zoomRectRatio>
<isLargePlateModEnable>
<!--optional, boolean type, whether to enable displaying the large-scale license plate picture: 0-no (default), 1-yes-->
</isLargePlateModEnable>
</BaseParam>

234
Intelligent Security API (Traffic) Developer Guide

B.56 XML_Device_BasicInfo
XML message about basic information of camera (available for traffic terminal server)
<BasicInfo>
<channelID><!--req, xs: integer, channel ID--></channelID>
<directionNo><!--req, xs: integer, direction No.--></directionNo>
<deviceType><!--opt, xs: integer, device type: 0-video monitoring, 1-loop detection, 2-video analysis, 3-reserved, 4-
video analysis (event + traffic enforcement + traffic data collection), 5-video analysis + capture (event + traffic
enforcement + traffic data collection), 6-video structurization, 7-speed dome for dynamic tracking and capture, 8-
speed dome for non-dynamic tracking and capture--></deviceType>
<detectType><!--opt, xs: string, detection type of video structurization: "motorVehicle,nonmotorVehicle,pedestrian",
multiple types can be set at same time, but each type should be separated by comma--></detectType>
<monitoringSiteID><!--req, xs: string, monitoring point ID--></monitoringSiteID>
<deviceID><!--req, xs: string, camera ID--></deviceID>
<monitorInfo><!--req, xs: string, description of monitoring point--></monitorInfo>
<monitorInfo1><!--opt, xs: string, information of monitoring point 1, the maximum length is 120 bytes--></
monitorInfo1>
<monitorInfo2><!--opt, xs: string, information of monitoring point 2, the maximum length is 40 bytes--></
monitorInfo2>
<monitorInfo3><!--opt, xs: string, information of monitoring point 3, the maximum length is 30 bytes--></
monitorInfo3>
<ptzType><!--opt, xs: integer, PTZ type: 0-no PTZ, 1-network PTZ, 2-RS-485 PTZ--></ptzType>
<ptz485Address><!--opt, xs: integer, address of RS-485 PTZ, which is between 0 and 256--></ptz485Address>
<ptzPTSpeed><!--opt, xs: integer, PTZ control speed, which is between 1 and 10, the default value is 4--></
ptzPTSpeed>
<ptzZoomSpeed><!--opt, xs: integer, zooming speed, which is between 1 and 10, the default value is 4--></
ptzZoomSpeed>
</BasicInfo>

B.57 XML_BlackListScheduleList
BlackListScheduleList message in XML format
<BlackListScheduleList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Schedule/><!--opt, see details in the message of XML_Schedule-->
</BlackListScheduleList>

See Also
XML_Schedule

B.58 XML_BrightEnhance
BrightEnhance message in XML format
<BrightEnhance version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<brightEnhanceEnabled opt="true,false">

235
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:boolean, whether to enable brightness enhancement: "true"-yes, "false"-no-->


</brightEnhanceEnabled>
<brightEnhanceLevel min="0" max="100">
<!--req, xs:integer, brightness enhancement level-->
</brightEnhanceLevel>
</BrightEnhance>

B.59 XML_CapturePicOverlays
CapturePicOverlays message in XML format
<CapturePicOverlays version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<overlayInfoEnabled>
<!--req, xs:boolean, whether to enable text overlay-->
</overlayInfoEnabled>
<OverlayInfoList/><!--req, see details in the message of XML_OverlayInfoList-->
<linePercent>
<!--req, xs:integer, percentage of overlaying lines, which is between 0 and 100 and the default value is 100-->
</linePercent>
<itemsStlye>
<!--req, xs:string, overlay mode: "horizontal" (default), "vertical"-->
</itemsStlye>
<charStyle>
<!--req, xs:string, font type: 0-SimSun (default), 1-Wei-->
</charStyle>
<charSize>
<!--req, xs:integer, character size: 0-16*16(Chinese)/8*16(English), 1-32*32(Chinese)/16*32(English), 2-48*48,
3-64*64(Chinese)/32*64(English)-->
</charSize>
<charPosition>
<!--req, xs:integer, text position overlayed on the picture: 0-overlayed on the picture, 1-overlayed outside the top
edge of the picture, 2-overlayed outside the bottom edge of the picture-->
</charPosition>
<charInterval>
<!--req, xs:integer, character separation distance, which is between 0 and 16 and the default value is 0, unit: pixel-->
</charInterval>
<foreColor>
<!--req, xs:integer, foreground color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0xffffff (white)-->
</foreColor>
<backColor>
<!--req, xs:integer, background color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0x0 (black)-->
</backColor>
<colorAdapt>
<!--dep, xs:boolean, whether to enable color self-adaption: 0-no, 1-yes-->
</colorAdapt>
<zeroizeEnable>
<!--dep, xs:boolean, whether to enable zero filling for OSD overlay, which is used to enable zero filling for vehicle
speed, speed limit, overspeed ratio and lane No. Zero filling is enabled by default-->

236
Intelligent Security API (Traffic) Developer Guide

</zeroizeEnable>
<platePicOverlay>
<!--dep, xs:boolean, whether to enable overlaying license plate thumbnail-->
</platePicOverlay>
<platePicPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture height, and the default value is 0-->
</platePicPosTop>
<platePicPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture width, and the default value is 0-->
</platePicPosLeft>
<posPercentMode>
<!--opt, xs:boolean, whether to enable percentage mode instead of pixel value mode: "true"-yes, "false"-no-->
</posPercentMode>
<startPosTopPercent>
<!--dep, xs:integer, this node is valid when <posPercentMode> is "true"-->
</startPosTopPercent>
<startPosLeftPercent>
<!--dep, xs:integer, this node is valid when <posPercentMode> is "true"-->
</startPosLeftPercent>
<itemsSpacesNumMode>
<!--opt, xs:boolean-->
</itemsSpacesNumMode>
<itemsSpacesNum>
<!--opt, xs:integer, number of spaces-->
</itemsSpacesNum>
</CapturePicOverlays>

See Also
XML_OverlayInfoList

B.60 XML_CapResolution
CapResolution message in XML format
<CapResolution version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<capResolutionWidth>
<!--opt, xs:integer, resolution width of the captured picture, which is selected from options of the obtained
resolution-->
</capResolutionWidth>
<capResolutionHeight>
<!--opt, xs:integer, resolution height of the captured picture, which is selected from options of the obtained
resolution-->
</capResolutionHeight>
</CapResolution>

237
Intelligent Security API (Traffic) Developer Guide

B.61 XML_Cap_AutoContrast
AutoContrast capability message in XML format
<AutoContrast>
<enable>
<!--req, xs:boolean, whether to enable automatic contrast: "true"-yes, "false"-no-->
</enable>
<level min="0" max="100" def="50">
<!--req, xs:integer, automatic contrast level, which ranges from 0 to 100, the default value is 50-->
</level>
</AutoContrast>

B.62 XML_Cap_CapResInfo
CapResInfo capability message in XML format
<CapResInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<capResolutionWidth>
<!--req, xs:integer, resolution width of the captured picture, which is selected from options of the obtained
resolution-->
</capResolutionWidth>
<capResolutionHeight>
<!--req, xs:integer, resolution height of the captured picture, which is selected from options of the obtained
resolution-->
</capResolutionHeight>
</CapResInfo>

B.63 XML_Cap_CapturePicOverlays
CapturePicOverlays capability message in XML format
<CapturePicOverlays version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<overlayInfoEnabled>
<!--req, xs:boolean, whether to enable text overlay-->
</overlayInfoEnabled>
<OverlayInfoList size="50"><!--req-->
<OverlayInfo><!--req-->
<itemType opt="0,1,2,3,…">
<!--req, xs:string, overlayed information type: 0-unknown, 1-place, 2-intersection No., 3-device No., 4-direction
No., 5-direction, 6-lane No., 7-lane, 8-capture time (without millisecond), 9-capture time (with millisecond), 10-license
plate number, 11-vehicle color, 12-vehicle type, 13-vehicle brand, 14-vehicle speed, 15-speed limit sign, 16-vehicle
length (between 1 and 99 meters), 17-violation code (traffic violation information is more useful than code, e.g.,
normal, low speed, overspeed, reverse driving, running the red light, occupying lane, driving over yellow lane line,
etc.), 18-camera information, 19-traffic violation, 20-overspeed ratio, 21-red light start time, 22-red light end time, 23-
red light time, 24-security code, 25-capture No., 26-seatbelt, 27-reserved, 28-sun visor, 29-lane direction, 30-license
plate color, 31-scene No., 32-scene name, 33-yellow label vehicle detection, 34-dangerous goods transport vehicle

238
Intelligent Security API (Traffic) Developer Guide

detection, 35-vehicle sub-brand detection, 36-vehicle direction, 37-window hangings, 38-making a call, 39-confidence,
40-verification unit, 41-verification certificate No., 42-calibration expiration date, 43-longitude and latitude, 44-tissue
box detection, 45-baby in arm detection, 46-label detection, 47-decoration detection, 48-face score, 49-face No., 50-
violation description, 51-marked speed limit, 52-segment speed, 53-segment distance, 54-segment overspeed ratio,
55-segment name, 56-segment ID, 57-traffic accident detection, 58-smoking, 59-wearing helmet, 60-manned, 61-
congestion-->
</itemType>
<editAble opt="true,false">
<!--req, xs:boolean, whether the overlayed information is editable-->
</editAble>
<itemOverlayEnabled opt="true,false">
<!--req, xs:boolean, whether to overlay the item-->
</itemOverlayEnabled>
<customName min="0" max="32">
<!--req, xs:string, custom overlaying name, the maximum length is 32 bytes (including '\0'). If this node is set to
none or NULL, the default name will be overlayed-->
</customName>
<changeLineNum min="0" max="100">
<!--req, xs:integer, number of line feeds, which is between 0 and 100 and the default value is 0-->
</changeLineNum>
<spaceNum min="0" max="255">
<!--req, xs:integer, number of spaces, which is between 0 and 255 and the default value is 0-->
</spaceNum>
<startPosEnable opt="true,false">
<!--dep, xs:boolean, whether to enable coordinate configuration, which is only valid for overlaying within the
picture. After enabling coordinate configuration, the function of line feed and space will be invalid, so you are
recommended to disable coordinate configuration-->
</startPosEnable>
<startPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture height, and the default value is 0-->
</startPosTop>
<startPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture width, and the default value is 0-->
</startPosLeft>
<overlayInfoText>
<!--dep, xs:string, overlay character string, which is valid when <itemType> is set to place, intersection No., device
No., direction No., direction description, lane information and camera. The maximum string length of place is 128
bytes, the maximum string length of intersection No., device No., direction No., direction description and lane
information is 32 bytes., the maximum string length of camera 1 is 44 bytes, and the maximum string length of
verification unit, verification certificate No., calibration expiration date is 128 bytes-->
</overlayInfoText>
<overlayInfoText2>
<!--dep, xs:string, overlay character string for camera 2, which is valid when <itemType> is set to camera, and the
maximum string length of camera 2 is 32 bytes-->
</overlayInfoText2>
</OverlayInfo>
</OverlayInfoList>
<linePercent min="0" max="100">
<!--req, xs:integer, percentage of overlaying lines, which is between 0 and 100 and the default value is 100-->
</linePercent>

239
Intelligent Security API (Traffic) Developer Guide

<itemsStlye opt="horizontal,vertical">
<!--req, xs:string, overlay mode: "horizontal" (default), "vertical"-->
</itemsStlye>
<charStyle>
<!--req, xs:string, font type-->
</charStyle>
<charSize min="0" max="3">
<!--req, xs:integer, character size: 0-16*16(Chinese)/8*16(English), 1-32*32(Chinese)/16*32(English), 2-48*48,
3-64*64(Chinese)/32*64(English)-->
</charSize>
<charPosition min="0" max="2">
<!--req, xs:integer, text position overlayed on the picture: 0-overlayed on the picture, 1-overlayed outside the top
edge of the picture, 2-overlayed outside the bottom edge of the picture-->
</charPosition>
<charInterval min="0" max="16">
<!--req, xs:integer, character separation distance, which is between 0 and 16 and the default value is 0, unit: pixel-->
</charInterval>
<foreColor min="0" max=" 0xffffff">
<!--req, xs:integer, foreground color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0xffffff (white)-->
</foreColor>
<backColor min="0" max=" 0xffffff">
<!--req, xs:integer, background color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0x0 (black)-->
</backColor>
<colorAdapt>
<!--dep, xs:boolean, whether to enable color self-adaption: 0-no, 1-yes-->
</colorAdapt>
<zeroizeEnable opt="true,false">
<!--dep, xs:boolean, whether to enable zero filling for OSD overlay, which is used to enable zero filling for vehicle
speed, speed limit, overspeed ratio and lane No. Zero filling is enabled by default-->
</zeroizeEnable>
<platePicOverlay>
<!--dep, xs:boolean, whether to enable overlaying license plate thumbnail-->
</platePicOverlay>
<platePicPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture height, and the default value is 0-->
</platePicPosTop>
<platePicPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture width, and the default value is 0-->
</platePicPosLeft>
<posPercentMode opt="true,false">
<!--opt, xs:boolean, whether to enable percentage mode instead of pixel value mode: "true"-yes, "false"-no-->
</posPercentMode>
<startPosTopPercent min="0" max="100">
<!--dep, xs:integer, this node is valid when <posPercentMode> is "true"-->
</startPosTopPercent>
<startPosLeftPercent min="0" max="100">
<!--dep, xs:integer, this node is valid when <posPercentMode> is "true"-->
</startPosLeftPercent>

240
Intelligent Security API (Traffic) Developer Guide

<itemsSpacesNumMode opt="true,false">
<!--opt, xs:boolean-->
</itemsSpacesNumMode>
<itemsSpacesNum>
<!--opt, xs:integer, number of spaces-->
</itemsSpacesNum>
</CapturePicOverlays>

B.64 XML_Cap_CarFeatureParam
CarFeatureParam capability message in XML format
<CarFeatureParam xmlns="urn:psialliance-org" version="1.0">
<isSupportCarColor>
<!--dep, xs:boolean, whether to support vehicle color recognition-->
</isSupportCarColor>
<isSupportCarLogo>
<!--dep, xs:boolean, whether to support vehicle logo recognition-->
</isSupportCarLogo>
<isSupportSafeBelt>
<!--dep, xs:boolean, whether to support safety belt detection-->
</isSupportSafeBelt>
<isSupportSunVisor>
<!--dep, xs:boolean, whether to support sun visor detection-->
</isSupportSunVisor>
<isSupportEnvprosign>
<!--dep, xs:boolean, whether to support yellow label vehicle detection-->
</isSupportEnvprosign>
<isSupportDangmark>
<!--dep, xs:boolean, whether to support dangerous goods transport vehicle detection-->
</isSupportDangmark>
<isSupportFaceDetect>
<!--req, xs:boolean, whether to enable face picture matting-->
</isSupportFaceDetect>
<isSupportUphone>
<!--dep, xs:boolean, whether to support phone call detection-->
</isSupportUphone>
<isSupportPendant>
<!--dep, xs:boolean, whether to support window hangings detection-->
</isSupportPendant>
<isSupportPilotFace>
<!--req, xs:boolean, whether to support driver's face picture matting-->
</isSupportPilotFace>
<isSupportCopilotFace>
<!--req, xs:boolean, whether to support front passenger's face picture matting-->
</isSupportCopilotFace>
<isSupportNonmotorface>
<!--opt, xs:boolean, whether to support non-motor vehicle user's face picture matting-->
</isSupportNonmotorface>
<faceImgScale min="1" max="3">

241
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:integer, face close-up picture zooming ratio-->


</faceImgScale>
<faceImgRatio min="1" max="3">
<!--req, xs:integer, face close-up picture cutting ratio-->
</faceImgRatio>
<faceImgOutput opt="none, overPic, alarmUpload">
<!--dep, xs:string, face close-up picture output-->
</faceImgOutput>
<isSupportDrawFaceRect>
<!--dep, xs:boolean, whether to support drawing frame on the face close-up picture-->
</isSupportDrawFaceRect>
<isSupportFaceImgBrightenEnhence>
<!--dep, xs:boolean, whether to support face close-up picture brightness enhancement-->
</isSupportFaceImgBrightenEnhence>
<faceImgBrightenEnhenceLevel min="0" max="100">
<!--req, xs:integer, face close-up picture brightness enhancement level-->
</faceImgBrightenEnhenceLevel>
<tissueBoxEnable>
<!--opt, xs:boolean, whether to support enabling tissue box detection-->
</tissueBoxEnable>
<frontChildEnable>
<!--opt, xs:boolean, whether to support enabling baby in arm detection-->
</frontChildEnable>
<labelEnable>
<!--opt, xs:boolean, whether to support enabling label detection-->
</labelEnable>
<decorationEnable>
<!--opt, xs:boolean, whether to support enabling decoration detection-->
</decorationEnable>
<safeBeltSensitivity min="1" max="100">
<!--dep, xs:integer, safety belt detection sensitivity, which ranges from 1 to 100-->
</safeBeltSensitivity>
<uphoneSensitivity min="1" max="100">
<!--dep, xs:integer, phone call detection sensitivity, which ranges from 1 to 100-->
</uphoneSensitivity>
<pendantSensitivity min="1" max="100">
<!--dep, xs:integer, window hangings detection sensitivity, which ranges from 1 to 100-->
</pendantSensitivity>
<isSupportSmoking opt="true, false">
<!--opt, xs:boolean, whether to support smoking detection-->
</isSupportSmoking>
<isSupportPerfumeBox opt="true, false">
<!--opt, xs:boolean, whether to support perfume box detection-->
</isSupportPerfumeBox>
<isSupportHelmet opt="true, false">
<!--opt, xs:boolean, whether to support helmet detection-->
</isSupportHelmet>
<isSupportTwoWheelVehicle opt="true, false">
<!--opt, xs:boolean, whether to support manned two wheeler detection-->
</isSupportTwoWheelVehicle>
<isSupportThreeWheelVehicle opt="true, false">
<!--opt, xs:boolean, whether to support manned tricycle detection-->

242
Intelligent Security API (Traffic) Developer Guide

</isSupportThreeWheelVehicle>
<nonMotorEnabled opt="true, false">
<!--opt, xs:boolean, whether to enable non-motor vehicle detection-->
</nonMotorEnabled>
<nonMotorFaceSnap opt="true, false">
<!--opt, xs:boolean, whether to enable non-motor vehicle user's face picture matting-->
</nonMotorFaceSnap>
</CarFeatureParam>

B.65 XML_Cap_CloudStorage
XML message about access capability of cloud storage
<CloudStorage version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:string--></id>
<enabled><!--required, xs:boolean--></enabled>
<addressingFormatType opt="ipaddress,hostname"><!--required, xs:string, address type: "ipaddress", "hostname"--
></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port min="" max=""><!--required, xs:integer, port No.--></port>
<username><!--dependent, xs:string, user name--></username>
<password><!--dependent, xs:string, password--></password>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
<cloudStorageType opt="0,1,2"><!--optional, xs:integer, 0-cloud storage (default), 1-CVR, 2-pcnvr2.0; if this node is
empty, it is the cloud storage by default--></cloudStorageType>
<V2.0>
<enabled><!--required, xs:integer, whether to enable--></enabled>
<addressingFormatType opt="ipaddress,hostname"><!--required, xs:string, address type: "ipaddress,hostname"--></
addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port min="" max=""><!--required, xs:integer, port No.--></port>
<isSupportAccessKey><!--optional, xs:boolean, whether it supports access key configuration; AccessKey is the cloud
storage access key generated by cloud storage management system, and it corresponds to the resource pool user,--></
isSupportAccessKey>
<isSupportSecretKey><!--optional, xs:boolean, whether it supports secret key configuration; SecretKey is the cloud
storage protocol encryption key generated by cloud storage management system, and it corresponds to the resource
pool user--></isSupportSecretKey>
<postPoolID min="0" max="4294967295"><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>

243
Intelligent Security API (Traffic) Developer Guide

<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>


<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
<accessKeyLen min="1" max="64"><!--dependent, access key length, it is valid only when the value of
isSupportAccessKey "true"--></accessKeyLen>
<secretKeyLen min="1" max="64"><!--dependent, secret key length, it is valid only when the value of
isSupportSecretKey "true"--></secretKeyLen>
<resourceID min="0" max="32"><!--optional, xs:string, resource pool ID--></resourceID>
</V2.0>
<ImageAndVideoCloud>
<enabled> <!--required, xs:boolean, whether to enable--> </enabled>
<addressingFormatType opt="ipaddress,hostname"><!--required, xs:string, address type: "ipaddress", "hostname"--
></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<isSupportAccessKey><!--optional, xs:boolean, whether it supports access key configuration; AccessKey is the cloud
storage access key generated by cloud storage management system, and it corresponds to the resource pool user,--></
isSupportAccessKey>
<isSupportSecretKey><!--optional, xs:boolean, whether it supports secret key configuration; SecretKey is the cloud
storage protocol encryption key generated by cloud storage management system, and it corresponds to the resource
pool user--></isSupportSecretKey>
<postPoolID min="0" max="4294967295"><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
<accessKeyLen min="1" max="64"><!--dependent, access key length, it is valid only when the value of
isSupportAccessKey "true"--></accessKeyLen>
<secretKeyLen min="1" max="64"><!--dependent, secret key length, it is valid only when the value of
isSupportSecretKey "true"--></secretKeyLen>
</ImageAndVideoCloud>
<protocolType opt="V1.0,V2.0,Image and Video Cloud"> <!--required, xs:string, cloud storage protocol type: "V1.0",
"V2.0", "Image and Video Cloud"--></protocolType>
<isSupportCloudStorageServerParam><!--optional, xs:boolean, whether it supports getting the parameters of cloud
storage server--></isSupportCloudStorageServerParam>
<bucketName><!--optional, xs:string, bucket name of cloud storage --></bucketName>
</CloudStorage>

B.66 XML_Cap_ContinueCapCmd
ContinueCapCmd capability message in XML format
<ContinueCapCmd xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<capEnable>
<!--opt, xs:boolean, whether to enable continuous capture: "true,false"-->
</capEnable>
<snapTimes>
<!--req, xs:integer, capture times, which ranges from 0 to 5, the default value is 0-->
</snapTimes>

244
Intelligent Security API (Traffic) Developer Guide

<relatedDriveWay>
<!--req, xs:integer, linked lane No., which ranges from 0 to 99, the default value is 1-->
</relatedDriveWay>
<waitTime>
<!--req, xs:integer, continuous capture waiting time, which ranges from 0 to 2000, unit: millisecond-->
</waitTime>
<IntervalList>
<!--req-->
<Interval>
<!--req-->
<value>
<!--req, xs:integer, continuous capture interval, which ranges from 0 to 10000, unit: millisecond-->
</value>
</Interval>
</IntervalList>
<snapVehicleNum>
<!--opt, xs:integer, captured vehicle No.-->
</snapVehicleNum>
</ContinueCapCmd>

B.67 XML_Cap_DarkEnhance
DarkEnhance capability message in XML format
<DarkEnhance version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<darkEnhanceEnabled>
<!--req, xs:boolean, whether to enable dark space enhancement-->
</darkEnhanceEnabled>
<darkEnhanceLevel min="0" max="100">
<!--dep, xs:integer, dark space enhancement level, which ranges from 0 to 100-->
</darkEnhanceLevel>
</DarkEnhance>

B.68 XML_Cap_DeviceInfo
DeviceInfo capability message in XML format
<DeviceInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<deviceName min="" max=""><!--req, xs:string, device name--></deviceName>
<DockStation>
<!--opt, dock station configuration-->
<Platform>
<!--opt, platform configuration-->
<type opt="none, 9533, 8618, ISAPI"><!--req, xs:string, platform type--></type>
<ip><!--opt, xs:string, IP address --></ip>
<port><!--opt, xs:integer, communication port--></port>
<userName><!--req, xs:string, user name, which is used for the dock station to log in to platform--></userName>
<password><!--req, xs:string, password, which is used for the dock station to log in to platform, it should be
encrypted--></password>

245
Intelligent Security API (Traffic) Developer Guide

</Platform>
<centralStorageBackupEnabled opt="true, false"><!--opt, xs:boolean, whether to enable central storage backup--></
centralStorageBackupEnabled>
</DockStation>
<languageType opt="chinese,english,spanish,portuguese,italian,french,russian,german,polish"/><!--opt, xs:string-->
<deviceID min="0" max="128"><!--ro, req, xs:string, uuid--></deviceID>
<deviceDescription min="0" max="16"><!--opt, xs:string--></deviceDescription>
<deviceLocation opt="STD-CGI, hangzhou"><!--opt, xs:string--></deviceLocation>
<systemContact opt="STD-CGI, Hikvision.China"><!--opt, req, xs:string--></systemContact>
<model min="0" max="64"><!--ro, req, xs:string--></model>
<serialNumber min="0" max="48"><!--ro, req, xs:string--></serialNumber>
<macAddress min="0" max="64"><!--ro, req, xs:string--></macAddress>
<firmwareVersion min="0" max="64"><!--ro, req, xs:string--></firmwareVersion>
<firmwareReleasedDate min="0" max="64"><!--ro, opt, xs:string--></firmwareReleasedDate>
<bootVersion min="0" max="16"><!--ro, opt, xs:string--></bootVersion>
<bootReleasedDate min="0" max="16"><!--ro, opt, xs:string--></bootReleasedDate>
<hardwareVersion min="0" max="16"><!--ro, opt, xs:string--></hardwareVersion>
<encoderVersion min="0" max="64"><!--ro, opt, xs:string--></encoderVersion>
<encoderReleasedDate min="0" max="64"><!--ro, opt, xs:stirng--></encoderReleasedDate>
<decoderVersion min="0" max="64"><!--ro, opt, xs:string--></decoderVersion>
<decoderReleasedDate min="0" max="64"><!--ro, opt, xs:stirng--></decoderReleasedDate>
<deviceType opt="IPCamera, IPDome, DVR, HybirdNVR, NVR, DVS, IPZoom"><!--ro, req, xs:string--></deviceType>
<telecontrolID min="1" max="255"><!--opt, xs:integer, "1-255"--></telecontrolID>
<supportBeep><!--opt, xs:boolean: "true,false"--></supportBeep>
<firmwareVersionInfo><!--ro, opt, xs:stirng--></firmwareVersionInfo>
<subChannelEnabled><!--opt, xs:boolean: "true,false"--></subChannelEnabled>
<thrChannelEnabled><!--opt, xs:boolean: "true,false"--></thrChannelEnabled>
<actualFloorNum><!--req, xs:integer, "1-128"--></actualFloorNum>
<radarVersion><!--opt, xs:string, radar version--></radarVersion>
<powerOnMode opt="button,adapter" def="button"><!--optional, xs:string, device startup mode: "button"-press
button to power on (default), "adapter"-connect adapter to power on--></powerOnMode>
<webVersion><!--optional, read-only, xs:string, web version No., it is the current value by default--></webVersion>
<deviceRFProgramVersion><!--optional, read-only, xs:string, version No. of the device's RF (Radio Frequency)
program, it is the current value by default--></deviceRFProgramVersion>
<securityModuleSerialNo><!--optional, read-only, xs:string, serial No. of the security module, it is the current value
by default--></securityModuleSerialNo>
<securityModuleVersion><!--optional, read-only, xs:string, version No. of the security module, it is the current value
by default--></securityModuleVersion>
<securityChipVersion><!--optional, read-only, xs:string, version No. of the security chip, it is the current value by
default--></securityChipVersion>
<securityModuleKeyVersion><!--optional, read-only, xs:string, version No. of the security module key, it is the current
value by default--></securityModuleKeyVersion>
<UIDLampRecognition><!--optional, information of the UID lamp recognition device-->
<enabled opt="true,false"><!--optional, xs:boolean, whether to enable--></enabled>
</UIDLampRecognition>
<bootTime><!--optional, xs:string, read-only, system boot time, ISO 8601 format; the maximum length is 32 bytes--
></bootTime>
<isSupportNewVersionDevlanguageSwitch><!--optional, xs:boolean, whether it supports switching language by new
version of the protocol, related URI: /ISAPI/System/DeviceLanguage/capabilities. If the device does not return this
node, it does not indicate that the device does not support switching language by new version of the protocol, and
whether the device supports this function is determined by the obtained capability--></

246
Intelligent Security API (Traffic) Developer Guide

isSupportNewVersionDevlanguageSwitch>
</DeviceInfo>

B.69 XML_Cap_entranceParam
entranceParam capability message in XML format
<entranceParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<laneNum>
<!--opt, xs:integer-->
</laneNum>
<isSupportBEnable>
<!--opt, xs:boolean-->
</isSupportBEnable>
<ctrlMode opt="0, 1">
<!--opt, xs:integer-->
</ctrlMode>
<relateTriggerMode opt="0, 1, 2">
<!--opt, xs:integer-->
</relateTriggerMode>
<isSupportPlateNumColor>
<!--opt, xs:boolean-->
</isSupportPlateNumColor>
<isSupportPlateNumOnly>
<!--opt, xs:boolean-->
</isSupportPlateNumOnly>
<vehInfoManag opt="0, 1, 2">
<!--opt, xs:integer-->
</vehInfoManag>
<barrierGateOper opt="0, 1">
<!--opt, xs:integer-->
</barrierGateOper>
<isSupportRelayOutAlarm>
<!--opt, xs:boolean-->
</isSupportRelayOutAlarm>
<isSupportUpAlarm>
<!--opt, xs:boolean-->
</isSupportUpAlarm>
<isSupportHostUpAlarm>
<!--opt, xs:boolean-->
</isSupportHostUpAlarm>
<relayNum min="1" max="5">
<!--opt, xs:integer-->
</relayNum>
<relayFunction min="0" max="5">
<!--opt, xs:integer-->
</relayFunction>
<relayFunctionIndex opt="0, 1, 2, 3, 4, 5">
<!--opt, xs:string-->
</relayFunctionIndex>

247
Intelligent Security API (Traffic) Developer Guide

<IOAlarmNum opt="1, 2">


<!--opt, xs:integer-->
</IOAlarmNum>
<IOAlarmType opt="0, 1">
<!--opt, xs:integer-->
</IOAlarmType>
<notCloseCarFollow>
<!--opt, xs:boolean, whether to enable the barrier gate not to close when the vehicle is followed by another vehicle--
>
</notCloseCarFollow>
<bigCarKeepOpen>
<!--opt, the barrier gate remains open when the large-sized vehicle passes-->
<enabled opt="true, false">
<!--req, xs:boolean, whether to enable the barrier gate to remain open when the large-sized vehicle passes-->
</enabled>
<duration min="0" max="1000">
<!--req, xs:integer, duration of the barrier gate remaining open-->
</duration>
</bigCarKeepOpen>
</entranceParam>

B.70 XML_Cap_FocusConfiguration
FocusConfiguration capability message in XML format
<FocusConfiguration>
<focusStyle opt="AUTO,MANUAL,SEMIAUTOMATIC"><!--req, xs:string--></focusStyle>
<focusLimited opt="50,100,300,600,1000,2000,5000,10000,15000" def="1000"><!--opt, xs:integer--></focusLimited>
<focusPosition/><!--dep, xs:integer, depends on FocusStyle-->
<focusSpeed><!--opt, xs:intger--></focusSpeed>
<focusSensitivity min="0" max="2" def="1"><!--optional, xs:intger, sensitivity of focus, ranging from 0 to 2. It is valid
when the focus mode is automatic or semi-automatic--></focusSensitivity>
<temperatureChangeAdaptEnabled opt="true,false"--><!--optional, xs:boolean--></
temperatureChangeAdaptEnabled>
<relativeFocusPos min="0" max="4000" def=""><!--optional, xs:intger--></relativeFocusPos>
<highTemperaturePriority opt="true,false"><!--optional, xs:boolean, enable high temperature priority mode--></
highTemperaturePriority>
<focusStatus opt="success,failed,working"><!--optional, xs:string, focus status: success, failed, working (focusing)--></
focusStatus>
<motorMovementType opt="manual,auto,armingLocation"><!--optional, xs:string, motor movement type: manual,
auto (automatic), armingLocation (arming location)--></motorMovementType>
</FocusConfiguration>

B.71 XML_Cap_GrayRange
GrayRange capability message in XML format
<GrayRange>
<grayValueType opt="hightContrast, moreDetail">

248
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:string, grayscale value type: "hightContrast"-high contrast with less details in the dark space (grayscale
range: [0, 255]), "moreDetail"-low contrast with more details in the dark space (grayscale range: [16, 235])-->
</grayValueType>
</GrayRange>

B.72 XML_Cap_Hdr
Hdr capability message in XML format
<Hdr version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<hdrMode opt="close","realHdr, digitalHdr">
<!--req, xs:string, WDR (Wide Dynamic Range) mode: "close", "realHdr"-WDR, "digitalHdr"-digital WDR. WDR mode
will be displayed according to the capability, and <HdrSwitch> and <HdrLevel> are invalid when this node is set to
"close"-->
</hdrMode>
<HdrSwitch>
<hdrSwitchMode opt="open,timeCtrl,lightCtrl">
<!--req, xs:string, WDR switching mode: "open", "timeCtrl"-enable by time, "lightCtrl"-enable by brightness.
<timeSwitch> nad <lightSwitch> are invalid when this node is set to "open"-->
</hdrSwitchMode>
<timeSwitch>
<!--req, this node is valid only when <hdrSwitchMode> is "timeCtrl"-->
<startHour min="0" max="23">
<!--dep, xs:integer, start hour, which ranges from 0 to 23-->
</startHour>
<startMinute min="0" max="59">
<!--dep, xs:integer, start minute, which ranges from 0 to 59-->
</startMinute>
<endHour min="0" max="23">
<!--dep, xs:integer, end hour, which ranges from 0 to 23-->
</endHour>
<endMinute min="0" max="59">
<!--dep, xs:integer, end minute, which ranges from 0 to 59-->
</endMinute>
</timeSwitch>
</HdrSwitch>
<hdrLevel opt="level1,level2,level3,level4,level5,level6,level7">
<!--dep, xs:string, WDR level, this node depends on <HdrSwitchMode>-->
</hdrLevel>
</Hdr>

B.73 XML_Cap_HVTVehicleDetectCfg
Capability message about mixed traffic detection in XML format
<?xml version="1.0" encoding="utf-8"?>
<HVTVehicleDetectCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--required, xs:boolean--></enabled>
<stateOrProvinceName opt=""><!--optional, xs:string--></stateOrProvinceName>

249
Intelligent Security API (Traffic) Developer Guide

<HVTVehicleDetectSceneList size="5">
<HVTVehicleDetectScene><!--list-->
<id><!--required, xs:integer--></id>
<sceneName min="" max=""><!--optional, xs:string--></sceneName>
<enabled><!--required, xs:boolean--></enabled>
<PlateRecogParam>
<PlateRecogRegionList size="5">
<PlateRecogRegion><!--list-->
<id><!--required, xs:string--></id>
<RegionCoordinatesList size="5">
<RegionCoordinates><!--list-->
<positionX><!--required, xs:integer, X-coordinate--></positionX>
<positionY><!--required, xs:integer, Y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</PlateRecogRegion>
</PlateRecogRegionList>
</PlateRecogParam>
<LaneConfig>
<LaneList size="5">
<Lane><!--list-->
<laneId min="" max=""><!--required, xs:integer--></laneId>
<RegionCoordinatesList size="5"><!--required-->
<RegionCoordinates><!--list-->
<positionX><!--required, xs:integer--></positionX>
<positionY><!--required, xs:integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
<lineType opt="laneBoundaryLine,laneLine"><!--optional, xs:string, lane line type, "laneBoundaryLine"-lane
boundary line, "laneLine"-lane line--></lineType>
<carDriveDirect opt="unknow,up_to_down,down_to_up"><!--optional, xs:string, vehicle driving direction--></
carDriveDirect>
</Lane>
</LaneList>
</LaneConfig>
</HVTVehicleDetectScene>
</HVTVehicleDetectSceneList>
<AtRoadsideCalib><!--optional, -->
<RegionCoordinatesList size="5">
<RegionCoordinates><!--list-->
<positionX><!--required, xs:integer, X-coordinate--></positionX>
<positionY><!--required, xs:integer, Y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</AtRoadsideCalib>
<AboveRoadCalib><!--optional-->
<RegionCoordinatesList>
<RegionCoordinates><!--required, list-->
<positionX><!--required, xs:integer, X-coordinate--></positionX>
<positionY><!--required, xs:integer, Y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>

250
Intelligent Security API (Traffic) Developer Guide

</AboveRoadCalib>
<nation opt="EU,ER,EUandCIS,ME,All"><!--optional, xs:string, region, "ER"-CIS Region, "EU"-Europe Region, "ME"-
Middle East, "All"-All Region--></nation>
<countryIndex opt="1,2,3,4,5,6,7,8,12,14,17,18,19,20,23,39,44,55"><!--optional, xs:integer, country/region No.--></
countryIndex>
<!--compatibility between countryIndex and CRIndex-->
<!--device: both fields will be returned, when the value of CRIndex is smaller than or equal to 255, the value of
countryIndex is the same as that of CRIndex; when the value of CRIndex is larger than 255, the value of countryIndex
is 253 (the field countryIndex is invalid)-->
<!--integration flow: for new users, CRIndex has higher priority over countryIndex and the field countryIndex is used
only when countryIndex does not exist; when the value of countryIndex is 253, additional logic processing should be
adopted to use CRIndex field-->
<CRIndex
opt="0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,28,29,30,31,33,34,35,36,37,38,39,40,42,43,
44,45,46,47,49,51,53,55,59,60,62,65,68,70,71,72,73,76,77,84,87,89,90,94,95,91,104,107,108,110,114,115,130,137,13
9,140,144,145,146,151,156,157,169,174,175,177,180,181,188,206,210,215,216,217,218,219,220,221,222,227,228,25
6">
<!--optional, xs:integer, country/region No., when the value is 0, it indicates that no country/region is specified-->
</CRIndex>
</HVTVehicleDetectCfg>

B.74 XML_Cap_IllegalDictionary
XML message about capability of traffic violation dictionary
<IllegalDictionary version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<IllegalCodeList>
<!--required-->
<IllegalCodeItem>
<!--required-->
<idx min="0" max="64">
<!--required, xs:integer-->
</idx>
<illegalCode min="0" max="64">
<!--required, xs:integer, illegal action code-->
</illegalCode>
<illegalName min="0" max="128">
<!--required, xs:string, illegal action name-->
</illegalName>
<illegalStringCode min="" max=""><!--optional, xs:string, illegal action code (string)--></illegalStringCode>
<illegalCodeLetterNum min="" max=""><!--optional, xs:integer, supported number of letters in illegal action code--
></illegalCodeLetterNum>
<illegalDescription size="256"><!--optional, xs:string, illegal action description--></illegalDescription>
</IllegalCodeItem>
</IllegalCodeList>
<isSupportReset opt="true,false">
<!--optional, xs: boolean, whether supports restoring to default settings, if not supports, this node will not be
returned-->
</isSupportReset>
</IllegalDictionary>

251
Intelligent Security API (Traffic) Developer Guide

B.75 XML_Cap_ImageChannel
XML message about image channel capability
<ImageChannel version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs:integer--></id>
<enabled><!--req, xs:boolean--></enabled>
<videoInputID><!--req, xs:integer--></videoInputID>
<FocusConfiguration/><!--opt, refer to the message XML_Cap_FocusConfiguration for details-->
<LensInitialization/><!--opt-->
<ImageFlip/><!--opt-->
<ImageFreeze/><!--opt-->
<proportionalpan/><!--opt-->
<WDR>
<mode opt="close,open,auto"><!--req, xs: string, WDR mode: "open,close,auto"--></mode>
<WDRLevel max="100" min="0"><!--opt, xs: integer--></WDRLevel>
<WDRContrastLevel max="" min="0"><!--opt, xs:integer--></WDRContrastLevel>
< WDRLevel1 max="" min="0"><!--opt,xs:integer-->< /WDRLevel1>
</WDR>
<BLC/><!--opt-->
<NoiseReduce/><!--opt-->
<ImageEnhancement/><!--opt-->
<SlowShutter/><!--opt-->
<DSS/><!--opt-->
<WhiteBlance/><!--opt-->
<Exposure/><!--opt, exposure configuration parameters, refer to the message XML_Exposure for details-->
<DayNightGate/><!--opt-->
<BrightEnhance/><!--opt-->
<Sharpness>
<SharpnessLevel max="100" min="0"><!--req, xs:integer--></SharpnessLevel>
</Sharpness>
<gammaCorrection/><!--opt-->
<powerLineFrequency/><!--opt-->
<Color><!--opt, image adjustment capability-->
<brightnessLevel max="100" min="0"><!--opt, xs:integer, brightness--></brightnessLevel>
<contrastLevel max="100" min="0"><!--opt,xs:integer, contrast--></contrastLevel>
<saturationLevel max="100" min="0"><!--opt, xs:integer, saturation--></saturationLevel>
<grayScale>
<grayScaleMode opt="outdoor,indoor"><!--opt,xs:string, gray scale mode: "indoor,outdoor"--></grayScaleMode>
</grayScale>
</Color>
<IrcutFilter/><!--opt, configuration parameters of day/night auto-switch, refer to the message XML_IrcutFilter for
details-->
<Scene/><!--opt-->
<EPTZ/ ><!--opt-->
<EIS/><!--opt-->
<HLC/> <!--opt-->
<ZoomLimit/> <!--opt-->
<corridor/><!--opt-->
<Dehaze/><!--opt-->
<ImageMode opt="standard, indoor, outdoor, dimLight"/><!--opt, xs:string-->

252
Intelligent Security API (Traffic) Developer Guide

<enableImageLossDetection><!--opt, boolean--></enableImageLossDetection>
<CaptureMode/><!--opt-->
<IrLight/><!--opt-->
<LensDistortionCorrection/><!--opt-->
<SupplementLight/><!--opt, supplement light configuration capability, refer to the message
XML_Cap_SupplementLight for details-->
<OpticalDehaze/><!--opt-->
<ManualRanging/><!--opt-->
<OIS/><!--opt-->
<isSupportlaserSpotManual><!--opt, boolean--></isSupportlaserSpotManual>
<isSupportLaserSpotAdjustment><!--opt, boolean--></isSupportLaserSpotAdjustment>
<DigitalZoom>
<ZoomRatio opt="1x,2x,4x,8x,16x,32x"><!--req, xs:string---></ZoomRatio>
</DigitalZoom>
<Palettes>
<mode
opt="WhiteHot,BlackHot,Fusion1,Rainbow,Fusion2,Ironbow1,Ironbow2,Sepia,Color1,Color2,IceFire,Rain,RedHot,Green
Hot,DeepBlue,Color3"><!--
opt,xs:string,"WhiteHot,BlackHot,Fusion1,Rainbow,Fusion2,Ironbow1,Ironbow2,Sepia,Color1,Color2,IceFire,Rain,RedH
ot,GreenHot,DeepBlue,Color3"--></mode>
<ColorateTarget><!--dep,mode="WhiteHot","target coloration"-->
<ColorateTargetModeList>
<ColorateTargetMode><!--list-->
<id><!--req,xs:integer "index,which starts from 1"--></id>
<mode opt="colorateHotAreae,colorateIntervalArea,colorateColdArea"><!--
req,xs:string,"colorateHotAreae,colorateIntervalArea,colorateColdArea"--></mode>
<enabled opt="true,false"><!--req,xs:boolean,"true,false"--></enabled>
<TemperatureLimit><!--req "temperature range"-->
<minTemperature><!--dep <mode> is colorateHotAreae/colorateIntervalArea,xs:float--></minTemperature>
<maxTemperature><!--dep <mode> is colorateColdArea/colorateIntervalArea,xs:float--></maxTemperature>
</TemperatureLimit>
<Color><!--req,"area color"-->
<R><!--req,xs:integer--></R>
<G><!--req,xs:integer--></G>
<B><!--req,xs:integer--></B>
</Color>
</ColorateTargetMode>
</ColorateTargetModeList>
</ColorateTarget>
<supportColorateTargetMode opt="WhiteHot,BlackHot"><!--opt,xs:string, palette modes that support target
coloration--></supportColorateTargetMode>
</Palettes>
<ExposureSync opt="true,false" def="false">
<enabled><!--req, xs:boolean--></enabled>
</ExposureSync>
<BrightnessSuddenChangeSuppressionCap/><!--opt-->
<isSupportIcr><!--opt, boolean--></isSupportIcr>
<isSupportMultishut><!--opt, boolean--></isSupportMultishut>
<isSupportPlateBright><!--opt, boolean--></isSupportPlateBright>
<isSupportJPEGParam><!--opt, boolean--></isSupportJPEGParam>
<isSupportDarkEnhance><!--opt, boolean--></isSupportDarkEnhance>
<isSupportHdr><!--opt, boolean--></isSupportHdr>

253
Intelligent Security API (Traffic) Developer Guide

<isSupportLse><!--opt, boolean--></isSupportLse>
<isSupportMce><!--opt, boolean--></isSupportMce>
<isSupportScve><!--opt, boolean--></isSupportScve>
<isSupportSectionCtrl><!--opt, boolean--></isSupportSectionCtrl>
<isSupportAutoContrast><!--opt, boolean--></isSupportAutoContrast>
<isSupportGrayRange><!--opt, boolean--></isSupportGrayRange>
<isSupportLSEDetail><!--opt, boolean--></isSupportLSEDetail>
<isSupportCapture><!--opt, boolean--></isSupportCapture>
<isSupportBrightEnhance><!--opt, boolean--></isSupportBrightEnhance>
<isSupportRecord><!--opt, xs:boolean--></isSupportRecord>
<isSupportDefog><!--opt, xs:boolean--></isSupportDefog>
<isSupportGeneral><!--opt, xs:boolean, whether to display general configuration page on the interface--></
isSupportGeneral>
<isSupportIa><!--opt, xs:boolean, whether to display video configuration page on the interface--></isSupportIa>
<NoiseReduce2D>
<noiseReduce2DEnable><!--req, xs:boolean--></noiseReduce2DEnable>
<noiseReduce2DLevel min="0" max="100"><!--dep,xs:integer--></noiseReduce2DLevel>
</NoiseReduce2D>
<Shutter>
<ShutterLevel min="100" max="40000"><!--req, xs:integer--></ShutterLevel>
</Shutter>
<Gain>
<GainLevel min="0" max="100"><!--req, xs:integer--></GainLevel>
</Gain>
<TempRange/><!--opt, temperature range capability, see XML_Cap_tempRange for details-->
</ImageChannel>

Remarks
The nodes <DigitalZoom> and <ExposureSync> are not supported by thermographic automation
thermal camera (DS-2TA03-15SVI, DS2TA06-25SVI).

B.76 XML_Cap_ImageIcrE
ImageIcrE capability message in XML format
<ImageIcrE xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0"><!--ICR configuration parameters, which
will be displayed according to the capability-->
<ICRCtrl><!--IR-cut filter-->
<ICRCtrlMode opt="close,manual,time,auto">
<!--req, xs:string, "close", "manual"-manually switch, "time"-switch by schedule, "auto"-automatically switch-->
</ICRCtrlMode>
<ManualMode>
<!--manually switch-->
<ManualPresetVal opt="day,night">
<!--req, xs:string, manually switch: "day", "night"-->
</ManualPresetVal>
</ManualMode>
<TimeMode>
<!--switch by schedule-->
<SwitchList size="2">

254
Intelligent Security API (Traffic) Developer Guide

<!--schedule list for switching, up to two time period control can be supported. For example: time period is from
6:00 to 18:00, the preset ID is 1-->
<Preset>
<!--req-->
<PresetId min="0" max="1">
<!--req, xs:integer, preset ID, which ranges from 0 to 1-->
</PresetId>
<PresetVal opt="day,night">
<!--dep, xs:string, "day", "night"-->
</PresetVal>
</Preset>
<TimeSwitch>
<!--req, time period-->
<timeId min="0" max="1">
<!--req, xs:integer, time period ID, which ranges from 0 to 1-->
</timeId>
<startHour min="0" max="23">
<!--dep, xs:integer, start hour, which ranges from 0 to 23-->
</startHour>
<startMinute min="0" max="59">
<!--dep, xs:integer, start minute, which ranges from 0 to 59-->
</startMinute>
<endHour min="0" max="23">
<!--dep, xs:integer, end hour, which ranges from 0 to 23-->
</endHour>
<endMinute min="0" max="59">
<!--dep, xs:integer, end minute, which ranges from 0 to 59-->
</endMinute>
</TimeSwitch>
</SwitchList>
</TimeMode>
<AutoMode>
<!--automatically switch according to the light change-->
<DayNightFilterTh min="0" max="100">
<!--req, xs:integer, day/night auto switch sensitivity, which ranges from 0 to 100-->
</DayNightFilterTh>
<ICRAutoSwitch min="0" max="100">
<!--dep, xs:integer, ICR auto-switch and threshold, which ranges from 0 to 100-->
</ICRAutoSwitch>
</AutoMode>
</ICRCtrl>
<ECtrl>
<!---E device, halo inhibition filter, which can be used to inhibit the halo-->
<ECtrlMode opt="close,manual,time,auto">
<!--req, xs:string, "close", "manual"-manually switch, "time"-switch by schedule, "auto"-automatically switch-->
</ECtrlMode>
<ManualMode>
<!--manually switch-->
<ManualPresetVal min="0" max="100">
<!--req, xs:integer-->
</ManualPresetVal>
</ManualMode>

255
Intelligent Security API (Traffic) Developer Guide

<TimeMode>
<!--switch by schedule-->
<SwitchList size="2">
<Preset>
<!--req, preset-->
<PresetId min="0" max="1">
<!--req, xs:integer-->
</PresetId>
<PresetVal min="0" max="100">
<!--dep, xs:integer-->
</PresetVal>
</Preset>
<TimeSwitch>
<!--req, time period-->
<timeId min="0" max="1">
<!--req, xs:integer, time period ID, which ranges from 0 to 1-->
</timeId>
<startHour min="0" max="23">
<!--dep, xs:integer, start hour, which ranges from 0 to 23-->
</startHour>
<startMinute min="0" max="59">
<!--dep, xs:integer, start minute, which ranges from 0 to 59-->
</startMinute>
<endHour min="0" max="23">
<!--dep, xs:integer, end hour, which ranges from 0 to 23-->
</endHour>
<endMinute min="0" max="59">
<!--dep, xs:integer, end minute, which ranges from 0 to 59-->
</endMinute>
</TimeSwitch>
</SwitchList>
</TimeMode>
<AutoMode>
<DayNightFilterTh min="0" max="100">
<!--req, xs:integer, "0-100"-->
</DayNightFilterTh>
<ExceptionCatchTh min="0" max="100">
<!--req, xs:integer, "0-100"-->
</ExceptionCatchTh>
</AutoMode>
</ECtrl>
</ImageIcrE>

B.77 XML_Cap_ImageMultishut
ImageMultishut capability message in XML format
<ImageMultishut version="2.0"xmlns="http://www.isapi.org/ver20/XMLSchema">
<doubleShutEnable>
<!--req, xs:boolean, whether to support dual-shutter-->

256
Intelligent Security API (Traffic) Developer Guide

</doubleShutEnable>
<codecType opt=" all_ia, all_record">
<!--req, xs:string, "all_ia"-algorithm stream, "all_record"-recording stream-->
</codecType>
</ImageMultishut >

B.78 XML_Cap_ITCSetUp
ITCSetUp capability message in XML format
<ITCSetUp xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<focusType opt="unknow,8mm,12mm,16mm,25mm,35mm,50mm">
<!--req, xs:string-->
</focusType>
<setUpHeight min="0" max="2000">
<!--req, xs:integer, "0-2000"-->
</setUpHeight>
<sceneDis min="0" max="6000">
<!--req, xs:integer, "0-6000"-->
</sceneDis>
<horizontalField min="0" max="360">
<!--req, xs:integer, "0-360"-->
</horizontalField>
<verticalField min="0" max="360">
<!--req, xs:integer, "0-360"-->
</verticalField>
<autoGetGps>
<!--req, xs:boolean, "true,false"-->
</autoGetGps>
<longitude min="0" max="16">
<!--req, xs:string-->
</longitude>
<latitude min="0" max="16">
<!--req, xs:string-->
</latitude>
<setupHeightUnit min="0" max="1">
<!--req, xs:integer, "0-1"-->
</setupHeightUnit>
<videoDetCoefficient min="0" max="360">
<!--req, xs:integer, "0-360"-->
</videoDetCoefficient>
</ITCSetUp>

B.79 XML_Cap_JPEGParam
JPEGParam capability message in XML format
<JPEGParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<JPEGSize min=" 64" max=" 8196">

257
Intelligent Security API (Traffic) Developer Guide

<!--dep, xs:integer, JPEG picture size, which ranges from 64 to 8196, unit: KB-->
</JPEGSize>
</JPEGParam>

B.80 XML_Cap_LEDConfiguration
LEDConfiguration capability message in XML format
<LEDConfiguration version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<!--LED screen display parameters-->
<information min="0" max="512">
<!--req, xs:string, LED screen display content-->
</information>
<displayMode opt="left,right,immediate">
<!--req, xs:string, display mode: "left"-move left, "right"-move right, "immediate"-display immediately-->
</displayMode>
<speedType opt="fast,medium,slow">
<!--req, xs:string, speed type: "fast", "medium", "slow"-->
</speedType>
<showTime min="1" max="60">
<!--req, xs:integer, display duration, which is between 1 and 60, unit: second-->
</showTime>
<showPlate>
<!--opt, xs:boolean, display license plate-->
</showPlate>
<ledCount min="" max="">
<!--opt, xs:integer, number of LED screens. An LED screen is a logic unit which can be controlled independently, the
default value is 1, and the LED screen ID ranges from the minimum value to the maximum value-->
</ledCount>
<fontSize min="" max="">
<!--opt, xs:integer, font size-->
</fontSize>
<fontColor min="0" max="">
<!--opt, xs:integer, RGB value of the font color-->
</fontColor>
</LEDConfiguration>

B.81 XML_Cap_LSE
LSE capability message in XML format
<LSE version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<lseLevel min="0" max="100">
<!--dep, xs:integer, contrast enhancement level, which ranges from 0 to 100, the default value is 50-->
</lseLevel>
<lseHaloLevel min="0" max="100">
<!--dep, xs:integer, halo inhibition level, which ranges from 0 to 100-->
</lseHaloLevel>
<switchMode opt="open,timeCtrl,lightCtrl">

258
Intelligent Security API (Traffic) Developer Guide

<!--opt, xs:string, contrast enhancement switching mode: "open", "timeCtrl"-enable by time, "lightCtrl"-enable by
brightness-->
</switchMode>
<timeSwitch>
<!--dep, switching time, this node is valid only when <switchMode> is "timeCtrl"-->
<startTime>
<!--opt, xs:time, start time, ISO8601 time-->
</startTime>
<endTime>
<!--opt, xs:time, end time, ISO8601 time-->
</endTime>
</timeSwitch>
<lightLevel min="0" max="100">
<!--dep, xs:integer, brightness level, this node is valid only when <switchMode> is "lightCtrl"-->
</lightLevel>
</LSE>

B.82 XML_Cap_LSEDetail
LSEDetail capability message in XML format
<LSEDetail version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled>
<!--req, xs:boolean, whether to enable DDE (Digital Detail Enhancement)-->
</enabled>
<LSEDetailLevel min="0" max="100">
<!--dep, xs:integer, DDE (Digital Detail Enhancement) level, which ranges from 0 to 100, the default value is 50-->
</lseLevel>
</LSEDetail>

B.83 XML_Cap_MCE
MCE capability message in XML format
<MCE version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled>
<!--req, xs:boolean, whether to enable memory color enhancement-->
</enabled>
<mceLevel min="0" max="100" def ="50">
<!--dep, xs:integer, memory color enhancement level, which ranges from 0 to 100, the default value is 50-->
</mceLevel>
</MCE>

B.84 XML_Cap_MergePicOverlays
MergePicOverlays capability message in XML format

259
Intelligent Security API (Traffic) Developer Guide

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


<overlayInfoEnabled>
<!--req, xs:boolean, whether to enable text overlay-->
</overlayInfoEnabled>
<OverlayInfoList size="50">
<!--req-->
<OverlayInfo>
<!--req-->
<itemType opt="0,1,2,3,…">
<!--req, xs:string, overlayed information type: 0-unknown, 1-place, 2-intersection No., 3-device No., 4-direction
No., 5-direction, 6-lane No., 7-lane, 8-capture time (without millisecond), 9-capture time (with millisecond), 10-license
plate number, 11-vehicle color, 12-vehicle type, 13-vehicle brand, 14-vehicle speed, 15-speed limit sign, 16-vehicle
length (between 1 and 99 meters), 17-violation code (traffic violation information is more useful than code, e.g.,
normal, low speed, overspeed, reverse driving, running the red light, occupying lane, driving over yellow lane line,
etc.), 18-camera information, 19-traffic violation, 20-overspeed ratio, 21-red light start time, 22-red light end time, 23-
red light time, 24-security code, 25-capture No., 26-seatbelt, 27-reserved, 28-sun visor, 29-lane direction, 30-license
plate color, 31-scene No., 32-scene name, 33-yellow label vehicle detection, 34-dangerous goods transport vehicle
detection, 35-vehicle sub-brand detection, 36-vehicle direction, 37-window hangings, 38-making a call, 39-confidence,
40-verification unit, 41-verification certificate No., 42-calibration expiration date, 43-longitude and latitude, 44-tissue
box detection, 45-baby in arm detection, 46-label detection, 47-decoration detection, 48-face score, 49-face No., 50-
violation description, 51-marked speed limit, 52-segment speed, 53-segment distance, 54-segment overspeed ratio,
55-segment name, 56-segment ID, 57-traffic accident detection, 58-smoking, 59-wearing helmet, 60-manned, 61-
congestion-->
</itemType>
<editAble opt="true,false">
<!--req, xs:boolean, whether the overlayed information is editable-->
</editAble>
<itemOverlayEnabled opt="true,false">
<!--req, xs:boolean, whether to overlay the item-->
</itemOverlayEnabled>
<customName min="0" max="32">
<!--req, xs:string, custom overlaying name, the maximum length is 32 bytes (including ’\0’). If this node is set to
none or NULL, the default name will be overlayed-->
</customName>
<changeLineNum min="0" max="100">
<!--req, xs:integer, number of line feeds, which is between 0 and 100 and the default value is 0-->
</changeLineNum>
<spaceNum min="0" max="255">
<!--req, xs:integer, number of spaces, which is between 0 and 255 and the default value is 0-->
</spaceNum>
<startPosEnable opt="true,false">
<!--dep, xs:boolean, whether to enable coordinate configuration, which is only valid for overlaying within the
picture. After enabling coordinate configuration, the function of line feed and space will be invalid, so you are
recommended to disable coordinate configuration-->
</startPosEnable>
<startPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture height, and the default value is 0-->
</startPosTop>
<startPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between
0 and the actual picture width, and the default value is 0-->

260
Intelligent Security API (Traffic) Developer Guide

</startPosLeft>
<overlayInfoText>
<!--dep, xs:string, overlay character string, which is valid when <itemType> is set to place, intersection No., device
No., direction No., direction description, lane information and camera. The maximum string length of place is 128
bytes, the maximum string length of intersection No., device No., direction No., direction description and lane
information is 32 bytes., the maximum string length of camera 1 is 44 bytes, and the maximum string length of
verification unit, verification certificate No., calibration expiration date is 128 bytes-->
</overlayInfoText>
<overlayInfoText2>
<!--dep, xs:string, overlay character string for camera 2, which is valid when <itemType> is set to camera, and the
maximum string length of camera 2 is 32 bytes-->
</overlayInfoText2>
</OverlayInfo>
</OverlayInfoList>
<linePercent min="0" max="100">
<!--req, xs:integer, percentage of overlaying lines, which is between 0 and 100 and the default value is 100-->
</linePercent>
<itemsStlye opt=" horizontal,vertical">
<!--req, xs:string, overlay mode: "horizontal" (default), "vertical"-->
</itemsStlye>
<charStyle>
<!--req, xs:string, font type-->
</charStyle>
<charSize min="0" max="3">
<!--req, xs:integer, character size: 0-16*16(Chinese)/8*16(English), 1-32*32(Chinese)/16*32(English), 2-48*48,
3-64*64(Chinese)/32*64(English)-->
</charSize>
<charPosition min="0" max="2">
<!--req, xs:integer, text position overlayed on the picture: 0-overlayed on the picture, 1-overlayed outside the top
edge of the picture, 2-overlayed outside the bottom edge of the picture-->
</charPosition>
<charInterval min="0" max="16">
<!--req, xs:integer, character separation distance, which is between 0 and 16 and the default value is 0, unit: pixel-->
</charInterval>
<foreColor min="0" max=" 0xffffff">
<!--req, xs:integer, foreground color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0xffffff (white)-->
</foreColor>
<backColor min="0" max=" 0xffffff">
<!--req, xs:integer, background color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0x0 (black)-->
</backColor>
<colorAdapt>
<!--dep, xs:boolean, whether to enable color self-adaption: 0-no, 1-yes-->
</colorAdapt>
<zeroizeEnable opt="true,false">
<!--dep, xs:boolean, whether to enable zero filling for OSD overlay, which is used to enable zero filling for vehicle
speed, speed limit, overspeed ratio and lane No. Zero filling is enabled by default-->
</zeroizeEnable>
<platePicOverlay>
<!--dep, xs:boolean, whether to enable overlaying license plate thumbnail-->
</platePicOverlay>

261
Intelligent Security API (Traffic) Developer Guide

<platePicPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture height, and the default value is 0-->
</platePicPosTop>
<platePicPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture width, and the default value is 0-->
</platePicPosLeft>
</MergePicOverlays>

B.85 XML_Cap_PicParam
PicParam capability message in XML format
<PicParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<PictureCfg>
<mode opt="quality,size">
<!--req,xs:string-->
</mode>
<pictureQuality min="1" max="100">
<!--dep, xs:integer, picture quality, it is between 1 and 100. This node is required when <mode> is "quality"-->
</pictureQuality>
<pictureSize>
<!--dep, xs:integer, picture size, unit:kb. This node is required when <mode> is "size"-->
</pictureSize>
</PictureCfg>
<Overlap><!--OSD quick configuration, it is valid for captured pictures and combined pictures simultaneously. The
priority of <Overlap> is lower than that of <CapturePicOverlays> and <MergePicOverlays>-->
<enabled>
<!--req, xs:boolean-->
</enabled>
<OverlapItem
opt="positionNo,positionInfo,cameraNo,captureTime,plateNo,vehicleColor,sceneName,carType,vehicleLogo,sceneNo"
>
<!--req, xs:string-->
</OverlapItem>
<fontColor>
<!--opt, xs:hexBinary, foreground color-->
</fontColor>
<backColor>
<!--opt, xs:hexBinary, background color-->
</backColor>
</Overlap>
<CapturePicOverlays><!--opt, professional OSD configuration for captured pictures, currently this configuration is
only supported by capture cameras--></CapturePicOverlays>
<MergePicOverlays><!--opt, professional OSD configuration for combined pictures, currently this configuration is only
supported by capture cameras--></MergePicOverlays>
<PlateEnhancement><!--opt, license plate enhancement on captured picture-->
<enabled opt="true,false" def="false"><!--opt, xs:boolean, whether to enable license plate enhancement on
captured picture, by default, it is set to false--></enabled>

262
Intelligent Security API (Traffic) Developer Guide

<level min="0" max="100" def="50"><!--opt, xs:integer, license plate enhancement level range: [0,100], by default:
50--></level>
</PlateEnhancement>
</PicParam>

See Also
XML_Cap_CapturePicOverlays
XML_Cap_MergePicOverlays

B.86 XML_Cap_PlateBright
PlateBright capability message in XML format
<PlateBright version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<plateBrightEnabled>
<!--req, xs:boolean, whether to enable license plate brightness compensation-->
</plateBrightEnabled>
<plateBrightSensitivity min="0" max="100">
<!--dep, xs:integer, license plate brightness compensation sensitivity, which ranges from 1 to 100-->
</plateBrightSensitivity>
<correctFactorEnabled>
<!--req, xs:boolean, whether to enable supplement light correction factor-->
</correctFactorEnabled>
<correctFactor min="0" max="100">
<!--dep, xs:integer, supplement light correction factor, which ranges from 0 to 100-->
</correctFactor>
</PlateBright>

B.87 XML_Cap_PlateRecognition
PlateRecognition capability message in XML format
<PlateRecognition version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<triggerMode
opt="postIOSpeed,postSingleIO,postRS485,postRadar,postVTCoil,postHVT,postMpr,epoliceRS485,postEpoliceRS485,vid
eoEpolice,postBOT">
<!--req, xs:string-->
</triggerMode>
<backupType opt="0,1">
<!--req, xs:integer-->
</backupType>
<plateRecogEnabled opt="true,false">
<!--dep, xs:boolean-->
</plateRecogEnabled>
<regionMode opt="rectangle,polygon">
<!--req, xs:string, "rectangle,polygon"-->
</regionMode>
<plateRegionCount min="1" max="6">

263
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:integer-->
</plateRegionCount>
</PlateRecognition>

B.88 XML_Cap_PlateRecognitionParam
PlateRecognitionParam capability message in XML format
<PlateRecognitionParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<isSupportdefaultCHN>
<!--req, xs:string, whether to support province/state abbreviation-->
</isSupportdefaultCHN>
<isSupportfrontPlateReco>
<!--opt, xs:boolean, whether to support front license plate recognition-->
</isSupportfrontPlateReco>
<isSupportrearPlateReco>
<!--opt, xs:boolean, whether to support rear license plate recognition-->
</isSupportrearPlateReco>
<isSupportsmallPlateReco>
<!--opt, xs:boolean, whether to support small license plate recognition-->
</isSupportsmallPlateReco>
<isSupportlargePlateReco>
<!--opt, xs:boolean, whether to support large license plate recognition-->
</isSupportlargePlateReco>
<isSupportfarmVehicle>
<!--opt, xs:boolean, whether to support agricultural vehicle recognition-->
</isSupportfarmVehicle>
<isSupportmotor>
<!--opt, xs:boolean, whether to support motorcycle recognition-->
</isSupportmotor>
<isSupportfuzzyDisc>
<!--opt, xs:boolean, whether to support fuzzy recognition-->
</isSupportfuzzyDisc>
<isSupportmicroPlateReg>
<!--opt, xs:boolean, whether to support tiny license plate recognition-->
</isSupportmicroPlateReg>
<isSupportcAPlateRegEnabled>
<!--opt, xs:boolean, whether to support civil aviation license plate recognition-->
</isSupportcAPlateRegEnabled>
<isSupporttiltPlateRegEnabled>
<!--opt, xs:boolean, whether to support tilted license plate recognition-->
</isSupporttiltPlateRegEnabled>
<isSupportsuperPlateRecoEnabled>
<!--opt, xs:boolean, whether to support oversized license plate recognition-->
</isSupportsuperPlateRecoEnabled>
<isSupportEmbassyPlateRecoEnabled>
<!-- opt, xs: boolean, whether to support embassy license plate recognition-->
</isSupportEmbassyPlateRecoEnabled>
</PlateRecognitionParam>

264
Intelligent Security API (Traffic) Developer Guide

B.89 XML_Cap_PostHVT
PostHVT capability message in XML format
<PostHVT version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<intervalType opt="time,distance">
<!--req, xs: string, interval type of continuous capture-->
</intervalType>
<interval min="0" max="65535">
<!--req, xs: integer, interval of continuous capture-->
</interval>
<post><!--req, xs: boolean, whether to enable checkpoint trigger mode--></post>
<postCapNo opt="1,2,3" def="2">
<!--dep, xs:integer, number of continuously captured pictures, capture 1 to 2 pictures in strobe mode, and capture 1
to 3 pictures in flash and mixture mode-->
</postCapNo>
<driveLine><!--req, xs: boolean, whether to enable the trigger mode of driving on lane line--></driveLine>
<driveLineCapNo opt="1,2,3" def="2">
<!--dep, xs:integer, number of continuously captured pictures in which the driving on lane line happened, capture 2
pictures in strobe mode, and capture 2 to 3 pictures in flash and mixture mode-->
</driveLineCapNo>
<reverse><!--req, xs: boolean, whether to enable wrong-way driving trigger mode--></reverse>
<reverseCapNo opt="1,2,3" def="2">
<!--dep, xs: integer, number of continuously captured pictures, capture 2 pictures in strobe mode, and capture 2 to
3 pictures in flash and mixture mode-->
</reverseCapNo>
<banSign><!--req, xs: boolean, whether to enable ban breaking trigger mode--></banSign>
<banSignCapNo opt="1,2,3" def="2">
<!--dep, xs: integer, number of continuously captured pictures in which the ban is broken, capture 2 pictures in
strobe mode, and capture 2 to 3 pictures in flash and mixture mode-->
</banSignCapNo>
<overSpeed><!--req, xs: boolean, whether to enable overspeed trigger mode--></overSpeed>
<overSpeedCapNo opt="1,2,3" def="2">
<!--dep, xs: integer, number of continuously captured pictures, capture 2 pictures in strobe mode, and capture 2 to
3 pictures in flash and mixture mode-->
</overSpeedCapNo>
<lowSpeed><!--req, xs: boolean, whether to enable low speed trigger mode--></lowSpeed>
<lowSpeedCapNo opt="1,2,3" def="2">
<!--dep, xs: integer, number of continuously captured pictures, capture 2 pictures in strobe mode, and capture 2 to
3 pictures in flash and mixture mode-->
</lowSpeedCapNo>
<highBeam><!--opt, xs: boolean, whether to enable high beam trigger mode--></highBeam>
<highBeamCapNo min="2" max="3">
<!--opt, xs: integer, number of captured picture, which is between 2 and 3-->
</highBeamCapNo>
<highBeamConfidence min="0" max="100"><!--opt, xs: integer, confidence in high beam trigger mode--></
highBeamConfidence>
<changeLane><!--opt, xs: boolean, whether to enable illegal lane change trigger mode--></changeLane>
<changeLaneCapNo min="2" max="3">
<!--opt, xs: integer, number of captured pictures, which is between 2 and 3-->
</changeLaneCapNo>

265
Intelligent Security API (Traffic) Developer Guide

<sceneMode opt="urban,ectrance,highway"><!--req, xs:string, scene mode--></sceneMode>


<snapType opt="mixObject,motor,nonmotor"><!--req, xs: string, captured object type--></snapType>
<capMode opt="videoFrame,capFrame,mixFrame"><!--req, xs:string, capture mode--></capMode>
<detectMode opt="video,coilLoop"><!--req, xs: string, detection mode--></detectMode>
<speedDetector opt="non,radarSpeed,videoSpeed"><!--req, xs: string, speed detection mode--></speedDetector>
<relatedLaneCount min="1" max="16"><!--req, xs: integer, number of linked lanes--></relatedLaneCount>
<laneNO min="1" max="99"><!--req, xs: integer, lane No. displayed on the picture--></laneNO>
<relatedDriveWay min="1" max="99"><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<laneUsage opt="carriageway,busway,banTrunks"><!--req, xs: string, lane usage--></laneUsage>
<laneType opt="non,highway,urbanFastWay,other">
<!--req, xs:string, lane type, "none"-not configured, "highway"-high way, "urbanFastWay"-urban
expressway,"other"-->
</laneType>
<carDriveDirect opt="up2down,down2up"><!--req, xs: string, vehicle driving direction--></carDriveDirect>
<signSpeed min="0" max="255"><!--req, xs: integer, marked speed limit--></signSpeed>
<speedLimit min="0" max="255"><!--req, xs: integer, maximum speed limit--></speedLimit>
<lowSpeedLimit min="0" max="255"><!--req, xs: integer, minimum speed limit--></lowSpeedLimit>
<bigCarSignSpeed min="0" max="255"><!--req, xs: integer, marked speed limit for large-sized vehicle--></
bigCarSignSpeed>
<bigCarHighSpeedLimit min="0" max="255"><!--req, xs: integer, maximum speed limit for large-sized vehicle--></
bigCarHighSpeedLimit>
<bigCarLowSpeedLimit min="0" max="255"><!--req, xs: integer, minimum speed limit for large-sized vehicle--></
bigCarLowSpeedLimit>
<trigLineEffect min="0" max="255"><!--req, xs: integer, validity of triggering line--></trigLineEffect>
<carHighSpeed min="0" max="255"><!--req, xs: integer, abnormal overspped--></carHighSpeed>
<carLowSpeed min="0" max="255"><!--req, xs: integer, abnormal low speed--></carLowSpeed>
<bigCarHighSpeed min="0" max="255"><!--req, xs: integer, abnormal overspeed of large-sized vehicle--></
bigCarHighSpeed>
<bigCarLowSpeed min="0" max="255"><!--req, xs: integer, abnormal low speed of small-sized vehicle--></
bigCarLowSpeed>
<IOOut min="1" max="7"><!--req, xs: integer, linked synchronous alarm output--></IOOut>
<flashMode><!--req, xs: boolean, whether to enable flash light mode--></flashMode>
<radarType opt="none,adr,adr4Byte,olvia,csr,IOBox,SSTK,custom"><!--req, xs: string, radar type--></radarType>
<enableRadarTestMode opt="true,false"><!--opt, xs: boolean, whether to enable radar detection mode--></
enableRadarTestMode>
<radarSensitivity min="0" max="65535"><!--req, xs: integer, radar sensitivity--></radarSensitivity>
<radarAngle min="1" max="89"><!--req, xs: integer, angle between radar and horizontal direction--></radarAngle>
<validRadarSpeedTime min="1" max="9000"><!--req, xs: integer, effective time of radar speed--></
validRadarSpeedTime>
<radarLinearCorrection min="0.001" max="2.0">
<!--req, xs: float, min: 0.001, max: 2.0, linear correction parameter-->
</radarLinearCorrection>
<radarConstantCorrection min="-100" max="100"><!--req, xs:integer, constant correction parameter--></
radarConstantCorrection>
<radarRS485><!--req, xs: boolean, whether to enable radar--></radarRS485>
<backupMode opt="none,postRS485">
<!--req, xs: string, backup mode: "none", "postRS485"-checkpoint vehicle detector trigger mode-->
</backupMode>
<lineType opt="unknown,white, singleYellow, doubleYellow,guardRail,noCross">
<!--req, xs: string, detection line type: "white"-white solid line, "singleYellow"-single yellow line, "doubleYellow"-
double yellow lines, "guardRail" -lane line with guardrail, "noCross"-lane line prohibited to cross by vehicle-->
</lineType>

266
Intelligent Security API (Traffic) Developer Guide

<emergencyTimeSwitchList size="4"><!--req, effective time periods of emergency lane, up to 4 time periods can be
configured-->
<emergencyTimeSwitch><!--req-->
<timeId min="1" max="4"><!--req, xs: integer, time period No.--></timeId>
<startHour min="0" max="23"><!--dep, xs: integer, start time (hour)--></startHour>
<startMinute min="0" max="59"><!--dep, xs: integer, start time (minute)--></startMinute>
<endHour min="0" max="23"><!--dep, xs: integer, end time (hour)--></endHour>
<endMinute min="0" max="59"><!--dep, xs: integer, end time (minute)--></endMinute>
</emergencyTimeSwitch>
</emergencyTimeSwitchList>
<HighBeamTriggerLine><!--opt, configure trigger line for high beam trigger mode-->
<lineName><!-- req, xs: string, "highBeamTriggerLine"--></lineName>
<lineType opt="unknown,white,singleYellow,doubleYellow,guardRail,noCross"><!--req, xs: string--></lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates size="2"><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</HighBeamTriggerLine>
<noSupportLeftTriggerLine>
<!--req, xs: boolean, whether supports drawing left lane line, "true"-no, this node is not returned-yes-->
</noSupportLeftTriggerLine>
<noSupportRightTriggerLine>
<!--req, xs: boolean, whether supports drawing right lane line, "true"-no, this node is not returned-yes-->
</noSupportRightTriggerLine>
<noSupportObjectDetectAera>
<!--req, xs: boolean, whether supports drawing target detection region, "true"-no, this node is not returned-yes-->
</noSupportObjectDetectAera>
<noSupportPlateRegion>
<!--req, xs: boolean, whether supports drawing ANPR region, "true"-no, this node is not returned-yes-->
</noSupportPlateRegion>
<safeBeltCapNo min="1" max="3">
<!--dep, xs: integer, number of captured pictures in which the driver does not wear the seatbelt, which is between 1
and 3, this node is valid only when <safeBeltEnabled> is "true"-->
</safeBeltCapNo>
<uphoneCapNo min="1" max="3">
<!--dep, xs: integer, if <uphoneEnabled>is "true"-->
</uphoneCapNo>
<longChangeLane><!--opt, long-distance lane change-->
<enabled opt="true,false"><!--req, xs: boolean, whether to enable long-distance lane change--></enabled>
<capNo min="2" max="3"><!--req, xs: integer, number of captured pictures in which the long-distance lane change
happened--></capNo>
<sensitivity min="0" max="100"><!--req, xs: integer, detection sensitivity--></sensitivity>
</longChangeLane>
<gasser><!--opt, queue jumping-->
<enabled opt="true,false"><!--req, xs: boolean, whether to enable queue jumping detection--></enabled>
<gasserCapNo min="2" max="3"><!--req, xs: integer, number of captured pictures in which the queue jumping
happened--></gasserCapNo>
<sensitivity min="0" max="100"><!--req, xs: integer, detection sensitivity--></sensitivity>
<congestionThreshold min="1" max="100">
<!--req, xs: integer, congestion threshold, which is between 1 and 100-->

267
Intelligent Security API (Traffic) Developer Guide

</congestionThreshold>
<capInterval min="0" max="6000">
<!--req, xs: integer, time interval of continuous capture (2 to 3 pictures), unit: millisecond-->
</capInterval>
</gasser>
<congestion><!--opt, congestion-->
<interval min="1" max="10"><!--req, integer, alarm time interval, unit: minute--></interval>
<sensitivity min="1" max="100"><!--req, xs: integer, congestion sensitivity--></sensitivity>
<lastTime min="1" max="60"><!--req, xs: integer, congestion duration, unit: second--></lastTime>
</congestion>
<accident><!--opt, accident detection-->
<enabled opt="true,false"><!--req, xs: boolean, whether to enable accident detection--></enabled>
<lastTime min="1" max="180"><!--req, xs: integer, accident duration, unit: second--></lastTime>
<interval min="1" max="60"><!--req, xs: integer, time interval of continuous capture, unit: minute--></interval>
</accident>
<singleLaneFaceSnap opt="true,false">
<!--opt, xs: boolean, whether to enable face capture in a single lane-->
</singleLaneFaceSnap>
<nonMotorExistCapNo min="" max="">
<!--opt, xs: boolean, number of captured pictures in which the motor vehicle lane is occupied by non-motor vehicle--
>
</nonMotorExistCapNo>
<shedCapNo min="1" max="3">
<!--dep, xs: integer, number of captured pictures, and this node is valid only when <shed> is "true"-->
</shedCapNo>
<helmetCapNo min="1" max="3">
<!--dep, xs:integer, this node is valid when <helmet>is "true"-->
</helmetCapNo>
<twoWheelPassengerCapNo min="1" max="3">
<!--dep, xs:integer, this node is valid when <twoWheelPassenger>is "true"-->
</twoWheelPassengerCapNo>
<threeWheelPassengerCapNo min="1" max="3">
<!--dep, xs:integer, this node is valid when <threeWheelPassenger>is "true"-->
</threeWheelPassengerCapNo>
<capType opt="vehicle,nonMotor,human,face">
<!--opt, xs:string, "vehicle,nonMotor,human,face"-->
</capType>
</PostHVT>

B.90 XML_Cap_PostPRS
PostPRS capability message in XML format
<PostPRS version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<triggerType opt="videoDetection,IO,RS485,radarDetection"><!--req, xs: string--></triggerType>
<captureMode opt="strobe,flashing">
<!--dep, xs: string, "strobe,flashing", it is valid when triggerType is "videoDetection"-->
</captureMode>
<totalLaneNum min="" max=""><!--req, xs: integer--></totalLaneNum>
<LaneParamList size=""><!--req, lane paremeters-->

268
Intelligent Security API (Traffic) Developer Guide

<LaneParam>
<id><!--req, xs: integer--></id>
<laneNo min="" max=""><!--req, xs: integer, lane No., which is for OSD--></laneNo>
<laneDirectionType opt="0,1,2,3,4,5,6,7,8">
<!--req, xs: integer, lane direction, 0-unknown, 1-from east to west, 2-from west to east, 3-from south to north, 4-
from north to south, 5-from southeast to northwest, 6-from northwest to southeast, 7-from northeast to southwest, 8-
from southwest to northeast-->
</laneDirectionType>
<relatedDriveWay min="" max="">
<!--req, xs: integer, linked lane No.-->
</relatedDriveWay>
<captureMode opt="strobe,flashing">
<!--dep, xs: string, it is valid when triggerType is "videoDetection"-->
</captureMode>
<RS485No min="" max="">
<!--dep, xs: integer, it is valid when triggerType is "RS485"-->
</RS485No>
<IONo min="" max="">
<!--dep, xs: integer, it is valid when triggerType is "IO"-->
</IONo>
<IODefStatus opt="risingEdge,fallingEdge">
<!--dep, xs: string, it is valid when triggerType is "IO"-->
</IODefStatus>
<ViolationDetectLine><!--req-->
<lineName min="" max=""><!--req, xs: string, "laneLine"--></lineName>
<NormalizedScreenSize><!--req, ro-->
<normalizedScreenWidth><!--req, ro, xs: integer--></normalizedScreenWidth>
<normalizedScreenHeight><!--req, ro, xs: integer--></normalizedScreenHeight>
</NormalizedScreenSize>
<RegionCoordinatesList size=""><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</ViolationDetectLine>
<TriggerLine><!--req-->
<lineName min="" max=""><!--req, xs: string, "triggerLine"--></lineName>
<NormalizedScreenSize><!--req, read-only-->
<normalizedScreenWidth><!--req, ro, xs: integer--></normalizedScreenWidth>
<normalizedScreenHeight><!--req, ro, xs: integer--></normalizedScreenHeight>
</NormalizedScreenSize>
<RegionCoordinatesList size=""><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</TriggerLine>
</LaneParam>
</LaneParamList>
<VirtualLane><!--req-->

269
Intelligent Security API (Traffic) Developer Guide

<lineName min="" max=""><!--req, xs:string, "laneRightBoundaryLine"--></lineName>


<NormalizedScreenSize><!--req, ro-->
<normalizedScreenWidth><!--req, ro, xs: integer--></normalizedScreenWidth>
<normalizedScreenHeight><!--req, ro, xs: integer--></normalizedScreenHeight>
</NormalizedScreenSize>
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</VirtualLane>
<noPlatCarCap><!--ro, xs: boolean--></noPlatCarCap>
<sceneMode opt="commonEntrance, tollGate, ParkingEntrance">
<!--opt, xs: string-->
</sceneMode>
<capPicMode opt="scene,sceneCloseup"><!--opt, xs: string--></capPicMode>
<radarDetection><!--opt, radar detection mode, it is valid when workMode is "RadarDetection"-->
<detectDistance1 min="0" max="2000">
<!--req, xs: integer, radar detection distance, unit: cm-->
</detectDistance1>
<detectDistance2 min="0" max="2000">
<!--req, xs: integer, radar detection distance, unit: cm-->
</detectDistance2>
<alarmDistance min="0" max="600" def="300">
<!--req, xs: integer, radar alarm distance, unit: cm-->
</alarmDistance>
</radarDetection>
</PostPRS>

B.91 XML_Cap_PostRadar
PostRadar capability message in XML format
<?xml version="1.0" encoding="utf-8"?>
<PostRadar version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<relatedLaneCount min="1" max="6"><!--req, xs: integer, number of linked lanes--></relatedLaneCount>
<relatedDriveWay min="1" max="99"><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<laneType opt="none,highway,urbanFastWay,other">
<!--req, xs: string, lane type, "none"-not configured, "highway"-high way, "urbanFastWay"-urban expressway,
"other"-other-->
</laneType>
<laneUsage opt="carriageway,emergency"><!--req, xs: string--></laneUsage>
<distance min="0" max="20000"><!--req, xs: integer--></distance>
<delayTime min="0" max="2000"><!--req, xs: integer--></delayTime>
<delayDistance min="0" max="255"><!--req, xs: integer--></delayDistance>
<speedCapEnabled><!--req, xs: boolean--></speedCapEnabled>
<lowSpeedCapEnable><!--req, xs: boolean--></lowSpeedCapEnable>
<emergencyCapEnable><!--req xs: boolean--></emergencyCapEnable>
<laneDirectionType opt="0,1,2,3,4,5,6,7,8">
<!--req, xs: integer, lane direction, "0"-unknown, "1"-from east to west, "2"-from west to east, "3"-from south to
north, "4"-from north to south, "5"-from southeast to northwest, "6"-from northwest to southeast, "7"-from

270
Intelligent Security API (Traffic) Developer Guide

northeast to southwest, "8"-from southwest to northeast-->


</laneDirectionType>
<signSpeed min="0" max="255"><!--req, xs: integer--></signSpeed>
<speedLimit min="0" max="255"><!--req, xs: integer--></speedLimit>
<bigCarSignSpeed min="0" max="255"><!--req, xs: integer--></bigCarSignSpeed>
<bigCarSpeedLimit min="0" max="255"><!--req, xs: integer--></bigCarSpeedLimit>
<bigCarLowSpeedLimit min="0" max="60"><!--req, xs: integer--></bigCarLowSpeedLimit>
<lowSpeedLimit min="0" max="60"><!--req, xs: integer--></lowSpeedLimit>
<carHighSpeed min="0" max="255"><!--req, xs: integer--></carHighSpeed>
<carLowSpeed min="0" max="255"><!--req, xs: integer--></carLowSpeed>
<bigCarHighSpeed min="0" max="255"><!--req, xs: integer--></bigCarHighSpeed>
<bigCarLowSpeed min="0" max="255"><!--req, xs: integer--></bigCarLowSpeed>
<snapTimes min="0" max="5"><!--req, xs: integer--></snapTimes>
<intervalType opt="time,distance"><!--req, xs: string--></intervalType>
<snapValue><!--req, xs: integer--></snapValue>
<IOOut min="1" max="7"><!--req, xs: integer--></IOOut>
<radarType opt="none,adr,adr4Byte,olvia,csr,SSTK,custom"><!--req, xs: string--></radarType>
<radarSensitivity min="0" max="65535"><!--req, xs: integer--></radarSensitivity>
<radarAngle min="0" max="89"><!--req, xs: integer--></radarAngle>
<radarLinearCorrection min="0.0" max="2.0"><!--req, xs: float--></radarLinearCorrection>
<radarConstantCorrection min="-100" max="100"><!--req, xs:integer--></radarConstantCorrection>
<radarRS485><!--req, xs: boolean--></radarRS485>
<flashMode opt="together,alternation"><!--req, xs: string--></flashMode>
<emergencyTimeSwitchList size="4"><!--req-->
<emergencyTimeSwitch><!--req-->
<timeId min="1" max="4"><!--req, xs: integer--></timeId>
<startHour min="0" max="23"><!--dep, xs: integer--></startHour>
<startMinute min="0" max="59"><!--dep, xs: integer--></startMinute>
<endHour min="0" max="23"><!--dep, xs: integer--></endHour>
<endMinute min="0" max="59"><!--dep, xs: integer--></endMinute>
</emergencyTimeSwitch>
</emergencyTimeSwitchList>
<noSupportPlateRegion><!--opt, xs: boolean--></noSupportPlateRegion>
<LaneLine><!--opt-->
<lineName min="0" max="64"><!--req, xs: string--></lineName>
<RegionCoordinatesList num="2"><!--req, xs: list-->
<RegionCoordinates>
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneLine>
<LaneRightBoundaryLine><!--req-->
<lineName><!--req, xs: string, "laneRightBoundaryLine"--></lineName>
<lineType><!--req, xs: string, "unknown,white,singleYellow,doubleYellow,guardRail,noCross"--></lineType>
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</LaneRightBoundaryLine>
<safeBelt><!--opt, xs: boolean--></safeBelt>
<safeBeltCapNo min="1" max="3"><!--opt, xs: integer--></safeBeltCapNo>

271
Intelligent Security API (Traffic) Developer Guide

<uphone><!--opt, xs: boolean--></uphone>


<uphoneCapNo min="1" max="3"><!--opt, xs: integer--></uphoneCapNo>
</PostRadar>

B.92 XML_Cap_PostSideRadarSpeed
PostSideRadarSpeed capability message in XML format
<PostSideRadarSpeed version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable>
<!--required, xs:boolean, whether to enable trigger mode of side-mounted radar speed detection-->
</enable>
<relatedLaneCount min="1" max="16">
<!--required, xs:integer, total number of linked lanes, it is between 1 and 3-->
</relatedLaneCount>
<post>
<!--required, xs:boolean, checkpoint-->
</post>
<postCapNo min="0" max="3">
<!--required, xs:integer, number of pictures captured at checkpoint, it is between 0 and 3-->
</postCapNo>
<overSpeed>
<!--required, xs:boolean, whether it is overspeed-->
</overSpeed>
<overSpeedCapNo min="0" max="3" >
<!--required, xs:integer, number of captured pictures of overspeed, it is between 0 and 3-->
</overSpeedCapNo>
<lowSpeed>
<!--required, xs:boolean, whether it is low speed-->
</lowSpeed>
<lowSpeedCapNo min="0" max="3" >
<!--required, xs:integer, number of captured pictures of low speed, it is between 0 and 3-->
</lowSpeedCapNo>
<intervalType opt="time,distance" >
<!--required, xs:string, burst interval type: "time", "distance"-->
</intervalType>
<IntervalList size="4" >
<!--required-->
<Interval>
<!--required-->
<intervalValue min="0" max="65535" >
<!--required, xs:integer-->
</intervalValue>
</Interval>
</IntervalList>
<carHighSpeed min="0" max="255" >
<!--required, xs:integer-->
</carHighSpeed>
<carLowSpeed min="0" max="255" >
<!--required, xs:integer-->

272
Intelligent Security API (Traffic) Developer Guide

</carLowSpeed>
<bigCarHighSpeed min="0" max="255" >
<!--required, xs:integer-->
</bigCarHighSpeed>
<bigCarLowSpeed min="0" max="255" >
<!--required, xs:integer-->
</bigCarLowSpeed>
<LaneParamList size="6" >
<!--required-->
<LaneParam>
<!--optional-->
<laneId min="0" max="6" >
<!--required, xs:integer-->
</laneId>
<laneNO min="0" max="6" >
<!--required, xs:integer, lane No.-->
</laneNO>
<relatedDriveWay min="1" max="99" >
<!--required, xs:integer, linked lane No.-->
</relatedDriveWay>
<carSignSpeed min="0" max="255" >
<!--required, xs:integer, marked speed limit for small-sized vehicle-->
</carSignSpeed>
<carSpeedLimit min="0" max="255" >
<!--required, xs:integer, maximum speed limit for small-sized vehicle-->
</carSpeedLimit>
<carLowSpeedLimit min="0" max="255" >
<!--required, xs:integer, minimum speed limit for small-sized vehicle-->
</carLowSpeedLimit>
<bigCarSignSpeed min="0" max="255" >
<!--required, xs:integer, marked speed limit for large-sized vehicle-->
</bigCarSignSpeed>
<bigCarSpeedLimit min="0" max="255" >
<!--required, xs:integer, maximum speed limit for large-sized vehicle-->
</bigCarSpeedLimit>
<bigCarLowSpeedLimit min="0" max="255" >
<!--required, xs:integer, minimum speed limit for large-sized vehicle-->
</bigCarLowSpeedLimit>
<vanSignSpeed min="0" max="255" >
<!--optional, xs:integer, marked speed limit for minivan-->
</vanSignSpeed>
<vanSpeedLimit min="0" max="255" >
<!--optional, xs:integer, maximum speed limit for minivan-->
</vanSpeedLimit>
<vanLowSpeedLimit min="0" max="255" >
<!--optional, xs:integer, minimum speed limit for minivan-->
</vanLowSpeedLimit>
<vehicleSignSpeed min="0" max="255" >
<!--optional, xs:integer, marked speed limit for car-->
</vehicleSignSpeed>
<vehicleSpeedLimit min="0" max="255" >
<!--optional, xs:integer, maximum speed limit for car-->

273
Intelligent Security API (Traffic) Developer Guide

</vehicleSpeedLimit>
<vehicleLowSpeedLimit min="0" max="255" >
<!--optional, xs:integer, minimum speed limit for car-->
</vehicleLowSpeedLimit>
<busSignSpeed min="0" max="255" >
<!--optional, xs:integer, marked speed limit for bus-->
</busSignSpeed>
<busSpeedLimit min="0" max="255" >
<!--optional, xs:integer, maximum speed limit for bus-->
</busSpeedLimit>
<busLowSpeedLimit min="0" max="255" >
<!--optional, xs:integer, minimum speed limit for bus-->
</busLowSpeedLimit>
<lightTruckSignSpeed min="0" max="255" >
<!--optional, xs:integer, marked speed limit for light truck-->
</lightTruckSignSpeed>
<lightTruckSpeedLimit min="0" max="255" >
<!--optional, xs:integer, maximum speed limit for light truck-->
</lightTruckSpeedLimit>
<lightTruckLowSpeedLimit min="0" max="255" >
<!--optional, xs:integer, minimum speed limit for light truck-->
</lightTruckLowSpeedLimit>
<mediumHeavyTruckSignSpeed min="0" max="255" >
<!--optional, xs:integer, marked speed limit for middle-sized truck and heavy truck-->
</mediumHeavyTruckSignSpeed>
<mediumHeavyTruckSpeedLimit min="0" max="255" >
<!--optional, xs:integer, maximum speed limit for middle-sized truck and heavy truck-->
</mediumHeavyTruckSpeedLimit>
<mediumHeavyTruckLowSpeedLimit min="0" max="255" >
<!--optional, xs:integer, minimum speed limit for middle-sized truck and heavy truck-->
</mediumHeavyTruckLowSpeedLimit>
<Radar>
<!--required-->
<radarType opt="none,adr,adr4Byte,olvia,csr,IOBox,SSTK,custom" >
<!--required, xs:string, radar type-->
</radarType>
<radarSensitivity min="0" max="65535" >
<!--required, xs:integer, sensitivity-->
</radarSensitivity>
<radarAngle min="1" max="89" >
<!--required, xs:integer, angle of radar and horizontal direction, it is between 0 and 90 and the default angle is 0,
unit: degree-->
</radarAngle>
<validRadarSpeedTime min="1" max="9000" >
<!--required, xs:integer, radar speed valid time, it is between 0 and 2000, unit: ms-->
</validRadarSpeedTime>
<radarLinearCorrection min="0.001" max="2.0" >
<!--required, xs:float, linear correction parameter, the displayed value is between 0.0 and 2.0, and the value sent
to the capture camera will be the displayed value multiplying 1000-->
</radarLinearCorrection>
<radarConstantCorrection min="-100" max="100" >
<!--required, xs:integer, constant correction coefficient, it is between -100 and 100-->

274
Intelligent Security API (Traffic) Developer Guide

</radarConstantCorrection>
<radarRS485 min="1" max="5" >
<!--required, xs:integer, No. of RS-485 serial port linked to the radar, it is between 1 and 5-->
</radarRS485>
</Radar>
<IOOutList size="8">
<!--required-->
<IOOut>
<!--required-->
<id min="1" max="8">
<!--required, xs:integer-->
</id>
<enabled>
<!--required, xs:boolean-->
</enabled>
</IOOut>
</IOOutList>
<LaneLine>
<!--required-->
<lineName min="0" max="256">
<!--required, xs:string, line name-->
</lineName>
<lineType opt="unknown,white,singleYellow,doubleYellow,guardRail,noCross,solidline,dotLine" >
<!--required, xs:string, line type-->
</lineType>
<RegionCoordinatesList size="2">
<!--required-->
<RegionCoordinates>
<!--list, only two coordinates are required-->
<positionX>
<!--required, xs:integer-->
</positionX>
<positionY>
<!--required, xs:integer-->
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneLine>
</LaneParam>
<LaneRightBoundaryLine>
<!--required-->
<lineName>
<!--required, xs:string, line name, e.g., "laneRightBoundaryLine"-->
</lineName>
<lineType>
<!--required, xs:string, line type: "unknown,white,singleYellow,doubleYellow,guardRail,noCross,dotLine"-->
</lineType>
<RegionCoordinatesList>
<!--required-->
<RegionCoordinates>
<!--list, only two coordinates are required-->
<positionX>

275
Intelligent Security API (Traffic) Developer Guide

<!--required, xs:integer-->
</positionX>
<positionY>
<!--required, xs:integer-->
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneRightBoundaryLine>
<TriggerLine>
<!--required-->
<lineName>
<!--required, xs:string, line name, e.g., "triggerLine"-->
</lineName>
<lineType>
<!--optional, xs:string, line type: "unknown,white,singleYellow,doubleYellow,guardRail,noCross,dotLine"-->
</lineType>
<RegionCoordinatesList>
<!--required, list-->
<RegionCoordinates>
<!--list, only two coordinates are required-->
<positionX>
<!--required, xs:integer-->
</positionX>
<positionY>
<!--required, xs:integer-->
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</TriggerLine>
</LaneParamList>
<reverse>
<!--opt, xs:boolean, whether it is wrong-way driving-->
</reverse>
<reverseCapNo min="2" max="3">
<!--optional, xs:integer, number of captured pictures about wrong-way driving-->
</reverseCapNo>
<crossLane>
<!--optional, xs:boolean, whether it is driving on the lane line-->
</crossLane>
<crossLaneCapNo min="2" max="3">
<!--optional, xs:integer, number of captured pictures about driving on the lane line-->
</crossLaneCapNo>
</PostSideRadarSpeed>

B.93 XML_Cap_PostSingleIO
PostSingleIO capability message in XML format
<?xml version="1.0" encoding="utf-8"?>
<PostSingleIO version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">

276
Intelligent Security API (Traffic) Developer Guide

<relatedLaneCount min="1" max="6"><!--req, xs: integer, number of linked lane--></relatedLaneCount>


<IOInNum opt="IO1,IO2,IO3,IO4,IO5,IO6,IO7,IO8"><!--req, xs: string, number of I/O inputs--></IOInNum>
<defaultStatus opt="falling,rising,both"><!--req, xs: string, default I/O status--></defaultStatus>
<relatedDriveWay min="1" max="99"><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<laneUsage opt="carriageWay,banTrucks,emergency">
<!--req, xs: string, lane usage, "carriageWay"-normal lane, "banTrucks"-lan banning large-sized vehicle, "emergency"-
emergency lane-->
</laneUsage>
<snapTimes min="0" max="5"><!--req, xs: integer, number of captured pictures--></snapTimes>
<intervalType opt="time,distance"><!--req, xs: string, interval type of continuous capture--></intervalType>
<snapValue min="0" max="10000">
<!--req, xs: integer, interval of continuous capture, unit: millisecond or decimeter-->
</snapValue>
<IOOutNum min="1" max="7"><!--req, xs: integer, number of I/O outputs--></IOOutNum>
<flashMode opt="together,alternation">
<!--req, xs: string, flashing mode of flashing light, "together,alternation"-->
</flashMode>
<emergencyCapEnable>
<!--req, xs: boolean, whether to enable capture when emergency lane occupancy is detected-->
</emergencyCapEnable>
<emergencyTimeSwitchList size="4"><!--req, effective time periods of emergency lane, up to 4 time periods can be
configured-->
<emergencyTimeSwitch><!--req-->
<timeId min="1" max="4"><!-- req, xs: integer, time period No.--></timeId>
<startHour min="0" max="23"><!--dep, xs: integer, start time (hour)--></startHour>
<startMinute min="0" max="59"><!--dep, xs: integer, start time (minute)--></startMinute>
<endHour min="0" max="23"><!--dep, xs: integer, end time (hour)--></endHour>
<endMinute min="0" max="59"><!--dep, xs: integer, end time (minute)--></endMinute>
</emergencyTimeSwitch>
</emergencyTimeSwitchList>
<noSupportPlateRegion>
<!--req, xs: boolean, whether supports drawing ANPR region, "true"-no, this node is not returned-yes-->
</noSupportPlateRegion>
<LaneLine><!--opt-->
<lineName min="0" max="64"><!--req, xs: string--></lineName>
<RegionCoordinatesList num="2"><!--req, xs: list-->
<RegionCoordinates>
<positionX><!--req,xs:intege--></positionX>
<positionY><!--req,xs:intege--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneLine>
<LaneRightBoundaryLine><!--req-->
<lineName><!--req, xs: string, "laneRightBoundaryLine"--></lineName>
<lineType><!--req, xs: string, "unknown,white,singleYellow,doubleYellow,guardRail,noCross"--></lineType>
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</LaneRightBoundaryLine>
<safeBelt><!--opt, xs: boolean, whether to enable seatbelt detection--></safeBelt>
<safeBeltCapNo min="1" max="3">

277
Intelligent Security API (Traffic) Developer Guide

<!--dep, xs: integer, number of captured pictures in which the driver does not wear the seatbelt, which is between 1
and 3-->
</safeBeltCapNo>
<uphone><!--opt, xs: boolean, whether to enable phone call detection--></uphone>
<uphoneCapNo min="1" max="3">
<!--opt, xs: integer, number of captured pictures in which the driver is making call, which is between 1 and 3-->
</uphoneCapNo>
</PostSingleIO>

B.94 XML_Cap_RadarSetUp
RadarSetUp capability message in XML format
<RadarSetUp version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<RadarSetUpParamList size="" >
<!--optional-->
<RadarSetUpParam>
<!--optional, list-->
<radarType opt="none,adr,adr4Byte,olvia,csr,IOBox,SSKT,custom">
<!--required, xs:string, radar type: "none", "adr"-Andoray, "adr4Byte"-Andoray (no radar controller), "olvia"-Olvia,
"csr"-TransMicrowave, "IOBox"-radar connecting I/O expansion box, "SSKT"-Sensortech, "custom"-->
</radarType>
<setUpHeight min="10" max="100" >
<!--required, xs:integer, radar construction height, range: [10,100], unit: dm-->
</setUpHeight>
<angle min="0" max="90" >
<!--required, xs:integer, angle, range: [0,90]-->
</angle>
<radarLaneDistance min="0" max="100" >
<!--required, xs:integer, distance between radar and lane, range: [0,100], unit: dm-->
</radarLaneDistance>
<carDifference min="0" max="100" >
<!--required, xs:integer, vehicle distance, range: [0,100], unit: dm-->
</carDifference>
<hardThreshold min="0" max="255" >
<!--required, xs:integer, hard threshold, range: [0,255]-->
</hardThreshold>
<threshold min="0" max="255" >
<!--required, xs:integer, threshold, range: [0,255]-->
</threshold>
<laneWidth min="20" max="50" >
<!--required, xs:integer, lane width, range: [20,50], unit:dm-->
</laneWidth>
<laneCalibration min="0" max="255" >
<!--required, xs:integer, lane calibration coefficient, range: [0,255]-->
</laneCalibration>
<limitSpeed min="0" max="255" >
<!--optional, xs:integer, speed limit, unit: km/h-->
</limitSpeed>
<margin min="0" max="255" >

278
Intelligent Security API (Traffic) Developer Guide

<!--optional, xs:integer, margin, unit: km/h-->


</margin>
<workMode opt="headTrig,tailTrig,doubleTrig" >
<!--opt, xs:string, radar triggering mode: "headTrig"-trigger by vehicle head, "tailTrig"-trigger by vehicle tail,
"doubleTrig"-trigger by vehicle head and tail-->
</workMode>
<sceneMode opt="city,highWay" >
<!--opt, xs:string, scene: "city", "highWay"-highway-->
</sceneMode>
</RadarSetUpParam>
</RadarSetUpParamList>
</RadarSetUp>

B.95 XML_Cap_ROI
ROI capability message in XML format
<ROI version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<streamID opt="101,102,103">
<!--req, xs:string, stream type: 101-main stream, 102-sub-stream, 103-third stream-->
</streamID>
<id opt="1,2,3,4">
<!--req, xs:string, region No., which is between 1 and 4-->
</id>
<qualityLevelOfROI opt="1,2,3,4,5,6">
<!--req, xs:string, enhancement level, which is between 1 and 6-->
</qualityLevelOfROI>
</ROI>

B.96 XML_Cap_ROIRegion
ROIRegion capability message in XML format
<ROIRegion version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id>
<!--req, xs:integer, region No.-->
</id>
<streamID min="1" max="3">
<!--req, xs:integer, stream type: 1-main stream,2-sub-stream, 3-third stream-->
</streamID>
<enabled opt="true,false">
<!--req, xs:boolean, whether to enable ROI: "true"-yes, "false"-no-->
</enabled>
<name>
<!--req, xs:string, region name-->
</name>
<qualityLevelOfROI>
<!--req, xs:integer, enhancement level-->

279
Intelligent Security API (Traffic) Developer Guide

</qualityLevelOfROI>
</ROIRegion>

B.97 XML_Cap_SectionCtrl
SectionCtrl capability message in XML format
<SectionCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<sectionCtrlEnabled>
<!--req, xs:boolean, whether to enable picture exposure control by video segment: "true"-yes, "false"-no-->
</sectionCtrlEnabled>
</SectionCtrl>

B.98 XML_Cap_Svce
Svce capability message in XML format
<Svce version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled>
<!--req, xs:boolean, whether to enable part contrast-->
</enabled>
<svceLevel min="0" max="100">
<!--dep, xs:integer, part contrast level, which ranges from 0 to 100, the default value is 50-->
</svceLevel>
</Svce>

B.99 XML_Cap_TMEVoiceConfiguration
TMEVoiceConfiguration capability message in XML format
<TMEVoiceConfiguration version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<!--control parameters of audio announcement-->
<voiceSpeed min="0" max="100">
<!--req, xs:integer, speed-->
</voiceSpeed>
<voicePitch min="0" max="100">
<!--req, xs:integer, intonation-->
</voicePitch>
<voiceVolum min="0" max="100">
<!--req, xs:integer, volume-->
</voiceVolum>
<voiceRole opt="3,51,52,53,54,55">
<!--req, xs:integer, speaker-->
</voiceRole>
<voiceContent min="1" max="64">
<!--req, xs:string, audio announcement content-->
</voiceContent>

280
Intelligent Security API (Traffic) Developer Guide

<voiceFileName min="1" max="64">


<!--req, xs:string, audio file name-->
</voiceFileName>
<voicePlate>
<!--opt, xs:boolean, whether to enable audio announcement for license plates-->
</voicePlate>
</TMEVoiceConfiguration>

B.100 XML_Cap_TrafficParam
TrafficParam capability message in XML format
<TrafficParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<enable opt="true,false">
<!--dep, xs:boolean, whether to enable traffic flow statistics collection, its display depends on <statisticsMinute>-->
</enable>
<statisticsMinute min="0" max="65535">
<!--dep, xs:integer-->
</statisticsMinute>
<tpsStatistic>
<!--opt, traffic flow statistics-->
<enabled opt="true,false">
<!--req, xs:boolean, whether to enable traffic flow statistics-->
</enabled>
<statisticsMinute min="0" max="65535">
<!--req, xs:integer, statistics interval, unit: minute-->
</statisticsMinute>
</tpsStatistic>
</TrafficParam>

B.101 XML_Cap_TriggerMode
TriggerMode capability message in XML format
<TriggerMode version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<usedTriggerMode>
<!--req, xs:string, trigger mode supported by the device, different devices support different trigger modes, and a
device may support multiple trigger modes:
"postIOSpeed,postSingleIO,postRS485,postRadar,postVTCoil,postHVT,postMPR,epoliceRS485,postEpoliceRS485,videoE
police,TPS,videoMonitor,postNoComityPed,postRedLightPed,postSideRadarSpeed,parkingIncident,trafficIncident"-->
</usedTriggerMode>
</TriggerMode>

B.102 XML_Cap_UploadPic
UploadPic capability message in XML format

281
Intelligent Security API (Traffic) Developer Guide

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


<uploadPicPriority>
<!--req, xs:integer, picture uploading priority, the minimum value is 1, and the maximum vlaue is 2-->
</uploadPicPriority>
</UploadPic>

B.103 XML_Cap_VehicleDetectCfg
Vehicle detection capability message in XML format
<VehicleDetectCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--required, xs:boolean--></enabled>
<nation opt="EU,ER,EUandCIS,ME"><!--optional, xs:string, country and region, "ER"-CIS Region, "EU"-Europe Region,
"ME"-Middle East, "AP"-Asia Pacific, "AfricaAndAmerica"-Africa and America, "All"-All Region--></nation>
<stateOrProvince opt=""><!--optional, xs:string--></stateOrProvince>
<VehicleDetectSceneList size="">
<VehicleDetectScene><!--list-->
<id><!--required, xs:integer--></id>
<enabled><!--required, xs:boolean--></enabled>
<LaneConfig>
<LaneList size="4">
<Lane>
<laneId min="1" max="4"><!--required, xs:integer--></laneId>
<RegionCoordinatesList size=""><!--list, required-->
<RegionCoordinates><!--minoccurs=2, maxoccurs=2-->
<positionX><!--required, xs:integer--></positionX>
<positionY><!--required, xs:integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
<lineType opt="laneBoundaryLine,laneLine" ><!--optional, xs:string, lane line type: "laneBoundaryLine"-lane
border line, "laneLine"-lane line--></lineType>
<carDriveDirect opt="unknow,up_to_down,down_to_up">
<!--optional, xs:string, vehicle driving direction: "unknow"-unknown, "up_to_down"-from top to bottom,
"down_to_up"-from bottom to top-->
</carDriveDirect>
</Lane>
</LaneList>
</LaneConfig>
</VehicleDetectScene>
</VehicleDetectSceneList>
<countryIndex opt="1,2,3,4,5,6,7,8,12,14,17,18,19,20,23,39,44,55"><!--optional, xs:integer, country/region No.--></
countryIndex>
<supportCountryIndex opt="1,2,3,4,5,6,7,8,11,12,14,17,18,19,20,21,23,39,44,46,55,73"><!--optional, xs:integer,
country/region No.--></supportCountryIndex>
<!--compatibility between countryIndex and CRIndex-->
<!--device: both fields will be returned, when the value of CRIndex is smaller than or equal to 255, the value of
countryIndex is the same as that of CRIndex; when the value of CRIndex is larger than 255, the value of countryIndex
is 253 (the field countryIndex is invalid)-->
<!--integration flow: for new users, CRIndex has higher priority over countryIndex and the field countryIndex is used
only when countryIndex does not exist; when the value of countryIndex is 253, additional logic processing should be

282
Intelligent Security API (Traffic) Developer Guide

adopted to use CRIndex field-->


<CRIndex
opt="0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,28,29,30,31,33,34,35,36,37,38,39,40,42,43,
44,45,46,47,49,51,53,55,59,60,62,65,68,70,71,72,73,76,77,84,87,89,90,94,95,91,104,107,108,110,114,115,130,137,13
9,140,144,145,146,151,156,157,169,174,175,177,180,181,188,206,210,215,216,217,218,219,220,221,222,227,228,25
6">
<!--optional, xs:integer, country/region No., when the value is 0, it indicates that no country/region is specified-->
</CRIndex>
</VehicleDetectCfg>

B.104 XML_Cap_VideoEpolice
VideoEpolice capability message in XML format
<VideoEpolice version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<post><!--req, xs: boolean, whether to enable checkpoint detection--></post>
<driveLine><!--req, xs: boolean, whether to enable driving on lane line detection--></driveLine>
<driveLineCapNo opt="1,2,3" def="2">
<!--req, dep, xs:integer, number of continuously captured pictures in which the driving on lane line happened,
capture 2 pictures in strobe mode, and capture 2 to 3 pictures in flash and mixture mode-->
</driveLineCapNo>
<reverse><!--req, xs: boolean, whether to enable wrong-way driving detection--></reverse>
<reverseCapNo opt="1,2,3" def="2">
<!--req, dep, xs: integer, number of continuously captured pictures in which wrong-way driving happened, capture 2
pictures in strobe mode, and capture 2 to 3 pictures in flash and mixture mode-->
</reverseCapNo>
<redLight><!--req, xs: boolean, whether to enable red light running detection--></redLight>
<direction><!--req, xs: boolean, whether to enable detection of driving in wrong lane at intersection--></direction>
<intersectionCongest>
<!--req, xs: boolean, whether to enable intersection congestion detection-->
</intersectionCongest>
<nonDriveWay><!--req, xs: boolean, whether to enable detection of motor vehicle on non-motor vehicle lane--></
nonDriveWay>
<nonDreveWayCapNo min="2" max="3">
<!--req, xs: integer, number of captured pictures in which the motor vehicle on non-motor vehicle lane happened-->
</nonDreveWayCapNo>
<changeLane><!--req, xs: boolean, whether to enable illegal lane change detection--></changeLane>
<changeLaneCapNo min="2" max="3">
<!--req, xs: integer, number of captured pictures, which is between 2 and 3-->
</changeLaneCapNo>
<banSign><!--req, xs: boolean, whether to enable ban breaking detection--></banSign>
<banSignCapNO min="2" max="3">
<!--req, dep, xs: integer, number of continuously captured pictures in which the ban is broken, capture 2 pictures in
strobe mode, and capture 2 to 3 pictures in flash and mixture mode-->
</banSignCapNO>
<intersectionStop><!--req, xs: boolean, whether to enable intersection parking detection--></intersectionStop>
<greenLightStop>
<!--req, xs: boolean, whether to enable detection of parking at green light-->
</greenLightStop>
<overSpeed><!--req, xs: boolean, whether to enable overspeed detection--></overSpeed>

283
Intelligent Security API (Traffic) Developer Guide

<overSpeedCapNo min="2" max="3">


<!--req, dep, xs: integer, number of captured pictures in which the overspeed is detected-->
</overSpeedCapNo>
<illegalTurn>
<!--req, xs: boolean, whether to enable illegal U-turning detection-->
</illegalTurn>
<TrafficLight opt="IO,RS485,videoDetect,network">
<!--req-->
<source>
<!--req, xs:string, traffic light detection access mode: "IO,RS485,videoDetect,network"-->
</source>
<IOLightList>
<!--dep-->
<IOLight>
<!--list-->
<lightId>
<!--req, xs:integer, "1-3"-->
</lightId>
<lightType>
<!--req, xs:string, guiding direction of traffic light: "left,straight,right"-->
</lightType>
<relatedIO>
<!--req, xs:string, "NON_IO,IO1,IO2,IO3,IO4,IO5,IO6,IO7,IO8"-->
</relatedIO>
<redLightStatus>
<!--req, xs:string, "low,high"-->
</redLightStatus>
</IOLight>
</IOLightList>
<RS485LightList>
<!--dep-->
<RS485Light>
<!--list-->
<lightId>
<!--req, xs:integer, "1-3"-->
</lightId>
<lightType>
<!--req, xs:string, guiding direction of traffic light: "left,straight,right"-->
</lightType>
<relatedLightChan>
<!--req, xs:integer, red light linked channel, "0-16"-->
</relatedLightChan>
<yellowLightChan>
<!--req, xs:integer, yellow light linked channel, "0-16"-->
</yellowLightChan>
</RS485Light>
</RS485LightList>
<NetworkLightList>
<!--dep-->
<NetworkLight>
<!--list-->
<lightId>

284
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:integer, "1-3"-->


</lightId>
<lightType>
<!--req, xs:string, guiding direction of traffic light: "left,straight,right"-->
</lightType>
<relatedLightChan>
<!--req, xs:integer, red light linked channel, "0-16"-->
</relatedLightChan>
<yellowLightChan>
<!--req, xs:integer, yellow light linked channel, "0-16"-->
</yellowLightChan>
</NetworkLight>
</NetworkLightList>
<videoDetectLightList>
<!--dep-->
<videoDetectLight>
<!--list-->
<videoDetectLightId>
<!--req, xs:integer, "1-12"-->
</videoDetectLightId>
<lightNum>
<!--req, xs:integer, "1-3"-->
</lightNum>
<straightLight>
<!--req, xs:boolean-->
</straightLight>
<leftLight>
<!--req, xs:boolean-->
</leftLight>
<rightLight>
<!--req, xs:boolean-->
</rightLight>
<redLight>
<!--req, xs:boolean-->
</redLight>
<greenLight>
<!--req, xs:boolean-->
</greenLight>
<yellowLight>
<!--req, xs:boolean-->
</yellowLight>
<yellowLightTime>
<!--req, xs:integer, "0-10"-->
</yellowLightTime>
<rectRegion>
<!--req-->
<positionLeft>
<!--req, xs:integer, "0-65535"-->
</positionLeft>
<positionTop>
<!--req, xs:integer, "0-65535"-->
</positionTop>

285
Intelligent Security API (Traffic) Developer Guide

<positionRight>
<!--req, xs:integer, "0-65535"-->
</positionRight>
<positionBottom>
<!--req, xs:integer, "0-65535"-->
</positionBottom>
</rectRegion>
</videoDetectLight>
</videoDetectLightList>
</TrafficLight>
<relatedLaneCount min="1" max="6"><!--req, xs: integer, number of linked lanes--></relatedLaneCount>
<relatedDriveWay min="1" max="99"><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<recordEnable>
<!--req, xs: boolean, whether to enable recording when traffic violation happened-->
</recordEnable>
<recordType opt="delayRecord,preRecord"><!--req, xs: string, recording type--></recordType>
<preRecordTime min="0" max="100"><!--req, xs: integer, pre-record time--></preRecordTime>
<recordDelayTime min="0" max="100"><!--req, xs: integer, post-record time--></recordDelayTime>
<recordTimeOut min="0" max="100"><!--req xs: integer, recording timeout--></recordTimeOut>
<signSpeed min="0" max="255"><!--req, xs: integer, marked speed limit--></signSpeed>
<speedLimit min="0" max="255"><!--req, xs: integer, speed limit--></speedLimit>
<usageType opt="carriageWay,bus,slow,nonmotor,reverse,emergency">
<!--req, xs: string, lane usage, only one of the options can be supported at a time, "carriageWay"-normal lane, "bus"-
fast lane, "slow"-slow lane, "nonmotor"-non-motor lane, "reverse"-reverse lane, "emergency"-emergency lane-->
</usageType>
<LaneUsageList size="5"><!--opt, one or more lane usage types can be selected-->
<laneUsage opt="bus,banTrucks,banLeft,banRight,motor">
<!--opt, xs: string, lane usage type: "bus"-bus lane, "banTrucks"-truck prohibited lane, "banLeft"-left turn
prohibited lane, "banRight"-right turn prohibited lane, "motor"-motorcycle lane-->
</laneUsage>
</LaneUsageList>
<directionType
opt="unkown,left,straight,leftStraight,right,leftRight,rightStraight,leftRightStraight,leftWait,straightWait,strightWaitRig
ht">
<!--req, xs: string, direction type, multiple options can be supported at one time-->
</directionType>
<laneDirectionType min="0" max="8">
<!--req, xs: integer, lane direction: 0-unknown, 1-from east to west, 2-from west to east, 3-from south to north, 4-
from north to south, 5-from southeast to northwest, 6-from northwest to southeast, 7-from northeast to southwest, 8-
from southwest to northeast-->
</laneDirectionType>
<stopLineDistance>
<!--req, xs: integer, distance between the vehicle and the stop line in the second captured picture of red light
running violation-->
</stopLineDistance>
<loopSensitivity min="1" max="100">
<!--req, xs: integer, loop sensitivity-->
</loopSensitivity>
<capPositionOffset min="0" max="1500">
<!--req, xs: integer, minimum offset between the capture position of the second and the third picture-->
</capPositionOffset>
<videoDetectLightId min="1" max="12"><!--req, xs: integer, light No.--></videoDetectLightId>

286
Intelligent Security API (Traffic) Developer Guide

<lightNum><!--req, xs: integer, number of lights--></lightNum>


<straightLight><!--req, xs: boolean, straight driving light--></straightLight>
<leftLight><!--req, xs: boolean, left-turn light--></leftLight>
<rightLight><!--req, xs: boolean, right-turn ligt--></rightLight>
<redLight><!--req, xs: boolean, red light--></redLight>
<greenLight><!--req, xs: boolean, green light--></greenLight>
<yellowLight><!--req, xs: boolean, yellow light--></yellowLight>
<yellowLightTime><!--req, xs: integer, yellow light duration--></yellowLightTime>
<beginTime min="1" max="3"><!--req, xs: integer, recording start time--></beginTime>
<leftNotYieldStraight>
<enable opt="true,false"><!--req, xs: boolean, whether to enable detection of left turn not yield to straight driving--
></enable>
</leftNotYieldStraight>
<rightNotYieldLeft>
<enable opt="true,false"><!--req, xs: boolean, whether to enable detection of right turn not yield to left turn--></
enable>
</rightNotYieldLeft>
<uTurnNotYieldGoingStaight>
<enable opt="true,false"><!--req, xs: boolean, whether to enable detection of U-turning not yield to straight
driving--></enable>
</uTurnNotYieldGoingStaight>
<leftSideDrivingAfterLeftTurn>
<enable opt="true,false"><!--req, xs: boolean, whether to enable detection of turning in small radian at curve with
large radian--></enable>
</leftSideDrivingAfterLeftTurn>
<failYieldPed><!--opt-->
<enable opt="true,false"><!--req, xs: boolean, whether supports detection of not yield to pedestrian--></enable>
<vehicleFromDirection opt="Front,Back">
<!--req, xs: string, driving direction of the vehicle which does not yield to pedestrian-->
</vehicleFromDirection>
<cameraPosition opt="crossing,roadSection">
<!--opt,xs: string, camera position-->
</cameraPosition>
<noDisplacementPedEnabled opt="true,false">
<!--req, xs: boolean, whether to enable no displacement capture of pedestrian-->
</noDisplacementPedEnabled>
<failYieldPedLineList>
<failYieldPedLine>
<lineId opt="1,2"><!--req, xs:integer--></lineId>
<lineName><!--req, xs:string--></lineName>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</failYieldPedLine>
</failYieldPedLineList>
<notification><!--opt, pedestrian linkage-->
<enable opt="true,false"><!--req, xs: boolean, whether to enable pedestrian linkage--></enable>
<ip><!--req, xs: string, IP address of traffic camera--></ip>
<port><!--req, xs: integer, port No. of traffic camera--></port>

287
Intelligent Security API (Traffic) Developer Guide

<username><!--req, xs: string, user name of traffic camera--></username>


<password><!--req, xs: string, password of traffic camera, when transmitting, HTTPS is required--></password>
<sensitivity min="0" max="100"><!--req, xs: integer, triggering sensitivity, which is between 0 to 100--></
sensitivity>
<RS485Port min="1" max="10">
<!--req, xs:integer, RS-485 port No. for the signal light to access the camera, which is between 1 and 10-->
</RS485Port>
</notification>
</failYieldPed>
<gasser><!--opt, queue jumping-->
<enabled opt="true,false"><!--req, xs: boolean, whether to enable queue jumping detection--></enabled>
<gasserCapNo min="2" max="3"><!--req, xs: integer, number of captured pictures in which the queue jumping
happened--></gasserCapNo>
<sensitivity min="0" max="100"><!--req, xs: integer, detection sensitivity--></sensitivity>
<congestionThreshold min="1" max="100">
<!--req, xs: integer, congestion threshold, which is between 1 and 100-->
</congestionThreshold>
<capInterval min="0" max="6000">
<!--req, xs: integer, time interval of continuous capture (2 to 3 pictures), unit: millisecond-->
</capInterval>
</gasser>
<congestion><!--opt, congestion-->
<enabled opt="true,false"><!--opt, xs:boolean, whether to enable congestion detection--></enabled>
<interval min="1" max="10"><!--req, integer, alarm time interval, unit: minute--></interval>
<sensitivity min="1" max="100"><!--req, xs: integer, congestion sensitivity--></sensitivity>
<lastTime min="1" max="60"><!--req, xs: integer, congestion duration, unit: second--></lastTime>
</congestion>
<accident><!--opt, accident detection-->
<enabled opt="true,false"><!--req, xs: boolean, whether to enable accident detection--></enabled>
<lastTime min="1" max="180"><!--req, xs: integer, accident duration, unit: second--></lastTime>
<interval min="1" max="60"><!--req, xs: integer, time interval of continuous capture, unit: minute--></interval>
</accident>
<nonMotorEnabled opt="true,false">
<!--opt, xs: boolean, whether to enable non-motor vehicle detection-->
</nonMotorEnabled>
<runGreenLight opt="true,false">
<!--opt, xs: boolean, whether to enable green light running detection-->
</runGreenLight>
<helmetCapNo min="1" max="3">
<!--dep, xs: integer, number of captured pictures in which the driver does not wear the helmet, this node is valid
only when <helmet> is "true"-->
</helmetCapNo>
<nonMotorExistCapNo min="" max="">
<!--opt, xs: boolean, number of captured pictures in which the motor lane is occupied by non-motor vehicles-->
</nonMotorExistCapNo>
<capType opt="vehicle,nonMotor,human,face">
<!--opt, xs:string, "vehicle,nonMotor,human,face"-->
</capType>
</VideoEpolice>

288
Intelligent Security API (Traffic) Developer Guide

B.105 XML_Cap_VideoMarkInfo
VideoMarkInfo capability message in XML format
<VideoMarkInfo xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<horizontalField>
<!--req, xs:integer, horizontal FOV (field of view), which ranges from 0 to 360, the default value is 0-->
</horizontalField>
<verticalField>
<!--req, xs:integer, vertical FOV (field of view), which ranges from 0 to 360, the default value is 0-->
</verticalField>
<autoGetGps>
<!--req, xs:boolean, whether to get GPS information automatically: "true"-yes, "false"-no (default)-->
</autoGetGps>
<longitude>
<!--req, xs:string, longitude-->
</longitude>
<latitude>
<!--req, xs:string, latitude-->
</latitude>
</VideoMarkInfo>

B.106 XML_Cap_VideoMonitor
VideoMonitor capability message in XML format
<VideoMonitor version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<relatedLaneCount min="1" max="16"><!--req, xs: integer, total number of linked lanes--></relatedLaneCount>
<relatedDriveWay min="1" max="99"><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<laneDirectionType opt="0,1,2,3,4,5,6,7,8">
<!--req, xs: integer, lane direction: 0-unknown, 1-from east to west, 2-from west to east, 3-from south to north, 4-
from north to south, 5-from southeast to northwest, 6-from northwest to southeast, 7-from northeast to southwest, 8-
from southwest to northeast-->
</laneDirectionType>
<capType opt=" vehicle,vehWithHum">
<!--req, xs: string, captured target type, "vehicle"-motor vehicle, "vehWithHum"-non-motor vehicle--->
</capType>
</VideoMonitor>

B.107 XML_Cap_VoiceBroadcastInfo
VoiceBroadcastInfo capability message in XML format
<VoiceBroadcastInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema"><!--information about
configuration parameters of voice prompt control-->
<information min="0" max="128"><!--required, xs:string, voice prompt content--></information>
<voiceFileName min="" max=""><!--optional, xs:string, audio file name--></voiceFileName>

289
Intelligent Security API (Traffic) Developer Guide

<cycleTimes min="" max=""><!--optional, xs:integer, repetition times--></cycleTimes>


<isSupportStopBroadcast><!--optional, xs:boolean, whether it supports stopping voice prompt--></
isSupportStopBroadcast>
</VoiceBroadcastInfo>

B.108 XML_Cap_WizardDeviceInfo
WizardDeviceInfo capability message in XML format
<WizardDeviceInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id min="0" max="10000">
<!--req, xs:integer, channel No.-->
</id>
<defaultCHN>
<!--req, xs:string, province abbreviation-->
</defaultCHN>
<ipVersion opt="IPv4, IPv6, dual">
<!--req, xs:string, IP version, only IPv4 is supported-->
</ipVersion>
<ipAddress min="0" max="40">
<!--dep, xs:string, IP address-->
</ipAddress>
<subnetMask min="0" max="15">
<!--dep, xs:string, subnet mask for IPv4 address-->
</subnetMask>
<DefaultGateway>
<!--dep, default gateway, currently only IPv4 is supported-->
<ipAddress min="0" max="40">
<!--dep, xs:string-->
</ipAddress>
<ipv6Address min="0" max="40">
<!--dep, xs:string-->
</ipv6Address>
</DefaultGateway>
<capMode opt="strobe, flashing">
<!--req, xs:string, capture mode: "strobe"-strobe light mode, "flashing"-flashing light mode-->
</capMode>
<sceneMode opt="commonEntrance, tollGate, ParkingEntrance">
<!--req, xs:string, scene mode: "commonEntrance"-common entrance and exit, "tollGate"-toll station (vehicles will
stay for longer time), "ParkingEntrance"-entrance and exit of underground parking lot (there will be dark day and
night)-->
</sceneMode>
</WizardDeviceInfo>

B.109 XML_Cap_WizardFirstLogin
WizardFirstLogin capability message in XML format

290
Intelligent Security API (Traffic) Developer Guide

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


<id min="0" max="100000">
<!--req, xs:integer, channel No.-->
</id>
<isFirstLogin>
<!--opt, xs:boolean, the default value is "true"-->
</isFirstLogin>
<isReboot>
<!--opt, xs:boolean, the default value is "true"-->
</isReboot>
</WizardFirstLogin>

B.110 XML_CarFeatureParam
CarFeatureParam message in XML format
<CarFeatureParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<colorEnabled>
<!--req, xs:boolean, whether to enable vehicle color recognition-->
</colorEnabled>
<carLogoEnabled>
<!--req, xs:boolean, whether to enable vehicle log recognition-->
</carLogoEnabled>
<pilotSafebeltEnabled>
<!--req, xs:boolean, whether to enable safety belt detection-->
</pilotSafebeltEnabled>
<sunVisorEnabled>
<!--req, xs:boolean, whether to enable sun visor detection-->
</sunVisorEnabled>
<envprosignEnabled>
<!--req, xs:boolean, whether to enable yellow label vehicle detection-->
</envprosignEnabled>
<dangmarkEnabled>
<!--req, xs:boolean, whether to enable dangerous goods transport vehicle detection-->
</dangmarkEnabled>
<faceDetectEnabled>
<!--req, xs:boolean, whether to enable face picture matting-->
</faceDetectEnabled>
<uphoneEnabled>
<!--dep, xs:boolean, whether to enable phone call detection-->
</uphoneEnabled>
<pendantEnabled>
<!--dep, xs:boolean, whether to enable window hangings detection-->
</pendantEnabled>
<tissueBoxEnable>
<!--opt, xs:boolean, whether to tissue box detection-->
</tissueBoxEnable>
<frontChildEnable>
<!--opt, xs:boolean, whether to enable baby in arm detection-->
</frontChildEnable>

291
Intelligent Security API (Traffic) Developer Guide

<labelEnable>
<!--opt, xs:boolean, whether to enable label detection-->
</labelEnable>
<safebeltSensitivity>
<!--dep, xs:integer, safety belt detection sensitivity, which ranges from 1 to 100-->
</safebeltSensitivity>
<uphoneSensitivity>
<!--dep, xs:integer, phone call detection sensitivity, which ranges from 1 to 100-->
</uphoneSensitivity>
<pendantSensitivity>
<!--dep, xs:integer, window hangings detection sensitivity, which ranges from 1 to 100-->
</pendantSensitivity>
<decorationEnable>
<!--opt, xs:boolean, whether to enable decoration detection-->
</decorationEnable>
<OutputCtrl>
<!--output control-->
<hostFaceEnabled>
<!--req, xs:boolean, whether to support driver's face picture matting-->
</hostFaceEnabled>
<viceFaceEnabled>
<!--req, xs:boolean, whether to support front passenger's face picture matting-->
</viceFaceEnabled>
<nonMotorFaceEnabled>
<!--req, xs:boolean, whether to support non-motor vehicle user's face picture matting-->
</nonMotorFaceEnabled>
<faceImgScale>
<!--req, xs:integer, face close-up picture cutting ratio, which ranges from 1 to 3-->
</faceImgScale>
<faceImgRatio>
<!--req, xs:integer, face close-up picture zooming ratio, which ranges from 1 to 3-->
</faceImgRatio>
<faceImgOutputMode>
<!--req, xs:integer, face close-up picture output mode, which ranges from 0 to 2-->
</faceImgOutputMode>
<DrawFaceRectEnabled>
<!--req, xs:boolean, whether to enable face picture matting contrast enhancement-->
</DrawFaceRectEnabled>
<faceImgBrightenEnhenceEnabled>
<!--req, xs:boolean, whether to enable face close-up picture brightness enhancement-->
</faceImgBrightenEnhenceEnabled>
<faceImgBrightenEnhenceLevel>
<!--req, xs:integer, face close-up picture brightness enhancement level, which ranges from 0 to 100-->
</faceImgBrightenEnhenceLevel>
</OutputCtrl>
<smokingEnabled>
<!--req, xs:boolean, whether to enable smoking detection-->
</smokingEnabled>
<perfumeBoxEnabled>
<!--opt, xs:boolean, whether to enable perfume box detection-->
</perfumeBoxEnabled>
<helmetEnabled>

292
Intelligent Security API (Traffic) Developer Guide

<!--opt, xs:boolean, whether to enable helmet detection-->


</helmetEnabled>
<twoWheelVehicleEnabled>
<!--opt, xs:boolean, whether to enable manned two wheeler detection-->
</twoWheelVehicleEnabled>
<threeWheelVehicleEnabled>
<!--opt, xs:boolean, whether to enable manned tricycle detection-->
</threeWheelVehicleEnabled>
<nonMotorEnabled>
<!--opt, xs:boolean, whether to enable non-motor vehicle detection-->
</nonMotorEnabled>
<nonMotorFaceSnap>
<!--opt, xs:boolean, whether to enable non-motor vehicle user's face picture matting-->
</nonMotorFaceSnap>
</CarFeatureParam>

B.111 XML_ChanCtrl
ChanCtrl message (for traffic) in XML format
<ChanCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<streamGetType><!--streaming mode: 0-live view mode (default), 1-data receiving mode--></streamGetType>
</ChanCtrl>

B.112 XML_ChanDeviceStatus
ChanDeviceStatus message in XML format
<ChanDeviceStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<chanNo><!--req, xs: string--></chanNo>
<online><!--req, xs: boolean--></online>
<normalAnalysis><!--req, xs: boolean--></normalAnalysis>
<statusCode>
<!--req, xs: integer, status code: 0-no error, other codes are also the error codes-->
</statusCode>
<statusStr><!--req, xs: string, error information string--></statusStr>
<Device><!--opt-->
<deviceName><!--req, xs: string, device name for display--></deviceName>
<deviceStatus><!--req, xs: integer, status: 0-normal, 1-exception--></deviceStatus>
</Device>
</ChanDeviceStatus>

B.113 XML_ChannelMatch
ChannelMatch message in XML format

293
Intelligent Security API (Traffic) Developer Guide

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


<id><!--req, xs: integer--></id>
<firstChan><!--req, xs: string--></firstChan>
<secondChan><!--req, xs: string--></secondChan>
<matchType><!--req, xs: integer, linkage action: 0-coil linkage, 1-video linkage--></matchType>
<enable><!--req, xs: boolean, whether to enable: "true,false"--></enable>
<matchPicNum><!--req, xs: integer, number of matched pictures--></matchPicNum>
</ChannelMatch>

B.114 XML_ChannelMatchCap
ChannelMatchCap message in XML format
<ChannelMatchCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ChannelMatchCfg/><!--refer to the message XML_ChannelMatchCfg for details-->
<ChannelMatchList/><!--refer to the message XML_ChannelMatchList for details-->
<UnusedChannel/><!--refer to the message XML_UnusedChannel for details-->
</ChannelMatchCap>

See Also
XML_ChannelMatchCfg
XML_ChannelMatch
XML_UnusedChannel

B.115 XML_ChannelMatchCfg
ChannelMatchCfg message in XML format
<ChannelMatchCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable><!--req, xs: boolean, whether to enable camera matching: "true,false"--></enable>
</ChannelMatchCfg>

B.116 XML_ChannelMatchList
ChannelMatchList message in XML format
<ChannelMatchList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ChannelMatch/><!--refer to the message XML_ChannelMatch for details-->
</ChannelMatchList>

See Also
XML_ChannelMatch

294
Intelligent Security API (Traffic) Developer Guide

B.117 XML_CloudStorage
XML message about access parameters of cloud storage
<CloudStorage version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:string--></id>
<enabled><!--required, xs:boolean--></enabled>
<addressingFormatType><!--required, xs:string, address type: "ipaddress", "hostname"--></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port><!--required, xs:integer, port No.--></port>
<username><!--dependent, xs:string, user name--></username>
<password><!--dependent, xs:string, password--></password>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
<protocolType> <!--required, xs:string, cloud storage protocol type: "V1.0", "V2.0", "Image and Video Cloud"--></
protocolType>
<cloudStorageType><!--optional, xs:integer, 0-cloud storage (default), 1-CVR, 2-pcnvr2.0; if this node is empty, it is
the cloud storage by default--></cloudStorageType>
<V2.0><!--required, this node in valid only when the vaule of protocolType is V2.0-->
<enabled><!--required, xs:integer, whether to enable--></enabled>
<addressingFormatType><!--required, xs:string, address type: "ipaddress,hostname"--></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port><!--required, xs:integer, port No.--></port>
<accessKeyLen><!--dependent, access key length, it is valid only when the value of isSupportAccessKey "true"--></
accessKeyLen>
<secretKeyLen><!--dependent, secret key length, it is valid only when the value of isSupportSecretKey "true"--></
secretKeyLen>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
<resourceID><!--optional, xs:string, resource pool ID--></resourceID>
</V2.0>
<ImageAndVideoCloud>
<enabled> <!--required, xs:boolean, whether to enable--> </enabled>
<addressingFormatType opt="ipaddress,hostname"><!--required, xs:string, address type: "ipaddress", "hostname"--
></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>

295
Intelligent Security API (Traffic) Developer Guide

<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port><!--required, xs:integer, port No.--></port>
<accessKeyLen><!--dependent, access key length, it is valid only when the value of isSupportAccessKey "true"--></
accessKeyLen>
<secretKeyLen><!--dependent, secret key length, it is valid only when the value of isSupportSecretKey "true"--></
secretKeyLen>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
</ImageAndVideoCloud>
<bucketName><!--optional, xs:string, bucket name of cloud storage --></bucketName>
</CloudStorage>

B.118 XML_CloudStorageList
XML message about access parameters of cloud storage.
<?xml version="1.0" encoding="utf-8"?>
<CloudStorageList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<CloudStorage/><!--optional, see XML_CloudStorage for details-->
</CloudStorageList>

See Also
XML_CloudStorage

B.119 XML_CloudStorageServerList
XML message about parameters of cloud storage server
<?xml version="1.0" encoding="utf-8"?>
<CloudStorageServerList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<CloudStorageServer><!--list-->
<ImageAndVideoCloud><!--optional, configuration parameters of video and image cloud storage server-->
<addressingFormatType><!--required, xs:string, address type: "ipaddress,hostname"--></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port><!--required, xs:integer, port No.--></port>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
</ImageAndVideoCloud>
</CloudStorageServer>
</CloudStorageServerList>

296
Intelligent Security API (Traffic) Developer Guide

B.120 XML_CloudStorageTestDescription
XML message about cloud storage test
<?xml version="1.0" encoding="utf-8"?>
<CloudStorageTestDescription version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<addressingFormatType><!--required, xs:string, address type: "ipaddress", "hostname"--></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port><!--required, xs:integer, port No.--></port>
<username><!--dependent, xs:string, user name--></username>
<password><!--dependent, xs:string, password--></password>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
<protocolType> <!--required, xs:string, cloud storage protocol type: "V1.0", "V2.0", "Image and Video Cloud"--></
protocolType>
<cloudStorageType><!--optional, xs:integer, 0-cloud storage (default), 1-CVR, 2-pcnvr2.0; if this node is empty, it is
the cloud storage by default--></cloudStorageType>
<V2.0><!--dependent, it is valid when <protocolType> is "V2.0"-->
<addressingFormatType><!--required, xs:string, address type: "ipaddress,hostname"--></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port><!--required, xs:integer, port No.--></port>
<accessKeyLen><!--dependent, access key length, it is valid only when the value of isSupportAccessKey "true"--></
accessKeyLen>
<secretKeyLen><!--dependent, secret key length, it is valid only when the value of isSupportSecretKey "true"--></
secretKeyLen>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
</V2.0>
<ImageAndVideoCloud>
<enabled> <!--required, xs:boolean, whether to enable--> </enabled>
<addressingFormatType opt="ipaddress,hostname"><!--required, xs:string, address type: "ipaddress", "hostname"--
></addressingFormatType>
<hostName><!--dependent, xs:string, host name, it is valid only when the value of addressingFormatType is
"hostname"--></hostName>
<ipAddress><!--dependent, xs:string, IPv4 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address, it is valid only when the value of addressingFormatType is
"ipaddress"--></ipv6Address>
<port><!--required, xs:integer, port No.--></port>

297
Intelligent Security API (Traffic) Developer Guide

<accessKeyLen><!--dependent, access key length, it is valid only when the value of isSupportAccessKey "true"--></
accessKeyLen>
<secretKeyLen><!--dependent, secret key length, it is valid only when the value of isSupportSecretKey "true"--></
secretKeyLen>
<postPoolID><!--optional, xs:integer, checkpoint picture pool ID--></postPoolID>
<illegalPoolID><!--optional, xs:integer, violation picture pool ID--></illegalPoolID>
<vehicleDetectionID><!--optional, xs:integer, ID of vehicle detection picture pool--></vehicleDetectionID>
</ImageAndVideoCloud>
<bucketName><!--optional, xs:string, bucket name of cloud storage --></bucketName>
</CloudStorageTestDescription>

B.121 XML_CloudStorageTestResult
XML message about cloud storage test result
<CloudStorageTestResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<errorDescription><!--req,xs:string--></errorDescription>
</CloudStorageTestResult>

B.122 XML_CMSearchCount
XML message about search result of file quantity of dock station
<?xml version="1.0" encoding="utf-8"?>
<CMSearchCount version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<totalNum><!--required, xs:integer, total number of matched results--></totalNum>
<notUploadNum><!--optional, xs:integer, number of not uploaded files--></notUploadNum>
<uploadedNum><!--optional, xs:integer, number of uploaded files--></uploadedNum>
<uploadedFailNum><!--optional, xs:integer, number of upload failed files--></uploadedFailNum>
</CMSearchCount>

B.123 XML_Color
XML message about color adjustment parameters
<Color version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<brightnessLevel><!--opt, xs:integer, brightness--></brightnessLevel>
<contrastLevel><!--opt,xs:integer, contrast--></contrastLevel>
<saturationLevel><!--opt,xs:integer, saturation--></saturationLevel>
<hueLevel><!--opt, xs:integer, hue--></hueLevel>
<grayScale>
<grayScaleMode><!--opt,xs:string, gray scale mode: "indoor,outdoor"--></grayScaleMode>
</grayScale>
<nightMode>
<!--opt, xs:boolean, enable night mode, when its value is "true", the saturation can be adjusted, otherwise, the
saturation cannot be adjusted-->

298
Intelligent Security API (Traffic) Developer Guide

</nightMode>
</Color>

B.124 XML_continueCapCmd
continueCapCmd message in XML format
<continueCapCmd xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<capEnable>
<!--opt, xs:boolean, whether to enable continuous capture: "true"-configure capture parameters and capture,
"false"-only save the configured parameters-->
</capEnable>
<snapTimes>
<!--req, xs:integer, capture times, which ranges from 0 to 5, the default value is 0-->
</snapTimes>
<relatedDriveWay>
<!--req, xs:integer, linked lane No., the default value is 1-->
</relatedDriveWay>
<waitTime>
<!--req, xs:integer, continuous capture waiting time, unit: millisecond-->
</waitTime>
<IntervalList>
<!--req-->
<Interval>
<!--req-->
<value>
<!--req, xs:integer, continuous capture interval, four groups, unit: millisecond-->
</value>
</Interval>
</IntervalList>
<snapVehicleNum>
<!--opt, xs:integer, captured vehicle No.-->
</snapVehicleNum>
</continueCapCmd>

B.125 XML_CurVehicleDetectMode
CurVehicleDetectMode message in XML format
<CurVehicleDetectMode version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<CurMode><!--req, xs: string,"hvtVehicleDetection, vehicleDetection"--></CurMode>
</CurVehicleDetectMode>

B.126 XML_DataOperation
DataOperation message in XML format

299
Intelligent Security API (Traffic) Developer Guide

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


<operationType><!--req, xs: string, operation types: search,deleteByID,deleteByTime--></operationType>
<searchCond><!--dep, this node is valid when <operationType> is set to "search"-->
<searchID><!--req, xs: string, search ID--></searchID>
<timeSpanList>
<datatype>
<startTime><!--req, xs: string, start time, format: YYYY-MM-DDTHH:mm:ssZ--></startTime>
<endTime><!--req, xs: string, end time, format: YYYY-MM-DDTHH:mm:ssZ--></endTime>
</datatype>
</timeSpanList>
<criteria>
<analysisState><!--req, xs: integer, 0-unanalyzed, 1-analyzed--></analysisState>
<datatype>
<!--req, xs: integer, 0-checkpoint, 1-intersection violation system, 2-event, 3-low enforcement, 4-laser feature, 5-
blacklist alarm data, 6-human body attributes, 7-face attributes-->
</datatype>
<channel><!--req, xs: integer, channel No., which between 1 and 12, if this node does not exist, it represents all--
></channel>
<direction><!--req,xs:integer--></direction>
<plate><!--req, xs: string--></plate>
<plateType><!--req, xs: integer--></plateType>
<plateColor><!--req, xs: integer--></plateColor>
<speedMin><!--req, xs: integer--></speedMin>
<speedMax><!--req, xs: integer--></speedMax>
<vehicleType><!--req, xs: string--></vehicleType>
<vehicleColor><!--req, xs: string--></vehicleColor>
<laneNo><!--req, xs: integer--></laneNo>
<surveilType><!--req, xs: integer, 0-all, 1-whitelist, 2-blacklist--></surveilType>
<romoteHost><!--req, xs: integer, remote host No., which is between 1 and 4, if this node does not exist, it
represents all--></romoteHost>
<sendFlag><!--req, xs: integer, 0-unsend, 1-sent, 2-sending is not required, if this node does not exist, it represents
all--></sendFlag>
<analysised><!--opt, xs: boolean, false-unanalyzed, true-analyzed--></analysised>
<containerNum><!--opt, xs: string--></containerNum>
<trailerNum><!--opt, xs: string--></trailerNum>
<violationType><!--req, xs: string--></violationType>
<loadStatus><!--opt, xs: integer--></loadStatus>
</criteria>
<searchResultPosition><!--req, xs: integer, start position of search--></searchResultPosition>
<maxResults><!--req, xs: integer, number of results for current search--></maxResults>
</searchCond>
</DataOperation>

B.127 XML_DataOperationCap
DataOperationCap message in XML format
<DataOperationCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<DataOperation/><!--refer to the message XML_DataOperation for details-->

300
Intelligent Security API (Traffic) Developer Guide

<TrafficSearchResult/><!--refer to the message XML_TrafficSearchResult for details-->


</DataOperationCap>

See Also
XML_DataOperation
XML_TrafficSearchResult

B.128 XML_DarkEnhance
DarkEnhance message in XML format
<DarkEnhance version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<darkEnhanceEnabled>
<!--req, xs:boolean, whether to enable dark space enhancement-->
</darkEnhanceEnabled>
<darkEnhanceLevel>
<!--dep, xs:integer, dark space enhancement level, which ranges from 0 to 100-->
</darkEnhanceLevel>
</DarkEnhance>

B.129 XML_DayNightGate
DayNightGate message in XML format
<DayNightGate xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<brightnessThreld>
<!--dep ,xs:integer, this node depends on <ExposureType> in the message of XML_Exposure-->
</brightnessThreld>
</DayNightGate>

See Also
XML_Exposure

B.130 XML_Defog
Defog message in XML format
<Defog version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--req, xs:boolean--></enabled>
</Defog>

301
Intelligent Security API (Traffic) Developer Guide

B.131 XML_DetectorStatus
DetectorStatus message in XML format
<DetectorStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<detectorLinkState>
<!--req, xs:string, vehicle detector connection status: "connected", "disconnected"-->
</detectorLinkState>
<DetectorList>
<!--vehicle detector status list-->
<Detector>
<laneId>
<!--opt, xs:integer, lane No., which ranges from 1 to 16-->
</laneId>
<firstCoilStatus>
<!--req, xs:string "used,unused", coil 1 status, including unused, normal, short circuit, open circuit-->
</firstCoilStatus>
<secondCoilStatus>
<!--req, xs:string, "used,unused", coil 2 status, including unused, normal, short circuit, open circuit-->
</secondCoilStatus>
<thirdCoilStatus>
<!--req, xs:string, "used,unused", coil 3 status, including unused, normal, short circuit, open circuit-->
</thirdCoilStatus>
</Detector>
</DetectorList>
</DetectorStatus>

B.132 XML_DeviceInfo
XML message about device information
<DeviceInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<deviceName><!--required, xs:string--></deviceName>
<deviceID><!--required, read-only, xs:string, uuid--></deviceID>
<deviceDescription>
<!--optional, xs:string, description about the device defined in RFC1213. For network camera, this node is set to
"IPCamera"; for network speed dome, this node is set to "IPDome"; for DVR or DVS, this node is set to "DVR" or
"DVS"-->
</deviceDescription>
<deviceLocation><!--optional, xs:string, actual location of the device--></deviceLocation>
<deviceStatus><!--optional, read-only, xs:string, device status: "normal", "abnormal"-->
<DetailAbnormalStatus>
<!--dependent, error status details, it is valid only when deviceStatus is "abnormal"-->
<hardDiskFull>
<!--optional, read-only, xs: boolean, whether the error of "HDD full" occurred: "true"-yes,"false"-no-->
</hardDiskFull>
<hardDiskError>
<!--optional, read-only, xs:boolean, whether the error of "HDD error" occurred: "true"-yes,"false"-no-->
</hardDiskError>

302
Intelligent Security API (Traffic) Developer Guide

<ethernetBroken>
<!--optional, read-only, xs: boolean, whether the error of "network disconnected" occurred: "true"-yes,"false"-no--
>
</ethernetBroken>
<ipaddrConflict>
<!--optional, read-only, xs: boolean, whether the error of "IP address conflicted" occurred: "true"-yes,"false"-no-->
</ipaddrConflict>
<illegalAccess>
<!--optional, read-only, xs: boolean, whether the error of "illegal login" occurred: "true"-yes,"false"-no-->
</illegalAccess>
<recordError>
<!--optional, read-only, xs: boolean, whether the error of "recording exception" occurred: "true"-yes,"false"-no-->
</recordError>
<raidLogicDiskError>
<!--optional, read-only, xs: boolean, whether the error of "RAID exception" occurred: "true"-yes,"false"-no-->
</raidLogicDiskError>
<spareWorkDeviceError>
<!--optional, read-only, xs: boolean, whether the error of "working device exception" occurred: "true"-yes,"false"-
no-->
</spareWorkDeviceError>
</DetailAbnormalStatus>
<systemContact><!--optional, xs:string, contact information of the device--></systemContact>
<model><!--required, read-only, xs:string--></model>
<serialNumber><!--required, read-only, xs:string--></serialNumber>
<macAddress><!--required, read-only, xs:string--></macAddress>
<firmwareVersion><!--required, read-only, xs:string--></firmwareVersion>
<firmwareReleasedDate><!--optional, read-only, xs:string--></firmwareReleasedDate>
<bootVersion><!--optional, read-only, xs:string--></bootVersion>
<bootReleasedDate><!--optional, read-only, xs:string--></bootReleasedDate>
<hardwareVersion><!--optional, read-only, xs:string--></hardwareVersion>
<encoderVersion><!--optional, read-only, xs:string--></encoderVersion>
<encoderReleasedDate><!--optional, read-only, xs:stirng--></encoderReleasedDate>
<decoderVersion><!--optional, read-only, xs:string--></decoderVersion>
<decoderReleasedDate><!--optional, read-only, xs:stirng--></decoderReleasedDate>
<softwareVersion><!--optional, read-only, xs:string, software version--></softwareVersion>
<capacity><!--optional, read-only, xs:integer, unit: MB, device capacity--></capacity>
<usedCapacity><!--optional, read-only, xs:integer, unit: MB, capacity usage--></usedCapacity>
<deviceType>
<!--required, read-only, xs:string,device type: "IPCamera", "IPDome", "DVR", "HybirdNVR", "NVR", "DVS", "IPZoom",
"CVR", "Radar", "PerimeterRadar"-perimeter radar, "ACS", "PHA"-Axiom hybrid security control panel-->
<deviceType>
<telecontrolID><!--optional, xs:integer, keyfob control ID, the value is between 1 and 255--></telecontrolID>
<supportBeep><!--optional, xs:boolean--></supportBeep>
<supportVideoLoss><!--optional, xs:boolean, whether it supports video loss detection--></supportVideoLoss>
<firmwareVersionInfo><!--optional, read-only, xs:string, firmware version information--></firmwareVersionInfo>
<actualFloorNum>
<!--required, xs: integer, actual number of floors, which is between 1 and 128-->
</actualFloorNum>
<subChannelEnabled><!--optional, xs:boolean, whether to support sub-stream live view: "true"-yes, "false"-no--></
subChannelEnabled>
<thrChannelEnabled><!--optional, xs:boolean, whether to support third stream live view: "true"-yes, "false"-no--></
thrChannelEnabled>

303
Intelligent Security API (Traffic) Developer Guide

<radarVersion><!--optional, xs:string, radar version--></radarVersion>


<cameraModuleVersion><!--read-only, xs:string, camera module version--></cameraModuleVersion>
<mainversion><!--optional, xs:integer, main version No. which is between 1 and 255--></mainversion>
<subversion><!--optional, xs:integer, sub version No. which is between 1 and 255--></subversion>
<upgradeversion><!--optional, xs:integer, upgraded version No. which is between 1 and 255--></upgradeversion>
<customizeversion><!--optional, xs:integer, customized version No. which is between 1 and 255--></
customizeversion>
<companyName><!--optional, xs:string, the manufacturing company's abbreviation--></companyName>
<copyright><!--optional, xs:string, copyright information--></copyright>
<systemName><!--optional, xs:string , storage system name: "storageManagement"-storage management system,
"distributedStorageManagement"-distrubuted storage management system--></systemName>
<systemStatus><!--optional, xs:string,system status: "configured"-configured, "unConfigured"-not configured--></
systemStatus>
<isLeaderDevice><!--optional, xs:boolean, whether it is the corresponding device of the resource IP address--></
isLeaderDevice>
<clusterVersion><!--dependent, xs:string, system cluster version. This node is valid when <isLeaderDevice> is true--
></clusterVersion>
<manufacturer><!--optional, xs:string, manufacturer information: "hikvision"-Hikvision devices; for neutral devices,
this node should be empty--></manufacturer>
<customizedInfo><!--optional, xs:string, order No. of the customization project. For baseline devices, this node is
empty; for custom devices, the order No. of the customization project will be returned by this node--></
customizedInfo>
<localZoneNum><!--optional, xs:integer, number of local zones--></localZoneNum>
<alarmOutNum><!--optional, xs:integer, number of alarm outputs--></alarmOutNum>
<distanceResolution><!--optional, xs:float, resolution of distance, unit: meter--></distanceResolution>
<angleResolution><!--optional, xs:float, resolution of angle, unit: degree--></angleResolution>
<speedResolution><!--optional, xs:float, resolution of speed, unit: m/s--></speedResolution>
<detectDistance><!--optional, xs:float, detection distance, unit: meter--></detectDistance>
<languageType opt="chinese,english,spanish,portuguese,italian,french,russian,turkish,greek,czech"><!--optional,
xs:string--></languageType>
<relayNum><!--optional, xs:integer, number of local relays--></relayNum>
<electroLockNum><!--optional, xs:integer, number of local electronic locks--></electroLockNum>
<RS485Num><!--optional, xs:integer, number of local RS-485--></RS485Num>
<powerOnMode><!--optional, xs:string, device startup mode: "button"-press button to power on (default), "adapter"-
connect adapter to power on--></powerOnMode>
<DockStation>
<!--optional, dock station configuration-->
<Platform>
<!--optional, platform configuration-->
<type><!--required, xs:string, platform type: none, 9533, 8618, ISAPI--></type>
<ip><!--optional, xs:string, IP address --></ip>
<port><!--optional, xs:integer, communication port--></port>
<userName><!--required, xs:string, user name, which is used for the dock station to log in to platform--></
userName>
<password><!--required, xs:string, password, which is used for the dock station to log in to platform, it should be
encrypted--></password>
</Platform>
<centralStorageBackupEnabled><!--optional, xs:boolean, whether to enable central storage backup--></
centralStorageBackupEnabled>
</DockStation>
<webVersion><!--optional, read-only, xs:string, web version No.--></webVersion>
<deviceRFProgramVersion><!--optional, read-only, xs:string, version No. of the device's RF (Radio Frequency)

304
Intelligent Security API (Traffic) Developer Guide

program--></deviceRFProgramVersion>
<securityModuleSerialNo><!--optional, read-only, xs:string, serial No. of the security module--></
securityModuleSerialNo>
<securityModuleVersion><!--optional, read-only, xs:string, version No. of the security module--></
securityModuleVersion>
<securityChipVersion><!--optional, read-only, xs:string, version No. of the security chip--></securityChipVersion>
<securityModuleKeyVersion><!--optional, read-only, xs:string, version No. of the security module key--></
securityModuleKeyVersion>
<UIDLampRecognition><!--optional, information of the UID lamp recognition device-->
<enabled><!--optional, xs:boolean, whether to enable--></enabled>
</UIDLampRecognition>
<bootTime><!--optional, xs:string, read-only, system boot time, ISO 8601 format; the maximum length is 32 bytes--
></bootTime>
</DeviceInfo>

B.133 XML_DockStation_CMSearchDescription
XML message about condition of searching for file quantity of dock station.
<?xml version="1.0" encoding="UTF-8"?>
<CMSearchDescription version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--required, xs:string, search ID--></searchID>
<timeSpanList>
<timeSpan>
<startTime><!--required, xs:datetime, start time, e.g., "2013-06-10T12:00:00+08:00"--></startTime>
<endTime><!--required, xs:datetime, end time, e.g., "2013-06-10T12:00:00+08:00"--></endTime>
</timeSpan>
</timeSpanList>
<searchTypeList>
<searchKeyword><!--optional, xs:string, search key word--></searchKeyword>
</searchTypeList>
<contentTypeList>
<contentType><!--optional, file type: "all,video,audio,metadata,text,picture,other"--></contentType>
</contentTypeList>
<uploadState><!--optional, xs:string, upload status: "all"-all, "uploaded"-uploaded, "nonUploaded"-not uploaded,
"uploadFailed"-upload failed--></uploadState>
<lockState><!--optional, xs:string, lock status: "lock,unlock,all"--></lockState>
<searchResultPostion>
<!--required, xs:integer, position of search result, it is used for paging, e.g., if the maximum number of search
results per page is 20 items, then "0" indicates first page and "20" indicates second page-->
</searchResultPostion>
<maxResults><!--required, xs:integer, maximum number of search results per page--></maxResults>
</CMSearchDescription>

B.134 XML_DSS
DSS message in XML format

305
Intelligent Security API (Traffic) Developer Guide

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


<enabled>
<!--req, xs:boolean-->
</enabled>
<DSSLevel>
<!--opt, xs:string, low illumination electronic shutter level in exposure,
"*1.25,*1.5,*2,*3*4,*6,*8,*12,*16,*24,*32,*48,*64,*96,*128,*256,*512,auto". *2 indicates that the speed of the
low illumination electronic shutter is 2 times of the normal shutter speed. This node is valid only when <enabled> is
"true"-->
</DSSLevel>
<mode>
<!--opt, xs:string, "frame"-frame mode, which indicates that <DSSLevel> is valid; "level"-level mode, which indicates
that <slowShutterLevel> is valid. If this node does not exist, the default mode is frame mode-->
</mode>
<slowShutterLevel>
<!--req, xs:integer, slow shutter level in exposure, which ranges from 1 to 6-->
</slowShutterLevel>
</DSS>

B.135 XML_edfForceManualCapSwitch
edfForceManualCapSwitch message in XML format.
<edfForceManualCapSwitch>
<status><!--req, xs:integer 1-open mandatory evidence capture mode，2-close 关闭闭制手闭取闭模式--></status>
</edfForceManualCapSwitch>

B.136 XML_EdfManualIts
XML message about parameters of manual evidence capture
<EdfManualItsCap version="1.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isPlateRec>
<!--optional, xs:boolean, whether to capture vehicle without license plate: 0-no (default), 1-yes-->
</isPlateRec>
<imgNum>
<!--required, xs:integer, number of captured pictures, which is between 1 and 6, the default value is 4-->
</imgNum>
<ImgGroupInfo><!--picture group information-->
<imgInterval>
<!--required, xs:integer, capture time interval, which is between 1 and 3600, the default value is 600, unit: second--
>
</imgInterval>
<imgType>
<!--required, xs:string, picture type: "0"-panorama view, "1"-close view (default), "2"-feature-based view, "3"-
custom view, "4"-middle-distance view-->
</imgType>
</ImgGroupInfo>

306
Intelligent Security API (Traffic) Developer Guide

<nSnapOneTimeOut>
<!--required, xs:integer, evidence capture timeout of a picture, which is between 2 and 60, the default value is 20,
unit: second-->
</nSnapOneTimeOut>
<nTskTimeOut>
<!--required, xs:integer, timeout of evidence capture task, which is between 10 and 7200, the default value is 1800,
unit: second-->
</nTskTimeOut>
<nPlateMatchRatio>
<!--required, xs:integer, matching rate (%) of license plate, which is between 0 and 100-->
</nPlateMatchRatio>
<plateRecogEnabled>
<!--required, xs:boolean, whether to enable license plate recognition for illegal parking event: true-yes, false-no
(default)-->
</plateRecogEnabled>
</EdfManualItsCap>

B.137 XML_EntranceCap
XML message about the entrance and exit capability
<EntranceCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<supportEntrance>
<!--opt, xs:boolean-->
</supportEntrance>
<supportBarrierGateNum>
<!--opt, xs:integer-->
</supportBarrierGateNum>
<supportAlarmINNum>
<!--opt, xs:integer-->
</supportAlarmINNum>
<supportRelayNum>
<!--opt, xs:integer-->
</supportRelayNum>
<isSupportWizardDeviceInfo>
<!--req, xs:boolean, whether to support configuring device information in wizard-->
</isSupportWizardDeviceInfo>
<isSupportWizardFirstLogin>
<!--req, xs:boolean, whether to support judging if it is login for the first time in wizard-->
</isSupportWizardFirstLogin>
<supportEntranceParam>
<!--opt, xs:integer-->
</supportEntranceParam>
</EntranceCap>

B.138 XML_EntranceParamList
EntranceParamList message in XML format

307
Intelligent Security API (Traffic) Developer Guide

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


<EntranceParam version="1.0" xmlns="urn:psialliance-org">
<laneNum>
<!--req, xs:integer, barrier gate No.: "1", currently only barrier gate No. 1 is supported-->
</laneNum>
<bEnable>
<!--req, xs:boolean, whether to enable the parameters-->
</bEnable>
<ctrlMod>
<!--req, xs:integer, barrier gate control mode: 0-controlled by camera, 1-controlled by platform-->
</ctrlMod>
<relateTriggerMode>
<!--req, xs:integer, linked trigger mode: 0-checkpoint single I/O trigger, 1-checkpoint vehicle detector, 2-MPR -->
</relateTriggerMode>
<vehControlMeasure><!--vehicle management and control method-->
<plateNumOnlyEnable>
<!--req, xs:boolean, only match license plate number-->
</plateNumOnlyEnable>
<plateNumColorEnable>
<!--req, xs:boolean, match license plate number and license plate color simultaneously-->
</plateNumColorEnable>
</vehControlMeasure>
<vehInfoManagList>
<!--req-->
<vehInfoManag>
<!--req-->
<vehInfoManagNum>
<!--req, xs:integer, vehicle information management: 0-temporary vehicle configuration, 1-blacklist vehicle
configuration, 2-whitelist vehicle configuration-->
</vehInfoManagNum>
<barrierGateOper>
<!--req, xs:integer, barrier gate operation: 0-no operation, 1-open barrier gate-->
</barrierGateOper>
<relayOutAlarmEnable>
<!--req, xs:boolean, whether to enable relay output alarm-->
</relayOutAlarmEnable>
<upAlarmEnable>
<!--req, xs:boolean, upload arming alarm information-->
</upAlarmEnable>
<hostUpAlarmEnable>
<!--req, xs:boolean, alarm host uploads alarm information-->
</hostUpAlarmEnable>
</vehInfoManag>
</vehInfoManagList>
<relayList>
<!--req-->
<relay>
<!--req-->
<relayNum>
<!--req, xs:integer, relay No., which is between 1 and 5-->
</relayNum>
<relayFunction>

308
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:integer, relay function: 0-none, 1-open barrier gate, 2-close barrier gate, 3-stop barrier gate, 4-alarm
signal, 5-solid light-->
</relayFunction>
</relay>
</relayList>
<IOAlarmList>
<!--req-->
<IOAlarm>
<!--req-->
<IOAlarmNum>
<!--req, xs:integer, alarm port No., which is between 1 and 2-->
</IOAlarmNum>
<IOAlarmType>
<!--req, xs:integer, alarm type: 0-none, 1-fire alarm-->
</IOAlarmType>
</IOAlarm>
</IOAlarmList>
<notCloseCarFollow>
<!--opt, xs:boolean, whether to enable the barrier gate not to close when the vehicle is followed by another
vehicle-->
</notCloseCarFollow>
<bigCarKeepOpen>
<!--opt, the barrier gate remains open when the large-sized vehicle passes-->
<enabled>
<!--req, xs:boolean, whether to enable the barrier gate to remain open when the large-sized vehicle passes-->
</enabled>
<duration>
<!--req, xs:integer, duration of the barrier gate remaining open-->
</duration>
</bigCarKeepOpen>
</EntranceParam>
</EntranceParamList>

B.139 XML_EventNotificationAlert_AlarmEventInfo
EventNotificationAlert message with alarm/event information in XML format.
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipAddress><!--dep, xs:string, device IPv4 address--></ipAddress>
<ipv6Address><!--dep, xs:string, device IPv6 address--></ipv6Address>
<portNo><!--opt, xs:integer, device port number--></portNo>
<protocol><!--opt, xs:string, protocol type for uploading alarm/event information, "HTTP,HTTPS"--></protocol>
<macAddress><!--opt, xs:string, MAC address--></macAddress>
<channelID><!--dep, xs:string, device channel No., starts from 1--></channelID>
<dateTime><!--req, alarm/event triggered or occurred time, format: 2017-07-19T10:06:41+08:00--></dateTime>
<activePostCount><!--req, xs:integer, alarm/event frequency, starts from 1--></activePostCount>
<eventType><!--req, xs:string, alarm/event type, "peopleCounting, ANPR,..."--></eventType>
<eventState>
<!--req, xs:string, durative alarm/event status: "active"-valid, "inactive"-invalid, e.g., when a moving target is
detected,

309
Intelligent Security API (Traffic) Developer Guide

the alarm/event information will be uploaded continuously unit the status is set to "inactive"-->
</eventState>
<eventDescription><!--req, xs:string, alarm/event description--></eventDescription>
<...><!--opt, for different alarm/event types, the nodes are different, see the message examples in different
applications--></...>
</EventNotificationAlert>

B.140 XML_EventNotificationAlert_ANPRMsg
XML message about ANPR results
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipAddress><!--dependent, xs:string, IPv4 address--></ipAddress>
<ipv6Address><!--dependent, xs:string, IPv6 address--></ipv6Address>
<portNo><!--optional, xs:integer, device's communication port No.--></portNo>
<protocol><!--optional, xs:string, transport protocol type: HTTP, HTTPS, EHome--></protocol>
<macAddress><!--optional, xs:string, MAC address--></macAddress>
<dynChannelID><!--optional, xs:string, digital channel No.--></dynChannelID>
<channelID><!--dependent, xs:string, channel No.--></channelID>
<dateTime>
<!--required, xs:datetime, event occurred time, which is in IOS 8601 format, e.g., 2017-04-22T15:39:01+08:00-->
</dateTime>
<activePostCount><!--required, xs:integer, event occurred times--></activePostCount>
<eventType><!--required, xs:string, event types, here it should be set to "ANPR"--></eventType>
<eventState><!--required, xs:string, event status (for persistent event): active, inactive--></eventState>
<eventDescription><!--required, xs:string, event description--></eventDescription>
<channelName><!--optional, xs:string, channel name--></channelName>
<deviceID><!--optional, xs:string, device ID--></deviceID>
<ANPR><!--dependent, this node is valid only when <eventType> is "ANPR"-->
<region><!--optional, xs:string, region--></region>
<country><!--optional, xs:string, country--></country>
<area><!--optional, xs:string, province or state--></area>
<licensePlate><!--required, xs:string, license plate number, e.g., "123456"--></licensePlate>
<line><!--required, xs:integer, recognized lane No.--></line>
<direction><!--optional, xs:string, license plate recognition direction: "reverse", "forward", "unknown"--></
direction>
<confidenceLevel><!--required, xs:integer, confidence level, which ranges from 0 to 100--></confidenceLevel>
<plateType><!--optional, xs:string, license plate type: "unknown", "arm"-police vehicle, "upDownMilitay"-military
vehicle (top-bottom type), "leftRightMilitay"-military vehicle (left-right type), "embassy"-embassy vehicle, "motorola"-
motorcycle, "coach"-driver-training vehicle, "tempTravl"-vehicle with temporary license plate, "trailer"-trailer,
"consulate"-consular vehicle, "tempEntry"-temporary vehicle, "newEnergy"-new energy vehicle--></plateType>
<plateColor>
<!--optional, xs:string, license plate color: "white", "yellow", "blue", "black", "green", "newEnergyGreen"-new
energy green, "newEnergyYellowGreen"-new energy flavogreen, "other"-other color-->
</plateColor>
<licenseBright>
<!--optional, xs:integer, license plate brightness, which ranges from 0 to 255-->
</licenseBright>
<Rect><!--optional, coordinates of the license plate thumbnail in the matched picture-->
<height><!--required, xs:float, height--></height>

310
Intelligent Security API (Traffic) Developer Guide

<width><!--required, xs:float, width--></width>


<x><!--required, xs:float, x-coordinate of the upper-left point--></x>
<y><!--required, xs:float, Y-coordinate of the upper-left point--></y>
</Rect>
<pilotsafebelt>
<!--optional, xs:string, whether the driver is wearing safety belt: "unknown, yes, no"-->
</pilotsafebelt>
<vicepilotsafebelt>
<!--optional, xs:string, whether the co-driver is wearing safety belt: "unknown, yes, no"-->
</vicepilotsafebelt>
<pilotsunvisor>
<!--optional, xs:string, whether the driver room's sun visor is open: "unknown, yes, no"-->
</pilotsunvisor>
<vicepilotsunvisor>
<!--required, xs:string, whether the co-driver room's sun visor is open: "unknown, yes, no"-->
</vicepilotsunvisor>
<envprosign><!--optional, xs:string, whether it is a yellow-label vehicle: "unknown,yes,no"--></envprosign>
<dangmark>
<!--optional, xs:string, whether it is dangerous goods vehicle: "unknown, yes, no"-->
</dangmark>
<uphone>
<!--optional, xs:string, whether the driver is making call: "unknown, yes, no"-->
</uphone>
<pendant>
<!--optional, xs:string, whether there is window hangings detected: "unknown, yes, no"-->
</pendant>
<tissueBox>
<!--optional, xs:string, whether there is tissue box detected: "unknown, yes, no"-->
</tissueBox>
<frontChild>
<!--optional, xs:string, whether the co-driver is with baby in arm: "unknown, yes, no"-->
</frontChild>
<label>
<!--optional, xs:string, whether there is label detected: "unknown, yes, no"-->
</label>
<decoration>
<!--optional, xs:string, whether there is decoration detected: "unknown, yes, no"-->
</decoration>
<smoking>
<!--optional, xs:string, whether there is smoking detected: "unknown, yes, no"-->
</smoking>
<perfumeBox>
<!--optional, xs:string, whether there is perfume box detected: "unknown, yes, no"-->
</perfumeBox>
<pdvs>
<!--optional, xs:string, whether there is a person sticking out of sunroof: "unknown, yes, no"-->
</pdvs>
<helmet>
<!--optional, xs:string, whether there is helmet detected: "unknown, yes, no"-->
</helmet>
<twoWheelVehicle>
<!--optional, xs:string, whether there is two-wheel detected: "unknown, yes, no"-->

311
Intelligent Security API (Traffic) Developer Guide

</twoWheelVehicle>
<threeWheelVehicle>
<!--optional, xs:string, whether there is three-wheel detected: "unknown, yes, no"-->
</threeWheelVehicle>
<blackness>
<!--optional, xs:integer, Ringelmann emittance, which is used for smoke detection-->
</blackness>
<plateCharBelieve>
<!--optional, xs:string, confidence of each character in the recognized license plate-->
</plateCharBelieve>
<speedLimit>
<!--optional, xs:integer, maximum speed limit, this node is valid only when overspeeding occurred-->
</speedLimit>
<illegalInfo>
<!--optional, illegal action information-->
<illegalCode>
<!--required, xs:string, illegal action code-->
</illegalCode>
<illegalName>
<!--required, xs:string, illegal action name-->
</illegalName>
<illegalDescription>
<!--optional, xs:string, illegal action description-->
</illegalDescription>
</illegalInfo>
<vehicleType>
<!--optional, xs:string, vehicle type: "unknown, largeBus, truck, vehicle, van, buggy, pedestrian, twoWheelVehicle,
threeWheelVehicle, SUVMPV, mediumBus, motorVehicle, nonmotorVehicle, smallCar, miniCar, pickupTruck"-->
</vehicleType>
<postPicFileName>
<!--optional, xs:string, name of the picture selected as the checkpoint picture when illegal action occurs, "none"
refers to not selecting any picture-->
</postPicFileName>
<featurePicFileName>
<!--optional, xs:string, name of the picture selected as the close-up picture when running the red light in the
intersection violation system is detected, "none" refers to not selecting any picture-->
</featurePicFileName>
<detectDir>
<!--optional, xs:integer, detection direction: 1-upward, 2-downward, 3-bidirectional, 4-westward, 5-northward, 6-
eastward, 7-southward, 8-other-->
</detectDir>
<detectType>
<!--optional, xs:integer, detection type: 1-inductive loop trigger, 2-video trigger, 3-multiple-frame recognition, 4-
radar trigger-->
</detectType>
<barrierGateCtrlType>
<!--optional, xs:integer, whether to enable elapsed time: 0-enabled, 1-disabled-->
</barrierGateCtrlType>
<alarmDataType>
<!--optional, xs:integer, 0-real-time data, 1-history data-->
</alarmDataType>
<dwIllegalTime>

312
Intelligent Security API (Traffic) Developer Guide

<!--optional, xs:integer, illegal action duration, which is the difference between the capture time of the last picture
and the capture time of the first picture, unit: millisecond-->
</dwIllegalTime>
<vehicleInfo>
<index>
<!--required, xs:integer, vehicle No.-->
</index>
<vehicleType>
<!--optional, xs:integer, vehicle type: 0-other vehicle, 1-small-sized vehicle, 2-large-sized vehicle, 3-pedestrian
trigger, 4-two wheeler trigger, 5-tricycle trigger-->
</vehicleType>
<colorDepth>
<!--required, xs:integer, shade of the vehicle color: 0-deep color, 1-light color-->
</colorDepth>
<color>
<!--required, xs:string, vehicle color: "unknown", "white", "silver"-silvery, "gray", "blacks"-balck, "red",
"deepBlue"-dark blue, "blue", "yellow", "green", "brown", "pink", "purple", "deepGray"-dark gray, "cyan", "orange"-->
</color>
<speed>
<!--required, xs:integer, vehicle speed, unit: km/h-->
</speed>
<length>
<!--required, xs:integer, length of the former vehicle, unit: decimeter-->
</length>
<vehicleLogoRecog>
<!--required, xs:integer, vehicle parent brand-->
</vehicleLogoRecog>
<vehileSubLogoRecog>
<!--optional, xs:integer, vehicle sub-brand-->
</vehileSubLogoRecog>
<vehileModel>
<!--optional, xs:integer, time to market of the vehicle sub-brand-->
</vehileModel>
<vehicleTypeByWeight>
<!--optional, xs:integer, 1-class one vehicle (buses with seven or less seats, trucks with capacity of 2 tons or less),
2-class two vehicle (buses with 8 to 19 seats, trucks with capacity of 2 to 5 (included) tons), 3-class three vehicle
(buses with 20 to 39 seats, trucks with capacity of 5 to 10 (included) tons), 4-class four vehicle (buses with 40 or more
seats, trucks with capacity of 10 to 15 (included) tons), 5-class five vehicle (trucks with capacity of more than 15 tons)--
>
</vehicleTypeByWeight>
</vehicleInfo>
<EntranceInfo>
<!--optional-->
<parkingID>
<!--optional, xs:string, parking space No.-->
</parkingID>
<gateID>
<!--optional, xs:string, entrance and exit No.-->
</gateID>
<direction>
<!--optional, xs:string, entering and exiting direction-->
</direction>

313
Intelligent Security API (Traffic) Developer Guide

<cardNo>
<!--optional, xs:string, card No.-->
</cardNo>
<parkType>
<!--optional, xs:string, parking type: "permanent", "temporary"-->
</parkType>
</EntranceInfo>
<pictureInfoList><!--required-->
<pictureInfo><!--required, xs:list-->
<fileName>
<!--required, xs:string, picture name, which must correspond to the picture name transmitted with the alarm
message-->
</fileName>
<type>
<!--required, xs:string, picture type: "detectionPicture, licensePlatePicture, pilotPicture, copilotPicture,
compositePicture, plateBinaryPicture, nonMotorPicture, pedestrianDetectionPicture, pedestrianPicture"-->
</type>
<dataType>
<!--required, xs:integer, data type: 0-upload data, 1-upload URL-->
</dataType>
<picRecogMode>
<!--optional, xs:integer, 0-front license plate recognition, 1-rear license plate recognition-->
</picRecogMode>
<redLightTime>
<!--optional, xs:integer, red light time elapsed, unit: second-->
</redLightTime>
<vehicleHead>
<!--optional, xs:integer, "unknown", "forward"-front license plate recognition, "back"-rear license plate
recognition-->
</vehicleHead>
<absTime>
<!--optional, xs:time, absolute time, format: yyyyMMddHHmmssxxx, e.g.: 20090810235959999, the last three
number is time in millisecond-->
</absTime>
<plateRect>
<!--dependent, the normalized value is the current image size in percentage multiplying 1000 and it is accurate
to three decimal places. This node is valid only when <type> is "detectionPicture"-->
<X>
<!--required, xs:integer, X-coordinate of the upper-left corner of the boundary frame-->
</X>
<Y>
<!--required, xs:integer, Y-coordinate of the upper-left corner of the boundary frame-->
</Y>
<width>
<!--required, xs:integer, width of the boundary frame-->
</width>
<height>
<!--required, xs:integer, height of the boundary frame-->
</height>
</plateRect>
<vehicelRect>
<!--dependent, the normalized value is the current image size in percentage multiplying 1000. This node is valid

314
Intelligent Security API (Traffic) Developer Guide

only when <type> is "detectionPicture"-->


<X><!--required, xs:integer, X-coordinate of the upper-left point of the boundary frame-->
</X>
<Y><!--required, xs:integer, Y-coordinate of the upper-left point of the boundary frame-->
</Y>
<width>
<!--required, xs:integer, width of the boundary frame-->
</width>
<height>
<!--required, xs:integer, height of the boundary frame-->
</height>
</vehicelRect>
<pictureURL>
<!--dependent, xs:string, picture URL, which is valid only when <dataType> is "URL"-->
</pictureURL>
</pictureInfo>
</pictureInfoList>
<hasMoreData>
<!--optional, xs:boolean, whether there is more data. This node is used to report the license plate information first,
and then report XML message with picture data; the XM message with picture data and license plate information are
linked by UUID-->
</hasMoreData>
<originalLicensePlate>
<!--optional, xs:string, original license plate number, When the license plate number is a minor language, return
the original license plate number-->
</originalLicensePlate>
<CRIndex>
<!--optional, xs:integer, country or region index-->
</CRIndex>
<VehicelGPSInfo><!--optional, GPS information of the vehicle-->
<longitudeType><!--required, xs:string, longitude, "E,W"--></longitudeType>
<latitudeType><!--required, xs:string, latitude, "S,N"--></latitudeType>
<Longitude><!--required, longitude information-->
<degree><!--required, xs:integer--></degree>
<minute><!--required, xs:integer--></minute>
<sec><!--required, xs:float, accurate to 6 decimal places--></sec>
</Longitude>
<Latitude><!--required, latitude information-->
<degree><!--required, xs:integer--></degree>
<minute><!--required, xs:integer,--></minute>
<sec><!--required, xs:float, accurate to 6 decimal places--></sec>
</Latitude>
</VehicelGPSInfo>
<vehiclePositionControl><!--optional, xs:string, arming type: "vehicleMonitor"-intelligent arming of vehicle (PUT /
ISAPI/Traffic/channels/<ID>/vehicleMonitor/<taskID>/startTask), "manualVehicleMonitor"-manual arming of vehicle
(PUT /ISAPI/Traffic/channels/<ID>/manualVehicleMonitor), "dailyVehicleMonitor"-daily arming of vehicle (you can
check whether this arming type is supported via the node isSupportDailyVehicleMonitor in the capability message
returned by /ISAPI/Traffic/channels/<ID>/vehicleDetect/capabilities; when daily arming of vehicle is enabled, both
alarm of ANPR and intelligent arming of vehicle will be uploaded; if this node is not returned, it is normal vehicle
detection--></vehiclePositionControl>
<vehicleMonitorTaskID><!--optional, xs:string, task ID of intelligent arming of vehicle, the maximum size is 64 bytes,
this node is returned when the value of vehiclePositionControl is "vehicleMonitor"--></vehicleMonitorTaskID>

315
Intelligent Security API (Traffic) Developer Guide

<vehicleListName><!--optional, xs:string, name of the list that the vehicle belongs to, the maximum size is 128
bytes--></vehicleListName>
</ANPR>
<UUID>
<!--optional, xs:string, common ID, which is used to link the same capture across multiple servers-->
</UUID>
<picNum>
<!--optional, xs:integer, number of pictures-->
</picNum>
<monitoringSiteID>
<!--optional, xs:string, camera No.-->
</monitoringSiteID>
<deviceID>
<!--optional, xs:string, device ID-->
</deviceID>
<ePlateUUID>
<!--optional, xs:string, electronic license plate ID. If this node is configured with a value, it indicates that an
electronic license plate is linked-->
</ePlateUUID>
<isDataRetransmission><!--optional, xs:boolean, data retransmission mark--></isDataRetransmission>
<SceneInfo><!--optional, scene information-->
<scenesID><!--optional, xs:string, scene ID, value range: [1,16]--></scenesID>
<sceneName><!--optional, xs:string, scene name, the maximum size is 32 bytes--></sceneName>
<PTZPos><!--optional, PTZ information-->
<elevation><!--optional, xs:integer, value range: [-900,2700]--></elevation>
<azimuth><!--optional, xs:integer, value range: [0,3600]--></azimuth>
<absoluteZoom><!--optional, xs:integer, value range: [0,1000]--></absoluteZoom>
</PTZPos>
</SceneInfo>
<monitorDescription><!--optional, xs:string, camera information--></monitorDescription>
</EventNotificationAlert>

B.141 XML_EventNotificationAlert_HeartbeatInfo
EventNotificationAlert message with heartbeat information (when there is no alarm is triggered) in
XML format
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ipv6Address><!--dep, xs:string, device IPv6 address--></ipv6Address>
<portNo><!--opt, xs:integer, device port number--></portNo>
<protocol><!--opt, xs:string, protocol type for uploading alarm/event information, "HTTP,HTTPS"--></protocol>
<macAddress><!--opt, xs:string, MAC address--></macAddress>
<channelID><!--dep, xs:string, device channel No., starts from 1--></channelID>
<dateTime><!--req, heartbeat uploaded time, format: 2017-07-19T10:06:41+08:00--></dateTime>
<activePostCount><!--req, xs:integer, heartbeat frequency, starts from 1--></activePostCount>
<eventType><!--req, xs:string, for heartbeat, it is "videoloss"--></eventType>
<eventState>
<!--req, xs:string, for heartbeat, it is "inactive"-->
</eventState>

316
Intelligent Security API (Traffic) Developer Guide

<eventDescription><!--req, xs: string, description--></eventDescription>


</EventNotificationAlert>

Remarks
• For network camera or network speed dome with the version 5.5.0 and lower, the heartbeat
frequency is 300 ms per heartbeat.
• For network camera or network speed dome with the version 5.5.0 and higher, the heartbeat
frequency is 10 s per heartbeat. If no heartbeat received for continuous 30 s, it indicates that the
heartbeat is timed out.
Example
Message Example of Heartbeat
<EventNotificationAlert version="2.0" xmlns="http://www.isapi.com/ver20/XMLSchema">
<ipAddress>10.17.133.46</ipAddress>
<portNo>80</portNo>
<protocol>HTTP</protocol>
<macAddress>44:19:b6:6d:24:85</macAddress>
<channelID>1</channelID>
<dateTime>2017-05-04T11:20:02+08:00</dateTime>
<activePostCount>0</activePostCount>
<eventType>videoloss</eventType>
<eventState>inactive</eventState>
<eventDescription>videoloss alarm</eventDescription>
</EventNotificationAlert>

B.142 XML_EventTrigger
Linkage parameter message in XML format
<EventTrigger version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:string, ID--></id>
<eventType>
<!--required, xs:string, see details in the "Remarks" below-->
</eventType>
<eventDescription><!--optional, xs:string--></eventDescription>
<inputIOPortID><!--dependent, xs:string, alarm input ID--></inputIOPortID>
<dynInputIOPortID><!--dependent, xs:string, dynamic alarm input ID--></dynInputPortID>
<videoInputChannelID>
<!--dependent, xs:string, video input channel ID, it is valid when <eventType> is "VMD, videoloss, tamperdetection,
regionEntrance, regionExiting, loitering, group, rapidMove, parking, unattendedBaggage, attendedBaggage"-->
</videoInputChannelID>
<dynVideoInputChannelID><!--dependent, xs:string, dynamic video input channel ID--></dynVideoInputChannelID>
<intervalBetweenEvents><!--optional, xs:integer, event time interval, unit: second--></intervalBetweenEvents>
<WLSensorID><!--dependent, xs:string, ID--></WLSensorID>
<EventTriggerNotificationList/><!--optional, alarm/event linkage actions, see details in the message of
XML_EventTriggerNotificationList-->
</EventTrigger>

317
Intelligent Security API (Traffic) Developer Guide

Remarks
The node <eventType> can be the following values: IO, VMD, videoloss, raidfailure,
recordingfailure, badvideo, POS, analytics, fanfailure, overheat, tamperdetection, diskfull, diskerror,
nicbroken, ipconflict, illaccess, videomismatch, resolutionmismatch, radifailure, PIR, WLSensor,
spareException, poePowerException, heatmap, counting, linedetection, fielddetection,
regionEntrance, regionExiting, loitering, group,rapidMove, parking, unattendedBaggage,
attendedBaggage, HUMANATTRIBUTE, blackList, whitelist, peopleDetection, allVehicleList,
otherVehicleList, vehicledetection, storageDetection, shipsDetection, humanAttribute,
faceContrast, blackListFaceContrast, whiteListFaceContrast, faceSnap, faceLib,
personDensityDetection, personQueueDetecton, mixedTargetDetection, HVTVehicleDetection,
illegalParking, pedestrian, trafficAccident, construction, roadblock, abandonedObject,
parallelParking, parkingState, congestion, intersectionAnalysis, heatMap, thermometry,
shipsFlowDetection, dredgerDetection, reverseEntrance, luma, highHDTemperature,
lowHDTemperature, hdImpact, hdBadBlock, SevereHDFailure, safetyHelmetDetection,
vibrationDetection, HBDLib,TMPA,faceThermometry,noMaskDetection
See Also
XML_EventTriggerNotificationList

B.143 XML_EventTriggerCapType
XML message about capability of alarm linkage action types
<EventTriggerCapType version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportCenter><!--optional, xs:boolean--></isSupportCenter>
<isSupportRecord><!--optional, xs:boolean--></isSupportRecord>
<isSupportMonitorAlarm><!--optional, xs:boolean--></isSupportMonitorAlarm>
<isSupportBeep><!--optional, xs: boolean, whether it supports audible warning--></isSupportBeep>
<isSupportIO><!--optional, xs:boolean--></isSupportIO>
<isSupportFTP><!--optional, xs:boolean--></isSupportFTP>
<isSupportEmail><!--optional, xs:boolean--></isSupEmail>
<isSupportLightAudioAlarm><!--optional, xs:boolean--></isSupportLightAudioAlarm>
<isSupportFocus><!--optional, xs:boolean--></isSupportFocus>
<isSupportPTZ><!--optional, xs:boolean--></isSupportPTZ>
<maxPresetActionNum>
<!--dependent, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPresetActionNum>
<maxPatrolActionNum>
<!--dependent, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPatrolActionNum>
<maxPatternActionNum>
<!--dependent, xs:integer, it is valid only when <isSupportPTZ> is "true"-->
</maxPatternActionNum>
<isSupportTrack><!--optional, xs:boolean, whether it supports PTZ linked tracking--></isSupportTrack>
<isSupportWhiteLight>
<!--optional, xs: boolean, whether it supports supplement light alarm linkage-->

318
Intelligent Security API (Traffic) Developer Guide

</isSupportWhiteLight>
<isSupportCloud><!--optional, xs:boolean, whether it supports upload to the cloud--></isSupportCloud>
<targetNotificationInterval max="1000" min="0" default="30"><!--xs:integer, range: [0, 1000], the default value is 30,
unit: seconds, this node is valid for <MotionDetectionTriggerCap> and <TamperDetectionTriggerCap> and this node is
valid when <isSupportPTZ> is "true"--></targetNotificationInterval>
<direction opt="both,forward,reverse"><!--xs:string, triggering direction, this node is valid for the node
<BlackListTriggerCap>, <WhiteListTriggerCap>, and <VehicleDetectionTriggerCap>--></direction>
<presetDurationTime min="" max=""><!--dependent, xs:integer--></presetDurationTime>
<isSupportSMS><!--optional, xs:boolean, whether to support SMS (Short Message Service)--></isSupportSMS>
<maxCellphoneNum><!--dependent, xs:integer, the maximum number of cellphones, which is node is valid only
when <isSupportSMS> is "true"--></maxCellphoneNum>
<isSupportOSD><!--optional, xs:boolean--></isSupportOSD>
<isSupportAudio><!--optional, xs:boolean, whether it supports setting audio alarm independently. If this node is set
to "true", audio alarm and buzzer alarm can be linked separately, and the linage method is audio--></isSupportAudio>
<AudioAction><!--dependent, this node is valid when <isSupportBeep> is "true" or <isSupportAudio> is "true"-->
<audioTypeList>
<audioType><!--list-->
<audioID><!--required, xs:integer, alarm sound type--></audioID>
<audioDescription><!--required, xs:string, alarm sound description, it should correspond to the alarm sound type--
></audioDescription>
</audioType>
</audioTypeList>
<alarmTimes opt="0,1,2,3,4,5,6,7,8,9,255"><!--required, xs:integer, alarm times, it is between 0 and 9, 255-
continuous alarm, unit: time--></alarmTimes>
</AudioAction>
<isSupportSMS><!--optional, xs:boolean --></isSupportSMS>
<maxCellphoneNum><!--dependent, if <isSupportSMS> is true, xs:integer--></maxCellphoneNum>
<isNotSupportCenterModify><!--optional, xs:boolean, whether editing configuration parameters of the surveillance
center is not supported: "true"-yes (configuration parameters of the surveillance center cannot be edited), "false" or
this node is not returned-no (configuration parameters of the surveillance center can be edited)--></
isNotSupportCenterModify>
<isSupportMessageConfig>
<!--optional, xs:boolean, whether it supports SMS configuration, if supports, set cellphoneNumber to null-->
</isSupportMessageConfig>
<isSupportAnalogOutput><!--optional, xs:boolean, whether it supports IO output of linkage analog channel--></
isSupportAnalogOutput>
<isSupportIOOutputUnify><!--optional, xs:boolean, whether it supports configuration of IO output--></
isSupportIOOutputUnify>
<isSupportFaceContrast><!--optional, xs:boolean, whether it supports face picture comparison linkage--></
isSupportFaceContrast>
<isSupportSiren><!--optional, xs:boolean, whether it supports siren linkage--></isSupportSiren>
<isSupportOutput><!--optional, xs:boolean, whether it supports relay linkage--></isSupportOutput>
</EventTriggerCapType>

B.144 XML_EventTriggerNotification
Event linkage notification message in XML format
<EventTriggerNotification><!--opt-->
<id><!--required, xs:string, device ID--></id>

319
Intelligent Security API (Traffic) Developer Guide

<notificationMethod>
<!--required, xs:string, linkage actions, opt="email,IM,IO,syslog,HTTP,FTP,beep,ptz,record, monitorAlarm, center,
LightAudioAlarm,focus,trace,cloud,SMS,whiteLight,audio,whiteLight,faceContrast,siren,output"-->
</notificationMethod>
<notificationRecurrence>
<!--optional, xs:string, "beginning,beginningandend,recurring"-->
</notificationRecurrence>
<notificationInterval><!--dependent, xs:integer, unit: millisecond--></notificationInterval>
<outputIOPortID><!--dependent, xs:string, video output No., it is required only when notificationMethod is "IO"--></
outputIOPortID>
<dynOutputIOPortID><!--dependent, xs:string, dynamic video output No., it is required only when
notificationMethod is "IO"--></dynOutputIOPortID>
<videoInputID><!--dependent, xs:string, video input No., it is required only when notificationMethod is "record"--></
videoInputID>
<dynVideoInputID><!--dependent, xs:string, dynamic video input No., it is required only when notificationMethod is
"record"--></dynVideoInputID>
<ptzAction><!--dependent, it is required only when notificationMethod is "ptz"-->
<ptzChannelID><!--required, xs:string, PTZ channel ID--></ptzChannelID>
<actionName><!--required, xs:string, PTZ control type: "preset", "pattern", "patrol"--></actionName>
<actionNum><!--dependent, xs:integer></actionNum>
</ptzAction>
<WhiteLightAction><!--dependent, white light linkage parameters, this node is valid when notificationMethod is
"whiteLight"-->
<whiteLightDurationTime><!--required, xs:integer, white light flashing duration, it is between 1 and 60, unit:
second--></whiteLightDurationTime>
</WhiteLightAction>
<cellphoneNumber><!--dependent, xs:string, min="0" max="11",cellphone number--></cellphoneNumber-->
</EventTriggerNotification>

B.145 XML_EventTriggerNotificationList
EventTriggerNotificationList message in XML format
<EventTriggerNotificationList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<EventTriggerNotification/><!--opt, see details in the message of XML_EventTriggerNotification-->
</EventTriggerNotificationList>

See Also
XML_EventTriggerNotification

B.146 XML_EventTriggersCap
XML message about linkage capabilities of different alarm categories
<EventTriggersCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<DiskfullTriggerCap><!--optional, xs: EventTriggerCapType--></DiskfullTriggerCap>
<DiskerrorTriggerCap><!--optional, xs: EventTriggerCapType--></DiskerrorTriggerCap>
<NicbrokenTriggerCap><!--optional, xs: EventTriggerCapType--></NicbrokenTriggerCap>

320
Intelligent Security API (Traffic) Developer Guide

<IpconflictTriggerCap><!--optional, xs: EventTriggerCapType--></IpconflictTriggerCap>


<IllaccesTriggerCap><!--optional, xs: EventTriggerCapType--></IllaccesTriggerCap>
<BadvideoTriggerCap><!--optional, xs: EventTriggerCapType--></BadvideoTriggerCap>
<VideomismatchTriggerCap><!--optional, xs: EventTriggerCapType--></VideomismatchTriggerCap>
<IOTriggerCap><!--optional, xs: EventTriggerCapType--></IOTriggerCap>
<LineDetectTriggerCap><!--optional, xs: EventTriggerCapType--></LineDetectTriggerCap>
<RegionEntranceTriggerCap><!--optional, xs: EventTriggerCapType--></RegionEntranceTriggerCap>
<RegionExitingTriggerCap><!--optional, xs: EventTriggerCapType--></RegionExitingTriggerCap>
<LoiteringTriggerCap><!--optional, xs: EventTriggerCapType--></LoiteringTriggerCap>
<GroupDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></GroupDetectionTriggerCap>
<RapidMoveTriggerCap><!--optional, xs: EventTriggerCapType--></RapidMoveTriggerCap>
<ParkingTriggerCap><!--optional, xs: EventTriggerCapType--></ParkingTriggerCap>
<UnattendedBaggageTriggerCap><!--optional, xs: EventTriggerCapType--></UnattendedBaggageTriggerCap>
<AttendedBaggageTriggerCap><!--optional, xs: EventTriggerCapType--></AttendedBaggageTriggerCap>
<FireDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></FireDetectionTriggerCap>
<FireDetectionCap><!--optional, xs: EventTriggerCapType--></FireDetectionCap>
<StorageDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></StorageDetectionTriggerCap>
<ShipsDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></ShipsDetectionTriggerCap>
<ThermometryCap><!--optional, xs: EventTriggerCapType--></ThermometryCap>
<VandalProofTriggerCap><!--optional, xs: EventTriggerCapType--></VandalProofTriggerCap>
<BlackListTriggerCap><!--opt, xs: EventTriggerCapType, configuration capability of blacklist arming linkage--></
BlackListTriggerCap>
<WhiteListTriggerCap><!--opt, xs: EventTriggerCapType, configuration capability of whitelist arming linkage--></
WhiteListTriggerCap>
<AllVehicleListTriggerCap><!--optional,xs:EventTriggerCapType, configuration capability of other list arming linkage--
></AllVehicleListTriggerCap>
<OtherVehicleListTriggerCap><!--optional,xs:EventTriggerCapType--></OtherVehicleListTriggerCap>
<PeopleDetectionTriggerCap><!--optional,xs:EventTriggerCapType--></PeopleDetectionTriggerCap>
<PIRAlarmCap><!--optional, xs: EventTriggerCapType--></PIRAlarmCap>
<TamperDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></TamperDetectionTriggerCap>
<DefocusDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></DefocusDetectionTriggerCap>
<FaceDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></FaceDetectionTriggerCap>
<SceneChangeDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></SceneChangeDetectionTriggerCap>
<VandalProofAlarmCap><!--optional, xs: EventTriggerCapType--></VandalProofAlarmCap>
<JudgmentTriggerCap><!--optional, xs: EventTriggerCapType--></JudgmentTriggerCap>
<FightingTriggerCap><!--optional, xs: EventTriggerCapType--></FightingTriggerCap>
<RisingTriggerCap><!--optional, xs: EventTriggerCapType--></RisingTriggerCap>
<DozingTriggerCap><!--optional, xs: EventTriggerCapType--></DozingTriggerCap>
<CountingTriggerCap><!--optional, xs: EventTriggerCapType--></CountingTriggerCap>
<VideoLossTriggerCap><!--optional, xs: EventTriggerCapType--></VideoLossTriggerCap>
<HideTriggerCap><!--optional, xs:EventTriggerCapType--></HideTriggerCap>
<AlarmInTriggerCap><!--optional, xs: EventTriggerCapType--></AlarmInTriggerCap>
<VehicleDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></VehicleDetectionTriggerCap>
<AudioExceptionCap><!--optional, xs: EventTriggerCapType--></AudioExceptionCap>
<FiledDetectTriggerCap><!--optional, xs: EventTriggerCapType--></FiledDetectTriggerCap>
<MotionDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></MotionDetectionTriggerCap>
<TemperatureCap><!--optional, xs: EventTriggerCapType--></TemperatureCap>
<IntelligentTriggerCap><!--optional, xs: EventTriggerCapType--></IntelligentTriggerCap>
<FaceContrastTriggerCap><!--optional, xs: EventTriggerCapType, face picture comparison alarm linkage--></
FaceContrastTriggerCap>
<PersonDensityDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></PersonDensityDetectionTriggerCap>
<PersonQueueDetectionTriggerCap><!--optional, xs: EventTriggerCapType, queue management alarm linkage--></

321
Intelligent Security API (Traffic) Developer Guide

PersonQueueDetectionTriggerCap>
<HumanRecognitionTriggerCap><!--optional,xs: EventTriggerCapType--></HumanRecognitionTriggerCap>
<FaceSnapTriggerCap><!--optional, xs: EventTriggerCapType--></FaceSnapTriggerCap>
<isSupportWhiteLightAction>
<!--dependent, xs: boolean, see details in EventTriggerCapType, it is valid when isSupportWhiteLight is "true"-->
</isSupportWhiteLightAction>
<isSupportAudioAction>
<!--dependent, xs: boolean, see details in EventTriggerCapType, it is valid when isSupportBeep is "true"-->
</isSupportAudioAction>
<HFPDTriggerCap><!--optional, xs: EventTriggerCapType--></HFPDTriggerCap>
<MixedTargetDetectionCap><!--optional, xs: EventTriggerCapType--></MixedTargetDetectionCap>
<HVTVehicleDetectionTriggerCap><!--optional, xs: EventTriggerCapType--></HVTVehicleDetectionTriggerCap>
<VCATriggerCap><!--optional, xs: EventTriggerCapType--></VCATriggerCap>
<PIRCap><!--optional, xs: EventTriggerCapType--></PIRCap>
<IllegalParkingTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports illegal parking detection--></
IllegalParkingTriggerCap>
<PedestrianTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports pedestrian detection--></
PedestrianTriggerCap>
<TrafficAccidentTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports traffic accident detection--></
TrafficAccidentTriggerCap>
<ConstructionTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports construction detection--></
ConstructionTriggerCap>
<RoadBlockTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports roadblock detection--></
RoadBlockTriggerCap>
<AbandonedObjectTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports objects dropped down
detection--></AbandonedObjectTriggerCap>
<ParallelParkingTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports parallel parking detection--></
ParallelParkingTriggerCap>
<ParkingStateTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports parking space status detection,
currently this node is not supported--></ParkingStateTriggerCap>
<CongestionTriggerCap><!--optional, xs: EventTriggerCapType, whether it supports congestion detection--></
CongestionTriggerCap>
<IntersectionAnalysisCap><!--optional, xs: EventTriggerCapType, whether it supports intersection analysis--></
IntersectionAnalysisCap>
<ShipsFlowDetectionTriggerCap><!--optional,xs:EventTriggerCapType, ship flow detection--></
ShipsFlowDetectionTriggerCap>
<dredgerDetectionTriggerCap><!--optional,xs:EventTriggerCapType, dredger detection--></
dredgerDetectionTriggerCap>
<voltageInstableTriggerCap><!--optional,xs:EventTriggerCapType, supply voltage exception--></
voltageInstableTriggerCap>
<HighHDTemperatureTriggerCap><!--optional, xs:EventTriggerCapType, HDD high temperature detection--></
HighHDTemperatureTriggerCap>
<LowHDTemperatureTriggerCap><!--optional, xs:EventTriggerCapType, HDD low temperature detection--></
LowHDTemperatureTriggerCap>
<HDImpactTriggerCap><!--optional, xs:EventTriggerCapType, HDD impact detection--></HDImpactTriggerCap>
<HDBadBlockTriggerCap><!--optional, xs:EventTriggerCapType, HDD bad sector detection--></
HDBadBlockTriggerCap>
<SevereHDFailureTriggerCap><!--optional, xs:EventTriggerCapType, HDD severe fault detection--></
SevereHDFailureTriggerCap>
<HUMANATTRIBUTECap><!--optional, xs:EventTriggerCapType--></HUMANATTRIBUTECap>
<HumanAttributeTriggerCap><!--optional, xs:EventTriggerCapType, human body attribute--></
HumanAttributeTriggerCap>

322
Intelligent Security API (Traffic) Developer Guide

<BlackListFaceContrastTriggerCap><!--opt, xs:EventTriggerCapType, alarm linkage capability of blacklist face


comparison--></BlackListFaceContrastTriggerCap>
<FaceLibTriggerCap><!--optional, xs:EventTriggerCapType--></FaceLibTriggerCap>
<SafetyHelmetDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of hard hat
detection--></SafetyHelmetDetectionTriggerCap>
<VibrationDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of vibration detection--
></VibrationDetectionTriggerCap>
<RadarLineDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of radar line crossing
detection--></RadarLineDetectionTriggerCap>
<RadarFieldDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of radar intrusion
detection--></RadarFieldDetectionTriggerCap>
<HBDLibTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of human body picture library--></
HBDLibTriggerCap>
<FaceThermometryCap><!--optional, xs:EventTriggerCapType--></FaceThermometryCap>
<NoMaskDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of no wearing mask
detection--></NoMaskDetectionTriggerCap>
<TMPATriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of temperature measurement pre-
alarm--></TMPATriggerCap>
<FireEscapeDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of fire engine access
detection--></FireEscapeDetectionTriggerCap>
<TakingElevatorDetectionTriggerCap><!--optional, xs:EventTriggerCapType, alarm linkage capability of elevator
detection--></TakingElevatorDetectionTriggerCap>
<RuleTriggerCap><!--optional, linkage capability of rule triggered alarm -->
<isSupportCityManagement>
<!--optional, xs:boolean, whether the city management supports setting linkage actions by area; if supports, the
value is true, otherwise, this node will not be returned-->
</isSupportCityManagement>
</RuleTriggerCap>
</EventTriggersCap>

See Also
XML_EventTriggerCapType

B.147 XML_EvidenceDictionary
EvidenceDictionary message in XML format
<EvidenceDictionary version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<EvidenceCodeList><!--req-->
<EvidenceCodeItem><!--req-->
<idx><!--req, xs: integer, law enforcement No.--></idx>
<evidenceCode><!--req, xs: string, law enforcement code--></evidenceCode>
<evidenceName><!--req, xs: string, law enforcement name--></evidenceName>
<deletable>
<!--opt, xs: boolean, whether the law enforcement can be deleted: true-yes, false-no-->
</deletable>
</EvidenceCodeItem>
</EvidenceCodeList>
</EvidenceDictionary>

323
Intelligent Security API (Traffic) Developer Guide

B.148 XML_EvidenceDictionaryCap
EvidenceDictionaryCap message in XML format
<EvidenceDictionaryCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<EvidenceCodeList><!--req-->
<EvidenceCodeItem><!--req-->
<idx min="0" max="64"><!--req, xs: integer, law enforcement No.--></idx>
<evidenceCode min="0" max=" 64"><!--req, xs: string, law enforcement code--></evidenceCode>
<evidenceName min="0" max="64"><!--req, xs: string, law enforcement name--></evidenceName>
<deletable opt="true,false"><!--whether the law enforcement can be deleted: true-yes, false-no--></deletable>
</EvidenceCodeItem>
</EvidenceCodeList>
<isSupportReset opt="true,false">
<!--opt, xs: boolean, whether supports restoring to default settings, if not support, this node will not be returned-->
</isSupportReset>
</EvidenceDictionaryCap>

B.149 XML_Exposure
Exposure message in XML format
<Exposure version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ExposureType/><!--req, xs:string, "auto, IrisFirst, ShutterFirst, gainFirst, manual, pIris, T5280-PQ1, T5289-PQ1,
T1140-PQ1, T2712-PQ1, HV1250P-MPIR, pIris-General"-->
<autoIrisLevel>
<!--dep, xs:integer-->
</autoIrisLevel>
<OverexposeSuppress><!--opt-->
<enabled>
<!--req, xs:boolean-->
</enabled>
<Type>
<!--dep, xs:string, this node depends on <enabled>, "AUTO,MANUAL"-->
</Type>
<DistanceLevel>
<!--dep, xs: integer, this node depends on <Type>-->
</DistanceLevel>
<shortIRDistanceLevel>
<!--dep, xs: integer, this node depends on <Type>-->
</shortIRDistanceLevel>
<longIRDistanceLevel>
<!--dep, xs: integer, this node depends on <Type>-->
</longIRDistanceLevel>
</OverexposeSuppress>
<pIris><!--opt-->
<pIrisType/><!--dep, xs:string, this node depends on <ExposureType>, "AUTO,MANUAL"-->
<IrisLevel>
<!--dep, xs:integer, this node depends on <pIrisType>-->

324
Intelligent Security API (Traffic) Developer Guide

</IrisLevel>
</pIris>
<PIrisGeneral><!--dep, it is available when <ExposureType> is set to "pIris-General"-->
<irisLevel>
<!--opt, iris level of general lens, which is between 1 and 100, the default level is 50-->
</irisLevel>
</PIrisGeneral>
<exposureLevel>
<!--opt, xs:integer , this node depends on <ExposureType>-->
</exposureLevel>
<faceExposure><!--opt, face exposure-->
<enabled opt="true,false">
<!--opt, xs:boolean, whether to enable face exposure-->
</enabled>
<sensitivity min="0" max="100">
<!--opt, xs:integer, sensitivity-->
</sensitivity>
</faceExposure>
</Exposure>

B.150 XML_FaceChannelMatchCfg
FaceChannelMatchCfg message in XML format
<FaceChannelMatchCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable><!--req, xs: boolean, whether to enable camera matching: false-no (default), true-yes--></enable>
</FaceChannelMatchCfg>

B.151 XML_FaceChannelMatchElement
FaceChannelMatchElement message in XML format
<FaceChannelMatchElement version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable><!--req, xs: boolean, whether to enable this function: false-no (default), true-yes--></enable>
<id><!--req, xs: integer, linked group ID--></id>
<illegalChan>
<!--req, xs: string, intersection monitoring system channel ID, each ID should be separated by comma-->
</illegalChan>
<normalChan><!--req, xs: string, checkpoint channel ID, each ID should be separated by comma--></normalChan>
</FaceChannelMatchElement>

B.152 XML_FaceChannelMatchList
FaceChannelMatchList message in XML format

325
Intelligent Security API (Traffic) Developer Guide

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


<FaceChannelMatchElement/><!--refer to the message XML_FaceChannelMatchElement for details-->
</FaceChannelMatchList>

See Also
XML_FaceChannelMatchElement

B.153 XML_FaceChannelMatchStatus
FaceChannelMatchStatus message in XML format
<FaceChannelMatchStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<matchList>
<matchElement><!--list-->
<id><!--req, xs: integer, linked group ID--></id>
<matchstatus><!--req, xs: string, real-time matching status, the maximum length is 32 bytes--></matchstatus>
</matchElement>
</matchList>
</FaceChannelMatchStatus>

B.154 XML_FaceEvidenceCap
FaceEvidenceCap message in XML format
<FaceEvidenceCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<FaceEvidenceCfg/><!--refer to the message XML_FaceEvidenceCfg for details-->
<FaceChannelMatchCap>
<FaceChannelMatchCfg/><!--refer to the message XML_FaceChannelMatchCfg for details-->
<FaceChannelMatchList>
<FaceChannelMatchElement/><!--refer to the message XML_FaceChannelMatchElement for details-->
</FaceChannelMatchList>
<FaceChannelMatchStatus/><!--refer to the message XML_FaceChannelMatchStatus for details-->
<UnusedChannel/><!--refer to the message XML_UnusedChannel for details-->
</FaceChannelMatchCap>
</FaceEvidenceCap>

See Also
XML_FaceEvidenceCfg
XML_FaceChannelMatchCfg
XML_FaceChannelMatchElement
XML_FaceChannelMatchStatus
XML_UnusedChannel

326
Intelligent Security API (Traffic) Developer Guide

B.155 XML_FaceEvidenceCfg
FaceEvidenceCfg message in XML format
<FaceEvidenceCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enableMatch>
<!--req, xs: boolean, whether to enable face evidence: false-no (default), true-yes-->
</enableMatch>
<enableMerge>
<!--req, xs: boolean, whether to enable composition: false-no (default), true-yes-->
</enableMerge>
<enableFuzzyMatch>
<!--req, xs: boolean, whether to enable fuzzy matching: false-no (default), true-yes-->
</enableFuzzyMatch>
<twoPicMergeStyle><!--req, xs: integer, method to compose two pictures--></twoPicMergeStyle>
<threePicMergeStyle><!--req, xs: integer, method to compose three pictures--></threePicMergeStyle>
<fourPicMergeStyle><!--req, xs: integer, method to compose four pictures--></fourPicMergeStyle>
<matchPreTime><!--req, xs: integer, pre-matching time--></matchPreTime>
<matchDelayTime><!--req, xs: integer, post-matching time--></matchDelayTime>
<orignalPicScale>
<!--req, xs: integer, zooming rate of captured picture: 0, 1, 2, 3, 4-->
</orignalPicScale>
<maxMergedPicSize>
<!--req, xs: integer, maximum size of composed picture, unit: KB, value range: [200, 4096]-->
</maxMergedPicSize>
<trafficViolationDataList>
<!--req, xs: string, data type: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19-->
</trafficViolationDataList>
</FaceEvidenceCfg>

B.156 XML_FortifyLinkStatus
FortifyLinkStatus message in XML format
<FortifyLinkStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<fortifyLinkCount>
<!--opt, xs:integer, number of arming connections-->
</fortifyLinkCount>
<FortifyLinkIPList>
<FortifyLinkIP>
<fortifyLinkPriority>
<!--opt, xs:integer, arming level (level 1, level 2, level 3)-->
</fortifyLinkPriority>
<addressingFormatType opt="ipaddress,hostname">
<!--req, xs:string, "ipaddress", "hostname"-->
</addressingFormatType>
<hostName>
<!--dep, xs:string, host name-->
</hostName>

327
Intelligent Security API (Traffic) Developer Guide

<ipAddress>
<!--dep, xs:string, IPv4 address-->
</ipAddress>
<ipv6Address>
<!--dep, xs:string, IPv6 address-->
</ipv6Address>
</FortifyLinkIP>
</FortifyLinkIPList>
</FortifyLinkStatus>

B.157 XML_FortifyStatus
FortifyStatus message in XML format
<FortifyStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<channel><!--req, xs: integer--></channel>
<loginState><!--req, xs: boolean, "true,flase"--></loginState>
<fortifyState><!--req, xs: boolean, "true,flase"--></fortifyState>
<fortifyLevel><!--req, xs: integer--></fortifyLevel>
<lastFortifyHeartbeatTime><!--req, xs: string--></lastFortifyHeartbeatTime>
<fortifyInfo><!--opt, xs: string, "Disabled,Ok,Error"--></fortifyInfo>
</FortifyStatus>

B.158 XML_FortifyStatusList
FortifyStatusList message in XML format
<FortifyStatusList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<FortifyStatus/><!--refer to XML_FortifyStatus for details-->
</FortifyStatusList>

See Also
XML_FortifyStatus

B.159 XML_Gain
Gain message in XML format
<Gain version="1.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<GainLevel/><!--dep, xs:integer, this node is valid when <ExposureType> in the message XML_Exposure is
"GainFisrt"-->
<GainWindow><!--opt-->
<RegionCoordinatesList><!--opt-->
<RegionCoordinates><!--opt-->
<positionX><!--req, xs: integer; x-coordinate--></positionX>
<positionY><!--req, xs: integer; y-coordinate--></positionY>

328
Intelligent Security API (Traffic) Developer Guide

</RegionCoordinates>
</RegionCoordinatesList>
</GainWindow>
</Gain>

See Also
XML_Exposure

B.160 XML_gammaCorrection
gammaCorrection message in XML format
<gammaCorrection version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<gammaCorrectionEnabled><!--opt, xs:boolean--></gammaCorrectionEnabled>
<gammaCorrectionLevel><!--opt, xs:integer--></gammaCorrectionLevel>
</gammaCorrection>

B.161 XML_GPSCap
GPSCap message in XML format
<GPSCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<GPSStatus>
<timingState min="" max="">
<!--req, xs: integer, 0-unknown GPS device, 2-the GPS device is not connected, 3-the GPS device is time
synchronized, 4-synchronizing GPS device time exception, 5-invalid GPS data-->
</timingState>
</GPSStatus>
</GPSCap>

B.162 XML_GPSStatus
GPSStatus message in XML format
<GPSStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<timingState min="" max="">
<!--req, xs: integer, 0-unknown GPS device, 2-the GPS device is not connected, 3-the GPS device is time
synchronized, 4-synchronizing GPS device time exception, 5-invalid GPS data-->
</timingState>
</GPSStatus>

B.163 XML_GrayRange
GrayRange message in XML format

329
Intelligent Security API (Traffic) Developer Guide

<GrayRange>
<grayValueType>
<!--req, xs:string, grayscale value type: "hightContrast"-high contrast with less details in the dark space (grayscale
range: [0, 255]), "moreDetail"-low contrast with more details in the dark space (grayscale range: [16, 235])-->
</grayValueType>
</GrayRange>

B.164 XML_Hdr
Hdr message in XML format
<Hdr version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<hdrMode>
<!--req, xs:string, WDR (Wide Dynamic Range) mode: "close", "realHdr"-WDR, "digitalHdr"-digital WDR. WDR mode
will be displayed according to the capability, and <HdrSwitch> and <HdrLevel> are invalid when this node is set to
"close"-->
</hdrMode>
<HdrSwitch>
<hdrSwitchMode>
<!--req, xs:string, WDR switching mode: "open", "timeCtrl"-enable by time, "lightCtrl"-enable by brightness.
<timeSwitch> nad <lightSwitch> are invalid when this node is set to "open"-->
</hdrSwitchMode>
<timeSwitch>
<!--req, this node is valid only when <hdrSwitchMode> is "timeCtrl"-->
<startHour>
<!--dep, xs:integer, start hour, which ranges from 0 to 23-->
</startHour>
<startMinute>
<!--dep, xs:integer, start minute, which ranges from 0 to 59-->
</startMinute>
<endHour>
<!--dep, xs:integer, end hour, which ranges from 0 to 23-->
</endHour>
<endMinute>
<!--dep, xs:integer, end minute, which ranges from 0 to 59-->
</endMinute>
</timeSwitch>
</HdrSwitch>
<hdrLevel>
<!--dep, xs:string, WDR level: "level1,level2,level3,level4,level5,level6,level7", this node depends on
<HdrSwitchMode>-->
</hdrLevel>
</Hdr>

B.165 XML_HttpHostNotification
XML message about parameters of a HTTP listening server

330
Intelligent Security API (Traffic) Developer Guide

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


<id><!--required, xs:string, ID--></id>
<url><!--required, xs:string, the absolute path, e.g., http://<ipAddress>:<portNo>/<uri>--></url>
<protocolType><!--required, xs:string, "HTTP,HTTPS,EHome"--></protocolType>
<parameterFormatType><!--required, xs:string, alarm/event information format, "XML,JSON"--></
parameterFormatType>
<addressingFormatType><!--required, xs:string, "ipaddress,hostname"--></addressingFormatType>
<hostName><!--dependent, xs:string--></hostName>
<ipAddress><!--dependent, xs:string--></ipAddress>
<ipv6Address><!--dependent, xs:string--></ipv6Address>
<portNo><!--optional, xs:integer--></portNo>
<userName><!--dependent, xs:string--></userName>
<password><!--dependent, xs:string--></password>
<httpAuthenticationMethod><!--required, xs:string, "MD5digest,none"--></httpAuthenticationMethod>
<ANPR><!--optional-->
<detectionUpLoadPicturesType>
<!--optional, xs:string, types of alarm picture to be uploaded: "all, licensePlatePicture, detectionPicture"-->
</detectionUpLoadPicturesType>
</ANPR>
<eventType optional="AID,TFS,TPS"><!--required, xs:string--></eventType>
<uploadImagesDataType>
<!--optional, xs:string, "URL", "binary" (default), for cloud storage, only "URL" is supported-->
</uploadImagesDataType>
<eventMode><!--optional, xs:string, "all,list"--></eventMode>
<EventList><!--dependent, it is valid only when eventMode is "list"-->
<Event><!--required-->
<type><!--required, xs:string--></type>
</Event>
</EventList>
<channels><!--optional, xs:string, "1,2,3,4…"--></channels>
<SubscribeEvent/><!--optional, event subscription parameters, see details in the message of XML_SubscribeEvent-->
</HttpHostNotification>

B.166 XML_HttpHostNotificationCap
XML message about capability of HTTP listening server
<?xml version="1.0" encoding="utf-8"?>
<HttpHostNotificationCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<hostNumber>2</hostNumber>
<urlLen max=""/>
<protocolType opt="HTTP,HTTPS,EHome"/>
<parameterFormatType opt="XML,querystring,JSON"/>
<addressingFormatType opt="ipaddress,hostname"/>
<ipAddress opt="ipv4,ipv6"/>
<portNo min="" max=""/>
<userNameLen min="" max=""/>
<passwordLen min="" max=""/>
<httpAuthenticationMethod opt="MD5digest,none"/>
<Extensions>

331
Intelligent Security API (Traffic) Developer Guide

<intervalBetweenEvents min="" max=""/>


</Extensions>
<uploadImagesDataType opt="URL,binary"/>
<ANPR><!--optional-->
<detectionUpLoadPicturesType opt="all,licensePlatePicture,detectionPicture…"/><!--optional, xs:string, types of
alarm pictures to be uploaded-->
<alarmHttpPushProtocol opt="baseline,custom"/>
</ANPR>
<httpBroken opt="true,false" def="true" ><!--optional, xs:boolean, whether to enable global ANR: true, false--></
httpBroken>
<SubscribeEventCap>
<heartbeat min="" max=""/><!--optional, heartbeat time interval, unit: second-->
<channelMode opt="all,list"/><!--required, all-subscribe events of all channels, list-subscribe event by channel-->
<eventMode opt="all,list"/><!--required, event subscription mode: all-subscribe all events of all channels, list-
subscribe events by type, channel, and target-->
<!--if the values of the two nodes channelMode and eventMode are both "all", it indicates that the device does not
support subscribe events by type and channel-->
<EventList><!--dependent, alarm uploading mode, this node is valid only when eventMode is "list"-->
<Event><!--required-->
<type><!--required, xs:string, event types--></type>
<pictureURLType opt="binary,localURL,cloudStorageURL" def=""/>
<!--optional, xs:string, transmission format of alarm picture: "binary"-picture binary data, "localURL"-picture URL
from local device, "cloudStorageURL"-picture URL from cloud storage-->
</Event>
</EventList>
<pictureURLType opt="binary,localURL,cloudStorageURL" def=""/>
<!--optional, xs:string, transmission format of all alarm pictures: "binary"-picture binary data (default for camera),
"localURL"-picture URL from local device (default for NVR/DVR), "cloudStorageURL"-picture URL from cloud storage;
this node is in highest priority-->
<ChangedUploadSub>
<interval/><!--optional, xs:integer, the life cycle of arming GUID, unit: second, the default life cycle is 5 minutes; if
the reconnection is not started during the life cycle, a new GUID will be generated-->
<StatusSub>
<all/><!--optional, xs:boolean, whether to subscribe all-->
<channel/><!--optional, xs:boolean, subscribe channel status, this node is not required when the node all is "true"--
>
<hd/><!--optional, xs:boolean, subscribe the HDD status, this node is not required when the node all is "true"-->
<capability/><!--optional, xs:boolean, subscribe the capability changed status, this node is not required when the
node all is "true"-->
</StatusSub>
</ChangedUploadSub>
</SubscribeEventCap>
</HttpHostNotificationCap>

B.167 XML_HttpHostNotificationList
HttpHostNotificationList message in XML format
<HttpHostNotificationList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<HttpHostNotification>

332
Intelligent Security API (Traffic) Developer Guide

<id><!--req, xs:string, ID--></id>


<url><!--req, xs:string--></url>
<protocolType><!--req, xs:string, "HTTP,HTTPS"--></protocolType>
<parameterFormatType><!--req, xs:string, alarm/event information format, "XML,JSON"--></parameterFormatType>
<addressingFormatType><!--req, xs:string, "ipaddress,hostname"--></addressingFormatType>
<hostName><!--dep, xs:string--></hostName>
<ipAddress><!--dep, xs:string--></ipAddress>
<ipv6Address><!--dep, xs:string--></ipv6Address>
<portNo><!--opt, xs:integer--></portNo>
<userName><!--dep, xs:string--></userName>
<password><!--dep, xs:string--></password>
<httpAuthenticationMethod><!--req, xs:string, "MD5digest,none"--></httpAuthenticationMethod>
<uploadImagesDataType>
<!--opt, xs:string, "URL", "binary" (default), for cloud storage, only "URL" is supported-->
</uploadImagesDataType>
<eventMode><!--opt, xs:string, "all,list"--></eventMode>
<EventList><!--dep, it is valid only when eventMode is "list"-->
<Event><!--req-->
<type><!--req, xs:string--></type>
</Event>
</EventList>
<channels><!--opt, xs:string, "1,2,3,4…"--></channels>
</HttpHostNotification>
</HttpHostNotificationList>

Example
HttpHostNotificationList Message Example
<HttpHostNotificationList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<HttpHostNotification>
<id>1</id>
<url></url>
<protocolType>HTTP</protocolType>
<parameterFormatType>XML</parameterFormatType>
<addressingFormatType>ipaddress</addressingFormatType>
<ipAddress>0.0.0.0</ipAddress>
<portNo>80</portNo>
<userName></userName>
<httpAuthenticationMethod>none</httpAuthenticationMethod>
</HttpHostNotification>
</HttpHostNotificationList>

B.168 XML_HttpHostTestResult
HttpHostTestResult message in XML format.
<HttpHostTestResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<errorDescription>
<!--req, xs:string-->

333
Intelligent Security API (Traffic) Developer Guide

</errorDescription>
</HttpHostTestResult>

B.169 XML_HVTVehicleDetectCfg
Mixed traffic detection message in XML format
<?xml version="1.0" encoding="utf-8"?>
<HVTVehicleDetectCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--required, xs:boolean--></enabled>
<stateOrProvince><!--optional, xs:integer--></stateOrProvince>
<bestDetectionSize><!--optional, xs:integer--></bestDetectionSize>
<HVTVehicleDetectSceneList>
<HVTVehicleDetectScene/><!--optional, see details in XML_HVTVehicleDetectScene-->
</HVTVehicleDetectSceneList>
<nation><!--optional,xs:string, "EU,ER,EUandCIS,ME,All", "ER"-CIS Region, "EU"-Europe Region, "ME"-Middle East,
"All"-All Region--></nation>
<countryIndex><!--optional,xs:integer, country/region No.--></countryIndex>
<!--compatibility between countryIndex and CRIndex-->
<!--device: both fields will be returned, when the value of CRIndex is smaller than or equal to 255, the value of
countryIndex is the same as that of CRIndex; when the value of CRIndex is larger than 255, the value of countryIndex
is 253 (the field countryIndex is invalid)-->
<!--integration flow: for new users, CRIndex has higher priority over countryIndex and the field countryIndex is used
only when countryIndex does not exist; when the value of countryIndex is 253, additional logic processing should be
adopted to use CRIndex field-->
<CRIndex><!--optional, xs:integer, country/region No., when the value is 0, it indicates that no country/region is
specified--></CRIndex>
</HVTVehicleDetectCfg>

See Also
XML_HVTVehicleDetectScene

B.170 XML_HVTVehicleDetectScene
Message about mixed traffic detection (single scene) in XML format
<?xml version="1.0" encoding="utf-8"?>
<HVTVehicleDetectScene version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:integer--></id>
<sceneName><!--optional, xs:string--></sceneName>
<enabled><!--required, xs:boolean--></enabled>
<PlateRecogParam>
<PlateRecogRegionList>
<PlateRecogRegion><!--list-->
<id><!--required, xs:string--></id>
<RegionCoordinatesList>
<RegionCoordinates><!--list,required-->
<positionX><!--required, xs:integer, X-coordinate--></positionX>

334
Intelligent Security API (Traffic) Developer Guide

<positionY><!--required, xs:integer, Y-coordinate--></positionY>


</RegionCoordinates>
</RegionCoordinatesList>
</PlateRecogRegion>
</PlateRecogRegionList>
</PlateRecogParam>
<LaneConfig>
<LaneList size="">
<Lane><!--list-->
<laneId><!--required, xs:integer--></laneId>
<RegionCoordinatesList><!--required-->
<RegionCoordinates><!--list-->
<positionX><!--required, xs:integer--></positionX>
<positionY><!--required, xs:integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
<lineType><!--optional, xs:string, "laneBoundaryLine,laneLine"--></lineType>
<carDriveDirect><!--dependent, xs:string, this field is valid when the value of lineType is "laneLine",
"unknow,up_to_down,down_to_up"--></carDriveDirect>
</Lane>
</LaneList>
</LaneConfig>
<AtRoadsideCalib><!--optional-->
<RegionCoordinatesList>
<RegionCoordinates><!--required, list-->
<positionX><!--required, xs:integer, X-coordinate--></positionX>
<positionY><!--required, xs:integer, Y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</AtRoadsideCalib>
<AboveRoadCalib><!--optional-->
<RegionCoordinatesList>
<RegionCoordinates><!--required, list-->
<positionX><!--required, xs:integer, X-coordinate--></positionX>
<positionY><!--required, xs:integer, Y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</AboveRoadCalib>
</HVTVehicleDetectScene>

B.171 XML_IllegalDictionary
XML message about parameters of traffic violation dictionary
<IllegalDictionary version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<IllegalCodeList><!--required-->
<IllegalCodeItem><!--required-->
<idx><!--required, xs:integer, value range: [0,64]--></idx>
<illegalCode><!--required, xs:string, illegal action code--></illegalCode>
<illegalName><!--required, xs:string, illegal action name, the maximum size is 128 bytes--></illegalName>

335
Intelligent Security API (Traffic) Developer Guide

<illegalStringCode><!--optional, xs:string, illegal action code (string)--> </illegalStringCode>


<illegalDescription><!--optional, xs:string, illegal action description--></illegalDescription>
</IllegalCodeItem>
</IllegalCodeList>
</IllegalDictionary>

B.172 XML_ImageChannel
ImageChannel message in XML format
<ImageChannel version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs: integer--></id>
<enabled><!--req, xs: boolean--></enabled>
<videoInputID><!--req, xs: integer--></videoInputID>
<Defog/><!--opt, electronic defogging parameters, see details in the message of XML_Defog-->
<NoiseReduce2D/><!--opt, 2D noise reduction parameters, see details in the message of XML_NoiseReduce2D-->
<Focusconfiguration/><!--opt-->
<LensInitialization/><!--opt-->
<ImageFlip/><!--opt, image automatic flipping parameters, see details in the message of XML_ImageFlip-->
<ImageFreeze/><!--opt-->
<proportionalpan/><!--opt-->
<WDR/><!--opt, WDR parameters, refer to the message XML_WDR for details-->
<BLC/><!--opt, BLC parameters, refer to the message XML_BLC for details-->
<NoiseReduce/><!--opt, 3D DNR parameters, see details in the message of XML_NoiseReduce-->
<ImageEnhancement/><!--opt, image enhancement parameters, see details in the message of
XML_ImageEnhancement-->
<DSS/><!--opt, low illumination electronic shutter parameters in exposure, see details in the message of XML_DSS-->
<WhiteBlance/><!--opt, WB parameters, see details in the message of XML_WhiteBlance-->
<Exposure/><!--opt, exposure parameters, see details in the message of XML_Exposure-->
<Sharpness/><!--opt, sharpness parameters, see details in the message of XML_Sharpness-->
<gammaCorrection/><!--opt, gamma correction parameters, see details in the message of XML_gammaCorrection-->
<powerLineFrequency/><!--opt, image standard parameters, refer to the message XML_powerLineFrequency for
details-->
<Color/><!--opt, image color parameters, see details in the message of XML_Color-->
<IrcutFilter/><!--opt, day/night auto switch parameters, see details in the message of XML_IrxutFilter-->
<ImageModeList/><!--opt, default image mode parameters, see details in the message of XML_ImageModeList-->
<BrightEnhance/><!--opt, brightness enhancement parameters, see details in the message of XML_BrightEnhance-->
<ISPMode/><!--opt, day/night mode parameters, see details in the message of XML_ISPMode-->
<Shutter/><!--opt, shutter parameters in exposure, see details in the message of XML_Shutter-->
<Gain/><!--opt, gain parameters, see details in the message of XML_Gain-->
<ImageIcrE/><!--opt, IR-cut filter parameters, see details in the message of XML_ImageIcrE-->
<ImageMultishut/><!--opt, multi-shutter parameters, see details in the message of XML_ImageMultishut-->
<PlateBright/><!--opt, license plate brightness compensation parameters, see details in the message of
XML_PlateBright-->
<JPEGParam/><!--opt, JPEG picture size parameters, see details in the message of XML_JPEGParam-->
<DarkEnhance/><!--opt, dark space enhancement parameters, see details in the message of XML_DarkEnhance-->
<Hdr/><!--opt, WDR (Wide Dynamic Range) parameters, see details in the message of XML_Hdr-->
<LSE/><!--opt, contrast enhancement parameters, see details in the message of XML_LSE-->
<MCE/><!--opt, memory color enhancement parameters, see details in the message of XML_MCE-->
<Svce/><!--opt, part contrast parameters, see details in the message of XML_Svce-->

336
Intelligent Security API (Traffic) Developer Guide

<SectionCtrl/><!--opt, configuration parameters of picture exposure control by video segment, see details in the
message of XML_SectionCtrl-->
<AutoContrast/><!--opt, automatic contrast parameters, see details in the message of XML_AutoContrast-->
<GrayRange/><!--opt, grayscale range parameters, see details in the message of XML_GrayRange-->
<LSEDetail/><!--opt, contrast enhancement parameters, see details in the message of XML_LSE-->
<ITCImageSnap/><!--opt, captured picture parameters, see details in the message of XML_ITCImageSnap-->
<ImageRecord/><!--opt, image parameters in the recorded video, see details in the message of XML_ImageRecord-->
<Scene/><!--opt-->
<EPTZ/><!--opt-->
<EIS/><!--opt-->
<HLC/><!--opt-->
<ZoomLimit/><!--opt-->
<corridor/><!--opt, image rotate mode parameters, refer to the message XML_corridor for details-->
<Dehaze/><!--opt, defog mode parameters, refer to the message XML_Dehaze for details-->
<ImageMode/><!--opt, xs: string, image mode: "standard, indoor, outdoor, dimLight"-->
<enableImageLossDetection><!--opt, xs: boolean--></enableImageLossDetection>
<CaptureMode/><!--opt, video input mode parameters, refer to the message XML_CaptureMode for details-->
<IrLight/><!--opt-->
<LensDistortionCorrection/><!--opt-->
<ExposureSync/><!--opt, exposure synchronization settings-->
<BrightnessSuddenChangeSuppression/><!--opt-->
<TempRange/><!--opt, temperature range, refer to the message XML_tempRange for details-->
<SupplementLight/> <!-- opt -->
</ImageChannel>

B.173 XML_ImageFlip
ImageFlip message in XML format
<ImageFlip version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled/><!--req, xs:boolean-->
<ImageFlipStyle/><!--opt, xs:string, "LEFTRIGHT, UPDOWN, CENTER, AUTO", it can be enabled only when the value is
"true"-->
<flipAngle><!--opt, xs:string, "90, 180, 270"--></flipAngle>
</ImageFlip>

B.174 XML_ImageIcrE
ImageIcrE message in XML format
<ImageIcrE xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0"><!--ICR configuration parameters, which
will be displayed according to the capability-->
<ICRCtrl><!--IR-cut filter-->
<ICRCtrlMode>
<!--req, xs:string, "close", "manual"-manually switch, "time"-switch by schedule, "auto"-automatically switch-->
</ICRCtrlMode>
<ManualMode>
<!--manually switch-->
<ManualPresetVal>

337
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:string, manually switch: "day", "night"-->


</ManualPresetVal>
</ManualMode>
<TimeMode>
<!--switch by schedule-->
<SwitchList>
<!--schedule list for switching, up to two time period control can be supported. For example: time period is from
6:00 to 18:00, the preset ID is 1-->
<Preset>
<!--req, preset-->
<PresetId>
<!--req, xs:integer, preset ID, which ranges from 0 to 1-->
</PresetId>
<PresetVal>
<!--dep, xs:string, "day", "night"-->
</PresetVal>
</Preset>
<TimeSwitch>
<!--req, time period-->
<timeId>
<!--req, xs:integer, time period ID, which ranges from 0 to 1-->
</timeId>
<startHour>
<!--dep, xs:integer, start hour, which ranges from 0 to 23-->
</startHour>
<startMinute>
<!--dep, xs:integer, start minute, which ranges from 0 to 59-->
</startMinute>
<endHour>
<!--dep, xs:integer, end hour, which ranges from 0 to 23-->
</endHour>
<endMinute>
<!--dep, xs:integer, end minute, which ranges from 0 to 59-->
</endMinute>
</TimeSwitch>
</SwitchList>
</TimeMode>
<AutoMode>
<!--automatically switch according to the light change-->
<DayNightFilterTh>
<!--req, xs:integer, day/night auto switch sensitivity, which ranges from 0 to 100-->
</DayNightFilterTh>
<ICRAutoSwitch>
<!--dep, xs:integer, ICR auto-switch and threshold, which ranges from 0 to 100-->
</ICRAutoSwitch>
</AutoMode>
</ICRCtrl>
<ECtrl>
<!---E device, halo inhibition filter, which can be used to inhibit the halo-->
<ECtrlMode>
<!--req, xs:string, "close", "manual"-manually switch, "time"-switch by schedule, "auto"-automatically switch-->
</ECtrlMode>

338
Intelligent Security API (Traffic) Developer Guide

<ManualMode>
<!--manually switch-->
<ManualPresetVal>
<!--req, xs:integer, preset for manually switching, which ranges from 0 to 100-->
</ManualPresetVal>
</ManualMode>
<TimeMode>
<!--switch by schedule-->
<SwitchList>
<!--schedule list for switching, up to two time period control can be supported. For example: time period is from
6:00 to 18:00, the preset ID is 1-->
<Preset>
<!--req, preset-->
<PresetId>
<!--req, xs:integer, range: [0, 1]-->
</PresetId>
<PresetVal>
<!--dep, xs:integer, range: [0, 100]-->
</PresetVal>
</Preset>
<TimeSwitch>
<!--req, time period-->
<timeId>
<!--req, xs:integer, time period ID, which ranges from 0 to 1-->
</timeId>
<startHour>
<!--dep, xs:integer, start hour, which ranges from 0 to 23-->
</startHour>
<startMinute>
<!--dep, xs:integer, start minute, which ranges from 0 to 59-->
</startMinute>
<endHour>
<!--dep, xs:integer, end hour, which ranges from 0 to 23-->
</endHour>
<endMinute>
<!--dep, xs:integer, end minute, which ranges from 0 to 59-->
</endMinute>
</TimeSwitch>
</SwitchList>
</TimeMode>
<AutoMode>
<DayNightFilterTh>
<!--req, xs:integer, day/night auto switch sensitivity, which ranges from 0 to 100-->
</DayNightFilterTh>
<ExceptionCatchTh>
<!--req, xs:integer, exception detection sensitivity, which ranges from 0 to 100-->
</ExceptionCatchTh>
</AutoMode>
</ECtrl>
</ImageIcrE>

339
Intelligent Security API (Traffic) Developer Guide

B.175 XML_ImageMultishut
ImageMultishut message in XML format
<ImageMultishut version="2.0"xmlns="http://www.isapi.org/ver20/XMLSchema">
<doubleShutEnable>
<!--req, xs:boolean, whether to support dual-shutter-->
</doubleShutEnable>
<codecType>
<!--req, xs:string, "all_ia"-algorithm stream, "all_record"-record stream-->
</codecType>
</ImageMultishut>

B.176 XML_ImageRecord
ImageRecord message in XML format
<ImageRecord version="2.0"xmlns="http://www.isapi.org/ver20/XMLSchema">
<RecordColor/><!--color, see details in the message of XML_RecordColor-->
<RecordShutter/><!--shutter, see details in the message of XML_RecordShutter-->
<RecordGain/><!--gain, see details in the message of XML_RecordGain-->
<RecordNoiseReduceExt/><!--3D DNR (Digital Noise Reduction), see details in the message of
XML_RecordNoiseReduceExt-->
<RecordNoiseReduce2D/><!--2D noise reduction, see details in the message of XML_RecordNoiseReduce2D-->
<RecordSectionCtrl/><!--picture exposure control by video segment, see details in the message of
XML_RecordSectionCtrl-->
</ImageRecord>

See Also
XML_RecordColor
XML_RecordShutter
XML_RecordGain
XML_RecordNoiseReduceExt
XML_RecordNoiseReduce2D
XML_RecordSectionCtrl

B.177 XML_ImageRecordCaps
ImageRecordCaps capability message in XML format
<ImageRecordCaps version="2.0"xmlns="http://www.isapi.org/ver20/XMLSchema">
<RecordColor/><!--color, see details in the message of XML_RecordColor-->
<RecordShutter/><!--shutter, see details in the message of XML_RecordShutter-->
<RecordGain/><!--gain, see details in the message of XML_RecordGain-->
<RecordNoiseReduceExt/><!--3D DNR (Digital Noise Reduction), see details in the message of
XML_RecordNoiseReduceExt-->

340
Intelligent Security API (Traffic) Developer Guide

<RecordNoiseReduce2D/><!--2D noise reduction, see details in the message of XML_RecordNoiseReduce2D-->


<RecordSectionCtrl/><!--picture exposure control by video segment, see details in the message of
XML_RecordSectionCtrl-->
</ImageRecordCaps>

See Also
XML_RecordColor
XML_RecordShutter
XML_RecordGain
XML_RecordNoiseReduceExt
XML_RecordNoiseReduce2D
XML_RecordSectionCtrl

B.178 XML_IrcutFilter
IrcutFilter message in XML format
<IrcutFilter version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<IrcutFilterType>
<!--opt, xs: string, day/night auto switch mode: "auto, day, night, schedule, eventTrigger, darkFighterX,
darkFighterXAuto, darkFighterXSchedule"-->
</IrcutFilterType>
<dayToNightFilterLevel>
<!--opt, xs: string, level of switching day to night: "low, normal, high"-->
</dayToNightFilterLevel>
<dayToNightFilterTime>
<!--opt, xs: integer, time interval of switching day to night-->
</dayToNightFilterTime>
<nightToDayFilterLevel>
<!--opt, xs: string, level of switching night to day: "low, normal, high"-->
</nightToDayFilterLevel>
<nightToDayFilterTime>
<!--opt, xs: integer, time interval of switching night to day-->
</nightToDayFilterTime>
<Schedule><!--dep-->
<scheduleType><!--req, xs: string, schedule type: "day,night"></scheduleType>
<TimeRange><!--req, time period on schedule-->
<beginTime><!--req, xs: time, which is in ISO8601 time format--></beginTime>
<endTime><!--req, xs:time, which is in ISO8601 time format--></endTime>
</TimeRange>
</Schedule>
<EventTrigger><!--dep-->
<eventType><!--req, xs: string, event type: "IO,VMD"></eventType>
<IrcutFilterAction><!--req, xs:string, "day,night"></IrcutFilterAction >
</EventTrigger>
</IrcutFilter>

341
Intelligent Security API (Traffic) Developer Guide

B.179 XML_ITCCap
XML message about intelligent traffic capability
<ITCCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportITCStatus>
<!--req, xs:boolean, whether it supports device status-->
</isSupportITCStatus>
<isSupportIllegalDictionary>
<!--req, xs:boolean, whether it supports traffic violation dictionary-->
</isSupportIllegalDictionary>
<isSupportVehicleDetection>
<!--dep, xs: boolean, whether it supports vehicle detection-->
<isSupportEvidenceDictionary>
<!--req, xs: boolean, whether it supports traffic law enforcement dictionary-->
</isSupportEvidenceDictionary>
<isSupportITCSetUp>
<!--req, xs:boolean, whether it supports installation parameters-->
</isSupportITCSetUp>
<isSupportTrafficParam>
<!--req, xs:boolean, whether it supports vehicle counting statistics-->
</isSupportTrafficParam>
<isSupportManualCap>
<!--req, xs:boolean, whether it supports manual capture-->
</isSupportManualCap>
<isSupportIllegalUploadPic>
<!--req, xs:boolean, whether it supports uploading pictures-->
</isSupportIllegalUploadPic>
<isSupportContinueCap>
<!--req, xs:boolean, whether it supports continuous capture-->
</isSupportContinueCap>
<isSupportWiper>
<!--req, xs:boolean, whether it supports wiper-->
</isSupportWiper>
<isSupportEntranceCap>
<!--opt, whether it supports entrance and exit functions-->
</isSupportEntranceCap>
<isSupportPlateRecognitionParam>
<!--req, xs:boolean, whether it supports license plate recognition parameters-->
</isSupportPlateRecognitionParam>
<isSupportSyncSignalOutput>
<!--req, xs:boolean,whether it supports output parameters-->
</isSupportSyncSignalOutput>
<isSupportSyncPower>
<!--req, xs:boolean, whether it supports signal light synchronization-->
</isSupportSyncPower>
<isSupportImageMerge>
<!--req, xs:boolean, whether it supports picture composition-->
</isSupportImageMerge>
<isSupportCabinetParam>
<!--req, xs:boolean, whether it supports device cabinet alarm-->

342
Intelligent Security API (Traffic) Developer Guide

</isSupportCabinetParam>
<isSupportCarFeatureParam>
<!--req, xs:boolean, whether it supports vehicle features-->
</isSupportCarFeatureParam>
<isSupportLightCorrect>
<!--req, xs:boolean, whether it supports exporting illegal action codes-->
</isSupportLightCorrect>
<isSupportSnapshot>
<!--req, xs:boolean, whether it supports image capture resolution-->
</isSupportSnapshot>
<isSupportIllegalCodeData>
<!--req, xs:boolean, whether it supports signal light correction-->
</isSupportIllegalCodeData>
<isSupportNetStorage>
<!--req, xs:boolean, whether it supports network storage-->
</isSupportNetStorage>
<isSupportAlgorithmsVersion>
<!--req, xs:boolean, whether it supports getting algorithm library status-->
</isSupportAlgorithmsVersion>
<isSupportAlgorithmsState>
<!--req, xs:boolean, whether it supports getting algorithm library version-->
</isSupportAlgorithmsState>
<isSupportPlateCorrection>
<!--opt, xs:boolean, whether it supports manual license plate correction-->
</isSupportPlateCorrection>
<isSupportRadarSetUp>
<!--req, xs:boolean, whether it supports radar construction parameters-->
</isSupportRadarSetUp>
<isSupportRadarMeasurement>
<!--opt, xs:boolean, whether it supports radar measurement configuration-->
</isSupportRadarMeasurement>
</ITCCap>

B.180 XML_ITCImageSnap
ITCImageSnap message in XML format
<ITCImageSnap version="2.0"xmlns="http://www.isapi.org/ver20/XMLSchema"><!--captured picture parameters,
which will be displayed according to the capability-->
<SnapColor/><!--color parameters for captured pictures, see details in the message of XML_SnapColor-->
<SnapShutter/><!--shutter parameters in exposure for captured pictures, see details in the message of
XML_SnapShutter-->
<SnapGain/><!--gain parameters for captured pictures, see details in the message of XML_SnapGain-->
<SnapNoiseReduce2D/><!--2D noise reduction parameters for captured pictures, see details in the message of
XML_SnapNoiseReduce2D-->
<ShadowHighlight/><!--shadow and highlight parameters for captured pictures, see details in the message of
XML_SnapShadowHighlight-->
<LPDE/><!--license plate enhancement parameters for captured pictures, see details in the message of
XML_SnapLPDE-->
<SnapPlateContrast/><!--license plate contrast parameters for captured pictures, see details in the message of

343
Intelligent Security API (Traffic) Developer Guide

XML_SnapPlateContrast-->
<SnapPlateSaturation/><!--license plate saturation parameters for captured pictures, see details in the message of
XML_SnapPlateSaturation-->
</ITCImageSnap>

See Also
XML_SnapColor
XML_SnapShutter
XML_SnapGain
XML_SnapNoiseReduce2D
XML_SnapShadowHighlight
XML_SnapLPDE
XML_SnapPlateContrast
XML_SnapPlateSaturation

B.181 XML_ITCImageSnapCaps
ITCImageSnapCaps capability message in XML format
<ITCImageSnapCaps version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SnapColor/><!--color parameters for captured pictures, see details in the message of XML_SnapColor-->
<SnapShutter/><!--shutter parameters in exposure for captured pictures, see details in the message of
XML_SnapShutter-->
<SnapGain/><!--gain parameters for captured pictures, see details in the message of XML_SnapGain-->
<SnapNoiseReduce2D/><!--2D noise reduction parameters for captured pictures, see details in the message of
XML_SnapNoiseReduce2D-->
<ShadowHighlight/><!--shadow and highlight parameters for captured pictures, see details in the message of
XML_SnapShadowHighlight-->
<LPDE/><!--license plate enhancement parameters for captured pictures, see details in the message of
XML_SnapLPDE-->
<SnapPlateContrast/><!--license plate contrast parameters for captured pictures, see details in the message of
XML_SnapPlateContrast-->
<SnapPlateSaturation/><!--license plate saturation parameters for captured pictures, see details in the message of
XML_SnapPlateSaturation-->
</ITCImageSnapCaps>

See Also
XML_SnapColor
XML_SnapShutter
XML_SnapGain
XML_SnapNoiseReduce2D
XML_SnapShadowHighlight
XML_SnapLPDE
XML_SnapPlateContrast
XML_SnapPlateSaturation

344
Intelligent Security API (Traffic) Developer Guide

B.182 XML_ITCSetUp
ITCSetUp message in XML format
<ITCSetUp xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<focusType>
<!--req, xs:string, lens focus type: 0-unknown (default), 1-8mm, 2-12mm, 3-16mm, 4-25mm, 5-35mm, 6-50mm-->
</focusType>
<setUpHeight>
<!--req, xs:integer, construction height, which ranges from 0 to 2000, the default height is 600, unit: centimeter-->
</setUpHeight>
<sceneDis>
<!--req, xs:integer, horizontal distance between the bottom edge of the picture and the camera, which ranges from
0 to 6000, unit: centimeter-->
</sceneDis>
<horizontalField>
<!--req, xs:integer, "0-360"-->
</horizontalField>
<verticalField>
<!--req, xs:integer, "0-360"-->
</verticalField>
<autoGetGps>
<!--req, xs:boolean, "true,false"-->
</autoGetGps>
<longitude>
<!--req, xs:string, "0-16"-->
</longitude>
<latitude>
<!--req, xs:string, "0-16"-->
</latitude>
<setupHeightUnit>
<!--req, xs:integer, construction height unit: 0-meter, 1-centimeter-->
</setupHeightUnit>
<videoDetCoefficient>
<!--req, xs:integer, video test coefficient, which ranges from 0 to 300-->
</videoDetCoefficient>
</ITCSetUp>

B.183 XML_ITCStatusCap
ITCStatusCap capability message in XML format
<ITCStatusCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<isSupportfortifyLinkStatus>
<!--req, xs:boolean-->
</isSupportfortifyLinkStatus>
<isSupportDetectorStatus>
<!--req, xs:boolean-->
</isSupportDetectorStatus>

345
Intelligent Security API (Traffic) Developer Guide

<relatedTriggerInputs>
<!--req, xs:integer, number of linked triggering inputs-->
</relatedTriggerInputs>
<relatedSyncOutputs>
<!--req, xs:integer, number of linked synchronous outputs-->
</relatedSyncOutputs>
</ITCStatusCap>

B.184 XML_ITCTotalCap
ITCTotalCap capability message in XML format
<ITCTotalCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<isSupportPreview opt="true,false" def="true">
<!--req, xs:boolean, whether to support live view-->
</isSupportPreview>
<isSupportPicItem opt="true,false" def="true">
<!--req, xs:boolean, whether to support picture item-->
</isSupportPicItem>
<isSupportDiaryItem opt="true,false" def="true">
<!--req, xs:boolean, whether to support log item-->
</isSupportDiaryItem>
<isSupportDeviceStatus opt="true,false" def="ture">
<!--req, xs:boolean, whether to support device item-->
</isSupportDeviceStatus>
<isSupportLocalConfig opt="true,false" def="true">
<!--req, xs:boolean, whether to support local configuration-->
</isSupportLocalConfig>
<isSupportSystemMaintain opt="true,false" def="true">
<!--req, xs:boolean, whether to support system maintenance-->
</isSupportSystemMaintain>
<isSupportEncdeStorage opt="true,false" def="true">
<!--req, xs:boolean, whether to support encoding and storage-->
</isSupportEncdeStorage>
<isSupportOSD opt="ture,false" def="true">
<!--req, xs:boolean, whether to support text overlay-->
</isSupportOSD>
<isSupportTriggerMode opt="true,false" def="true">
<!--req, xs:boolean, whether to support trigger mode-->
</isSupportTriggerMode>
<isSupportCaptureParam opt="true,false" def="true">
<!--req, xs:boolean, whether to support capture parameters-->
</isSupportCaptureParam>
<isSupportImageParam opt="true,false" def="true">
<!--req, xs:boolean, whether to support image parameters-->
</isSupportImageParam>
<isSupportException opt="true,false" def="true">
<!--req, xs:boolean, whether to support exception event-->
</isSupportException>
<isSupportUserManage opt="true,false" def="true">

346
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:boolean, whether to support user management-->


</isSupportUserManage>
</ITCTotalCap>

B.185 XML_JPEGParam
JPEGParam message in XML format
<JPEGParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<JPEGSize>
<!--dep, xs:integer, JPEG picture size, which ranges from 64 to 8196, unit: KB-->
</JPEGSize>
</JPEGParam>

B.186 XML_LampCtrl
LampCtrl message in XML format
<LampCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<barrietGateNum>
<!--opt, xs:integer, barrier gate No.-->
</barrietGateNum>
<LampCtrlList>
<lampOper>
<!--opt, xs:string, solid light operation: "off"-turn off solid light, "on"-turn on solid light-->
</lampOper>
</LampCtrlList>
</LampCtrl>

B.187 XML_LcdCfg
LcdCfg message in XML format
<LcdCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<lcd><!--req, xs: string--></lcd>
</LcdCfg>

B.188 XML_LcdStatus
LcdStatus message in XML format
<LcdStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<lcd min="" max=""><!--req, xs: integer, LCD control system status: 0-offline, 1-normal, 2-exception--></lcd>
</LcdStatus>

347
Intelligent Security API (Traffic) Developer Guide

B.189 XML_LEDConfigurationList
LEDConfigurationList message in XML format
<LEDConfigurationList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<LEDConfiguration>
<!--LED screen display parameters-->
<id>
<!--opt, xs:integer, screen ID-->
</id>
<information>
<!--req, xs:string, LED screen display content-->
</information>
<displayMode>
<!--req, xs:string, display mode: "left"-move left, "right"-move right, "immediate"-display immediately-->
</displayMode>
<speedType>
<!--req, xs:string, speed type: "fast", "medium", "slow"-->
</speedType>
<showTime>
<!--req, xs:integer, display duration, which is between 1 and 60, unit: second-->
</showTime>
<showPlate>
<!--opt, xs:boolean, display license plate-->
</showPlate>
<fontSize>
<!--opt, xs:integer, font size-->
</fontSize>
<fontColor>
<!--opt, xs:integer, RGB value of the font color-->
</fontColor>
</LEDConfiguration>
</LEDConfigurationList>

B.190 XML_LightCfg
LightCfg message in XML format
<LightCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<online min="" max=""><!--req, xs: integer, traffic light detection system: 0-offline, 1-normal, 2-exception--></online>
<Light>
<IPCamereaID min="" max=""><!--req, xs: integer, channel ID of network camera--></IPCamereaID>
<isRelated min="" max=""><!--req, xs: integer, whether it is linked: 0-yes, 1-no--></isRelated>
<IPCisExit min="" max=""><!--req, xs: integer, whether the network camera does exists: 0-yes, 0-no--></IPCisExit>
</Light>
</LightCfg>

348
Intelligent Security API (Traffic) Developer Guide

B.191 XML_LightStatus
LightStatus message in XML format
<LightStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<online min="" max=""><!--req, xs: integer, system status: 0-offline, 1-normal, 2-exception--></online>
<channelList><!--req-->
<channel><!--req-->
<ID min="" max=""><!--req, xs: integer, channel No.--></ID>
<status min="0" max="1">
<!--req, xs: integer, traffic light status: 0-red light, 1-non-red light-->
</status>
</channel>
</channelList>
</LightStatus>

B.192 XML_LPListAuditSearchDescription
LPListAuditSearchDescription message in XML format
<LPListAuditSearchDescription version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string--></searchID>
<searchResultPosition><!--req, xs: integer--></searchResultPosition>
<maxResults><!--req, xs: integer--></maxResults>
</LPListAuditSearchDescription>

B.193 XML_LPListAuditSearchResult
LPListAuditSearchResult message in XML format
<LPListAuditSearchResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string--></searchID>
<responseStatus></responseStatus>
<responseStatusStrg></responseStatusStrg>
<numOfMatches><!--req, xs: integer--></numOfMatches>
<totalMatches><!--req, xs: integer--></totalMatches>
<LicensePlateInfoList>
<LicensePlateInfo>
<id><!--req, xs: string --></id>
<LicensePlate><!--opt, xs: string--></LicensePlate>
<type><!--opt, xs: string, "blackList,whitelist,allVehicleList,otherVehicleList"--></type>
<createTime><!--opt, xs: string, time in ISO8601 format--></createTime>
<direction><!--opt, xs: string, "forward,reverse,unknown"--></direction>
<laneNo><!--opt, xs: integer--></laneNo>
</LicensePlateInfo>
</LicensePlateInfoList>
</LPListAuditSearchResult>

349
Intelligent Security API (Traffic) Developer Guide

B.194 XML_LSE
LSE message in XML format
<LSE version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<lseLevel>
<!--dep, xs:integer, contrast enhancement level, which ranges from 0 to 100, the default value is 50-->
</lseLevel>
<lseHaloLevel>
<!--dep, xs:integer, halo inhibition level, which ranges from 0 to 100-->
</lseHaloLevel>
<switchMode>
<!--opt, xs:string, contrast enhancement switching mode: "open", "timeCtrl"-enable by time, "lightCtrl"-enable by
brightness-->
</switchMode>
<timeSwitch>
<!--dep, switching time, this node is valid only when <switchMode> is "timeCtrl"-->
<startTime>
<!--opt, xs:time, start time, ISO8601 time-->
</startTime>
<endTime>
<!--opt, xs:time, end time, ISO8601 time-->
</endTime>
</timeSwitch>
<lightLevel>
<!--dep, xs:integer, brightness level, this node is valid only when <switchMode> is "lightCtrl"-->
</lightLevel>
</LSE>

B.195 XML_LSEDetail
LSEDetail message in XML format
<LSEDetail version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--req, xs:boolean, whether to enable DDE (Digital Detail Enhancement)--></enabled>
<LSEDetailLevel><!--dep, xs:integer, DDE (Digital Detail Enhancement) level, which ranges from 0 to 100, the default
value is 50--></lseLevel>
</LSEDetail>

B.196 XML_ManualItsCap
ManualItsCap capability message in XML format.
<ManualItsCap xmlns="http://www.isapi.org/ver20/XMLSchema">
<StartPoint>
<PositionX><!--required, integer type, start X-coordinate of rectangle frame--></PositionX>
<PositionY><!--required, integer type, start Y-coordinate of rectangle frame--></PostitionY>

350
Intelligent Security API (Traffic) Developer Guide

</StartPoint>
<EndPoint>
<PositionX><!--required, integer type, end X-coordinate of rectangle frame--></PositionX>
<PositionY><!--required, integer type, end Y-coordinate of rectangle frame--></PositionY>
</EndPoint>
</ManualItsCap>

B.197 XML_MCE
MCE message in XML format
<MCE version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled>
<!--req, xs:boolean, whether to enable memory color enhancement-->
</enabled>
<mceLevel>
<!--dep, xs:integer, memory color enhancement level, which ranges from 0 to 100, the default value is 50-->
</mceLevel>
</MCE>

B.198 XML_MergePicOverlays
MergePicOverlays message in XML format
<MergePicOverlays version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<overlayInfoEnabled>
<!--req, xs:boolean, whether to enable text overlay-->
</overlayInfoEnabled>
<OverlayInfoList/><!--req, see details in the message of XML_OverlayInfoList-->
<linePercent>
<!--req, xs:integer, percentage of overlaying lines, which is between 0 and 100 and the default value is 100-->
</linePercent>
<itemsStlye>
<!--req, xs:string, overlay mode: "horizontal" (default), "vertical"-->
</itemsStlye>
<charStyle>
<!--req, xs:string, font type: 0-SimSun (default), 1-Wei-->
</charStyle>
<charSize>
<!--req, xs:integer, character size: 0-16*16(Chinese)/8*16(English), 1-32*32(Chinese)/16*32(English), 2-48*48,
3-64*64(Chinese)/32*64(English)-->
</charSize>
<charPosition>
<!--req, xs:integer, text position overlayed on the picture: 0-overlayed on the picture, 1-overlayed outside the top
edge of the picture, 2-overlayed outside the bottom edge of the picture-->
</charPosition>
<charInterval>
<!--req, xs:integer, character separation distance, which is between 0 and 16 and the default value is 0, unit: pixel-->
</charInterval>

351
Intelligent Security API (Traffic) Developer Guide

<foreColor>
<!--req, xs:integer, foreground color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0xffffff (white)-->
</foreColor>
<backColor>
<!--req, xs:integer, background color, which is the RGB value directly obtained by the palette, the value is between 0
and 0xffffff and the default value is 0x0 (black)-->
</backColor>
<colorAdapt>
<!--dep, xs:boolean, whether to enable color self-adaption: 0-no, 1-yes-->
</colorAdapt>
<zeroizeEnable>
<!--dep, xs:boolean, whether to enable zero filling for OSD overlay, which is used to enable zero filling for vehicle
speed, speed limit, overspeed ratio and lane No. Zero filling is enabled by default-->
</zeroizeEnable>
<platePicOverlay>
<!--dep, xs:boolean, whether to enable overlaying license plate thumbnail-->
</platePicOverlay>
<platePicPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture height, and the default valid is 0-->
</platePicPosTop>
<platePicPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture width, and the default value is 0-->
</platePicPosLeft>
</MergePicOverlays>

See Also
XML_OverlayInfoList

B.199 XML_NetPortStatusList
NetPortStatusList message in XML format
<NetPortStatusList>
<NetPortStatus>
<index min="" max=""><!--req, xs: integer--></index>
<status min="" max=""><!--req, xs: integer, 1-connected, 2-not connected--></status>
<ipAddr><!--req, xs: string--></ipAddr>
<mac><!--req, xs: string--></mac>
<uplink><!--req, xs: integer, unit: KB--></uplink>
<downlink><!--req, xs: integer, unit: KB--></downlink>
</NetPortStatus>
</NetPortStatusList>

352
Intelligent Security API (Traffic) Developer Guide

B.200 XML_NoiseReduce
NoiseReduce message in XML format
<NoiseReduce version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<mode><!--req, xs: string, 3D DNR mode: "close, general, advanced"--></mode>
<GeneralMode><!--dep, this node is valid only when <mode> is "general"-->
<generalLevel><!--req, xs: integer--></generalLevel>
</GeneralMode>
<AdvancedMode><!--dep, this node is valid only when <mode> is "advanced"-->
<FrameNoiseReduceLevel><!--req, xs: integer--></FrameNoiseReduceLevel>
<InterFrameNoiseReduceLevel><!--req, xs: integer--></InterFrameNoiseReduceLevel>
</AdvancedMode>
</NoiseReduce>

B.201 XML_NoiseReduce2D
NoiseReduce2D message in XML format
<NoiseReduce2D version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<noiseReduce2DEnable><!--req, xs:boolean--></noiseReduce2DEnable>
<noiseReduce2DLevel min="0" max="100"><!--dep, xs:integer--></noiseReduce2DLevel>
</NoiseReduce2D>

B.202 XML_OPTStatus
OPTStatus message in XML format
<OPTStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<OPT min="" max="">
<!--req, xs: integer, optional terminal status: 0-offline, 1-normal, 2-exception-->
</OPT>
</OPTStatus>

B.203 XML_OverlayInfo
OverlayInfo message in XML format
<OverlayInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<overlayInfoID>
<!--req, xs:integer, overlayed information ID, which is between 1 and 50-->
</overlayInfoID>
<itemType>
<!--req, xs:integer, overlayed information type: 0-unknown, 1-place, 2-intersection No., 3-device No., 4-direction
No., 5-direction, 6-lane No., 7-lane, 8-capture time (without millisecond), 9-capture time (with millisecond), 10-license

353
Intelligent Security API (Traffic) Developer Guide

plate number, 11-vehicle color, 12-vehicle type, 13-vehicle brand, 14-vehicle speed, 15-speed limit sign, 16-vehicle
length (between 1 and 99 meters), 17-violation code (traffic violation information is more useful than code, e.g.,
normal, low speed, overspeed, reverse driving, running the red light, occupying lane, driving over yellow lane line,
etc.), 18-camera information, 19-traffic violation, 20-overspeed ratio, 21-red light start time, 22-red light end time, 23-
red light time, 24-security code, 25-capture No., 26-seatbelt, 27-reserved, 28-sun visor, 29-lane direction, 30/31/32-
reserved, 33-yellow label vehicle detection, 34-dangerous goods transport vehicle detection, 35-vehicle sub-brand
detection, 36-vehicle direction, 37-window hangings, 38-making a call, 39-confidence, 40-verification unit, 41-
verification certificate No., 42-calibration expiration date, 43-longitude and latitude, 44-tissue box detection, 45-baby
in arm detection, 46-label detection, 47-decoration detection, 48-face score, 49-face No., 50-violation description, 51-
marked speed limit, 52-segment speed, 53-segment distance, 54-segment overspeed ratio, 55-segment name, 56-
segment ID, 57-traffic accident detection, 58-smoking, 59-wearing helmet, 60-manned, 61-congestion-->
</itemType>
<itemOverlayEnabled>
<!--req, xs:boolean, whether to overlay the item-->
</itemOverlayEnabled>
<customName>
<!--req, xs:string, custom overlaying name, the maximum length is 32 bytes (including '\0'). If this node is set to
none or NULL, the default name will be overlayed-->
</customName>
<changeLineNum>
<!--req, xs:integer, number of line feeds, which is between 0 and 100 and the default value is 0-->
</changeLineNum>
<spaceNum>
<!--req, xs:integer, number of spaces, which is between 0 and 255 and the default value is 0-->
</spaceNum>
<startPosEnable>
<!--dep, xs:boolean, whether to enable coordinate configuration, which is only valid for overlaying within the
picture. After enabling coordinate configuration, the function of line feed and space will be invalid, so you are
recommended to disable coordinate configuration-->
</startPosEnable>
<startPosTop>
<!--req, xs:integer, start top coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture height, and the default value is 0-->
</startPosTop>
<startPosLeft>
<!--req, xs:integer, start left coordinate, which is only valid for overlaying within the picture, the value is between 0
and the actual picture width, and the default value is 0-->
</startPosLeft>
<overlayInfoText>
<!--dep, xs:string, overlay character string, which is valid when <itemType> is set to place, intersection No., device
No., direction No., direction description, lane information and camera. The maximum string length of place is 128
bytes, the maximum string length of intersection No., device No., direction No., direction description and lane
information is 32 bytes., the maximum string length of camera 1 is 44 bytes, and the maximum string length of
verification unit, verification certificate No., and calibration expiration date is 128 bytes-->
</overlayInfoText>
<overlayInfoText2>
<!--dep, xs:string, overlay character string for camera 2, which is valid when <itemType> is set to camera, and the
maximum string length of camera 2 is 32 bytes-->
</overlayInfoText2>
</OverlayInfo>

354
Intelligent Security API (Traffic) Developer Guide

B.204 XML_OverlayInfoList
OverlayInfoList message in XML format
<OverlayInfoList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<OverlayInfo/><!--see details in the message of XML_OverlayInfo-->
</OverlayInfoList>

See Also
XML_OverlayInfo

B.205 XML_ParkingCap
ParkingCap capability message in XML format
<ParkingCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportTME><!--optional, xs:boolean, whether it supports TME nodes--></isSupportTME>
<isSupportLampCtrl><!--optional, xs:boolean, whether it supports configuring and controlling parking space
indicators--></isSupportLampCtrl>
<isSupportparkingStatus><!--optional, xs:boolean, whether it supports getting parking space status--></
isSupportparkingStatus>
<isSupportPicDevision><!--optional, xs:boolean, whether it supports parking space picture division--></
isSupportPicDevision>
<isSupportAlterCtrlLampCap><!--optional, xs:boolean, whether it supports alternate indicator control--></
isSupportAlterCtrlLampCap>
<isSupportParkingSpace><!--optional, xs:boolean, whether it supports parking region configuration--></
isSupportParkingSpace>
<isSupportVideoParkingPole><!--optional, xs:boolean, whether it supports video station--></
isSupportVideoParkingPole>
</ParkingCap>

B.206 XML_PicModel
PicModel message in XML format
<PicModel version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable>
<!--req, xs: boolean, whether to enable picture modeling for searching by picture: "true,false"-->
</enable>
</PicModel>

B.207 XML_PicModelCap
PicModelCap message in XML format

355
Intelligent Security API (Traffic) Developer Guide

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


<enable opt="true,false">
<!--req, xs: boolean, whether to enable picture modeling for searching by picture-->
</enable>
</PicModelCap>

B.208 XML_PicParam
PicParam message in XML format
<PicParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<PictureCfg>
<mode> <!--req, xs:string,"quality,size"--> </mode>
<pictureQuality> <!--dep, xs:integer,1-100 --> </pictureQuality>
<pictureSize> <!--dep, xs:integer,unit:kb --> </pictureSize>
</PictureCfg>
<Overlap>
<enabled> <!--req, xs: boolean> </enabled>
<OverlapItemList >
<OverlapItem>
<id><!--req, xs:interger --><id>
<item opt="">
<!--req, xs:string, "positionNo, positionInfo, cameraNo, captureTime, plateNo, vehicleColor, sceneName, carType,
vehicleLogo, sceneNo, direction, validity"-->
</item>
</OverlapItem>
</OverlapItemList >
<fontColor> <!--opt, xs: hexBinary;color --> </fontColor>
<backColor> <!--opt, xs: hexBinary;color --> </backColor>
</Overlap>
<PlateEnhancement><!--opt, license plate enhancement on captured picture-->
<enabled><!--opt, xs:boolean, whether to enable license plate enhancement on captured picture, by default, it is
set to false--></enabled>
<level><!--opt, xs:integer, license plate enhancement level range: [0,100], by default, it is set to 50--></level>
</PlateEnhancement>
</PicParam>

Note
The node pictureQulity is required when the node mode is set to "quality", and the node
pictureSize is required when the node mode is set to "size".

B.209 XML_PicRecInfoSearchDescription
PicRecInfoSearchDescription message in XML format
<PicRecInfoSearchDescription version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string--></searchID>

356
Intelligent Security API (Traffic) Developer Guide

<VehicleList><!--opt-->
<Vehicle><!--req, xs: list-->
<vehicleID><!--req, xs: string--></vehicleID>
<channel><!--req, xs: integer, channel No. of camera--></channel>
<ctrl><!--req, xs: string--></ctrl>
<drive><!--req, xs: string--></drive>
<part><!--req, xs: string--></part>
<fileNo><!--req, xs: string--></fileNo>
<startOffset><!--req, xs: string--></startOffset>
<picLen><!--req, xs: string--></picLen>
<captureTime><!--req, xs: string, captured time for video search--></captureTime>
<violationType>
<!--req, xs: integer, violation type, if its value is 0, it indicates that no violation occurred, and there is no need to
search for video-->
</violationType>
</Vehicle>
</VehicleList>
</PicRecInfoSearchDescription>

B.210 XML_PicRecInfoSearchResult
PicRecInfoSearchResult message in XML format
<PicRecInfoSearchResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string--></searchID>
<responseStatus><!--req, xs: boolean--></responseStatus>
<responseStatusStrg><!--req, xs: string--></responseStatusStrg>
<resultList><!--req-->
<result><!--opt, list-->
<vehicleID><!--req, xs: string--></vehicleID>
<features><!--opt-->
<pilotsafebelt><!--opt, xs: string, whether the driver wearing seat belt: unknown, yes, no--></pilotsafebelt>
<vicepilotsafebelt><!--opt, xs: string, whether the co-driver wearing seat belt: unknown, yes, no--></
vicepilotsafebelt>
<pilotsunvisor><!--opt, xs: string, whether the sun visor of driver room is open: unknown, yes, no--></
pilotsunvisor>
<vicepilotsunvisor><!--req, xs: string, whether the sun visor of co-driver room is open: unknown, yes, no--></
vicepilotsunvisor>
<envprosign><!--opt, xs: string, whether it is a yellow-label vehicle: unknown, yes, no--></envprosign>
<dangmark><!--opt, xs: string, whether it is a dangerous goods vehicle: unknown, yes, no--></dangmark>
<uphone><!--opt, xs: string, whether the driver is making call: unknown, yes, no--></uphone>
<pendant><!--opt, xs: string, whether the vehicle window hanging is detected: unknown, yes, no--></pendant>
<tissueBox><!--opt, xs: string, whether the tissue box is detected: unknown, yes, no--></tissueBox>
<frontChild><!--opt, xs: string, whether the co-driver is carrying a baby in his or her arms: unknown, yes, no--></
frontChild>
<label><!--opt, xs: string, whether the label is detected: unknown, yes, no--></label>
<decoration><!--opt, xs: string, whether the decoration is detected: unknown, yes, no--></decoration>
<smoking><!--opt, xs: string, whether the smoking is detected: unknown, yes, no--></smoking>
<perfumeBox><!--opt, xs: string, whether the perfume bottle is detected: unknown, yes, no--></perfumeBox>
<pdvs><!--opt, xs: string, whether the sticking out of sunroof is detected: unknown, yes, no--></pdvs>

357
Intelligent Security API (Traffic) Developer Guide

<human><!--opt, xs: string, person information-->


<gender><!--req, gender: male, female--></gender>
<age><!--req, xs: integer, age--></age>
<glass><!--req, xs: string, whether wearing glasses: unknown, yes, no--></glass>
<name><!--opt, xs: string, person name--></name>
<certificateNo><!--opt, xs: string, certificate number--></certificateNo>
<familyAddress><!--opt, xs: string, home address--></familyAddress>
</human>
</features>
<pictures><!--opt-->
<picture><!--opt, xs: list-->
<type>
<!--req, xs: integer, picture type: 0-license plate picture, 1-normal picture, 2-composite picture, 3-close-up
picture, 4-binary picture, 6-face thumbnail of driver, 7-face thumbnail of co-driver-->
</type>
<datatype><!--req, xs: string, picture name--></datatype>
<vehicleLogoRecog><!--req, xs: string, vehicle brand--></vehicleLogoRecog>
<vehicleSubLogoRecog><!--req, xs: string, sub vehicle brand--></vehicleSubLogoRecog>
<vehicleModel><!--req, xs: string, model of sub vehicle brand--></vehicleModel>
<vehicleType><!--req, xs: string, vehicle type--></vehicleType>
<vehicleClassification><!--req, xs: string, vehicle classification--></vehicleClassification>
</picture>
</pictures>
<video><!--opt-->
<numOfMatches><!--req, xs: integer--></numOfMatches>
<exist><!--req, xs: boolean, whether the video segment exists in this record--></exist>
<searchMatchItem><!--control playing according to start and end time-->
<startTime><!--req, xs: string--></startTime>
<endTime><!--req, xs: string--></endTime>
<trackID><!--req, xs: string, track ID of video segment--></trackID>
<playbackURI><!--req, xs: string--></playbackURI>
</searchMatchItem>
<searchMatchItem><!--opt, xs: string--></searchMatchItem>
</video>
</result>
</resultList>
</PicRecInfoSearchResult>

B.211 XML_PlateBright
PlateBright message in XML format
<PlateBright version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<plateBrightEnabled>
<!--req, xs:boolean, whether to enable license plate brightness compensation-->
</plateBrightEnabled>
<plateBrightSensitivity>
<!--dep, xs:integer, license plate brightness compensation sensitivity, which ranges from 1 to 100-->
</plateBrightSensitivity>
<correctFactorEnabled>

358
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:boolean, whether to enable supplement light correction factor-->


</correctFactorEnabled>
<correctFactor>
<!--dep, xs:integer, supplement light correction factor, which ranges from 0 to 100-->
</correctFactor>
</PlateBright>

B.212 XML_PlateRecognition
PlateRecognition message in XML format
<PlateRecognition version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<triggerMode>
<!--req, xs:string,
"postIOSpeed,postSingleIO,postRS485,postRadar,postVTCoil,postMixedLane,postMpr,epoliceRS485,postEpoliceRS485,
videoEpolice"-->
</triggerMode>
<backupType>
<!--req xs:integer, backup mode type: 1-normal mode, 0-backup mode (it is valid when the trigger mode is virtual
coil)-->
</backupType>
<plateRecogEnabled>
<!--dep, xs:boolean, whether to enable license plate recognition function of this region-->
</plateRecogEnabled>
<regionMode>
<!--req, xs:string, region type, "rectangle, polygon"-->
</regionMode>
<plateRegionCount>
<!--req, xs:integer, total number of linked license plate recognition regions-->
</plateRegionCount>
<PlateRegionList><!--req-->
<PlateRegion><!--req-->
<regionId><!--req, xs:integer, region ID--></regionId>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--req-->
<positionX><!--req, xs:integer, X-coordinate--></positionX>
<positionY><!--req, xs:integer, Y-coordinate--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</PlateRegion>
</PlateRegionList>
</PlateRecognition>

B.213 XML_PlateRecognitionList
PlateRecognitionList message in XML format

359
Intelligent Security API (Traffic) Developer Guide

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


<plateRecognition/><!--req, see details in the message of XML_PlateRecognition-->
</PlateRecognitionList>

See Also
XML_PlateRecognition

B.214 XML_PlateRecognitionParam
PlateRecognitionParam message in XML format
<PlateRecognitionParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<defaultCHN>
<!--req, xs:string, province/state abbreviation-->
</defaultCHN>
<frontPlateRecoEnabled>
<!--dep, xs:boolean, front license plate recognition-->
</frontPlateRecoEnabled>
<rearPlateRecoEnabled>
<!--dep, xs:boolean, rear license plate recognition-->
</rearPlateRecoEnabled>
<smallPlateRecoEnabled>
<!--dep, xs:boolean, small license plate recognition-->
</smallPlateRecoEnabled>
<largePlateRecoEnabled>
<!--dep, xs:boolean, large license plate recognition-->
</largePlateRecoEnabled>
<farmVehicleEnabled>
<!--dep, xs:boolean, agricultural vehicle recognition-->
</farmVehicleEnabled>
<motorEnabled>
<!--dep, xs:boolean, motorcycle recognition-->
</motorEnabled>
<fuzzyDiscEnabled>
<!--dep, xs:boolean, fuzzy recognition-->
</fuzzyDiscEnabled>
<microPlateRegEnabled>
<!--dep, xs:boolean, tiny license plate recognition-->
</microPlateRegEnabled>
<cAPlateRegEnabled>
<!--dep, xs:boolean, civil aviation license plate recognition-->
</cAPlateRegEnabled>
<tiltPlateRegEnabled>
<!--dep, xs:boolean, tilted license plate recognition-->
</tiltPlateRegEnabled>
<superPlateRecoEnabled>
<!--dep, xs:boolean, oversized license plate recognition-->
</superPlateRecoEnabled>
<embassyPlateRecoEnabled>
<!--dep, xs:boolean, embassy license plate recognition-->

360
Intelligent Security API (Traffic) Developer Guide

</embassyPlateRecoEnabled>
</PlateRecognitionParam>

B.215 XML_PostHVT
PostHVT message in XML format
<PostHVT version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<relatedLaneCount>
<!--req, xs: integer, total number of linked lanes, which is between 1 and 3-->
</relatedLaneCount>
<backupType>
<!--req, xs:integer, backup mode: 0-none, 1-checkpoint vehicle detector trigger mode-->
</backupType>
<DetectSnapType><!--req, violation detection type-->
<intervalType>
<!--req, xs: string, interval type of continuous capture, "time,distance"-->
</intervalType>
<IntervalList><!--req, list-->
<Interval><!--req-->
<intervalValue>
<!--req, xs: integer, interval of continuous capture, unit: millisecond or decimeter-->
</intervalValue>
</Interval>
</IntervalList>
<post><!--req, xs: boolean, whether to enable checkpoint trigger mode--></post>
<postCapNo>
<!--dep, xs:integer, number of continuously captured pictures, which is between 0 and 3-->
</postCapNo>
<reverse><!--req, xs: boolean, whether to enable wrong-way driving trigger mode--></reverse>
<reverseCapNo>
<!--dep, xs: integer, number of continuously captured pictures, which is between 2 and 3-->
</reverseCapNo>
<overSpeed><!--req, xs: boolean, whether to enable overspeed trigger mode--></overSpeed>
<overSpeedCapNo>
<!--dep, xs: integer, number of continuously captured pictures, which is between 2 and 3-->
</overSpeedCapNo>
<lowSpeed><!--req, xs: boolean, whether to enable low speed trigger mode--></lowSpeed>
<lowSpeedCapNo>
<!--dep, xs: integer, number of continuously captured pictures, which is between 2 and 3-->
</lowSpeedCapNo>
<driveLine>
<!--req, xs: boolean, whether to enable the trigger mode of driving on lane line-->
</driveLine>
<driveLineCapNo>
<!--dep, xs:integer, number of continuously captured pictures in which the driving on lane line happened, which is
between 2 and 3-->
</driveLineCapNo>
<driveLineSensitivity>
<!--req, xs:integer, detection sensitivity, which is between 1 and 5-->

361
Intelligent Security API (Traffic) Developer Guide

</driveLineSensitivity>
<banSign><!--req, xs: boolean, whether to enable ban breaking trigger mode--></banSign>
<banSignCapNo>
<!--dep, xs: integer, number of continuously captured pictures in which the ban is broken, which is between 2 and
3-->
</banSignCapNo>
<highBeam><!--opt, xs: boolean, whether to enable high beam trigger mode--></highBeam>
<highBeamCapNo>
<!--opt, xs: integer, number of captured picture, which is between 2 and 3-->
</highBeamCapNo>
<highBeamConfidence><!--opt, xs: integer, confidence in high beam trigger mode--></highBeamConfidence>
<changeLane><!--opt, xs: boolean, whether to enable illegal lane change trigger mode--></changeLane>
<changeLaneCapNo>
<!--opt, xs: integer, number of captured pictures, which is between 2 and 3-->
</changeLaneCapNo>
<longChangeLane><!--opt, long-distance lane change-->
<enabled><!--req, xs: boolean, whether to enable long-distance lane change--></enabled>
<capNo><!--req, xs: integer, number of captured pictures in which the long-distance lane change happened--></
capNo>
<sensitivity><!--req, xs: integer, detection sensitivity--></sensitivity>
</longChangeLane>
<gasser><!--opt, queue jumping-->
<enabled><!--req, xs: boolean, whether to enable queue jumping detection--></enabled>
<gasserCapNo>
<!--req, xs: integer, number of captured pictures in which the queue jumping happened, which is between 2 and
3-->
</gasserCapNo>
<sensitivity><!--req, xs: integer, detection sensitivity--></sensitivity>
<congestionThreshold>
<!--req, xs: integer, congestion threshold, which is between 1 and 100-->
</congestionThreshold>
<capInterval>
<!--req, xs: integer, time interval of continuous capture (2 to 3 pictures), unit: millisecond-->
</capInterval>
</gasser>
<congestion><!--opt, congestion-->
<interval><!--req, integer, alarm time interval, unit: minute--></interval>
<sensitivity><!--req, xs: integer, congestion sensitivity--></sensitivity>
<lastTime><!--req, xs: integer, congestion duration, unit: second--></lastTime>
</congestion>
<accident><!--opt, accident detection-->
<enabled><!--req, xs: boolean, whether to enable accident detection--></enabled>
<lastTime><!--req, xs: integer, accident duration, unit: second--></lastTime>
<interval><!--req, xs: integer, time interval of continuous capture, unit: minute--></interval>
</accident>
<singleLaneFaceSnap>
<!--opt, xs: boolean, whether to enable face capture in a single lane-->
</singleLaneFaceSnap>
<helmetCapNo min="1" max="3">
<!--dep, xs:integer, this node is valid when <helmet> is "true"-->
</helmetCapNo>
<twoWheelPassengerCapNo min="1" max="3">

362
Intelligent Security API (Traffic) Developer Guide

<!--dep, xs:integer, this node is valid when <twoWheelPassenger> is "true"-->


</twoWheelPassengerCapNo>
<threeWheelPassengerCapNo min="1" max="3">
<!--dep, xs:integer, this node is valid when <threeWheelPassenger> is "true"-->
</threeWheelPassengerCapNo>
</DetectSnapType>
<sceneMode><!--req, xs:string, scene mode, "urban"-urban road, "entrance"-community entrance and exit,
"highway"--></sceneMode>
<snapType><!--req, xs: string, captured object type, "mixObject"-motor vehicle, non-motor vehicle and pedestrian,
"motor"-motor vehicle, "nonmotor"-non-motor vehicle--></snapType>
<capMode><!--req, xs:string, capture mode: "videoFrame"-strobe light mode, "capFrame"-flash light mode,
"mixFrame"-mixed mode--></capMode>
<detectMode opt="video,coilLoop"><!--req, xs: string, detection mode, "video,coilLoop"--></detectMode>
<speedDetector><!--req, xs: string, speed detection mode: "non"-none, "radarSpeed"-radar speed detection,
"videoSpeed"-video speed detection--></speedDetector>
<trigLineEffect><!--req, xs: integer, validity of triggering line: bit0-left triggering line, bit1-right triggering line, bit2-
target detection area--></trigLineEffect>
<carHighSpeed><!--req, xs: integer, abnormal overspped, unit: km/h--></carHighSpeed>
<carLowSpeed><!--req, xs: integer, abnormal low speed, unit: km/h--></carLowSpeed>
<bigCarHighSpeed><!--req, xs: integer, abnormal overspeed of large-sized vehicle, unit: km/h--></bigCarHighSpeed>
<bigCarLowSpeed><!--req, xs: integer, abnormal low speed of small-sized vehicle, unit: km/h--></bigCarLowSpeed>
<LaneParamList><!--req-->
<LaneParam><!--list-->
<laneId><!--req, xs: integer, lane No.--></laneId>
<laneNO><!--req, xs: integer, lane No. displayed on the picture--></laneNO>
<relatedDriveWay><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<laneUsage><!--req, xs: string, lane usage:, "carriageway"-normal lane, "busway"-bus lane, "banTrunks"-truck
prohibited lane--></laneUsage>
<laneType>
<!--req, xs:string, lane type, "none"-not configured, "highway"-high way, "urbanFastWay"-urban
expressway,"other"-->
</laneType>
<laneDirectionType><!--req, xs:integer, lane direction type, "0-8"--></laneDirectionType>
<carDriveDirect><!--req, xs:integer, vehicle driving direction: 0-unknown, 1-downward, 2-upward--></
carDriveDirect>
<signSpeed><!--req, xs: integer, marked speed limit, unit: km/h--></signSpeed>
<speedLimit><!--req, xs: integer, maximum speed limit, unit: km/h--></speedLimit>
<lowSpeedLimit><!--req, xs: integer, minimum speed limit, unit: km/h--></lowSpeedLimit>
<bigCarSignSpeed><!--req, xs: integer, marked speed limit for large-sized vehicle, unit: km/h--></bigCarSignSpeed>
<bigCarSpeedLimit><!--req, xs:integer--></bigCarSpeedLimit>
<bigCarHighSpeedLimit><!--req, xs: integer, maximum speed limit for large-sized vehicle, unit: km/h--></
bigCarHighSpeedLimit>
<bigCarLowSpeedLimit><!--req, xs: integer, minimum speed limit for large-sized vehicle, unit: km/h--></
bigCarLowSpeedLimit>
<Radar><!--req-->
<radarType><!--req, xs: string, radar type: "none", "adr"-Andoray, "adr4Byte"-Andoray (no radar controller),
"olvia"-Olvia, "csr"-TransMicrowave, "IOBox"-radar connecting I/O expansion box, "SSTK"-WHST, "custom"-custom
type--></radarType>
<enableRadarTestMode><!--opt, xs: boolean, whether to enable radar detection mode--></
enableRadarTestMode>
<radarSensitivity><!--req, xs: integer, radar sensitivity--></radarSensitivity>
<radarAngle>

363
Intelligent Security API (Traffic) Developer Guide

<!--req, xs: integer, angle between radar and horizontal direction, which is between 0 and 90 and the default
value is 0-->
</radarAngle>
<validRadarSpeedTime>
<!--req, xs: integer, effective time of radar speed, which is between 0 and 2000, unit: millisecond-->
</validRadarSpeedTime>
<radarLinearCorrection>
<!--req, xs: float, min: 0.001, max: 2.0, linear correction parameter, which is between 0.0 and 2.0, the actual
value should be the configured value multiplying 1000-->
</radarLinearCorrection>
<radarConstantCorrection>
<!--req, xs:integer, constant correction parameter, which is between -100 and 100-->
</radarConstantCorrection>
<radarRS485><!--req, xs: integer, radar linked RS-485 port No. If this capability is not supported or this node is set
to 1, it indicates that only 1 RS-485 ports can be supported--></radarRS485>
</Radar>
<banTrucksTimeSwitchList><!--req, list of truck prohibited time periods, up to 4 time periods can be configured-->
<banTrucksTimeSwitch><!--req, list-->
<timeId><!--req, xs: integer, time period No., which is between 1 and 4--></timeId>
<startHour><!--dep, xs: integer, start time (hour), which is between 0 and 23--></startHour>
<startMinute><!--dep, xs: integer, start time (minute), which is between 0 and 59--></startMinute>
<endHour><!--dep, xs: integer, end time (hour), which is between 0 and 23--></endHour>
<endMinute><!--dep, xs: integer, end time (minute), which is between 0 and 59--></endMinute>
</banTrucksTimeSwitch>
</banTrucksTimeSwitchList>
<emergencyTimeSwitchList>
<!--req, effective time periods of emergency lane, up to 4 time periods can be configured-->
<emergencyTimeSwitch><!--req-->
<timeId><!--req, xs: integer, time period No., which is between 1 and 4--></timeId>
<startHour><!--dep, xs: integer, start time (hour), which is between 0 and 23--></startHour>
<startMinute><!--dep, xs: integer, start time (minute), which is between 0 and 59--></startMinute>
<endHour><!--dep, xs: integer, end time (hour), which is between 0 and 23--></endHour>
<endMinute><!--dep, xs: integer, end time (minute), which is between 0 and 59--></endMinute>
</emergencyTimeSwitch>
</emergencyTimeSwitchList>
<IOOutList><!--req, xs: interger-->
<IOOut><!--req, xs: integer, linked alarm output-->
<id><!--req, xs:integer, linked alarm output No., which is between 1 and 8--></id>
<enabled><!--req, xs:boolean, whether to link IO output--></enabled>
</IOOut>
</IOOutList>
<flashMode><!--req, xs: string, flashing mode of the flash light, "together,alternation"--></flashMode>
<LaneLine><!--req, draw violation detection line for a single lane-->
<lineName><!--req, xs: string, detection line name, "laneLine", which can only be used for a single lane--></
lineName>
<lineType>
<!--req, xs:string, detection line type: "unknown", "white"-white solid line, "singleYellow"-single yellow line,
"doubleYellow"-double yellow line, "guardRail"-with guardrail, "noCross"-lane line prohibited to cross by vehicle-->
</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>

364
Intelligent Security API (Traffic) Developer Guide

<positionY><!--req, xs: integer--></positionY>


</RegionCoordinates>
</RegionCoordinatesList>
</LaneLine>
</LaneParam>
</LaneParamList>
<LaneRightBoundaryLine><!--req, draw violation detection line for all lanes-->
<lineName><!--req, xs:string, detection line name, "laneRightBoundaryLine", which can be used for all lanes--></
lineName>
<lineType>
<!--req, xs:string, detection line type: "unknown", "white"-white solid line, "singleYellow"-single yellow line,
"doubleYellow"-double yellow line, "guardRail"-with guardrail, "noCross"-lane line prohibited to cross by vehicle-->
</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneRightBoundaryLine>
<TriggerLine><!--req, draw triggering line for all lanes-->
<lineName><!--req, xs:string, triggering line name, "triggerLine", which can be used for all lanes--></lineName>
<lineType>
<!--req, xs:string, detection line type: "unknown", "white"-white solid line, "singleYellow"-single yellow line,
"doubleYellow"-double yellow line, "guardRail"-with guardrail, "noCross"-lane line prohibited to cross by vehicle-->
</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</TriggerLine>
<LeftTriggerLine><!--req, draw left triggering line for all lanes-->
<lineName><!--req, xs:string, triggering line name, "leftTriggerLine", which is used for all lanes--></lineName>
<lineType>
<!--req, xs:string, detection line type: "unknown", "white"-white solid line, "singleYellow"-single yellow line,
"doubleYellow"-double yellow line, "guardRail"-with guardrail, "noCross"-lane line prohibited to cross by vehicle-->
</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LeftTriggerLine>
<RightTriggerLine><!--req, draw right triggering line for all lanes-->
<lineName><!--req, xs:string, triggering line name, "rightTriggerLine", whichi is used for all lanes--></lineName>
<lineType>
<!--req, xs:string, detection line type: "unknown", "white"-white solid line, "singleYellow"-single yellow line,
"doubleYellow"-double yellow line, "guardRail"-lane line with guardrail, "noCross"-lane line prohibited to cross by
vehicle-->

365
Intelligent Security API (Traffic) Developer Guide

</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</RightTriggerLine>
<ObjectDetectAera><!--draw target detection area for all lanes-->
<DetectAera><!--req-->
<DetectAeraCoordinatesList><!--req-->
<AeraCoordinates><!--list, req-->
<positionX><!--req, xs:integer--></positionX>
<positionY><!--req, xs:integer--></positionY>
</AeraCoordinates>
</DetectAeraCoordinatesList>
</DetectAera>
</ObjectDetectAera>
<HighBeamTriggerLine><!--opt-->
<lineName><!--req, xs:string, triggering line name, "highBeamTriggerLine"--></lineName>
<lineType>
<!--req, xs:string, "unknown,white, singleYellow, doubleYellow,guardRail,noCross"-->
</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</HighBeamTriggerLine>
<safeBeltCapNo>
<!--dep, xs: integer, number of captured pictures in which the driver does not buckle up the seat belt, which is
between 1 and 3, this node is valid only when <safeBeltEnabled> is "true"-->
</safeBeltCapNo>
<uphoneCapNo>
<!--dep, xs: integer, this node is valid when <uphoneEnabled>is "true"-->
</uphoneCapNo>
<nonMotorExistCapNo>
<!--opt, xs:boolean, number of captured pictures in which the motor vehicle lane is occupied by non-motor
vehicles-->
</nonMotorExistCapNo>
<shedCapNo>
<!--dep, xs: integer, number of captured pictures, and this node is valid only when <shed> is "true"-->
</shedCapNo>
<capType>
<!--opt, xs:string, "vehicle,nonMotor,human,face"-->
</capType>
</PostHVT>

366
Intelligent Security API (Traffic) Developer Guide

B.216 XML_PostPRS
PostPRS message in XML format
<PostPRS version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<triggerType>
<!--req, xs: string, "videoDetection,IO,RS485,radarDetection"-->
</triggerType>
<captureMode>
<!--dep, xs: string, "strobe,flashing", it is valid when triggerType is "videoDetection"-->
</captureMode>
<totalLaneNum>
<!--req, xs: integer-->
</totalLaneNum>
<LaneParamList/><!--req, lane parameters-->
<VirtualLane/><!--req, all detection lines-->
<noPlatCarCap><!--ro, xs: boolean--></noPlatCarCap>
<sceneMode>
<!--opt, xs: string, scene mode: "commonEntrance"-common entrance and exit scene, "tollGate"-toll station scene
(vehicles will stay for longer time), "ParkingEntrance"-entrance and exit of underground parking lot scene (there will
be dark day and night)-->
</sceneMode>
<capPicMode opt="scene,sceneCloseup">
<!--opt, xs: string, captured picture type: "scene"-scene picture, "sceneCloseup"-scene picture and close-up picture--
>
</capPicMode>
<radarDetection><!--opt, radar detection mode, it is valid when workMode is "RadarDetection"-->
<detectDistance1 min="0" max="2000">
<!--req, xs: integer, radar detection distance, unit: cm-->
</detectDistance1>
<detectDistance2 min="0" max="2000">
<!--req, xs: integer, radar detection distance, unit: cm-->
</detectDistance2>
<alarmDistance min="0" max="600" def="300">
<!--req, xs: integer, radar alarm distance, unit: cm-->
</alarmDistance>
</radarDetection>
</PostPRS>

B.217 XML_PostRadar
PostRadar message in XML format
<?xml version="1.0" encoding="utf-8"?>
<PostRadar version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<relatedLaneCount>
<!--req, xs: integer, number of linked lanes, which is between 1 and 4-->
</relatedLaneCount>
<PostRadarLaneList>

367
Intelligent Security API (Traffic) Developer Guide

<PostRadarLane>
<laneId><!--req, xs: integer, lane No., which is between 1 and 4--></laneId>
<relatedDriveWay><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<laneType>
<!--req, xs: string, lane type, "none"-not configured, "highway"-high way, "urbanFastWay"-urban expressway,
"other"-other-->
</laneType>
<distance><!--req, xs: integer, distance between each loops--></distance>
<delayTime><!--req, xs: integer, trigger delay time--></delayTime>
<delayDistance><!--req, xs: integer, trigger delay distance, unit: decimeter--></delayDistance>
<speedCapEnabled>
<!--req, xs: boolean, whether to enable capture when overspeed is detected-->
</speedCapEnabled>
<lowSpeedCapEnable>
<!--req, xs: boolean, whether to enable capture when low speed is detected-->
</lowSpeedCapEnable>
<emergencyCapEnable>
<!--req, xs: boolean, whether to enable capture when emergency lane occupancy is detected-->
</emergencyCapEnable>
<Radar><!--req-->
<radarType><!--req, xs: string, "none,adr,adr4Byte,olvia,csr,SSTK,custom"--></radarType>
<radarSensitivity><!--req, xs: integer, radar sensitivity--></radarSensitivity>
<radarAngle><!--req, xs: integer, radar angle, which is between 0 and 90--></radarAngle>
<radarLinearCorrection>
<!--req, xs: float, linear correction parameter, which is between 0.0 and 2.0-->
</radarLinearCorrection>
<radarConstantCorrection>
<!--req, xs: integer, constant correction parameter, which is between -100 and 100-->
</radarConstantCorrection>
<radarRS485>
<!--req, xs: integer, RS-485 port number that linked with radar, which is between 1 and 5-->
</radarRS485>
</Radar>
<signSpeed><!--req, xs: integer, signed speed limit, unit: km/h--></signSpeed>
<speedLimit><!--req, xs: integer, speed limit, unit: km/h--></speedLimit>
<bigCarSignSpeed><!--req, xs: integer, signed speed limit of large-sized vehicle, unit: km/h--></bigCarSignSpeed>
<bigCarSpeedLimit><!--req, xs: integer, speed limit of large-sized vehicle, unit: km/h--></bigCarSpeedLimit>
<lowSpeedLimit><!--req, xs: integer, speed lower-limit of small-sized vehicle, unit: km/h--></lowSpeedLimit>
<bigCarLowSpeedLimit><!--req, xs: integer, speed lower-limit of large-sized vehicle, unit: km/h--></
bigCarLowSpeedLimit>
<carHighSpeed><!--req, xs: integer, overspeed (lane No.1), unit: km/h--></carHighSpeed>
<carLowSpeed><!--req, xs: integer, low speed (lane No.1), unit: km/h--></carLowSpeed>
<bigCarHighSpeed><!--req, xs: integer, large-sized vehicle overspeed (lane No.1), unit: km/h--></bigCarHighSpeed>
<bigCarLowSpeed><!--req, xs: integer, large-sized vehicle low speed (lane No.1), unit: km/h--></bigCarLowSpeed>
<snapTimes><!--req, xs: integer, number of captured pictures, which is between 0 and 5--></snapTimes>
<intervalType><!--req, xs: string, interval type of continuous capture, "time", "distance"--></intervalType>
<IntervalList><!--req-->
<Interval><!--req-->
<value><!--req, xs: integer, interval of continuous capture, unit: millisecond or decimeter--></value>
</Interval>
</IntervalList>
<IOOutList><!--req, xs: integer-->

368
Intelligent Security API (Traffic) Developer Guide

<IOOut><!--req-->
<id><!--req, xs: integer, linked I/O output No., which is between 1 and 8--></id>
<enabled><!--req, xs: boolean, whether to link the I/O output--></enabled>
</IOOut>
</IOOutList>
<flashMode><!--req, xs: string, flashing mode of flashing light, "together,alternation"--></flashMode>
<laneUsage>
<!--req, xs: string, lane usage, "carriageWay"-normal lane, "banTrucks"-lan banning large-sized vehicle,
"emergency"-emergency lane-->
</laneUsage>
<laneDirectionType><!--req, xs: integer, lane direction which is between 0 and 8--></laneDirectionType>
<emergencyTimeSwitchList>
<!--req, effective time periods of emergency lane, up to 4 time periods can be configured-->
<emergencyTimeSwitch><!--req-->
<timeId><!--req, xs: integer, time period No., which is between 1 and 4--></timeId>
<startHour><!--dep, xs: integer, start time (hour), which is between 0 and 23--></startHour>
<startMinute><!--dep, xs: integer, start time (minute), which is between 0 and 59--></startMinute>
<endHour><!--dep, xs: integer, end time (hour), which is between 0 and 23--></endHour>
<endMinute><!--dep, xs: integer, end time (minute), which is between 0 and 59--></endMinute>
</emergencyTimeSwitch>
</emergencyTimeSwitchList>
<LaneLine><!--req-->
<lineName><!--req, xs: string, "highBeamTriggerLine"--></lineName>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneLine>
</PostRadarLane>
</PostRadarLaneList>
<LaneRightBoundaryLine><!--req-->
<lineName><!--req xs:string,"laneRightBoundaryLine"--></lineName>
<lineType>
<!--req xs:string,"unknown,white, singleYellow, doubleYellow,guardRail,noCross"-->
</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneRightBoundaryLine>
<safeBelt><!--opt, xs: boolean, whether to enable seatbelt detection--></safeBelt>
<safeBeltCapNo>
<!--opt, xs: integer, number of captured pictures in which the driver does not wear the seatbelt, which is between 1
and 3-->
</safeBeltCapNo>
<uphone><!--opt, xs: boolean, whether to enable phone call detection--></uphone>
<uphoneCapNo>
<!--opt, xs: integer, number of captured pictures in which the driver is making call, which is between 1 and 3-->

369
Intelligent Security API (Traffic) Developer Guide

</uphoneCapNo>
</PostRadar>

B.218 XML_PostRadarParam
PostRadarParam message in XML format
<?xml version="1.0" encoding="utf-8"?>
<PostRadarParam version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id min="" max=""><!--opt, xs: integer, serial port number--></id>
<softWareVersion min="0" max="32"><!--opt, xs: string, software version No.--></softWareVersion>
<workMode opt="continue,headTrig,tailTrig,moveTrig,doubleTrig,other">
<!--opt, xs: string, radar working mode-->
</workMode>
<speedType opt="single,doubleByte,fourByte,other"><!--opt, xs: string--></speedType>
<directionFilter opt="nonefilter,outputCome,outputGo">
<!--opt, xs: string, "nonefilter"-unfiltered, "outputCome"-output the direction that the target comes from,
"outputGo"-output the direction that the target goes to-->
</directionFilter>
<angleCorrect min="" max=""><!--opt, xs: integer, corrected angle, value range: [0,70]--></angleCorrect>
<sensitivity min="" max=""><!--opt, xs: integer, sensitivity, value range: [11,240]--></sensitivity>
<speedLowLimit min="" max=""><!--opt, xs: integer, speed lower-limit, value range: [1,150km/h]--></speedLowLimit>
<trigDistance min="" max=""><!--opt, xs: integer, trigger distance, value range: [0,40m]--></trigDistance>
</PostRadarParam>

B.219 XML_PostRadarSpeed
PostRadarSpeed message in XML format
<?xml version="1.0" encoding="utf-8"?>
<PostRadarSpeed version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<laneType opt="none,highway,urbanFastWay,other">
<!--opt, xs: string,"none"-not configured, "highway"-high way, "urbanFastWay"-urban expressway, "other"-other-->
</laneType>
<checkPostEnabled>
<!--opt, xs: boolean, whether to enable checkpoint detection-->
</checkPostEnabled>
<overSpeedEnabled>
<!--opt, xs: boolean, whether to enable overspeed detection-->
</overSpeedEnabled>
<intervalTime min="" max="">
<!--opt, xs: integer, captured interval of overspeed detection, unit: ms-->
</intervalTime>
<signSpeed min="" max="">
<!--opt, xs: integer, speed limit sign of small-sized vehicle-->
</signSpeed>
<speedLimit min="" max="">
<!--opt, xs: integer, speed limit of small-sized vehicle, unit: km/h-->
</speedLimit>

370
Intelligent Security API (Traffic) Developer Guide

<lowSpeedLimit min="" max="">


<!--opt, xs: integer, low speed limit of small-sized vehicle, unit: km/h-->
</lowSpeedLimit>
<bigCarSignSpeed min="" max="">
<!--opt, xs: integer, speed limit sign of large-sized vehicle-->
</bigCarSignSpeed>
<bigCarSpeedLimit min="" max="">
<!--opt, xs: integer, speed limit of large-sized vehicle, unit: km/h-->
</bigCarSpeedLimit>
<bigCarLowSpeedLimit min="" max="">
<!--opt, xs: integer, low speed limit of large-sized vehicle, unit: km/h-->
</bigCarLowSpeedLimit>
</PostRadarSpeed>

B.220 XML_PostSideRadarSpeed
PostSideRadarSpeed message in XML format
<PostSideRadarSpeed version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable>
<!--required, xs:boolean, whether to enable trigger mode of side-mounted radar speed detection-->
</enable>
<relatedLaneCount>
<!--required, xs:integer, total number of linked lanes, it is between 1 and 3-->
</relatedLaneCount>
<post>
<!--required, xs:boolean, checkpoint-->
</post>
<postCapNo>
<!--required, xs:integer, number of pictures captured at checkpoint, it is between 0 and 3-->
</postCapNo>
<overSpeed>
<!--required, xs:boolean, whether it is overspeed-->
</overSpeed>
<overSpeedCapNo>
<!--required, xs:integer, number of captured pictures of overspeed, it is between 0 and 3-->
</overSpeedCapNo>
<lowSpeed>
<!--required, xs:boolean, whether it is low speed-->
</lowSpeed>
<lowSpeedCapNo>
<!--required, xs:integer, number of captured pictures of low speed, it is between 0 and 3-->
</lowSpeedCapNo>
<intervalType>
<!--required, xs:string, burst interval type: "time", "distance"-->
</intervalType>
<intervalList>
<!--required-->
<interval>
<!--required, list-->

371
Intelligent Security API (Traffic) Developer Guide

<intervalValue>
<!--required, xs:integer, burst interval, unit: ms or dm-->
</intervalValue>
</interval>
</intervalList>
<carHighSpeed>
<!--required, xs:integer, abnormal overspeed of small-sized vehicle-->
</carHighSpeed>
<carLowSpeed>
<!--required, xs:integer, abnormal low speed of smarll-sized vehicle-->
</carLowSpeed>
<bigCarHighSpeed>
<!--required, xs:integer, abnormal overspeed of large-sized vehicle, unit: km/h-->
</bigCarHighSpeed>
<bigCarLowSpeed>
<!--required, xs:integer, abnormal low speed of large-sized vehicle, unit: km/h-->
</bigCarLowSpeed>
<LaneParamList>
<!--required, lane parameters-->
<LaneParam>
<!--optional, list-->
<laneId>
<!--required, xs:integer-->
</laneId>
<laneNO>
<!--required, xs:integer, lane No.-->
</laneNO>
<relatedDriveWay>
<!--required, xs:integer, linked lane No.-->
</relatedDriveWay>
<carSignSpeed>
<!--required, xs:integer, marked speed limit for small-sized vehicle-->
</carSignSpeed>
<carSpeedLimit>
<!--required, xs:integer, maximum speed limit for small-sized vehicle-->
</carSpeedLimit>
<carLowSpeedLimit>
<!--required, xs:integer, minimum speed limit for small-sized vehicle-->
</carLowSpeedLimit>
<bigCarSignSpeed>
<!--required, xs:integer, marked speed limit for large-sized vehicle-->
</bigCarSignSpeed>
<bigCarSpeedLimit>
<!--required, xs:integer, maximum speed limit for large-sized vehicle-->
</bigCarSpeedLimit>
<bigCarLowSpeedLimit>
<!--required, xs:integer, minimum speed limit for large-sized vehicle-->
</bigCarLowSpeedLimit>
<vanSignSpeed>
<!--optional, xs:integer, marked speed limit for minivan-->
</vanSignSpeed>
<vanSpeedLimit>

372
Intelligent Security API (Traffic) Developer Guide

<!--optional, xs:integer, maximum speed limit for minivan-->


</vanSpeedLimit>
<vanLowSpeedLimit>
<!--optional, xs:integer, minimum speed limit for minivan-->
</vanLowSpeedLimit>
<vehicleSignSpeed>
<!--optional, xs:integer, marked speed limit for car-->
</vehicleSignSpeed>
<vehicleSpeedLimit>
<!--optional, xs:integer, maximum speed limit for car-->
</vehicleSpeedLimit>
<vehicleLowSpeedLimit>
<!--optional, xs:integer, minimum speed limit for car-->
</vehicleLowSpeedLimit>
<busSignSpeed>
<!--optional, xs:integer, marked speed limit for bus-->
</busSignSpeed>
<busSpeedLimit>
<!--optional, xs:integer, maximum speed limit for bus-->
</busSpeedLimit>
<busLowSpeedLimit>
<!--optional, xs:integer, minimum speed limit for bus-->
</busLowSpeedLimit>
<lightTruckSignSpeed>
<!--optional, xs:integer, marked speed limit for light truck-->
</lightTruckSignSpeed>
<lightTruckSpeedLimit>
<!--optional, xs:integer, maximum speed limit for light truck-->
</lightTruckSpeedLimit>
<lightTruckLowSpeedLimit>
<!--optional, xs:integer, minimum speed limit for light truck-->
</lightTruckLowSpeedLimit>
<mediumHeavyTruckSignSpeed>
<!--optional, xs:integer, marked speed limit for middle-sized truck and heavy truck-->
</mediumHeavyTruckSignSpeed>
<mediumHeavyTruckSpeedLimit>
<!--optional, xs:integer, maximum speed limit for middle-sized truck and heavy truck-->
</mediumHeavyTruckSpeedLimit>
<mediumHeavyTruckLowSpeedLimit>
<!--optional, xs:integer, minimum speed limit for middle-sized truck and heavy truck-->
</mediumHeavyTruckLowSpeedLimit>
<Radar>
<!--required-->
<radarType>
<!--required, xs:string, radar type: "none,adr,adr4Byte,olvia,csr,IOBox,SSTK,custom"-->
</radarType>
<radarSensitivity>
<!--required, xs:integer, sensitivity-->
</radarSensitivity>
<radarAngle>
<!--required, xs:integer, angle of radar and horizontal direction, it is between 0 and 90 and the default angle is 0,
unit: degree-->

373
Intelligent Security API (Traffic) Developer Guide

</radarAngle>
<validRadarSpeedTime>
<!--required, xs:integer, radar speed valid time, it is between 0 and 2000, unit: ms-->
</validRadarSpeedTime>
<radarLinearCorrection>
<!--required, xs:float, linear correction parameter, the displayed value is between 0.0 and 2.0, and the value sent
to the capture camera will be the displayed value multiplying 1000-->
</radarLinearCorrection>
<radarConstantCorrection>
<!--required, xs:integer, constant correction coefficient, it is between -100 and 100-->
</radarConstantCorrection>
<radarRS485>
<!--required, xs:integer, No. of RS-485 serial port linked to the radar, it is between 1 and 5-->
</radarRS485>
</Radar>
<IOOutList>
<!--required-->
<IOOut>
<!--required, list-->
<id>
<!--required, xs:integer, "1-8"-->
</id>
<enabled>
<!--required, xs:boolean-->
</enabled>
</IOOut>
</IOOutList>
<LaneLine>
<!--required-->
<lineName>
<!--required, xs:string, line name, e.g., "laneLine"-->
</lineName>
<lineType>
<!--required, xs:string, line type: "unknown,white,singleYellow,doubleYellow,guardRail,noCross"-->
</lineType>
<RegionCoordinatesList>
<!--required-->
<RegionCoordinates>
<!--only two coordinates are required-->
<positionX>
<!--required, xs:integer-->
</positionX>
<positionY>
<!--required, xs:integer-->
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneLine>
</LaneParam>
<LaneRightBoundaryLine>
<!--required-->
<lineName>

374
Intelligent Security API (Traffic) Developer Guide

<!--required, xs:string, line name, e.g, "laneRightBoundaryLine"-->


</lineName>
<lineType>
<!--required, xs:string, line type:
"unknown,white,singleYellow,doubleYellow,guardRail,noCross,dotLine,solidline,dotLine"-->
</lineType>
<RegionCoordinatesList>
<!--required-->
<RegionCoordinates>
<!--list, only two coordinates are required-->
<positionX>
<!--required, xs:integer-->
</positionX>
<positionY>
<!--required, xs:integer-->
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneRightBoundaryLine>
<TriggerLine>
<!--required-->
<lineName>
<!--required, xs:string, line name, e.g., "triggerLine"-->
</lineName>
<lineType>
<!--optional, xs:string, line type: "unknown,white,singleYellow,doubleYellow,guardRail,noCross,dotLine"-->
</lineType>
<RegionCoordinatesList>
<!--required, list-->
<RegionCoordinates>
<!--list, only two coordinates are required-->
<positionX>
<!--required, xs:integer-->
</positionX>
<positionY>
<!--required, xs:integer-->
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</TriggerLine>
</LaneParamList>
<reverse>
<!--opt, xs:boolean, whether it is wrong-way driving-->
</reverse>
<reverseCapNo>
<!--optional, xs:integer, number of captured pictures about wrong-way driving-->
</reverseCapNo>
<crossLane>
<!--optional, xs:boolean, whether it is driving on the lane line-->
</crossLane>
<crossLaneCapNo>
<!--optional, xs:integer, number of captured pictures about driving on the lane line-->

375
Intelligent Security API (Traffic) Developer Guide

</crossLaneCapNo>
</PostSideRadarSpeed>

B.221 XML_PostSingleIOList
PostSingleIOList message in XML format
<?xml version="1.0" encoding="utf-8"?>
<PostSingleIOList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<PostSingleIO>
<relatedIOIn>
<!--req, xs: string, linked I/O inputs, "IO1,IO2,IO3,IO4,IO5,IO6,IO7,IO8"-->
</relatedIOIn>
<enable>
<!--req, xs: boolean, whether to enable I/O input, up to 4 inputs can be enabled-->
</enable>
<emergencyCapEnable>
<!--req, xs: boolean, whether to enable capture when emergency lane occupancy is detected-->
</emergencyCapEnable>
<defaultStatus>
<!--req, xs: string, default I/O status, "rising,falling,both"-->
</defaultStatus>
<relatedDriveWay><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<snapTimes>
<!--req, xs: integer, number of captured pictures, which is between 0 and 5-->
</snapTimes>
<intervalType>
<!--req, xs: string, interval type of continuous capture, "time,distance"-->
</intervalType>
<IntervalList><!--req-->
<Interval><!--req-->
<value>
<!--req, xs: integer, continuous capture interval, unit: millisecond or decimeter-->
</value>
</Interval>
</IntervalList>
<IOOutList><!--req, xs: interger-->
<IOOut><!--req-->
<id><!--req, xs: integer, linked I/O output No., which is between 1 and 8--></id>
<enabled><!--req, xs: boolean, whether to linlk I/O output--></enabled>
</IOOut>
</IOOutList>
<flashMode>
<!--req, xs: string, flashing mode of flashing light, "together,alternation"-->
</flashMode>
<laneUsage>
<!--req, xs: string, lane usage, "carriageWay"-normal lane, "banTrucks"-lan banning large-sized vehicle,
"emergency"-emergency lane-->
</laneUsage>
<emergencyTimeSwitchList>

376
Intelligent Security API (Traffic) Developer Guide

<!--req, effective time periods of emergency lane, up to 4 time periods can be configured-->
<emergencyTimeSwitch><!--req-->
<timeId><!--req, xs: integer, time period No., which is between 1 and 4--></timeId>
<startHour><!--dep, xs: integer, start time (hour), which is between 0 and 23--></startHour>
<startMinute><!--dep, xs: integer, start time (minute), which is between 0 and 59--></startMinute>
<endHour><!--dep, xs: integer, end time (hour), which is between 0 and 23--></endHour>
<endMinute><!--dep, xs: integer, end time (minute), which is between 0 and 59--></endMinute>
</emergencyTimeSwitch>
</emergencyTimeSwitchList>
<LaneLine><!--req-->
<lineName><!--req, xs: string, "highBeamTriggerLine"--></lineName>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneLine>
</PostSingleIO>
<LaneRightBoundaryLine><!--req-->
<lineName><!--req xs:string,"laneRightBoundaryLine"--></lineName>
<lineType>
<!--req xs:string,"unknown,white, singleYellow, doubleYellow,guardRail,noCross"-->
</lineType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</LaneRightBoundaryLine>
<safeBelt><!--opt, xs: boolean, whether to enable seatbelt detection--></safeBelt>
<safeBeltCapNo>
<!--opt, xs: integer, number of captured pictures in which the driver does not wear the seatbelt, which is between 1
and 3-->
</safeBeltCapNo>
<uphone><!--opt, xs: boolean, whether to enable phone call detection--></uphone>
<uphoneCapNo>
<!--opt, xs: integer, number of captured pictures in which the driver is making call, which is between 1 and 3-->
</uphoneCapNo>
</PostSingleIOList>

B.222 XML_PowerDataSearchDescription
PowerDataSearchDescription message in XML format
<PowerDataSearchDescription version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string, search ID--></searchID>
<searchResultPostion><!--req, xs: integer, start search position--></searchResultPostion>
<mainMetaId><!--req, xs: integer, major type value--></mainMetaId>

377
Intelligent Security API (Traffic) Developer Guide

<subMetaId><!--req, xs: integer, minor type value--></subMetaId>


<dataType><!--req, xs: integer, data type: 0-history data, 1-alarm data--></dataType>
<timeSpanList>
<timeSpan>
<startTime><!--req, xs: time, format: yyyy-MM-ddTHH:mm:ssZ--></startTime>
<endTime><!--req, xs: time, format:yyyy-MM-ddTHH:mm:ssZ--></endTime>
</timeSpan>
</timeSpanList>
<maxResults><!--req, xs: integer, number of current search results--></maxResults>
</PowerDataSearchDescription>

B.223 XML_PowerDataSearchResult
PowerDataSearchResult message in XML format
<PowerDataSearchResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string--></searchID>
<responseStatus><!--req, xs: boolean, whether to return search status: "true,false"--></responseStatus>
<responseStatusStrg>
<!--req, xs: string, this node represents the error description if <responseStatus> is "false"-->
</responseStatusStrg>
<numOfMatches><!--req, xs: integer, number of returned results--></numOfMatches>
<totalMatches><!--req, xs: integer, total number of returned results--></totalMatches>
<matchList><!--opt-->
<searchMatchItem><!--req-->
<dataDescriptor><!--req-->
<StartDateTime><!--req, xs: time, data detection time--></StartDateTime>
<mainMetaId><!--req, xs: integer, major type--></mainMetaId>
<subMetaId><!--req, xs: integer, minor type--></subMetaId>
<dataType><!--req, xs: integer, data type: 0-history data, 1-alarm data--></dataType>
<dataName><!--req, xs: string, data name--></dataName>
<dataValue><!--req, xs: string, data value--></dataValue>
<unitsType><!--req, xs: string, unit--></unitsType>
</dataDescriptor>
</searchMatchItem>
</matchList>
</PowerDataSearchResult>

B.224 XML_PreviewStatus
PreviewStatus message in XML format
<PreviewStatus xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<previewCount>
<!--req, xs:integer, number of live view connections-->
</previewCount>
<previewCfgList xmlns="urn:psialliance-org" version="1.0">
<previewCfg xmlns="urn:psialliance-org" version="1.0">
<id>

378
Intelligent Security API (Traffic) Developer Guide

<!--req, xs:integer-->
</id>
<previewIP>
<!--req, xs:string, live view connection IP-->
</previewIP>
<channelType>
<!--req, xs:string, "mainChannel,subChannel,noChannel"-->
</channelType>
<frameRate>
<!--req, xs:integer, frame rate, the maximum frame rate is x100. This node is set to 0 if live view is disabled-->
</frameRate>
<resolutionWidth>
<!--req, xs:integer, video resolution width-->
</resolutionWidth>
<resolutionHeight>
<!--req, xs:integer, video resolution height-->
</resolutionHeight>
</previewCfg>
</previewCfgList>
<snapResolutionWidth>
<!--req, xs:integer, capture resolution width-->
</snapResolutionWidth>
<snapResolutionHeight>
<!--req, xs:integer, capture resolution height-->
</snapResolutionHeight>
<triggerType>
<!--req, xs:string, trigger mode: "normal"-normal trigger, "vtMode"-video trigger-->
</triggerType>
</PreviewStatus>

B.225 XML_RacmCap
XML message about device storage capability
<?xml version="1.0" encoding="utf-8"?>
<RacmCap version="1.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportZeroChan>
<!--optional, xs:boolean, whether it supports channel-zero, "true"-yes, "false"-no-->
</isSupportZeroChan>
<inputProxyNums><!--optional, xs:integer, number of supported digital channels--></inputProxyNums>
<eSATANums><!--optional, xs:integer, number of supported eSATAs--></eSATANums>
<miniSASNums><!--optional, xs:integer, number of supported miniSATAs--></miniSASNums>
<nasNums><!--optional, xs:integer, number of supported NASs--></nasNums>
<ipSanNums><!--optional, xs:integer, number of supported IPSANs--></ipSanNums>
<isSupportRaid>
<!--optional, xs:boolean, whether it supports RAID, "true"-yes, "false"-no-->
</isSupportRaid>
<isSupportExtHdCfg>
<!--optional, xs:boolean, whether it supports HDD advanced management, "true"-yes, "false"-no-->
</isSupportExtHdCfg>

379
Intelligent Security API (Traffic) Developer Guide

<isSupportTransCode><!--optional, xs:boolean, whether it supports auto-switch, "true"-yes, "false"-no--></


isSupportTransCode>
<isSupportIpcImport>
<!--optional, xs:boolean, whether it supports importing configuration files to network camera, "true"-yes, "false"-
no-->
</isSupportIpcImport>
<NasMountType><!--optional-->
<isNFSSupportAuthentication/><!--optional, xs:boolean, whether it supports NFS authentication, "true"-yes, "false"-
no-->
<isCIFSSupportAuthentication/><!--optional, xs:boolean, whether it supports CIFS authentication, "true"-yes, "false"-
no-->
</NasMountType>
<isSupportIpcStreamType/><!--optional, xs:boolean-->
<isSupportIOInputProxy/><!--optional, xs:boolean, whether it supports dynamic alarm input channel: "true"-yes,
"false"-no-->
<isSupportIOOutputProxy/><!--optional, xs:boolean, whether it supports dynamic alarm output channel: "true"-yes,
"false"-no-->
<isSupportPTZRs485Proxy/><!--optional, xs:boolean, whether it supports dynamic PTZ485 channel, "true"-yes,
"false"-no-->
<isSupportSrcIDSearch/><!--optional, xs:boolean, whether it supports search by stream ID, "true"-yes, "false"-no-->
<isSupportReversePlayback/><!--optional, xs:boolean, whether it supports reverse playback, "true"-yes, "false"-no-->
<isSupportSMARTTest/><!--optional, xs:boolean, whether it supports HDD checking, "true"-yes, "false"-no-->
<isSupportDownloadByTime/><!--optional, xs:boolean, whether it supports downloading by time, "true"-yes, "false"-
no-->
<pictureSearchType
opt="AllEvent,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,Command,pir,wlsensor,callhelp,facedetection,FieldDete
ction,scenechangedetection,LineDetection,regionEntrance,regionExiting,loitering,group,rapidMove,parking,unattende
dBaggage,attendedBaggage,vehicleDetection,manual,manualSnapShot,playSnapShot,allPic,evidence,illegalParking,cro
sslane,vehicleexist,lanechange,wrongdirection,congestion,turnround, parallelParking, pedestrian, construction,
roadblock, abandonedObject, trafficAccident, fogDetection, personQueueCounting,personQueueTime,
mixedTargetDetection, safetyHelmet, accessController, videoInterCom, GJD, Luminite, OPTEX, securityControlPanel,
playCellphone, vibrationDetection, ATMPanel, ATMSurround, ATMFace, ATMSafetyCabin,
temperatureIntervalMeasurement"/>
<!--optional, xs:string, picture search conditions-->
<recordSearchType
opt="AllEvent,CMR,MOTION,ALARM,EDR,ALARMANDMOTION,Command,pir,wlsensor,callhelp,facedetection,FieldDete
ction,scenechangedetection,LineDetection,regionEntrance,regionExiting,loitering,group,rapidMove,parking,unattende
dBaggage,attendedBaggage,vehicleDetection,manual,manualSnapShot,playSnapShot,AudioDetection,playCellphone,ru
nning,failDown,violentMotion,retention,allPerimeterEvent, allBehaviorEvent, vibrationDetection, ATMPanel,
ATMSurround, ATMFace, ATMSafetyCabin, temperatureIntervalMeasurement"/>
<!--optional, xs:string, video search conditions-->
<isSupportActivateIpc/><!--optional, xs:boolean, whether it supports activating network camera, "true"-yes, "false"-
no-->
<isSupportCheckIpcSecurity><!--optional-->
<isSupportCheckPassword/><!--optional, xs:boolean, whether it supports password verification, "true"-yes, "false"-
no-->
</isSupportCheckIpcSecurity>
<isSupportMainAndSubRecord/>
<!--optional, xs:boolean, whether it supports recording in main stream or sub-stream, "true"-yes, "false"-no-->
<isSupportSyncIPCPassword>
<!--optional, xs:boolean, whether it supports synchronizing network camera's password, "true"-yes, "false"-no-->
</isSupportSyncIPCPassword>

380
Intelligent Security API (Traffic) Developer Guide

<isSupportTransferIPC>
<!--optional, xs:boolean, whether it supports network camera passthrough function, "true"-yes, "false"-no-->
</isSupportTransferIPC>
<isSupportPOS><!--optional, xs:boolean, whether it supports POS, "true"-yes, "false"-no--></isSupportPOS>
<isSupportPassBackBasicCfg>
<!--optional, xs:boolean, whether it supports the ANR basic function of CVR, "true"-yes, "false"-no-->
</isSupportPassBackBasicCfg>
<PassBackTaskConfig><!--optional, task management function of ANR-->
<isSupportAddTask><!--optional, xs:boolean, whether it supports adding task, "true"-yes, "false"-no--></
isSupportAddTask>
<isSupportSearchTask><!--optional, xs:boolean, whether it supports task search, "true"-yes, "false"-no--></
isSupportSearchTask>
<isSupportControlTask><!--optional, xs:boolean, whether it supports task control, "true"-yes, "false"-no--></
isSupportControlTask>
<isSupportDeleteTask><!--optional, xs:boolean, whether it supports deleting task, "true"-yes, "false"-no--></
isSupportDeleteTask>
</PassBackTaskConfig>
<PassBackPlanConfig><!--optional, task plan of ANR-->
<isSupportAddPlan><!--optional, xs:boolean, whether it supports adding plan, "true"-yes, "false"-no--></
isSupportAddPlan>
<isSupportSearchPlan><!--optional, xs:boolean, whether it supports plan search, "true"-yes, "false"-no--></
isSupportSearchPlan>
<isSupportDeletePlan><!--optional, xs:boolean, whether it supports deleting plan, "true"-yes, "false"-no--></
isSupportDeletePlan>
</PassBackTaskConfig>
<IRAIDCap/><!--optional, network RAID-->
<isSupportStorageExtraInfo>
<!--optional, xs:boolean, whether it supports configuring storage additional information, "true"-yes, "false"-no-->
</isSupportStorageExtraInfo>
<isSupportRecordStatus><!--optional, xs:boolean--></isSupportRecordStatus>
<supportAIDTFSType opt="illegalParking,wrongdirection crosslane,vehicleexist,lanechange, turnround, evidence"/>
<!--optional, xs:string, event picture search conditions supported by both AID and TFS-->
<isSupportRacmChannelsCap><!--optional, xs:boolen--></isSupportRacmChannelsCap>
<LockCap/><!--optional, lock or unlock video-->
<isSupportForamtAll><!--optional, xs:boolean, "true,false"--></isSupportForamtAll>
<isSupportExtendCabinetCfg>
<!--optional, xs:boolean, whether it supports enclosure configuration-->
</isSupportExtendCabinetCfg>
<diskGroupNums><!--optional, xs:integer, number of supported HDD groups--></diskGroupNums>
<isSupportCountingSearchByUTC><!--optional, xs:boolean, whether it supports searching people counting results by
UTC time--></isSupportCountingSearchByUTC>
<isSupportPlaybackReverseByUTC><!--optional, xs:boolean, whether it supports reverse playback by UTC time--></
isSupportPlaybackReverseByUTC>
<isSupportWebPrivatePlaybackByUTC>
<!--optional, xs: boolean, whether it supports playback based on Web private protocol-->
</isSupportWebPrivatePlaybackByUTC >
<isSupportFindCommonFileByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for searching files-->
</isSupportFindCommonFileByUTC>
<isSupportFindEventFileByUTC><!--optional, xs: boolean, whether it supports extending the time zone for searching
files by event-->
</isSupportFindEventFileByUTC >

381
Intelligent Security API (Traffic) Developer Guide

<isSupportSmartSearchRecordByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for VCA search-->
</isSupportSmartSearchRecordByUTC>
<isSupportMRDSearchByTimeZone>
<!--optional, xs: boolean, whether it supports extending the time zone for searching files by calendar-->
</isSupportMRDSearchByTimeZone>
<isSupportSearchRecordLabelByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for searching video tags-->
</isSupportSearchRecordLabelByUTC>
<isSupportSearchPictureByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for searching pictures-->
</isSupportSearchPictureByUTC>
<isSupportSmartSearchPictureByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for searching pictures with smart
information-->
</isSupportSmartSearchPictureByUTC>
<isSupportFindLogByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for searching log-->
</isSupportFindLogByUTC>
<isSupportUploadRecordByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for uploading files to cloud storage-->
</isSupportUploadRecordByUTC>
<isSupportPlaybackByUTC>
<!--optional, xs: boolean, whether it supports extending the time zone for playback by time and locating by time-->
</isSupportPlaybackByUTC>
<SecurityLog>
<isSupportSecurityLog><!--optional, boolean, whether it supports security log--></isSupportSecurityLog>
<isSupportLogServer><!--optional, boolean, whether it supports log server configuration--></isSupportLogServer>
<isSupportLogServerTest><!--optional, xs: boolean, whether it supports log server test--></isSupportLogServerTest>
<SecurityLogTypeList><!--required, xs: list, supported log type list-->
<SecurityLogType>
<primaryType><!--required, xs: string, major type--></primaryType>
<secondaryType optional=""><!--required, xs: string, minor type--></secondaryType>
</SecurityLogType>
</SecurityLogTypeList>
</SecurityLog>
<iSptInputProxyChanCap>
<!--optional, xs:boolean, whether it supports getting the capability of the digital channel-->
</iSptInputProxyChanCap>
<isSupportLogDataPackage>
<!--optional, xs:boolean, whether it supports exporting logs: "true, false"-->
</isSupportLogDataPackage>
<logSearchTimeSpanNums>
<!--optional, xs:integer, supported number of time periods for log search-->
</logSearchTimeSpanNums>
<isSupportManualRecord>
<!--optional, xs:boolean, whether the device supports manual recording-->
</isSupportManualRecord>
<isSupportRemark><!--optional, xs:boolean, whether it supports file remarks--></isSupportRemark>
<FileUpload><!--optional, upload file-->
<enabled><!--required, xs:boolean, whether it supports enabling file uploading--></enabled>
</FileUpload>

382
Intelligent Security API (Traffic) Developer Guide

<PoliceInfoUpload><!--optional, upload police information-->


<enabled><!--required, xs:boolean, whether it supports enabling police information uploading--></enabled>
</PoliceInfoUpload>
<PoliceInfo>
<policeID><!--optional, xs:boolean, whether it supports police ID--></policeID>
<policeCode><!--optional, xs:boolean, whether it supports police No.--></policeCode>
<policeName><!--optional, xs:boolean, whether it supports police name--></policeName>
<password><!--optional, xs:boolean, whether it supports police password--></password>
<deviceID><!--optional, xs:boolean, whether it supports device ID--></deviceID>
</PoliceInfo>
<behaviorEventPicSearch
opt="allBehaviorEvent,running,group,violentMotion,failDown,playCellphone,peopleNumChange,leavePosition,retentio
n,sleepOnduty">
<!--optional, xs:string, behavior analysis events supported by picture search, which is used for web display,
"allBehaviorEvent"-all events in behaviorEventPicSearch-->
</behaviorEventPicSearch>
<perimeterEventPicSearch
opt="allPerimeterEvent,linedetection,fielddetection,regionEntrance,regionExiting,loitering">
<!--optional, xs:string, perimeter protection events that support picture search, which is used for web display,
"allPerimeterEvent"-all events in perimeterEventPicSearch-->
</perimeterEventPicSearch>
<isSupportAssignChannelID><!--optional, xs:boolean, whether it supports specify channel No. when adding IPC--></
isSupportAssignChannelID>
<isSupportAssignStreamID><!--optional, xs:boolean, whether it supports specify stream ID of the channel when
adding IPC--></isSupportAssignStreamID>
<isSupportTimeSearch><!--optional, xs:boolean, whether it supports searching for recording start and end time by
channel--></isSupportTimeSearch>
<CloudStorageServerCap><!--optional-->
<isSupportCloudStorageParameter><!--optional, xs:boolean, whether it supports configuring cloud storage
parameters--></isSupportCloudStorageParameter>
<isSupportCloudStoragePool><!--optional, xs:boolean, whether it supports configuring cloud storage pool
parameters--></isSupportCloudStoragePool>
</CloudStorageServerCap>
<CMSearchCount/><!--optional, xs:boolean, whether it supports searching for file quantity of dock station-->
<isSupportSSDSMARTTest>
<!--optional, xs:boolean, whether the device supports SSD S.M.A.R.T detection (related URI: /ISAPI/ContentMgmt/
Storage/ssd/<ID>/SMARTTest/start)-->
</isSupportSSDSMARTTest>
</RacmCap>

B.226 XML_RadarSetUp
RadarSetUp message in XML format
<RadarSetUp version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<RadarSetUpParamList>
<!--optional-->
<RadarSetUpParam>
<!--optional-->
<radarType>

383
Intelligent Security API (Traffic) Developer Guide

<!--required, xs:string, radar type: "none", "adr"-Andoray, "adr4Byte"-Andoray (no radar controller), "olvia"-Olvia,
"csr"-TransMicrowave, "IOBox"-radar connecting I/O expansion box, "SSKT"-Sensortech, "custom"-->
</radarType>
<setUpHeight>
<!--required, xs:integer, radar construction height, range: [10,100], unit: dm-->
</setUpHeight>
<angle>
<!--required, xs:integer, angle, range: [0,90]-->
</angle>
<radarLaneDistance>
<!--required, xs:integer, distance between radar and lane, range: [0,100], unit: dm-->
</radarLaneDistance>
<carDifference>
<!--required, xs:integer, vehicle distance, range: [0,100], unit: dm-->
</carDifference>
<hardThreshold>
<!--required, xs:integer, hard threshold, range: [0,255]-->
</hardThreshold>
<threshold>
<!--required, xs:integer, threshold, range: [0,255]-->
</threshold>
<laneWidth>
<!--required, xs:integer, lane width, range: [20,50], unit:dm-->
</laneWidth>
<laneCalibration>
<!--required, xs:integer, lane calibration coefficient, range: [0,255]-->
</laneCalibration>
<limitSpeed>
<!--optional, xs:integer, speed limit, it is between 0 and 255, unit: km/h-->
</limitSpeed>
<margin>
<!--optional, xs:integer, margin, it is between 0 and 255, unit: km/h-->
</margin>
<workMode>
<!--opt, xs:string, radar triggering mode: "headTrig"-trigger by vehicle head, "tailTrig"-trigger by vehicle tail,
"doubleTrig"-trigger by vehicle head and tail-->
</workMode>
<sceneMode>
<!--opt, xs:string, scene: "city", "highWay"-highway-->
</sceneMode>
</RadarSetUpParam>
</RadarSetUpParamList>
</RadarSetUp>

B.227 XML_RealTrafficStats
RealTrafficStats message in XML format
<RealTrafficStats version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<chanNo><!--req, xs: integer--></chanNo>

384
Intelligent Security API (Traffic) Developer Guide

<Period><!--opt-->
<startTime><!--req, xs: string--></startTime>
<endTime><!--req, xs: string--></endTime>
<vehicleFlow><!--req, xs: integer--></vehicleFlow>
<laneOccupancyRate><!--req, xs: string--></laneOccupancyRate>
<avgSpeed><!--req, xs: string--></avgSpeed>
<timeHeadway><!--req, xs: string--></timeHeadway>
<vehicleLength><!--req, xs: string--></vehicleLength>
</Period>
</RealTrafficStats>

B.228 XML_RecordColor
RecordColor message in XML format
<RecordColor version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<brightnessLevel min="0" max="100"><!--req, xs:integer, brightness, which ranges from 0 to 100--></
brightnessLevel>
<contrastLevel min="0" max="100"><!--req, xs:integer, contrast, which ranges from 0 to 100--></contrastLevel>
</RecordColor>

B.229 XML_RecordGain
RecordGain message in XML format
<RecordGain version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<gainLevel min="0" max="100"><!--req, xs:integer, gain level, which ranges from 0 to 100--></gainLevel>
</RecordGain>

B.230 XML_RecordNoiseReduce2D
RecordNoiseReduce2D message in XML fomat
<RecordNoiseReduce2D version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<noiseReduce2DEnable>
<!--req, xs:boolean, whether to enable 2D noise reduction: "true"-yes, "false"-no-->
</noiseReduce2DEnable>
<noiseReduce2DLevel min="0" max="100">
<!--dep, xs:integer, 2D noise reduction level, which ranges from 0 to 100-->
</noiseReduce2DLevel>
</RecordNoiseReduce2D>

385
Intelligent Security API (Traffic) Developer Guide

B.231 XML_RecordNoiseReduceExt
RecordNoiseReduceExt message in XML format
<RecordNoiseReduceExt version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<mode opt="close,general,advanced">
<!--req, xs:string, 3D DNR mode: "close", "general"-normal mode, "advanced"-expert mode-->
</mode>
<GeneralMode>
<!--3D DNR in normal mode, this node is valid only when <mode> is "general"-->
<generalLevel min="0" max="100">
<!--dep, xs:integer, 3D DNR level in normal mode, which ranges from 0 to 100 and depends on <mode>-->
</generalLevel>
</GeneralMode>
<AdvancedMode>
<!--3D DNR in expert mode, this node is valid only when <mode> is "advanced"-->
<spatialLevel min="0" max="100">
<!--dep, xs:integer, 3D DNR space level in expert mode, which ranges from 0 to 100 and depends on <mode>-->
</spatialLevel>
<temporalLevel min="0" max="100">
<!--dep, xs:integer, 3D DNR time level in expert mode, which ranges from 0 to 100 and depends on <mode>-->
</temporalLevel>
</AdvancedMode>
</RecordNoiseReduceExt>

B.232 XML_RecordSectionCtrl
RecordSectionCtrl message in XML format
<RecordSectionCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<sectionCtrlEnabled opt="true,false">
<!--req, xs:boolean, whether to enable picture exposure control by video segment: "true"-yes, "false"-no-->
</sectionCtrlEnabled>
</RecordSectionCtrl>

B.233 XML_RecordShutter
RecordShutter message in XML format
<RecordShutter version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<shutterLevel min="0" max="100"><!--req, xs:integer, shutter level, which ranges from 0 to 100, unit: microsecond--
></shutterLevel>
</RecordShutter>

386
Intelligent Security API (Traffic) Developer Guide

B.234 XML_RedLightStatus
RedLightStatus message in XML format
<RedLightStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<chanNo><!--req, xs: integer, channel No.--></chanNo>
<online><!--req, xs: boolean, whether it is online--></online>
<normalAnalysis><!--req, xs: boolean--></normalAnalysis>
<statusCode>
<!--req, xs: string, status code: 0-no error, other codes are also the error codes-->
</statusCode>
<statusStr><!--req, xs: string--></statusStr>
<Direction>
<direction><!--req, xs: string, "left,right,straight"--></direction>
<lightColor><!--req, xs: string, "red,green,yellow,off"--></lightColor>
<duration><!--req, xs: integer, time duration of each light status, unit: second--></duration>
</Direction>
</RedLightStatus>

B.235 XML_RemoteHost
RemoteHost message in XML format
<RemoteHost version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Host><!--opt, list-->
<ID><!--req, xs: integer--></ID>
<ipAddr><!--req, xs: string--></ipAddr>
<port><!--req, xs: integer--></port>
<postDataTypes>
<!--opt, xs: string, checkpoint data type, for multiple types, they should be separated by comma-->
</postDataTypes>
<epoliceDataTypes>
<!--opt, xs: string, data type of intersection violation system, for multiple types, they should be separated by
comma-->
</epoliceDataTypes>
<eventDataTypes>
<!--opt, xs: string, event data type, for multiple types, they should be separated by comma-->
</eventDataTypes>
<evidenceDataTypes>
<!--opt,xs:string, data type of traffic law enforcement, for multiple types, they should be separated by comma-->
</evidenceDataTypes>
<suspendUpload><!--opt, xs: string--></suspendUpload>
<uploadStrategy><!--req, xs: integer--></uploadStrategy>
<uploadInterval><!--req, xs: integer--></uploadInterval>
<uploadTimeout><!--req, xs: integer--></uploadTimeout>
<uploadProtocol><!--req, xs: integer--></uploadProtocol>
<CloudSwitch><!--req, xs: integer--></CloudSwitch>
<CloudServerIP><!--req, xs: string--></CloudServerIP>
<CloudCMDPort><!--req, xs: integer--></CloudCMDPort>

387
Intelligent Security API (Traffic) Developer Guide

<CloudPoolIDKK><!--req, xs: string--></CloudPoolIDKK>


<CloudPoolIDVio><!--req, xs: string--></CloudPoolIDVio>
<CloudPoolIDAid><!--req, xs: string--></CloudPoolIDAid>
<CloudPoolIDTFS><!--req, xs: string--></CloudPoolIDTFS>
<CloudUser><!--req, xs: string--></CloudUser>
<CloudPwd><!--req, xs: string--></CloudPwd>
<historyEnabled><!--req, xs: boolean, whether to enable uploading history data--></historyEnabled>
<noPlateUploadEnabled>
<!--req, xs: boolean, whether to enable uploading vehicle data without license plate information-->
</noPlateUploadEnabled>
<uploadTimePlan><!--opt-->
<enabled><!--req, xs: boolean--></enabled>
<timeList><!--opt-->
<timeSlot><!--req, list-->
<timeId><!--req, xs: integer, value: 0, 1--></timeId>
<startHour><!--dep, xs: integer, value range: [0,23]--></startHour>
<startMinute><!--dep, xs: integer, value range: [0,59]--></startMinute>
<endHour><!--dep, xs: integer, value range: [0,23]--></endHour>
<endMinute><!--dep, xs: integer, value range: [0,59]--></endMinute>
</timeSlot>
</timeList>
</uploadTimePlan>
<uploadTpsEnable><!--opt, xs: boolean, whether to uploading traffic data collection parameters--></
uploadTpsEnable>
<tempDataUpload><!--req, xs: boolean, whether to enable temporary data--></tempDataUpload>
</Host>
</RemoteHost>

B.236 XML_RemoteHostCap
RemoteHostCap message in XML format
<RemoteHostCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<RemoteHostList><!--opt-->
<RemoteHost><!--opt, xs: list-->
<Host>
<ID min="" max=""><!--req, xs: integer--></ID>
<ipAddr><!--req, xs: string--></ipAddr>
<port><!--req, xs: integer--></port>
<dataTypes><!--req, xs: string--></dataTypes>
<suspendUpload min="" max=""><!--req, xs: integer--></suspendUpload>
<uploadStrategy min="" max=""><!--req, xs: integer--></uploadStrategy>
<uploadInterval min="" max=""><!--req, xs: integer--></uploadInterval>
<uploadTimeout min="" max=""><!--req, xs: integer--></uploadTimeout>
<uploadProtocol min="" max=""><!--req, xs: integer--></uploadProtocol>
<CloudSwitch min="" max=""><!--req, xs: integer--></CloudSwitch>
<CloudServerIP><!--req, xs: string--></CloudServerIP>
<CloudCMDPort><!--req, xs: integer--></CloudCMDPort>
<CloudPoolIDKK min="" max=""><!--req, xs: string--></CloudPoolIDKK>
<CloudPoolIDVio min="" max=""><!--req, xs: string--></CloudPoolIDVio>

388
Intelligent Security API (Traffic) Developer Guide

<CloudPoolIDAid min="" max=""><!--req, xs: string--></CloudPoolIDAid>


<CloudPoolIDTFS min="" max=""><!--req, xs: string--></CloudPoolIDTFS>
<CloudUser><!--req, xs: string--></CloudUser>
<CloudPwd><!--req, xs: string--></CloudPwd>
<historyEnabled opt="true,false"><!--req, xs: boolean--></historyEnabled>
<noPlateUploadEnabled opt="true,false"><!--req, xs: boolean--></noPlateUploadEnabled>
<uploadTimePlan>
<enabled opt="true,false"><!--req, xs: boolean--></enabled>
<timeList>
<timeSlot>
<timeId min="0" max="1"><!--req, xs: integer, values: 0, 1--></timeId>
<startHour min="0" max="23"><!--dep, xs: integer, value range: [0,23]--></startHour>
<startMinute min="0" max="59"><!--dep, xs: integer, value range: [0,59]--></startMinute>
<endHour min="0" max="23"><!--dep, xs: integer, value range: [0,23]--></endHour>
<endMinute min="0" max="59"><!--dep, xs: integer, value range: [0,59]--></endMinute>
</timeSlot>
</timeList>
</uploadTimePlan>
</Host>
</RemoteHost>
</RemoteHostList>
<UploadCtrl>
<hostID min="" max=""><!--req, xs: integer--></hostID>
<ctrlType opt="resend,priorsend,unsend"><!--req, xs: string--></ctrlType>
<startTime><!--req, xs: string, start time, format: YYYY-MM-DD HH:mm:ss--></startTime>
<endTime><!--req, xs: string, end time, format: YYYY-MM-DD HH:mm:ss--></endTime>
<dataType min="" max=""><!--req, xs: integer--></dataType>
</UploadCtrl>
<Statistics>
<StatisticsSearch>
<timeSpanList>
<timeSpan><!--req, xs: list-->
<startTime><!--req, xs: string, start time, format: YYYY-MM-DDTHH:mm:ssZ--></startTime>
<endTime><!--req, xs: string, end time, format: YYYY-MM-DDTHH:mm:ssZ--></endTime>
</timeSpan>
</timeSpanList>
</StatisticsSearch>
<StatisticsResult>
<RemoteList>
<Statistics><!--req, xs: list-->
<HostID min="" max=""><!--req, xs: integer--></HostID>
<UploadedCount min="" max=""><!--req, xs: integer--></UploadedCount>
<Total min="" max=""><!--req, xs: integer--></Total>
</Statistics>
</RemoteList>
</StatisticsResult>
</Statistics>
</RemoteHostCap>

389
Intelligent Security API (Traffic) Developer Guide

B.237 XML_RemoteHostList
RemoteHostList message in XML format
<RemoteHostList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<RemoteHost/><!--refer to the message XML_RemoteHost for details-->
</RemoteHostList>

See Also
XML_RemoteHost

B.238 XML_ResponseStatus
XML message about response status
<ResponseStatus version="2.0" xmlns="http://www.std-cgi.org/ver20/XMLSchema">
<requestURL>
<!--required, read-only, xs:string, request URL-->
</requestURL>
<statusCode>
<!--required, read-only, 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, 9-Additional Error-->
</statusCode>
<statusString>
<!--required, read-only, xs:string, status description: OK, Device Busy, Device Error, Invalid Operation, Invalid XML
Format, Invalid XML Content, Reboot, Additional Error-->
</statusString>
<subStatusCode>
<!--required, read-only, xs:string, describe the error reason in detail-->
</subStatusCode>
</ResponseStatus>

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

B.239 XML_ROI
ROI message in XML format
<ROI version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id/><!--req, xs:string, the ID should be the same as the stream ID-->
<enabled/><!--req, xs:string, if this node is set to "disable", all regions are invalid-->
<normalizedScreenSize><!--req, standard screen size-->
<normalizedScreenWidth>
<!--req, xs:integer-->

390
Intelligent Security API (Traffic) Developer Guide

</normalizedScreenWidth>
<normalizedScreenHeight>
<!--req, xs:integer-->
</normalizedScreenHeight>
</normalizedScreenSize>
<ROIRegionList/><!--dep, list of ROI regions-->
</ROI>

B.240 XML_ROIList
ROIList message in XML format
<ROIList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ROI/><!--opt, ROI (Region of Interest) No. Users can set the region of most concern and interest in the video by
enabling ROI, and the video quality of the interested region will be enhanced while encoding-->
</ROIList>

B.241 XML_ROIRegion
ROIRegion message in XML format
<ROIRegion version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id>
<!--req, xs:integer-->
</id>
<streamID>
<!--req, xs:integer, stream type-->
</streamID>
<enabled>
<!--req, xs:boolean, whether to enable ROI-->
</enabled>
<name>
<!--opt, xs:string, region name-->
</name>
<qualityLevelOfROI>
<!--req, xs:integer, enhancement level, which is between 1 and 6-->
</qualityLevelOfROI>
<RegionCoordinatesList>
<RegionCoordinates><!--list, coordinates of ROI region-->
<positionX>
<!--req, xs:integer, X-coordinate-->
</positionX>
<positionY>
<!--req, xs:integer, Y-coordinate-->
</positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</ROIRegion>

391
Intelligent Security API (Traffic) Developer Guide

B.242 XML_ROIRegionsList
ROIRegionsList message in XML format
<ROIRegionsList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ROIRegion/><!--opt, see details in the message of XML_ROIRegion-->
</ROIRegionsList>

See Also
XML_ROIRegion

B.243 XML_Schedule
Schedule message in XML format
<Schedule version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--required, xs:string, ID--></id>
<eventType>
<!--optional, xs:string, alarm/event types, see details in the "Remarks" below-->
</eventType>
<inputIOPortID><!--read-only, dependent, xs:string, alarm input No.--></inputIOPortID>
<outputIOPortID><!--read-only, dependent, xs:string, alarm output No.--></inputIOPortID>
<videoInputChannelID><!--read-only, dependent, xs:string, video input channel ID--></videoInputChannelID>
<TimeBlockList size="8"><!--required-->
<TimeBlock><!--list-->
<dayOfWeek>
<!--optional, xs:integer, day of the week based on ISO8601, "1"=Monday, ...-->
</dayOfWeek>
<TimeRange><!--required-->
<beginTime><!--required, xs:time, ISO8601 time--></beginTime>
<endTime><!--required, xs:time, ISO8601 time--></endTime>
</TimeRange>
<CustomExtension>
<vehicleDetectSceneID>
<!--required, xs:interger-->
</vehicleDetectSceneID>
</CustomExtension>
</TimeBlock>
</TimeBlockList>
<HolidayBlockList><!--optional-->
<TimeBlock><!--list-->
<TimeRange><!--required-->
<beginTime><!--required, xs:time, ISO8601 time--></beginTime>
<endTime><!--required, xs:time, ISO8601 time--></endTime>
</TimeRange>
</TimeBlock>
</HolidayBlockList>
</Schedule>

392
Intelligent Security API (Traffic) Developer Guide

Remarks
The node <eventType> can be set to the following values: IO, VMD,videoloss, PIR,linedetection,
fielddetection, audioexception, facedetection, regionEntrance, regionExiting, loitering, group,
rapidMove, parking, unattendedBaggage,attendedBaggage, storageDetection, shipsDetection,
HUMANATTRIBUTE, humanAttribute, faceContrast, faceSnap, faceLib, whiteListFaceContrast,
personDensityDetection, personQueueDetection, mixedTargetDetection, fireDetection,
illegalParking, pedestrian, trafficAccident,construction, roadblock, abandonedObject,
parallelParking, parkingState, congestion, intersectionAnalysis, heatMap, reverseEntrance,
vehicledetect, safetyHelmetDetection, vibrationDetection, TMPA, faceThermometry, HBDLib.

B.244 XML_SectionCap
SectionCap message in XML format
<SectionCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SectionCfg/><!--refer to the message XML_SectionCfg for details-->
<SectionList/><!--refer to the message XML_SectionList for details-->
<UnusedChannel/><!--refer to the message XML_UnusedChannel for details-->
</SectionCap>

See Also
XML_SectionCfg
XML_SectionElement
XML_UnusedChannel

B.245 XML_SectionCtrl
SectionCtrl message in XML format
<SectionCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<sectionCtrlEnabled>
<!--req, xs:boolean, whether to enable picture exposure control by video segment: "true"-yes, "false"-no-->
</sectionCtrlEnabled>
</SectionCtrl>

B.246 XML_SectionCfg
SectionCfg message in XML format
<SectionCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable><!--req, xs: boolean, whether to enable section speed detection: "true,false"--></enable>
</SectionCfg>

393
Intelligent Security API (Traffic) Developer Guide

B.247 XML_SectionElement
SectionElement message in XML format
<SectionElement version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id><!--req, xs: integer--></id>
<enable><!--req, xs: boolean--></enable>
<name><!--req, xs: string--></name>
<length><!--req, xs: float--></length>
<scene><!--req, xs: integer--></scene>
<startChan><!--req, xs: string--></startChan>
<endChan><!--req, xs: string--></endChan>
<largeSignSpeed><!--req, xs: integer--></largeSignSpeed>
<largeTopSpeed><!--req, xs: integer--></largeTopSpeed>
<largeExpSpeed><!--req, xs: integer--></largeExpSpeed>
<smallSignSpeed><!--req, xs: integer--></smallSignSpeed>
<smallTopSpeed><!--req, xs: integer--></smallTopSpeed>
<smallExpSpeed><!--req, xs: integer--></smallExpSpeed>
</SectionElement>

B.248 XML_SectionList
SectionList message in XML format
<SectionList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SectionElement/><!--refer to the message XML_SectionElement for details-->
</SectionList>

See Also
XML_SectionElement

B.249 XML_SetVCLData
SetVCLData message in XML format
<SetVCLData version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<VCLDataList>
<singleVCLData>
<id>
<!--req, xs:integer, list No., which is between 0 and 128-->
</id>
<disabled><!--opt, xs: boolean, if this node does not exist, it represents enabled, otherwise, "true" represents
enabled--></disabled>
<runNum>
<!--opt, xs:integer, data serial No., which is a mark used for platform data synchronization and is between 1 and
4294836225, the value configured by the control is 0-->
</runNum>

394
Intelligent Security API (Traffic) Developer Guide

<listType>
<!--req, xs:integer, list type: 0-whitelist, 1-blacklist-->
</listType>
<plateNum>
<!--req, xs:string, license plate number, the maximum length is 16 bytes-->
</plateNum>
<plateColor>
<!--req, xs: integer, license plate color: 0-blue, 1-yellow, 2-white, 3-black, 4-green, 0xff-other-->
</plateColor>
<plateType>
<!--req, xs: integer, license plate type: 0-standard civil vehicle and military vehicle, 1-standard 02 civil vehicle, 2-
armed police vehicle, 3-police vehicle, 4-civil vehicle with two-line license plate, 5-embassy vehicle license plate, 6-
agricultural vehicle license plate, 7-motorcycle license plate-->
</plateType>
<cardNo>
<!--opt, xs:string, card No., the maximum length is 48 bytes-->
</cardNo>
<startTime>
<!--opt, xs:datetime, valid start time, e.g., 2009-06-10T12:00:00Z-->
</startTime>
<endTime>
<!--opt, xs:datetime, valid end time, e.g., 2014-06-10T12:00:00Z-->
</endTime>
<startDay>
<!--opt, xs: string, start date, e.g., 2018-05-16-->
</startDay>
<endDay>
<!--opt, xs: string, end time, e.g., 2018-05-16-->
</endDay>
<startTimeOfDay>
<!--opt, xs: string, start time of the daytime, e.g., 08:00-->
</startTimeOfDay>
<endTimeOfDay>
<!--opt, xs: string, end time of the daytime, e.g., 18:00-->
</endTimeOfDay>
</singleVCLData>
</VCLDataList>
</SetVCLData>

B.250 XML_Sharpness
Sharpness message in XML format
<Sharpness version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SharpnessMode><!--opt, xs:string, "manual", "auto"--></SharpnessMode>
<SharpnessLevel><!--req, xs:integer--></SharpnessLevel>
</Sharpness>

395
Intelligent Security API (Traffic) Developer Guide

B.251 XML_Shutter
Shutter message in XML format
<Shutter version="1.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<ShutterLevel>
<!--dep, xs: string, shutter level: "1/1, 1/2, 1/3, 1/6, 1/12, 1/25, 1/50, 1/75, 1/100, 1/120, 1/125, 1/150, 1/175,
1/215, 1/225, 1/300, 1/400, 1/425, 1/600, 1/1000, 1/1250, 1/1750, 1/2500, 1/3500, 1/6000, 1/10000", this node is
valid when <ExposureType> in the message XML_Exposure is "ShutterFisrt"-->
<ShutterLevel>
</Shutter>

See Also
XML_Exposure

B.252 XML_SlaveSystemCap
SlaveSystemCap message in XML format
<SlaveSystemCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SlaveSystemStatus/><!--refer to XML_SlaveSystemStatus for details-->
<SlaveSystemCfg>
<LightCfg/><!--refer to message XML_LightCfg for details-->
<SmartPowerCfg/><!--refer to message XML_SmartPowerCfg for details-->
<LcdCfg/><!--refer to message XML_LcdCfg for details-->
<PowerDataSearchDescription/><!--refer to message XML_PowerDataSearchDescription for details-->
<PowerDataSearchResult/><!--refer to message XML_PowerDataSearchResult for details-->
</SlaveSystemCfg>
</SlaveSystemCap>

See Also
XML_SlaveSystemStatus
XML_LightCfg
XML_SmartPowerCfg
XML_LcdCfg
XML_PowerDataSearchDescription
XML_PowerDataSearchResult

B.253 XML_SlaveSystemStatus
SlaveSystemStatus message in XML format
<SlaveSystemStatus version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<LightStatus/><!--refer to message XML_LightStatus for details-->
<SmartPowerStatus/><!--refer to message XML_SmartPowerStatus for details-->

396
Intelligent Security API (Traffic) Developer Guide

<LcdStatus/><!--refer to message XML_LcdStatus for details-->


<OPTStatus/><!--refer to message XML_OPTStatus for details-->
<AnalogStatus/><!--refer to message XML_AnalogStatus for details-->
<TX1Status/><!--refer to message XML_TX1Status for details-->
</SlaveSystemStatus>

See Also
XML_LightStatus
XML_SmartPowerStatus
XML_LcdStatus
XML_OPTStatus
XML_AnalogStatus
XML_TX1Status

B.254 XML_SlaveVersionInfo
SlaveVersionInfo message in XML format.
<SlaveVersionInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<SlaveItemList>
<SlaveItem>
<id><!--required, string type, subsystem ID--></id>
<slaveName><!--required, string type, subsystem name--></slaveName>
<version><!--required, string type, version No.--></version>
</SlaveItem>
</SlaveItemList>
</SlaveVersionInfo>

B.255 XML_SmartCap
SmartCap capability message in XML format
<SmartCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportROI><!--opt, xs:boolean, whether to support ROI (Region of Interest)--></isSupportROI>
<isSupportFaceDetect><!--opt, xs:boolean, whether to support face detection--></isSupportFaceDetect>
<isSupportIntelliTrace><!--opt, xs:boolean--></isSupportIntelliTrace>
<isSupportFieldDetection><!--opt, xs:boolean, whether to support region detection--></isSupportFieldDetection>
<isSupportDefocusDetection><!--opt, xs:boolean--></isSupportDefocusDetection>
<isSupportAudioDetection><!--opt, xs:boolean--></isSupportAudioDetection>
<isSupportSceneChangeDetection><!--opt, xs:boolean, whether to support scene change detection--></
isSupportSceneChangeDetection>
<isSupportLineDetection><!--opt, xs:boolean--></isSupportLineDetection>
<isSupportRegionEntrance><!--opt, xs:boolean--></isSupportRegionEntrance>
<isSupportRegionExiting><!--opt, xs:boolean--></isSupportRegionExiting>
<isSupportLoitering><!--opt, xs:boolean--></isSupportLoitering>
<isSupportGroup><!--opt, xs:boolean--></isSupportGroup>
<isSupportRapidMove><!--opt, xs:boolean--></isSupportRapidMove>

397
Intelligent Security API (Traffic) Developer Guide

<isSupportParking><!--opt, xs:boolean--></isSupportParking>
<isSupportUnattendedBaggage><!--opt, xs:boolean--></isSupportUnattendedBaggage>
<isSupportAttendedBaggage><!--opt, xs:boolean--></isSupportAttendedBaggage>
<isSupportPeopleDetection><!--opt, xs:boolean--></isSupportPeopleDetection>
<isSupportStorageDetection><!--opt, xs:boolean--></isSupportStorageDetection>
<isSupportShipsDetection><!--opt, xs:boolean--></isSupportShipsDetection>
<isSupportSmartCalibration><!--opt, xs:boolean--></isSupportSmartCalibration>
<isSupportShield><!--opt, xs:boolean, whether to support shielded area--></isSupportShield>
<isSupportAlgVersion><!--opt, xs:boolean, whether to support algorithm library version--></isSupportAlgVersion>
<isSupportVideoOverlap><!--opt, xs:boolean, whether to support text overlay--></isSupportVideoOverlap>
<isSupportParkingState><!--opt, xs:boolean, whether to support parking space status detection--></
isSupportParkingState>
<isSupportChannelResource><!--opt, xs:boolean--></ isSupportChannelResource>
<isSupportAnalysisUnitSwitch opt="true,false"><!--opt, xs:boolean, whether to support analysis unit switch--></
isSupportAnalysisUnitSwitch>
<isSupportHFPD><!--opt, xs:boolean, whether to support frequently appeared person detection--></isSupportHFPD>
<isSupportImageROI<!--opt, xs:boolean, whether to support smartJpeg (image ROI (Region of Interest))--></
isSupportImageROI>
</SmartCap>

B.256 XML_SmartPowerCfg
SmartPowerCfg message in XML format
<SmartPowerCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<online><!--req, xs: integer, power system status: 0-offline, 1-normal, 2-exception--></online>
<SmartPower><!--req-->
<InputVoltage><!--req, input voltage parameters-->
<InputVID><!--req, xs: integer, ID of input voltage, which starts from 0--></InputVID>
<enableDET><!--req, xs: boolean, whether to enable power detection: "true,false"--></enableDET>
<InputVoltageName><!--req, xs: string, name of input volatage, the maximum length is 32--></InputVoltageName>
<InVoNormalRange><!--req, value range of input voltage-->
<rangeMaxValue min="" max=""><!--req, xs: integer, maximum value of input voltage--></rangeMaxValue>
<rangeMinValue min="" max=""><!--req, xs: integer, minimum value of input voltage--></rangeMinValue>
</InVoNormalRange>
<handleType><!--opt, linkage action-->
<handleTypeVoice><!--req, xs: boolean, whether to enable audible warning: "true, false"--></handleTypeVoice>
<handleTypeCenter><!--req, xs: boolean, whether to enable uploading to center: "true, false"--></
handleTypeCenter>
</handleType>
<alarmOutNum><!--opt, alarm output-->
<channelList>
<channel><!--list-->
<ID><!--req, xs:integer--></ID>
<enable><!--req, xs: boolean--></enable>
</channel>
</channelList>
</alarmOutNum>
</InputVoltage>
<ExternalVoltage><!--opt, external power parameters-->

398
Intelligent Security API (Traffic) Developer Guide

<OutputVID><!--req, xs: integer, ID of external power, which starts from 0--></OutputVID>


<enableDET><!--req, xs: boolean, whether to enable external power detection: "true, false"--></enableDET>
<OutputVoltageName><!--req, xs: string, name of external power, the maximum length is 32 bytes--></
OutputVoltageName>
<handleType><!--opt, linkage action-->
<handleTypeVoice><!--req, xs: boolean, whether to enable audible warning: "true, false"--></handleTypeVoice>
<handleTypeCenter><!--req, xs: boolean, whether to enable uploading to center: "true, false"--></
handleTypeCenter>
</handleType>
<alarmOutNum><!--opt, alarm output-->
<channelList>
<channel><!--list-->
<ID><!--req, xs:integer--></ID>
<enable><!--req, xs: boolean--></enable>
</channel>
</channelList>
</alarmOutNum>
</ExternalVoltage>
<Analog><!--req-->
<analogID><!--req, xs: integer, analog signal--></analogID>
<analogBUsed><!--req, xs: boolean, whether to be configured: "true,false"--></analogBUsed>
<analogName><!--req, xs: string, analog signal name, the maximum length is 32--></analogName>
<analogType><!--req, xs: string, analog signal type, the maximum length is 32--></analogType>
<analogUnit><!--req, xs: string, analog signal unit, the maximum length is 32--></analogUnit>
<analogStandard><!--opt, analog signal specification-->
<rangeMaxValue><!--req, xs: integer, maximum value of specification--></rangeMaxValue>
<rangeMinValue><!--req, xs: integer, minimum value of specigication--></rangeMinValue>
</analogStandard>
<analogRange><!--opt, value range of analog signal-->
<rangeMaxValue><!--req, xs: integer, maximum value--></rangeMaxValue>
<rangeMinValue><!--req, xs: integer, minimum value--></rangeMinValue>
</analogRange>
<analogSensitivity><!--req, xs: integer, sensitivity--></analogSensitivity>
<analogNormalRange><!--req, normal value range-->
<rangeMaxValue><!--req, xs: integer, maximum value--></rangeMaxValue>
<rangeMinValue><!--req, xs: integer, minimum value--></rangeMinValue>
</analogNormalRange>
<handleType><!--opt, linkage action-->
<handleTypeVoice><!--req, xs: boolean, whether to enable audible warning: "true, false"--></handleTypeVoice>
<handleTypeCenter><!--req, xs: boolean, whether to enable uploading to center: "true, false"--></
handleTypeCenter>
</handleType>
<alarmOutNum><!--opt, alarm output-->
<channelList>
<channel><!--list-->
<ID><!--req, xs:integer--></ID>
<enable><!--req, xs: boolean--></enable>
</channel>
</channelList>
</alarmOutNum>
</Analog>

399
Intelligent Security API (Traffic) Developer Guide

</SmartPower>
</SmartPowerCfg>

B.257 XML_SmartPowerStatus
SmartPowerStatus message in XML format
<SmartPowerStatus>
<online min="" max=""><!--req, xs: integer, power system status: 0-offline, 1-normal, 2-exception--></online>
<InputVoltage><!--req-->
<InputVID min="" max=""><!--req, xs: integer, input voltage ID, which starts from 0--></InputVID>
<voltageValue min="" max=""><!--req, xs: integer, value of input voltage--></voltageValue>
<InputVoltageName size=""><!--req, xs: string, name of input voltage--></InputVoltageName>
<enableDET opt="true,false"><!--req, xs: boolean, whether to enable input voltage detection--></enableDET>
</InputVoltage>
<ExternalVoltage><!--req-->
<OutputVID min="" max=""><!--req, xs: integer, external power ID, which start from 0--></OutputVID>
<OutputVoltageName size=""><!--req, xs: string, name of external power--></OutputVoltageName>
<ExVoltageStatus min="" max="">
<!--req, xs: integer, external power status: 0-normal, 1-exception, 2-alarm and exception-->
</ExVoltageStatus>
<enableDET opt="true,false"><!--req, xs: boolean, whether to enable external power detection--></enableDET>
<enableOUT opt="true,false"><!--req, xs: boolean, whether to enable output闭</enableOUT>
</ExternalVoltage>
<Analog><!--req-->
<analogID min="" max=""><!--req, xs:integer, ID of analog signal, which starts from 0--></analogID>
<analogBUsed opt="true,false"><!--req, xs: boolean, whether to be configured--></analogBUsed>
<analogName size=""><!--req, xs: string, analog signal name--></analogName>
<analogType><!--req, xs: string, analog signal type--></analogType>
<analogUnit size=""><!--req, xs: string, analog signal unit--></analogUnit>
<sensorStatus min="" max=""><!--req, xs: integer, sensor status: 0-normal, 1-exception--></sensorStatus>
<analogValue min="" max=""><!--req, xs: float, value of analog signal--></analogValue>
</Analog>
</SmartPowerStatus>

B.258 XML_SnapColor
SnapColor message in XML format
<SnapColor>
<brightnessLevel min="0" max="100">
<!--req, xs:integer, brightness, which ranges from 0 to 100-->
</brightnessLevel>
<contrastLevel min="0" max="100">
<!--req, xs:integer, contrast, which ranges from 0 to 100-->
</contrastLevel>
</SnapColor>

400
Intelligent Security API (Traffic) Developer Guide

B.259 XML_SnapGain
SnapGain message in XML format
<SnapGain version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<snapGainLevel min="0" max="100">
<!--req, xs:integer, gain level for captured pictures, which ranges from 0 to 100-->
</snapGainLevel>
</SnapGain>

B.260 XML_SnapLPDE
SnapLPDE message in XML format
<SnapLPDE version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enable>
<!--req, xs:boolean, whether to enable license plate enhancement: "true"-yes, "false"-no-->
</enable>
<level min="0" max="100" def="50">
<!--dep, xs:integer, license plate enhancement level, which ranges from 0 to 100, the default value is 50-->
</level>
</SnapLPDE>

B.261 XML_SnapNoiseReduce2D
SnapNoiseReduce2D message in XML format
<SnapNoiseReduce2D version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<noiseReduce2DEnable>
<!--req, xs:boolean, whether to enable 2D noise reduction for captured pictures: "true"-yes, "false"-no-->
</noiseReduce2DEnable>
<noiseReduce2DLevel min="0" max="100">
<!--dep, xs:integer, 2D noise reduction level for captured pictures, which ranges from 0 to 100-->
</noiseReduce2DLevel>
</SnapNoiseReduce2D>

B.262 XML_SnapPlateContrast
SnapPlateContrast message in XML format
<SnapPlateContrast version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<plateContrastLevel min="0" max="100" def="0">
<!--opt, xs:integer, license plate contrast level, which ranges from 0 to 100, the default value is 0-->
</plateContrastLevel>
</SnapPlateContrast>

401
Intelligent Security API (Traffic) Developer Guide

B.263 XML_SnapPlateSaturation
SnapPlateSaturation message in XML format
<SnapPlateSaturation version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<plateSaturationLevel min="0" max="100" def="0">
<!--opt, xs:integer, license plate saturation level, which ranges from 0 to 100, the default value is 0-->
</plateSaturationLevel>
</SnapPlateSaturation>

B.264 XML_SnapShadowHighlight
SnapShadowHighlight message in XML format
<SnapShadowHighlight version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<mode opt= "close,SAE,HLC,SAE_HLC,DCE">
<!--req, xs:string, mode: "close"-none, "SAE"-dark space enhancement, "HLC"-highlight compensation, "SAE_HLC"-
dark space enhancement and highlight compensation, "DCE"-part contrast enhancement-->
</mode>
<level min="0" max="100" def="50">
<!--dep, xs:integer, mode level, which ranges from 0 to 100, the default value is 50-->
</level>
</SnapShadowHighlight>

B.265 XML_SnapShutter
SnapShutter message in XML format
<SnapShutter version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<snapShutterLevel min="120" max="14887">
<!--req, xs:integer, shutter (exposure time) when capturing pictures, which ranges from 120 to 14887, unit:
microsecond-->
</snapShutterLevel>
</SnapShutter>

B.266 XML_StatisticCap
StatisticCap message in XML format
<StatisticCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<StatisticCfg/><!--refer to the message XML_StatisticCfg for details-->
<StatisticOperator/><!--refer to the message XML_StatisticOperator for details-->
<StatisticOperatorResult/><!--refer to the message XML_StatisticOperatorResult for details-->
</StatisticCap>

402
Intelligent Security API (Traffic) Developer Guide

See Also
XML_StatisticCfg
XML_StatisticOperator
XML_StatisticOperatorResult

B.267 XML_StatisticCfg
StatisticCfg message in XML format
<StatisticCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled opt="true,false"><!--req, xs: boolean, whether to enable traffic flow statistics--></enabled>
<trafficStatisticsPeriod>
<!--opt, xs: integer, statistics period, unit: second, default: 300-->
</trafficStatisticsPeriod>
<blockedSensibility><!--opt, xs: integer, congestion threshold--></blockedSensibility>
<unblockedSensibility><!--opt, xs: integer, fluent threhold--></unblockedSensibility>
<bigCarRatio>
<!--opt, xs: integer, large-scale vehicle flow percentage, which is between 0% and 100%, default: 25%-->
</bigCarRatio>
<rulesInfoEnabled><!--opt, xs: boolean, rule information--></rulesInfoEnabled>
</StatisticCfg>

B.268 XML_StatisticOperator
StatisticOperator message in XML format
<StatisticOperator version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<operationType><!--req, xs: string, operation type: search, delete, format--></operationType>
<searchCond><!--dep, this node is valid when <operationType> is set to search-->
<searchID><!--req, xs: string, search ID--></searchID>
<timeSpanList>
<timeSpan><!--list, req-->
<startTime><!--req, xs: string, format:YYYY-MM-DDTHH:mm:ssZ--></startTime>
<endTime><!--req, xs: string, format:YYYY-MM-DDTHH:mm:ssZ--></endTime>
</timeSpan>
</timeSpanList>
<criteria>
<channel><!--req, xs: string, channel No., each No. should be separated by comma--></channel>
<vehicleType><!--req, xs: integer, vehicle type: 0-all, 1-large-scale vehicle, 2-small-scale vehicle--></vehicleType>
<statisticMode><!--req, xs: integer, statistics mode: 1-by month, 2-by day, 3-by hour--></statisticMode>
<displayMode><!--req, xs: integer, display mode: 1-table, 2-histogram, 3-point diagram--></displayMode>
<laneNo><!--req, xs: integer, lane No., 0-all--></laneNo>
<laneDirect><!--req, xs: integer, lane direction: 0-all, 1-up, 2-down--></laneDirect>
<illegalType><!--optional, xs:integer, violation type: 0-all, 1-overspeed, 2-low speed, 3-wrong-way driving, 4-driving
on the lane line. Only one type can be selected--></illegalType>
<vehicleSpeed><!--optional, xs:integer, vehicle speed: 0-all, 1-exceeding 120% and under 150% of speed limit, 2-
exceeding 150% of speed limit. Only one value can be selected--></vehicleSpeed>

403
Intelligent Security API (Traffic) Developer Guide

</criteria>
<searchResultPosition><!--req, xs: integer, the default value is 0--></searchResultPosition>
<maxResults><!--req, xs: integer, maximum number of results, default: 20--></maxResults>
</searchCond>
<deleteCond><!--dep, this node is valid when <operationType> is set to "delete"-->
<IDList>
<ID><!--req, xs: integer, database ID, multiple records can be deleted at same time--></ID>
</IDList>
</deleteCond>
</StatisticOperator>

B.269 XML_StatisticOperatorResult
StatisticOperatorResult message in XML format
<StatisticOperatorResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<statusCode>
<!--req, xs: integer, status or error code, refer to Error Codes in ResponseStatus for details-->
</statusCode>
<description><!--req, xs: string, error description--></description>
<searchID><!--req, xs: string--></searchID>
<numOfMatches><!--req, xs: integer, number of returned results--></numOfMatches>
<totalMatches><!--req, xs: integer, total number of search results--></totalMatches>
<StatisticList>
<Statistic><!--list-->
<ID><!--req, xs: integer--></ID>
<direction><!--req, xs: string, direction: 0-all, 1, 2--></direction>
<laneNo><!--req, xs: string, lane No.: 0-all--></laneNo>
<vehicleType>
<!--req, xs: string, vehicle type: 0-all, 1-large-scale vehicle, 2-small-scale vehicle-->
</vehicleType>
<startTime><!--req, xs: string, start time--></startTime>
<endTime><!--req, xs: string, end time--></endTime>
<timePoint><!--req, xs: string, time point--></timePoint>
<channel><!--req, xs: integer--></channel>
<carFlux><!--req, xs: integer, total number of passed vehicles--></carFlux>
<smallCarFlux><!--req, xs: integer, number of passed small-scale vehicles--></smallCarFlux>
<bigCarFlux><!--req, xs: integer, number of passed large-scale vehicles--></bigCarFlux>
<passerbyFlux><!--req, xs: integer, number of passed pedestrians--></passerbyFlux>
<averOccpancy><!--req, xs: float, average occupancy--></averOccpancy>
<averSpeed><!--req, xs: string, average speed, unit: km/s--></averSpeed>
<averCarDis><!--req, xs: string, average distance between two vehicles, unit: m--></averCarDis>
<midCarFlux><!--req, xs: integer, number of passed middle-scale vehicles--></midCarFlux>
<averTimeOccupancy><!--opt, xs: integer, average lane occupancy (%)--></averTimeOccupancy>
<averQueueLength>
<!--opt, xs: integer, actual queue length, unit: m, value range: [0,500]-->
</averQueueLength>
<trafficState>
<!--opt, xs: integer, lane traffic status: 0-unknown, 1-fluent, 2-crowd, 3-congestion-->
</trafficState>

404
Intelligent Security API (Traffic) Developer Guide

</Statistic>
</StatisticList>
</StatisticOperatorResult>

B.270 XML_StatisticsResult
StatisticsResult message in XML format
<StatisticsResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<RemoteList>
<Statistics><!--req, xs: list-->
<HostID><!--req, xs: integer--></HostID>
<UploadedCount><!--req, xs: integer--></UploadedCount>
<Total><!--req, xs: integer--></Total>
</Statistics>
</RemoteList>
</StatisticsResult>

B.271 XML_StatisticsSearch
StatisticsSearch message in XML format
<StatisticsSearch version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema>
<timeSpanList>
<timeSpan><!--req,xs:list-->
<startTime><!--req, xs: string, start time, format:YYYY-MM-DD HH:mm:ssZ--></startTime>
<endTime><!--req, xs: string, end time, format:YYYY-MM-DD HH:mm:ssZ--></endTime>
</timeSpan>
</timeSpanList>
</StatisticsSearch>

B.272 XML_Svce
Svce message in XML format
<Svce version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled>
<!--req, xs:boolean, whether to enable part contrast-->
</enabled>
<svceLevel>
<!--dep, xs:integer, part contrast level, which ranges from 0 to 100, the default value is 50-->
</svceLevel>
</Svce>

405
Intelligent Security API (Traffic) Developer Guide

B.273 XML_TMECap
TMECap capability message in XML format
<TMECap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<isSupportTMEChargeRule><!--optional, xs:boolean--></isSupportTMEChargeRule>
<isSupportPaperCharge><!--optional, xs:boolean--></isSupportPaperCharge>
<isSupportParkingSpace><!--optional, xs:boolean--></isSupportParkingSpace>
<isSupportTMEOffline><!--optional, xs:boolean--></isSupportTMEOffline>
<isSupportTMEMultiCtrl><!--optional, xs:boolean--></isSupportTMEMultiCtrl>
<isSupportTMECFG><!--optional, xs:boolean--></isSupportTMECFG>
<isSupportChargeAmount><!--optional, xs:boolean--></isSupportChargeAmount>
<isSupportVehicleCtrl><!--optional, xs:boolean--></isSupportVehicleCtrl>
<isSupportBarrierGate><!--optional, xs:boolean--></isSupportBarrierGate>
<isSupportTemporaryParkingCard><!--optional, ,xs:boolean--></isSupportTemporaryParkingCard>
<isSupportLEDConfiguration><!--optional, xs:boolean--></isSupportLEDConfiguration>
<isSupportVoiceBroadcastInfo><!--optional, xs:boolean--></isSupportVoiceBroadcastInfo>
<isSupportPaperPrintFormatInfo><!--optional, xs:boolean--></isSupportPaperPrintFormatInfo>
<isSupportLockGateConfig><!--optional, xs:boolean--></isSupportLockGateConfig>
<isSupportTMEVoiceConfiguration><!--optional, xs:boolean--></isSupportTMEVoiceConfiguration>
<isSupportVoiceFileUpload><!--optional, xs:boolean--></isSupportVoiceFileUpload>
<isSupportVoiceFileList><!--optional, xs:boolean--></isSupportVoiceFileList>
</TMECap>

B.274 XML_TMEVoiceConfiguration
TMEVoiceConfiguration message in XML format
<TMEVoiceConfiguration version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<!--control parameters of audio announcement-->
<voiceSpeed>
<!--req, xs:integer, speed, which is between 0 and 100-->
</voiceSpeed>
<voicePitch>
<!--req, xs:integer, intonation, which is between 0 and 100-->
</voicePitch>
<voiceVolum>
<!--req, xs:integer, volume, which is between 0 and 100-->
</voiceVolum>
<voiceRole>
<!--req, xs:integer, speaker:"3,51,52,53,54,55"-->
</voiceRole>
<voiceContent>
<!--req, xs:string, audio announcement content-->
</voiceContent>
<voiceFileName>
<!--req, xs:string, audio file name-->
</voiceFileName>
<voicePlate>

406
Intelligent Security API (Traffic) Developer Guide

<!--opt, xs:boolean, whether to enable audio announcement for license plates-->


</voicePlate>
</TMEVoiceConfiguration>

B.275 XML_TrafficCap
XML message about traffic capability
<TrafficCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<plateCap>
<!--opt, license plate related capability-->
<supCustomStateOrProvince>
<!--opt, xs:boolean, whether it supports custom province-->
</supCustomStateOrProvince>
<supCountry opt="ER,EU,All,ME">
<!--opt, xs:string, country and region: "ER"-CIS region, "EU"-Europe region, "All"-all regions, "ME"-the Middle East--
>
</supCountry>
<isSupportPlateList>
<!--opt, xs:boolean, whether it supports importing and exporting license plate blacklist and whitelist-->
</isSupportPlateList>
<plateListNum>
<!--opt, integer, maximum number of imported blacklists and whitelists supported by the device-->
</plateListNum>
<plateMaskLen>
<!--opt, integer, maximum length of license plate characters supported by the device-->
</plateMaskLen>
<isNotSupportLicenseImport>
<!--opt, xs:boolean-->
</isNotSupportLicenseImport>
<isSupportIllegalParkingDetection>
<!--opt, xs:boolean, whether it supports illegal parking detection-->
</isSupportIllegalParkingDetection>
</plateCap>
<isNotSupportImageMerge>
<!--opt, xs:boolean, whether it does not support picture overlay-->
</isNotSupportImageMerge>
<isNotSupportOverlaps>
<!--opt, xs:boolean, whether it does not support text overlay-->
</isNotSupportOverlaps>
<isSupportContentMgmt>
<!--opt, xs:boolean, whether it supports traffic terminal server-->
</isSupportContentMgmt>
<isSupportVehicleDetection>
<!--dep, xs:boolean, whether it supports vehicle recognition-->
</isSupportVehicleDetection>
<isSupportHVTVehicleDetection>
<!--dep, xs:boolean, whether it supports mixed traffic detection-->
</isSupportHVTVehicleDetection>
<isSupportSignal>

407
Intelligent Security API (Traffic) Developer Guide

<!--opt, xs:boolean, whether it supports traffic lights controlled by the network-->


</isSupportSignal>
<isSupportEPlate>
<!--opt, xs:boolean, whether it supports electronic license plate access-->
</isSupportEPlate>
<isSupportUpgradeByUSB>
<!--optional, xs:boolean, whether it supports upgrading via USB-->
</isSupportUpgradeByUSB>
</TrafficCap>

B.276 XML_TrafficContentMgmtCap
TrafficContentMgmtCap message in XML format
<TrafficContentMgmtCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<netPortStatus opt="true,false"><!--opt, xs: boolean--></netPortStatus>
<uploadModuleStatus opt="true,false"><!--opt, xs: boolean--></uploadModuleStatus>
<trafficLightStatus opt="true,false"><!--opt, xs: boolean--></trafficLightStatus>
<chanDevStatus opt="true,false"><!--opt, xs: boolean--></chanDevStatus>
<realTrafficStats opt="true,false"><!--opt, xs: boolean--></realTrafficStats>
<dataOperation opt="true,false"><!--opt, xs: boolean--></dataOperation>
<picRecInfo opt="true,false"><!--opt, xs: boolean--></picRecInfo>
<Picture opt="true,false"><!--opt, xs: boolean--></Picture>
<RemoteHost opt="true,false"><!--opt, xs: boolean--></RemoteHost>
<Statistic opt="true,false"><!--opt, xs: boolean--></Statistic>
<SlaveSystem opt="true,false"><!--opt, xs: boolean--></SlaveSystem>
<FaceEvidence opt="true,false"><!--opt, xs: boolean--></FaceEvidence>
<Section opt="true,false"><!--opt, xs: boolean--></Section>
<ChannelMatch opt="true,false"><!--opt, xs: boolean--></ChannelMatch>
<picModel opt="true,false"><!--opt, xs: boolean--></picModel>
<GPS opt="true,false"><!--opt, xs: boolean--></GPS>
<FortifyStatus opt="true,false"><!--opt, xs: boolean--></FortifyStatus>
<lmsStatistic opt="true,false"><!--opt, xs: boolean--></lmsStatistic>
<autoUpdateblackList>
<!--opt, xs: boolean, whether supports automatically synchronize the blacklist-->
</autoUpdateblackList>
<travelingCrane opt="true,false">
<!--opt, xs: boolean, whether supports crane bridge parameters-->
</travelingCrane>
<imageMerge opt="true,false">
<!--opt, xs: boolean, whether supports picture collaging-->
</imageMerge>
<InputProxy opt="true,false">
<!--opt, xs: boolean, whether supports configuring digital channels of terminal server-->
</InputProxy>
<wirelessDialStatus opt="true,false">
<!--opt, xs: boolean, wireless network status-->
</wirelessDialStatus>
</TrafficContentMgmtCap>

408
Intelligent Security API (Traffic) Developer Guide

B.277 XML_TrafficChannelCap
Traffic channel capability message in XML format
<TrafficChannelCap version="1.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<deviceTypeSupport>
<!--optional, xs: integer, device type: 0-video monitoring, 1-loop detection, 2-video analysis, 3-reserved, 4-video
analysis (event + traffic enforcement + traffic data collection), 5-video analysis + capture (event + traffic enforcement +
traffic data collection), 6-video structurization, 7-speed dome for dynamic tracking and capture, 8-speed dome for non-
dynamic tracking and capture-->
</deviceTypeSupport>
<isPTZSupport><!--optional, xs:boolean, whether it supports configuring PTZ type, PTZ address, PTZ control speed,
and zooming speed--><isPTZSupport>
<isEvidenceGettingSupport>
<!--optional, xs: boolean, whether it supports violation enforcement, setting scenes, and scene auto-switch-->
</isEvidenceGettingSupport>
<isBasicSupport>
<!--optional, xs: boolean, whether it supports setting basic parameters-->
</isBasicSupport>
<isImageMergeSupport>
<!--optional, xs: boolean, whether it supports picture overlay-->
</isImageMergeSupport>
<isOverlapSupport>
<!--optional, xs: boolean, whether it supports text overlay-->
</isOverlapSupport>
<isEdfAlgSupport>
<!--optional, xs: boolean, whether it supports setting analysis parameters-->
</isEdfAlgSupport>
<isAutoTraceSupport>
<!--required, xs: boolean, whether it supports auto-tracking-->
</isAutoTraceSupport>
<isEdfManualItsCapSupport>
<!--optional, xs: boolean, whether it supports setting manual enforcement parameters-->
</isEdfManualItsCapSupport>
<isViolationTypeStdSupport>
<!--optional, xs: boolean, whether it supports violation code-->
</isViolationTypeStdSupport>
<isEDFRemoteHostSupport>
<!--optional, xs: boolean, whether it supports remote host-->
</isEDFRemoteHostSupport>
<isANRSupport>
<!--optional, xs: boolean, whether it supports ANR-->
</isANRSupport>
<isvoiceTriggerSupport>
<!--optional, xs: boolean, whether it supports audible linkage-->
</isvoiceTriggerSupport>
<uploadDataTypesSupport>
<!--optional, xs: string, uploaded data types:
"illegalParking,wrongDirection,crossLane,congestion,parkingEvidence,crossLaneEvidence,wrongDirectionEvidence,lane
Change,turnRound,laneChangeEvidence,turnRoundEvidence,vehicleexist,vehicleexistEvidence,edfManualEvidence,obj
ectDroppedDown,smoke"-->

409
Intelligent Security API (Traffic) Developer Guide

</uploadDataTypesSupport>
<aidTypeSupport>
<!--optional, xs:string, traffic incident types:
"illegalParking,wrongDirection,crossLane,laneChange,turnRound,congestion,vehicleexist,pedestrian,objectDroppedDo
wn,smoke,edfManual,trafficAccident,construction,roadBlock,abandonedObject,fogDetection"-->
</aidTypeSupport>
<isIntellMonitorSupport>
<!--optional, xs: boolean, whether it supports smart surveillance-->
</isIntellMonitorSupport>
<isVCRSupport>
<!--optional, xs: boolean, whether it supports vehicle statistics-->
</isVCRSupport>
<isEdfManualTrackSupport>
<!--optional, xs: boolean, whether it support manual tracking and enforcement-->
</isEdfManualTrackSupport>
<videoEvidenceTypeSupport
opt="illegalParking,wrongDirection,crossLane,laneChange,turnRound,vehicleexist,edfManualEvidence">
<!--optional, xs: string, uploaded video evidence types-->
</videoEvidenceTypeSupport>
<isRecordParamSupport>
<!--optional, xs: boolean, whether it supports setting recording parameters-->
</isRecordParamSupport>
<AIDEventSupport opt="abandonedObject, pedestrian, congestion, roadBlock, construction, trafficAccident,
fogDetection, wrongDirection, illegalParking, SSharpDriving, lowSpeed, dragRacing">
<!--optional, xs: string, supported traffic incident type: "abandonedObject"-objects dropped down, "pedestrian"-
pedestrian, "congestion"-congestion, "roadBlock"-roadblock, "construction"-construction, "trafficAccident"-traffic
accident, "fogDetection"-fog, "wrongDirection"-wrong-way driving, "illegalParking"-illegal parking, "SSharpDriving"-
slalom driving, "lowSpeed"-driving in low speed, "dragRacing"-street racing-->
</AIDEventSupport>
<TFSEventSupport opt="illegalParking, wrongDirection, crossLane, laneChange, vehicleExist, turnRound,
parallelParking, notKeepDistance, notSlowZebraCrossing, overtakeRightSide, lowSpeed, dragRacing,
changeLaneContinuously, SSharpDriving, largeVehicleOccupyLine, jamCrossLine">
<!--optional, xs: string, supported enforcement event type: "illegalParking"-illegal parking, "wrongDirection"-wrong-
way driving, "crossLane"-driving on the lane line, "laneChange"-illegal lane change, "vehicleExist"-motor vehicle on
non-motor vehicle lane, "turnRound"-illegal U-turn, "parallelParking"-parallel parking, "notKeepDistance"-not keeping
vehicle distance, "notSlowZebraCrossing"-not slowing down at zebra corssing, "overtakeRightSide"-overtaking on the
right, "lowSpeed"-driving in low speed, "dragRacing"-street racing, "changeLaneContinuously"-continuous lane
change, "SSharpDriving"-slalom driving, "largeVehicleOccupyLine"-lane occupation by large-sized vehicle,
"jamCrossLine"-queue jumping-->
</TFSEventSupport>
<isVehicleStatisticsSupport>
<!--optional, xs: boolean, whether it supports setting parameters for traffic data collection-->
</isVehicleStatisticsSupport>
<isLaneRuleSupport>
<!--optional, xs: boolean, whether it supports setting lane rules-->
</isLaneRuleSupport>
<isSupportPlateListEvidence>
<!--optional, xs: boolean, whether it supports setting parameters for blacklist and whitelist ANPR enforcement-->
</isSupportPlateListEvidence>
<isSupportMixedTargetDetection>
<!--optional, xs: boolean, whether it supports multi-target-type detection-->
</isSupportMixedTargetDetection>

410
Intelligent Security API (Traffic) Developer Guide

<isSupportVideoOverlays>
<!--optional, xs: boolean, whether it supports overlaying information on video-->
</isSupportVideoOverlays>
<isSupportAddrInfo>
<!--optional, xs:boolean, whether it supports overlaying address information-->
</isSupportAddrInfo>
<VehiclePositionControl><!--optional, whether it supports vehicle direction control-->
<license min="0" max="16"><!--required, xs:string, license plate number--></license>
<intervalTime min="0" max="65535" def="1"><!--required, xs:integer, upload interval, unit: s, by default it is 1--></
intervalTime>
</VehiclePositionControl>
<isSupportLicensePlateExposure><!--optional, xs:boolean, whether it supports license plate exposure, return "true" if
it supports, and this node will not be returned if the device does not supports this function--></
isSupportLicensePlateExposure>
<isSupportFiltration><!--optional, xs:boolean, whether it supports filtering duplicated license plate, return "true" if it
supports, and this node will not be returned if the device does not support the function--></isSupportFiltration>
</TrafficChannelCap>

Example
TrafficChannelCap Message Example
<TrafficChannelCap version="2.0" xmlns="http://www.hikvision.com/ver20/XMLSchema">
<isEvidenceGettingSupport>false</isEvidenceGettingSupport>
<isBasicSupport>true</isBasicSupport>
<isImageMergeSupport>true</isImageMergeSupport>
<isOverlapSupport>true</isOverlapSupport>
<isEdfAlgSupport>true</isEdfAlgSupport>
<isEdfManualItsCapSupport>false</isEdfManualItsCapSupport>
<isEDFRemoteHostSupport>true</isEDFRemoteHostSupport>
<isANRSupport>true</isANRSupport>
<isvoiceTriggerSupport>false</isvoiceTriggerSupport>
<uploadDataTypesSupport></uploadDataTypesSupport>

<aidTypeSupport>wrongDirection,turnRound,vehicleexist,congestion,crossLane,laneChange,pedestrian,roadBlock,aba
ndonedObject,construction,trafficAccident,fogDetection</aidTypeSupport>
<isIntellMonitorSupport>false</isIntellMonitorSupport>
<isVCRSupport>false</isVCRSupport>
<isEdfManualTrackSupport>false</isEdfManualTrackSupport>
<videoEvidenceTypeSupport></videoEvidenceTypeSupport>
<TFSEventSupport>wrongDirection,turnRound,vehicleexist,crossLane,laneChange</TFSEventSupport>
<AIDEventSupport>congestion,pedestrian,roadBlock,abandonedObject,construction,trafficAccident,fogDetection</
AIDEventSupport>
<isVehicleStatisticsSupport>true</isVehicleStatisticsSupport>
<isLaneRuleSupport>true</isLaneRuleSupport>
<isSupportPlateListEvidence>true</isSupportPlateListEvidence>
</TrafficChannelCap>

B.278 XML_TrafficEventTrigger
TrafficEventTrigger message in XML format.

411
Intelligent Security API (Traffic) Developer Guide

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


<EventType><!--req,-->
<allVehicleList><!--opt,xs:boolen--></allVehicleList>
</EventType>
</TrafficEventTrigger>

B.279 XML_TrafficParam
TrafficParam message in XML format
<TrafficParam xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<enable>
<!--dep, xs: boolean, whether to enable traffic flow statistics and collection-->
</enable>
<statisticsMinute>
<!--req, xs:integer, statistics interval, which ranges from 0 to 65535, unit: minute-->
</statisticsMinute>
<tpsStatistic>
<!--opt, traffic flow statistics-->
<enabled>
<!--req, xs:boolean, whether to enable traffic flow statistics-->
</enabled>
<statisticsMinute>
<!--req, xs:integer, statistics interval, unit: minute-->
</statisticsMinute>
</tpsStatistic>
</TrafficParam>

B.280 XML_TrafficSearchResult
TrafficSearchResult message in XML format
<TrafficSearchResult version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<searchID><!--req, xs: string, search ID--></searchID>
<statusCode><!--req, xs: integer, status or error code, refer to Error Code in ResponseStatus for details--></
statusCode>
<description><!--req, xs: string, string to describe the returned error code--></description>
<numOfMatches><!--req, xs: integer, number of matched results for current search--></numOfMatches>
<totalMatches><!--req, xs: integer, total number of matched results--></totalMatches>
<matchList>
<matchElement><!--list-->
<trafficData>
<id><!--req, xs: string, search ID--></id>
<camera>
<id><!--req, xs: integer, channel No.--></id>
</camera>
<laneNo><!--req, xs: integer, lane No.--></laneNo>
<vehicleLen><!--req, xs: integer, vehicle length--></vehicleLen>

412
Intelligent Security API (Traffic) Developer Guide

<vehicleWidth><!--req, xs: integer, vehicle width--></vehicleWidth>


<vehicleHigh><!--req, xs: integer, vehicle height--></vehicleHigh>
<plate><!--req, xs: string, license plate number--></plate>
<plateType>
<!--opt, xs: string, license plate types: unknown,92TypeCivil,arm,upDownMilitay,92TypeArm,leftRightMilitay,
02TypePersonalized,yellowTwoLine,
04NewMilitay,embassy,oneLineArm,twoLineArm,yellow1225FarmVehicle,green1325FarmVehicle,yellow1325FarmVehi
cle,motorola,coach,tempTravl,trailer,consulate,hongKongMacao,tempEntry,civilAviation,newEnergy-->
</plateType>
<plateColor>
<!--opt, xs: string, license plate color:
white,yellow,blue,black,green,civilAviationBlack,civilAviationGreen,newEnergyGreen,newEnergyYellowGreen,0xff-->
</plateColor>
<vehicleTypeByIdentify><!--req, xs: integer, vehicle model--></vehicleTypeByIdentify>
<direction><!--req, xs: integer, direction: 1-drive up on picture, 2-drive down on picture--></direction>
<speed><!--req, xs: integer, speed--></speed>
<ctrl><!--req, xs: integer--></ctrl>
<drive><!--req, xs: integer--></drive>
<part><!--req, xs: integer--></part>
<fileNo><!--req, xs: integer, picture file No.--></fileNo>
<startOffset><!--req, xs: integer, picture file offset--></startOffset>
<picLen><!--req, xs: integer, actual picture size--></picLen>
<captureTime><!--req, xs: string, captured time--></captureTime>
<sendflag1><!--req, xs: integer, sending flag of uploading host 1--></sendflag1>
<sendflag2><!--req, xs: integer, sending flag of uploading host 2--></sendflag2>
<sendflag3><!--req, xs: integer, sending flog of FTP1--></sendflag3>
<sendflag4><!--req, xs: integer, sending flog of FTP2--></sendflag4>
<vehicleInfo><!--opt-->
<index><!--req, xs: integer, vehicle No.--></index>
<vehicleType><!--opt, xs: integer, vehicle type: 0-other,1-samll-scale vehicle, 2-large-scale vehicle, 3-pedestrian,
4-two-wheel vehicle, 5-three-wheel vehicle--></vehicleType>
<colorDepth><!--req, xs: integer, vehicle color depth: 0-dark color, 1-light color--></colorDepth>
<color><!--req, xs:string, vehicle color:
unknown,white,silver,gray,black,red,deepBlue,blue,yellow,green,brown,pink,purple,deepGray,cyan,orange--></color>
<speed><!--req, xs: integer, vehicle speed, unit: km/h--></speed>
<length><!--req, xs: integer, length of previous vehicle, unit: dm--></length>
<vehicleLogoRecog><!--req, xs: integer, main vehicle brand--></vehicleLogoRecog>
<vehileSubLogoRecog><!--opt, xs: integer, sub vehicle brand--></vehileSubLogoRecog>
<vehileModel><!--opt, xs: integer, model of sub vehicle brand--></vehileModel>
<vehicleTypeByWeight>
<!--opt, xs: integer, vehicle type based on weight: 1-type 1 (coach: 7-seat and below; truck: 2-ton loads or
below), 2-type 2 (coach: 8 to 19-seat, truck: 2 to 5-ton (includes 5) loads), 3-type 3 (coach: 20 to 39-seat, truck: 5 to 10-
ton (includes 10) loads), 4-type 4 (coach: 40-seat and above, truck: 10 to 15-ton (includes 15) loads), 5-type 5 (truck:
15-ton and above)-->
</vehicleTypeByWeight>
</vehicleInfo>
<violationType><!--opt, xs: integer, reserved--></violationType>

<container/><!--opt, reserved-->
<Human><!--opt, human body attributes-->
<Property><!--req, attribute list-->
<description><!--req, xs: string--></description>

413
Intelligent Security API (Traffic) Developer Guide

<value><!--req, xs: string, attribute value--></value>


</Property>
</Human>
<Face><!--opt, face attributes-->
<Property><!--req, attribute list-->
<description><!--req, xs: string, description--></description>
<value><!--req, xs: string, attribute value--></value>
</Property>
</Face>
<ePlateUUID><!--opt, xs: string, electronic license plate information ID--></ePlateUUID>
</trafficData>
</matchElement>
</matchList>
</TrafficSearchResult>

B.281 XML_InputProxyChannel
InputProxyChannel (for traffic) message in XML format
<InputProxyChannel version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<channel>
<!--req, xs: integer, channel No.-->
</channel>
<BasicInfo/><!--refer to the message XML_BasicInfo for details-->
<ChanCtrl/><!--refer to the message XML_ChanCtrl for details-->
<OcrConfigList>
<OcrConfig/>
</OcrConfigList>
</InputProxyChannel>

See Also
XML_Device_BasicInfo
XML_ChanCtrl

B.282 XML_InputProxyChannelsCap
InputProxyChannelsCap (for traffic) message in XML format
<InputProxyChannelsCap version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<InputProxyChannel>
<channel>
<!--req, xs: integer, channel No.-->
</channel>
<BasicInfo/><!--refer to the message XML_BasicInfo for details-->
<ChanCtrl/><!--refer to the message XML_ChanCtrl for details-->
<OcrConfigList>
<OcrConfig/>
</OcrConfigList>

414
Intelligent Security API (Traffic) Developer Guide

</InputProxyChannel>
</InputProxyChannelsCap>

Remarks
XML_Device_BasicInfo
XML_ChanCtrl

B.283 XML_InputProxyChannelsList
InputProxyChannelsList (for traffic) message in XML format
<InputProxyChannelsList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<InputProxyChannel>
<channel>
<!--req, xs: integer, channel No.-->
</channel>
<BasicInfo>
<deviceType>
<!--opt, xs: integer, device type: 0-video monitoring, 1-loop detection, 2-video analysis, 3-exit/entrance capture
unit, 4-video analysis (event + traffic enforcement + traffic data collection), 5-video analysis + capture (event + traffic
enforcement + traffic data collection), 6-video structurization, 7-speed dome for dynamic tracking and capture, 8-
speed dome for non-dynamic tracking and capture-->
</deviceType>
</BasicInfo>
<ipAddr></ipAddr>
<online><!--req, xs: integer, 0-offline, 1-online--></online>
<supportPTZStats><!--req, xs: integer, 0-box camera, 1-speed dome--></ supportPTZStats>
<scenoMode><!--req, xs: integer, scene No., which is between 1 and 16--></scenoMode>
<ChanCtrl/><!--refer to the message XML_ChanCtrl for details-->
<OcrConfigList>
<OcrConfig/>
</OcrConfigList>
</InputProxyChannel>
</InputProxyChannelsList>

Remarks
XML_ChanCtrl

B.284 XML_TX1Status
TX1Status message in XML format
<TX1Status version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<systemNum><!--req, xs: integer, number of subsystems, value range: [1,16]--></systemNum>
<TX1SystemList>
<TX1SystemStatus><!--list-->
<ID><!--req, xs: string, TX1 subsystem ID--></ID>
<TX1><!--req, xs: integer, 0-not support, 1-normal, 2-to be confirmed, 3-exception--></TX1>

415
Intelligent Security API (Traffic) Developer Guide

</TX1SystemStatus>
</TX1SystemList>
</TX1Status>

B.285 XML_UnusedChannel
UnusedChannel message in XML format
<UnusedChannel version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<channels><!--req, xs: string--></channels>
</UnusedChannel>

B.286 XML_UploadCtrl
UploadCtrl message in XML format
<UploadCtrl version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<hostID><!--req, xs: integer--></hostID>
<ctrlType><!--req, xs: string--></ctrlType>
<startTime><!--req, xs: string, start time, format:YYYY-MM-DD HH:mm:ss--></startTime>
<endTime><!--req, xs: string, end time, format:YYYY-MM-DD HH:mm:ss--></endTime>
<dataType><!--req, xs: integer--></dataType>
</UploadCtrl>

B.287 XML_UploadModule
UploadModule message in XML format
<UploadModule version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<UploadHostID>
<!--data uploading module ID: 0-remote host server 1, 1-remote host server 2, 2-FTP server 1, 3-FTP sever 2-->
</UploadHostID>
<UploadHostEnable><!--whether to enable data uploading module: 0-no, 1-yes--></UploadHostEnable>
<UploadHostNetStatus><!--network status--></UploadHostNetStatus>
<UploadCurrDataRealTime>
<!--captured time of real-time data to be uploaded, e.g., 2013-08-28 15:20:00.856-->
</UploadCurrDataRealTime>
<UploadCurrDataHistoryTime>
<!--captured time of history data to be uploaded, e.g., 2013-08-28 15:20:00.856-->
</UploadCurrDataHistoryTime>
<UploadDataCost><!--time consumption for uploading one item of data--></UploadDataCost>
<UploadResultInfo><!--uploading prompt information, the maximum lenth is 64 bytes--></UploadResultInfo>
</UploadModule>

416
Intelligent Security API (Traffic) Developer Guide

B.288 XML_UploadModuleStateList
UploadModuleStateList message in XML format
<UploadModuleStateList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<UploadModule>
<UploadHostID>
<!--data uploading module ID: 0-remote host server 1, 1-remote host server 2, 2-FTP server 1, 3-FTP sever 2-->
</UploadHostID>
<UploadHostEnable><!--whether to enable data uploading module: 0-no, 1-yes--></UploadHostEnable>
<UploadHostNetStatus><!--network status--></UploadHostNetStatus>
<UploadCurrDataRealTime>
<!--captured time of real-time data to be uploaded, e.g., 2013-08-28 15:20:00.856-->
</UploadCurrDataRealTime>
<UploadCurrDataHistoryTime>
<!--captured time of history data to be uploaded, e.g., 2013-08-28 15:20:00.856-->
</UploadCurrDataHistoryTime>
<UploadDataCost><!--time consumption for uploading one item of data--></UploadDataCost>
<UploadResultInfo><!--uploading prompt information, the maximum lenth is 64 bytes--></UploadResultInfo>
</UploadModule>
</UploadModuleStateList>

B.289 XML_UploadPic
UploadPic message in XML format
<UploadPic xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">
<uploadPicPriority>
<!--req, xs:integer, picture uploading priority-->
</uploadPicPriority>
</UploadPic>

B.290 XML_VCLCfg
VXLCfg message in XML format
<VCLCfg>
<disabledBlackList opt="true,false">
<!--req, xs: boolean, disable blacklist, if this node does not exist or the whole message is not returned, it represents
enabled-->
</disabledBlackList>
<disabledWhiteList opt="true,false">
<!--req, xs: boolean, disable whitelist, if this node does not exist or the whole message is not returned, it represents
enabled-->
</disabledWhiteList>
<enabledBlackListTimeSlot opt="true,false">
<!--req, xs: boolean, enable arming schedule of blacklist->

417
Intelligent Security API (Traffic) Developer Guide

<enabledBlackListTimeSlot>
<enabledWhiteListTimeSlot opt="true,false">
<!--req, xs: boolean, enable arming schedule of whitelist-->
<enabledWhiteListTimeSlot>
</VCLCfg>

B.291 XML_VCLData
VCLData message in XML format
<VCLData version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<currentUpNum>
<!--req, xs:integer, number of currently uploaded lists-->
</currentUpNum>
<totalNum>
<!--req, xs:integer, total number of searched lists-->
</totalNum>
<VCLDataList>
<singleVCLData>
<id>
<!--req, xs:integer, list No.-->
</id>
<disabled><!--opt, xs: boolean, if this node does not exist, it represents enabled, otherwise, "true" represents
enabled--></disabled>
<runNum>
<!--req, xs:integer, data serial No., which is mark used for platform data synchronization and is between 1 and
4294836225, the value configured by the control is 0-->
</runNum>
<listType>
<!--req, xs:integer, list type: 0-whitelist, 1-blacklist-->
</listType>
<plateNum>
<!--req, xs:string, license plate number, the maximum length is 16 bytes-->
</plateNum>
<plateColor>
<!--req, xs:integer, license plate color: 0-blue, 1-yellow, 2-white, 3-black, 4-green, 0xff-other-->
</plateColor>
<plateType>
<!--req, xs:integer, license plate type: 0-standard civil vehicle and military vehicle, 1-standard 02 civil vehicle, 2-
armed police vehicle, 3-police vehicle, 4-civil vehicle with two-line license plate, 5-embassy vehicle license plate, 6-
agricultural vehicle license plate, 7-motorcycle license plate-->
</plateType>
<cardNo>
<!--reg, xs:string, card No., the maximum length is 48 bytes-->
</cardNo>
<startTime>
<!--reg, xs:datetime, valid start time, e.g., 2009-06-10T12:00:00Z-->
</startTime>
<endTime>
<!--reg, xs:datetime, valid end time, e.g., 2014-06-10T12:00:00Z-->

418
Intelligent Security API (Traffic) Developer Guide

</endTime>
<startDay>
<!--opt, xs: string, start date, e.g., 2018-05-16-->
</startDay>
<endDay>
<!--opt, xs: string, end time, e.g., 2018-05-16-->
</endDay>
<startTimeOfDay>
<!--opt, xs: string, start time of the daytime, e.g., 08:00-->
</startTimeOfDay>
<endTimeOfDay>
<!--opt, xs: string, end time of the daytime, e.g., 18:00-->
</endTimeOfDay>
</singleVCLData>
</VCLDataList>
</VCLData>

B.292 XML_VCLDelCond
VCLDelCond message in XML format
<VCLDelCond version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<delVCLCond>
<!--reg, xs:integer, list deleting condition: 0-all, 1-license plate number, 2-card No., 3-license plate color, 4-license
plate type, 5-license plate number and license plate color, 6-ID-->
</delVCLCond>
<plateNum>
<!--dep, xs:string, license plate number, the maximum length is 16 bytes-->
</plateNum>
<plateColor>
<!--dep, xs: integer, license plate color: 0-blue, 1-yellow, 2-white, 3-black, 4-green, 0xff-other-->
</plateColor>
<plateType>
<!--dep, xs: integer, license plate type: 0-standard civil vehicle and military vehicle, 1-standard 02 civil vehicle, 2-
armed police vehicle, 3-police vehicle, 4-civil vehicle with two-line license plate, 5-embassy vehicle license plate, 6-
agricultural vehicle license plate, 7-motorcycle license plate-->
</plateType>
<cardNo>
<!--dep, xs:string, card No., the maximum length is 48 bytes-->
</cardNo>
<id><!--req, xs: integer--></id>
<startDay>
<!--opt, xs: string, start date, e.g., 2018-05-16-->
</startDay>
<endDay>
<!--opt, xs: string, end time, e.g., 2018-05-16-->
</endDay>
<startTimeOfDay>
<!--opt, xs: string, start time of the daytime, e.g., 08:00-->
</startTimeOfDay>

419
Intelligent Security API (Traffic) Developer Guide

<endTimeOfDay>
<!--opt, xs: string, end time of the daytime, e.g., 18:00-->
</endTimeOfDay>
</VCLDelCond>

B.293 XML_VCLGetCond
VCLGetCond message in XML format
<VCLGetCond version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<getVCLNum>
<!--reg, xs:integer, maximum number of lists that can be obtained, which is the number of data that can be obtained
specified by the control-->
</getVCLNum>
<startOffSet>
<!--reg, xs:integer, starting position of searching in the list-->
</startOffSet>
<getVCLCond>
<!--reg, xs:integer, list getting condition: 0-all, 1-license plate number, 2-card No., 3-list type-->
</getVCLCond>
<listType>
<!--dep, xs:integer, list type: 0-whitelist, 1-blacklist-->
</listType>
<plateNum>
<!--dep, xs:string, license plate number, the maximum length is 16 bytes-->
</plateNum>
<cardNo>
<!--dep, xs:string, card No., the maximum length is 48 bytes-->
</cardNo>
<startDay>
<!--opt, xs: string, start date, e.g., 2018-05-16-->
</startDay>
<endDay>
<!--opt, xs: string, end time, e.g., 2018-05-16-->
</endDay>
<startTimeOfDay>
<!--opt, xs: string, start time of the daytime, e.g., 08:00-->
</startTimeOfDay>
<endTimeOfDay>
<!--opt, xs: string, end time of the daytime, e.g., 18:00-->
</endTimeOfDay>
</VCLGetCond>

B.294 XML_VehicleDetectCfg
Vehicle detection configuration message in XML format
<VehicleDetectCfg version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--required, xs:boolean--></enabled>

420
Intelligent Security API (Traffic) Developer Guide

<nation><!--optional, xs:string, "ER"-CIS Region, "EU"-Europe Region, "ME"-Middle East, "AP"-Asia Pacific,
"AfricaAndAmerica"-Africa and America, "All"-All Region--></nation>
<stateOrProvince> <!--optional, xs:string--> </stateOrProvince>
<bestDetectionSize> <!--optional, xs:string--> </bestDetectionSize>
<VehicleDetectSceneList>
<VehicleDetectScene/>
</VehicleDetectSceneList>
<PlateDetectionRegion>
<PlateSize>
<minWidth> <!--optional, xs:interger--> </minWidth>
<maxWidth> <!--optional, xs:interger--> </maxWidth>
</PlateSize>
<plateMode><!--optional,xs:string, "small,large", License plate mode--></plateMode>
</PlateDetectionRegion>
<RodeType><!--optional-->
<type><!--optional, xs:string,"entrance,city,custom,alarmInput"--> </type>
<Custom><!--dependent, custom-->
<delayTime><!--optional, xs:interger,[0,15000]--></delayTime>
<delayTimeUnit><!--optional, xs:string, "ms"--></delayTimeUnit>
</Custom>
</RodeType>
<countryIndex><!--optional, xs:integer, country/region No.--></countryIndex>
<!--compatibility between countryIndex and CRIndex-->
<!--device: both fields will be returned, when the value of CRIndex is smaller than or equal to 255, the value of
countryIndex is the same as that of CRIndex; when the value of CRIndex is larger than 255, the value of countryIndex
is 253 (the field countryIndex is invalid)-->
<!--integration flow: for new users, CRIndex has higher priority over countryIndex and the field countryIndex is used
only when countryIndex does not exist; when the value of countryIndex is 253, additional logic processing should be
adopted to use CRIndex field-->
<CRIndex><!--optional, xs:integer, country/region No., when the value is 0, it indicates that no country/region is
specified--></CRIndex>
</VehicleDetectCfg>

B.295 XML_VehicleDetectScheduleList
VehicleDetectScheduleList message in XML format
<VehicleDetectScheduleList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Schedule>
<id><!--req, xs:string; id --></id>
<inputIOPortID><!--ro, dep, xs:string; id--></inputIOPortID>
<outputIOPortID><!--ro, dep, xs:string; id--></inputIOPortID>
<videoInputChannelID><!--ro, dep, xs:string; id--></videoInputChannelID>
<TimeBlockList> <!--req-->
<TimeBlock>
<dayOfWeek>
<!--opt, xs:integer, ISO8601 weekday number, 1=Monday, … -->
</dayOfWeek>
<TimeRange><!--req-->
<beginTime><!--req, xs:time, ISO8601 time--></beginTime>

421
Intelligent Security API (Traffic) Developer Guide

<endTime><!--req, xs:time, ISO8601 time--></endTime>


</TimeRange>
<CustomExtension>
<vehicleDetectSceneID><!--req, xs:interger--></vehicleDetectSceneID>
</CustomExtension>
</TimeBlock>
</TimeBlockList>
</Schedule>
</VehicleDetectScheduleList>

B.296 XML_VideoEpolice
VideoEpolice message in XML format
<VideoEpolice version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<enabled><!--req, xs: boolean, whether to enable intersection violation system--></enabled>
<relatedLaneCount>
<!--req, xs: integer, number of linked lanes, which is between 1 and 6-->
</relatedLaneCount>
<TrafficLight><!--req-->
<source><!--req, xs: string, signal source, "IO,RS485,videoDetect,network"--></source>
<IOLightList><!--dep, list-->
<IOLight><!--I/O access-->
<lightId><!--req, xs: integer, traffic light No., which is between 1 and 3--></lightId>
<lightType><!--req, xs: string, guiding direction of traffic light: "left,straight,right"--></lightType>
<relatedIO>
<!--req, xs: string, linked I/O input: "NON_IO,IO1,IO2,IO3,IO4,IO5,IO6,IO7,IO8"-->
</relatedIO>
<redLightStatus><!--req, xs: string, red light level status: "low"-low-level red light, "high"-high-level red light--></
redLightStatus>
</IOLight>
</IOLightList>
<RS485LightList><!--dep, list-->
<RS485Light><!--RS-485 access-->
<lightId><!--req, xs: integer, RS-485 signal No., which is between 1 and 3--></lightId>
<lightType><!--req, xs: string, traffic guide light: "left,straight,right"--></lightType>
<relatedLightChan>
<!--req, xs: integer, detector channel No. linked to red light, which is between 0 and 16, 0-no channel linked-->
</relatedLightChan>
<yellowLightChan>
<!--req, xs: integer, detector channel No. linked to yellow light, which is between 0 and 16, 0-no channel linked-->
</yellowLightChan>
</RS485Light>
</RS485LightList>
<NetworkLightList>
<!--dep, list-->
<NetworkLight>
<lightId>
<!--req, xs:integer, network signal No., which is between 1 and 3-->
</lightId>

422
Intelligent Security API (Traffic) Developer Guide

<lightType>
<!--req, xs:string, traffic guide light: "left,straight,right"-->
</lightType>
<relatedLightChan>
<!--req, xs:integer, linked channel No. of red light, which is between 0 and 16, 0-no channel linked-->
</relatedLightChan>
<yellowLightChan>
<!--req, xs:integer, linked channel No. of yellow light, which is between 0 and 16, 0-no channel linked-->
</yellowLightChan>
</NetworkLight>
</NetworkLightList>
<videoDetectLightList><!--dep, list-->
<videoDetectLight><!--video detection access-->
<videoDetectLightId>
<!--req, xs: integer, video detection signal No., which is between 1 and 12-->
</videoDetectLightId>
<lightNum><!--req, xs: integer, number of traffic lights, which is between 1 and 3--></lightNum>
<straightLight><!--req, xs: boolean, whether the straight driving light is on--></straightLight>
<leftLight><!--req, xs: boolean, whether the left-turn light is on--></leftLight>
<rightLight><!--req, xs: boolean, whether the right-turn light is on--></rightLight>
<redLight><!--req, xs: boolean, whether the red light is on--></redLight>
<greenLight><!--req, xs: boolean, whether the green light is on--></greenLight>
<yellowLight><!--req, xs: boolean, whether the yellow light is on--></yellowLight>
<yellowLightTime>
<!--req, xs: integer, yellow light duration, which is between 0 and 10, unit: second-->
</yellowLightTime>
<rectRegion><!--req, traffic light region-->
<positionLeft><!--req, xs: integer, left boundary, value range: 0 to 65535--></positionLeft>
<positionTop><!--req, xs: integer, top boundary, value range: 0 to 65535 --></positionTop>
<positionRight><!--req, xs: integer, right boundary, value range: 0 to 65535--></positionRight>
<positionBottom><!--req, xs: integer, bottom boundary, value range: 0 to 65535--></positionBottom>
</rectRegion>
</videoDetectLight>
</videoDetectLightList>
</TrafficLight>
<LaneParamList><!--req, lane parameter list-->
<LaneParam><!--req-->
<laneId><!--req, xs: integer, lane No.--></laneId>
<laneDirectionType><!--req, xs: integer, lane direction No., which is between 0 and 8--></laneDirectionType>
<relatedDriveWay><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<recordEnable><!--req, xs: boolean, whether to enable recording when red light running is detected--></
recordEnable>
<recordType><!--req, xs: string, recording type, "preRecord,delayRecord"--></recordType>
<beginTime><!--req, xs: integer, recording start time, "1,2,3"--></beginTime>
<preRecordTime><!--req, xs: integer, pre-record time, unit: second--></preRecordTime>
<recordDelayTime><!--req, xs: integer, post-record time, unit: second--></recordDelayTime>
<recordTimeOut><!--req, xs: integer, recording timeout, unit: second--></recordTimeOut>
<usageType>
<!--req, xs: string, lane usage, only one of the options can be supported at a time, "carriageWay"-normal lane,
"bus"-fast lane, "slow"-slow lane, "nonmotor"-non-motor lane, "reverse"-reverse lane, "emergency"-emergency lane--
>
</usageType>

423
Intelligent Security API (Traffic) Developer Guide

<LaneUsageList><!--opt, lane usage, one or multiple options can be supported at a time-->


<laneUsage><!--opt, xs:string, lane usage: "bus"-bus lane, "banTrucks"-trucks prohibited lane, "banLeft"-left-turn
prohibited lane, "banRight"-right-turn prohibited lane, "motor"-motorcycle lane--></laneUsage>
</LaneUsageList>
<banTrucksTimeSwitchList><!--req, list of large-sized vehicle prohibited time periods-->
<banTrucksTimeSwitch><!--req-->
<timeId><!--req, xs:integer, time period No., which is between 1 and 4--></timeId>
<startHour><!--dep, xs:integer, start time (hour), which is between 0 and 23--></startHour>
<startMinute><!--dep, xs:integer, start time (minute), which is between 0 and 59--></startMinute>
<endHour><!--dep, xs:integer, end time (hour), which is between 0 and 23--></endHour>
<endMinute><!--dep, xs:integer, end time (minute), which is between 0 and 59--></endMinute>
</banTrucksTimeSwitch>
</banTrucksTimeSwitchList>
<busWayTimeSwitchList><!--req, list-->
<busWayTimeSwitch><!--req-->
<timeId><!--req, xs:integer, "1-4" --></timeId>
<startHour><!--dep, xs:integer, "0-23" --></startHour>
<startMinute><!--dep, xs:integer, "0-59" --></startMinute>
<endHour><!--dep, xs:integer, "0-23" --></endHour>
<endMinute><!--dep, xs:integer, "0-59" --></endMinute>
</busWayTimeSwitch>
</busWayTimeSwitchList>
<radarEnabled><!--req, xs: boolean, whether to enable radar speed detection--></radarEnabled>
<Radar><!--req-->
<radarType>
<!--req, xs: string, radar type: "none", "adr"-Andoray, "adr4Byte"-Andoray (no radar controller), "olvia"-Olvia,
"csr"-TransMicrowave, "IOBox"-radar connecting I/O expansion box, "SSTK"-WHST, "custom"-custom type-->
</radarType>
<radarSensitivity><!--req, xs: integer, sensitivity--></radarSensitivity>
<radarAngle><!--req, xs: integer, angle between the radar and the horizontal direction, which is between 0 and 90
and the default value is 0--></radarAngle>
<validRadarSpeedTime>
<!--req, xs: integer, effective duration of radar speed, which is between 0 and 2000, unit: millisecond-->
</validRadarSpeedTime>
<radarLinearCorrection>
<!--req, xs: float, linear correction parameter, which is between 0.0 and 2.0, the actual value should be the
configured value multiplying 1000-->
</radarLinearCorrection>
<radarConstantCorrection>
<!--req, xs: integer, constant correction parameter, which is between -100 and 100-->
</radarConstantCorrection>
<radarRS485><!--req, xs: integer, radar linked RS-485 port No., which is between 1 and 5--></radarRS485>
</Radar>
<directionType>
<!--req, xs: string, lane direction:
"unknown,straight,leftStraight,right,leftRight,rightStraight,leftRightStraight,leftWait,straightWait,strightWaitRight"-->
</directionType>
<stopLineDistance>
<!--req, xs: integer, distance between the vehicle and the stop line in the second captured picture of red light
running violation, which is between 0 and 300, unit: pixel-->
</stopLineDistance>
<loopSensitivity>

424
Intelligent Security API (Traffic) Developer Guide

<!--req, xs: integer, loop sensitivity, which is between 1 and 100-->


</loopSensitivity>
<capPositionOffset min="0" max="300">
<!--req, xs: integer, minimum offset between the capture positions of the second and the third picture, which is
between 0 and 1500, unit: pixel-->
</capPositionOffset>
<detectSnapType><!--req, type of capture triggered by video detection-->
<post><!--req, xs: boolean, whether to enable checkpoint detection--></post>
<overSpeed><!--reg, xs:boolean, whether to enable overspeed detection--></overSpeed>
<overSpeedCapNo>
<!--req, xs:integer, number of captured pictures in which the overspeed violation is detected, which is between 2
and 3 and the default value is 2-->
</overSpeedCapNo>
<driveLine><!--req, xs: boolean, whether to enable driving on lane line detection--></driveLine>
<driveLineCapNo>
<!--req, xs: integer, number of continuously captured pictures in which the driving on lane line happened, which
is between 2 and 3 and the default value is 2-->
</driveLineCapNo>
<driveLineSensitivity>
<!--req, xs: integer, sensitivity of driving on lane line detection, which is between 0 and 100-->
</driveLineSensitivity>
<reverse><!--req, xs: boolean, whether to enable wrong-way driving detection--></reverse>
<reverseCapNo>
<!--req, xs: integer, number of captured pictures in which the wrong-way driving is detected, which is between 2
and 3 and the default value is 2-->
</reverseCapNo>
<redLight><!--req, xs: boolean, whether to enable red light running detection--></redLight>
<redLightMode>
<!--req, xs: integer, red light running mode, 0-by direction, 1-by lane-->
</redLightMode>
<direction>
<!--req, xs: boolean, whether to enable detection of driving in wrong lane at intersection-->
</direction>
<illegalPriority>
<!--req, xs: integer, traffic violation priority, 0-none, 1-red light running first-->
</illegalPriority>
<intersectionCongest><!--req, xs: boolean, whether to enable intersection congestion detection--></
intersectionCongest>
<nonDriveWay><!--req, xs: boolean, whether to enable detection of motor vehicle on non-motor vehicle lane--></
nonDriveWay>
<nonDriveWayCapNo>
<!--req, xs: integer, number of captured pictures in which motor vehicle on non-motor vehicle lane happened,
which is between 2 and 3 and the default value is 2-->
</nonDriveWayCapNo>
<nonDriveWayTime>
<!--req, xs: integer, capture duration of motor vehicle on non-motor vehicle lane , which is between 10 and 240,
unit: second, this node is not recommended to be configured-->
</nonDriveWayTime>
<changeLane><!--req, xs: boolean, whether to enable illegal lane change detection--></changeLane>
<changeLaneCapNo><!--req, xs: integer, number of captured pictures in which illegal lane change is detected,
which is between 2 and 3 and the default value is 2--></changeLaneCapNo>
<banSign><!--req, xs: boolean, whether to enable ban breaking detection--></banSign>

425
Intelligent Security API (Traffic) Developer Guide

<banSignCapNo>
<!--dep, xs: integer, number of continuously captured pictures in which the ban is broken, which is between 2
and 3 and the default value is 2-->
</banSignCapNo>
<intersectionStop><!--req, xs: boolean, whether to enable intersection parking detection--></intersectionStop>
<greenLightStop><!--req, xs: boolean, whether to enable detection of parking at green light--></greenLightStop>
<illegalUTurn><!--req, xs: boolean, whether to enable illegal U-turning detection--></illegalUTurn>
<gasser><!--opt, queue jumping-->
<enabled><!--req, xs: boolean, whether to enable queue jumping detection--></enabled>
<gasserCapNo>
<!--req, xs: integer, number of captured pictures in which the queue jumping happened-->
</gasserCapNo>
<sensitivity><!--req, xs: integer, detection sensitivity--></sensitivity>
<congestionThreshold>
<!--req, xs: integer, congestion threshold, which is between 1 and 100-->
</congestionThreshold>
<capInterval>
<!--req, xs: integer, time interval of continuous capture (2 to 3 pictures), unit: millisecond-->
</capInterval>
</gasser>
<congestion><!--opt, congestion-->
<enabled><!--opt, xs: boolean, whether to enable congestion detection--></enabled>
<interval><!--req, integer, alarm time interval, unit: minute--></interval>
<sensitivity><!--req, xs: integer, congestion sensitivity--></sensitivity>
<lastTime><!--req, xs: integer, congestion duration, unit: second--></lastTime>
</congestion>
<accident><!--opt, accident detection-->
<enabled><!--req, xs: boolean, whether to enable accident detection--></enabled>
<lastTime><!--req, xs: integer, accident duration, unit: second--></lastTime>
<interval><!--req, xs: integer, time interval of continuous capture, unit: minute--></interval>
</accident>
<nonMotorEnabled>
<!--opt, xs: boolean, whether to enable non-motor vehicle detection-->
</nonMotorEnabled>
<runGreenLight>
<!--opt, xs: boolean, whether to enable green light running detection-->
</runGreenLight>
</detectSnapType>
<ViolationDetectLineList><!--req, list-->
<ViolationDetectLine><!--req, draw violation detection line for a single lane-->
<lineName>
<!--req, xs: string, detection line name: "laneLine,stopLine,redlightLine,cancelLine,waitLine"-->
</lineName>
<lineType>
<!--req, xs: string, detection line type: "unknown", "white"-white solid line, "singleYellow"-single yellow line,
"doubleYellow"-double yellow line, "guardRail"-lane line with guardrail, "noCross"-lane line prohibited to cross by
vehicle-->
</lineType>
<customName><!--req, xs: string, custom triggering line name--></customName>
<RegionCoordinatesList><!--req, list-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs:integer--></positionX>

426
Intelligent Security API (Traffic) Developer Guide

<positionY><!--req, xs:integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</ViolationDetectLine>
</ViolationDetectLineList>
</LaneParam>
</LaneParamList>
<VirtualLaneList><!--req, list-->
<VirtualLane><!--req, virtual lane line-->
<lineName>
<!--req, xs: string, "laneRightBoundaryLine, turnLeftLine,turnRightLine,topZebraLine,bottomZebraLine" -->
</lineName>
<lineType>
<!--req, xs: string, detection line type: "unknown", "white"-white solid line, "singleYellow"-single yellow line,
"doubleYellow"-double yellow line, "guardRail"-lane line with guardrail, "noCross"-lane line prohibited to cross by
vehicle-->
</lineType>
<RegionCoordinatesList><!--req, list-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs:integer--></positionX>
<positionY><!--req, xs:integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</VirtualLane>
</VirtualLaneList>
<Posting>
<postingEnable><!--req, xs:boolean, whether to enable positioning frame--></postingEnable>
<postingSize><!--req, xs:boolean, positioning frame size: small-300 pixels, medium-400 pixels, large-500 pixels--></
postingSize>
</Posting>
<leftNotYieldStraight>
<enable><!--req, xs: boolean, whether to enable detection of left-turn without straight driving--></enable>
</leftNotYieldStraight>
<rightNotYieldLeft>
<enable><!--req, xs: boolean, whether to enable detection of only right-turn--></enable>
</rightNotYieldLeft>
<uTurnNotYieldGoingStaight>
<enable><!--req, xs: boolean, whether to enable detection of U-turn without straight driving--></enable>
</uTurnNotYieldGoingStaight>
<leftSideDrivingAfterLeftTurn>
<enable><!--req, xs: boolean, whether to enable detection of small turn at big bend--></enable>
</leftSideDrivingAfterLeftTurn>
<failYieldPed><!--opt-->
<enable><!--req, xs: boolean, whether supports detection of not yield to pedestrian--></enable>
<vehicleFromDirection>
<!--req, xs: string, driving direction of the vehicle which does not yield to pedestrian, "Front,Back"-->
</vehicleFromDirection>
<cameraPosition>
<!--opt, xs: string, camera position, "crossing,roadSection"-->
</cameraPosition>
<noDisplacementPedEnabled>
<!--req, xs: boolean, whether to enable no displacement capture of pedestrian-->

427
Intelligent Security API (Traffic) Developer Guide

</noDisplacementPedEnabled>
<failYieldPedLineList><!--list-->
<failYieldPedLine>
<lineId><!--req, xs:integer--></lineId>
<lineName><!--req, xs:string--></lineName>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</failYieldPedLine>
</failYieldPedLineList>
<notification><!--opt, pedestrain linkage-->
<enable><!--req, xs: boolean, whether to enable pedestrian linkage--></enable>
<ip><!--req, xs: string, IP address of traffic camera--></ip>
<port><!--req, xs: integer, port No. of traffic camera--></port>
<username><!--req, xs: string, user name of traffic camera--></username>
<password><!--req, xs: string, password of traffic camera, when transmitting, HTTPS is required--></password>
<sensitivity><!--req, xs: integer, triggering sensitivity, which is between 0 and 100--></sensitivity>
<RS485Port>
<!--req, xs:integer, RS-485 port No. for the traffic light to access the camera, which is between 1 and 10-->
</RS485Port>
</notification>
</failYieldPed>
<helmetCapNo>
<!--dep, xs: integer, number of captured pictures in which the driver does not wear the helmet, this node is valid
only when <helmet> is "true"-->
</helmetCapNo>
<nonMotorExistCapNo>
<!--opt, xs: boolean, number of captured pictures in which the motor lane is occupied by non-motor vehicle-->
</nonMotorExistCapNo>
<capType>
<!--opt, xs:string, "vehicle,nonMotor,human,face"-->
</capType>
</VideoEpolice>

Remarks
The nodes <usageType> and <LaneUsageList> are mutually exclusive, if the node <usageType> is
configured, the node <LaneUsageList> cannot be configured.

B.297 XML_VideoMarkInfo
VideoMarkInfo message in XML format
<VideoMarkInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<horizontalField>
<!--req, xs:integer, horizontal FOV (field of view), which ranges from 0 to 360, the default value is 0-->
</horizontalField>
<verticalField>

428
Intelligent Security API (Traffic) Developer Guide

<!--reg, xs:integer, vertical FOV (field of view), which ranges from 0 to 360, the default value is 0-->
</verticalField>
<autoGetGps>
<!--req, xs:boolean, whether to get GPS information automatically: "true"-yes, "false"-no (default)-->
</autoGetGps>
<longitude>
<!--reg, xs:string, longitude-->
</longitude>
<latitude>
<!--reg, xs:string, latitude-->
</latitude>
</VideoMarkInfo>

B.298 XML_VideoMonitor
VideoMonitor message in XML format
<VideoMonitor version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<relatedLaneCount><!--req, xs: integer, total number of linked lanes, which is between 1 and 3--></
relatedLaneCount>
<capType>
<!--req, xs: string, captured target type: "vehicle"-motor vehicle, "vehWithHum"-non-motor vehicle-->
</capType>
<ViolationDetectLineList><!--req-->
<ViolationDetectLine><!--req, draw violation detection line on the single lane-->
<lineName><!--req, xs: string, detection line name, "laneLine" (for a single lane only)--></lineName>
<relatedDriveWay><!--req, xs: integer, linked lane No.--></relatedDriveWay>
<laneDirectionType>
<!--req, xs: integer, lane direction type No., which is between 0 and 8-->
</laneDirectionType>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</ViolationDetectLine>
</ViolationDetectLineList>
<VirtualLane><!--req, draw violation detection line on all lanes-->
<lineName>
<!--req, xs: string, detection line name, "laneRightBoundaryLine"-right lane boundary line (for all lanes)-->
</lineName>
<RegionCoordinatesList><!--req-->
<RegionCoordinates><!--only two coordinates are required-->
<positionX><!--req, xs: integer--></positionX>
<positionY><!--req, xs: integer--></positionY>
</RegionCoordinates>
</RegionCoordinatesList>
</VirtualLane>
</VideoMonitor>

429
Intelligent Security API (Traffic) Developer Guide

B.299 XML_VoiceBroadcastInfo
VoiceBroadcastInfo message in XML format
<VoiceBroadcastInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema"><!--information about
configuration parameters of audio prompt control-->
<information min="0" max="128"><!--required, xs:string, audio prompt content. If the audio prompt content does
not need to be obtained in some scenes, this node can be empty--></information>
<voiceFileName><!--optional, xs:string, audio file name. If the audio file is uploaded by calling /ISAPI/Parking/
channels/<ID>/VoiceFileUpload/<NAME> by PUT method, this node corresponds to the <NAME> in the URL--></
voiceFileName>
<cycleTimes><!--optional, xs:integer, repetition times--></cycleTimes>
<stopBroadcast><!--optional, xs:boolean, whether to stop voice prompt--></stopBroadcast>
</VoiceBroadcastInfo>

B.300 XML_VoiceFile
VoiceFile message in XML format
<VoiceFile version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<voiceFileName><!--required, xs:string, audio file name--></voiceFileName>
<voiceContent><!--required, xs:string, prompt content of the audio file. If only the audio file name is required, this
node can be empty--></voiceContent>
<type><!--optional, xs:string, file usage: "all", "loop"-play repeatedly, "alarm"-play alarms. If this node does not exist,
the default value of this node is "all"--></type>
<isSptDeleted><!--optional, xs:boolean, whether it supports deleting the audio file: "true"-yes, "false"-no. If this
node is not returned by the device, the audio file can be deleted by default--></isSptDeleted>
</VoiceFile>

B.301 XML_VoiceFileList
VoiceFileList message in XML format
<VoiceFileList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<VoiceFile/><!--opt, audio file, see details in the message of XML_VoiceFile-->
</VoiceFileList>

See Also
XML_VoiceFile

B.302 XML_WhiteBalance
WhiteBalance message in XML format

430
Intelligent Security API (Traffic) Developer Guide

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


<WhiteBalanceStyle/><!--req, xs:string, "auto, manual, indoor, outdoor, autotrace, onece, sodiumlight,
mercurylight,auto0, atuo1, fluorescent, natural, warm, incandescent"-->
<WhiteBalanceRed/><!--dep,xs:integer, this node depends on <WhiteBalanceStyle>-->
<WhiteBalanceBlue/><!--dep,xs:integer, this node depends on <WhiteBalanceStyle>-->
</WhiteBalance>

Remarks
Setting WhiteBalanceRed and WhiteBalanceBlue is available only when WhiteBalanceStyle is set
to "manual".

B.303 XML_WhiteListScheduleList
WhiteListScheduleList message in XML format
<WhiteListScheduleList version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<Schedule/><!--opt, see details in the message of XML_Schedule-->
</WhiteListScheduleList>

See Also
XML_Schedule

B.304 XML_wirelessDialStatus
wirelessDialStatus message in XML format
<wirelessDialStatus>
<ModuleStatus><!--req, xs: string, wireless module status--></ModuleStatus>
<NetworkSystem><!--req, xs: string, network standard--></NetworkSystem>
<SIMCardStatus><!--req, xs: string, SIM card status--></SIMCardStatus>
<NetworkStatus><!--req, xs: string, network mode--></NetworkStatus>
<SignalStrength><!--req, xs: string, signal strength--></SignalStrength>
<DialStatus><!--req, xs: string, dial-up status--></DialStatus>
<DialProcessStat><!--req, xs: string, dial-up progress--></DialProcessStat>
<IPaddress><!--req, xs: string, IP address of wireless device--></IPaddress>
</wirelessDialStatus>

B.305 XML_WizardDeviceInfo
WizardDeviceInfo message in XML format
<WizardDeviceInfo version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id>
<!--req, xs:integer, channel No.-->
</id>

431
Intelligent Security API (Traffic) Developer Guide

<defaultCHN>
<!--req, xs:string, province abbreviation-->
</defaultCHN>
<ipVersion opt="IPv4, IPv6, dual">
<!--req, xs:string, IP version, only IPv4 is supported-->
</ipVersion>
<ipAddress min="0" max="40">
<!--dep, xs:string, IP address-->
</ipAddress>
<subnetMask min="0" max="15">
<!--dep, xs:string, subnet mask for IPv4 address-->
</subnetMask>
<DefaultGateway>
<!--dep, default gateway, currently only IPv4 is supported-->
<ipAddress>
<!--dep, xs:string-->
</ipAddress>
<ipv6Address>
<!--dep, xs:string-->
</ipv6Address>
</DefaultGateway>
<capMode>
<!--req, xs:string, capture mode: "strobe"-strobe light mode, "flashing"-flashing light mode-->
</capMode>
<sceneMode>
<!--req, xs:string, scene mode: "commonEntrance"-common entrance and exit, "tollGate"-toll station (vehicles will
stay for longer time), "ParkingEntrance"-entrance and exit of underground parking lot (there will be dark day and
night)-->
</sceneMode>
</WizardDeviceInfo>

B.306 XML_WizardFirstLogin
WizardFirstLogin message in XML format
<WizardFirstLogin version="2.0" xmlns="http://www.isapi.org/ver20/XMLSchema">
<id>
<!--req, xs:integer, channel No.-->
</id>
<isFirstLogin>
<!--opt, xs:boolean, the default value is "true"-->
</isFirstLogin>
<isReboot>
<!--opt, xs:boolean, the default value is "true"-->
</isReboot>
</WizardFirstLogin>

432
Intelligent Security API (Traffic) Developer Guide

Appendix C. Response Codes of Text Protocol


The response codes returned during the text protocol integration is based on the status codes of
HTTP. 7 kinds of status codes are predefined, including 1 (OK), 2 (Device Busy), 3 (Device Error), 4
(Invalid Operation), 5 (Invalid Message Format), 6 (Invalid Message Content), and 7 (Reboot
Required). Each kind of status code contains multiple sub status codes, and the response codes are
in a one-to-one correspondence with the sub status codes.

StatusCode=1

SubStatusCode Error Code Description


ok 0x1 Operation completed.
riskPassword 0x10000002 Risky password.
armProcess 0x10000005 Arming process.

StatusCode=2

Sub Status Code Error Code Description


noMemory 0x20000001 Insufficient memory.
serviceUnavailable 0x20000002 The service is not available.
upgrading 0x20000003 Upgrading.
deviceBusy 0x20000004 The device is busy or no
response.
reConnectIpc 0x20000005 The video server is
reconnected.
transferUpgradePackageFailed 0x20000006 Transmitting device upgrade
data failed.
startUpgradeFailed 0x20000007 Starting upgrading device
failed.
getUpgradeProcessfailed. 0x20000008 Getting upgrade status failed.
certificateExist 0x2000000B The Authentication certificate
already exists.

433
Intelligent Security API (Traffic) Developer Guide

StatusCode=3

Sub Status Code Error Code Description


deviceError 0x30000001 Hardware error.
badFlash 0x30000002 Flash operation error.
28181Uninitialized 0x30000003 The 28181 configuration is not
initialized.
socketConnectError 0x30000005 Connecting to socket failed.
receiveError 0x30000007 Receive response message
failed.
deletePictureError 0x3000000A Deleting picture failed.
pictureSizeExceedLimit 0x3000000C Too large picture size.
clearCacheError 0x3000000D Clearing cache failed.
updateDatabasError 0x3000000F Updating database failed.
searchDatabaseError 0x30000010 Searching in the database
failed.
writeDatabaseError 0x30000011 Writing to database failed.
deleteDatabaseError 0x30000012 Deleting database element
failed.
searchDatabaseElementError 0x30000013 Getting number of database
elements failed.
cloudAutoUpgradeException 0x30000016 Downloading upgrade packet
from cloud and upgrading
failed.
HBPException 0x30001000 HBP exception.
UDEPException 0x30001001 UDEP exception
elasticSearchException 0x30001002 Elastic exception.
kafkaException 0x30001003 Kafka exception.
HBaseException 0x30001004 Hbase exception.
sparkException 0x30001005 Spark exception.
yarnException 0x30001006 Yarn exception.
cacheException 0x30001007 Cache exception.

434
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

StatusCode=4

Sub Status Code Error Code Description


notSupport 0x40000001 Not supported.
lowPrivilege 0x40000002 No permission.
badAuthorization 0x40000003 Authentication failed.
methodNotAllowed 0x40000004 Invalid HTTP method.
notSetHdiskRedund 0x40000005 Setting spare HDD failed.
invalidOperation 0x40000006 Invalid operation.
notActivated 0x40000007 Inactivated.
hasActivated 0x40000008 Activated.
certificateAlreadyExist 0x40000009 The certificate already exists.
operateFailed 0x4000000F Operation failed.
USBNotExist 0x40000010 USB device is not connected.

435
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


upgradePackageMoret 0x40001000 Up to 2GB upgrade package is allowed to be
han2GB uploaded.
IDNotexist 0x40001001 The ID does not exist.
synchronizationError 0x40001003 Synchronization failed.
synchronizing 0x40001004 Synchronizing.
importError 0x40001005 Importing failed.
importing 0x40001006 Importing.
fileAlreadyExists 0x40001007 The file already exists.
invalidID 0x40001008 Invalid ID.
backupnodeNotAllowe 0x40001009 Accessing to backup node is not allowed.
Log
exportingError 0x4000100A Exporting failed.
exporting 0x4000100B Exporting.
exportEnded 0x4000100C Exporting stopped.
exported 0x4000100D Exported.
IPOccupied 0x4000100E The IP address is already occupied.
IDAlreadyExists 0x4000100F The ID already exists.
exportItemsExceedLimi 0x40001010 No more items can be exported.
t
noFiles 0x40001011 The file does not exist.
beingExportedByAnoth 0x40001012 Being exported by others.
erUser
needReAuthentication 0x40001013 Authentication is needed after upgrade.
unitAddNotOnline 0x40001015 The added data analysis server is offline.
unitControl 0x40001016 The data analysis server is already added.
analysis unitFull 0x40001017 No more data analysis server can be added.
unitIDError 0x40001018 The data analysis server ID does not exist.
unitExit 0x40001019 The data analysis server already exists in the
list.
unitSearch 0x4000101A Searching data analysis server in the list failed.

436
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


unitNotOnline 0x4000101B The data analysis server is offline.
unitInfoEror 0x4000101C Getting data analysis server information failed.
unitGetNodeInfoError 0x4000101D Getting node information failed.
unitGetNetworkInfoErr 0x4000101E Getting the network information of data
or analysis server failed
unitSetNetworkInfoErr 0x4000101F Setting the network information of data analysis
or server failed
setSmartNodeInfoError 0x40001020 Setting node information failed.
setUnitNetworkInfoErr 0x40001021 Setting data analysis server network
or information failed.
unitRestartCloseError 0x40001022 Rebooting or shutting down data analysis server
failed.
virtualIPnotAllowed 0x40001023 Adding virtual IP address is not allowed.
unitInstalled 0x40001024 The data analysis server is already installed.
badSubnetMask 0x40001025 Invalid subnet mask.
uintVersionMismatche 0x40001026 Data analysis server version mismatches.
d
deviceMOdelMismatch 0x40001027 Adding failed. Device model mismatches.
ed
unitAddNotSelf 0x40001028 Adding peripherals is not allowed.
noValidUnit 0x40001029 No valid data analysis server.
unitNameDuplicate 0x4000102A Duplicated data analysis server name.
deleteUnitFirst 0x4000102B Delete the added data analysis server of the
node first.
getLocalInfoFailed 0x4000102C Getting the server information failed.
getClientAddedNodeFa 0x4000102D Getting the added node information of data
iled analysis server failed.
taskExit 0x4000102E The task already exists.
taskInitError 0x4000102F Initializing task failed.
taskSubmitError 0x40001030 Submiting task failed.
taskDelError 0x40001031 Deleting task failed.

437
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


taskPauseError 0x40001032 Pausing task failed.
taskContinueError 0x40001033 Starting task failed.
taskSeverNoCfg 0x40001035 Full-text search server is not configured.
taskPicSeverNoCfg 0x40001036 The picture server is not configured.
taskStreamError 0x40001037 Streaming information exception.
taskRecSDK 0x40001038 History recording is not supported.
taskCasaError 0x4000103A Cascading is not supported.
taskVCARuleError 0x4000103B Invalid VCA rule.
taskNoRun 0x4000103C The task is not executed.
unitLinksNoStorageNo 0x4000103D No node is linked with the data analysis server.
de Configure the node first.
searchFailed 0x4000103E Searching video files failed.
searchNull 0x4000103F No video clip.
userScheOffline 0x40001040 The task scheduler service is offline.
updateTypeUnmatche 0x40001041 The upgrade package type mismatches.
d
userExist 0x40001043 The user already exists.
userCannotDelAdmin 0x40001044 The administrator cannot be deleted.
userInexistence 0x40001045 The user name does not exist.
userCannotCreatAdmi 0x40001046 The administrator cannot be created.
n
monitorCamExceed 0x40001048 Up to 3000 cameras can be added.
monitorCunitOverLimit 0x40001049 Adding failed. Up to 5 lower-levels are
supported by the control center.
monitorReginOverLimit 0x4000104A Adding failed. Up to 5 lower-levels are
supported by the area.
monitorArming 0x4000104B The camera is already armed. Disarm the
camera and try again.
monitorSyncCfgNotSet 0x4000104C The system parameters are not configured.
monitorFdSyncing 0x4000104E Synchronizing. Try again after completing the
synchronization.

438
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


monitorParseFailed 0x4000104F Parsing camera information failed.
monitorCreatRootFaile 0x40001050 Creating resource node failed.
d
deleteArmingInfo 0x40001051 The camera is already . Disarm the camera and
try again.
cannotModify 0x40001052 Editing is not allowed. Select again.
cannotDel 0x40001053 Deletion is not allowed. Select again.
deviceExist 0x40001054 The device already exists.
IPErrorConnectFailed 0x40001056 Connection failed. Check the network port.
cannotAdd 0x40001057 Only the capture cameras can be added.
serverExist 0x40001058 The server already exists.
fullTextParamError 0x40001059 Incorrect full-text search parameters.
storParamError 0x4000105A Incorrect storage server parameters.
picServerFull 0x4000105B The storage space of picture storage server is
full.
NTPUnconnect 0x4000105C Connecting to NTP server failed. Check the
parameters.
storSerConnectFailed 0x4000105D Connecting to storage server failed. Check the
network port.
storSerLoginFailed 0x4000105E Logging in to storage server failed. Check the
user name and password.
searchSerConnectFaile 0x4000105F Connecting to full-text search server failed.
d Check the network port.
searchSerLoginFailed 0x40001060 Logging in to full-text search server failed.
Check the user name and password.
kafkaConnectFailed 0x40001061 Connecting to Kafka failed. Check the network
port.
mgmtConnectFailed 0x40001062 Connecting to system failed. Check the network
port.
mgmtLoginFailed 0x40001063 Logging in to system failed. Check the user
name and password.

439
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


TDAConnectFailed 0x40001064 Connecting to traffic data access server failed.
Checking the server status.
86sdkConnectFailed 0x40001065 Connecting to listening port of iVMS-8600
System failed. Check the parameters.
nameExist 0x40001066 Duplicated server name.
batchProcessFailed 0x40001067 Processing in batch failed.
IDNotExist 0x40001068 The server ID does not exist.
serviceNumberReache 0x40001069 No more service can be added.
sLimit
invalidServiceType. 0x4000106A Invalid service type.
clusterGetInfo 0x4000106B Getting cluster group information failed.
clusterDelNode 0x4000106C Deletion node failed.
clusterAddNode 0x4000106D Adding node failed.
clusterInstalling 0x4000106E Creating cluster…Do not operate.
clusterUninstall 0x4000106F Reseting cluster…Do not operate.
clusterInstall 0x40001070 Creating cluster failed.
clusterIpError 0x40001071 Invalid IP address of task scheduler server.
clusterNotSameSeg 0x40001072 The master node and slave node must be in the
same network segment.
clusterVirIpError 0x40001073 Automatically getting virtual IP address failed.
Enter manually.
clusterNodeUnadd 0x40001074 The specified master(slave) node is not added.
clusterNodeOffline 0x40001075 The task scheduler server is offline.
nodeNotCurrentIP 0x40001076 The analysis node of the current IP address is
required when adding master and slave nodes.
addNodeNetFailed 0x40001077 Adding node failed. The network disconnected.
needTwoMgmtNode 0x40001078 Two management nodes are required when
adding master and slave nodes.
ipConflict 0x40001079 The virtual IP address and data analysis server's
IP address conflicted.
ipUsed 0x4000107A The virtual IP address has been occupied.

440
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


cloudAlalyseOnline 0x4000107B The cloud analytic server is online.
virIP&mainIPnotSame 0x4000107C The virtual IP address is not in the same
NetSegment network segment with the IP address of
master/slave node.
getNodeDispatchInfoFa 0x4000107D Getting node scheduler information failed.
iled
unableModifyManage 0x4000107E Editing management network interface failed.
mentNetworkIP The analysis board is in the cluster.
notSpecifyVirtualIP 0x4000107F Virtual IP address should be specified for
master and slave cluster.
armingFull 0x40001080 No more device can be armed.
armingNoFind 0x40001081 The arming information does not exist.
disArming 0x40001082 Disarming failed.
getArmingError 0x40001084 Getting arming information failed.
refreshArmingError 0x40001085 Refreshing arming information failed.
ArmingPlateSame 0x40001086 The license plate number is repeatedly armed.
ArmingParseXLSError 0x40001087 Parsing arming information file failed.
ArmingTimeError 0x40001088 Invalid arming time period.
ArmingSearchTimeErro 0x40001089 Invalid search time period.
r
armingRelationshipRea 0x4000108A No more relation can be created.
chesLimit
duplicateAarmingNam 0x4000108B The relation name already exists.
e
noMoreArmingListAdd 0x4000108C No more blacklist library can be armed.
ed
noMoreCamerasAdded 0x4000108D No more camera can be armed.
noMoreArmingListAdd 0x4000108E No more library can be linked to the camera.
edWithCamera
noMoreArmingPeriodA 0x4000108F No more time period can be added to the
dded arming schedule.

441
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

442
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


licenseNotExist 0x400010A6 The dongle does not exist.
SessionExpired 0x400010A7 Session expired .
beyondConcurrentLimi 0x400010A8 Out of concurrent limit.
t
stopSync 0x400010A9 Synchronization stopped.
getProgressFaild 0x400010AA Getting progress failed.
uploadExtraCaps 0x400010AB No more files can be uploaded.
timeRangeError 0x400010AC Time period error.
dataPortNotConnected 0x400010AD The data port is not connected.
addClusterNodeFailed 0x400010AE Adding to the cluster failed. The device is
already added to other cluster.
taskNotExist 0x400010AF The task does not exist.
taskQueryFailed 0x400010B0 Searching task failed.
modifyTimeRuleFailed 0x400010B2 The task already exists. Editing time rule is not
allowed.
modifySmartRuleFailed 0x400010B3 The task already exists. Editing VAC rule is not
allowed.
queryHistoryVideoFaile 0x400010B4 Searching history video failed.
d
addDeviceFailed 0x400010B5 Adding device failed.
addVideoFailed 0x400010B6 Adding video files failed.
deleteAllVideoFailed 0x400010B7 Deleting all video files failed.
createVideoIndexFailed 0x400010B8 Indexing video files failed.
videoCheckTypeFailed 0x400010B9 Verifying video files types failed.
configStructuredAddre 0x400010BA Configuring IP address of structured server
ssFailed failed.
configPictureServerAd 0x400010BB Configuring IP address of picture storaged
dressFailed server failed.
storageServiceIPNotExi 0x400010BD The storage server IP address does not exist.
st

443
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

444
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


controlRelationshipNot 0x400010D0 The relation does not exist.
Exist
getHistoryAlarmInfoFai 0x400010D1 Getting history alarm information failed.
led
getFlowReportFailed 0x400010D2 Getting people counting report failed.
addGuardFailed 0x400010D3 Adding arming configuration failed.
deleteGuardFailed 0x400010D4 Deleting arming configuration failed.
modifyGuardFailed 0x400010D5 Editing arming configuration failed.
queryGuardFailed 0x400010D6 Searching arming configurations failed.
uploadUserSuperCaps 0x400010D7 No more user information can be uploaded.
bigDataServerConnect 0x400010D8 Connecting to big data server failed.
Failed
microVideoCloudRequ 0x400010D9 Adding response information of micro video
estInfoBuildFailed cloud failed.
microVideoCloudRespo 0x400010DA Parsing response information of micro video
nseInfoBuildFailed cloud failed.
transcodingServerRequ 0x400010DB Adding response information of transcoding
estInfoBuildFailed server failed.
transcodingServerResp 0x400010DC Parsing response information of transcoding
onseInfoParseFailed server failed.
transcodingServerOffli 0x400010DD Transcoding server is offline.
ne
microVideoCloudOfflin 0x400010DE Micro video cloud is offline.
e
UPSServerOffline 0x400010DF UPS monitor server is offline.
statisticReportRequestI 0x400010E0 Adding response information of statistics report
nfoBuildFailed failed.
statisticReportRespons 0x400010E1 Parsing response information of statistics report
eInfoParseFailed failed.
DisplayConfigInfoBuild 0x400010E2 Adding display configuration information failed.
Failed
DisplayConfigInfoParse 0x400010E3 Parsing display configuration information failed.
Failed

445
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

446
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

447
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

448
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

449
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

450
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

451
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

452
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


NonprimaryNodeIsPro 0x4000116D Slicing is not allowed by the backup node.
hibitedFromSlcingData
NoReadyNodeToCluste 0x4000116E Creating the cluster failed. No ready node.
rServers
NodeManagementServ 0x4000116F The node management server is offline.
iceIsOffline
theCamera(s)OfTheCo 0x40001170 Some cameras in control center are already
ntrolCenterAreAlready armed. Disarm them and try again.
Armed.DisarmThemFir
st
theCamera(s)OfTheAre 0x40001171 Some cameras in this area are already armed.
aAreAlreadyArmed.Dis Disarm them and try again.
armThemFirst
configuringHigh- 0x40001172 Configuring high frequency people detection
frequencyPeopleDetect failed.
ionFailed
searchingForHigh- 0x40001173 Searching detection event logs of high-
frequencyPeopleDetect frequency people detection failed.
ionLogsFailed.
gettingDetailsOfSearch 0x40001174 Getting the search result details of high
edHigh- frequency alarms failed.
frequencyPeopleDetect
ionLogsFailed.
theArmedCamerasAlre 0x40001175 Some cameras in control center are already
adyExistInTheControlC armed.
enter
disarmingFailedTheCa 0x40001177 Disarming failed. The camera is not armed.
meraIsNotArmed
noDataReturned 0x40001178 No response is returned by the big data service.
preallocFailure 0x40001179 Pre-​allocating algorithm resource failed.
overDogLimit 0x4000117A Configuration failed. No more resources can be
pre-allocated.
analysisServicesDoNot 0x4000117B Not supported.
Support

453
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

454
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

455
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

456
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

457
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


NotSupportWithVideo 0x400020F3 This function is not supported.
Task
incorrectConsolePassw 0x40002106 Saving failed. Incorrect console command.
ord
noDetectionArea 0x400050df No detection area
armingFailed 0x40008000 Arming failed.
disarmingFailed 0x40008001 Disarming failed.
clearAlarmFailed 0x40008002 Clearing alarm failed.
bypassFailed 0x40008003 Bypass failed.
bypassRecoverFailed 0x40008004 Bypass recovery failed.
outputsOpenFailed 0x40008005 Opening relay failed.
outputsCloseFailed 0x40008006 Closing relay failed.
registerTimeOut 0x40008007 Registering timed out.
registerFailed 0x40008008 Registering failed.
addedByOtherHost 0x40008009 The peripheral is already added by other
security control panel.
alreadyAdded 0x4000800A The peripheral is already added.
armedStatus 0x4000800B The partition is armed.
bypassStatus 0x4000800C Bypassed.
zoneNotSupport 0x4000800D This operation is not supported by the zone.
zoneFault 0x4000800E The zone is in fault status.
pwdConflict 0x4000800F Password conflicted.
audioTestEntryFailed 0x40008010 Enabling audio test mode failed.
audioTestRecoveryFaile 0x40008011 Disabling audio test mode failed.
d
addCardMode 0x40008012 Adding card mode.
searchMode 0x40008013 Search mode.
addRemoterMode 0x40008014 Adding keyfob mode.
registerMode 0x40008015 Registration mode.
exDevNotExist 0x40008016 The peripheral does not exist.

458
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

459
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

StatusCode=5

Sub Status Code Error Code Description


badXmlFormat 0x50000001 Invalid XML format.

StatusCode=6

Sub Status Code Error Code Description


badParameters 0x60000001 Invalid parameter.
badHostAddress 0x60000002 Invalid host IP address.
badXmlContent 0x60000003 Invalid XML content.
badIPv4Address 0x60000004 Invalid IPv4 address.
badIPv6Address 0x60000005 Invalid IPv6 address.
conflictIPv4Address 0x60000006 IPv4 address conflicted.
conflictIPv6Address 0x60000007 IPv6 address conflicted.
badDomainName 0x60000008 Invalid domain name.
connectSreverFail 0x60000009 Connecting to server failed.
conflictDomainName 0x6000000A Domain name conflicted.
badPort 0x6000000B Port number conflicted.
portError 0x6000000C Port error.
exportErrorData 0x6000000D Importing data failed.
badNetMask 0x6000000E Invalid sub-net mask.
badVersion 0x6000000F Version mismatches.

460
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


badDevType 0x60000010 Device type mismatches.
badLanguage 0x60000011 Language mismatches.
incorrentUserNameOrPasswor 0x600000012 Incorrect user name or
d password.
invalidStoragePoolOfCloudServ 0x600000013 Invalid storage pool. The
er storage pool is not configured
or incorrect ID.
noFreeSpaceOfStoragePool 0x600000014 Storage pool is full.
riskPassword 0x600000015 Risky password.
UnSupportCapture 0x600000016 Capturing in 4096*2160 or
3072*2048 resolution is not
supported when H.264+ is
enabled.
userPwdLenUnder8 0x60000023 At least two kinds of
characters, including digits,
letters, and symbols, should be
contained in the password.
userPwdNameSame 0x60000025 Duplicated password.
userPwdNameMirror 0x60000026 The password cannot be the
reverse order of user name.
beyondARGSRangeLimit 0x60000027 The parameter value is out of
limit.
DetectionLineOutofDetectionR 0x60000085 The rule line is out of region.
egion
DetectionRegionError 0x60000086 Rule region error. Make sure
the rule region is convex
polygon.
DetectionRegionOutOfCountin 0x60000087 The rule region must be
gRegion marked as red frame.
PedalAreaError 0x60000088 The pedal area must be in the
rule region.
DetectionAreaABError 0x60000089 The detection region A and B
must be in the a rule frame.

461
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


ABRegionCannotIntersect 0x6000008a Region A and B cannot be
overlapped.
customHBPIDError 0x6000008b Incorrect ID of custom human
body picture library
customHBPIDRepeat 0x6000008c Duplicated ID of custom human
body picture library
dataVersionsInHBDLibMismatc 0x6000008d Database versions mismatches
hes of human body picture library
invalidHBPID 0x6000008e Invalid human body picture PID
invalidHBDID 0x6000008f Invalid ID of human body
picture library
humanLibraryError 0x60000090 Error of human body picture
library
humanLibraryNumError 0x60000091 No more human body picture
library can be added
humanImagesNumError 0x60000092 No more human body picture
can be added
noHumanInThePicture 0x60000093 Modeling failed, no human
body in the picture
analysisEnginesNoResourceErr 0x60001000 No analysis engine.
or
analysisEnginesUsageExcced 0x60001001 The engine usage is
overloaded.
PicAnalysisNoResourceError 0x60001002 No analysis engine provided for
picture secondary recognition.
analysisEnginesLoadingError 0x60001003 Initializing analysis engine.
analysisEnginesAbnormaError 0x60001004 Analysis engine exception.
analysisEnginesFacelibImportin 0x60001005 Importing pictures to face
g picture library. Failed to edit
analysis engine parameters.
analysisEnginesAssociatedChan 0x60001006 The analysis engine is linked to
nel channel.

462
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


smdEncodingNoResource 0x60001007 Insufficient motion detection
encoding resources.
smdDecodingNoResource 0x60001008 Insufficient motion detection
decoding resources.
diskError 0x60001009 HDD error.
diskFull 0x6000100a HDD full.
facelibDataProcessing 0x6000100b Handling face picture library
data.
capturePackageFailed 0x6000100c Capturing packet failed.
capturePackageProcessing 0x6000100d Capturing packet.
noSupportWithPlaybackAbstra 0x6000100e This function is not supported.
ct Playback by video synopsis is
enabled.
insufficientNetworkBandwidth 0x6000100f Insufficient network
bandwidth.
tapeLibNeedStopArchive 0x60001010 Stop the filing operation of
tape library first.
identityKeyError 0x60001011 Incorrect interaction command.
identityKeyMissing 0x60001012 The interaction command is
lost.
noSupportWithPersonDensityD 0x60001013 This function is not supported.
etect The people density detection is
enabled.
ipcResolutionOverflow 0x60001014 The configured resolution of
network camera is invalid.
ipcBitrateOverflow 0x60001015 The configured bit rate of
network camera is invalid.
tooGreatTimeDifference 0x60001016 Too large time difference
between device and server.
noSupportWithPlayback 0x60001017 This function is not supported.
Playback is enabled.
channelNoSupportWithSMD 0x60001018 This function is not supported.
Motion detection is enabled.

463
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


channelNoSupportWithFD 0x60001019 This function is not supported.
Face capture is enabled.
illegalPhoneNumber 0x6000101a Invalid phone number.
illegalCertificateNumber 0x6000101b Invalid certificate No.
linkedCameraOutLimit 0x6000101c Connecting camera timed out.
achieveMaxChannelLimit 0x6000101e No more channels are allowed.
humanMisInfoFilterEnabledCha 0x6000101f No more channels are allowed
nNumError to enable preventing false
alarm.
humanEnginesNoResource 0x60001020 Insufficient human body
analysis engine resources.
taskNumberOverflow 0x60001021 No more tasks can be added.
collisionTimeOverflow 0x60001022 No more comparison duration
can be configured.
invalidTaskID 0x60001023 Invalid task ID.
eventNotSupport 0x60001024 Event subscription is not
supported.
invalidEZVIZSecretKey 0x60001034 Invalid verification code for Hik-
Connect.
needDoubleVerification 0x60001042 Double verification required
noDoubleVerificationUser 0x60001043 No double verification user
timeSpanNumOverLimit 0x60001044 Max. number of time buckets
reached
channelNumOverLimit 0x60001045 Max. number of channels
reached
noSearchIDResource 0x60001046 Insufficient searchID resources
noSupportDeleteStrangerLib 0x60001051 Deleting stranger library is not
supported
noSupportCreateStrangerLib 0x60001052 Creating stranger library is not
supported
behaviorAnalysisRuleInfoError 0x60001053 Behavior analysis rule
parameters error.

464
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


safetyHelmetParamError 0x60001054 Hard hat parameters error.
OneChannelOnlyCanBindOneE 0x60001077 No more engines can be
ngine bound.
engineTypeMismatch 0x60001079 Engine type mismatched.
badUpgradePackage 0x6000107A Invalid upgrade package.
AudioFileNameDuplicate 0x60001135 Duplicated audio file name.
CurrentAudioFileAIRuleInUseAl 0x60001136 The AI rule linkage related to
readyDelete current audio file has been
deleted.
TransitionUseEmmc 0x60002000 Starting device failed. The
EMMC is overused.
AdaptiveStreamNotEnabled 0x60002001 The stream self-​adaptive
function is not enabled.
AdaptiveStreamAndVariableBit 0x60002002 Stream self-​adptive and
rateEnabled variable bitrate function cannot
be enabled at the same time.
noSafetyHelmetRegion 0x60002023 The hard hat detection area is
not configured (if users save
their settings without
configuring the arming area,
they should be prompted to
configure one).
unclosedSafetyHelmet 0x60002024 The hard hat detection is
enabled (If users save their
settings after deleting the
arming area, they should be
prompted to disable hard hat
detection first and then delete
the arming area).
width/ 0x6000202C The width/height ratio of the
heightRatioOfPictureError uploaded picture should be in
the range from 1:2 to 2:1.
PTZNotInitialized 0x6000202E PTZ is not initialized.
PTZSelfChecking 0x6000202F PTZ is self-checking.
PTZLocked 0x60002030 PTZ is locked.

465
Intelligent Security API (Traffic) Developer Guide

Sub Status Code Error Code Description


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

StatusCode=7

SubStatusCode Error Code Description


rebootRequired 0x70000001 Reboot to take effect.

466

You might also like