HikCentral Professional OpenAPI

Developer Guide
 HikCentral Professional OpenAPI Developer Guide

Legal Information

About this Document

● This Document includes instructions for using and managing the Product. Pictures, charts,
images and all other information hereinafter are for description and explanation only. Unless
otherwise agreed, Hangzhou Hikvision Digital Technology Co., Ltd. or its affiliates (hereinafter
referred to as "Hikvision") makes no warranties, express or implied.
● Please use this Document with the guidance and assistance of professionals trained in
supporting the Product.

Acknowledgment of Intellectual Property Rights

● Hikvision owns the copyrights and/or patents related to the technology embodied in the
Products described in this Document, which may include licenses obtained from third parties.
● Any part of the Document, including text, pictures, graphics, etc., belongs to Hikvision. No part
of this Document may be excerpted, copied, translated, or modified in whole or in part by any
means without written permission.
● and other Hikvision's trademarks and logos are the properties of Hikvision in
various jurisdictions.
● Other trademarks and logos mentioned are the properties of their respective owners.

LEGAL DISCLAIMER
● TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THIS DOCUMENT AND THE
PRODUCT DESCRIBED, WITH ITS HARDWARE, SOFTWARE AND FIRMWARE, ARE PROVIDED "AS
IS" AND "WITH ALL FAULTS AND ERRORS". HIKVISION MAKES NO WARRANTIES, EXPRESS OR
IMPLIED, INCLUDING WITHOUT LIMITATION, MERCHANTABILITY, SATISFACTORY QUALITY, OR
FITNESS FOR A PARTICULAR PURPOSE. THE USE OF THE PRODUCT BY YOU IS AT YOUR OWN RISK.
IN NO EVENT WILL HIKVISION BE LIABLE TO YOU 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), PRODUCT LIABILITY, OR OTHERWISE, IN CONNECTION WITH THE USE OF THE
PRODUCT, EVEN IF HIKVISION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR
LOSS.
● YOU ACKNOWLEDGE THAT THE NATURE OF THE INTERNET PROVIDES FOR INHERENT SECURITY
RISKS, AND HIKVISION SHALL NOT TAKE ANY RESPONSIBILITIES FOR ABNORMAL OPERATION,
PRIVACY LEAKAGE OR OTHER DAMAGES RESULTING FROM CYBER-ATTACK, HACKER ATTACK,
VIRUS INFECTION, OR OTHER INTERNET SECURITY RISKS; HOWEVER, HIKVISION WILL PROVIDE
TIMELY TECHNICAL SUPPORT IF REQUIRED.
● YOU AGREE TO USE THIS PRODUCT IN COMPLIANCE WITH ALL APPLICABLE LAWS, AND YOU ARE
SOLELY RESPONSIBLE FOR ENSURING THAT YOUR USE CONFORMS TO THE APPLICABLE LAW.

i
 HikCentral Professional OpenAPI Developer Guide

ESPECIALLY, YOU ARE RESPONSIBLE, FOR USING THIS PRODUCT IN A MANNER THAT DOES NOT
INFRINGE ON THE RIGHTS OF THIRD PARTIES, INCLUDING WITHOUT LIMITATION, RIGHTS OF
PUBLICITY, INTELLECTUAL PROPERTY RIGHTS, OR DATA PROTECTION AND OTHER PRIVACY
RIGHTS. YOU SHALL NOT USE THIS PRODUCT FOR ANY PROHIBITED END-USES, INCLUDING THE
DEVELOPMENT OR PRODUCTION OF WEAPONS OF MASS DESTRUCTION, THE DEVELOPMENT OR
PRODUCTION OF CHEMICAL OR BIOLOGICAL WEAPONS, ANY ACTIVITIES IN THE CONTEXT
RELATED TO ANY NUCLEAR EXPLOSIVE OR UNSAFE NUCLEAR FUEL-CYCLE, OR IN SUPPORT OF
HUMAN RIGHTS ABUSES.
● IN THE EVENT OF ANY CONFLICTS BETWEEN THIS DOCUMENT AND THE APPLICABLE LAW, THE
LATTER PREVAILS.

© Hangzhou Hikvision Digital Technology Co., Ltd. All rights reserved.

ii
 HikCentral Professional OpenAPI Developer Guide

Contents
Chapter 1 Overview .................................................................................................................... 1
1.1 Introduction ........................................................................................................................... 1
1.2 System Requirements ............................................................................................................ 1
1.3 Open Capabilities ................................................................................................................... 1
1.4 Terms and Definitions ............................................................................................................ 2
1.5 Update History ....................................................................................................................... 3
Chapter 2 Getting Started ......................................................................................................... 11
2.1 Installation ........................................................................................................................... 11
2.2 Configuration ....................................................................................................................... 14
2.2.1 Authenticate Service Certificate ................................................................................. 14
2.2.2 Enable Open Platform ................................................................................................. 15
2.3 Run Open Platform .............................................................................................................. 16
Chapter 3 Protocol Summary .................................................................................................... 19
3.1 Request and Response Rule ................................................................................................. 19
3.1.1 Request ....................................................................................................................... 19
3.1.2 Response ..................................................................................................................... 20
3.2 Signature and Authentication .............................................................................................. 22
Chapter 4 Typical Applications .................................................................................................. 26
4.1 Common Application ........................................................................................................... 26
4.1.1 Capability Description ................................................................................................. 26
4.1.2 Programming Guide .................................................................................................... 26
4.2 Resource Management ........................................................................................................ 27
4.2.1 Capability Description ................................................................................................. 27
4.2.2 Programming Guide .................................................................................................... 28
4.2.3 Restrictions and Suggestions ...................................................................................... 44
4.3 Event and Alarm ................................................................................................................... 44

iii
 HikCentral Professional OpenAPI Developer Guide

4.3.1 Capability Description ................................................................................................. 44

4.3.2 Programming Guide .................................................................................................... 46
4.3.3 Restrictions and Suggestions ...................................................................................... 50
4.4 Video Application ................................................................................................................. 50
4.4.1 Capability Description ................................................................................................. 50
4.4.2 Programming Guide .................................................................................................... 51
4.4.3 Restrictions and Suggestions ...................................................................................... 63
4.5 Access Control ...................................................................................................................... 64
4.5.1 Capability Description ................................................................................................. 64
4.5.2 Programming Guide .................................................................................................... 64
4.5.3 Restrictions and Suggestions ...................................................................................... 67
4.6 Visitor Management ............................................................................................................ 68
4.6.1 Capability Description ................................................................................................. 68
4.6.2 Programming Guide .................................................................................................... 69
4.7 ANPR .................................................................................................................................... 72
4.7.1 Capability Description ................................................................................................. 72
4.7.2 Programming Guide .................................................................................................... 73
4.8 Parking Lot Application ........................................................................................................ 74
4.8.1 Capability Description ................................................................................................. 74
4.8.2 Programming Guide .................................................................................................... 74
4.9 On-Board Monitoring ........................................................................................................... 80
4.9.1 Capability Description ................................................................................................. 80
4.9.2 Programming Guide .................................................................................................... 80
4.10 Digital Signage .................................................................................................................... 83
4.10.1 Capability Description ............................................................................................... 83
4.10.2 Programming Guide .................................................................................................. 83
4.11 Intelligent Analysis ............................................................................................................. 84
4.11.1 Capability Description ............................................................................................... 84

iv
 HikCentral Professional OpenAPI Developer Guide

4.11.2 Programming Guide .................................................................................................. 85

Chapter 5 API Reference ........................................................................................................... 87
5.1 Common API ........................................................................................................................ 87
5.1.1 POST /artemis/api/common/v1/version ..................................................................... 87
5.2 Physical Resources API ......................................................................................................... 88
5.2.1 POST /artemis/api/resource/v1/acsDevice/acsDeviceList .......................................... 88
5.2.2 POST /artemis/api/resource/v1/acsDevice/indexCode/acsDeviceInfo ....................... 90
5.2.3 POST /artemis/api/resource/v1/acsDevice/advance/acsDeviceList ........................... 91
5.2.4 POST /artemis/api/resource/v1/encodeDevice/encodeDeviceList ............................. 93
5.2.5 POST /artemis/api/resource/v1/encodeDevice/indexCode/encodeDeviceInfo ......... 95
5.2.6 POST /artemis/api/resource/v1/encodeDevice/advance/encodeDeviceList .............. 97
5.2.7 POST artemis/api/resource/v1/device/indexCode/wakeUp ....................................... 99
5.2.8 POST /artemis/api/resource/v1/intelligentServer/intelligentServerList ................... 100
5.2.9 POST /artemis/api/resource/v1/mobileDevice/mobileDeviceList ............................ 102
5.2.10 POST /artemis/api/resource/v1/mobileDevice/indexCode/mobileDeviceInfo ...... 104
5.2.11 POST /artemis/api/resource/v1/mobileDevice/advance/mobileDeviceList ........... 105
5.2.12 POST /artemis/api/resource/v1/recordServer/recordServerList ............................ 107
5.2.13 POST /artemis/api/resource/v1/recordServer/indexCode/recordServerInfo ......... 109
5.2.14 POST /artemis/api/resource/v1/recordServer/recordStatus .................................. 111
5.2.15 POST /artemis/api/resource/v1/streamServer/streamServerList ........................... 114
5.2.16 POST /artemis/api/resource/v1/videoManagementServer .................................... 116
5.3 Logical Resources API ......................................................................................................... 117
5.3.1 Site Information ........................................................................................................ 117
5.3.2 Area Information ....................................................................................................... 122
5.3.3 Camera Information .................................................................................................. 130
5.3.4 Organization Information .......................................................................................... 140
5.3.5 Access Point Information .......................................................................................... 153
5.3.6 Vehicle Information ................................................................................................... 162

v
 HikCentral Professional OpenAPI Developer Guide

5.3.7 Vehicle Linked to On-Board Device ........................................................................... 181

5.3.8 Person Information ................................................................................................... 187
5.3.9 Face Comparison Group ............................................................................................ 218
5.3.10 Face Information ..................................................................................................... 231
5.3.11 Alarm Input/Output Information ............................................................................ 239
5.4 Video API ............................................................................................................................ 252
5.4.1 POST /artemis/api/aiapplication/v1/people/statisticsTotalNumByTime .................. 252
5.4.2 POST /artemis/api/aiapplication/v1/people/resourceGroupRealTimeCount ........... 255
5.4.3 POST /artemis/api/aiapplication/v1/people/advance/resourceGroupList ............... 256
5.4.4 POST /artemis/api/aiapplication/v1/people/statisticsHeatMapByTime ................... 258
5.4.5 POST /artemis/api/video/v1/cameras/playbackURLs ............................................... 261
5.4.6 POST /artemis/api/video/v1/cameras/previewURLs ................................................ 264
5.4.7 POST /artemis/api/video/v2/cameras/previewURLs ................................................ 266
5.4.8 POST /artemis/api/video/v1/cameras/talkURLs ....................................................... 268
5.4.9 POST /artemis/api/video/v1/device/talkURLs .......................................................... 270
5.4.10 POST /artemis/api/video/v1/patrols/addition ........................................................ 272
5.4.11 POST /artemis/api/video/v1/patrols/deletion ........................................................ 274
5.4.12 POST /artemis/api/video/v1/patrols/patrolIndex/patrolInfo ................................. 275
5.4.13 POST /artemis/api/video/v1/patrols/searches ....................................................... 276
5.4.14 POST /artemis/api/video/v1/presets/addition ....................................................... 278
5.4.15 POST /artemis/api/video/v1/presets/deletion ....................................................... 279
5.4.16 POST /artemis/api/video/v1/presets/searches ...................................................... 281
5.4.17 POST /artemis/api/video/v1/ptzs/controlling ......................................................... 282
5.4.18 POST /artemis/api/video/v1/camera/capture ........................................................ 285
5.4.19 POST /artemis/api/video/v1/download .................................................................. 286
5.4.20 POST /artemis/api/video/v1/downloadURL ........................................................... 288
5.4.21 POST /artemis/api/video/v1/event/searchLabels ................................................... 290
5.5 Alarm and Event API .......................................................................................................... 293

vi
 HikCentral Professional OpenAPI Developer Guide

5.5.1 POST /artemis/api/eventService/v1/eventRecords/controlling ................................ 293

5.5.2 POST /artemis/api/eventService/v1/eventRecords/page ......................................... 294
5.5.3 POST /artemis/api/eventService/v1/eventSubscriptionByEventTypes ..................... 298
5.5.4 POST /artemis/api/eventService/v1/eventSubscriptionView ................................... 300
5.5.5 POST /artemis/api/eventService/v1/eventUnSubscriptionByEventTypes ................ 301
5.5.6 POST /artemis/api/eventService/v1/generalEventRule/generalEventRuleList ......... 303
5.5.7 POST /artemis/api/eventService/v1/generalEventRule/single/add .......................... 305
5.5.8 POST /artemis/api/eventService/v1/generalEventRule/single/delete ...................... 306
5.5.9 POST /artemis/api/eventService/v1/generalEventRule/single/update .................... 308
5.5.10 POST /artemis/api/eventService/v1/generalEventRule/triggerAlarm .................... 309
5.5.11 POST /artemis/api/eventService/v1/image_data ................................................... 311
5.5.12 POST /artemis/api/eventService/v1/deviceApplicationEvent ................................ 313
5.6 Visitor API .......................................................................................................................... 315
5.6.1 POST /artemis/api/visitor/v1/appointment .............................................................. 315
5.6.2 POST /artemis/api/visitor/v1/appointment/update ................................................. 319
5.6.3 POST /artemis/api/visitor/v1/registerment .............................................................. 322
5.6.4 POST /artemis/api/visitor/v1/registerment/update ................................................. 325
5.6.5 POST /artemis/api/visitor/v2/appointment .............................................................. 328
5.6.6 POST /artemis/api/visitor/v1/appointment/single/delete ....................................... 333
5.6.7 POST /artemis/api/visitor/v2/appointment/update ................................................. 334
5.6.8 POST /artemis/api/visitor/v1/visitor/out .................................................................. 337
5.6.9 POST /artemis/api/visitor/v1/appointment/appointmentlist ................................... 339
5.6.10 POST /artemis/api/visitor/v1/appointment/downloadpicture ............................... 343
5.6.11 POST /artemis/api/visitor/v1/visitorconfig/customfields ....................................... 344
5.6.12 POST /artemis/api/visitor/v1/visitorgroups ............................................................ 346
5.6.13 POST /artemis/api/visitor/v1/visitorgroups/groupinfo ........................................... 348
5.6.14 POST /artemis/api/visitor/v1/visitor/visitorInfo ..................................................... 350
5.6.15 POST /artemis/api/visitor/v1/visitor/single/visitorinfo .......................................... 352

vii
 HikCentral Professional OpenAPI Developer Guide

5.6.16 POST /artemis/api/visitor/v1/auth/reapplication ................................................... 353

5.6.17 POST /artemis/api/visitor/v1/visitorapprovalflow/status ....................................... 354
5.6.18 POST /artemis/api/visitor/v1/visitorConfig/automaticApproval ............................ 356
5.7 Vehicle and Parking API ...................................................................................................... 357
5.7.1 POST /artemis/api/pms/v1/image ............................................................................ 357
5.7.2 POST /artemis/api/pms/v1/crossRecords/page ........................................................ 359
5.7.3 POST /artemis/api/vehicle/v1/parkinglot/list ........................................................... 361
5.7.4 POST /artemis/api/vehicle/v1/floor/list ................................................................... 363
5.7.5 POST /artemis/api/vehicle/v1/floor/overview ......................................................... 365
5.7.6 POST /artemis/api/vehicle/v1/floor/parkingspace/status ........................................ 368
5.7.7 POST /artemis/api/vehicle/v1/parkinglot/passageway/record ................................ 370
5.7.8 POST /artemis/api/vehicle/v1/parkingspace/record ................................................ 374
5.7.9 POST /artemis/api/vehicle/v1/parkingfee/calculate ................................................ 377
5.7.10 POST /artemis/api/vehicle/v1/parkingfee/confirm ................................................ 379
5.7.11 POST /artemis/api/vehicle/v1/vehicle/blocklist/add .............................................. 380
5.7.12 POST /artemis/api/vehicle/v1/vehicle/blocklist/get ............................................... 382
5.7.13 POST /artemis/api/vehicle/v1/vehicle/blocklist/modify ........................................ 384
5.7.14 POST /artemis/api/vehicle/v1/vehicle/blocklist/delete .......................................... 387
5.8 Access Control API ............................................................................................................. 388
5.8.1 POST /artemis/api/acs/v1/auth/applicationResult ................................................... 388
5.8.2 POST /artemis/api/acs/v1/door/doControl .............................................................. 390
5.8.3 POST /artemis/api/acs/v1/door/events .................................................................... 392
5.8.4 POST /artemis/api/acs/v1/event/pictures ................................................................ 395
5.8.5 POST /artemis/api/acs/v1/privilege/group ............................................................... 395
5.8.6 POST /artemis/api/acs/v1/privilege/group/single/addPersons ................................ 397
5.8.7 POST /artemis/api/acs/v1/privilege/group/single/deletePersons ............................ 399
5.8.8 POST /artemis/api/acs/v1/privilege/group/single/personList .................................. 401
5.8.9 POST /artemis/api/visitor/v1/auth/reapplication ..................................................... 403

viii
 HikCentral Professional OpenAPI Developer Guide

5.8.10 POST /artemis/api/visitor/v1/person/ID/elementDownloadDetail ........................ 404

5.9 On-Board Monitoring API .................................................................................................. 406
5.9.1 POST /artemis/api/mobilesurveillance/v1/gpsdetails .............................................. 406
5.9.2 POST /artemis/api/mobilesurveillance/v1/recordOverview ..................................... 409
5.9.3 POST /artemis/api/mobilesurveillance/v1/single/record ......................................... 412
5.9.4 POST /artemis/api/mobilesurveillance/v1/picture_download ................................. 415
5.10 Person Search API ............................................................................................................ 417
5.10.1 POST /artemis/api/body/v1/application/pictureRecognition ................................. 417
5.10.2 POST /artemis/api/body/v1/application/pictureModel ......................................... 419
5.10.3 POST /artemis/api/body/v1/application/captureSearch ........................................ 422
5.10.4 POST /artemis/api/frs/v1/application/pictureRecognitionModel .......................... 425
5.10.5 POST /artemis/api/frs/v1/application/captureSearch ............................................ 427
5.11 Digital Signage API ........................................................................................................... 431
5.11.1 POST /artemis/api/focsign/v1/material/dataSource/search .................................. 431
5.11.2 POST /artemis/api/focsign/v1/material/dataSource/update ................................. 432
5.11.3 POST /artemis/api/focsign/v1/material/dataSource/update/batch ....................... 434
Appendix A. Appendixes ......................................................................................................... 436
A.1 Object Description ............................................................................................................. 436
A.1.1 accessInfo ................................................................................................................. 436
A.1.2 AccessLevel ............................................................................................................... 436
A.1.3 AcsDevInfo ................................................................................................................ 436
A.1.4 AlarmInputInfo ......................................................................................................... 437
A.1.5 AlarmOutputInfo ...................................................................................................... 438
A.1.6 appendInfo ............................................................................................................... 439
A.1.7 ApplicationErrorResult .............................................................................................. 439
A.1.8 ApprovalFlowInfo ...................................................................................................... 439
A.1.9 BaseInfo .................................................................................................................... 440
A.1.10 bodyRect ................................................................................................................. 440

ix
 HikCentral Professional OpenAPI Developer Guide

A.1.11 bodyTargetInfo ........................................................................................................ 440

A.1.12 CameraInfo ............................................................................................................. 442
A.1.13 CameraRecordStatus .............................................................................................. 444
A.1.14 Card ........................................................................................................................ 445
A.1.15 CertificateStatus ..................................................................................................... 445
A.1.16 characterInfo .......................................................................................................... 446
A.1.17 CustomField ............................................................................................................ 446
A.1.18 dataSourceBatchUpdateList ................................................................................... 447
A.1.19 dataSourceData ...................................................................................................... 448
A.1.20 DeviceError ............................................................................................................. 448
A.1.21 DoorControlResult .................................................................................................. 449
A.1.22 DoorInfo .................................................................................................................. 449
A.1.23 ElementDetail ......................................................................................................... 450
A.1.24 ElementDetailBaseInfo ........................................................................................... 451
A.1.25 ElementStatus ......................................................................................................... 451
A.1.26 EncodeDevInfo ........................................................................................................ 451
A.1.27 ErrorcodeApprovalReviewInfo ................................................................................ 452
A.1.28 eventLabelList ......................................................................................................... 453
A.1.29 eventList ................................................................................................................. 453
A.1.30 EventPic .................................................................................................................. 454
A.1.31 EventRecord ............................................................................................................ 454
A.1.32 face ......................................................................................................................... 456
A.1.33 FaceGroupInfo ........................................................................................................ 456
A.1.34 FaceInfo .................................................................................................................. 456
A.1.35 facePic ..................................................................................................................... 457
A.1.36 FaceMatchRecord ................................................................................................... 457
A.1.37 faceTargetInfo ......................................................................................................... 459
A.1.38 faceTargets .............................................................................................................. 460

x
 HikCentral Professional OpenAPI Developer Guide

A.1.39 FingerPrint .............................................................................................................. 461

A.1.40 fingerPrintUpdateResult ......................................................................................... 462
A.1.41 FloorInfo ................................................................................................................. 462
A.1.42 FloorOverViewInfo .................................................................................................. 462
A.1.43 ForbiddenVehicleInfo .............................................................................................. 463
A.1.44 GeneralEventRule ................................................................................................... 464
A.1.45 gpsInfo .................................................................................................................... 465
A.1.46 HDDInfo .................................................................................................................. 466
A.1.47 IntelligentServerInfo ............................................................................................... 466
A.1.48 MobileDeviceInfo ................................................................................................... 466
A.1.49 MobilevehivleInfo ................................................................................................... 467
A.1.50 OrgInfo .................................................................................................................... 468
A.1.51 ParkingFeeCalculate ................................................................................................ 469
A.1.52 ParkingFeeConfirm ................................................................................................. 469
A.1.53 ParkingLotInfo ......................................................................................................... 470
A.1.54 ParkingRecordInfo .................................................................................................. 470
A.1.55 ParkingSpaceInfo .................................................................................................... 471
A.1.56 PassingRecordInfo ................................................................................................... 472
A.1.57 PassVehicleRecord .................................................................................................. 473
A.1.58 PatrolInfo ................................................................................................................ 474
A.1.59 PatrolPointInfo ........................................................................................................ 475
A.1.60 PeopleCountInfo ..................................................................................................... 476
A.1.61 PeopleCountingParam ............................................................................................ 476
A.1.62 PersonInfo ............................................................................................................... 476
A.1.63 PersonInOutEvents ................................................................................................. 478
A.1.64 PersonPhoto ........................................................................................................... 479
A.1.65 picInfo ..................................................................................................................... 480
A.1.66 PlaybackUrlVideoInfo ............................................................................................. 480

xi
 HikCentral Professional OpenAPI Developer Guide

A.1.67 PresetInfo ............................................................................................................... 481

A.1.68 PresetValue ............................................................................................................. 481
A.1.69 PrivilegeGroupInfo .................................................................................................. 482
A.1.70 ReaderInfo .............................................................................................................. 482
A.1.71 RealPeopleCountInfo .............................................................................................. 483
A.1.72 RecordOverview ..................................................................................................... 483
A.1.73 RelatedResourceInfo ............................................................................................... 485
A.1.74 RecordServerInfo .................................................................................................... 485
A.1.75 RegionInfo ............................................................................................................... 486
A.1.76 RelatedErrorInfo ..................................................................................................... 486
A.1.77 ResourceGroupInfo ................................................................................................. 487
A.1.78 SiteInfo .................................................................................................................... 487
A.1.79 SpaceTypeOverViewInfo ......................................................................................... 488
A.1.80 StatisticResult ......................................................................................................... 488
A.1.81 StreamServerInfo .................................................................................................... 489
A.1.82 SubscriptionInfo ...................................................................................................... 489
A.1.83 tableInfo ................................................................................................................. 490
A.1.84 TimeSchedule ......................................................................................................... 490
A.1.85 TimeZoneInfo .......................................................................................................... 491
A.1.86 UrlInfo ..................................................................................................................... 492
A.1.87 VehicleGroupInfo .................................................................................................... 492
A.1.88 VehicleInfo .............................................................................................................. 492
A.1.89 Version .................................................................................................................... 494
A.1.90 VideoInfo ................................................................................................................ 494
A.1.91 Visitor ..................................................................................................................... 495
A.1.92 VisitorappointInfo ................................................................................................... 495
A.1.93 VisitorInfo ............................................................................................................... 497
A.1.94 VisitorPhoto ............................................................................................................ 498

xii
 HikCentral Professional OpenAPI Developer Guide

A.1.95 watchListInfo .......................................................................................................... 499

A.2 Event Message Format ...................................................................................................... 499
A.2.1 Access Control Event Message ................................................................................. 502
A.2.2 ANPR Event Message ................................................................................................ 503
A.2.3 License Plate Matched or Mismatched Event Message ............................................ 503
A.2.4 Face Comparison Event Message ............................................................................. 503
A.2.5 On-Board Monitoring Event Message ...................................................................... 506
A.3 Data Dictionary .................................................................................................................. 509
A.4 Event Types or Alarm Categories ....................................................................................... 514
A.5 Status or Error Code .......................................................................................................... 523

xiii
 HikCentral Professional OpenAPI Developer Guide

Chapter 1 Overview

1.1 Introduction
HikCentral Professional is a platform that provides the open capabilities and APIs of video, alarm,
ANPR (Automatic Number Plate Recognition), and so on, for the third-party manufacturers or
developers to fast integrate different applications.

1.2 System Requirements

Operating System: Microsoft® Windows 7 SP1/8.1/10 (64-bit)

Note
The system requirements of Open Platform is same as that of HikCentral Professional.

1.3 Open Capabilities

The open capabilities of HikCentral Professional for application integration include resource
management, video application (streaming, PTZ control, intelligent recognition, etc.), event and
alarm (face comparison event, abnormal temperature alarm, no mask alarm, etc.), access control
application (permission management, access control, etc), visitor application (visitor reservation
and check-in/check-out), ANPR application, vehicle and parking management (parking lot
management, parking fee charging, and vehicle entry/exit), on-board monitoring application,
digital signage application, and intelligent analysis capability.

Figure 1-1 Open Capabilities Directory

1
 HikCentral Professional OpenAPI Developer Guide

1.4 Terms and Definitions

Term Description
OpenAPI The publicly available application programming interface that
provides developers with programmatic access to a proprietary
software application or web service.
HikCentral Professional A platform for security video management.
HTTP method A set of request methods defined by HTTP to indicate the
desired action to be performed for a given resource. The useful
methods include GET (get resources), PUT (set or update
resources), POST (add or search resources), and DELETE (delete
resources).
header The supplemental data at the beginning of a data block. For
example, "Accept:text/plain".
URL Uniform Resource Locator, which is colloquially termed a web
address, and is a reference to a web resource that specifies its
location on a computer network and a mechanism for retrieving
it.
query A precise request for information retrieval with database and
information systems.
appKey\appSecret A pair of appKey or appSecret is used to mark the caller, and the
appSecret is as a key for signature calculation.
AK Access Key, which relates with the private access key. They are
used in pair to encrypt the signature in the request.
SK Secret Access Key, which is used to mark the sender and prevent
the request from being modified during signature encryption.
SMS Stream Media Server, which supports RTSP and is used to
forward stream to up to 200 channels. It is also like a security
gateway in multi-​channel scene.
RTSP Real Time Streaming Protocol, which is a network control
protocol designed for use in entertainment and communications
systems to control streaming media servers. The protocol is used
for establishing and controlling media sessions between end
points. Clients of media servers issue VHS-style commands, such
as play, record and pause, to facilitate real-​time control of the

2
 HikCentral Professional OpenAPI Developer Guide

Term Description
media streaming from the server to a client (Video On Demand)
or from a client to the server (Voice Recording).
RTP Real-​time Transport Protocol, which is a network protocol for
delivering audio and video over IP networks.

1.5 Update History

Summary of Changes in Version 2.5.1_Jan., 2024

1. Extended the typical application Resource Management :
added an API calling flow of waking up device: Wake Up Device ;
extended the restrictions and suggestions for solar camera channel with reconnecting
mechanism: Restrictions and Suggestions ;
extended the response message for POST /artemis/api/resource/v1/encodeDevice/
encodeDeviceList ;
extended the response message for POST /artemis/api/resource/v1/encodeDevice/indexCode/
encodeDeviceInfo ;
extended the response message for POST /artemis/api/resource/v1/encodeDevice/advance/
encodeDeviceList ;
added an API for waking up solar device: POST artemis/api/resource/v1/device/indexCode/
wakeUp ;
extended the response message for POST /artemis/api/resource/v1/regions/
regionIndexCode/cameras ;
extended the response message for POST /artemis/api/resource/v1/cameras/indexCode ;
extended the response message for POST /artemis/api/resource/v1/cameras ;
extended the response message for POST /artemis/api/resource/v1/camera/advance/
cameraList ;
added two parameters isSupportWakeUp and wakeUpStatus for the structure CameraInfo and
EncodeDevInfo .
2. Extended Restrictions and Suggestions in the typical application Video Application :
extended the restrictions and suggestions for recording downloading API;
extended the restrictions and suggestions for recording playback API.
3. Extended Restrictions and Suggestions in the typical application Access Control :
extended the restrictions and suggestions for access level applying API and access level
searching API.
4. Modified the typical application Visitor Management :
added a step (API POST /artemis/api/visitor/v1/visitorConfig/automaticApproval for checking
whether auto review of visitor reservation is enabled or not) for Make a Reservation for Visitor
and Programming Guide ;

3
 HikCentral Professional OpenAPI Developer Guide

deleted a step (API POST /artemis/api/visitor/v1/auth/reapplication for applying visitor's

access level settings to devices) for Check In Visitor and Programming Guide .
5. Added a step for Get Real-Time Occupancy of the Parking Spaces :
added an API for downloading vehicle pictures: POST /artemis/api/pms/v1/image (originally
POST /artemis/api/pms/v1/image_data).
6. Extended the typical application On-Board Monitoring :
added Resource Management and Video Application in Programming Guide .
7. Added the description for supporting streaming from cameras on remote sites or not for the
following video application APIs:
POST /artemis/api/video/v1/cameras/previewURLs ;
POST /artemis/api/video/v2/cameras/previewURLs ;
POST /artemis/api/video/v1/cameras/playbackURLs :
POST /artemis/api/video/v1/cameras/talkURLs ;
POST /artemis/api/video/v1/device/talkURLs .
8. Added a restriction for POST /artemis/api/video/v1/download :
the recording to be downloaded should be shorter than one minute.
9. Added ANPR as a supported module for POST /artemis/api/eventService/v1/
eventSubscriptionByEventTypes .
10. Extended the following vehicle resource APIs:
extended the request message for POST /artemis/api/resource/v1/vehicle/vehicleList ;
extended the request message for POST /artemis/api/resource/v1/vehicle/indexCode/
vehicleInfo ;
extended the request message for POST /artemis/api/resource/v1/vehicle/advance/
vehicleList ;
added 2 optional request parameters plateCategory and plateArea, and extended the request
and response message for POST /artemis/api/resource/v1/vehicle/single/add ;
added 2 optional request parameters plateCategory and plateArea, and extended the request
and response message for POST /artemis/api/resource/v1/vehicle/single/update ;
added 3 optional parameters plateCategory, plateArea, and plateAreaName for VehicleInfo .
11. Added a parameter doorOutState:
extended the response message for POST /artemis/api/resource/v1/acsDoor/region/
acsDoorList ;
extended the response message for POST /artemis/api/resource/v1/acsDoor/indexCode/
acsDoorInfo ;
extended the response message for POST /artemis/api/resource/v1/acsDoor/acsDoorList ;
extended the response message for POST /artemis/api/resource/v1/acsDoor/advance/
acsDoorList ;
extended the structure DoorInfo .
12. Extended the request message for POST /artemis/api/resource/v1/person/single/add and
POST /artemis/api/resource/v1/person/single/update :
added a request parameter residentRoomNo.
13. Extended the response message for POST /artemis/api/visitor/v2/appointment :

4
 HikCentral Professional OpenAPI Developer Guide

added an optional request parameter watchListInfo (and the corresponding structure

watchListInfo ).
14. Extended the API description for person search APIs:
POST /artemis/api/body/v1/application/pictureRecognition ;
POST /artemis/api/body/v1/application/pictureModel ;
POST /artemis/api/body/v1/application/captureSearch ;
POST /artemis/api/frs/v1/application/pictureRecognitionModel ;
POST /artemis/api/frs/v1/application/captureSearch .
15. Extended the request message for POST /artemis/api/acs/v1/door/doControl :
added a required request parameter controlDirection (door control direction).
16. Added an optional request parameter appendInfo (and the corresponding structure
appendInfo ) and extended the request message for the following APIs:
POST /artemis/api/resource/v1/person/personList ;
POST /artemis/api/resource/v1/person/personId/personInfo ;
POST /artemis/api/resource/v1/person/personCode/personInfo ;
POST /artemis/api/resource/v1/person/advance/personList .
17. Added description of personId and personCode for the following APIs, structures, and event
message:
POST /artemis/api/resource/v1/person/personCode/personInfo ;
POST /artemis/api/resource/v1/person/single/add ;
POST /artemis/api/resource/v1/person/single/update ;
PersonInfo ;
FaceMatchRecord ;
Access Control Event Message .

Summary of Changes in Version 2.5_Oct., 2023

1. Adjusted the structure of the chapters of Open Capabilities and Typical Applications :
Divided the capabilities and applications by service module; added typical applications for more
services.
2. Added an API for approving or rejecting submitted visitor reservation: POST /artemis/api/
visitor/v1/visitorapprovalflow/status .
3. Added an API for downloading pictures and videos from on-board monitoring event search or
notification pushing: POST /artemis/api/mobilesurveillance/v1/picture_download .
4. Extended the request message for POST /artemis/api/visitor/v1/auth/reapplication :
added 3 optional parameters ImmediateDownload, personIds, and doorIndexCodes.
5. Extended the request message for POST /artemis/api/frs/v1/application/picture :
extended the parameter isHumanSearchPic and added an optional parameter
encodeDeviceCode.
6. Extended the request and response message for POST /artemis/api/visitor/v1/appointment
and POST /artemis/api/visitor/v1/registerment :
Added a required request parameter watchListInfo ( watchListInfo ) and an optional response
parameter qrCodeImage.

5
 HikCentral Professional OpenAPI Developer Guide

7. Extended the request message for POST /artemis/api/visitor/v1/appointment/update and

POST /artemis/api/visitor/v1/registerment/update :
Extended the request parameter visitorInfoList ( VisitorInfo ), added an object description
accessInfo accordingly.
8. Extended the request and response message for POST /artemis/api/visitor/v2/appointment :
Added 2 optional request parameter accessInfo ( accessInfo ) and watchListInfo
( watchListInfo ), and an optional response parameter qrCodeImage.
9. Extended the request message for POST /artemis/api/visitor/v2/appointment/update :
Added an optional request parameter accessInfo ( accessInfo ).
10. Extended the response message for POST /artemis/api/visitor/v1/appointment/
appointmentlist :
Extended the response parameter list ( VisitorappointInfo ), added an object description
accessInfo accordingly.
11. For POST /artemis/api/video/v1/cameras/playbackURLs :
added more API descriptions;
extended the request message: added 2 optional parameters mergeSegment and
storageLocation;
for the response parameter data, extended parameters in PlaybackUrlVideoInfo and
VideoInfo accordingly.
12. Extended the request message for POST /artemis/api/body/v1/application/
pictureRecognition , POST /artemis/api/body/v1/application/pictureModel , POST /
artemis/api/body/v1/application/captureSearch , POST /artemis/api/frs/v1/application/
pictureRecognitionModel , and POST /artemis/api/frs/v1/application/captureSearch :
added a required parameter protocolType and an optional parameter
encodeDeviceIndexCode.

Summary of Changes in Version 2.4.1_Mar., 2023

1. Corrected the values of the request parameter bRecordSetting for:
POST /artemis/api/resource/v1/camera/advance/cameraList ;
POST /artemis/api/resource/v1/cameras ;
POST /artemis/api/resource/v1/regions/regionIndexCode/cameras .
2. Corrected the values of the request parameter type for:
POST /artemis/api/acs/v1/auth/applicationResult .

Summary of Changes in Version 2.4_Jan., 2023

1. Changed "mobile monitoring" and "mobile device" to "on-board monitoring" and "on-board
device".
2. Added APIs for getting the video and audio stream:
Download recordings by obtained playback URL and returned information: POST /artemis/api/
video/v1/download ;
Get the download progress and download URL: POST /artemis/api/video/v1/downloadURL .
3. Added APIs for searching for person:

6
 HikCentral Professional OpenAPI Developer Guide

Detect and model faces in the picture: POST /artemis/api/frs/v1/application/

pictureRecognitionModel ;
Get matched faces by face picture comparison: POST /artemis/api/frs/v1/application/
captureSearch ;
Detect human body and get the human body coordinates: POST /artemis/api/body/v1/
application/pictureRecognition
Get the human body modeling data according to the coordinates: POST /artemis/api/body/v1/
application/pictureModel ;
Get matched human bodies by body picture comparison and get the target picture information:
POST /artemis/api/body/v1/application/captureSearch .
4. Added APIs for managing digital signage:
Search for data source: POST /artemis/api/focsign/v1/material/dataSource/search ;
Update the data source: POST /artemis/api/focsign/v1/material/dataSource/update ;
Batch update the data source: POST /artemis/api/focsign/v1/material/dataSource/update/
batch .
5. Person information APIs:
Added an API for adding a custom field: POST /artemis/api/resource/v1/person/customFields/
single/add ;
Added an API for editing the custom field information: POST /artemis/api/resource/v1/person/
customFields/single/modify ;
Added an API for deleting a custom field: POST /artemis/api/resource/v1/person/
customFields/single/delete .
Added 2 parameters isPublic and isShow for CustomField .
6. Access control APIs:
Added an API for getting the access level application information of a visitor: POST /
artemis/api/visitor/v1/person/ID/elementDownloadDetail
7. Video APIs:
Extended and edited the description and note for POST /artemis/api/video/v1/cameras/
playbackURLs .
Added an API for capturing real-time pictures via camera: POST /artemis/api/video/v1/
camera/capture .
Added an API for getting the tags of the person/vehicle-detected videos: POST /artemis/api/
video/v1/event/searchLabels .
8. Alarm and Event APIs:
Extended the description and note, and added a request parameter passBackfor POST /
artemis/api/eventService/v1/eventSubscriptionByEventTypes .
Added a response parameter passBack for POST /artemis/api/eventService/v1/
eventSubscriptionView .
Added an API for searching for AIOP and HEOP event lists by condition: POST /artemis/api/
eventService/v1/deviceApplicationEvent .
9. Added a request parameter isHumanSearchPic for POST /artemis/api/frs/v1/application/
picture .

7
 HikCentral Professional OpenAPI Developer Guide

10. Added a parameter timeZone for AcsDevInfo , EncodeDevInfo and MobileDeviceInfo : added
an object description TimeZoneInfo accordingly.
11. Added a parameter vehicleDirectionType for PassVehicleRecord .
12. Added AIOP event and HEOP event to camera alarms.

Summary of Changes in Version 2.3.1_Oct., 2022

Extended the request message for POST /artemis/api/resource/v1/camera/advance/cameraList ,
POST /artemis/api/resource/v1/cameras , and POST /artemis/api/resource/v1/regions/
regionIndexCode/cameras : added a parameter bRecordSetting (whether to get the recording
settings).
Summary of Changes in Version 2.3_Jun., 2022
1. Extended the description for searching for specified organization information by condition
( POST /artemis/api/resource/v1/org/advance/orgList ).
2. Extended the request and response message for adding a vehicle ( POST /artemis/api/
resource/v1/vehicle/single/add ) and editing information of a vehicle( POST /artemis/api/
resource/v1/vehicle/single/update ):
added 2 parameters: effectiveDate (start time of vehicle validity) and expiredDate (vehicle
expiry date).
3. Extended the description of the request parameter "visitEndTime" (related API: POST /
artemis/api/visitor/v1/appointment , POST /artemis/api/visitor/v1/appointment/update ,
POST /artemis/api/visitor/v1/registerment , and POST /artemis/api/visitor/v1/registerment/
update ).
Extended the response message for checking in a visitor ( POST /artemis/api/visitor/v1/
registerment ):
added a response parameter qrCodeImage (QR code image).
4. Added APIs for getting the video and audio stream:
Batch get streaming URLs for live view: POST /artemis/api/video/v2/cameras/previewURLs ;
Get streaming URL of two-way audio for the device: POST /artemis/api/video/v1/device/
talkURLs .
Added a parameter protocol for getting streaming URL of two-way audio for the camera
( POST /artemis/api/video/v1/cameras/talkURLs ).
Extended the API description and request parameter protocol:
Get the streaming URL for live view: POST /artemis/api/video/v1/cameras/previewURLs .
Get the streaming URL for playback: POST /artemis/api/video/v1/cameras/playbackURLs .
5. Added an API for getting the heat map information of a specific camera ( POST /artemis/api/
aiapplication/v1/people/statisticsHeatMapByTime ).
6. Added a typical application for managing mobile monitoring (search for driving event records,
search for GPS statistics, receive events of vehicles linked to mobile devices, and get people
counting statistics of vehicle linked to mobile device).
7. Added APIs for managing vehicle parking:

8
 HikCentral Professional OpenAPI Developer Guide

- Calculate the vehicle parking fee (related API: POST /artemis/api/vehicle/v1/parkingfee/

calculate ).
- Confirm the payment of parking fee and allow exit (related API: POST /artemis/api/
vehicle/v1/parkingfee/confirm ).
- Manage vehicle information in the blocklist (related API: POST /artemis/api/vehicle/v1/
vehicle/blocklist/add , POST /artemis/api/vehicle/v1/vehicle/blocklist/delete , POST /
artemis/api/vehicle/v1/vehicle/blocklist/modify and POST /artemis/api/vehicle/v1/
vehicle/blocklist/get ).
8. Modified the data type of the parameter speed:
Search for event information of a mobile device: POST /artemis/api/mobilesurveillance/v1/
single/record .
RecordOverview Object Description: RecordOverview .
Modified the data type of the parameter longitude, latitude, direction, and speed for gpsInfo
object description ( gpsInfo ).
Modified the data type of the parameter longitude, latitude, and speed for mobile event
message ( On-Board Monitoring Event Message ).
9. Extended the parameter devResourceType (device resource type) by adding a value
"mobileDevice" (related object descriptions: CameraInfo , AlarmInputInfo , and
AlarmOutputInfo .
10. Extended the stream protocol by adding a value "websocket_s" ( Video Type ).
Extended the parameter "ability" (event category) by adding a value "event_ms" ( Event
Message Format ).
Added 2 resource codes "mobileDevice" and "mobileVehicle" ( Resource Types / Resource
Permission Code ).

Summary of Changes in Version 2.2.1_Mar., 2022

1. Added APIs for getting mobile device information:
Get the mobile device list in page: POST /artemis/api/resource/v1/mobileDevice/
mobileDeviceList ;
Get the information of a mobile device by device ID: POST /artemis/api/resource/v1/
mobileDevice/indexCode/mobileDeviceInfo ;
Search the mobile device list: POST /artemis/api/resource/v1/mobileDevice/advance/
mobileDeviceList .
2. Extended the request and response message for getting the camera list of a specified area by
area ID ( POST /artemis/api/resource/v1/regions/regionIndexCode/cameras ), getting the
information of a specified camera by camera ID ( POST /artemis/api/resource/v1/cameras/
indexCode ), getting the information list of all cameras ( POST /artemis/api/resource/v1/
cameras ), and setting search conditions to search the specified cameras ( POST /artemis/api/
resource/v1/camera/advance/cameraList ):
added 2 parameters: deviceType (device type) and devIndexCode (mobile device ID).
3. Extended the request and response message for getting the alarm input information list
( POST /artemis/api/resource/v1/alarmInputs ), setting search condition to search for the
alarm input information ( POST /artemis/api/resource/v1/alarmInput/advance/

9
 HikCentral Professional OpenAPI Developer Guide

alarmInputList ), getting the alarm output information list ( POST /artemis/api/resource/v1/

alarmOutputs ), and setting search condition to search for the alarm output information
( POST /artemis/api/resource/v1/alarmOutput/advance/alarmOutputList ):
added a parameter deviceType (device type).
4. Added APIs for managing information of vehicles linked to mobile devices:
Get the list of vehicles linked to mobile devices: POST /artemis/api/resource/v1/
mobilevehicle/mobilevehicleList ;
Get the information of a vehicle linked to the mobile device: POST /artemis/api/resource/v1/
mobileVehicle/indexCode/mobileVehicleInfo ;
Search the list of vehicles linked to mobile devices: POST /artemis/api/resource/v1/
mobilevehicle/advanced/mobilevehicleList .
5. Added APIs for managing mobile monitoring:
Get GPS statistics information of mobile devices: POST /artemis/api/mobilesurveillance/v1/
gpsdetails ;
Search for event information of a mobile device: POST /artemis/api/mobilesurveillance/v1/
single/record ;
Search for event records of vehicles linked to mobile devices: POST /artemis/api/
mobilesurveillance/v1/recordOverview .
6. Added the mobile event message ( On-Board Monitoring Event Message ).

10
 HikCentral Professional OpenAPI Developer Guide

Chapter 2 Getting Started

2.1 Installation
The Open Platform can be installed with the HikCentral Professional in a same computer or server
(i.e., centralized mode) or in different computers or servers (i.e., distributed mode).
Before You Start
● Make sure you have prepared the proper system environment and installed the HikCentral

Professional.

Note
The compatible versions include version 2.0/2.1/2.2 of HikCentral Professional and version
1.0/1.1 of HikCentral Professional Access Control.
● Make sure you have enabled the License of Third-Party Integration function, see details in the
figure below.

11
HikCentral Professional OpenAPI Developer Guide

Figure 2-1 Enable License of Third-Party Integration

12
 HikCentral Professional OpenAPI Developer Guide

Steps
1. Run the executable program HikCentral Professional_OpenAPI.exe as an administrator to enter
the welcome panel of the InstallShield Wizard.
2. Click Next to start the InstallShield Wizard.
3. Read the License Agreement.
- Click I accept the terms of the license agreement and continue.
- Click I do not accept the terms of the license agreement to cancel the installation.
4. Click Next.
5. Perform one of the following operations according to the centralized or distributed installation
mode.

Note
If the event or alarm uploading frequency is larger than 100 times per second, you should adopt
the distributed installation mode.
- For centralized installation mode, click Next to continue.

Note
The default directory C:\Program Files (x86)\HikCentral Professional\VSM Servers\OpenAPI is
used.
- For distributed installation mode, click Change... and select a proper directory as desired to
install the Open Platform.
6. Click Next to continue.
7. Read the pre-install information, and click Install to begin the installation.
A panel indicating progress of the installation displays.
8. Read the post-install information and click Finish to complete the installation.
Four services, i.e., OpenAPI Translation Service, artemis, artemis-web, and artemis-portal, are
generated. And the following documents and software development kits will appear under the
installation directory.

Folder Name File Description

Document HikCentral Professional OpenAPI Provide the RESTful APIs for
Developer Guide integrating different functions.
WebSDK HCVideoSDKWebControl Provide the APIs, introductions, and
HikCentral Professional Video sample codes for developing a video
WebSDK Developer Guide player on the web browser.
Demos
C++SDK HCVideoSDK Provide the APIs using C++ language,
HikCentral Professional Video SDK (C introductions, and sample codes for
++) Developer Guide playing video and audio.

13
 HikCentral Professional OpenAPI Developer Guide

Folder Name File Description

HCVideoSDKDemo
C#SDK HikCentral Professional Video SDK Provide the APIs using C# language,
(C#) Demo User Manual introductions, and sample codes for
C#HCSDKDemo playing video and audio.
C++HttpUtillib HttpUtillib DLL Encapsulate the POST methods of
HikCentral Professional OpenAPI HTTP/HTTPS and provide a unified
Security Authentication Library (C++) access of OpenAPI to communicate
Developer Guide with gateway based on HTTP.
HttpUtillib Demo
jsDecoder jsDecoder SDK Provide a no plug-in solution to play
HikCentral Professional Video video via web browser.
jsDecoder SDK Developer Guide
jsDecoder SDK Demo and User
Manual

2.2 Configuration
After installing the services of Open Platform, some configurations should be done to make it
running normally. Especially for the distributed installation mode, the service certificate must be
authenticated. And also, switching the integration mode of HikCentral Professional and enabling
the Open Platform are required.

2.2.1 Authenticate Service Certificate

If the installation of Open Platform services and HikCentral Professional services adopts the
distributed mode, before using the services, the security certificate must be authenticated.
Steps
1. Log in to the HikCentral Professional via the Web Client, refer to HikCentral Professional Web
Client User Manual for details.
2. Select → System Configuration → Security → Service Component Certificate .

14
 HikCentral Professional OpenAPI Developer Guide

Figure 2-2 View Service Certificate

3. View and get the service certificate information in the Certificate between Services in System
field.
4. Run the Service Manager as an administrator.
5. Click Security Certificate to open Enter Certificate Information dialog.
6. Enter the obtained service certificate information in the dialog.
7. Click OK.

2.2.2 Enable Open Platform

By default, the Open Platform is disabled. So before the integration, you must enable it in the
HikCentral Professional Web Client.
Steps
1. Log in to the HikCentral Professional via the Web Client, refer to HikCentral Professional Web
Client User Manual for details.
2. Select → System Configuration → Third-Party Integration → Open API .
3. Switch Open API to on.

15
 HikCentral Professional OpenAPI Developer Guide

Figure 2-3 Enable Open Platform Page

4. Enter the IP address of Open Platform and the management port No.

Note
The default management port No. is 8208.
5. Check the checkbox to select a partner user.
6. Click Save.

2.3 Run Open Platform

After installing the services and configuring the Open Platform, you can run it and create a partner
for further integration.
Steps
1. In the address bar of the web browser, enter the address of https://IPaddress/artemis-web and
press Enter key.

16
 HikCentral Professional OpenAPI Developer Guide

Figure 2-4 Open Platform Login Page

2. Click log in tab to switch to login page.
3. Enter user name and password.

Note
The user names of Open Platform and HikCentral Professional are independent, the default user
name of Open Platform is "admin", and the initial password is "admin@123". For the first time
login, you must change the password.
4. Click log in to log in to the Open Platform.
5. Create a partner.
1) Click Partner Management at the left panel.
2) Click Create a partner to enter Create Partner panel.

Figure 2-5 Create Partner Page

3) Enter the partner name and description.
4) Optional: Add extension fields to the partner.

17
 HikCentral Professional OpenAPI Developer Guide

Note
If the domains of the third-party platform and HikCentral Professional are different, you
should an extension field to set the domain information.
5) Click Create to save the added partner information.
The created partner displays on the Partner Management panel. Click on the partner name to
view the details, including APPkey and APPsecret, which are for authentication and marking
the encrypted request.
6) Select a partner and click Authentication in the operating column of the selected partner
item.

Figure 2-6 Assign Permission to Partner Page

7) Select permission(s) to be assigned.
8) Click to assign the selected permissions to the partner.
6. Optional: Perform the request URL test.
1) Click API List at the left panel of Open Platform.
2) Select URL and click Online Debug at the right panel to enter debug page.

Note
The third-party partner should enter the debug page via the web site https://IPaddress/
artemis-portal.
3) Enter the request URL, request parameters, and authentication information (the APPkey and
APPsecret are returned after creating partner) to start the test.
If the request URL is available, the corresponding response message will be returned.

18
 HikCentral Professional OpenAPI Developer Guide

Chapter 3 Protocol Summary

3.1 Request and Response Rule

3.1.1 Request
The request for executing a task contains HTTP method, request URL, and request message.

HTTP Method
The POST method is used to execute different tasks in this manual.
Request URL
The format of request URL is defined as "<protocol>://<serverAddress>[:serverPort][absolutePath?
[query]]". For example, https://10.26.31.41:443/artemis/api/example?
qa=value1&qb=value2&qc=value3.
protocol
Required, protocol type, here in this manual, it always be "https".
serverAddress
Required, domain name or IP address of the platform, i.e., "10.26.31.41" in the above URL
example.
serverPort
Optional, web access port No. of the platform, i.e., "403" in the above URL example. If this field is
not configured, it will use the default port No.
absolutePath
Required, the absolute path of resources for identifying, and it is a part of URI (Uniform Resource
Identifier), i.e., "/artemis/api/example" in the above URL example.
query
Optional, parameters for describing the resource, and it is the other part of URI (Uniform
Resource Identifier), i.e., "qa", "qb", and "qc" in the above URL example.

Note
The URI is a uniform resource identifier for distinguishing different resource types, which consists
of absolutePath and query, i.e., "/artemis/api/example?qa=value1&qb=value2&qc=value3" in the
above URL example. Sometime, the URI will replace the URL to simplify the description.

19
 HikCentral Professional OpenAPI Developer Guide

Request Message
The request message is in JSON format and encoded by UTF-8 rule. It consists of multiple input
parameters, and the parameters are named by camel case.

3.1.2 Response
The response returned after calling API contains response message and status or error code.

Response Message
The response message is in JSON format and encoded by UTF-8 rule. It consists of multiple output
parameters, and the parameters are named by camel case, refer to the parameter description
below.

Parameter Required/ Data Type Description

Optional
code Required String Returned status or error code: 0-succeeded,
other codes-failed (refer to Status or Error Code
for details); its maximum length is 32 bits.
msg Required String Status or error description, which is in one-to-
one correspondence with the code, refer to
Status or Error Code for details.
data Required / The data details vary in different request URLs.

Status or Error Code

The status or error code will be returned in the response message. If succeeded, the status code is
"0"; and if failed, the error codes vary in different error types, refer to Status or Error Code for
details.
Example
Response of Calling Succeeded
{
"code": "0",
"msg": "Success",
"data": {
"streamURL":"rtsp://10.2.145.66:655/EUrl/CLJ52BW"
}
}

Example
Response of Calling Failed

20
 HikCentral Professional OpenAPI Developer Guide

{
"code": "0x02401006",
"msg": "Token Exception.",
"data":""
}

Example
Response of Single Data Item
{
"code":"0",
"msg":"xxxxxx",
"data":{
"userId": xxxxxx,
"name": "xxxxxx",
…
}
}

Example
Response of Paged Batch Data
{
"code":"0",
"msg":"xxxxxx",
"data":{
"total":5,
"pageSize":20,
"pageNo": 1,
"list": [{
"userId": xxxxxx,
"name": "xxxxxx",
…
},
{
"userId": xxxxxx,
"name": "xxxxxx",
…
}]
}
}

Example
Response of Batch Data without Paging
{
"code":"0",
"msg":"xxxxxx",
"data":{
"total":5,
"list": [{
"userId": xxxxxx,

21
 HikCentral Professional OpenAPI Developer Guide

"name": "xxxxxx",
…
},
{
"userId": xxxxxx,
"name": "xxxxxx",
…
}]
}
}

3.2 Signature and Authentication

The APIs in this document use AK/SK digest authentication, the AK/SK is generated by the gateway.

Signature String
The signature string before calculating consists of HTTP method, headers, and URI, which is defined
as below.
HTTP METHOD "\n"
Accept "\n"
Content-MD5 "\n"
Content-Type "\n"
Date "\n"
Headers
Uri
HTTP METHOD
The HTTP method must be upper-case, e.g., "POST".
Accept
Setting Accept header is suggested. As for some HTTP clients, if Accept is not configured, the
default value: */* will automatically be assigned to it, which may cause the failure of signature
verification.
Content-MD5
The Content-MD5 is the value of digest calculated by MD5 algorithm in the request body and
processed by BASE64 algorithm, and the body must be on non-form format. E.g., String content-
MD5=Base64.encodeBase64(MD5(bodyStream.getbytes("UTF-8"))).
Content-Type
Content format, such as "text/plain", "text/xml", and "text/json".
Date
Signature date and time.
Headers

22
 HikCentral Professional OpenAPI Developer Guide

The headers consists of X-Ca-Key, X-Ca-Signature, X-Ca-Signature-Headers, X-Ca-Timestamp, X-Ca-

Nonce, and other custom headers. A value will be assigned to each header, the format is
"header:value\n", in which, the header should be in lower-case and there is no space at front and
behind of the value, also, it should end with "\n". For headers in a list, they should be sorted
alphabetically.
X-Ca-Key
Required, appKey or appSecret for authentication and it should be obtained by contacting our
technical supports.
Make sure the appKey or appSecret is properly kept. Otherwise, please reset it and get a new
one.
X-Ca-Signature
Required, signature string.
X-Ca-Signature-Headers
Required, a lower-case name string of headers that will be calculated in the signature. The
names in the string will be sorted alphabetically and each two names are separated by
comma. E.g., x-ca-signature-headers:x-ca-key,x-ca-timestamp.

Note
The following headers will not be calculated in the signature: X-Ca-Signature, X-Ca-Signature-
Headers, Accept, Content-MD5, Content-Type, Date, Content-Length, Server, Connection, Host,
Transfer-Encoding, X-Application-Context, and Content-Encoding.
X-Ca-Timestamp
Optional, time stamp of calling API, the value equals to the number of milliseconds calculated
from 00:00:00 on 1st., Jan., 1970 to the current time. E.g., x-ca-timstamp:1550153182830.
X-Ca-Nonce
Optional, UUID generated when calling API, which is used with the time stamp for anti-replay.
Uri
Uniform resource identifier, which consists of resource absolute path and query parameters, e.g.,
"/artemis/api/example?qa=value1&qb=value2&qc", or "/artemis/api/example".

Note
Each header should end with "\n", but if the Accept, Content-MD5, Content-Type, or Date header
does not exist, "\n" is not required.

The following shows the example of signature string before calculating.

POST \n
*/* \n
dGhpcyBpcyBhIGV4YW1wbGU= \n
text/plain;charset=UTF-8 \n
Thu, 24 Nov 2016 03:12:25 GMT \n

23
 HikCentral Professional OpenAPI Developer Guide

a-header:value \n
b-header:value \n
x-ca-key:1231243298 \n
x-ca-timestamp:1479956865000 \n
/artemis/api/example?a-bodyform=value&a-query=value&b-query=value

Signature Calculation
1. Calculate the signature string by HmacSHA256 algorithm with the appKey or appSecret to
generate message digest.
2. Calculate the message digest by BASE64 algorithm to generate the signature.

Note
During the signature calculation, the encoding format is UTF-8.

The following shows the JAVA sample code of signature calculation:

Mac hmacSha256 = Mac.getInstance("HmacSHA256");
byte[] keyBytes = secret.getBytes("UTF-8");
hmacSha256.init(new SecretKeySpec(keyBytes, 0, keyBytes.length, "HmacSHA256"));
String sign = new String(Base64.encodeBase64(Sha256.doFinal(stringToSign.getBytes("UTF-8")),"UTF-8"));

Signature Transfer and Authentication

The signature must be transmitted in the request header, see details in the sample code below.
/*request URL*/
http://www.example.com/artemis/api/example?qa=a&qb=B
/*HTTP method*/
POST
/*headers*/
Accept:*/*
Accept-Encoding:gzip, deflate, sdch
Accept-Language:en-US,en;q=0.8
Connection:keep-alive
Content-Length:0
Content-Type:text/plain;charset=UTF-8
Cookie:JSESSIONID=D9C4A515CACAC31211D1612039D062B7
header-A:A
header-B:b
X-Ca-Key:29666671
X-Ca-Signature:XeBEg2Ifh+FOfeProHLMYz8luWkJ00Exx7N7tJuats8=
X-Ca-Signature-Headers:header-a,header-b,x-ca-key,x-ca-timestamp
X-Ca-Timestamp:1479968678000
X-Requested-With:XMLHttpRequest
/*query parameters*/
qa:a
qb:B
/*signature string*/
POST\n
*/*\n
text/plain;charset=UTF-8\n

24
 HikCentral Professional OpenAPI Developer Guide

header-a:A\n
header-b:b\n
x-ca-key:29666671\n
x-ca-timestamp:1479968678000\n
/artemis/api/example?a-body=a&qa=a&qb=B&x-body=x
/*signature information*/
XeBEg2Ifh+FOfeProHLMYz8luWkJ00Exx7N7tJuats8=

Example
Sample Flow of Signature and Authentication

Figure 3-1 Calculate Signature and Authenticate

25
 HikCentral Professional OpenAPI Developer Guide

Chapter 4 Typical Applications

4.1 Common Application

4.1.1 Capability Description

Get general information or general applications (e.g., platform service information), which might
be related to multiple service applications.

4.1.2 Programming Guide

Figure 4-1 API Calling Flow of Getting Platform Service Information

● Call POST /artemis/api/common/v1/version to get version information of platform.
● Call POST /artemis/api/resource/v1/videoManagementServer to get the information of the
System Management Server (e.g., IP address, port No., CPU usage, and network status).

26
 HikCentral Professional OpenAPI Developer Guide

4.2 Resource Management

4.2.1 Capability Description

Resource management includes APIs for full sychronization and search by condition of devices and
servers (encoding device, access control device, recording server, Intelligent Analysis Server,
streaming server, and on-board device), sites, areas, cameras, alarm inputs/outputs, access points,
person information, and license plate information. These basic APIs are also used for further
applications of other services. By calling these APIs, you can get the resource point indexCode,
which can be used in APIs for other operations on the resource point, e.g., the obtained camera
indexCode can be used in the API of video streaming to get the camera streaming URL.

Figure 4-2 Resource Management Capability Directory

27
 HikCentral Professional OpenAPI Developer Guide

4.2.2 Programming Guide

Manage Physical Resources

The physical resource management provides the management capability of physical devices and
servers added to the HikCentral Professional platform.

Figure 4-3 API Calling Flow of Getting Information of Physical Resource

1. Call the API of getting the list of a physical resource (POST /artemis/api/resource/v1/
<DeviceType>/<DeviceTypeList>) or the API of searching for the list of a physical resource by
condition (POST /artemis/api/resource/v1/<DeviceType>/advance/<DeviceTypeList>) to get the
physical resource list.
2. Call the API of getting information of a single resource (POST /artemis/api/resource/v1/
<DeviceType>/indexCode/<DeviceTypeInfo>) to get information of a single resource.
The APIs of getting physical resource information are displayed by resource type as follows:

28
 HikCentral Professional OpenAPI Developer Guide

Table 4-1 Encoding Device

Function API
Get encoding device list POST /artemis/api/resource/v1/encodeDevice/
encodeDeviceList
Search for encoding devices by POST /artemis/api/resource/v1/encodeDevice/advance/
condition encodeDeviceList
Get an encoding device's POST /artemis/api/resource/v1/encodeDevice/indexCode/
information encodeDeviceInfo

Table 4-2 Access Control Device

Function API
Get access control device list POST /artemis/api/resource/v1/acsDevice/acsDeviceList
Search for access control POST /artemis/api/resource/v1/acsDevice/advance/
devices by condition acsDeviceList
Get an access control device's POST /artemis/api/resource/v1/acsDevice/indexCode/
information acsDeviceInfo

Table 4-3 Intelligent Analysis Server

Function API
Get DeepinMind Server list POST /artemis/api/resource/v1/intelligentServer/
intelligentServerList

Table 4-4 Streaming Server

Function API
Get Streaming Server list POST /artemis/api/resource/v1/streamServer/
streamServerList

29
 HikCentral Professional OpenAPI Developer Guide

Table 4-5 Recording Server

Function API
Get Recording Server list POST /artemis/api/resource/v1/recordServer/recordServerList
Get storage status of cameras POST /artemis/api/resource/v1/recordServer/recordStatus
linked to a specific Recording
Server
Get information of a Recording POST /artemis/api/resource/v1/recordServer/indexCode/
Server recordServerInfo

Table 4-6 On-Board Device

Function API
Get the on-board device list in POST /artemis/api/resource/v1/mobileDevice/
page mobileDeviceList
Get the information of an on- POST /artemis/api/resource/v1/mobileDevice/indexCode/
board device by device ID mobileDeviceInfo
Search the on-board device list POST /artemis/api/resource/v1/mobileDevice/advance/
mobileDeviceList

Manage Logical Resources

The logical resource management provides the management capability of logical resources
including the information of sites, areas, cameras, access points, alarm inputs/outputs, etc.,
meeting the needs of multi-end (web, PC, and mobile phone) development.

30
 HikCentral Professional OpenAPI Developer Guide

Figure 4-4 API Calling Flow of Getting Information of Logical Resource

1. According to the site information, call POST /artemis/api/resource/v1/regions or POST /
artemis/api/resource/v1/regions/subRegions to get the area list and sub area list. Call POST /
artemis/api/resource/v1/region/indexCode/regionInfo to get the information of a single area.
2. Call the API of getting resource list, searching for resource list by condition, or getting the list of
all resources in an area; call POST api/resource/v1/<resourceType>/indexCode to get the
information of a single resource.
3. The obtained information can be displayed on the developed page/client/app, or used for other
service development.

31
 HikCentral Professional OpenAPI Developer Guide

Note
For RSM scenario, call POST /artemis/api/resource/v1/site/siteList , or POST /artemis/api/
resource/v1/site/advance/siteList to get the site list; call POST /artemis/api/resource/v1/site/
indexCode/siteInfo to get the information of a single site.

Table 4-7 Site

Function API
Get site list POST /artemis/api/resource/v1/site/siteList
Get a site's information POST /artemis/api/resource/v1/site/indexCode/siteInfo
Search for sites by condition POST /artemis/api/resource/v1/site/advance/siteList

Table 4-8 Area

Function API
Get area list of a parent area by POST /artemis/api/resource/v1/regions/subRegions
area No.
Get an area's information by POST /artemis/api/resource/v1/region/indexCode/regionInfo
area No.
Search for areas by condition POST /artemis/api/resource/v1/regions

Table 4-9 Camera

Function API
Get camera list of an area by POST /artemis/api/resource/v1/regions/regionIndexCode/
area No. cameras
Get a camera's information by POST /artemis/api/resource/v1/cameras/indexCode
camera ID
Get cameras' information in POST /artemis/api/resource/v1/cameras
page
Search for cameras by POST /artemis/api/resource/v1/camera/advance/cameraList
condition

32
 HikCentral Professional OpenAPI Developer Guide

Table 4-10 Alarm Input/Output

Function Description
Get alarm input information POST /artemis/api/resource/v1/alarmInputs/indexCode
according to alarm input ID
Get all the alarm input POST /artemis/api/resource/v1/alarmInputs
information
Search for alarm input POST /artemis/api/resource/v1/alarmInput/advance/
information alarmInputList
Get alarm output information POST /artemis/api/resource/v1/alarmOutputs/indexCode
according to alarm output ID
Get all the alarm output POST /artemis/api/resource/v1/alarmOutputs
information
Search for alarm output POST /artemis/api/resource/v1/alarmOutput/advance/
information alarmOutputList
Control alarm output POST /artemis/api/resource/v1/alarmOutput/controlling

Table 4-11 Access Point and Card Reader

Function API
Get access point list of an area POST /artemis/api/resource/v1/acsDoor/region/acsDoorList
by area No.
Get an access point's POST /artemis/api/resource/v1/acsDoor/indexCode/
information acsDoorInfo
Get access points' information POST /artemis/api/resource/v1/acsDoor/acsDoorList
in page
Search for access points by POST /artemis/api/resource/v1/acsDoor/advance/acsDoorList
condition
Get card reader information POST /artemis/api/resource/v1/reader/search

33
 HikCentral Professional OpenAPI Developer Guide

Table 4-12 Vehicle Linked to On-Board Device

Function Description
Get the list of vehicles linked to POST /artemis/api/resource/v1/mobilevehicle/
on-board devices mobilevehicleList
Get the information of a POST /artemis/api/resource/v1/mobileVehicle/indexCode/
vehicle linked to the on-board mobileVehicleInfo
device
Search the list of vehicles POST /artemis/api/resource/v1/mobilevehicle/advanced/
linked to on-board devices mobilevehicleList

Table 4-13 Face Comparison Group

Function Description
Get information list of face POST /artemis/api/frs/v1/face/groupList
comparison groups
Search for face comparison POST /artemis/api/frs/v1/face/group
groups
Add a face comparison group POST /artemis/api/frs/v1/face/group/single/addition
Edit information of a face POST /artemis/api/frs/v1/face/group/single/update
comparison group
Delete a face comparison POST /artemis/api/frs/v1/face/group/batch/deletion
group
Apply face comparison group POST /artemis/api/frs/v1/plan/recognition/black/restart
to device
Search for the face comparison POST /artemis/api/aiapplication/v1/face/faceMatchRecord
information by camera

Table 4-14 Face

Function Description
Add a face's information POST /artemis/api/frs/v1/face/single/addition
Delete a face's information POST /artemis/api/frs/v1/face/deletion
Search for face information in POST /artemis/api/frs/v1/face
face comparison group
Download face picture via URL POST /artemis/api/frs/v1/application/picture

34
 HikCentral Professional OpenAPI Developer Guide

Table 4-15 Visitor

Function Description
Add a visitor's reservation POST /artemis/api/visitor/v1/appointment
record
Add a visitor's reservation POST /artemis/api/visitor/v2/appointment
record (v2)
Edit a visitor's reservation POST /artemis/api/visitor/v1/appointment/update
record
Edit a visitor's reservation POST /artemis/api/visitor/v2/appointment/update
record (v2)
Delete a visitor's reservation POST /artemis/api/visitor/v1/appointment/single/delete
record
Get the list of the reservation POST /artemis/api/visitor/v1/appointment/appointmentlist
records
Get the picture of a visitor POST /artemis/api/visitor/v1/appointment/downloadpicture
Add a visitor's information for POST /artemis/api/visitor/v1/registerment
checking in
Edit a visitor's information for POST /artemis/api/visitor/v1/registerment/update
checking in
Revoke visitor's access level POST /artemis/api/visitor/v1/visitor/out
after the visitor checks out
Verify the validity of face POST /artemis/api/acs/v1/faceCheck
picture
Search for the custom POST /artemis/api/visitor/v1/visitorconfig/customfields
information about visitors
Search for the information POST /artemis/api/visitor/v1/visitorgroups
about visitor groups by group
name
Search for visitors' information POST /artemis/api/visitor/v1/visitorgroups/groupinfo
by visitor group ID
Get the visitor's information by POST /artemis/api/visitor/v1/visitor/visitorInfo
condition
Get the information about a POST /artemis/api/visitor/v1/visitor/single/visitorinfo
single visitor

35
 HikCentral Professional OpenAPI Developer Guide

Control Alarm Output

Call the alarm output control API to control the alarm output control status, meeting the needs of
on-site control including barrier gate control, sounder control, etc.

Figure 4-5 API Calling Flow of Controling Alarm Output

1. Call the relevant APIs from Table 4-10 to get the alarm output information.
2. If manual control is required (determined by the monitoring system integrated by web or
control client) or relevant events or alarms are triggered in the deployed environment, call
POST /artemis/api/resource/v1/alarmOutput/controlling to control the on/off status of alarm
output (remotely opening barrier gate, sounder output alarms, etc.).

Manage Persons
The person management includes the organization management, person's basic information
management, face picture management, fingerprint management, custom information
management, etc.

36
HikCentral Professional OpenAPI Developer Guide

Figure 4-6 API Calling Flow of Managing Persons

37
 HikCentral Professional OpenAPI Developer Guide

Organization Management

Function Description
Get root organization POST /artemis/api/resource/v1/org/rootOrg
information
Get information list of lower- POST /artemis/api/resource/v1/org/parentOrgIndexCode/
level organizations by parent subOrgList
organization
Get information of an POST /artemis/api/resource/v1/org/orgIndexCode/orgInfo
organization
Get information list of all POST /artemis/api/resource/v1/org/orgList
organizations
Search for organizations by POST /artemis/api/resource/v1/org/advance/orgList
condition
Add an organization POST /artemis/api/resource/v1/org/single/add
Edit an organization's POST /artemis/api/resource/v1/org/single/update
information
Delete an organization POST /artemis/api/resource/v1/org/single/delete
1. Call POST /artemis/api/resource/v1/org/single/add to add an organization.
2. Call POST /artemis/api/resource/v1/org/rootOrg to get the root organization information.
3. Call POST /artemis/api/resource/v1/org/parentOrgIndexCode/subOrgList to get information
list of lower-level organizations by parent organization; call POST /artemis/api/
resource/v1/org/orgList to get information list of all organizations; call POST /artemis/api/
resource/v1/org/advance/orgList to search for organizations by condition.
With the organization ID, call POST /artemis/api/resource/v1/org/orgIndexCode/orgInfo to get
information of a single organization.
4. (Optional) Call POST /artemis/api/resource/v1/org/single/delete / POST /artemis/api/
resource/v1/org/single/update to delete/edit organization information.

Person Management

Function API
Get persons' information POST /artemis/api/resource/v1/person/personList
Get a person's information by POST /artemis/api/resource/v1/person/personId/personInfo
person ID
Search for persons by condition POST /artemis/api/resource/v1/person/advance/personList

38
 HikCentral Professional OpenAPI Developer Guide

Function API
Get person picture POST /artemis/api/resource/v1/person/picture_data
Add a person POST /artemis/api/resource/v1/person/single/add
Edit a person's information POST /artemis/api/resource/v1/person/single/update
Delete a person POST /artemis/api/resource/v1/person/single/delete
Edit information of face linked POST /artemis/api/resource/v1/person/face/update
with person
Edit information of fingerprint POST /artemis/api/resource/v1/person/fingerPrints/update
linked with person
Get person information POST /artemis/api/resource/v1/person/personCode/
according to person ID personInfo
Verify the validity of face POST /artemis/api/acs/v1/faceCheck
picture
Get the person's custom POST /artemis/api/resource/v1/person/customFields
information
Update the person's custom POST /artemis/api/resource/v1/person/personId/
information customFieldsUpdate
Add a custom field POST /artemis/api/resource/v1/person/customFields/
single/add
Delete a custom field POST /artemis/api/resource/v1/person/customFields/single/
delete
Edit the custom field POST /artemis/api/resource/v1/person/customFields/single/
modify
1. Call POST /artemis/api/resource/v1/person/single/add to add persons to the organization.
2. Call POST /artemis/api/resource/v1/person/personList or POST /artemis/api/resource/v1/
person/advance/personList to get the person information list.
3. Call POST /artemis/api/resource/v1/person/picture_data to get the person's face picture.
4. Call POST /artemis/api/resource/v1/person/personId/personInfo to get the person details by
person ID, or call POST /artemis/api/resource/v1/person/personCode/personInfo to get the
person details by person No.
5. (Optional) Delete/edit persons as needed. Call POST /artemis/api/resource/v1/person/single/
delete or POST /artemis/api/resource/v1/person/single/update to delete/edit persons
information (person No., name, gender, employee No., organization, phone No., email, face
picture, fingerprint, card, validity).

39
 HikCentral Professional OpenAPI Developer Guide

6. (Optional) Edit face picture as needed. Call POST /artemis/api/acs/v1/faceCheck to verify the
face picture data, and then call POST /artemis/api/resource/v1/person/face/update to update
the face picture information.
7. (Optional) Edit fingerprint information as needed. Call POST /artemis/api/resource/v1/person/
fingerPrints/update to update the fingerprint information.
8. (Optional) Edit custom information as needed. Call POST /artemis/api/resource/v1/person/
personId/customFieldsUpdate to update the custom attributes of a specific person.
9. Call POST /artemis/api/resource/v1/person/customFields to get the list of custom fields, and
call POST /artemis/api/resource/v1/person/customFields/single/add , POST /artemis/api/
resource/v1/person/customFields/single/delete , or POST /artemis/api/resource/v1/person/
customFields/single/modify to add, delete, or edit the custom field for attribute management.

Manage Vehicles
The vehicle management includes managing vehicle lists and blocklists, for parking lot service
configuration.

40
HikCentral Professional OpenAPI Developer Guide

Figure 4-7 API Calling Flow of Managing Vehicles

41
 HikCentral Professional OpenAPI Developer Guide

Vehicle List Management

Function API
Add a vehicle list POST /artemis/api/resource/v1/vehicleGroup/single/add
Delete a vehicle list POST /artemis/api/resource/v1/vehicleGroup/single/delete
Edit a vehicle list's information POST /artemis/api/resource/v1/vehicleGroup/single/update
Get the list of vehicle lists POST /artemis/api/resource/v1/vehicleGroup/vehicleGroupList
1. Call POST /artemis/api/resource/v1/vehicleGroup/single/add to add a vehicle list.
2. (Optional) Call POST /artemis/api/resource/v1/vehicleGroup/single/delete or POST /
artemis/api/resource/v1/vehicleGroup/single/update to delete or edit the vehicle list.
3. Call POST /artemis/api/resource/v1/vehicleGroup/vehicleGroupList to get the list of vehicle
lists.

Vehicle Management

Function API
Add a vehicle POST /artemis/api/resource/v1/vehicle/single/add
Delete a vehicle POST /artemis/api/resource/v1/vehicle/single/delete
Edit a vehicle's information POST /artemis/api/resource/v1/vehicle/single/update
Get the list of all vehicles. POST /artemis/api/resource/v1/vehicle/vehicleList
Search for vehicles by condition POST /artemis/api/resource/v1/vehicle/advance/vehicleList
Get a vehicle's information by POST /artemis/api/resource/v1/vehicle/indexCode/vehicleInfo
vehicle ID
1. Call POST /artemis/api/resource/v1/vehicle/single/add to add a vehicle to the vehicle list.
2. (Optional) Call POST /artemis/api/resource/v1/vehicle/single/delete or POST /artemis/api/
resource/v1/vehicle/single/update to delete or edit the vehicle.
3. Call POST /artemis/api/resource/v1/vehicle/vehicleList to get the list of all vehicles; call POST /
artemis/api/resource/v1/vehicle/advance/vehicleList to search for vehicles by condition; call
POST /artemis/api/resource/v1/vehicle/indexCode/vehicleInfo to get information of a specific
vehicle.

42
 HikCentral Professional OpenAPI Developer Guide

Vehicle Blocklist Management

Function API
Add a vehicle blocklist POST /artemis/api/vehicle/v1/vehicle/blocklist/add
Delete a vehicle blocklist POST /artemis/api/vehicle/v1/vehicle/blocklist/delete
Edit a vehicle blocklist's POST /artemis/api/vehicle/v1/vehicle/blocklist/modify
information
Get the vehicle blocklist POST /artemis/api/vehicle/v1/vehicle/blocklist/get
1. Call POST /artemis/api/vehicle/v1/vehicle/blocklist/add to add a vehicle blocklist.
2. (Optional) Call POST /artemis/api/vehicle/v1/vehicle/blocklist/delete or POST /artemis/api/
vehicle/v1/vehicle/blocklist/modify to delete or edit the vehicle blocklist.
3. Call POST /artemis/api/vehicle/v1/vehicle/blocklist/get to get the vehicle blocklist.

Wake Up Device
Wake up solar devices.

Figure 4-8 API Calling Flow of Waking Up Device

43
 HikCentral Professional OpenAPI Developer Guide

1. Call Table 4-1 APIs and Table 4-9 APIs to get the information of encoding device and camera.
2. Check if the device supports the wakeup function according to isSupportWakeUp from the
obtained device information.
3. Check if the device is in sleep mode according to wakeUpStatus from the obtained device
information.
4. If the device supports wakeup function and is in sleep mode, call POST artemis/api/
resource/v1/device/indexCode/wakeUp to wake it up.

4.2.3 Restrictions and Suggestions

1. When getting the resource list, set the number of records per page as large as possible (max.
500) to avoid API calling frequency for higher search efficiency; it is recommended to pull the
data once and store it in the third-party platform instead of frequently pulling the data if there
is no change on devices (adding, editing, or deleting).
2. If getting the recording settings is not required for APIs of getting camera lists, you can set
bRecordSetting to 0 for faster search.
3. On the third party client, if it is a solar camera channel with reconnecting mechanism, the
reconnecting mechanism should be disabled first. Users will be prompted to manually click to
wake up device and start live view, so that the solar camera streaming is not repeatedly
triggered during auto-switch and the camera can go to sleep as scheduled.

4.3 Event and Alarm

4.3.1 Capability Description

Event is a signal that resource (e.g., camera, device, server) sends when something occurs, while
alarm is used to notify security personnel of the particular situation which helps handle the
situation promptly. To receive alarm or event information, you should first subscribe to event types
or alarm categories. When the subscribed type or category of event occurs or alarm is triggered,
the platform or service will automatically upload the related information to the caller for
processing or acknowledgment.
Capabilities provided:
1. Event subscription: You can subscribe to events by event type or cancel the subscription as
needed.
2. Real-time event push: Callback addresses in both HTTP and HTTPS format are supported.
3. Event and alarm search / picture download: You can search for event and alarm records, and
download relevant pictures.
4. Generic event rule and alarm configuration.

44
HikCentral Professional OpenAPI Developer Guide

Figure 4-9 Event and Alarm Capability Directory

45
 HikCentral Professional OpenAPI Developer Guide

4.3.2 Programming Guide

Subscribe to and Push Events

Steps

Figure 4-10 API Calling Flow of Subscribing to and Pushing Events

1. Enable HTTP or HTTPS service for receiving events.
2. Optional: Call POST /artemis/api/eventService/v1/deviceApplicationEvent to search for the list
of AIOP event types when AIOP alarm subscription is needed.
3. Call POST /artemis/api/eventService/v1/eventSubscriptionByEventTypes to set event type or
alarm category to subscribe.

46
 HikCentral Professional OpenAPI Developer Guide

Note
Multiple event types or alarm categories are available for subscription, refer to Event Types or
Alarm Categories for details.
4. Call POST /artemis/api/eventService/v1/eventSubscriptionView to search for the subscribed
events.
5. When events are triggered, call back the HTTP or HTTPS event receiving API. The third-party can
correspond according to the event/alarm types or resources from the callback message, e.g.,
triggering the camera capture, triggering the sounder alarm, controling alarm output, or saving
the record.
6. Optional: Call POST /artemis/api/eventService/v1/eventRecords/controlling to acknowledge
the alarm.

Note
The alarm or event receiving and alarm acknowledgment must be in different threads.
7. Call POST /artemis/api/eventService/v1/eventUnSubscriptionByEventTypes to specify the
event types or alarm categories to cancel subscribing.

Note
Subscribed events will be re-subscribed if OpenAPI service exception occurs or the service is
rebooted; events that failed to be pushed will be pushed again until it is successful, for every 24
hours.

Search for Events and Get Picture

You can search for the received alarms or events by some specific search conditions, such as event
type, event source type, and start or end time. If there are pictures contained in the search results,
you can get the picture URLs to download the pictures.
Before You Start
Make sure you have subscribed and received the alarms or events.

47
 HikCentral Professional OpenAPI Developer Guide

Steps

Figure 4-11 API Calling Flow of Searching for Events and Getting Pictures
1. Get related resources information, including cameras, encoding device, and access points, refer
to Resource Management for details.
2. Call one of the following APIs to search for the corresponding records.
- Call POST /artemis/api/eventService/v1/eventRecords/page to search for alarm records.
- Call POST /artemis/api/pms/v1/crossRecords/page to search for ANPR records.
- Call POST /artemis/api/acs/v1/door/events to search for card swiping records.
- Call POST /artemis/api/mobilesurveillance/v1/recordOverview to search for on-board
monitoring records.
- Call POST /artemis/api/aiapplication/v1/face/faceMatchRecord to search for face picture
comparison records.

48
 HikCentral Professional OpenAPI Developer Guide

3. Get the picture URL from the searched events and call one of the following APIs to download the
corresponding picture.
- Call POST /artemis/api/eventService/v1/image_data to download the alarm picture
according to the obtained picture URL.
- Call POST /artemis/api/pms/v1/image to download the vehicle passing picture according to
the obtained picture URL.
- Call POST /artemis/api/acs/v1/event/pictures to download the access control event picture
according to the obtained picture URL.
- Call POST /artemis/api/mobilesurveillance/v1/picture_download to download the on-board
monitoring event picture according to the obtained picture URL.
- Call POST /artemis/api/frs/v1/application/picture to download the face picture according to
the obtained picture URL.

Configure Generic Event Rules

Generic event is the signal that resource (e.g., other software, device) sends when something
occurs, and can be received in the form of TCP or UDP data packages, where the system can
analyze and generate events if they match configured expression. You can customize the
expression to create a generic event to analyze the received TCP and/or UDP data packages, and
trigger events when specified conditions are met. In this way, you can easily integrate your system
with a very wide range of external sources, such as access control systems and alarm systems.
Steps

Figure 4-12 API Calling Flow of Configuring Generic Event

1. Call POST /artemis/api/eventService/v1/generalEventRule/single/add to customize the
expression to add a generic event.

49
 HikCentral Professional OpenAPI Developer Guide

2. Call POST /artemis/api/eventService/v1/generalEventRule/generalEventRuleList to get all

configured generic events.
3. Optional: Call the following API(s) after adding a generic event.
Edit a generic event POST /artemis/api/eventService/v1/generalEventRule/single/
update
Delete a generic event POST /artemis/api/eventService/v1/generalEventRule/single/
delete
4. Call POST /artemis/api/eventService/v1/generalEventRule/triggerAlarm to enable receiving
generic events.
5. Optional: When event is triggered, receive the generic event information on the Control Client.

4.3.3 Restrictions and Suggestions

1. It is recommended to call the APIs of event receiving asynchronously and only use them for
receiving events; for processing events, it is recommended to perform it asynchronously.
2. The status code 200 should be returned after event receiving, or the openAPI platform will
consider the event push failed.

4.4 Video Application

4.4.1 Capability Description

The video application and development includes video monitoring, video analysis, and other
extension applications based on videos.
Capabilities provided:
1. Video streaming: Live view, playback, two-way audio, and video download.
2. PTZ Control: 3D operations (rotate camera, move focus, adjust focal length (zoom in/out),
enlarge/reduce iris), jumping to preset, and starting patrol.
3. Intelligent Recognition: Search for matched faces / human bodies.
4. Picture capture by camera.
5. Person/Vehicle Tag Search: Get the tags of the person/vehicle-detected videos recorded by
cameras.

50
 HikCentral Professional OpenAPI Developer Guide

Figure 4-13 Video Capability Directory

4.4.2 Programming Guide

Video Streaming
You can get the video and audio stream, and download playback videos via standard RTSP, but
cannot play the video or audio on the OpenAPI platform. Therefore, you must develop a player for
live view, playback, and two-way audio in the Windows operating system, via the one of the
following methods:
● APIs provided by C++ or C# language SDK via RTSP.

● Video plug-in developed on the web browser via RTSP.

● Non-plug-in solution of JsDecoder via WebSocket and WebSocket_S.

● Integration by standard open-source players via RTSP_S, RTMP or HLS protocols.

This developer guide compares the first 3 development methods on aspects including instructions
for use, application scenarios, technical requirements, supported development language and
operating system, etc. between the web client and control client, so that the caller can select an
appropriate one as needed.

51
 HikCentral Professional OpenAPI Developer Guide

Figure 4-14 Video Streaming

Note
The C++ or C# language SDK, web plug-in, and JsDecoder only supports Windows operating system.
And the SDK can implement the functions of live view, playback, PTZ control, capturing, stream
callback, and so on, while the web plug-in and JsDecoder only provide live view and playback
functions. Refer to the HikCentral Professional Video SDK (C++) Developer Guide, HikCentral
Professional Video SDK (C#) Demo User Manual, HikCentral Professional Video WebSDK Developer
Guide, and HikCentral Professional Video JsDecoder SDK_Developer Guide for details.

Develop via C++/C# SDK

Development via SDK (i.e., a full set of C++ and C# SDK APIs provided) realizes functions including
live view, playback, PTZ control, picture capture, stream data callback, etc., and is only supported in
the Windows operating system. For specific functions, refer to HikCentral Professional Video SDK (C
++) Developer Guide and HikCentral Professional Video SDK (C#) Demo User Manual.

Example Application Scenarios

1. To reduce the limitations of video playing control (e.g., lack of functions, unfriendly UI)., you can
call the APIs to develop the display window.
2. The original video stream is required for other services (displaying on video wall, intelligent
analysis, etc.).

52
HikCentral Professional OpenAPI Developer Guide

Figure 4-15 API Calling Flow of Developing via C++/C# SDK

53
 HikCentral Professional OpenAPI Developer Guide

1. Call POST /artemis/api/resource/v1/camera/advance/cameraList , POST /artemis/api/

resource/v1/cameras , POST /artemis/api/resource/v1/cameras/indexCode , and POST /
artemis/api/resource/v1/regions/regionIndexCode/cameras to get the camera information
and recording settings.
2. Call POST /artemis/api/video/v1/cameras/playbackURLs to get the playback URL and
recording time; call POST /artemis/api/video/v1/cameras/previewURLs or POST /artemis/api/
video/v2/cameras/previewURLs to get the live view URL; call POST /artemis/api/video/v1/
cameras/talkURLs or POST /artemis/api/video/v1/device/talkURLs to get the two-way audio
URL.
3. Introduce C++ and C# SDK, and call the corresponding APIs of SDK to complete the secondary
development. The development documents of SDK are provided separately.

Note
1. Cameras resource information should be recorded and live view / playback should be
configured on the platform, as the relevant APIs are not available for now.
2. Development language: C++ and C#; operating system: Microsoft Windows server 2008 or
above.

Develop via Web Plug-In

Developing via the web video plug-in (VideoWebPlugin) is applicable for web video application
development across browsers, which provides functions including live view, playback, etc. After
HCVideoSDKWebControl.exe is installed, HCVideoSDKWebControlService.exe will be run by the
system automatically and interact with jsWebControl-1.0.0.min.js, to realize various video
functions.

Running Environment
32/64-bit Windows 7: 32-bit IE 10 (compatible with 64-bit IE 10; 32-bit IE 10 will be started by
default in 64-bit IE 10 environment), 32/64-bit IE 11, 32/64-bit Chrome 45.0 or above, 32/64-bit
Firefox 52.0 or above.
32/64-Bit Windows 10: 32/64-bit IE 11, 32/64-bit Chrome 45.0 or above, 32/64-bit Firefox 51.0 or
above.

54
 HikCentral Professional OpenAPI Developer Guide

Figure 4-16 API Calling Flow of Developing via Web Plug-In

Install the plug-in package HCVideoSDKWebControl.exe to the directory Program Files
\HCVideoSDKWebControl (install directly, extracting or runing extracted executable file not
recommended).

Note
1. Generally, calling JS_DestroyWnd to destroy a plug-in window is not needed, since the window
can be destroyed internally by JS_Disconnect. In some cases, however, calling this interface is
needed. For example, when a browser needs to enable and disable playing video at any time,
you can call JS_DestroyWnd to destroy the plug-in window and disable playing, and call
JS_CreateWnd to enable playing video. JS_DestroyWnd and JS_Disconnect will deinitialize the
plug-in, thus calling JS_RequestInterface/uninit for deinitializing is not needed.
2. Touchscreen Windows operating system is not fully tested, thus not recommended.
3. Currently div tags must be used cooperatively. The iframe or browser pop-up methods are not
supported.

Develop via Non-Plug-In JsDecoder

Running Environment
32/64-Bit Windows 7/8/10: 32/64-bit Chrome 45.0 or above, 32/64-bit Firefox 52.0 or above.
The API calling flow for download solution of non-plug-in is shown below:

55
 HikCentral Professional OpenAPI Developer Guide

Note
See details of the live view / playback and two-way audio solutions in HikCentral Professional Video
JsDecoder SDK_Developer Guide.

Figure 4-17 API Calling Flow of Developing via Non-Plug-In JsDecoder

1. Call POST /artemis/api/resource/v1/camera/advance/cameraList , POST /artemis/api/
resource/v1/cameras , POST /artemis/api/resource/v1/cameras/indexCode , and POST /
artemis/api/resource/v1/regions/regionIndexCode/cameras to get the camera information
and recording settings.
2. Call POST /artemis/api/video/v1/cameras/playbackURLs to get the playback URL and
recording time.

56
 HikCentral Professional OpenAPI Developer Guide

3. Call POST /artemis/api/video/v1/download to start download and get the download ID.
4. According to the returned download ID, call POST /artemis/api/video/v1/downloadURL to get
the download progress and URL of the downloaded file when the download is completed.
5. Get the downloaded file by the returned URL via web browser.

PTZ Control
After adding cameras and starting live view in HikCentral Professional, you can call the APIs
provided here to control PTZ, manage presets and patrols.
Steps

Figure 4-18 API Calling Flow of PTZ Control

57
 HikCentral Professional OpenAPI Developer Guide

1. Call POST /artemis/api/video/v1/cameras/previewURLs to get the live view image.

2. Call POST /artemis/api/video/v1/presets/searches to search for the preset list; call POST /
artemis/api/video/v1/patrols/searches to search for the patrol list.
3. Optional: Call POST /artemis/api/video/v1/presets/addition and POST /artemis/api/video/v1/
presets/deletion to edit the preset information; call POST /artemis/api/video/v1/patrols/
addition and POST /artemis/api/video/v1/patrols/deletion to edit the patrol information.
4. Call POST /artemis/api/video/v1/ptzs/controlling to perform 3D operations (rotate camera,
move focus, adjust focal length (zoom in/out), enlarge/reduce iris), and other operations
including jumping to preset and starting patrol by camera No., preset No. and patrol No.

Intelligent Recognition
Intelligent recognition includes applications on searching for matched faces and human bodies.

58
HikCentral Professional OpenAPI Developer Guide

Figure 4-19 API Calling Flow of Intelligent Recognition

59
 HikCentral Professional OpenAPI Developer Guide

Manage Faces and Face Comparison Groups

Steps
1. Call POST /artemis/api/frs/v1/face/group/single/addition to add a face comparison group.
2. Call POST /artemis/api/frs/v1/face/group or POST /artemis/api/frs/v1/face/groupList to get
information of the face comparison group.
3. Optional: Call POST /artemis/api/frs/v1/face/group/single/update to edit information of a
face comparison group; call POST /artemis/api/frs/v1/face/group/batch/deletion to delete the
face comparison group.
4. Call POST /artemis/api/frs/v1/face/single/addition to add information of a face to the face
comparison group.

Note
The face information can be added from existing persons. See details in Manage Persons .
5. Call POST /artemis/api/frs/v1/face to get the face information by face comparison group.
6. Optional: Call POST /artemis/api/frs/v1/face/deletion to delete the face information from the
face comparison group. If the face information is added from existing persons in the person
management, you can choose to delete it from the organization.

Receive Face Comparison Events and Search for Records

Steps
1. Create an intelligent recognition task on the HikCentral Professional platform first for face
comparison event.
2. Call POST /artemis/api/frs/v1/plan/recognition/black/restart to apply the face comparison
group to device.
3. Refer to Programming Guide for the event receiving process; refer to Facial Events for specific
event type enumerations.
4. Call POST /artemis/api/aiapplication/v1/face/faceMatchRecord to search for the face
comparison records.
5. Call POST /artemis/api/frs/v1/application/picture to download face pictures from real-time
face comparison events and face comparison record search.

Search for Persons by Matched Faces / Human Bodies

You can search for person by searching for matched faces / human bodies on Intelligent Fusion
Server and DeepInMind NVR. The search for person function on Intelligent Fusion Server and
DeepInMind NVR both relies on the intelligent recognition task, which should be created on the
HikCentral Professional platform and applied to device.

60
 HikCentral Professional OpenAPI Developer Guide

Search for Matched Face

1. Call the Base64 converter to get the picture data.
2. Call POST /artemis/api/frs/v1/application/pictureRecognitionModel to detect and model
faces in the picture.
3. Call POST /artemis/api/frs/v1/application/captureSearch to get matched faces by face picture
comparison according to the face modeling data.
4. Call POST /artemis/api/frs/v1/application/picture to download the target picture according to
the returned URL and convert it by Base64.

Search for Matched Human Body

1. Call the Base64 converter to get the picture data.
2. Call POST /artemis/api/body/v1/application/pictureRecognition to detect human body and
get the human body coordinates.
3. Call POST /artemis/api/body/v1/application/pictureModel to get the human body modeling
data according to the coordinates.
4. Call POST /artemis/api/body/v1/application/captureSearch to get matched human bodies by
body picture comparison according to the modeling data, and get the target picture
information.
5. Call POST /artemis/api/frs/v1/application/picture to download the target picture according to
the returned URL and convert it by Base 64.

Camera Capture
Steps
Picture capture by camera is applicable to scenarios including but not limited to:
a. You need to specify camera for capturing pictures for initial alarm reviewing, but picture capture
is not configured for some events or alarms yet.
b. You can configure scheduled tasks and specify camera of a certain area (e.g., rack, farm, and
construction site) for capturing pictures, to observe changes of the area within a time period.
c. Any other applicable scenarios you can think of.

61
 HikCentral Professional OpenAPI Developer Guide

Figure 4-20 API Calling Flow of Camera Capture

1. The relevant alarms/events or scheduled tasks are triggered.
2. Get the corresponding camera resource information.
3. Call POST /artemis/api/video/v1/camera/capture to capture real-time pictures via camera, and
decode and save the returned picture in base64 format.

Tag Search
Tag search is used to search for time periods when persons or vehicles are detected by camera. You
can download the recording during the time period on your developed client as evidence.

62
 HikCentral Professional OpenAPI Developer Guide

Steps

Figure 4-21 API Calling Flow of Tag Search

1. Get the playback URL and play back on your client developed via C++/C# SDK.
2. Call POST /artemis/api/video/v1/event/searchLabels to search for the tags of the person/
vehicle-detected videos and display the result on the playback progress bar.
3. Select a tag and download the video as evidence via C++/C# SDK.

4.4.3 Restrictions and Suggestions

1. As POST /artemis/api/video/v1/ptzs/controlling (PTZ control) is an asynchronous API, which
requires a certain time for the interaction with device, it is recommended to lower the calling
frequency according to the network status.
2. As the adding, deleting, and editing operation on presets and patrols also requires a certain
time for the interaction with device, it is recommended to lower the calling frequency according
to the network status.
3. POST /artemis/api/video/v1/download (recording download) only supports downloading
recordings no longer than one minute; it is recommended to have no more than 50 concurrent
channels; MP4 file downloading requires internal transcoding, which makes it slower than AVI
file downloading.

63
 HikCentral Professional OpenAPI Developer Guide

4. It is recommended to call POST /artemis/api/video/v1/cameras/playbackURLs (playback URL

search) synchronously. The time parameter in the request is the device time.
5. As the APIs of searching for matched faces / human bodies require interaction with device, it is
recommended to call them concurrently.

4.5 Access Control

4.5.1 Capability Description

The access control application provides the capability of person's access level management, real-
time card-swiping event pushing and receiving, identity access search and picture download, and
access point control.

Figure 4-22 Directory of Access Control Capability Directory

4.5.2 Programming Guide

The programming guide includes configurations related to person's access level, providing the real-
time person entry/exit monitoring and access event statistics.

64
 HikCentral Professional OpenAPI Developer Guide

Figure 4-23 API Calling Flow of Access Control

Manage Access Levels

In access control, access level is a group of doors and floors. After assigning the access level to
certain persons, it defines the access permission that which persons can get access to which doors
and floors during the authorized time period. After setting the linkage between access levels and
persons, you should apply the persons' access level settings to device to take effect.

65
 HikCentral Professional OpenAPI Developer Guide

Before You Start

● Make sure you have added access levels on the platform. Refer to the User Manual of HikCentral

Professional Web Client for details.

● Make sure you have added persons. Refer to Manage Persons for details.

Steps
1. Call APIs from Manage Persons to get the information list of corresponding persons, where you
can perform adding, editing, or deleting persons.
2. Call POST /artemis/api/acs/v1/privilege/group to get the existing access levels of the platform
for reference.
3. Optional: Call POST /artemis/api/acs/v1/privilege/group/single/addPersons / POST /
artemis/api/acs/v1/privilege/group/single/deletePersons to assign/unassign access levels to
persons.

Note
If the access level is configured through the person group on the platform, calling POST /
artemis/api/acs/v1/privilege/group/single/addPersons is not needed.
4. Call POST /artemis/api/visitor/v1/auth/reapplication to apply persons' access level settings to
device.
5. Optional: Call POST /artemis/api/acs/v1/auth/applicationResult to get the details of access
level applying and see if the applying is successful.

Receive Card-Swiping Information

You can receive card-swiping information for access control related application development.
● Receive events of the specified event type. Refer to Subscribe to and Push Events for details.
● Event type enumeration: Card Swiping Events .

Note
Besides card swiping event, you can also refer to other access control related alarms for your
development: Door Alarms and Access Control Device Alarms .

Search for Card-Swiping Records and Download Picture

You can search for card-swiping records in page according to the start/end time, access point ID,
event type, and person name.
1. Call the access point resource related APIs in Manage Logical Resources to get the
corresponding resource information list.
2. Call POST /artemis/api/acs/v1/door/events to search for card-swiping records.

66
 HikCentral Professional OpenAPI Developer Guide

Note
For the event types as the search condition, see details in Event Types or Alarm Categories .
3. Call POST /artemis/api/acs/v1/event/pictures to download URL pictures from the event.

Control Door Status

You can control the status for a single door, including opening door, closing door, remaining the
door open, and remaining the door closed.
Steps

Figure 4-24 API Calling Flow of Controlling Door Status

1. Get door (access point) information, refer to Resource Management for details.
2. Call POST /artemis/api/acs/v1/door/doControl to control the status of a single door.

4.5.3 Restrictions and Suggestions

1. As the access control APIs requires interaction with device, it is recommended to lower the
calling frequency according to the network status during operations on the same device.
2. For POST /artemis/api/visitor/v1/auth/reapplication , it is recommended to choose whether
to apply persons including those which have failed as needed. Applying those which have failed
may lead to slow applying.
3. Access levels created by persons will be automatically applied and do not require a second
applying. It is recommended to call the access level applying API after the access level
verification failed; it is recommended to wait a while before calling the search API POST /
artemis/api/acs/v1/auth/applicationResult as the auto-applying of access level takes some
time.

67
 HikCentral Professional OpenAPI Developer Guide

4.6 Visitor Management

4.6.1 Capability Description

You can manage visitors, including making reservations for visitors, checking in visitors with/
without reservation information, and checking out visitors. The certificate No. will be used as the
unique visitor ID, for allowing or rejecting the reservation when matching with the monitoring list
configured.

Figure 4-25 Visitor Management Capability Directory

68
 HikCentral Professional OpenAPI Developer Guide

4.6.2 Programming Guide

Figure 4-26 API Calling Flow of Visitor Management

69
 HikCentral Professional OpenAPI Developer Guide

Make a Reservation for Visitor

You can make reservations for visitors before arrival, and quickly check in the reserved visitors with
the visitor information including reservation code, phone No., and certificate No.
1. Call POST /artemis/api/visitor/v2/appointment to make a reservation for a visitor.

Note
A reservation record ID will be returned, which is used for checking in.
2. If the visitor matched with any person in the monitoring list, all matched information will be
returned and you should call POST /artemis/api/visitor/v2/appointment again with the auto-
filled information to make the reservation.
3. Call POST /artemis/api/visitor/v1/visitorConfig/automaticApproval to check whether auto
review of visitor reservation is enabled or not.
4. (Optional) Call POST /artemis/api/visitor/v2/appointment/update / POST /artemis/api/
visitor/v1/appointment/single/delete to edit/delete the visitor reservation information.

Note
When auto review of visitor reservation is enabled, you can edit the reservation information;
when it is disabled, the reservation in review cannot be edited.
5. (Optional) Call POST /artemis/api/visitor/v1/visitorapprovalflow/status to review the
reservation.
6. Call POST /artemis/api/visitor/v1/appointment/appointmentlist to search for the reservation
list.

Check In Visitor
The platform provides check-in service for both reserved visitors and unreserved visitors.

Check In Unreserved Visitor

The process of checking in unreserved visitors includes entering the visitor information and visitor
certificate, visit purpose, linking and applying access levels. Refer to Manage Access Levels for
configuring access levels.
1. Call POST /artemis/api/visitor/v1/registerment to check in a visitor without reservation.
2. (Optional) Call POST /artemis/api/visitor/v1/registerment/update to edit the visitor check-in
information.
3. (Optional) For scenarios where access control is applicable, call POST /artemis/api/acs/v1/
privilege/group to search for the access group and add the visitor to the specified access group.
4. Call POST /artemis/api/visitor/v1/person/ID/elementDownloadDetail to search for
information of access level applying. If the access level applying failed, call POST /artemis/api/
visitor/v1/auth/reapplication again to reapply the access level.

70
 HikCentral Professional OpenAPI Developer Guide

Check In Reserved Visitor

If a reservation has been made before check-in, the check-in process includes searching for
reservation information, auto-filling in the visitor information, and linking and applying access
levels.

Note
The difference between check-in with and without reservation is the searched reservation
information for quick filling of visitor information.
1. Call POST /artemis/api/visitor/v1/appointment/appointmentlist to get the reservation record,
or get the reservation record by reservation code.
2. According to the visitorId returned from the last step, call POST /artemis/api/visitor/v1/
registerment to match the visitorId with the information from the reservation list, for auto-
filling for quick visitor check-in.
3. (Optional) Call POST /artemis/api/acs/v1/privilege/group to search for the access group and
add the visitor to the specified access group.
4. Call POST /artemis/api/visitor/v1/auth/reapplication to apply the visitor's access level settings
to devices.
5. Call POST /artemis/api/visitor/v1/person/ID/elementDownloadDetail to search for
information of access level applying. If the access level applying failed, call POST /artemis/api/
visitor/v1/auth/reapplication again to reapply the access level.

Check Out Visitor

You can make reservations for visitors before arrival, and quickly check in the reserved visitors with
the visitor information including reservation code, phone No., and certificate No.
When the visit is over, call POST /artemis/api/visitor/v1/visitor/out to check out the visitor and
the visitor's access level will be revoked.

Search for Visit Record

You can search for visit records including reservation records, visitor groups, and visitor
information.
● After a reservation is made, the corresponding reservation record will be generated.
Call POST /artemis/api/visitor/v1/appointment/appointmentlist to get the reservation record
list.
● After the reservation is made or the visitor is checked in, the visitor information will be added to
the visitor group.
Call POST /artemis/api/visitor/v1/visitorgroups/groupinfo to search for visitors' information by
visitor group ID.

71
 HikCentral Professional OpenAPI Developer Guide

● Call POST /artemis/api/visitor/v1/visitor/visitorInfo or POST /artemis/api/visitor/v1/visitor/

single/visitorinfo to search for visitors' information by condition.
● Call POST /artemis/api/visitor/v1/visitorgroups/groupinfo to search for visitors' information by
visitor group ID.

4.7 ANPR

4.7.1 Capability Description

The ANPR application provides the capability of vehicle recognition, including ANPR event upload,
ANPR record search, and vehicle picture download.

Note
For vehicle resource management, refer to Manage Vehicles .

Figure 4-27 ANPR Capability Directory

72
 HikCentral Professional OpenAPI Developer Guide

4.7.2 Programming Guide

Figure 4-28 API Calling Flow of ANPR

1. Receive the real-time ANPR events ( ANPR Events ) and call POST /artemis/api/pms/v1/
crossRecords/page to search for history records of ANPR.
2. If the event message or records contain any picture URL, call POST /artemis/api/pms/v1/image
to download the vehicle picture.

Note
Besides the ANPR events, you can also refer to the vehicle matched event and vehicle mismatched
event in Camera Alarms .

73
 HikCentral Professional OpenAPI Developer Guide

4.8 Parking Lot Application

4.8.1 Capability Description

The parking lot application includes searching for vehicle passing records, searching for vehicle
parking records, getting the real-time occupancy of parking spaces, getting the parking fee
information, etc.

Note
For vehicle resource management, refer to Manage Vehicles .

Figure 4-29 Parking Lot Application Capability Directory

4.8.2 Programming Guide

Search for Vehicle Passing Records

You can search for vehicle passing records in page by start/end time, parking lot ID, license plate
No., vehicle owner name, vehicle owner contact, etc.

74
 HikCentral Professional OpenAPI Developer Guide

Figure 4-30 API Calling Flow of Searching for Vehicle Passing Records
1. Call POST /artemis/api/vehicle/v1/parkinglot/list to get the parking lot list.
2. Call POST /artemis/api/vehicle/v1/parkinglot/passageway/record to search for the vehicle
passing records of the specified parking lot.
3. (Optional) Call POST /artemis/api/pms/v1/image to download the vehicle pictures via the
URLs in the records.

Get Passing Vehicle Picture

1. Call POST /artemis/api/vehicle/v1/parkinglot/passageway/record to get the vehicle passing
records containing the picture URL (ImageUrl); or receive ANPR events ( ANPR Events ) to get
the picture URL from the event message.

Note
For how to receive ANPR events, refer to Programming Guide .
2. Call POST /artemis/api/pms/v1/image to download the corresponding picture.

75
 HikCentral Professional OpenAPI Developer Guide

Get Real-Time Occupancy of the Parking Spaces

Figure 4-31 API Calling Flow of Getting Real-Time Occupancy of the Parking Spaces
1. Call POST /artemis/api/vehicle/v1/parkinglot/list to get the parking lot list.
2. Call POST /artemis/api/vehicle/v1/floor/list to get the floor list of the specified parking lots.
3. Call POST /artemis/api/vehicle/v1/floor/overview to get the occupancy of the specified floors.
4. Call POST /artemis/api/vehicle/v1/floor/parkingspace/status to get the real-time status of all
parking spaces on the specified floor.
5. According to parkingImageUrl and platenumberImageUrl in the returned parking space
information, call POST /artemis/api/pms/v1/image to download the picture.

Search for Vehicle Parking Records

Search for vehicle parking records by parking start/end time, parking lot ID, floor ID, parking space
No., and license plate No.

76
 HikCentral Professional OpenAPI Developer Guide

Figure 4-32 API Calling Flow of Searching for Vehicle Parking Records
1. Call POST /artemis/api/vehicle/v1/parkinglot/list to get the parking lot list.
2. Call POST /artemis/api/vehicle/v1/floor/list to get the floor list of the specified parking lots.
3. Call POST /artemis/api/vehicle/v1/parkingspace/record to get the vehicle parking records.

Get Vehicle Parking Fee Information

Get the vehicle parking fee information by accurate license plate No.

77
 HikCentral Professional OpenAPI Developer Guide

Figure 4-33 API Calling Flow of Getting Vehicle Parking Fee Information
Enter the license plate number and call POST /artemis/api/vehicle/v1/parkingfee/calculate to get
the parking fee information of the vehicle in the current parking lot.

78
 HikCentral Professional OpenAPI Developer Guide

Confirm Parking Fee Payment and Allow Exit

Figure 4-34 API Calling Flow of Confirming the Payment of Parking Fee and Allow Exit
Enter the license plate number and call POST /artemis/api/vehicle/v1/parkingfee/confirm .
● Payment on exit:

○ If the vehicle is right at the barrier gate, the gate will be opened once the payment is made via

booth.
○ If the vehicle is not at the barrier gate, a pompt on absence will be be sent.

● Payment before exit:

○ If the vehicle is to exit wthin the paid duration, the gate will be automatically opened on exit.

○ If the vehicle is to exit after the paid duration, extra time will be charged and the gate will be

automatically opened after the payment is made.

79
 HikCentral Professional OpenAPI Developer Guide

4.9 On-Board Monitoring

4.9.1 Capability Description

The on-board monitoring capability is about managing on-board monitoring devices ( Manage
Physical Resources ), getting detailed information of GPS statistics, searching for event information
of an on-board device, and searching for event records of on-board monitoring (brief information
included only).

Figure 4-35 On-Board Monitoring Capability Directory

4.9.2 Programming Guide

Note
● Resource Management: consistent with Table 4-6 in Manage Physical Resources .
● Video Application: consistent with Video Application .

Search for Driving Event Records

You can search for records of driving events of the following types.
● On-Board module event: panic button alarm, sharp turn, sudden brake, sudden acceleration,

rollover, overspeed, collision, enter fence, deviation, and exit fence.

Note
For receiving the following real-time on-board module event, refer to Event and Alarm .
● Driver status monitoring event: smoking, on the phone, fatigue driving, distracted, not buckled
up, and video tampering.
● ADAS event: front vehicle collision warning, short vehicle distance warning, lane deviation
warning, pedestrian collision warning, overspeed warning, and blind spot detection warning.

80
 HikCentral Professional OpenAPI Developer Guide

Figure 4-36 API Calling Flow of Searching for Driving Event Records
1. Call POST /artemis/api/resource/v1/mobilevehicle/mobilevehicleList to get the list of vehicles
linked to on-board devices.
2. Call On-Board Monitoring Events to search for event types of vehicles linked to on-board
devices.
3. Call POST /artemis/api/mobilesurveillance/v1/recordOverview to search for event records of
vehicles linked to on-board devices.
4. Call POST /artemis/api/mobilesurveillance/v1/single/record to search for event information of
an on-board device.

81
 HikCentral Professional OpenAPI Developer Guide

Search for GPS Statistics

Search for history GPS data uploaded by multiple on-board devices by time.

Figure 4-37 API Calling Flow of Searching for GPS Statistics

1. Call POST /artemis/api/resource/v1/mobilevehicle/mobilevehicleList to get the list of vehicles
linked to on-board devices.
2. Call POST /artemis/api/mobilesurveillance/v1/gpsdetails to get GPS statistics information of
on-board devices.

Receive On-Board Monitoring Events

You can receive real-time event notifications with relevant subscriptions. Refer to Subscribe to and
Push Events for details. For supported event types, refer to On-Board Device Alarms and On-Board
Monitoring Events .

82
 HikCentral Professional OpenAPI Developer Guide

4.10 Digital Signage

4.10.1 Capability Description

You can upload dynamic materials of third-party data source, link them to a program, and push
data by updating the data source. The digital signage capability is about searching for the data
source, updating the data source, and batch updating data sources.

Figure 4-38 Digital Signage Capability Directory

4.10.2 Programming Guide

Figure 4-39 API Calling Flow of Managing Data Source

83
 HikCentral Professional OpenAPI Developer Guide

1. (Optional) Call POST /artemis/api/focsign/v1/material/dataSource/search to search for the

available data source on the current platform.
2. Call POST /artemis/api/focsign/v1/material/dataSource/update / POST /artemis/api/
focsign/v1/material/dataSource/update/batch to update / batch update the data source.

4.11 Intelligent Analysis

4.11.1 Capability Description

The intelligent analysis provides video application based intelligent analysis data including people
counting and heat map statistics.

Figure 4-40 Intelligent Analysis Capability Directory

84
 HikCentral Professional OpenAPI Developer Guide

4.11.2 Programming Guide

Figure 4-41 API Calling Flow of Intelligent Analysis

Get People Counting Statistics

1. Get camera information from APIs in Manage Logical Resources and call POST /artemis/api/
aiapplication/v1/people/advance/resourceGroupList to get the list of resource groups.
2. Call POST /artemis/api/aiapplication/v1/people/statisticsTotalNumByTime to get the people
counting of multiple cameras within a specific time period, and call POST /artemis/api/
aiapplication/v1/people/resourceGroupRealTimeCount to get the real-time statistics of
multiple resource groups.

85
 HikCentral Professional OpenAPI Developer Guide

Get Heat Map Data

1. Get the camera information.
2. Call POST /artemis/api/aiapplication/v1/people/statisticsHeatMapByTime to get the heat
map data of multiple cameras within a specific time period.

86
 HikCentral Professional OpenAPI Developer Guide

Chapter 5 API Reference

5.1 Common API

Here provides an API for getting version information.

5.1.1 POST /artemis/api/common/v1/version

Get version information of platform.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/common/v1/version
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Version information. See details in
Version .

87
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"produceName": "HikCentral Professional",
"softVersion": "V2.1.0.0"
}
}

5.2 Physical Resources API

Here provides APIs for the management of encoding devices, access control devices, Streaming
Servers, Recording Servers, DeepinMind Servers, and System Management Servers.

5.2.1 POST /artemis/api/resource/v1/acsDevice/acsDeviceList

Get the information list of all access control devices, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/acsDevice/acsDeviceList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,

88
 HikCentral Professional OpenAPI Developer Guide

"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array List of access control device
information.
list[0] Opt. Object Information of an access control
device in the list. See details in
AcsDevInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 4,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"acsDevIndexCode": "46",
"acsDevName": "10.18.64.39",
"acsDevIp": "10.18.64.39",
"acsDevPort": "9502",
"treatyType": "hiksdk_net",

89
 HikCentral Professional OpenAPI Developer Guide

"acsDevCode": "DS-K1T671TM-3XF20210308V030202ENE43116796",
"status ": 2
},
{
"acsDevIndexCode": "13",
"acsDevName": "10.18.66.112",
"acsDevIp": "10.18.66.112",
"acsDevPort": "8005",
"treatyType": "hiksdk_net",
"acsDevCode": "DS-K1T680MF-E120210303V030203ENE33392121",
"status ": 2
}
]
}
}

5.2.2 POST /artemis/api/resource/v1/acsDevice/indexCode/acsDeviceInfo

Get the information of an access control device by device ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/acsDevice/indexCode/acsDeviceInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
acsDevIndexC Req. String Body Access control device ID, which
ode consists of up to 64 characters.

Request Example
{
"acsDevIndexCode": "46"
}

90
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Access control device information.
See details in AcsDevInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"acsDevIndexCode": "46",
"acsDevName": "10.18.64.39",
"acsDevIp": "10.18.64.39",
"acsDevPort": "9502",
"treatyType": "hiksdk_net",
"acsDevCode": "DS-K1T671TM-3XF20210308V030202ENE43116796",
"status": 2
}
}

5.2.3 POST /artemis/api/resource/v1/acsDevice/advance/acsDeviceList

Set search condition (i.e., device name) to search the specified access control devices, and fuzzy
search is supported; if the search condition is not configured, the information of all access control
devices will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/acsDevice/advance/acsDeviceList

91
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
acsDevName Opt. String Body Access control device name,
which consists of 1 to 32
characters, but cannot contain
special characters like ' / \ : * ?
"<>|

Request Example
{
"pageNo": 1,
"pageSize": 10，
"acsDevName": "10.18.64.39"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.

92
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Information list of access control
devices.
list[0] Opt. Object Information of an access control
device in the list. See details in
AcsDevInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"acsDevIndexCode": "46",
"acsDevName": "10.18.64.39",
"acsDevIp": "10.18.64.39",
"acsDevPort": "9502",
"treatyType": "hiksdk_net",
"acsDevCode": "DS-K1T671TM-3XF20210308V030202ENE43116796",
"status ": 2
}
]
}
}

5.2.4 POST /artemis/api/resource/v1/encodeDevice/encodeDeviceList

Get the information list of all encoding devices, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/encodeDevice/encodeDeviceList

93
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.

94
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Encoding device information list.
list[0] Opt. Object Information of an encoding device in
the list. See details in EncodeDevInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 19,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"encodeDevIndexCode": "86",
"encodeDevName": "10.41.13.38_ ",
"encodeDevIp": "10.41.13.38",
"encodeDevPort": "8000",
"encodeDevCode": "DS-9632NI-I81620210322CCRRF71031387WCVU",
"treatyType": "hiksdk_net",
"isSupportWakeUp": 0,
"wakeUpStatus": 0,
"status ": 1
},
{
"encodeDevIndexCode": "85",
"encodeDevName": "10.18.66.25",
"encodeDevIp": "10.18.66.25",
"encodeDevPort": "9000",
"encodeDevCode": "SimulatorDevice",
"treatyType": "hiksdk_net",
"isSupportWakeUp": 0,
"wakeUpStatus": 0,
"status ": 2
}
]
}
}

5.2.5 POST /artemis/api/resource/v1/encodeDevice/indexCode/encodeDeviceInfo

Get the information of an encoding device by device ID.

95
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/encodeDevice/indexCode/
encodeDeviceInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
encodeDevInd Req. String Body Encoding device ID, which
exCode consists of up to 64 characters.

Request Example
{
"encodeDevIndexCode": "85"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Encoding device information. See
details in EncodeDevInfo .

Response Example
{
"code": "0",

96
 HikCentral Professional OpenAPI Developer Guide

"msg": "Success",
"data": {
"encodeDevIndexCode": "85",
"encodeDevName": "10.18.66.25",
"encodeDevIp": "10.18.66.25",
"encodeDevPort": "9000",
"encodeDevCode": "SimulatorDevice",
"treatyType": "hiksdk_net",
"isSupportWakeUp": 0,
"wakeUpStatus": 0,
"status": 2
}
}

5.2.6 POST /artemis/api/resource/v1/encodeDevice/advance/encodeDeviceList

Set search condition (i.e., device name) to search the specified encoding devices, and fuzzy search
is supported; if the search condition is not configured, the information of all encoding devices will
be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/encodeDevice/advance/
encodeDeviceList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
encodeDevNa Opt. String Body Encoding device name, which
me consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |

97
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"pageNo": 1,
"pageSize": 10，
"encodeDevName": "10.18.66.25",
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Encoding device information list.
list[0] Opt. Object Information of an encoding device in
the list. See details in EncodeDevInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"encodeDevIndexCode": "85",
"encodeDevName": "10.18.66.25",

98
 HikCentral Professional OpenAPI Developer Guide

"encodeDevIp": "10.18.66.25",
"encodeDevPort": "9000",
"encodeDevCode": "SimulatorDevice",
"treatyType": "hiksdk_net",
"isSupportWakeUp": 0,
"wakeUpStatus": 0,
"status ": 2
}
]
}
}

5.2.7 POST artemis/api/resource/v1/device/indexCode/wakeUp

Wake up solar device.

Request URL
https://[serverAddress]:[serverPort]/artemis/resource/v1/device/indexCode/wakeUp
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
deviceIndexCo Req. String Body Device ID.
de
cameraIndexC Opt. String Body Camera ID.
ode

Request Example
{
"deviceIndexCode": "1",
"cameraIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

99
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.

Response Example
{
"code": "0",
"msg": "Success"
}

5.2.8 POST /artemis/api/resource/v1/intelligentServer/intelligentServerList

Get DeepinMind Server list to sychronize all device information. The information of all servers will
be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/intelligentServer/
intelligentServerList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

100
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Information list of DeepinMind
Servers.
list[0] Opt. Object Information of a DeepinMind Server,
refer to IntelligentServerInfo for
details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 4,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"intelligentServerIndexCode": "1",

101
 HikCentral Professional OpenAPI Developer Guide

"intelligentServerName": "10.41.7.96",
"intelligentServerIp": "10.41.7.96",
"status": 1
},
{
"intelligentServerIndexCode": "2",
"intelligentServerName": "10.19.167.130",
"intelligentServerIp": "10.19.167.130",
"status": 0
}
]
}
}

5.2.9 POST /artemis/api/resource/v1/mobileDevice/mobileDeviceList

Get the on-board device list in page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/mobileDevice/mobileDeviceList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of
up to 32 characters, but
cannot contain special
characters like ' / \ : * ? " <
>|
pageNo Req. Number Body The current page No.,
which is between 1 and
2147483647.
pageSize Req. Number Body Number of records on
each page, which is
between 1 and 500.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

102
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. PageInfo Response data details.

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. MobileDeviceInfo On-board device list.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"mobileDevIndexCode": "1",
"mobileDevName": "10.18.66.164",
"mobileDevIp": "",
"mobileDevPort": "0",
"mobileDevCode": "20210225WRF58663372",
"treatyType": "ehome_reg",
"status ": 2
}

103
 HikCentral Professional OpenAPI Developer Guide

]
}
}

5.2.10 POST /artemis/api/resource/v1/mobileDevice/indexCode/mobileDeviceInfo

Get the information of an on-board device by device ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/mobileDevice/indexCode/
mobileDeviceInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of
up to to 32 characters, but
cannot contain special
characters like ' / \ : * ? " <
>|
mobileDevI Req. String Body On-board device ID. The
ndexCode maximum length is 64
characters.

Request Example
{
"mobileDevIndexCode ":"1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the

104
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. MobileDevInfo Response data details. See details in
MobileDeviceInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"mobileDevIndexCode": "1",
"mobileDevName": "10.18.66.164",
"mobileDevIp": "",
"mobileDevPort": "0",
"mobileDevCode": "20210225WRF58663372",
"treatyType": "ehome_reg",
"status": 2
}
}

5.2.11 POST /artemis/api/resource/v1/mobileDevice/advance/mobileDeviceList

Search the on-board device list.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/mobileDevice/advance/
mobileDeviceList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of
up to 32 characters, but
cannot contain special

105
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
characters like ' / \ : * ? " <
>|
pageNo Req. Number Body The current page No.,
which is between 1 and
2147483647.
pageSize Req. Number Body Number of records on
each page, which is
between 1 and 500.
mobileDevN Opt. String Body On-board device resource
ame name. The maximum
length is 128 characters.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"mobileDevName": "10.18.64.39"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. PageInfo Response data details.

106
 HikCentral Professional OpenAPI Developer Guide

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. MobileDevInfo[] On-board device list. See details in
MobileDeviceInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"mobileDevIndexCode": "1",
"mobileDevName": "10.18.66.164",
"mobileDevIp": "",
"mobileDevPort": "0",
"mobileDevCode": "20210225WRF58663372",
"treatyType": "ehome_reg",
"status ": 2
}
]
}
}

5.2.12 POST /artemis/api/resource/v1/recordServer/recordServerList

Get Recording Server list.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/recordServer/recordServerList

107
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.

108
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Information list of Recording Servers.
list[0] Opt. Object Information of a Recording Server,
refer to RecordServerInfo for details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"recordServerIndexCode": "1",
"recordServerName": "10.41.7.232",
"recordServerIp": "10.41.7.232",
"recordingStatus": 2,
"networkStatus": 1
},
{
"recordServerIndexCode": "4",
"recordServerName": "10.18.66.214",
"recordServerIp": "10.18.66.214",
"recordingStatus": 1,
"networkStatus": 2
}
]
}
}

5.2.13 POST /artemis/api/resource/v1/recordServer/indexCode/recordServerInfo

Get information of a Recording Server by server ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/recordServer/indexCode/
recordServerInfo

109
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
recordServerIn Req. String Body Recording Server ID, which
dexCode consists of up to 10 characters.

Request Example
{
"recordServerIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Information of a Recording Server,
refer to RecordServerInfo for details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"recordServerIndexCode": "1",
"recordServerName": "10.41.7.232",
"recordServerIp": "10.41.7.232",

110
 HikCentral Professional OpenAPI Developer Guide

"recordingStatus": 2,
"networkStatus": 1,
"hddList": [
{
"poolID": "0",
"poolName": "RV_1",
"Capacity": 821568,
"FreeSpace": 712317,
"UsedSpace": 109251
},
{
"poolID": "1",
"poolName": "PIC_RV_1",
"Capacity": 9310,
"FreeSpace": 9310,
"UsedSpace": 0
}
]
}
}

5.2.14 POST /artemis/api/resource/v1/recordServer/recordStatus

Get the storage status of cameras linked to a specific Recording Server.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/recordServer/recordStatus
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
' / \ : * ? " < > |.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

111
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
recordServerIn Req. String Body Recording Server ID, which
dexCode consists of up to 64 characters.
poolID Req. String Body Resource pool ID, which
consists of up to 32 characters.

Request Example
{
"pageNo": 1,
"pageSize": 2，
"recordServerIndexCode": "1",
"poolID": "0"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
recordServerInde Opt. String Recording Server ID, which consists of
xCode up to 64 characters.
recordServerNam Opt. String Recording Server name, which
e consists of up to 64 characters.
pageSize Opt. Number Number of records on each page.
list Opt. Array Information list of Recording Servers.

112
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

recordServerIp Opt. String IP address of Recording Server, whose
maximum length is 64 bytes.
recordingStatus Opt. Number Video status: 0-unknown, 1-normal,
2-​exception.
networkStatus Opt. Number Network status: 0-unknown, 1-online,
2-​offline.
total Opt. Number Total number of data records.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Storage status list of cameras linked to
a Recording Server.
list[0] Opt. Object Storage status of a camera linked to a
Recording server, refer to
CameraRecordStatus for details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"recordServerIndexCode": "1",
"recordServerName": "10.41.7.232",
"recordServerIp": "10.41.7.232",
"recordingStatus": 2,
"networkStatus": 1,
"list": [
{
"regionName": "10.18.65.98",
"deviceIp": "10.18.65.98",
"cameraName": "Camera 01",
"cameraIndexCode": "103",
"networkStatus": 2,
"recordingScheduleName": "",
"recordingStatus": 2,
"siteName": "HikCentral Professional",
"storageType": 1
}
]

113
 HikCentral Professional OpenAPI Developer Guide

}
}

5.2.15 POST /artemis/api/resource/v1/streamServer/streamServerList

Get Streaming Service list.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/streamServer/streamServerList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

114
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Information list of Streaming Servers.
list[0] Opt. Object Information of a Streaming Server,
refer to StreamServerInfo for details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 4,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"acsDevIndexCode": "46",
"acsDevName": "10.18.64.39",
"acsDevIp": "10.18.64.39",
"acsDevPort": "9502",
"treatyType": "hiksdk_net",
"acsDevCode": "DS-K1T671TM-3XF20210308V030202ENE43116796",
"status ": 2
},
{
"acsDevIndexCode": "13",
"acsDevName": "10.18.66.112",
"acsDevIp": "10.18.66.112",
"acsDevPort": "8005",
"treatyType": "hiksdk_net",
"acsDevCode": "DS-K1T680MF-E120210303V030203ENE33392121",
"status ": 2

115
 HikCentral Professional OpenAPI Developer Guide

}
]
}
}

5.2.16 POST /artemis/api/resource/v1/videoManagementServer

Get the information of the System Management Server.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/videoManagementServer
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
' / \ : * ? " < > |.

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Information of the System
Management Server.
ip Opt. String IP address of the server, and the
maximum length is 64 bytes.
port Opt. Number Port No. of the server.

116
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

cpu Opt. Number CPU usage of the server.
status Opt. Number Network status: 0-online, 1-​offline.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"ip": "127.0.0.1",
"port": 443,
"cpu": 90,
"status": 0
}
}

5.3 Logical Resources API

Here provides APIs for the management of sites, areas, cameras, alarm inputs, alarm outputs,
vehicles, access points, organizations, persons, face comparison groups, faces, visitors, access
levels, and access groups.

5.3.1 Site Information

POST /artemis/api/resource/v1/site/siteList
Get the information list of all sites, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/site/siteList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot

117
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
pageNo Opt. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Opt. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Opt. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Opt. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Site information list.
list[0] Opt. Object Information of a site in the list. See
details in SiteInfo .

118
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"siteIndexCode": "0",
"siteName": "HikCentral Professional",
"siteIp": "10.41.7.232",
"sitePort": "0",
"description": ""
},
{
"siteIndexCode": "17",
"siteName": "HikCentral Professional",
"siteIp": "10.18.66.21",
"sitePort": "80",
"description": ""
}
]
}
}

POST /artemis/api/resource/v1/site/indexCode/siteInfo
Get the information of a site by site ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/site/indexCode/siteInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
siteIndexCode Req. String Body Site ID, which consists of up to
64 characters.

119
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"siteIndexCode": "17"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Site information. See details in
SiteInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"siteIndexCode": "17",
"siteName": "HikCentral Professional",
"siteIp": "10.18.66.21",
"sitePort": "80",
"description": ""
}
}

POST /artemis/api/resource/v1/site/advance/siteList
Set search condition (i.e., site name) to search the specified site, and fuzzy search is supported; if
the search condition is not configured, the information of all sites will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/site/advance/siteList

120
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
siteName Opt. String Body Site name, which consists of up
to 32 characters, but cannot
contain special characters like
'/\:*?"<>|

Request Example
{
"pageNo": 1,
"pageSize": 10,
"siteName": "HikCentral Professional"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.

121
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Site information list.
list[0] Opt. Object Information of a site in the list. See
details in SiteInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"siteIndexCode": "0",
"siteName": "HikCentral Professional",
"siteIp": "10.41.7.232",
"sitePort": "0",
"description": ""
},
{
"siteIndexCode": "17",
"siteName": "HikCentral Professional",
"siteIp": "10.18.66.21",
"sitePort": "80",
"description": ""
}
]
}
}

5.3.2 Area Information

POST /artemis/api/resource/v1/regions/subRegions
Get the area list of a specified parent area by resource type and permission.

122
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/regions/subRegions
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
parentIndexCo Opt. String Body Parent area No., which consists
de of up to 64 characters. By
default, it is the root area.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters. By default, it is
the current site.

Request Example
{
"siteIndexCode": "0",
"parentIndexCode": "0"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Area information. See details in
RegionInfo .

123
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"list": [
{
"indexCode": "1",
"parentIndexCode": "-1",
"siteIndexCode": "0",
"name": "10.18.65.114"
},
{
"indexCode": "28",
"parentIndexCode": "-1",
"siteIndexCode": "0",
"name": "10.18.65.98"
},
{
"indexCode": "29",
"parentIndexCode": "-1",
"siteIndexCode": "0",
"name": "10.41.7.131"
}
]
}
}

Remarks
The returned areas do not contain any child area, and both the cascading and non-cascading areas
will be returned.

POST /artemis/api/resource/v1/region/indexCode/regionInfo
Get the area information by area ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/region/indexCode/regionInfo

124
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
regionIndexCo Req. String Body Area ID, which consists of up to
de 64 characters.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters. By default, it is
the current site.

Request Example
{
"regionIndexCode": "28",
"siteIndexCode": "0"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Area information. See details in
RegionInfo .

Response Example
{
"code": "0",

125
 HikCentral Professional OpenAPI Developer Guide

"msg": "Success",
"data": {
"indexCode": "28",
"parentIndexCode": "-1",
"siteIndexCode": "0",
"name": "10.18.65.98"
}
}

POST /artemis/api/resource/v1/regions
Get information list of all areas, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/regions
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters. By default, it is
the current site.

Request Example
{
"pageNo": 1,
"pageSize": 2，
"siteIndexCode": "0"
}

126
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Area information list.
list[0] Opt. Object Information of an area in the list. See
details in RegionInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 40,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"indexCode": "1",
"parentIndexCode": "-1",
"siteIndexCode": "0",
"name": "10.18.65.114"
},
{
"indexCode": "28",
"parentIndexCode": "-1",
"siteIndexCode": "0",
"name": "10.18.65.98"

127
 HikCentral Professional OpenAPI Developer Guide

}
]
}
}

POST /artemis/api/resource/v1/regions/regionIndexCode/cameras
Get the camera list of a specified area by area ID, and the information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/regions/regionIndexCode/cameras
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
regionIndexCo Req. String Body Area ID, which consists of up to
de 64 characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters. By default, it is
the current site.
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.
bRecordSettin Opt. Number Body Whether to get the recording
g settings: 0-no, 1-yes (by
default). When there is a large

128
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
number of cameras, getting the
record settings will slow down
the API performance.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"regionIndexCode": "1",
"siteIndexCode": "0",
"deviceType": "encodeDevice",
"bRecordSetting": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data details.

PageInfo Object Description

Parameter Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.

129
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

pageSize Opt. Number Number of records on each page.
list Opt. CameraInfo[] Information of a camera in the list.
See details in CameraInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"cameraIndexCode": "1",
"cameraName": "Simulator Channel",
"capabilitySet": "ptz,event_veh",
"encodeDevIndexCode": "1",
"recordType": "0",
"recordLocation": "1",
"regionIndexCode": "1",
"siteIndexCode": "0",
"status": 2,
"isSupportWakeUp": 0,
"wakeUpStatus": 0
}
]
}
}

Remarks
The returned cameras do not contain child cameras.

5.3.3 Camera Information

POST /artemis/api/resource/v1/regions/regionIndexCode/cameras
Get the camera list of a specified area by area ID, and the information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/regions/regionIndexCode/cameras

130
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
regionIndexCo Req. String Body Area ID, which consists of up to
de 64 characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters. By default, it is
the current site.
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.
bRecordSettin Opt. Number Body Whether to get the recording
g settings: 0-no, 1-yes (by
default). When there is a large
number of cameras, getting the
record settings will slow down
the API performance.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"regionIndexCode": "1",
"siteIndexCode": "0",
"deviceType": "encodeDevice",

131
 HikCentral Professional OpenAPI Developer Guide

"bRecordSetting": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data details.

PageInfo Object Description

Parameter Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. CameraInfo[] Information of a camera in the list.
See details in CameraInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"cameraIndexCode": "1",
"cameraName": "Simulator Channel",
"capabilitySet": "ptz,event_veh",
"encodeDevIndexCode": "1",

132
 HikCentral Professional OpenAPI Developer Guide

"recordType": "0",
"recordLocation": "1",
"regionIndexCode": "1",
"siteIndexCode": "0",
"status": 2,
"isSupportWakeUp": 0,
"wakeUpStatus": 0
}
]
}
}

Remarks
The returned cameras do not contain child cameras.

POST /artemis/api/resource/v1/cameras/indexCode
Get the information of a specified camera by camera ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/cameras/indexCode
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.

Request Example
{
"cameraIndexCode": "1213"
}

133
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details. See details in
CameraInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"cameraIndexCode": "1213",
"cameraName": "Simulator Channel",
"capabilitySet": "ptz",
"devResourceType": "encodeDevice",
"DevIndexCode": "5",
"recordType": "0",
"recordLocation": "1",
"regionIndexCode": "95",
"siteIndexCode": "0",
"status": 2,
"isSupportWakeUp": 0,
"wakeUpStatus": 0
}
}

POST /artemis/api/resource/v1/cameras
Get the information list of all cameras, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/cameras

134
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters. By default, it is
the current site.
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.
bRecordSettin Opt. Number Body Whether to get the recording
g settings: 0-no, 1-yes (by
default). When there is a large
number of cameras, getting the
record settings will slow down
the API performance.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"siteIndexCode": "0",
"deviceType": "encodeDevice",
"bRecordSetting": 1
}

135
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details. See details in

PageInfo Object Description

Parameter Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. CameraInfo[] Information of a camera in the list.
See details in CameraInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 51,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"cameraIndexCode": "1213",
"cameraName": "Simulator Channel",
"capabilitySet": "ptz",
"encodeDevIndexCode": "85",
"recordType": "0",
"recordLocation": "1",
"regionIndexCode": "95",

136
 HikCentral Professional OpenAPI Developer Guide

"siteIndexCode": "0",
"status": 2,
"isSupportWakeUp": 0,
"wakeUpStatus": 0
},
{
"cameraIndexCode": "1212",
"cameraName": "Simulator Channel",
"capabilitySet": "ptz",
"encodeDevIndexCode": "85",
"recordType": "0",
"recordLocation": "1",
"regionIndexCode": "95",
"siteIndexCode": "0",
"status": 2,
"isSupportWakeUp": 0,
"wakeUpStatus": 0
}
]
}
}

POST /artemis/api/resource/v1/camera/advance/cameraList
Set search conditions (e.g., camera name, encoding device ID, and area ID) to search the specified
cameras, and fuzzy search is supported; if the search condition is not configured, the information
of all cameras will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/camera/advance/cameraList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

137
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
cameraName Opt. String Body Camera name, which consists
of 1 to 32 characters, but
cannot contain special
characters like ' / \ : * ? " < > |
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.
devIndexCode String Body On-board device ID. It is valid
when encodeDevIndexCode is
empty.
encodeDevInd Opt. String Body Encoding device ID, which
exCode consists of up to 64 characters.
If the ID is specified, only the
cameras of the current level
will be searched.
regionIndexCo Opt. String Body Area ID, which consists of up to
de 64 characters.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters. By default, it is
the current site.
bRecordSettin Opt. Number Body Whether to get the recording
g settings: 0-no, 1-yes (by
default). When there is a large
number of cameras, getting the
record settings will slow down
the API performance.

Request Example
{
"pageNo": 1,
"pageSize": 100,
"cameraName": "Simulator Channel",
"deviceType": "encodeDevice"
"encodeDevIndexCode": "85",
"devIndexCode": "15",

138
 HikCentral Professional OpenAPI Developer Guide

"regionIndexCode": "95",
"siteIndexCode": "0",
"bRecordSetting": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data details.

PageInfo Object Description

Parameter Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. CameraInfo[] Information of a camera in the list.
See details in CameraInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 100,
"list": [
{
"cameraIndexCode": "1213",
"cameraName": "Simulator Channel",

139
 HikCentral Professional OpenAPI Developer Guide

"capabilitySet": "ptz",
"encodeDevIndexCode": "85",
"recordType": "0",
"recordLocation": "1",
"regionIndexCode": "95",
"siteIndexCode": "0",
"status": 2,
"isSupportWakeUp": 0,
"wakeUpStatus": 0
},
{
"cameraIndexCode": "1212",
"cameraName": "Simulator Channel",
"capabilitySet": "ptz",
"encodeDevIndexCode": "85",
"recordType": "0",
"recordLocation": "1",
"regionIndexCode": "95",
"siteIndexCode": "0",
"status": 2,
"isSupportWakeUp": 0,
"wakeUpStatus": 0
}
]
}
}

Remarks
If there are multiple search conditions, they will be combined for search.

5.3.4 Organization Information

POST /artemis/api/resource/v1/org/advance/orgList
Set search conditions (e.g., organization ID, organization name, and organization status) to search
for specified organization information and fuzzy search is supported; if the search condition is not
configured, the information of all organizations will be returned by page. It is a traversing search
method and the parent node will always be included in the returned result.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/advance/orgList

140
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
orgName Opt. String Body Organization name, which
consists of up to 64 characters.
orgIndexCode Req. String Body Organization No., which
consists of up to 64 characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"orgName": "test",
"pageNo": 1,
"pageSize": 10
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.

141
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Organization information list.
list[0] Opt. Object Information of an organization in the
list. See details in OrgInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"orgIndexCode": "1",
"orgName": "root",
"parentOrgIndexCode": "0"
},
{
"orgIndexCode": "2",
"orgName": "test",
"parentOrgIndexCode": "1"
}
]
}
}

POST /artemis/api/resource/v1/org/orgIndexCode/orgInfo
Get organization information by organization ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/orgIndexCode/orgInfo

142
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User name, which cannot
contain punctuations or special
symbols like ' / \ : * ? " < > |,
and it consists of up to 32
characters.
orgIndexCode Req. String Body Organization ID, which consists
of up to 64 characters.

Request Example
{
"orgIndexCode": "3"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details); it
consists of up to 32 characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. It consists of up to 256
characters.
data Opt. Object Organization information. See details
in OrgInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"orgIndexCode": "3",
"orgName": " name_test ",
"parentOrgIndexCode": "1"

143
 HikCentral Professional OpenAPI Developer Guide

}
}

POST /artemis/api/resource/v1/org/orgList
Get the information list of all organizations, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/orgList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 100
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

144
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Organization information list.
list[0] Opt. Object Information of an organization in the
list. See details in OrgInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 3,
"pageNo": 1,
"pageSize": 100,
"list": [
{
"orgIndexCode": "1",
"orgName": "root",
"parentOrgIndexCode": "0"
},
{
"orgIndexCode": "2",
"orgName": "test",
"parentOrgIndexCode": "1"
},
{
"orgIndexCode": "3",
"orgName": " name_test ",
"parentOrgIndexCode": "1"
}
]

145
 HikCentral Professional OpenAPI Developer Guide

}
}

POST /artemis/api/resource/v1/org/parentOrgIndexCode/subOrgList
Get information list of lower-level organizations by parent organization, and all information is
returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/parentOrgIndexCode/subOrgList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User name, which cannot
contain punctuations or special
symbols like ' / \ : * ? " < > |,
and it consists of up to 32
characters.
parentOrgInde Req. String Body Parent organization No., which
xCode consists of up to 64 characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"parentOrgIndexCode": "1",
"pageNo": 1,
"pageSize": 10
}

146
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details); it
consists of up to 32 characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. It consists of up to 256
characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Organization information list.
list[0] Opt. Object Information of an organization in the
list. See details in OrgInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"orgIndexCode": "2",
"orgName": "test",
"parentOrgIndexCode": "1"
},
{
"orgIndexCode": "3",
"orgName": "name_test",
"parentOrgIndexCode": "1"
}
]

147
 HikCentral Professional OpenAPI Developer Guide

}
}

POST /artemis/api/resource/v1/org/rootOrg
Get the root organization information.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/rootOrg
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Root organization information. See
details in OrgInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {

148
 HikCentral Professional OpenAPI Developer Guide

"orgIndexCode": "1",
"orgName": "root",
"parentOrgIndexCode": "0"
}
}

POST /artemis/api/resource/v1/org/single/add
Add an organization.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/single/add
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User name, which cannot
contain punctuations or special
symbols like ' / \ : * ? " < > |,
and it consists of up to 32
characters.
parentIndexCo Req. String Body Parent organization ID, which
de consists of up to 64 characters.
orgName Req. String Body Organization name, which
consists of up to 64 characters.

Request Example
{
"orgName": "name",
"parentIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer

149
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

to Status or Error Code for details); it
consists of up to 32 characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. It consists of up to 256
characters.
data Opt. Object Organization information. See details
in OrgInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"orgIndexCode": "4",
"orgName": "name",
"parentOrgIndexCode": "1"
}
}

POST /artemis/api/resource/v1/org/single/delete
Delete an organization.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/single/delete
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User name, which cannot
contain punctuations or special
symbols like ' / \ : * ? " < > |,

150
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
and it consists of up to 32
characters.
orgIndexCode Req. String Body Organization ID, which consists
of up to 64 characters.

Request Example
{
"orgIndexCode": "4"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details); it
consists of up to 32 characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. It consists of up to 256
characters.
data Opt. String Response data details, if succeeded,
this field is null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

POST /artemis/api/resource/v1/org/single/update
Edit the information of an organization.

151
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/org/single/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
parentIndexCo Req. String Body Parent organization ID, which
de consists of up to 64 characters.
orgIndexCode Req. String Body Organization ID, which consists
of up to 64 characters.
orgName Req. String Body Organization name, which
consists of up to 64 characters.

Request Example
{
"orgName": "name_test",
"orgIndexCode": "4",
"parentIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

152
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description consists of
up to 256 characters.
data Opt. String Returned result, if succeeded, this
field is null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.3.5 Access Point Information

POST /artemis/api/resource/v1/acsDoor/region/acsDoorList
Get the information list of access points in a specified area by area ID, and the information is
returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/acsDoor/region/acsDoorList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.

153
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
regionIndexCo Req. String Body Area ID, which consists of up to
de 64 characters.

Request Example
{
"regionIndexCode": "f182356d-8647-4fd8-96d0-cf635e9293cd",
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Access point information list.
list[0] Opt. Object Information of an access point in the
list. See details in DoorInfo .

154
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"doorIndexCode": "938",
"acsDevIndexCode": "46",
"regionIndexCode": "77",
"doorNo": "6",
"doorName": "Door 01",
"doorState": 4,
"doorOutState": 4
}
]
}
}

POST /artemis/api/resource/v1/acsDoor/indexCode/acsDoorInfo
Get the information of a specified access point by access point ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/acsDoor/indexCode/acsDoorInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
doorIndexCod Req. String Body Access point ID, which consists
e of up to 64 characters.

155
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"doorIndexCode": "938"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Access point information. See details
in DoorInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"doorIndexCode": "938",
"acsDevIndexCode": "46",
"regionIndexCode": "77",
"doorNo": "6",
"doorName": "Door 01",
"doorState": 4,
"doorOutState": 4
}
}

POST /artemis/api/resource/v1/acsDoor/acsDoorList
Get the information list of all access points, and all information is returned by page.

156
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/acsDoor/acsDoorList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.

157
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Access point information list.
list[0] Opt. Object Information of an access point in the
list. See details in DoorInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 6,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"doorIndexCode": "938",
"acsDevIndexCode": "46",
"regionIndexCode": "77",
"doorNo": "6",
"doorName": "Door 01",
"doorState": 4
},
{
"doorIndexCode": "920",
"acsDevIndexCode": "37",
"regionIndexCode": "75",
"doorNo": "5",
"doorName": "Door1",
"doorState": 0,
"doorOutState": 0
}
]
}
}

POST /artemis/api/resource/v1/acsDoor/advance/acsDoorList
Set search condition (i.e., access point name, access control device ID, and area ID) to search the
specified access point, and fuzzy search is supported; if the search condition is not configured, the
information of all access points will be returned by page.

158
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/acsDoor/advance/acsDoorList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
doorName Opt. String Body Access point name, which
consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
acsDevIndexC Opt. String Body Access control device ID, which
ode consists of up to 64 characters.
regionIndexCo Req. String Body Area ID, which consists of up to
de 64 characters.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"doorName": "Door 01",
"acsDevIndexCode": "46",
"regionIndexCode": "77"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer

159
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Access point information list.
list[0] Opt. Object Information of an access point in the
list. See details in DoorInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"doorIndexCode": "938",
"acsDevIndexCode": "46",
"regionIndexCode": "77",
"doorNo": "6",
"doorName": "Door 01",
"doorState": 4,
"doorOutState": 4
}
]
}
}

160
 HikCentral Professional OpenAPI Developer Guide

POST /artemis/api/resource/v1/reader/search
Get card reader information.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/reader/search
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
doorIndexCod Req. String Body Access point ID, which consists
e of up to 64 characters.
readerIndexCo Opt. String Body Card reader ID, which consists
de of up to 64 characters.

Request Example
{
"doorIndexCode": "938"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

161
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
list Opt. Array List of card reader information.
list[0] Opt. Object Information of a card reader. See
details in ReaderInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"list": [
{
"indexCode": "5",
"name": "Cardreader 01",
"enable": 0
},
{
"indexCode": "6",
"name": "Cardreader 02",
"enable": 0
}
]
}
}

5.3.6 Vehicle Information

POST /artemis/api/resource/v1/vehicleGroup/vehicleGroupList
Get the information list of all vehicle groups, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicleGroup/vehicleGroupList

162
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 10
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.

163
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Vehicle group information list.
list[0] Opt. Object Information of a vehicle group in the
list. See details in VehicleGroupInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"vehicleGroupIndexCode": "3",
"vehicleGroupName": "group_one",
"description": ""
},
{
"vehicleGroupIndexCode": "2",
"vehicleGroupName": "1",
"description": ""
}
]
}
}

POST /artemis/api/resource/v1/vehicleGroup/single/add
Add a vehicle group.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicleGroup/single/add
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

164
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
vehicleGroup Req. String Body Vehicle group name, which
Name consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
description Opt. String Body Description, which consists of 1
to 128 characters, but cannot
contain special characters like
'/\:*?"<>|

Request Example
{
"vehicleGroupName": "test",
"description": "test"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Vehicle group information, refer to
VehicleGroupInfo for details.

Response Example
{
"code": "0",
"msg": "Success",

165
 HikCentral Professional OpenAPI Developer Guide

"data": {
"vehicleGroupIndexCode": "4",
"vehicleGroupName": "test",
"description": "test"
}
}

POST /artemis/api/resource/v1/vehicleGroup/single/update
Edit the information of a vehicle group.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicleGroup/single/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
vehicleGroupI Req. String Body Vehicle group ID, which
ndexCode consists of 1 to 64 characters.
vehicleGroup Req. String Body Vehicle group name, which
Name consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
description Opt. String Body Description, which consists of 1
to 128 characters, but cannot
contain special characters like
'/\:*?"<>|

Request Example
{
"vehicleGroupIndexCode": "4",
"vehicleGroupName": "test_mod",
"description": "test_mod"
}

166
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / /

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

POST /artemis/api/resource/v1/vehicleGroup/single/delete
Delete a vehicle group.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicleGroup/single/delete
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
vehicleGroupI Req. String Body Vehicle group ID, which
ndexCode consists of 1 to 64 characters.

167
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"vehicleGroupIndexCode": "4"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / /

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

POST /artemis/api/resource/v1/vehicle/vehicleList
Get the information list of all vehicles, and all information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicle/vehicleList

168
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
vehicleGroupI Req. String Body Vehicle group ID, which
ndexCode consists of up to 32 characters.

Request Example
{
"pageNo": 1,
"pageSize": 10
"vehicleGroupIndexCode": “1”
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.

169
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Vehicle information list.
list[0] Opt. Object Information of a vehicle in the list.
See details in VehicleInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"vehicleId": "7",
"plateNo": "888",
"plateCategory": "123",
"plateArea": 258,
"plateAreaName": "DXB",
"personName": "1 2",
"personFamilyName": "2",
"personGivenName": "1",
"phoneNo": "",
"vehicleColor": 0,
"vehicleGroupIndexCode": "1",
"effectiveDate": "2022-03-21T00:00:00+08:00",
"expiredDate": "2023-03-25T23:59:59+08:00"
}
]
}
}

POST /artemis/api/resource/v1/vehicle/indexCode/vehicleInfo
Get the information of a specified vehicle by vehicle ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicle/indexCode/vehicleInfo

170
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
vehicleIndexC Req. String Body Vehicle ID, which consists of up
ode to 32 characters.

Request Example
{
"vehicleIndexCode": "7 "
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Vehicle information. See details in
VehicleInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"vehicleId": "7",
"plateNo": "AB5555",
"plateCategory": "123",
"plateArea": 258,
"plateAreaName": "DXB",
"personName": "1 2",
"phoneNo": "",
"vehicleColor": 0,

171
 HikCentral Professional OpenAPI Developer Guide

"vehicleGroupIndexCode": "1"
"effectiveDate": "2022-03-21T00:00:00+08:00",
"expiredDate": "2023-03-25T23:59:59+08:00"
}

POST /artemis/api/resource/v1/vehicle/advance/vehicleList
Set search condition (i.e., license plate number, vehicle owner name, and owner contact number)
to search the specified vehicles, and fuzzy search is supported; if the search condition is not
configured, the information of all vehicles will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicle/advance/vehicleList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
plateNo Opt. String Body License plate number, which
consists of up to 64 characters.
personName Opt. String Body Vehicle owner name, which
consists of up to 64 characters.
phoneNo Opt. String Body Contact number of vehicle
owner, which consists of up to
64 characters.
vehicleGroupI Req. String Body Vehicle group ID, which
ndexCode consists of up to 64 characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

172
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"pageNo": 1,
"pageSize": 10,
"personName": "",
"plateNo": "N746",
"phoneNo": "",
"vehicleGroupIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Vehicle information list.
list[0] Opt. Object Information of a vehicle in the list.
See details in VehicleInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 10,
"list": [

173
 HikCentral Professional OpenAPI Developer Guide

{
"vehicleId": "20",
"plateNo": "NN7464",
"plateCategory": "123",
"plateArea": 258,
"plateAreaName": "DXB",
"personName": "test test",
"personFamilyName": "test",
"personGivenName": "test",
"phoneNo": "",
"vehicleColor": 3,
"vehicleGroupIndexCode": "1",
"effectiveDate": "2022-03-21T00:00:00+08:00",
"expiredDate": "2023-03-25T23:59:59+08:00"
}
]
}

Remarks
The search conditions, i.e., license plate number, vehicle owner name, and owner contact number,
are mutually exclusive. That is, they cannot be configured for search at same time.

POST /artemis/api/resource/v1/vehicle/single/add
Add a vehicle.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicle/single/add
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
plateNo Req. String Body License plate number, which
consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
personId Opt. String Body Person ID, which consists of up
to 128 characters.

174
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
personGivenN Opt. String Body Person's given name, which
ame consists of 1 to 256 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
personFamily Opt. String Body Person's family name, which
Name consists of 1 to 256 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
phoneNo Opt. String Body Person's contact number,
which consists of 1 to 32
characters, but cannot contain
special characters like ' / \ : * ?
"<>|
plateCategory Opt. String Body License plate type, which
consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
plateArea Opt. Number Body Area of the license plate: 0-not
supported, 60-BHR, 62-LEB, 66-
UAE, 68-OMN, 72-QAT, 77-KSA,
84-KUW, 85-SYR,90-IRQ, 93-
YMN, 94-JOR, 104-EGY, 256-
AUH, 257-FUJ, 258-DXB, 259-
RAK, 260-AJM, 261-SHJ, 262-
UAQ, 263-FED.
vehicleColor Opt. Number Body Vehicle color code: 0-other
color, 1-white, 2- sliver, 3-grey,
4-black, 5-red, 6-dark blue, 7-
blue, 8-yellow, 9-green, 10-
brown, 11-pink, 12- purple, 13-
dark blue, 14-cyan.
vehicleGroupI Req. String Body Vehicle group ID, which
ndexcode consists of up to 64 characters.
effectiveDate Req. String Body Start time of vehicle validity, in
ISO 8601 format, which is
represented by "yyyy- MM-

175
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00".
expiredDate Req. String Body Vehicle expiry date, in ISO 8601
format, which is represented
by "yyyy- MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00".

Request Example

{
"plateNo": "NN7464",
"plateCategory": "123",
"plateArea": 258,
"personId": "1149",
"phoneNo": "111111",
"vehicleColor": 3,
"vehicleGroupIndexCode": "1",
"personGivenName": "ma",
"personFamilyName": "jack",
"effectiveDate": "2022-03-21T00:00:00+08:00",
"expiredDate": "2023-03-25T23:59:59+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

176
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description can contain
up to 256 characters.
data Opt. Object Vehicle information, refer to
VehicleInfo for details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"vehicleId": "20",
"plateNo": "NN7464",
"plateCategory": "123",
"plateArea": 258,
"plateAreaName": "DXB",
"personName": "test test",
"phoneNo": "",
"vehicleColor": 3,
"vehicleGroupIndexCode": "1",
"effectiveDate": "2022-03-21T00:00:00+08:00",
"expiredDate": "2023-03-25T23:59:59+08:00"
}
}

POST /artemis/api/resource/v1/vehicle/single/update
Edit information of a vehicle.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicle/single/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

177
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
vehicleId Req. String Body Vehicle ID, which consists of up
to 65 characters.
vehicleGroupI Req. String Body Vehicle group ID, which
ndexcode consists of up to 64 characters.
plateNo Req. String Body License plate number, which
consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
plateCategory Opt. String Body License plate type, which
consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
plateArea Opt. Number Body Area of the license plate: 0-not
supported, 60-BHR, 62-LEB, 66-
UAE, 68-OMN, 72-QAT, 77-KSA,
84-KUW, 85-SYR,90-IRQ, 93-
YMN, 94-JOR, 104-EGY, 256-
AUH, 257-FUJ, 258-DXB, 259-
RAK, 260-AJM, 261-SHJ, 262-
UAQ, 263-FED.
personId Opt. String Body Person ID, which consists of up
to 128 characters.
personGivenN Opt. String Body Person's given name, which
ame consists of 1 to 256 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
personFamily Opt. String Body Person's family name, which
Name consists of 1 to 256 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
phoneNo Opt. String Body Person's contact number,
which consists of 1 to 32
characters, but cannot contain

178
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
special characters like ' / \ : * ?
"<>|
vehicleColor Opt. Number Body Vehicle color code: 0-other
color, 1-white, 2- sliver, 3-grey,
4-black, 5-red, 6-dark blue, 7-
blue, 8-yellow, 9-green, 10-
brown, 11-pink, 12- purple, 13-
dark blue, 14-cyan.
effectiveDate Req. String Body Start time of vehicle validity, in
ISO 8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00".
expiredDate Req. String Body Vehicle expiry date, in ISO 8601
format, which is represented
by "yyyy- MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00".

Request Example

{
"vehicleId": "21",
"plateNo": "74651544B",
"plateCategory": "123",
"plateArea": 258,
"plateAreaName": "DXB",
"personId": "1149",
"phoneNo": "111111111111",
"vehicleColor": 3,
"vehicleGroupIndexCode": "1",
"personFamilyName": "dong",
"personGivenName": "zhaod",
"effectiveDate": "2022-03-21T00:00:00+08:00",
"expiredDate": "2023-03-25T23:59:59+08:00"
}

179
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / /

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

POST /artemis/api/resource/v1/vehicle/single/delete
Delete a vehicle

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/vehicle/single/delete
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
vehicleId Req. String Body Vehicle ID, which consists of up
to 65 characters.

180
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"vehicleId": "12"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / /

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.3.7 Vehicle Linked to On-Board Device

POST /artemis/api/resource/v1/mobilevehicle/mobilevehicleList
Get the list of vehicles linked to on-board devices. The returned results will be displayed in page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/mobilevehicle/mobilevehicleList

181
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of
up to 32 characters, but
cannot contain special
characters like ' / \ : * ? " <
>|
pageNo Req. Number Body The current page No.,
which is between 1 and
2147483647.
pageSize Req. Number Body Number of records on
each page, which is
between 1 and 500.

Request Example
{
"pageNo": 1,
"pageSize": 10
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Vehicle information structure.

182
 HikCentral Professional OpenAPI Developer Guide

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. MobilevehivleInfo List of vehicles linked to on-board
devices.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"mobilevehicleIndexCode": "3",
"mobilevehicleName": "zhe123",
"DevIndexCode": "28",
"regionIndexCode": "1",
"status": "1",
"plateNo": "zhe123",
"personName": "ljf",
"personFamilyName": "l",
"personGivenName": "jf",
"phoneNo": "2345346",
"vehicleColor": "1",
"vehicleType": "1",
"vehicleBrand": "1"
}
]
}
}

POST /artemis/api/resource/v1/mobileVehicle/indexCode/mobileVehicleInfo
Get the information of a vehicle linked to the on-board device according to the vehicle ID.

183
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/mobileVehicle/indexCode/
mobileVehicleInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
mobilevehicleI Req. String Body ID of vehicle linked to the on-
ndexCode board device. The maximum
length is 256 characters.

Request Example
{
"mobilevehicleIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. MobilevehivleInfo Response data details.

Response Example
{
"code": "0",

184
 HikCentral Professional OpenAPI Developer Guide

"msg": "Success",
"data": {
"mobilevehicleIndexCode": "1",
"mobilevehicleName": "zhe123",
"regionIndexCode": "1",
"status": 2,
"DevIndexCode": "1",
"plateNo": "zhe123",
"personFamilyName": "",
"personGivenName": "",
"personName": "",
"phoneNo": "",
"vehicleType": -1,
"vehicleBrand": -1,
"vehicleColor": -1
}
}

POST /artemis/api/resource/v1/mobilevehicle/advanced/mobilevehicleList
Search the list of vehicles linked to on-board devices by condition. The returned results will be
displayed in page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/mobilevehicle/advanced/
mobilevehicleList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
mobilevehicle Opt. String Body Name of vehicle linked to the
Name on-board device. This field
consists of up to 32 characters,

185
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
but cannot contain special
characters like ' / \ : * ? " < >.
Fuzzy search is supported.
devIndexCode Opt. String Body Device ID. When this field is
set, results of vehicles which
are linked to the specific on-
board device will be returned.
The maximum length is 64
characters.
regionIndexCo Opt. String Body Area ID, which consists of up to
de 64 characters.

Request Example
{
"pageNo": 1,
"pageSize": 10,
"mobilevehicleName":"10.18.68.12",
"devIndexCode":"1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Vehicle information structure.

186
 HikCentral Professional OpenAPI Developer Guide

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. MobilevehivleInfo Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"mobilevehicleIndexCode": "3",
"mobilevehicleName": "zhe123",
"DevIndexCode": "28",
"regionIndexCode": "1",
"status": "1",
"plateNo": "zhe123",
"personName": "ljf",
"personFamilyName": "l",
"personGivenName": "jf",
"phoneNo": "2345346",
"vehicleColor": "1",
"vehicleType": "1",
"vehicleBrand": "1"
}
]
}
}

5.3.8 Person Information

POST /artemis/api/resource/v1/person/personList
Get the information list of all persons, and all information is returned by page.

187
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/personList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
appendInfo Opt. appendInfo [] Body Extra person information to be
returned as needed. Currently
supported values: 6-room No.,
19-​floor No. To get room No.
and floor No. information,
enter [6, 19] for this field.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"appendInfo": [6, 19]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

188
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Person information list.
list[0] Opt. Object Information of a person in the list. See
details in PersonInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 37,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"personId": "1149",
"personCode": "3536895491",
"orgIndexCode": "1",
"personName": "test test",
"personFamilyName": "test",
"personGivenName": "test",
"gender": 0,
"phoneNo": "",
"personPhoto": {
"picUri": ""
},
"email": "",
"remark": "",
"beginTime": "2021-04-25T16:19:27+08:00",
"endTime": "2031-04-25T16:19:27+08:00",
"cards": [

189
 HikCentral Professional OpenAPI Developer Guide

{
"cardNo": "234324"
}
],
"customFieldList": [
{
"id": "12",
"customFiledName": "Home Adrress",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "13",
"customFiledName": "Salary",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "14",
"customFiledName": "time",
"customFieldType": 2,
"customFieldValue": ""
}
]
},
{
"personId": "1135",
"personCode": "2357358552",
"orgIndexCode": "1",
"personName": "John",
"personFamilyName": "",
"personGivenName": "John",
"gender": 0,
"phoneNo": "",
"personPhoto": {
"picUri": "0B4E92A30AF914C1285613A4FBD9F761F"
},
"email": "",
"remark": "",
"beginTime": "2021-04-15T17:07:41+08:00",
"endTime": "2031-04-15T17:07:41+08:00",
"customFieldList": [
{
"id": "12",
"customFiledName": "Home Adrress",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "13",
"customFiledName": "Salary",
"customFieldType": 0,

190
 HikCentral Professional OpenAPI Developer Guide

"customFieldValue": ""
},
{
"id": "14",
"customFiledName": "time",
"customFieldType": 2,
"customFieldValue": ""
}
]
}
]
}
}

POST /artemis/api/resource/v1/person/personId/personInfo
Get the information of a specified person by person ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/personId/personInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
personId Req. String Body Person ID, which consists of up
to 64 characters.
appendInfo Opt. appendInfo [] Body Extra person information to be
returned as needed. Currently
supported values: 6-room No.,
19-​floor No. To get room No.
and floor No. information,
enter [6, 19] for this field.

Request Example
{
"personId": "1149",
"appendInfo": [6, 19]
}

191
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Person information. See details in
PersonInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"personId": "1149",
"personCode": "3536895491",
"personName": "test test",
"gender": 0,
"orgIndexCode": "1",
"personPhoto": {
"picUri": ""
},
"phoneNo": "",
"email": "",
"remark": "",
"beginTime": "2021-04-25T16:19:27+08:00",
"endTime": "2031-04-25T16:19:27+08:00",
"personFamilyName": "test",
"personGivenName": "test",
"cards": [
{
"cardNo": "234324"
}
],
"customFieldList": [
{
"id": "12",
"customFiledName": "Home Adrress",

192
 HikCentral Professional OpenAPI Developer Guide

"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "13",
"customFiledName": "Salary",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "14",
"customFiledName": "time",
"customFieldType": 2,
"customFieldValue": ""
}
]
}
}

POST /artemis/api/resource/v1/person/personCode/personInfo
Get person information according to person code.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/personCode/personInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
personCode Req. string Body Person code, a customized
employee ID when you add the
person, which cannot be
modified once set. The
maximum length is 64.
appendInfo Opt. appendInfo [] Body Extra person information to be
returned as needed. Currently
supported values: 6-room No.,
19-​floor No. To get room No.

193
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
and floor No. information,
enter [6, 19] for this field.

Request Example
{
"personCode": "3536895491",
"appendInfo": [6, 19]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Person information. See details in
PersonInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"personId": "1149",
"personCode": "3536895491",
"personName": "test test",
"personFamilyName": "test",
"personGivenName": "test",
"gender": 0,
"orgIndexCode": "1",
"personPhoto": {
"picUri": ""
},

194
 HikCentral Professional OpenAPI Developer Guide

"phoneNo": "",
"email": "",
"remark": "",
"beginTime": "2021-04-25T16:19:27+08:00",
"endTime": "2031-04-25T16:19:27+08:00",
"cards": [
{
"cardNo": "234324"
}
],
"CustomField": [
{
"id": "12",
"customFiledName": "Home Adrress",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "13",
"customFiledName": "Salary",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "14",
"customFiledName": "time",
"customFieldType": 2,
"customFieldValue": ""
}
]
}
}

POST /artemis/api/resource/v1/person/advance/personList
Set search condition (i.e., person name) to search the specified person, and fuzzy search is
supported; if the search condition is not configured, the information of all persons will be returned
by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/advance/personList

195
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
personName Opt. String Body Person name, which consists of
up to 32 characters, but cannot
contain special characters like
'/\:*?"<>|
appendInfo Opt. appendInfo [] Body Extra person information to be
returned as needed. Currently
supported values: 6-room No.,
19-​floor No. To get room No.
and floor No. information,
enter [6, 19] for this field.

Request Example
{
"pageNo": 1,
"pageSize": 10,
"personName": "test",
"appendInfo": [6, 19]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

196
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Person information list.
list[0] Opt. Object Information of a person in the list. See
details in PersonInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"personId": "1149",
"personCode": "3536895491",
"orgIndexCode": "1",
"personName": "test test",
"personFamilyName": "test",
"personGivenName": "test",
"gender": 0,
"phoneNo": "",
"personPhoto": {
"picUri": ""
},
"email": "",
"remark": "",
"beginTime": "2021-04-25T16:19:27+08:00",
"endTime": "2031-04-25T16:19:27+08:00",
"cards": [

197
 HikCentral Professional OpenAPI Developer Guide

{
"cardNo": "234324"
}
],
"customFieldList": [
{
"id": "12",
"customFiledName": "Home Adrress",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "13",
"customFiledName": "Salary",
"customFieldType": 0,
"customFieldValue": ""
},
{
"id": "14",
"customFiledName": "time",
"customFieldType": 2,
"customFieldValue": ""
}
]
}
]
}
}

POST /artemis/api/resource/v1/person/picture_data
Get the URI of profile picture uploaded when adding person, and then download the picture from
Recording Server according to the URL.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/picture_data
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
domainId Opt. Number Header Domain ID, which consists of
up to 32 characters.
picUri Req. String Body Relative URI of picture, which is
returned when adding persons.

198
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
And the URI contains up to 256
characters.
personId Req. String Body Person ID, which is returned
when adding persons. And the
ID contains up to 64 characters.

Request Example
{
"personId": "1135",
"picUri": "0B4E92A30AF914C1285613A4FBD9F761F"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. String Returned picture data.

Response Example
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls
49L0y20yFyy29ukSs3UhVAB/SigyEjFFG5+2RioRUV0P/2Q=="
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls4
9L0y20yFyy29ukSs3UhVAB/SigyEjFFG5+2RioRUV0P/2Q=="

POST /artemis/api/resource/v1/person/single/add
Add a person.

199
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/single/add
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
personCode Opt. String Body Person code, a customized
employee ID when you add the
person, which cannot be
modified once set. The
maximum length is 16.
personGivenN Req. String Body Person name, which consists of
ame up to 256 characters.
personFamily Req. String Body Person's last name, which
Name consists of up to 256
characters.
gender Opt. String Body 1-male, 2-female, 0-unknown.
orgIndexCode Req. String Body Person's organization ID.
phoneNo Opt. String Body Person's mobile phone number.
email Opt. String Body Person's email address.
faces Opt. Array Body Face information list.
faces[0] Opt. Object Body Information of a face in the list,
refer to face for details.
fingerPrint Opt. Array Body Fingerprint information list.
fingerPrint[0] Opt. Object Body Information of a fingerprint in
the list, refer to FingerPrint for
details.
remark Opt. String Body Remarks, which consists of up
to 128 characters.
cards Opt. Array Body Card information list.

200
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
cards[0] Opt. Object Body Information of a card in the list,
refer to Card for details.
beginTime Opt. String Body Start time in ISO 8601 format,
which is represented by "yyyy-
MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64 bytes.
endTime Opt. String Body End time in ISO 8601 format,
which is represented by "yyyy-
MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64 bytes.
residentRoom Opt. Number Body Resident room No.: [1, 9999].
No
residentFloor Opt. Number Body Resident floor No.: [1, 999].
No

Request Example
{
"personCode": "123245214",
"personFamilyName": "LI",
"personGivenName": "person0",
"gender": 1,
"orgIndexCode": "1",
"remark": "description",
"phoneNo": "13000110011",
"email": "[email protected]",
"cards": [
{
"cardNo": "123456"
}
],
"beginTime": "2020-05-26T15:00:00+08:00",
"endTime": "2030-05-26T15:00:00+08:00"
}

201
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. String Added person ID.

Response Example
{
"code": "0",
"msg": "Success",
"data": "1150"
}

POST /artemis/api/resource/v1/person/single/update
Edit a person's information.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/single/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot

202
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
personId Req. String Body Person ID, GUID allocated by
system and for internal use.
The maximum length is 16.
personCode Opt. String Body Person code, a customized
employee ID when you add the
person, which cannot be
modified once set. The
maximum length is 16.
personGivenN Opt. String Body Person name, which consists of
ame up to 256 characters.
personFamily Opt. String Body Person's last name, which
Name consists of up to 256
characters.
gender Opt. Number Body 1-male, 2-female, 0-unknown.
orgIndexCode Opt. String Body Person's organization ID. This
field is not required when
editing the person's name.
phoneNo Opt. String Body Person's mobile phone number.
email Opt. String Body Person's email address.
remark Opt. String Body Remarks, which consists of up
to 128 characters.
cards Opt. Array Body Card information list.
cards[0] Opt. Object Body Information of a card in the list,
refer to Card for details.
beginTime Opt. String Body Start time in ISO 8601 format,
which is represented by "yyyy-
MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64 bytes.

203
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
endTime Opt. String Body End time in ISO 8601 format,
which is represented by "yyyy-
MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64 bytes.
residentRoom Opt. Number Body Resident room No.: [1, 9999].
No
residentFloor Opt. Number Body Resident floor No.: [1, 999].
No

Request Example
{
"personId": "1150",
"personCode": "123245214",
"personFamilyName": "Li",
"personGivenName": "person0",
"orgIndexCode": "1",
"gender": 1,
"phoneNo": "13000110011",
"remark": "description",
"email": "[email protected]",
"cards": [
{
"cardNo": "123456"
}
],
"beginTime": "2022-05-26T15:00:00+08:00",
"endTime": "2030-05-26T15:00:00+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

204
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. String Response result, if succeeded, this
field is null.

Response Example
{
"code": "0",
"msg": "ok",
"data":””
}

POST /artemis/api/resource/v1/person/single/delete
Delete a person.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/single/delete
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
personId Req. String Body Person ID, which is returned
when adding person and
consists of up to 64 characters.
If this field is not configured,

205
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
the platform will automatically
generate an ID.

Request Example
{
"personId ": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. String Response details, if succeeded, this
field is null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

POST /artemis/api/resource/v1/person/face/update
Edit the information of face linked with the person.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/face/update

206
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
personId Req. String Body Person ID, which is returned
when adding person and
consists of up to 16 characters.
If this field is not configured,
the platform will automatically
generate an ID.
faceData Req. String Body Face information of the person
encoded by Base64.

Request Example
{
"personId": "1",
"faceData": " AQSkzFYSEbxpSTWIl7lb2dtYSUW4"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. String Response result, if succeeded, this
field is null.

207
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data":””
}

POST /artemis/api/resource/v1/person/fingerPrints/update
Edit the information of fingerprints linked with the person.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/fingerPrints/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
personId Req. String Body Person ID, which is returned
when adding person and
consists of up to 16 characters.
If this field is not configured,
the platform will automatically
generate an ID.
fingerPrint Opt. Array Body Fingerprint information list.
fingerPrint[0] Opt. Object Body Information of a fingerprint in
the list, refer to FingerPrint for
details.

Request Example
{
"personId": "1",
"fingerPrint": [
{
"fingerPrintIndexCode": "1",
"fingerPrintName": "fringe_pringt_01",

208
 HikCentral Professional OpenAPI Developer Guide

"fingerPrintData": "228697F1AD0146C8D00",
"relatedCardNo": "1123"
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Array List of fingerprint updating results.
data[0] Opt. Object A fingerprint updating result in the
list, see details in
fingerPrintUpdateResult .

Response Example
{
"code": "0",
"msg": "Success",
"data":””
}

POST /artemis/api/resource/v1/person/customFields
Get the person's custom information list, and all the information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/customFields

209
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.

210
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Persons' custom information list.
list[0] Opt. Object Custom information about a person.
See details in CustomField .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 3,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"id": "12",
"customFiledName": "Home Adrress",
"customFieldType": 0
},
{
"id": "13",
"customFiledName": "Salary",
"customFieldType": 0
}
]
}
}

POST /artemis/api/resource/v1/person/personId/customFieldsUpdate
Edit the person's custom information.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/personId/
customFieldsUpdate
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

211
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
personId Req. String Body Person ID, which consists of up
to 64 characters.
list Opt. Array Body List of person custom
information.
list[0] Opt. Object Body Custom information of a
person. See details in
CustomField .

Request Example
{
"personId": "1150",
"list": [
{
"id": "12",
"customFiledName": "ssss",
"customFieldType": 2,
"customFieldValue": "2354"
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

212
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

POST /artemis/api/acs/v1/faceCheck
Verify the validity of face picture (a few seconds are required for verifying a picture). Currently, the
API is only supported by the MinMoe (i.e., Face Recognition Terminal). It is used for linking face
picture to the person when adding a person.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/faceCheck
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
faceData Req. String Body Face picture data (Base64).
acsDevIndexC Req. String Body Access control device ID, which
ode consists of up to 64 characters.

Request Example
{
"faceData": "4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K",
"acsDevIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer

213
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data":””
}

POST /artemis/api/resource/v1/person/customFields/single/add
Add a custom field.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/customFields/single/add
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
customFieldLis Opt. CustomField [] Body List of custom fields. See details
t in CustomField .

Request Example
{
"customFieldList": {

214
 HikCentral Professional OpenAPI Developer Guide

"customField": [
{
"customFieldName": "123",
"customFieldType": 0,
"presetValueList": {
"presetValue": [
{
"value": "0",
"ID": "1"
}
]
},
"isPublic": 0,
"isShow": 1
}
]
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data":{
"Id": "1",
"customFieldName": "wwww",
"customFieldType": 0,
"isPublic": 0
}
}

215
 HikCentral Professional OpenAPI Developer Guide

POST /artemis/api/resource/v1/person/customFields/single/modify
Edit the custom field information.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/customFields/single/modify
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
customFieldLis Opt. CustomField [] Body List of custom fields. See details
t in CustomField .

Request Example
{
"customFieldList": {
"customField": [
{
"customFieldId": "1",
"customFieldName": "123",
"isShow": 1,
"customFieldName": 3,
"presetValueList": {
"presetValue": [
{
"value": "0",
"ID": "1"
}
]
}
}
]
}
}

216
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data":""
}

POST /artemis/api/resource/v1/person/customFields/single/delete
Delete a custom field. Custom fields related to person information in the AD domain cannot be
deleted.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/person/customFields/single/delete
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
customFieldId Req. String Body Custom field ID.

217
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"customFieldId": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.3.9 Face Comparison Group

POST /artemis/api/frs/v1/face/group
Set search condition (i.e., group ID and group name) to search the specified face comparison
groups, and fuzzy search is supported; if the search condition is not configured, the information of
all face comparison groups will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face/group

218
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
indexCodes Opt. Array Body A set of face comparison group
IDs, currently, only one ID is
supported. And each ID
consists of up to 64 characters.
indexCodes[0] Opt. String Body A face comparison group ID in
the list.
name Opt. String Body Name of face comparison
group, which consists of 1 to 32
characters, but cannot contain
special characters like ' / \ : * ?
" < >. It is for fuzzy search.

Request Example
{
"indexCodes": [
"2"
],
"name": ""
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

219
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description consists of
up to 256 characters.
data Opt. Array Information list of face comparison
groups.
data[0] Opt. Object Information of a face comparison
group in the list. See details in
FaceGroupInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"list": [
{
"indexCode": "2",
"name": "test_group",
"description": ""
}
]
}
}

POST /artemis/api/frs/v1/face/group/batch/deletion
Delete a face comparison group by group ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face/group/batch/deletion
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

220
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
indexCode Req. Array of String Body Array of face comparison group
IDs, but currently, only one ID
can be set in the array. If no ID
or multiple IDs are specified,
error will be returned.

Request Example
{
"indexCodes": [
"1"
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description consists of
up to 256 characters.
data Opt. String Response details, if succeeded, this
field is null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

221
 HikCentral Professional OpenAPI Developer Guide

Remarks
The validity of face comparison group ID will be checked when deleting by ID, if the ID is invalid,
error will be returned.

POST /artemis/api/frs/v1/face/group/single/addition
Add a face comparison group, and the group ID will be returned after adding.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face/group/single/addition
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
name Req. String Body Name of face comparison
group, which consists of 1 to 32
characters, but cannot contain
special characters like ' / \ : * ?
" < >. It is for fuzzy search.
description Opt. String Body Description of face comparison
group, which contains 1 to 128
characters, but cannot contain
special characters like ' / \ : * ?
"<>

Request Example
{
"name": "name",
"description": "test"
}

222
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description consists of
up to 256 characters.
data Opt. Array Information list of face comparison
groups.
data[0] Opt. Object Information of a face comparison
group in the list. See details in
FaceGroupInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"indexCode": "1",
"name": "name",
"description": "test"
}
}

POST /artemis/api/frs/v1/face/group/single/update
Edit information of a face comparison group.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face/group/single/update

223
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
indexCode Req. String Body Face comparison group IDs,
which can be obtained by
searching for face comparison
groups by condition. The ID
consists of up to 10 characters.
name Req. String Body Name of face comparison
group, which consists of 1 to 32
characters, but cannot contain
special characters like ' / \ : * ?
" < >. It is for fuzzy search.
description Opt. String Body Description of face comparison
group, which contains 1 to 128
characters, but cannot contain
special characters like ' / \ : * ?
" < >. This field will be set to
null if no value is transmitted
to.

Request Example
{
"indexCode": "1",
"name": "name_mod",
"description": "test_mod"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

224
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description consists of
up to 256 characters.
data Opt. String Response details, if succeeded, this
field is null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

Remarks
If the face comparison group to be edited is already added to the identification schedule, after
editing, the changed information will also be applied to device.

POST /artemis/api/frs/v1/face/groupList
Get face comparison group list.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face/groupList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

225
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 6
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.

226
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Information list of face comparison
groups.
list[0] Opt. Object Information of a face comparison
group in the list. See details in
FaceGroupInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 500,
"list": [
{
"indexCode": "2",
"name": "test_group",
"description": ""
},
{
"indexCode": "1",
"name": "1111@@@@@@@@",
"description": "erryttttttttttttttttttttttttttt###"
}
]
}
}

POST /artemis/api/frs/v1/plan/recognition/black/restart
Apply all faces' information of the face comparison group to the linked device.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/plan/recognition/black/restart

227
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
indexCode Req. String Body Array of face comparison group
IDs, but currently, only one ID
can be set in the array. If no ID
or multiple IDs are specified,
error will be returned.

Request Example
{
"indexCodes": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description consists of
up to 256 characters.
data Opt. String Response details, if succeeded, this
field is null.

Response Example
{
"code": "0",
"msg": "Success",

228
 HikCentral Professional OpenAPI Developer Guide

"data": ""
}

POST /artemis/api/aiapplication/v1/face/faceMatchRecord
Search for the face comparison information by camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/aiapplication/v1/face/faceMatchRecord
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
cameraIndexC Opt. String Body Camera ID, the maximum
odes length is 1024 characters. Use
comma to separate multiple
items. Up to 10 IDs are
allowed.
personIndexC Opt. String Body Person ID, the maximum length
odes is 1024 characters. Use comma
to separate multiple items. Up
to 10 IDs are allowed.
faceGroupInde Opt. String Body Face comparison group ID, the
xCodes maximum length is 1024
characters. Use comma to
separate multiple items. Up to
10 IDs are allowed.
startTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:

229
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
yyyy-MM-
dd'T'HH:mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00.
And the time consists of up to
64 characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:
yyyy-MM-
dd'T'HH:mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00.
And the time consists of up to
64 characters.
temperatureSt Opt. Number Body Temperature status: -1 (all), 0
atus (unknown), 1 (normal), 2
(exception).
maskStatus Opt. Number Body Mask status: -1 (all), 0
(unknown), 1 (wearing mask), 2
(no mask).
temperatureT Opt. String Body Temperature threshold.
hreshold

Request Example
{
"pageNo":1,
"pageSize":20,
"cameraIndexCodes":"1",
"statisticsType":0,
"startTime":"2018-07-26T15:00:00+08:00",
"endTime":"2018-07-26T16:00:00+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

230
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array List of face comparison information.
list[0] Opt. FaceMatchRecord Face comparison information.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"completeness":1,
"pageNo":1,
"pageSize":20,
"list":[{
"time":"2018-07-26T15:00:00+08:00",
"cameraIndexCode":"1",
"exitNum":5,
"enterNum":1
}]
}
}

5.3.10 Face Information

POST /artemis/api/frs/v1/application/picture
Download the picture according to the specified URL.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/application/picture

231
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
url Req. String Body Picture URL, which should start
with "Dev://", "Server"//", and
"Vsm://". The URL consists of
up to 256 characters.
isHumanSearc Opt. Number Body Device used for search of
hPic matched human bodies/faces:
0-default value when this field
is not configured, and value for
circumstances except for 1, 2,
or 3; 1-Intelligent Fusion
Server; 2-DeepinMind NVR
accessed via SDK; 3-
DeepinMind NVR accessed via
ISUP.
encodeDevice Opt. String Body ID of DeepinMind NVR device
Code accessed by SDK protocol,
specially used for search via
picture comparison.

Request Example
{
"url": "Dev://picture/Streaming/tracks/303/?name=405812&size=405812&DEVICE=26&TYPE=0&VSM=0",
"isHumanSearchPic": 0
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

232
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description consists of
up to 256 characters.
data Opt. / Picture data.

Response Example
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls49L0y20yFyy29ukSs3UhVAB/
SigyEjFFG5+2RioRUV0P/2Q=="
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls49L0y20yFyy29ukSs3UhVAB/
SigyEjFFG5+2RioRUV0P/2Q=="

POST /artemis/api/frs/v1/face
Search face information in a specified face comparison group.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
faceGroupInde Req. String Body Face comparison group ID,
xCode which can be obtained by
getting face comparison group
by condition.

233
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"faceGroupIndexCode": "1",
"pageNo": 1,
"pageSize": 20
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Face information list.
list[0] Opt. Object Information of a face in the list. See
details in FaceInfo .

234
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1
"pageNo": 1,
"pageSize": 20,
"list": [
{
"indexCode": "4",
"faceInfo": {
"personGivenName": "san",
"personFamilyName": "zhang",
"sex": "1"
},
"facePic": {
"faceUrl": "/9j/4AAQSkZJRgABAQEAAAAAAAD/4QBCRXhpZgAATU"
}
}
]
}
}

POST /artemis/api/frs/v1/face/deletion
Remove the information of a face from a specified face comparison group.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face/deletion
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
indexCodes Req. Array of String Body Array of person IDs, but
currently, only one ID can be
set in the array. If no ID or

235
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
multiple IDs are specified, error
will be returned.
faceGroupInde Req. String Body Face comparison group ID,
xCode which can be obtained by
getting face comparison group
by condition.
deleteFromOr Opt. String Body Whether to remove from the
g organization: "0" or null-no,
"1"-yes.

Request Example
{
"indexCodes": [
"4"
],
"faceGroupIndexCode": "1",
"deleteFromOrg":"0"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description consists of
up to 256 characters.
data Opt. String Response details, if succeeded, this
field is null.

236
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

POST /artemis/api/frs/v1/face/single/addition
Add the information of a face.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/face/single/addition
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
personIndexC Opt. String Body Person ID in the person list, if
ode this field is configured, the
person to be added is from the
person list, and the fields
faceInfo and facePic are
invalid.
faceGroupInde Req. String Body ID of face comparison group
xCode that the face information to be
added to. The ID can be
obtained by getting face
comparison group by
condition.
faceInfo Opt. Object Body Face information. See details in
FaceInfo .
facePic Req. Object Body Face picture data. See details in
facePic .

237
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"personIndexCode": "1",
"faceGroupIndexCode": "1",
"faceInfo": {
"personGivenName": "san",
"personFamilyName": "zhang",
"sex": "1"
},
"facePic": {
"faceBinaryData": "/9j/4AAQSkZJRgABAQEAAAAAAAD/4QBCRXhpZgAATU"
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code consists of up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description consists of
up to 256 characters.
data Req. Object Response data details.
indexCode Req. String Face ID.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"indexCode": "4"
}
}

238
 HikCentral Professional OpenAPI Developer Guide

5.3.11 Alarm Input/Output Information

POST /artemis/api/resource/v1/alarmInput/advance/alarmInputList
Set search condition (input alarm name, device ID, area ID, etc.) to search for the alarm input
information; if the search condition is not configured, all alarm input information will be returned
by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/alarmInput/advance/alarmInputList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
alarmInputNa Opt. String Body Alarm input name, which
me consists of up to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.
devIndexCode Opt. String Body Device ID, which consists of up
to 64 characters. If the ID is
specified, only the cameras of

239
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
the current level will be
searched for.
regionIndexCo Opt. String Body Area ID, which consists of up to
de 64 characters.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"alarmInputName": "D1_0.0.0.0",
"devIndexCode": "85",
"regionIndexCode": "95"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Alarm input information list.
list[0] Opt. Object A specific alarm input information.
See details in AlarmInputInfo .

240
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"alarmInputIndexCode": "1215",
"alarmInputName": "D1_0.0.0.0",
"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"networkStatus": 2
}
]
}
}

POST /artemis/api/resource/v1/alarmInputs
Get the alarm input information list, and all the information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/alarmInputs
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.

241
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.

242
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Alarm input information list.
list[0] Opt. Object Specific alarm input information. See
details in AlarmInputInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 129,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"alarmInputIndexCode": "1215",
"alarmInputName": "D1_0.0.0.0",
"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"networkStatus": 2
},
{
"alarmInputIndexCode": "1214",
"alarmInputName": "A1",
"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"networkStatus": 2
}
]
}
}

POST /artemis/api/resource/v1/alarmInputs/indexCode
Get the alarm input information according to alarm input ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/alarmInputs/indexCode

243
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
alarmInputInd Req. String Body Alarm input ID, which consists
exCode of up to 64 characters.

Request Example
{
"alarmInputIndexCode": "1215"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Alarm input information. See details
in AlarmInputInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"alarmInputIndexCode": "1215",
"alarmInputName": "D1_0.0.0.0",
"regionIndexCode": "95",

244
 HikCentral Professional OpenAPI Developer Guide

"devIndexCode": "85",
"devResourceType": "encodeDevice",
"networkStatus": 2
}
}

POST /artemis/api/resource/v1/alarmOutput/advance/alarmOutputList
Set search condition (output alarm name, device ID, area ID, etc.) to search for the alarm output
information; if the search condition is not configured, all alarm output information will be returned
by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/alarmOuput/advance/
alarmOutputList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
alarmOutputN Opt. String Body Alarm output name, which
ame consists of up to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.

245
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
devIndexCode Opt. String Body Device ID, which consists of up
to 64 characters. If the ID is
specified, only the cameras of
the current level will be
searched for.
regionIndexCo Opt. String Body Area ID, which consists of up to
de 64 characters.

Request Example
{
"pageNo": 1,
"pageSize": 10,
"alarmOutputName": "0.0.0.0",
"devIndexCode": "85",
"regionIndexCode": "95"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.

246
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Alarm output information list.
list[0] Opt. Object A specific alarm output information.
See details in AlarmOutputInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"alarmOutputIndexCode": "1218",
"alarmOutputName": "D2_0.0.0.0",
"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"status": -1
},
{
"alarmOutputIndexCode": "1217",
"alarmOutputName": "D1_0.0.0.0",
"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"status": -1
}
]
}
}

POST /artemis/api/resource/v1/alarmOutput/controlling
Control alarm output.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/alarmOutput/controlling

247
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
alarmOutputI Req. String Body Alarm output ID, which consists
ndexCode of up to 64 characters.
action Req. Number Body Operation: 0-disable alarm
output, 1-enable alarm output.

Request Example
{
"alarmOutputIndexCode": "1",
"action": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",

248
 HikCentral Professional OpenAPI Developer Guide

"data": ""
}

POST /artemis/api/resource/v1/alarmOutputs
Get the alarm output information list, and all the information is returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/alarmOutputs
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
deviceType Opt. String Body Device type (mobileDevice,
encodeDevice (default),
acsDevice), which consists of
up to 128 characters. Use
comma to separate multiple
items.

Request Example
{
"pageNo": 1,
"pageSize": 2
}

249
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Alarm output information list.
list[0] Opt. Object Specific alarm output information.
See details in AlarmOutputInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 81,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"alarmOutputIndexCode": "1218",
"alarmOutputName": "D2_0.0.0.0",
"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"status": -1
},
{
"alarmOutputIndexCode": "1217",
"alarmOutputName": "D1_0.0.0.0",

250
 HikCentral Professional OpenAPI Developer Guide

"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"status": -1
}
]
}
}

POST /artemis/api/resource/v1/alarmOutputs/indexCode
Get the alarm output information according to alarm output ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/resource/v1/alarmOutputs/indexCode
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
alarmOutputI Req. String Body Alarm output ID, which consists
ndexCode of up to 64 characters.

Request Example
{
"alarmOutputIndexCode": "1218"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

251
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Alarm output information. See details
in AlarmOutputInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"alarmOutputIndexCode": "1218",
"alarmOutputName": "D2_0.0.0.0",
"regionIndexCode": "95",
"devIndexCode": "85",
"devResourceType": "encodeDevice",
"status": -1
}
}

5.4 Video API

Here provides APIs for getting streaming URL for live view, playback, and two-way audio, preset
management, patrol management, PTZ control, getting real-time people counting statistics, and so
on.

5.4.1 POST /artemis/api/aiapplication/v1/people/statisticsTotalNumByTime

Get people counting statistics of a specified camera by minute, hour, day, and month.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/aiapplication/v1/people/
statisticsTotalNumByTime

252
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
' / \ : * ? " < > |.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
cameraIndexC Req. String Body Camera ID, and the maximum
odes length is 1024 bytes. For
multiple IDs, each two ones
should be separated by comma
and up to 10 IDs are allowed.
statisticsType Req. Number Body Statistics type: 0-by hour, 1-by
day, 2-by month, 4-by minute.
startTime Req. String Body Start time in ISO 8601 format
of search, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07-26T15:00:00+08:00".
The maximum length is 64
bytes.
endTime Req. String Body End time in ISO 8601 format of
search, which is represented by
"yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07-26T15:00:00+08:00".
The maximum length is 64
bytes.

Request Example
{
"pageNo": 1,
"pageSize": 20,

253
 HikCentral Professional OpenAPI Developer Guide

"cameraIndexCodes": "1",
"statisticsType": 0,
"startTime": "2018-07-26T15:00:00+08:00",
"endTime": "2018-07-26T16:00:00+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
completeness Opt. Number Whether the data is complete: 0-no,
1-yes.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array People counting statistics list.
list[0] Opt. Object People counting statistics of an item
in the list. See details in
PeopleCountInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"completeness": 1,
"pageNo": 1,
"pageSize": 20,
"list": [
{
"time": "2018-07-26T15:00:00+08:00",
"cameraIndexCode": "1",

254
 HikCentral Professional OpenAPI Developer Guide

"exitNum": 5,
"enterNum": 1
}
]
}
}

5.4.2 POST /artemis/api/aiapplication/v1/people/resourceGroupRealTimeCount

Get the real-time statistics of resource groups.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/aiapplication/v1/people/
resourceGroupRealTimeCount
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
resourceGrou Req. String Body Resource group ID, the
pIndexCodes maximum length is 1024
characters. Up to 10 group IDs
are allowed. Use comma to
separate different IDs.

Request Example
{
"resourceGroupIndexCodes":"1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

255
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
list Opt. Array List of the real-​time statistics of
resource groups.
list[0] Opt. RealPeopleCountI The real-​time statistics of a resource
nfo group.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"list":[{
"time":"2018-07-26T15:00:00+08:00",
"cameraIndexCode":"1",
"exitNum":5,
"enterNum":1
}]
}
}

5.4.3 POST /artemis/api/aiapplication/v1/people/advance/resourceGroupList

Get the list of resource groups.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/aiapplication/v1/people/advance/
resourceGroupList

256
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
siteIndexCode Opt. String Body Site ID, which consists of up to
64 characters.
name Opt. String Body Name of the resource group.
resourceGrou Opt. String Body Resource group ID. Use comma
pIndexCodes to separate different IDs.

Request Example
{
"pageNo": 1,
"pageSize": 10
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.

257
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

data Opt. Object Response data details.
total Opt. Number Total number of matched results, the
maximum length is 32 characters.
pageNo Opt. Number The current page No, the maximum
length is 32 characters.
pageSize Opt. Number Number of records on each page, the
maximum length is 32 characters.
list Opt. Array List of resource groups.
list[0] Opt. ResourceGroupInf Information about a resource group.
o

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"total":2,
"pageNo":1,
"pageSize":10,
"list":
}
}

5.4.4 POST /artemis/api/aiapplication/v1/people/statisticsHeatMapByTime

Get the heat map information of a specific camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/aiapplication/v1/people/
statisticsHeatMapByTime
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

258
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 1024 characters.
statisticsType Req. Number Body Heat map type: 0 (dwell
duration), 1 (number of
people).
beginTime Req. String Body Start time of search, in ISO
8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64 bytes.
endTime Req. String Body End time of search, in ISO 8601
format, which is represented
by "yyyy- MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 bytes.

Request Example
{
"cameraIndexCode": "1",
"statisticsType": 0,
"beginTime": "2022-02-16T15:00:00+08:00",
"endTime": "2022-02-16T16:00:00+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

259
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. PageInfo Response data details.

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

maxValue Req. Number The maximum heat value.
minValue Req. Number The minimum heat value.
arrayLine Req. Number Average heat value.
arrayLine Req. Number Row value of map pixels. When this
field is 0, the pixel data information
does not exist.
arrayColum Req. Number Column value of map pixels. When
this field is 0, the pixel data
information does not exist.
buffer Opt. String Heat map pixel data information
(base64).

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"maxValue": -1,
"minValue": -1,
"averageValue": -1,
"arrayLine": -1,
"arrayColum": -1,
"buffer": ""
}
}

260
 HikCentral Professional OpenAPI Developer Guide

5.4.5 POST /artemis/api/video/v1/cameras/playbackURLs

Get the streaming URL for playback.

Note
● During playback by RTSP_s, RTMP or HLS, follow the following format: URL +
"&beginTime=2022-06-24T22:59:48.000-07:00&endTime=2022-06-25T00:46:36.000-07:00".
● Audio playback via HLS and RTMP only supports Advanced Audio Coding (AAC).
● Get the streaming URL for playback via the following protocols: RTSP, RTSP_S, WebSocket,
WebSocket_S, RTMP (H.264 video encoding only), and HLS (Cloud Storage 2.2.8 above and CVR
3.2.8 above; H.264 video encoding only)
● Supports searching by device time in DST in ISO 8601 format, which is represented by "yyyy-
MMddTHH: mm:ss+current time difference". When you are searching by the same time in and
out of DST, you can differentiate them by the current time difference, e.g., searching for
recordings from 2022-11-06T01:10:00-07:00 to 2022-11-06T01:10:00-08:00 means searching for
recordings from 1:10 in DST and 1:10 out of DST, i.e., the duration is an hour.
● Supports streaming from cameras on remote sites. For cascaded streaming via two streaming
media, only RTSP and RTSP_S are supported.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/cameras/playbackURLs
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
domainId Opt. Number Header Domain ID.
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
recordType Req. String Body Recording types, i.e., "0" (main
recording) and "1" (auxiliary
recording). And this field can
contain up to 32 characters.
protocol Opt. String Body Streaming protocol (application
layer protocol) types: "rtsp"

261
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
(default) and "websocket" (for
JsDecoder SDK), "rtsp_s" (for
getting stream via standard
RTSP), "websocket_s", "hls",
"rtmp". And this field can
contain up to 64 characters.
transmode Opt. Number Body Transfer protocol types: 0-UDP,
1-TCP (default). And this field is
valid when the protocol is set
to "rtsp".
beginTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:
yyyy-MM-
dd'T'HH:mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00.
And the time consists of up to
64 characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:
yyyy-MM-
dd'T'HH:mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00.
And the time consists of up to
64 characters.
uuid Opt. String Body ID for searching by page, which
consists of up to 64 characters.
This UUID is returned after the
previous search and it is used
for the next search of
remaining videos. By default, it
is "null".
mergeSegmen Opt. Number Body Whether to merge returned
t recordings according to the
request time parameter: 0-(by
default) return recordings by
the recording time on device,
1-return recordings by the time

262
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
from request parameters (auto-
segmented by the min. valid
interval).
storageLocatio Opt. Number Body Storage location of the camera
n on the remote site, valid for
searching for playback URL of
cameras on remote sites: 0-
central storage (by default), 1-
remote storage.

Note
The days between start time and end time should be no more than three days.

Request Example
{
"beginTime":"2021-04-26T00:00:00+08:00",
"endTime":"2021-04-26T01:00:00+08:00",
"cameraIndexCode":"19",
"recordType":"0",
"protocol":"rtsp",
"transmode":"1",
"uuid":""
"mergeSegment": 0,
"storageLocation": 0
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

263
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description can contain
up to 256 characters.
data Opt. Object Playback URL and video segment
information. See details in
PlaybackUrlVideoInfo and VideoInfo .

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"url":"[sms:playback]rtsp://10.41.13.178:554/file/dvr://10.41.7.143:8001/0/channels/33?tcpport=10000",
"authentication":"J3mnUxvJ4vcJ5vdN25FrX/Xru/
5fhLD7DbVcYjWNobrt6NhHuwqYwWxulqfWcFPWhRyeWPi7V4bqkbEiVj9NEuRyrx5VkgoZRF9vrR6MJAcRef96KJfnBEdfKg
VbPBOsF4nSeIxElU5oEE2dBWJMsRKETW7QAhMQXcB2e/SY6NXcHZ/QmE4v27j3H2Y3eJWvjrFwfMSITcThZJPhv1nLGYz
+BVo+zSTKaVX6VP3DeTeiDpQtX0Dvq82+zyAyNBVVehAht3QKVf5DCOsr8o65o8HEEdq+e/
mvrZ4N3EcxadJrMcJmbtIn2YKm7SAbxrCQw2hrnwwDhi0nKYSJJSzfvA==",
"uuid":"",
"recordLocation":1
}
}

5.4.6 POST /artemis/api/video/v1/cameras/previewURLs

Get the streaming URL for live view via protocols including RTSP, RTSP_S, WebSocket,
WebSocket_S, RTMP, and HLS. Streaming via RTMP and HLS only supports H.264 video encoding.
Audio streaming only supports Advanced Audio Coding (AAC).

Note
Supports streaming from cameras on remote sites. For cascaded streaming via two streaming
media, only RTSP and RTSP_S are supported.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/cameras/previewURLs

264
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
domainId Opt. Number Header Domain ID, which consists of
up to 32 characters.
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
streamType Opt. Number Body Stream types: 0-main stream
(default), 1-sub-stream.
protocol Opt. String Body Streaming protocol (application
layer protocol) types: "rtsp"
(default), "websocket" (for
JsDecoder SDK), "rtsp_s" (for
getting stream via standard
RTSP), "websocket_s", "hls",
"rtmp". And this field can
contain up to 16 characters.
transmode Opt. Number Body Transfer protocol types: 0-UDP,
1-TCP (default).
requestWebso Opt. Number Body Streaming type of websocket:
cketProtocol 0-ws, 1-wss. This parameter is
required when the value of
protocol is "websocket".

Request Example
{
"cameraIndexCode":"1",
"streamType":0,
"protocol":"rtsp",
"transmode":1
}

265
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Streaming URL information. See
details in UrlInfo .

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"url":"[sms:preview]rtsp://10.41.13.178:554/hikvision://10.41.7.66:8001:0:0",
"authentication":"Fsd8eugj2+RYG6EKEgN8/EHy6o5XPdkxD8t7Dy+EH6moE4G0X9+60C7PucJ8TlZOJHpXlM0y
+DwPdkSiALHgLmcWShmtWnKnfD5lhfDSMakMUxtlqfqOalXw5AAcSxoz76LkR8qzI8lKncuhXO9RslvYiC0UJN/
b3tmwUH999oWgJbX6jd3mN/p3FPgi4NtkbADKKnmjEY8NI9cPDcHaMfV+oJCYF0aVCjI3BU9AnPY="
}
}

5.4.7 POST /artemis/api/video/v2/cameras/previewURLs

Batch get streaming URLs for live view via protocols including RTSP, RTSP_S, WebSocket,
WebSocket_S, RTMP, and HLS. Streaming via RTMP and HLS only supports H.264 video encoding.
Audio streaming only supports Advanced Audio Coding (AAC).

Note
Supports streaming from cameras on remote sites. For cascaded streaming via two streaming
media, only RTSP and RTSP_S are supported.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v2/cameras/previewURLs

266
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
domainId Opt. Number Header Domain ID, which consists of
up to 32 characters.
cameraIndexC Req. String Body Camera IDs, which consist of up
odes to 1024 characters.
streamType Opt. Number Body Stream types: 0-main stream
(default), 1-sub-stream. And
this field can contain up to 32
characters.
protocol Opt. String Body Streaming protocol (application
layer protocol) types: "rtsp"
(default), "websocket" (for
JsDecoder SDK), "rtsp_s" (for
getting stream via standard
RTSP), "websocket_s", "hls",
"rtmp". And this field can
contain up to 16 characters.
transmode Opt. Number Body Transfer protocol types: 0-UDP,
1-TCP (default). And this field
can contain up to 32
characters.

Request Example
{
"cameraIndexCode":"1",
"streamType":0,
"protocol":"rtsp",
"transmode":1,
}

267
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Streaming URL information. See
details in UrlInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"list": [
{
"url": "[sms:preview]rtsp://10.19.131.67:554/hikvision://10.14.67.204:8000:0:0?bandwidth=4",
"authentication": "Fsd8eugj2+RYG6EKEgN8/EHy6o5XPdkxD8t7Dy
+EH6n0ECvzdKuvVH5xFnTYOEuACuTyjZTCemXqQf6bzYDmvszxZmoGM2j/b2EzE
+96DduQT2+tt4jaSxWVkPcEHIi3lH6kWp/EerFa/TKSolhIuDk3nw7QoNMKLOsJpCqizP/
OIHr8Qv6L0cJoFBw8KSd9J6APaTb7I9dHVStExL/R6NHmNBH9dfJcSgKOCEQRz9A="
},
{
"url": "[sms:preview]rtsp://10.19.131.67:554/hikvision://10.41.7.98:8089:0:0?bandwidth=2",
"authentication": "J3mnUxvJ4vcJ5vdN25FrXxtO+7SQkYajdcztnn8uDbQ3XXPpnNaZjVNzzmf84oM3tO/
TzJUoEh3SEXJfcADJK0XlpPUAFNxNVbO2N5Wx1ueJwIoQ94oxWjBNqcUfgqdww/jc27BGG6U8J
+FvLPoi0GMtbn93I50+LBinpwPAn9T5M
+NyTyU7mwGUKjKcaE5auVkGQ8wSh1VJSNvEyChctp8OjU4ldY8RWMLS1WWoBSk="
}
]
}
}

5.4.8 POST /artemis/api/video/v1/cameras/talkURLs

Get streaming URL of two-way audio for the camera.

268
 HikCentral Professional OpenAPI Developer Guide

Note
Supports streaming from cameras on remote sites. For cascaded streaming via two streaming
media, only RTSP is supported and EHOME devices are not supported.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/cameras/talkURLs
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
domainId Opt. Number Header Domain ID, which consists of
up to 32 characters.
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
protocol Opt. String Body Streaming protocol (application
layer protocol) types: "rtsp"
(default),"websocket_s". And
this field can contain up to 64
characters.
transmode Opt. Number Body Transfer protocol types: 0-UDP,
1-TCP (default). And this field
can contain up to 32
characters.

Request Example
{
"cameraIndexCode": "1",
"transmode": 1
}

269
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Streaming URL information. Refer to
UrlInfo for details.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"url":"[sms:voicetalk]rtsp://10.41.13.178:554/voicetalk://10.41.7.66:8001:0:0",
"authentication":"Fsd8eugj2+RYG6EKEgN8/EHy6o5XPdkxD8t7Dy+EH6moE4G0X9+60C7PucJ8TlZOJHpXlM0y
+DwPdkSiALHgLmcWShmtWnKnfD5lhfDSMakMUxtlqfqOalXw5AAcSxoz76LkR8qzI8lKncuhXO9RslvYiC0UJN/
b3tmwUH999oWgJbX6jd3mN/p3FPgi4NtkbADKKnmjEY8NI9cPDcHaMfV+oJCYF0aVCjI3BU9AnPY="
}
}

5.4.9 POST /artemis/api/video/v1/device/talkURLs

Get streaming URL of two-way audio for the device.

Note
Streaming from cameras on remote sites is not supported.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/device/talkURLs

270
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
domainId Opt. Number Header Domain ID, which consists of
up to 32 characters.
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
protocol Opt. String Body Streaming protocol (application
layer protocol) types: "rtsp"
(default), "websocket_s". And
this field can contain up to 64
characters.
transmode Opt. Number Body Transfer protocol types: 0-UDP,
1-TCP (default). And this field
can contain up to 32
characters.

Request Example
{
"cameraIndexCode": "1",
"transmode": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the

271
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Streaming URL information. Refer to
UrlInfo for details.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"url":"[sms:voicetalk]rtsp://10.41.13.178:554/voicetalk://10.41.7.66:8001:0:0",
"authentication":"Fsd8eugj2+RYG6EKEgN8/EHy6o5XPdkxD8t7Dy+EH6moE4G0X9+60C7PucJ8TlZOJHpXlM0y
+DwPdkSiALHgLmcWShmtWnKnfD5lhfDSMakMUxtlqfqOalXw5AAcSxoz76LkR8qzI8lKncuhXO9RslvYiC0UJN/
b3tmwUH999oWgJbX6jd3mN/p3FPgi4NtkbADKKnmjEY8NI9cPDcHaMfV+oJCYF0aVCjI3BU9AnPY="
}
}

5.4.10 POST /artemis/api/video/v1/patrols/addition

Add a patrol to a camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/patrols/addition
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
patrolName Opt. String Body Patrol name, which consists of
up to 128 characters.

272
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
patrolIndex Req. Number Body Patrol No., which ranges from 1
to 8. And the No. consists of up
to 64 characters.
patrolPointInf Req. Array Body Preset information list of the
oList patrol.
patrolPointInf Req. Object Body Information of a preset in the
oList[0] preset list of the patrol. Refer
to PatrolPointInfo for details.

Request Example
{
"cameraIndexCode": "89",
"patrolIndex": 1,
"patrolName": "1",
"patrolPointInfoList": [
{
"presetIndex": 1,
"speed": 1,
"dwellTime": 15
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / Set it to null.

273
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.4.11 POST /artemis/api/video/v1/patrols/deletion

Delete a patrol of a camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/patrols/deletion
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
patrolIndex Req. Number Body Patrol No., which ranges from 1
to 8. And the No. consists of up
to 64 characters.

Request Example
{
"cameraIndexCode": "89",
"patrolIndex":1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer

274
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / Set it to null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.4.12 POST /artemis/api/video/v1/patrols/patrolIndex/patrolInfo

Get the patrol information of a camera by patrol No.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/patrols/patrolIndex/patrolInfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
patrolIndex Req. Number Body Patrol No., which consists of up
to 64 characters.

275
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"cameraIndexCode": "89",
"patrolIndex": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Patrol information. See details in
PatrolInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"patrolIndex": 1,
"patrolName": "1"
}
}

5.4.13 POST /artemis/api/video/v1/patrols/searches

Search for the patrol information of a camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/patrols/searches

276
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.

Request Example
{
"cameraIndexCode": "89"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
list Opt. Array Patrol information list.
list[0] Opt. Object Information of a patrol in the list.
Refer to PatrolInfo for details.

Response Example
{
"code": "0",

277
 HikCentral Professional OpenAPI Developer Guide

"msg": "Success",
"data": {
"total": 1,
"list": [
{
"patrolName": "1",
"patrolIndex": 1
}
]
}
}

5.4.14 POST /artemis/api/video/v1/presets/addition

Add a preset to a camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/presets/addition
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
presetName Req. String Body Preset name, which can be
duplicated. And it consists up
of up to 128 characters.
presetIndex Req. Number Body Preset No., which ranges from
1 to 256. And the No. consists
of up to 64 characters.

Request Example
{
"cameraIndexCode": "89"
"presetName":"2",
"presetIndex":2
}

278
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Set it to null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.4.15 POST /artemis/api/video/v1/presets/deletion

Delete a preset of a camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/presets/deletion
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

279
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
presetIndex Req. Number Body Preset No., which ranges from
1 to 256. And each No. consists
of up to 64 characters.

Request Example
{
"cameraIndexCode": "89",
"presetIndex":1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / Set it to null.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

280
 HikCentral Professional OpenAPI Developer Guide

5.4.16 POST /artemis/api/video/v1/presets/searches

Search for the preset information of a camera.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/presets/searches
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.

Request Example
{
"cameraIndexCode": "89"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.

281
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Opt. Array Preset information list.
list[0] Opt. Object Information of a preset in the list.
Refer to PresetInfo for details.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"list": [
{
"presetName": "1",
"presetIndex": 1
}
]
}
}

5.4.17 POST /artemis/api/video/v1/ptzs/controlling

Control the PTZ after starting live view.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/ptzs/controlling
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
action Req. Number Body Start or stop control: 0-start, 1-
stop.

282
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
command Req. String Body PTZ control commands (case
insensitive): "LEFT" (pan left),
"RIGHT" (pan right), "UP" (tilt
up), "DOWN" (tilt down),
"ZOOM_IN" (zoom in),
"ZOOM_OUT" (zoom out),
"LEFT_UP" (pan left and tilt
up), "LEFT_DOWN" (pan left
and tilt down), "RIGHT_UP"
(pan right and tilt up), "RIGHT_
DOWN" (pan right and tilt
down), "FOCUS_NEAR" (focus
+), "FOUCS_FAR" (focus -),
"IRIS_ENLARGE" (iris +), "IRIS_
REDUCE" (iris -), "GOTO_
PRESET" (call preset), and
"RUN_PATROL" (call patrol).
The field can contain up to 16
characters.
speed Opt. Number Body PTZ control speed, which
ranges from 20 and 60, and the
default speed is 40.

Note
This field is Opt. only when the
control commands are
"GOTO_PRESET" and "RUN_
PATROL". For other
commands, this field is Req..

presetIndex Opt. Number Body Preset No., which ranges from

1 to 256.

283
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type

Note
This field is Req. when the
control command is "GOTO_
PRESET".

patrolIndex Opt. Number Body Patrol No., which ranges from 1

to 8.

Note
This field is Req. when the
control command is "RUN_
PATROL".

Request Example
{
"cameraIndexCode": "89",
"command": "GOTO_PRESET",
"presetIndex":1,
"action": 0,
"speed": 40,
"PatrolIndex": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. / Set it to null.

284
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.4.18 POST /artemis/api/video/v1/camera/capture

Capture real-time pictures via camera. The resolution is determined by the device environment.
For devices accessed via EHOME protocol, picture capture depends on the device capability and if
the picture storage has been enabled and configured.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/camera/capture
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 1024 characters.

Request Example
{
"cameraIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

285
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. String Returned picture information
encoded by Base64.

Response Example
{
"code": "0",
"msg": "Success",
"data": “data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/
2wBDAAYEBAUEBAYFBQUHBgYHCRAKCQgICRMODgsQFxQYGBYUFhYZHCQfGRsiGxYWICsgIiYnKSkpGB4tMCwoMCQoKSf
/2wBDAQYHBwkICRIKChInGhYaJycnJycnJycnJycnJycnJycnJycnJycnJycnJycnJy”
}

5.4.19 POST /artemis/api/video/v1/download

Download recordings by obtained playback URL, authentication information, start and end time,
and video format.

Note
The length of the recording should not exceed one minute.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/download
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

286
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
url Req. String Body Playback URL, obtained via
POST /artemis/api/video/v1/
cameras/playbackURLs .
authentication Req. String Body Authentication information for
streaming, obtained via POST /
artemis/api/video/v1/
cameras/playbackURLs .
beginTime Req. String Body Start time of the recording, in
ISO 8601 format, which is
represented by "yyyy-
MMddTHH: mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64.
endTime Req. String Body End time of the recording, in
ISO 8601 format, which is
represented by "yyyy-
MMddTHH: mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64.
videoType Opt. Number Body Video format: 0-AVI (default),
1-MP4.

Request Example
{
"url": "rtsp://10.18.66.12:554/sms/HCPEurl/commonvideobiz_yL3BB0IJEfmZXqcbVjpen
%2BT1uYbybvT38kqzRR6XaakK2GcRosSrw4A9o%2FFtIeHzaYm3O%2Fmn
%2FWOZwbiNhwhk9eTw1oiI8YFyIY5tLp5CJu7RnoINpei1W22NqnwyDt
%2FcnLNZEnXoejzLazu9A0oXWVwxjsV99%2FtZXqJx8K7601%2BywBbErC80PzfVyFWd5HKmEz8NVdNCVT2fqokL8868ffQ
i8uMYNLXYSE0FEsqunLs%3D",
"authentication": "Fsd8eugj2+RYG6EKEgN8/EHy6o5XPdkxD8t7Dy
+EH6moE4G0X9+60C7PucJ8TlZOdGIK3lH5W7JDFdrercIsiJb1bl9Y52PGA/K/QXIff+84XMQ=",
"beginTime": "2022-09-07T19:38:16+08:00",
"endTime": "2022-09-07T19:38:16+08:00",

287
 HikCentral Professional OpenAPI Developer Guide

"videoType": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Download information structure.

Table 5-1 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
downloadID Req. String Download ID (valid for 10 minutes).
Get download progress and
download URL by the download ID.
The maximum length is 32.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"downloadID": "F704686D84CD4E34A2181A915862FE3F"
}
}

5.4.20 POST /artemis/api/video/v1/downloadURL

Get download progress and download URL by the download ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/downloadURL

288
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to 32
characters, but cannot contain
special characters like ' / \ : * ? "
<>|
downloadID Req. String Body Obtained from POST /
artemis/api/video/v1/
download . The maximum
length is 32.

Request Example
{
"downloadID": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Download information structure.

289
 HikCentral Professional OpenAPI Developer Guide

Table 5-2 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
percent Req. String Download progress (unit: %). The
maximum length is 32.
url Opt. String Download URL.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"percent": "1",
"url": "http://10.18.66.12/download/20221017204905_F704686D84CD4E34A2181A915862FE3F.avi"
}
}

5.4.21 POST /artemis/api/video/v1/event/searchLabels

Get the tags of the person/vehicle-detected videos recorded by cameras.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/video/v1/event/searchLabels
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No. The
maximum length is 32.
pageSize Req. Number Body Number of records on each
page. The maximum length is
32.
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.

290
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
startTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:
yyyy-MMdd'T'HH:
mm:ss.SSSzzz, e.g., 2018-07-
26T15:00:00 + 08:00. And the
time consists of up to 64
characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:
yyyy-MMdd'T'HH:
mm:ss.SSSzzz, e.g., 2018-07-
26T15:00:00 + 08:00. And the
time consists of up to 64
characters.
eventLabel Req. Enum Body 1 (person/​vehicle-detection
tag), 2 (person-detection tag), 4
(vehicle-detection tag).

Request Example
{
"pageNo": 1,
"pageSize": 2,
"cameraIndexCode": "1",
"startTime": "2022-08-06T09:58:39+08:00",
"endTime": "2022-08-06T09:58:39+08:00",
"eventLabel": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

291
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Structure for getting the tag.

Table 5-3 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
totalNum Req. Number Number of tags. The maximum length
is 32.
pageNo Req. Number The current page No. The maximum
length is 32.
pageSize Req. Number Number of records on each page. The
maximum length is 32.
labelList Opt. labelListInfo[] Get the list of event tags. See details
in eventLabelList .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"totalNum": 8,
"pageNo": 1,
"pageSize": 100,
"labelList": [
"labelCode": "35",
"labelEvent": 2,
"startTime": "2022-10-20T15:56:13+08:00",
"endTime": "2022-10-20T15:56:23+08:00"
]
}
}

292
 HikCentral Professional OpenAPI Developer Guide

5.5 Alarm and Event API

Here provides APIs for event and alarm search, getting event and alarm picture, alarm
acknowledgment, event subscription, generic event rule management, and so on.

5.5.1 POST /artemis/api/eventService/v1/eventRecords/controlling

Acknowledge the alarm.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/eventRecords/controlling
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
eventIndexCo Req. String Body Event ID, which consists of up
de to 64 characters.
controlType Req. Number Body Operation type: 1-acknowledge
alarm

Request Example
{
"eventIndexCodes":"1f276203e5234bdca08f7d99e1097bba",
"controlType":1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

293
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.
data Opt. String No data returned.

Response Example
{
"code":"0",
"msg":"Success",
"data":""
}

5.5.2 POST /artemis/api/eventService/v1/eventRecords/page

Set search conditions (e.g., event ID, event source, event type, etc.) to search for alarm or event
details, and the search results will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/eventRecords/page
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
eventIndexCo Opt. String Body Event ID, which consists of up
de to 64 characters. If this field is
not configured, the
eventTypes, srcType, or

294
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
srcIndexs fields must be
configured.
eventTypes Req. String Body Event type, which can be
separated by comma if there
are multiple types, refer to
Event Types or Alarm
Categories for details. And the
field can contain up to 1024
characters.
srcType Req. String Body Event source type: "acsDevice"
(access controller), "door"
(access point), "encodeDevice"
(encoding device), "camera",
"ioIn" (alarm input),
"generalEventRule" (general
event). And the field can
contain up to 64 characters.
Refer to Event Types or Alarm
Categories for details.
srcIndexs Req. String Body Event source No., which can be
separated by command if there
are multiple No.s. And the No.
consists of up to 1024
characters.
subSrcType Opt. String Body Event source type, which is
available for license plate
matched or mismatched event
search. The maximum length is
64 bytes. Refer to Event Types
or Alarm Categories for details.
subSrcIndexs Opt. String Body Event source No., which is
available for license plate
matched or mismatched event
search. Each two No. should be
separated by comma. The
maximum length is 1024 bytes.

295
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
startTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:
yyyy-MM-ddTHH:mm:ss
+current zone, e.g., 2018-07-
26T15:00:00+08:00. And the
time contains up to 64
characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:
yyyy-MM-ddTHH:mm:ss
+current zone, e.g., 2018-07-
26T15:00:00+08:00. And the
time contains up to 64
characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Note
The days between start time and end time should be no more than 31 days.

Request Example
{
"eventIndexCode": "12321432154316547",
"eventTypes": "131329",
"srcType": "camera",
"srcIndexs": "1",
"startTime": "2018-07-26T15:00:00+08:00",
"endTime": "2018-07-26T16:00:00+08:00",
"pageNo": 1,
"pageSize": 15
}

296
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Event record list.
list[0] Opt. Object Information of an event record in the
list. See details in EventRecord .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total":1,
"pageNo":1,
"pageSize":15,
"list": [
{
"eventIndexCode": "12321432154316547",
"eventType": "131329",
"srcType": "camera",
"srcIndex": "1",
"description": "abc",
"startTime": "2018-07-26T15:00:00+08:00",
"stopTime": "2018-07-26T16:00:00+08:00",
"eventPicUri": "0B4E92A30AF914C1285613A4FBD9F761F ",
"linkCameraIndexCode": "2"
}

297
 HikCentral Professional OpenAPI Developer Guide

]
}
}

5.5.3 POST /artemis/api/eventService/v1/eventSubscriptionByEventTypes

Subscribe to events by event type. Repeated subscriptions from the same user will be
automatically deduplicated by the API; when errors occur within the OpenAPI service, the event
will be subscribed again for the partner after the restart of the OpenAPI service. Event subscription
is available for alarm event, on-board monitoring, face picture match, access control card swiping,
and ANPR.

Note
After the event callback is enabled, there might be exceptions in 3 circumstances.
● OpenAPI exception: Restart the OpenAPI service and the event records during the exception

period will be pushed from the HikCentral Professional platform to the partner again.
● Third party service or network exception: The pushed events (max. number: 500) will be cached

by OpenAPI for 1 day at most.

● HikCentral Professional exception: Pushing events is not supported.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/eventSubscriptionByEventTypes
Request URL
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
eventTypes Req. Number Body Event type code, which is a
decimal integer, refer to Event
Types or Alarm Categories for
details. Up to 256 types are
supported, whose codes are
between 100000 and
2147483647.

298
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
eventDest Req. String Body Address to receive event
information, which consists of
up to 1024 characters. The
address adopts RESTful callback
mode, and supports HTTP and
HTTPS, its format is "http:/​/
ip:port/​eventRcv" or "https:/​/
ip:port/​eventRcv".

Note
Refer to Event Message
Format for the event details
received in the address.

passBack Opt. Number Body Whether to enable event

callback: 0-no (by default), 1-
yes.

Request Example
{
"eventTypes":[131329,131330,131331],
"eventDest":"https://10.18.66.21:8080/eventRcv"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.

299
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": 0,
"msg": "Success"
}

5.5.4 POST /artemis/api/eventService/v1/eventSubscriptionView

Search for event subscription details by user.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/eventSubscriptionView
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|

Request Example
uri：/api/eventService/v1/eventSubscriptionView

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

300
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description contains up
to 256 characters.
data Opt. Detail Response data details.

Table 5-4 Detail Object Description

Parameter Req. or Opt. Data Type Description
detail Req. SubscriptionInfo[] Details of a subscribed event. Refer to
SubscriptionInfo for details.

Response Example
{
"code": 0,
"msg": “Success”,
"data": {
"detail":
[
{
"eventTypes":[131329,131330,131331],
"eventDest":" https://10.18.66.21:8080 /eventRcv ",
"passBack":0
}
]

}
}

5.5.5 POST /artemis/api/eventService/v1/eventUnSubscriptionByEventTypes

Cancel subscription by event type.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/
eventUnSubscriptionByEventTypes

301
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
eventTypes Req. Number Body Event type code, which is a
decimal integer, refer to Event
Types or Alarm Categories for
details. Up to 256 types are
supported, whose codes are
between 100000 and
2147483647.

Request Example
{
"eventTypes":[131329,131330,131331]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.

Response Example
{
"code": 0,

302
 HikCentral Professional OpenAPI Developer Guide

"msg": "Success",
}

5.5.6 POST /artemis/api/eventService/v1/generalEventRule/generalEventRuleList

Get the information list of generic events.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/generalEventRule/
generalEventRuleList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageNo": 1,
"pageSize": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

303
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Information list of generic events.
list[0] Opt. Object Information about a specific generic
event. See details in
GeneralEventRule .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 3,
"pageNo": 1,
"pageSize": 1,
"list": [
{
"generalEventRuleIndexCode": "1",
"generalEventRuleName": "1",
"transportType": 0,
"matchType": 0,
"expression": "\"1\" AND \"1\"",
"regularExpression": "(1.*1|1.*1)"
}
]
}
}

304
 HikCentral Professional OpenAPI Developer Guide

5.5.7 POST /artemis/api/eventService/v1/generalEventRule/single/add

Customize the expression to add a generic event.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/generalEventRule/single/add
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
generalEventR Req. String Body Name of the generic event,
uleName which consists of up to 32
characters.
transportType Req. Number Body Transmission type: 0-TCP, 1-
UDP. The maximum length is 32
characters.
matchType Req. Number Body Match type: 0-search (the
received data package must
contain the text specified in
expression, but may also have
more content), 1-match (the
received data package must
contain exactly the text
specified in expression, and
nothing else). The maximum
length is 64 characters.
expression Req. String Body Description of the regular
expression, which consists of
up to 256 characters.
regularExpress Req. String Body Regular expression of the
ion generic event, which consists
of up to 256 characters.

305
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"generalEventRuleName": "name1",
"transportType": 0,
"matchType": 0,
"expression": "\'1\' AND \'2\'",
"regularExpression": "(1.*2|2.*1)"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.5.8 POST /artemis/api/eventService/v1/generalEventRule/single/delete

Delete a generic event.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/generalEventRule/single/delete

306
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
generalEventR Req. String Body Generic event ID, which
uleIndexCode consists of up to 64 characters.

Request Example
{
"generalEventRuleIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

307
 HikCentral Professional OpenAPI Developer Guide

5.5.9 POST /artemis/api/eventService/v1/generalEventRule/single/update

Edit a generic event.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/generalEventRule/single/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
generalEventR Req. String Body Generic event ID, which
uleIndexCode consists of up to 64 characters.
generalEventR Req. String Body Generic event name, which
uleName consists of up to 32 characters.
transportType Req. Number Body Transmission type: 0-TCP, 1-
UDP. The maximum length is 32
characters.
matchType Req. Number Body Match type: 0-search (the
received data package must
contain the text specified in
expression, but may also have
more content), 1-match (the
received data package must
contain exactly the text
specified in expression, and
nothing else). The maximum
length is 64 characters.
expression Req. String Body Description of the regular
expression, which consists of
up to 256 characters.
regularExpress Req. String Body Regular expression of the
ion generic event, which consists
of up to 256 characters.

308
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"generalEventRuleIndexCode": "1",
"generalEventRuleName": "name2",
"transportType": 0,
"matchType": 0,
"expression": "\"1\" AND \"2\"",
"regularExpression": "(1.*2|2.*1)"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.5.10 POST /artemis/api/eventService/v1/generalEventRule/triggerAlarm

Configure parameters to enable receiving the generic events By default, the recipient is admin and
the linked camera is the one with storage configured.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/generalEventRule/triggerAlarm

309
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
generalEventR Req. String Body Generic event ID (separate
uleIndexCodes multiple items with comma,
currently only one ID is
supported). The maximum
length is 32 characters.
description Req. String Body Description. The maximum
length is 128 characters.
alarmPriority Req. Number Body Alarm priority: 1-high, 2-
medium, 3-low. The maximum
length is 64 characters.
triggerPopup Opt. Number Body Whether it triggers pop-up
Windows window: 0-no, 1-yes. The
maximum length is 256
characters.
linkCameraList Opt. Array Body List of linked camera.
linkCameraList Opt. Object Body Information of linked camera.
[0]
cameraIndexC Req. String Body Camera ID.
ode
recordType Opt. Number Body Recoding type: 0-main
recording, 1-auxiliary
recording.
defaultPlayTyp Opt. Number Body Default type of video play: 0-
e live view, 1-playback.

Request Example
{
"generalEventRuleIndexCodes": "1",
"description": "descriptioninfo",
"alarmPriority": 1,

310
 HikCentral Professional OpenAPI Developer Guide

"triggerPopupWindows": 0,
"linkCameraList": [
{
"cameraIndexCode": "1",
"recordType": 0
}
],
"defaultPlayType": 0
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.5.11 POST /artemis/api/eventService/v1/image_data

Get alarm pictures from the searched alarm or event information by picture URL.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/image_data

311
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
domainId Opt. String Header Domain ID, which is used in the
streaming URL and consists of
up to 16 characters. If this field
is not configured, the value will
be determined by the request.
picUri Req. String Body Picture URL, which consists of
up to 256 characters.

Request Example
{
"picUri": "/pic?=d7ei703i10cd*73a-d5108a--22cd0c9d6592aiid="
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.
data Opt. String Data encoded by Base64 in the
response.

312
 HikCentral Professional OpenAPI Developer Guide

Response Example
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls49L0y20yFyy29ukSs3UhVAB/
SigyEjFFG5+2RioRUV0P/2Q=="

5.5.12 POST /artemis/api/eventService/v1/deviceApplicationEvent

Search for AIOP and HEOP event lists by condition.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/eventService/v1/deviceApplicationEvent
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageSize Req. String Body Number of records on each
page.
pageIndex Req. String Body The current page No.
criteria Req. Object Body Search conditions, including
event type and event name.
sort Req. Object Body Sort type and sort order.

Table 5-5 criteria Object Description

Parameter Req. or Opt. Data Type Parameter Description
Type
eventCategory Req. Number Body Event types (100651-HEOP
event, 100652-AIOP event).
eventName Opt. String Body Search by event name. Get all
events when this field is empty.

313
 HikCentral Professional OpenAPI Developer Guide

Table 5-6 sort Object Description

Parameter Req. or Opt. Data Type Parameter Description
Type
sortField Req. String Body Sort by one field: eventName,
rawEventName, or description.
orderType Req. Number Body 0-ascending order, 1-
descending order.

Request Example
{
"pageIndex": 1,
"pageSize": 10,
"criteria": {
"eventCategory": 100652,
"eventName": "name"
},
"sort": {
"sortField": "EventName",
"orderType": 0
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.
data Opt. PageInfo Response data.

314
 HikCentral Professional OpenAPI Developer Guide

Table 5-7 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
totalNum Req. Number Number of search results from search
of face picture via picture
comparison.
pageIndex Req. Number The current page No.
pageSize Req. Number Number of records on each page.
event Req. eventInfo [] Event information. See details in
eventList .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"totalNum": 1,
"pageIndex": 1,
"pageSize": 10,
"event": [
{
"eventCode": 1,
"eventType": 1,
"eventName": "name",
"rawEventName": "rawname",
"description": "test",
"eventCategory": 100652
}
]
}
}

5.6 Visitor API

5.6.1 POST /artemis/api/visitor/v1/appointment

Add a visitor's information for checking in.

Remark
We recommend that you use the API ( POST /artemis/api/visitor/v1/registerment ), which will
take the place of the old one ( POST /artemis/api/visitor/v1/appointment ).

315
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/appointment
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
receptionistId Opt. String Body ID of the person to be visited,
which consists of up to 64
characters.
visitStartTime Req. String Body Check-in time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 bytes.
visitEndTime Req. String Body Check-out time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 bytes. Once the visitor
checked out, all permissions
assigned to this visitor will be
unassigned but the visitor
information will be retained.
visitPurposeTy Req. Number Body Visiting purpose type: 0-
pe business, 1-training, 2-visit, 3-
meeting, 4-others.
visitPurpose Opt. String Body Visiting purpose, which consists
of up to 128 characters.
visitorInfoList Req. Object Body List of visitor information,
which consists of up to 128

316
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
characters. Currently, it only
supports adding visitor at a
time. See details in VisitorInfo .
watchListInfo Req. Object Body Visitor monitoring list
information. See details in
watchListInfo .

Request Example
{
"receptionistId": "",
"visitStartTime": "2018-07-26T15:00:00+08:00",
"visitEndTime": "2018-07-26T16:00:00+08:00",
"visitPurposeType": 0,
"visitPurpose": "visitor",
"visitorInfoList": [
{
"VisitorInfo": {
"visitorFamilyName": "san",
"visitorGivenName": "zhang",
"gender": 1,
"email": "[email protected]",
"phoneNo": "13600000000",
"plateNo": "A666",
"companyName": "AAA",
"certificateType": 111,
"certificateNo": "null",
"remark": "visitor",
"accessInfo": {
"electrostaticDetectionType": 0,
"qrCodeValidNum": 0
},
"watchListInfo": [
{
"enableRegister": 1,
"ID": “0”,
"Type": "1"
}
],
"faces": [
{
"faceData": "/9j/4AAQSkZRgABAQEAAAAAAAD/4QBCRXhpZgAATU.."
}
],
"fingerPrint": [
{

317
 HikCentral Professional OpenAPI Developer Guide

"fingerPrintIndexCode": "1",
"fingerPrintName": "fringe_pringt_01",
"fingerPrintData": "46504D228697F1AD0146C8D00",
"relatedCardNo": "123456"
}
],
"cards": [
{
"cardNo": "123456"
}
]
}
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
appointRecordId Opt. String Reservation record ID, which consists
of up to 64 characters.
visitorId Opt. String Visitor ID, which consists of up to 64
characters.
qrCodeImage Opt. String Visitor QR code, encoded by Base64;
represented by "data:image/
png;base64".

Response Example
{
"code": "0",
"msg": "Success",
"data": {

318
 HikCentral Professional OpenAPI Developer Guide

"appointRecordId": "1",
"visitorId":”"2"
}
}

5.6.2 POST /artemis/api/visitor/v1/appointment/update

Edit a visitor's information for checking in. Currently, editing visitors in a batch is not supported.

Remark
We recommend that you use the API ( POST /artemis/api/visitor/v1/registerment/update ),
which will take the place of the old one ( POST /artemis/api/visitor/v1/appointment/update ).
Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/appointment/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
appointRecord Req. String Body Reservation record ID, which
Id consists of up to 64 characters.
receptionistId Opt. String Body ID of the person to be visited,
which consists of up to 16
characters.
visitStartTime Req. String Body Check-in time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 bytes.
visitEndTime Req. String Body Check-out time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,

319
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 bytes. Once the visitor
checked out, all permissions
assigned to this visitor will be
unassigned but the visitor
information will be retained.
visitPurposeTy Req. Number Body Visiting purpose type: 0-
pe business, 1-training, 2-visit, 3-
meeting, 4-others.
visitPurpose Opt. String Body Visiting purpose.
visitorInfoList Req. Array Body List of visitor information,
which consists of up to 128
characters. Currently, it only
supports one visitor at a time.
See details in VisitorInfo .

Request Example
{
"appointRecordId": "1",
"receptionistId": "1",
"visitStartTime": "2018-07-26T15:00:00+08:00",
"visitEndTime": "2018-07-26T16:00:00+08:00",
"visitPurposeType": 0,
"visitPurpose": "visitor",
"visitorInfoList": [
{
"VisitorInfo": {
"visitorFamilyName": "san",
"visitorGivenName": "zhang",
"gender": 1,
"email": "null",
"phoneNo": "13600000000",
"plateNo": "BBBA",
"companyName": "AAA",
"certificateType": 111,
"certificateNo": "null",
"remark": "null",
"accessInfo": {
"electrostaticDetectionType": 0,
"qrCodeValidNum": 0
},

320
 HikCentral Professional OpenAPI Developer Guide

"faces": [
{
"faceData": "/9j/4AAQSkZJRgABAQEAAAAAAAD/4QBCRXhpZgAATU.."
}
],
"fingerPrint": [
{
"fingerPrintIndexCode": "1",
"fingerPrintName": "fringe_pringt_01",
"fingerPrintData": "46504D228697F1AD0146C8D00",
"relatedCardNo": "123456"
}
],
"cards": [
{
"cardNo": "123456"
}
]
}
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
appointRecordId Opt. String Reservation record ID, which will
change each time the visitor
information is updated. The maximum
length is 64 characters.

321
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data":
}

5.6.3 POST /artemis/api/visitor/v1/registerment

Check in a visitor.

Remark
We recommend that you use the API ( POST /artemis/api/visitor/v1/registerment ), which will
take the place of the old one ( POST /artemis/api/visitor/v1/appointment ), for checking in a
visitor.
Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/registerment
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
receptionistId Opt. String Body ID of the person to be visited,
which consists of up to 64
characters.
appointId Opt. String Body Reservation record ID, which
consists of up to 64 characters.
visitorId Opt. String Body Visitor ID, which consists of up
to 64 characters.
visitStartTime Req. String Body Check-in time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00

322
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
+ 08:00". The maximum length
is 64 characters.
visitEndTime Req. String Body Check-out time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 characters. Once the
visitor checked out, all
permissions assigned to this
visitor will be unassigned but
the visitor information will be
retained.
visitPurposeTy Req. Number Body Visiting purpose type: 0-
pe business, 1-training, 2-visit, 3-
meeting, 4-others.
visitPurpose Opt. String Body Visiting purpose, which consists
of up to 128 characters.
visitorInfoList Req. VisitorInfo[] Body List of visitor information,
which consists of up to 128
characters. Currently, it only
supports one visitor at a time.
See details in VisitorInfo .
watchListInfo Req. Object Body Visitor monitoring list
information. See details in
watchListInfo .

Request Example
{
"receptionistId": "",
"visitStartTime": "2018-07-26T15:00:00+08:00",
"visitEndTime": "2018-07-26T16:00:00+08:00",
"visitPurposeType": 0,
"visitPurpose": "visitor",
"visitorInfoList": [{
"VisitorInfo": {
"visitorFamilyName": "san",

323
 HikCentral Professional OpenAPI Developer Guide

"visitorGivenName": "zhang",
"gender": 1,
"email": "[email protected]",
"phoneNo": "13600000000",
"plateNo": "A666",
"companyName": "AAA",
"certificateType": 111,
"certificateNo": "null",
"remark": "visitor",
"accessInfo": {
"electrostaticDetectionType": 0,
"qrCodeValidNum": 0
},
"watchListInfo": [
{
"enableRegister": 1,
"ID": “0”,
"Type": "1" }
],
"faces": [{
"faceData": "/9j/4AAQSkZRgABAQEAAAAAAAD/4QBCRXhpZgAATU.."
}],
"fingerPrint": [{
"fingerPrintIndexCode": "1",
"fingerPrintName": "fringe_pringt_01",
"fingerPrintData": "46504D228697F1AD0146C8D00",
"relatedCardNo": "123456"
}],
"cards": [{
"cardNo": "123456"
}]
}
}]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

324
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
appointRecordId Opt. String Reservation record ID, which consists
of up to 64 characters.
visitorId Opt. String Visitor ID, which consists of up to 64
characters.
qrCodeImage Opt. String Visitor QR code, encoded by Base64;
represented by "data:image/
png;base64".

Request Example
{
"code": "0",
"msg": "Success",
"data": {
"appointRecordId": "1",
"visitorId":"2"
"qrCodeImage": "iVBORw0KGgoAAAANSUhEUg”
}
}

5.6.4 POST /artemis/api/visitor/v1/registerment/update

Edit a visitor's information for checking in.

Remark
We recommend that you use the API ( POST /artemis/api/visitor/v1/registerment/update ),
which will take the place of the old one ( POST /artemis/api/visitor/v1/appointment/update ).
Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/registerment/update

325
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
appointRecord Req. String Body Reservation record ID, which
Id consists of up to 64 characters.
receptionistId Opt. String Body ID of the person to be visited,
which consists of up to 16
characters.
visitStartTime Req. String Body Check-in time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 characters.
visitEndTime Req. String Body Check-out time in ISO 8601
format, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 characters. Once the
visitor checked out, all
permissions assigned to this
visitor will be unassigned but
the visitor information will be
retained.
visitPurposeTy Req. Number Body Visiting purpose type: 0-
pe business, 1-training, 2-visit, 3-
meeting, 4-others.

326
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
visitPurpose Opt. String Body Visiting purpose. The maximum
length is 128 characters.
visitorInfoList Req. VisitorInfo[] Body List of visitor information,
which consists of up to 128
characters. Currently, it only
supports one visitor at a time.
See details in VisitorInfo .

Request Example
{
"appointRecordId": "1",
"receptionistId": "1",
"visitStartTime": "2018-07-26T15:00:00+08:00",
"visitEndTime": "2018-07-26T16:00:00+08:00",
"visitPurposeType": 0,
"visitPurpose": "visitor",
"visitorInfoList": [
{
"VisitorInfo": {
"visitorFamilyName": "san",
"visitorGivenName": "zhang",
"gender": 1,
"email": "null",
"phoneNo": "13600000000",
"plateNo": "BBBA",
"companyName": "AAA",
"certificateType": 111,
"certificateNo": "null",
"remark": "null",
"accessInfo": {
"electrostaticDetectionType": 0,
"qrCodeValidNum": 0
},
"faces": [
{
"faceData": "/9j/4AAQSkZJRgABAQEAAAAAAAD/4QBCRXhpZgAATU.."
}
],
"fingerPrint": [
{
"fingerPrintIndexCode": "1",
"fingerPrintName": "fringe_pringt_01",
"fingerPrintData": "46504D228697F1AD0146C8D00",
"relatedCardNo": "123456"
}

327
 HikCentral Professional OpenAPI Developer Guide

],
"cards": [
{
"cardNo": "123456"
}
]
}
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
appointRecordId Opt. String Reservation record ID, which will
change each time you edit the visitor
information. The maximum length is
64 characters.

Request Example
{
"code": "0",
"msg": "Success",
"data":
}

5.6.5 POST /artemis/api/visitor/v2/appointment

Make a reservation for a visitor.

328
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v2/appointment
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
receptionistId Opt. String Body ID of the person to be visited,
which can be obtained via
POST /artemis/api/
resource/v1/person/advance/
personList and consists of up to
64 characters.
appointStartTi Req. String Body Expected time of arrival in ISO
me 8601 format, which is
represented by "yyyy-MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters.
appointEndTi Req. String Body Expected time of leaving in ISO
me 8601 format, which is
represented by "yyyy-MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters. If the visitor has
checked out, all permissions
assigned to the visitor will be
unassigned.
visitReasonTy Req. Number Body Visiting purpose type: 0-
pe business, 1-training, 2-visit, 3-
meeting, 4-others.

329
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
visitReasonDe Opt. String Body Visiting purpose, this
tail parameters is required when
the value of visitReasonType is
4. The maximum length is 128
characters.
visitorInfoList Req. Array Body List of visitor information,
which consists of up to 128
characters. Currently, it only
supports adding one visitor at a
time.
visitorInfoList[ Req. VisitorInfo[] Body List of visitor information,
0] which consists of up to 128
characters. Currently, it only
supports one visitor at a time.
See details in VisitorInfo .
accessInfo Opt. Object Body Visitor's access permission. See
details in accessInfo . The
maximum length is 128.
watchListInfo Opt. watchListInfo[] Body Monitoring list information.
See details in watchListInfo .
The maximum length is 128.

Request Example
{
"receptionistId":"2",
"appointStartTime":"2021-05-09T15:00:00+08:00",
"appointEndTime":"2021-05-14T15:00:00+08:00",
"visitReasonType":0,
"visitReasonDetail":"null",
"visitorInfoList":[
{
"VisitorInfo":{
"visitorFamilyName":"mmm",
"visitorGivenName":"yyyy",
"gender":1,
"email":"[email protected]",
"phoneNo":"13600000000",
"plateNo":"Zhe A",
"companyName":"hik",
"certificateType":111,

330
 HikCentral Professional OpenAPI Developer Guide

"certificateNo":"dddd2234",
"remark":"null",
"accessInfo": {
"electrostaticDetectionType": 0,
"qrCodeValidNum": 0，
"accessLevelList": [
{
"accessLevel": {
"id": 1,
"baseInfo": {
"name": "1"
}
}
}
]
},
"watchListInfo": [
{
"enableRegister": 1,
"ID": "0",
"Type": "1" }
],
"faces":[
{
"faceData":"/9j/4AAQSkZRgABAQEAAAAAAAD/4QBCRXhpZgAATU.."
}
],
"identiPhoto":[
{
"identiPhotoData":"/9j/4AAQSkZRgABAQEAAAAAAAD/4QBCRXhpZgAATU.."
}
],
"customField":[
{
"customID":"1",
"customFieldName":"",
"customFieldType":0,
"customFieldValue":""
}
]
}
}
],
"accessInfo": {
"accessLevelList": [
{
"accessLevel": {
"id": 1,
"baseInfo": {
"name": "1"
}
}

331
 HikCentral Professional OpenAPI Developer Guide

}
]
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
appointRecordId Opt. String Reservation record ID, which consists
of up to 64 characters.
visitorId Opt. String Visitor ID, which consists of up to 64
characters.
appointCode Opt. String Reservation code, which consists of
up to 64 characters.
qrCodeImage Opt. String Visitor QR code, encoded by Base64;
represented by "data:image/
png;base64".
watchListInfo Opt. watchListInfo [] Monitoring list information.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"appointRecordId": "1",
"visitorId": "2",
"qrCodeImage": "iVBORw0KGgoAANIAAADSAQMAAAAFVwwBAAA",
"AppointCode": "5080",
"watchListInfo": [
{

332
 HikCentral Professional OpenAPI Developer Guide

"enableRegister": true,
"id": 0,
"type": "1"，
"visitorType": "",
"type": "",
"remark": ""，
"visitorTypeName": "",
"identiFicationType": "",
"identiFiyCode": ""，
"haveVisitorHeadPic": 0，
"haveVisitorIdentiPic": 0，
}
]
}
}

5.6.6 POST /artemis/api/visitor/v1/appointment/single/delete

Delete a visitor's reservation record.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/appointment/single/delete
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
appointRecord Req. String Body Reservation record ID, which
Id consists of up to 64 characters.

Request Example
{
"appointRecordId ": "5"
}

333
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Request Example
{
"code": "0",
"msg": "Success",
"data":""
}

5.6.7 POST /artemis/api/visitor/v2/appointment/update

Edit a visitor's reservation record.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v2/appointment/update
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
appointRecord Req. String Body Reservation record ID, which
Id consists of up to 64 characters.

334
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
receptionistId Opt. String Body ID of the person to be visited,
which consists of up to 64
characters.
appointStartTi Req. String Body Expected time of arrival in ISO
me 8601 format, which is
represented by "yyyy-MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters.
appointEndTi Req. String Body Expected time of leaving in ISO
me 8601 format, which is
represented by "yyyy-MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters. If the visitor has
checked out, all permissions
assigned to the visitor will be
unassigned.
visitReasonTy Req. Number Body Visiting purpose type: 0-
pe business, 1-training, 2-visit, 3-
meeting, 4-others.
visitReasonDe Opt. String Body Visiting purpose, this
tail parameters is required when
the value of visitReasonType is
4. The maximum length is 128
characters.
visitorInfoList Req. Array Body List of visitor information,
which consists of up to 128
characters. Currently, it only
supports editing one visitor's

335
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
information at a time. See
details in VisitorInfo .
accessInfo Opt. Object Body Visitor's access permission. See
details in accessInfo . The
maximum length is 128.

Request Example
{
"receptionistId":"",
"appointStartTime":"2020-10-26T15:00:00+08:00",
"appointEndTime":"2020-10-29T15:00:00+08:00",
"visitReasonType":0,
"visitReasonDetail":"null",
"visitorInfoList":[{
"VisitorInfo":{
"visitorFamilyName":"null",
"visitorGivenName":"null",
"gender":1,
"email":"",
"phoneNo":"13600000000",
"plateNo":"A",
"companyName":"hik",
"certificateType":111,
"certificateNo":"null",
"remark":"null",
"accessInfo": {
"electrostaticDetectionType": 0,
"qrCodeValidNum": 0，
"accessLevelList": [
{
"accessLevel": {
"id": 1,
"baseInfo": {
"name": "1"
}
}
}
]
},
"faces": "null",
"customField":[
{
"customID":"1",
"customFieldName":"",
"customFieldType":0,

336
 HikCentral Professional OpenAPI Developer Guide

"customFieldValue":""
}
]
}
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
appointRecordId Opt. String Reservation record ID, which will
change each time you edit the visitor
information. The maximum length is
64 characters.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"appointRecordId": "6",
"visitorId": "5",
"appointCode": "6582"
}
}

5.6.8 POST /artemis/api/visitor/v1/visitor/out

Check out a visitor and the visitor's access permission will be revoked.

337
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/visitor/out
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
appointRecord Req. String Body Reservation record ID.
Id

Request Example
{
"appointRecordId": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",

338
 HikCentral Professional OpenAPI Developer Guide

"data":
}

5.6.9 POST /artemis/api/visitor/v1/appointment/appointmentlist

Get the list of reservation records.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/appointment/appointmentlist
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
appointStartTi Req. String Body Expected time of arrival in ISO
me 8601 format, which is
represented by "yyyy-MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters.
appointEndTi Req. String Body Expected time of leaving in ISO
me 8601 format, which is
represented by "yyyy-MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters. If the visitor has
checked out, all permissions

339
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
assigned to the visitor will be
unassigned.
visitorName Opt. String Body Visitor's name, which consists
up to 64 characters.
companyNam Opt. String Body Name of the company, which
e consists of up to 64 characters.
interviewNam Opt. String Body Name of the person to be
e visited, which consists of up to
64 characters.
appointCode Opt. String Body Reservation code, which
consists of up to 64 characters.
identiCode Opt. String Body ID Card number, which consists
of up to 64 characters.
phoneNo Opt. String Body Phone number, which consists
of up to 64 characters.
appointState Opt. String Body Reservation status: 0
(reservation record has been
added); 1 (reservation has
been invalid); 2 (visitor has
arrived). The maximum length
is 64 characters.
visitorReason Opt. String Body Visiting purpose, which consists
of up to 64 characters.

Request Example
{
"pageNo": 1,
"pageSize": 100,
"appointStartTime": "2021-04-09T15:00:00+08:00",
"appointEndTime": "2021-05-19T15:00:00+08:00",
"visitorName": "sad",
"companyName": "AAA",
"interviewName": "",
"appointCode": "",
"identiCode": "111",
"phoneNo": "",
"appointState": "",

340
 HikCentral Professional OpenAPI Developer Guide

"visitorReason": 4
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of matched results, the
maximum length is 32 characters.
pageNo Opt. Number The current page No, the maximum
length is 32 characters.
pageSize Opt. Number Number of records on each page, the
maximum length is 32 characters.
list Opt. Array Reservation record list.
list[0] Opt. VisitorappointInf Information of a reservation record.
o

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 100,
"list": [{
"appointStartTime": "2021-05-06T17:00:39+08:00",
"appointEndTime": "2021-05-06T23:59:59+08:00",
"appointCode": "5905",
"appointID": "5",
"visitReasonType": 4,

341
 HikCentral Professional OpenAPI Developer Guide

"visitorReasonName": "other",
"visitReasonDetail": "123",
"appointStatus": 0,
"visitorInfo": {
"visitorId": "4",
"email": "",
"remark": "",
"visitorFamilyName": "sdasd",
"visitorGivenName": "sad",
"visitorName": "sad sdasd",
"gender": 1,
"plateNo": "",
"phoneNo": "",
"companyName": "hik",
"certificateType": 111,
"certificateNo": "1234567",
"visitorPhoto": {
"haveVisitorPhoto": 0,
"haveIdentiPhoto": 0
},
"customField":[
{
"customID":"1",
"customFieldName":"",
"customFieldType":0,
"customFieldValue":""
}
]
"accessInfo": {
“electrostaticDetectionType”:1,
"qrCodeValidNum":1,
"accessLevelList": [
{
"accessLevel": {
"id": 1,
"baseInfo": {
"name": "1"
}
}
}
]
}
}
}
]
}
}

342
 HikCentral Professional OpenAPI Developer Guide

5.6.10 POST /artemis/api/visitor/v1/appointment/downloadpicture

Get the picture of a visitor.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/appointment/downloadpicture
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
visitorId Req. String Body Visitor ID, which consists of up
to 64 characters.
picUrl Req. String Body URL of the visitor's picture used
for reservation, which consists
of up to 256 characters.
picType Req. String Body Picture type: 0-small picture, 1-
big picture, 3-ID photo. The
maximum length is 64
characters.

Request Example
{
"visitorId": "1",
"picType": "0"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

343
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Request Example
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls49L0y20yFyy29ukSs3UhVAB/
SigyEjFFG5+2RioRUV0P/2Q=="
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls49L0y20yFyy29ukSs3UhVAB/
SigyEjFFG5+2RioRUV0P/2Q=="

5.6.11 POST /artemis/api/visitor/v1/visitorconfig/customfields

Search for the custom information about visitors.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/visitorconfig/customfields
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.

344
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
customFieldN Opt. String Body Custom field for fuzzy search.
ame

Request Example
{
"pageIndex":0,
"pageSize":0,
"customFieldName":""
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of matched results, the
maximum length is 32 characters.
pageIndex Opt. Number Current page, the maximum length is
32 characters.
pageSize Opt. Number Number of records on each page, the
maximum length is 32 characters.

345
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

CustomField Opt. Array List of the custom information about
visitors.
CustomField[0] Opt. CustomField Custom information about a visitor.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"CustomFieldList":{
"TotalNum":0,
"pageIndex":0,
"pageSize":0,
"CustomField":[
{
"indexCode":0,
"customFieldType": 0,
"customFieldName":"",
"PresetValueList":{
"PresetValue":[
{
"indexCode":0,
"value":""
}
]
}
}
]
}
}
}

5.6.12 POST /artemis/api/visitor/v1/visitorgroups

Search for the information about visitor groups by group name.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/visitorgroups

346
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
visitorGroupN Opt. String Body Visitor group name, which
ame consists of up to 128
characters.

Request Example
{
"SearchCriteria": {
"visitorGroupName": ""
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
indexCode Req. String Group ID, which consists of up to 32
characters.
name Req. String Group name, which consists of up to
64 characters.

347
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"VisitorGroupList":{
"VisitorGroup":[{
" indexCode":0,
"baseInfo":{
"name":""
}
}]
}
}
}

5.6.13 POST /artemis/api/visitor/v1/visitorgroups/groupinfo

Search for visitors' information by visitor group ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/visitorgroups/groupinfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
indexCode Req. String Body Visitor group ID, which consists
of up to 32 characters.
identifiyCode Opt. string Body ID No., which consists of up to
128 characters.
personName Opt. string Body Name of the visitor, which
consists of up to 128
characters.
phoneNum Opt. string Body Phone number, which consists
of up to 128 characters.

348
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
companyNam Opt. string Body Company name, which consists
e of up to 128 characters.
temperatureSt Opt. Number Body Temperature status: 0
atus (exception), 1 (normal), 2
(unknown), -1 (all).
blackLisitStatu Opt. Number Body Whether the visitor is in the
s blocklist: 0 (no), 1(yes), -1 (all).

Request Example
{
"VisitorListRequest":{
"indexCode":"1",
"pageIndex":0,
"pageSize":0,
"searchCriteria":{
"identifiyCode":"",
"personName":"",
"phoneNum":"",
"companyName":"",
"remperatureStatus":0,
"blackLisitStatus":0
}
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.

349
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

data Opt. Object Response data details.
total Opt. Number Total number of matched results, the
maximum length is 32 characters.
pageIndex Opt. Number The current page No, the maximum
length is 32 characters.
pageSize Opt. Number Number of records on each page, the
maximum length is 32 characters.
list Opt. Array List of information about visitors'
reservation.
list[0] Opt. Visitor A visitor's reservation information.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"pageSize":1,
"pageIndex ":10,
"total":10,
"VisitorList":{
"Visitor":[{
"ID":0,
"BaseInfo":{
"fullName":""
}
}]
}
}
}

5.6.14 POST /artemis/api/visitor/v1/visitor/visitorInfo

Search for visitors' information by condition.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/visitor/visitorInfo

350
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
searchCriteria Opt. Object Body Search conditions.
visitorGroupID Opt. String Body Visitor group ID, which consists
of up to 64 characters.
identifiyCode Opt. String Body ID No., which consists of up to
64 characters.
personName Opt. String Body Name of the visitor, which
consists of up to 128
characters.
phoneNum Opt. String Body Phone number, which consists
of up to 128 characters.
companyNam Opt. String Body Company name, which consists
e of up to 128 characters.
identificationT Opt. String Body Identification type, which
ype consists of up to 128
characters.

Request Example
{
"pageNo ":"0",
" pageSize":"20",
"searchCriteria":{
"visitorGroupID":"1,2,3"
}
}

351
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. VisitorInfo Response data details.

5.6.15 POST /artemis/api/visitor/v1/visitor/single/visitorinfo

Get the visitor's information by visitor ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/visitor/single/visitorinfo
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
visitorId Req. String Body Visitor ID, which consists of up
to 64 characters.

Request Example
{
"visitorId": "125"
}

352
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. VisitorInfo Response data details.

5.6.16 POST /artemis/api/visitor/v1/auth/reapplication

Apply persons' access level settings or information (person ID, person name, face picture,
fingerprint, card No., validity, etc. according to device capability) to device when the persons'
access level or person information changed.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/auth/reapplication
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
orderId Req. String Body Currently not in use.
ImmediateDo Opt. Integer Body 0-immdiately apply persons,
wnload including those which have
failed, 1-immdiately apply
persons, excluding those which
have failed

353
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
personIds Opt. String Body Person ID list. Multiple items
are separated by comma.
doorIndexCod Opt. String Body Door ID list. Multiple items are
es separated by comma.

Response Example
{
"ImmediateDownload": 0,
"personIds": "1",
"doorIndexCodes": "2"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.
data Opt. String Response data.

Response Example
{
"code": "0",
"msg": "ok",
"data": ""
}

5.6.17 POST /artemis/api/visitor/v1/visitorapprovalflow/status

Approve or reject submitted visitor reservation.

354
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/api/visitor/v1/visitorapprovalflow/status
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
operateType Req. Number Body Review decision: 0-approve, 1-
reject.
approvalOpini Opt. String Body Review comment. The
on maximum length is 128.
approvalFlowI Req. ApprovalFlowI Body Review process details. Refer to
nfo nfo[] ApprovalFlowInfo .

Request Example
{
"Visitor": {
"operateType": 0,
"approvalOpinion": "null",
"ApprovalFlowInfo": [
{
"approvalFlowCode": "null",
"watchlistInfo": {
"id": 0
}
}
]
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

355
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description can contain
up to 256 characters.
data Opt. Object Refer to
ErrorcodeApprovalReviewInfo .

Response Example
{
"code": "0",
"msg": "success",
"data":[
{
"errorCode": 0,
"visitorID": 0,
"approvalFlowCode": "null",
"visitorName": "null"
}
]
}

5.6.18 POST /artemis/api/visitor/v1/visitorConfig/automaticApproval

Check whether the auto review of visitor reservation is enabled or not.

Request URL
https://[serverAddress]:[serverPort]/api/visitor/v1/visitorConfig/automaticApproval
Request Parameters
None.
Request Example
None.
Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

356
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Response data information. The
maximum length is 128.
automaticApprov Req. Number Auto review configuration.
al

Response Example
{
"code": "0",
"msg": "success",
"data":{
"automaticApproval": 1
}
}

5.7 Vehicle and Parking API

Here provides APIs for vehicle management and vehicle parking management.

5.7.1 POST /artemis/api/pms/v1/image

Get vehicle pictures from the searched vehicle passing records by picture URL.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/pms/v1/image

357
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
domainId Opt. String Header Domain ID, which is used in the
streaming URL and consists of
up to 16 characters. If this field
is not configured, the value will
be determined by the request.
picUri Req. String Body Picture URL, which consists of
up to 256 characters.

Request Example
{
"picUri": "0B4E92A30AF914C1285613A4FBD9F761F"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. String Binary picture data in the response.

Response Example
HTTP/1.1
Content-Type:image/jpeg;charset=utf-8

358
 HikCentral Professional OpenAPI Developer Guide

Date:YourDate
Content-Length:image_length

[Picture Data]

5.7.2 POST /artemis/api/pms/v1/crossRecords/page

Set search conditions (e.g., camera ID, license plate number, vehicle owner name, etc.) to search
for vehicle passing records, and the search results will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/pms/v1/crossRecords/page
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
cameraIndexC Req. String Body Camera ID, which consists of up
ode to 64 characters.
plateNo Opt. String Body License plate number, which
consists of up to 16 characters.
ownerName Opt. String Body Vehicle owner name, which
consists of up to 64 characters.
contact Opt. String Body Contact number of vehicle
owner, which consists of up to
32 characters.
startTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:
yyyy-MM-ddTHH:mm:ss
+current zone, e.g., 2018-07-
26T15:00:00+08:00. And the
time consists of up to 64
characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:

359
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
yyyy-MM-ddTHH:mm:ss
+current zone, e.g., 2018-07-
26T15:00:00+08:00. And the
time consists of up to 64
characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Note
The days between start time and end time should be no more than 31 days.

Request Example
{
"cameraIndexCode": "1",
"plateNo": "a123456",
"ownerName": "aaa",
"contact": "123",
"startTime": "2018-07-26T15:00:00+08:00",
"endTime": "2018-07-26T16:00:00+08:00",
"pageNo": 1,
"pageSize": 10"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

360
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Vehicle passing record list.
list[0] Opt. Object Information of a vehicle passing
record in the list. See details in
PassVehicleRecord .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total":1,
"pageNo":1,
"pageSize":15,
"list": [
{
"crossRecordSyscode": "74554754035654645",
"cameraIndexCode": "1",
"plateNo": "a123456",
"ownerName": "aaa",
"contact": 123,
"vehicleType": 1,
"vehiclePicUri": "/pic?=d7ei703i10cd*73a-d5108a--22cd0c9d6592aiid=",
"crossTime": "2018-07-26T15:00:00+08:00",
"createTime": "2018-07-26T15:00:00+08:00"
}
]
}
}

5.7.3 POST /artemis/api/vehicle/v1/parkinglot/list

Get the parking lot list.

361
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/parkinglot/list
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Response data details.
total Req. Number The number of parking lots, the
maximum length is 10 characters.
list Req. Array List of parking lots.
list[0] Req. ParkingLotInfo Parking lot information.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 3,
"list": [
{

362
 HikCentral Professional OpenAPI Developer Guide

"parkingLotIndexCode": "1",
"parkingLotName": "parkinglot",
"parentParkingLotIndexCode": "-1",
"totalSpaceNum": 1000,
"freeSpaceNum": 0,
"totalPermanentSpaceNum": 500,
"freePermanentSpaceNum": 202,
"maxParkingTime": 9
},
{
"parkingLotIndexCode": "2",
"parkingLotName": "parking lot 2",
"parentParkingLotIndexCode": "-1",
"totalSpaceNum": 600,
"freeSpaceNum": 600,
"totalPermanentSpaceNum": 500,
"freePermanentSpaceNum": 500,
"maxParkingTime": 7
},
{
"parkingLotIndexCode": "4",
"parkingLotName": "parking lot 3",
"parentParkingLotIndexCode": "2",
"totalSpaceNum": 2,
"freeSpaceNum": 2,
"totalPermanentSpaceNum": -1,
"freePermanentSpaceNum": -1,
"maxParkingTime": -1
}
]
}
}

5.7.4 POST /artemis/api/vehicle/v1/floor/list

Get the floor list of the specified parking lot.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/floor/list
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

363
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
parkingLotInd Opt. String Body Parking lot ID, the maximum
exCode length is 1024 characters.
Information about all parking
lots will be returned if no ID is
specified.

Request Example
{
"parkingLotIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Req. Number The number of floors, the maximum
length is 10 characters.
list Req. Array Floor information list.
list[0] Req. FloorInfo Floor information.

Response Example
{
"code":"0",
"msg":"Success",

364
 HikCentral Professional OpenAPI Developer Guide

"data":{
"total":3,
"list":[{
"floorIndexCode":"12",
"floorName":"666",
"parkingLotIndexCode":"1",
"parkingLotName":" xxxx"
},
{
"floorIndexCode":"13",
"floorName":"111",
"parkingLotIndexCode":"1",
"parkingLotName":"xxxx"
},
{
"floorIndexCode":"14",
"floorName":"122",
"parkingLotIndexCode":"1",
"parkingLotName":"xxxx"
}]
}
}

5.7.5 POST /artemis/api/vehicle/v1/floor/overview

Get the occupancy of one or multiple floors of the parking lot, including the total number of
parking spaces and the number of vacant parking spaces.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/floor/overview
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
parkingLotInd Opt. String Body Parking lot ID, the maximum
exCode length is 1024 characters.
Information of all parking lots

365
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
will be returned if no parking
lot ID is specified.
floorIndexCod Opt. String Body Floor ID, the maximum length
e is 1024 characters. Information
of all floors will be returned if
no floor ID is specified.

Request Example
{
"parkingLotIndexCode" : "1",
"floorIndexCode" : "14"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Response data details.
totalSpaceNum Req. Number Total number of parking spaces, the
maximum length is 10 characters.
freeSpaceNum Req. Number Number of vacant parking spaces, the
maximum length is 10 characters.
total Req. Number Total number of floors, the maximum
length is 10 characters.

366
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Req. Array List of floor overview.
list[0] Req. FloorOverViewInf Floor overview.
o

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"total":1,
"totalSpaceNum":50,
"freeSpaceNum":48,
"list":[{
"floorIndexCode":"14",
"floorName":"122",
"parkingLotIndexCode":1,
"totalSpaceNum":50,
"freeSpaceNum":48,
"spaceTypeOverView":[{
"typeIndexCode":"1",
"typeName":"general",
"typeColor":"#FFFF00",
"totalSpaceNum":6,
"freeSpaceNum":4
},
{
"typeIndexCode":"2",
"typeName":"allow",
"typeColor":"#00FF00",
"totalSpaceNum":6,
"freeSpaceNum":6
},
{
"typeIndexCode":"3",
"typeName":"forbid",
"typeColor":"#0000FF",
"totalSpaceNum":8,
"freeSpaceNum":8
}]
}]
}
}

367
 HikCentral Professional OpenAPI Developer Guide

5.7.6 POST /artemis/api/vehicle/v1/floor/parkingspace/status

Get the real-time status of all parking spaces on the specified floor.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/floor/parkingspace/status
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
floorIndexCod Req. String Body Floor ID, the maximum length
e is 1024 characters.

Request Example
{
"floorIndexCode": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Response data details.
total Req. Number Total number of parking spaces, the
maximum length is 10 characters.

368
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

list Req. Array List of parking spaces.
list[0] Req. ParkingSpaceInfo Information of a parking space.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"total":3,
"list":[{
"spaceIndexCode":"1",
"floorIndexCode":"1",
"spaceType":3,
"serial":"1",
"status":1,
"plateNumber":"",
"creatTime":"2021-07-26T19:58:12+08:00",
"duration":16,
"parkingImageUrl":"Vsm://PHQG#20210726#20210726_193035917.d:104558170:490700",
"platenumberImageUrl":""
},
{
"spaceIndexCode":"2",
"floorIndexCode":"1",
"spaceType":3,
"serial":"2",
"status":1,
"plateNumber":"",
"creatTime":"2021-07-26T11:23:36+08:00",
"duration":30892,
"parkingImageUrl":"Vsm://PHQG#20210726#20210726_112325847.d:1941072:537216",
"platenumberImageUrl":""
},
{
"spaceIndexCode":"3",
"floorIndexCode":"1",
"spaceType":3,
"serial":"3",
"status":1,
"plateNumber":"",
"creatTime":"2021-07-26T13:41:15+08:00",
"duration":22633,
"parkingImageUrl":"Vsm://PHQG#20210726#20210726_131648673.d:129672100:456972",
"platenumberImageUrl":""
}]

369
 HikCentral Professional OpenAPI Developer Guide

}
}

5.7.7 POST /artemis/api/vehicle/v1/parkinglot/passageway/record

Get the vehicle passing records of the specified parking lot.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/parkinglot/passageway/record
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageIndex Req. Number Body The current page No., which is
between 1 and 2147483647.
The maximum length is 10
characters.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500. The maximum length is 3
characters.
queryInfo Req. Object Body Search condition.
parkingLotInd Req. String Body Parking lot ID, the maximum
exCode length is 1024 characters.
beginTime Req. String Body Start time in ISO 8601 format
of search, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07-26T15:00:00+08:00".
The maximum length is 32
bytes.
endTime Req. String Body End time in ISO 8601 format of
search, which is represented by
"yyyy-MM-ddTHH:mm:ss

370
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
+current time zone", e.g.,
"2018-07-26T15:00:00+08:00".
The maximum length is 32
bytes.
ownerName Opt. String Body Vehicle owner name, the
maximum length is 32
characters.
plateLicense Opt. String Body License plate number, the
maximum length is 32
characters.
directionType Opt. Number Body Direction: -1 (all), 1 (entry), 2
(exit).
allowResult Opt. Number Body Whether the passing is
allowed: -1 (all), 1 (allowed), 2
(not allowed).

Request Example
{
"pageIndex": 1,
"pageSize": 3,
"queryInfo": {
"parkingLotIndexCode": "1",
"beginTime": "2021-07-21T00:00:00+08:00",
"endTime": "2021-07-21T23:59:59+08:00",
"ownerName": "",
"plateLicense": "",
"directionType": -1,
"allowResult": -1
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

371
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Response data details.
total Req. Number Total number of records, the
maximum length is 10 characters.
pageIndex Req. Number The current page No., the maximum
length is 10 characters.
pageSize Req. Number Number of records on each page, the
maximum length is 4 characters.
list Req. Array List of vehicle passing records.
list[0] Req. PassingRecordInf Information about a vehicle passing
o record.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"total":3,
"pageIndex":1,
"pageSize":3,
"list":[{
"guid":"0F388D71AFA346CABCBA4FB91312861B",
"parkingLotInfo":{
"parkingLotIndexCode":"1",
"parkingLotName":"parking lot33"
},
"passagewayInfo":{
"passagewayIndexCode":"1",
"passagewayName":"Default Entrance & Exit01"
},
"laneInfo":{
"laneIndexCode":"1",
"laneName":"entrance 1",
"direction":1
},

372
 HikCentral Professional OpenAPI Developer Guide

"personInfo":{
"cardNum":"",
"ownerName":"",
"ownerPhoneNum":""
},
"carInfo":{
"plateLicense":"BJ08FNV",
"carType":3,
"ImageUrl":"Vsm://PHQG#20210721#20210721_232955105.d:198227798:102096",
"EnterTime":"2021-07-21T23:59:57+08:00",
"ExitTime":""
},
"allowType":3,
"allowResult":2
},
{
"guid":"31775DB5BF1940F681D03FD7DBDA623E",
"parkingLotInfo":{
"parkingLotIndexCode":"1",
"parkingLotName":"parking lot33"
},
"passagewayInfo":{
"passagewayIndexCode":"1",
"passagewayName":"Default Entrance & Exit01"
},
"laneInfo":{
"laneIndexCode":"1",
"laneName":"entrance 1",
"direction":1
},
"personInfo":{
"cardNum":"",
"ownerName":"",
"ownerPhoneNum":""
},
"carInfo":{
"plateLicense":"N500GES",
"carType":3,
"ImageUrl":"Vsm://PHQG#20210721#20210721_232955105.d:198025042:100636",
"EnterTime":"2021-07-21T23:59:50+08:00",
"ExitTime":""
},
"allowType":3,
"allowResult":2
},
{
"guid":"4EE0D343B9D94DA58FA335D2506DC290",
"parkingLotInfo":{
"parkingLotIndexCode":"1",
"parkingLotName":"parking lot33"
},
"passagewayInfo":{

373
 HikCentral Professional OpenAPI Developer Guide

"passagewayIndexCode":"1",
"passagewayName":"Default Entrance & Exit01"
},
"laneInfo":{
"laneIndexCode":"1",
"laneName":"entrance 1",
"direction":1
},
"personInfo":{
"cardNum":"",
"ownerName":"",
"ownerPhoneNum":""
},
"carInfo":{
"plateLicense":"VE54CTY",
"carType":3,
"ImageUrl":"Vsm://PHQG#20210721#20210721_232955105.d:197822794:101588",
"EnterTime":"2021-07-21T23:59:44+08:00",
"ExitTime":""
},
"allowType":3,
"allowResult":2
}]
}
}

5.7.8 POST /artemis/api/vehicle/v1/parkingspace/record

Get the vehicle parking records.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/parkingspace/record
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageIndex Req. Number Body The current page No., which is
between 1 and 2147483647.
The maximum length is 10
characters.

374
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500. The maximum length is 3
characters.
queryInfo Req. Object Body Search condition.
parkingLotInd Opt. String Body Parking lot ID, the maximum
exCode length is 1024 characters.
floorIndexCod Opt. String Body Floor ID, the maximum length
e is 1024 characters.
beginTime Req. String Body Start time in ISO 8601 format
of search, which is represented
by "yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07-26T15:00:00+08:00".
The maximum length is 32
bytes.
endTime Req. String Body End time in ISO 8601 format of
search, which is represented by
"yyyy-MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07-26T15:00:00+08:00".
The maximum length is 32
bytes.
spaceSerial Opt. String Body Space serial No., the maximum
length is 32 characters.
plateLicense Opt. String Body License plate number, the
maximum length is 32
characters.
statusType Opt. Number Body Parking status: 0 (parking), 1
(exited), -1 (all).

Request Example
{
"pageIndex":1,
"pageSize":3,
"queryInfo":{

375
 HikCentral Professional OpenAPI Developer Guide

"parkingLotIndexCode":"1",
"floorIndexCode":"1",
"beginTime":"2021-07-22T00:00:00+08:00",
"endTime":"2021-07-22T23:59:59+08:00",
"spaceSerial":"1",
"plateLicense":"",
"statusType":0
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Response data details.
total Req. Number Total number of records, the
maximum length is 10 characters.
pageIndex Req. Number The current page No., the maximum
length is 10 characters.
pageSize Req. Number Number of records on each page, the
maximum length is 4 characters.
list Req. Array List of vehicle parking records.
list[0] Req. ParkingRecordInf Information about a vehicle parking
o record.

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"total":3,
"pageIndex":1,

376
 HikCentral Professional OpenAPI Developer Guide

"pageSize":3,
"list":[{
"guid":30726,
"parkingLotIndexCode":"1",
"parkingLotName":"parkinglot",
"floorIndexCode":"1",
"floorName":"F3",
"parkingSpaceSerial":"11",
"plateLicense":"ARB209KE",
"parkingStatusType":0,
"occurTime":"2021-07-22T23:59:51+08:00"
},
{
"guid":30725,
"parkingLotIndexCode":"1",
"parkingLotName":"parkinglot",
"floorIndexCode":"1",
"floorName":"F3",
"parkingSpaceSerial":"11",
"plateLicense":"unknown",
"parkingStatusType":0,
"occurTime":"2021-07-22T23:59:41+08:00"
},
{
"guid":30721,
"parkingLotIndexCode":"1",
"parkingLotName":"parkinglot",
"floorIndexCode":"1",
"floorName":"F3",
"parkingSpaceSerial":"11",
"plateLicense":"unknown",
"parkingStatusType":0,
"occurTime":"2021-07-22T23:59:18+08:00"
}]
}
}

5.7.9 POST /artemis/api/vehicle/v1/parkingfee/calculate

Calculate the parking fee based on parking information (parking start time, total parking time,
parking fee rule type, parking fee rule ID, parking fee rule name) for a specific license plate No.
from exact match.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/parkingfee/calculate

377
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
plateLicense Opt. String Body License plate number, the
maximum length is 32
characters.

Request Example
{
"plateLicense" : "2700H"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details.
data Req. Object See details in ParkingFeeCalculate .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"plateLicense": "2700H",
"parkingInTime": "2022-03-30T11:39:35+08:00",
"parkingDuration": 1134404,
"feeRuleType": 1,
"feeRuleIndexCode": "1",
"feeRuleName": "rule1",
"fee": "10.00"

378
 HikCentral Professional OpenAPI Developer Guide

}
}

5.7.10 POST /artemis/api/vehicle/v1/parkingfee/confirm

Confirm the payment of parking fee and allow exit for a specific license plate No. from exact match.
Payment on exit will be made via booth, and the vehicle is allowed to pass the barrier gate once it
is recognized by camera; payment before exit will be made via toll center, and if the final parking
time exceeded the paid duration, the extra fee will also be charged on exit via booth.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/vehicle/v1/parkingfee/confirm
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
plateLicense Req. String Body License plate number, the
maximum length is 32
characters.
immediatelyLe Req. Number Body Whether the vehicle is leaving
ave the parking lot immediately.
fee Req. String Body Parking fee. The maximum
length is 32.

Request Example
{
"plateLicense" : "2700H",
"immediatelyLeave" : 0,
"fee" : "200"
}

379
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details.
data Req. Object See details in ParkingFeeConfirm .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"fee": "200.00",
"feeTime": "2022-04-12T14:48:11+08:00"
}
}

5.7.11 POST /artemis/api/vehicle/v1/vehicle/blocklist/add

Add a vehicle to the blocklist.

Request URL
https://[serverAddress]:[serverPort]/api/vehicle/v1/vehicle/blocklist/add
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
' / \ : * ? " < > |.
plateLicense Req. String Body License plate number, which
consists of 1 to 32 characters,

380
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
but cannot contain special
characters like ' / \ : * ? " < > |.
personGivenN Opt. String Body Person's given name, which
ame consists of 1 to 16 characters,
but cannot contain special
characters like ' / \ : * ? " < > |.
personFamily Opt. String Body Person's family name, which
Name consists of 1 to 16 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
phoneNo Opt. String Body Contact number, which can
contain numbers from 0-9, and
special characters ＋ and －.
The maximum length is 32.
description Opt. String Body Vehicle description, which
consists of 1 to 128 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
effectiveDate Req. String Body Start time of blocking, in ISO
8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00".
expiredDate Req. String Body End time of blobking, in ISO
8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00".

Request Example
{
"plateLicense":"123",
"personGivenName":"KaiRui",
"personFamilyName":"Jin",
"phoneNo":"1-1807894561",

381
 HikCentral Professional OpenAPI Developer Guide

"description":"xxxxxx",
"effectiveDate":"2022-03-21T00:00:00+08:00",
"expiredDate":"2023-03-25T23:59:59+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.7.12 POST /artemis/api/vehicle/v1/vehicle/blocklist/get

Search the vehicle blocklist. Advanced search can be performed by specifying the license plate
number, family name of the owner, given name of the owner, contact number of the owner, or
vehicle description as the keyword. Fuzzy search is supported. If no search condition specified,
information of all vehicles will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/api/vehicle/v1/vehicle/blocklist/get
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

382
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
' / \ : * ? " < > |.
pageIndex Req. Number Body The current page No., which is
between 1 and 2147483647.
The maximum length is 10
characters.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500. The maximum length is 3
characters.
keyWords Opt. String Body The license plate number,
family name of the owner,
given name of the owner,
contact number of the owner,
or vehicle description. Fuzzy
search is supported. If no
search condition specified,
information of all vehicles will
be returned by page.

Request Example
{
"pageIndex": 1,
"pageSize" : 10,
"keyWords" : ""
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
msg Req. String Status or error description, which is in
one-to-one correspondence with the

383
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

code, refer to Status or Error Code for
details.
data Req. Object See details in PageInfo.

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No., which is
between 1 and 2147483647.
pageSize Opt. Number Number of records on each page,
which is between 1 and 500.
list Opt. object See details in ForbiddenVehicleInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageIndex": 1,
"pageSize": 10,
"list": [
{
"vehicleIndexCode": "1",
"plateLicense": "123",
"personGivenName": "KaiRui",
"personFamilyName": "Jin",
"phoneNo": "1-1807894561",
"description": "xxxxxx",
"effectiveDate": "2022-03-21T00:00:00+08:00",
"expiredDate": "2023-03-25T23:59:59+08:00"
}
]
}
}

5.7.13 POST /artemis/api/vehicle/v1/vehicle/blocklist/modify

Edit the vehicle in the blocklist.

384
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/api/vehicle/v1/vehicle/blocklist/modify
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
vehicleIndexC Req. String Body Blocklist vehicle ID, which
ode consists of up to 32 characters.
plateLicense Req. String Body License plate number, which
consists of 1 to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |.
personGivenN Opt. String Body Person's given name, which
ame consists of 1 to 16 characters,
but cannot contain special
characters like ' / \ : * ? " < > |.
personFamily Opt. String Body Person's family name, which
Name consists of 1 to 16 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
phoneNo Opt. String Body Contact number, which can
contain numbers from 0-9, and
special characters ＋ and －.
The maximum length is 32.
description Opt. String Body Vehicle description, which
consists of 1 to 128 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
effectiveDate Req. String Body Start time of blocking, in ISO
8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time

385
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
zone", e.g., "2018-07-
26T15:00:00 + 08:00".
expiredDate Req. String Body End time of blobking, in ISO
8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00".

Request Example
{
"vehicleIndexCode" : "1",
"plateLicense":"9999",
"personGivenName":"KaiRui",
"personFamilyName":"Jin",
"phoneNo":"1-1807894561",
"description":"xxxxxx",
"effectiveDate":"2022-03-21T00:00:00+08:00",
"expiredDate":"2023-03-25T23:59:59+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

386
 HikCentral Professional OpenAPI Developer Guide

5.7.14 POST /artemis/api/vehicle/v1/vehicle/blocklist/delete

Delete the vehicle from the blocklist.

Request URL
https://[serverAddress]:[serverPort]/api/vehicle/v1/vehicle/blocklist/delete
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
vehicleIndexC Req. String Body ID list of vehicles from blocklist,
odes in "1,2,3,4,5" format, which
consists of up to 32 characters.

Request Example
{
"vehicleIndexCodes" : "1,2,3"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details.

Response Example
{
"code": "0",
"msg": "Success",

387
 HikCentral Professional OpenAPI Developer Guide

"data": ""
}

5.8 Access Control API

Here provides APIs for access point control, access record search, applying person information,
getting access control event picture, and so on.

5.8.1 POST /artemis/api/acs/v1/auth/applicationResult

Get status details of applying person information or persons' access level settings to device.
Currently, the returned status details are about applying failure and waiting to be applied.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/auth/applicationResult
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
' / \ : * ? " < > |.
applicationRes Req. Number Body Applying result type: 1-get
ultType statistics data, 2-get error
information.
pageNo Opt. Number Body The current page No., which is
between 1 and 2147483647.
The maximum length is 10
bytes. This parameter is valid
only when the value of
applicationResultType is 2.
pageSize Opt. Number Body Number of records on each
page, which is between 1 and
500. The maximum length is 4
bytes. This parameter is valid

388
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
only when the value of
applicationResultType is 2.
type Req. Number Body Access level type: 1 (access
control), 2 (visitor).

Request Example
{
"applicationResultType": 1,
"pageNo": 1,
"pageSize": 2,
"type": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Applying result details.
statisticResult Opt. Object Statistics results, see details in
StatisticResult . This parameter will
be returned when the value of
applicationResultType is 1.
applicationErrorR Opt. Object Applying failure information, see
esult details in ApplicationErrorResult .
This parameter will be returned when
the value of applicationResultType is
2.

389
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"statisticResult": {
"unApplicationCount": 3,
"applicationFailCount": 2,
"editAndUnApplicationCount": 1
}
}
}

5.8.2 POST /artemis/api/acs/v1/door/doControl

Control the door to open, close, remain open, and remain closed by door ID.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/door/doControl
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
doorIndexCod Req. List of String Body Access point ID, and up to 10
es access points can be obtained.
controlType Req. Number Body Control types: 0-remain open,
1-close, 2-open, 3-remain
closed.
controlDirecti Req. Number Body Door control direction: 0-entry,
on 1-exit. For regular doors, it is
only 0; for barrier gates, both
values are available.

Request Example
{
"doorIndexCodes":["1","2"],

390
 HikCentral Professional OpenAPI Developer Guide

"controlType":3,
"controlDirection":0,
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Returned status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.
data Opt. Array Information list of access point
control results.
data[0] Opt. Object Information of an access point control
result. Refer to DoorControlResult for
details.

Response Example
{
"code":"0",
"msg":"Success",
"data":[
[
{
"doorIndexCode":"1",
"controlResultCode":0,
"controlResultDesc":"Success"
},
{
"doorIndexCode":"2",
"controlResultCode":0,
"controlResultDesc":" Success "
}
]
]
}

391
 HikCentral Professional OpenAPI Developer Guide

5.8.3 POST /artemis/api/acs/v1/door/events

Set search conditions (time, person name, access point ID, event type, etc.) to search for access
records (access by card, face, fingerprint, and so on), and the search results (authentication
method, card information, face information, fingerprint information, etc.) will be returned by page.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/door/events
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
eventType Req. Number Body Event type code, which is a
decimal integer, refer to Event
Types or Alarm Categories for
details.
personName Opt. String Body Person name, which which
consists of up to 32 characters,
but cannot contain special
characters like ' / \ : * ? " < > |
doorIndexCod Req. String Body Access point ID, and up to 10
es access points can be obtained.
startTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:
yyyy-MM-ddTHH:mm:ss
+current zone, e.g., 2018-07-
26T15:00:00+08:00. And the
time consists of up to 64
characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:
yyyy-MM-ddTHH:mm:ss
+current zone, e.g., 2018-07-
26T15:00:00+08:00. And the

392
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
time consists of up to 64
characters.
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
temperatureSt Opt. Number Body Temperature status: 0-
atus unknown, 1-normal, 2-
abnormal.
wearMaskStat Opt. Number Body Wearing mask or not: 0-
us unknown, 1-yes, 2-no.

Note
● The days between start time and end time should be no more than 31 days.
● At least one of the parameters eventType and personName must be configured.

Request Example
{
"startTime":"2018-08-10T12:00:00.000+08:00",
"endTime":"2018-08-11 12:00:00.000+08:00",
"eventType": 197151,
"personName": "a",
"doorIndexCodes":["1","2"],
"pageNo":1,
"pageSize":100
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

393
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Card swiping or access record list.
list[0] Opt. Object Information of a card swiping record
in the list. See details in
PersonInOutEvents .

Response Example
{
"code":"0",
"msg":"Success",
"data":{
"pageSize":100,
"pageNo":1,
"total":1,
"list":[
{
"eventId":"58689546546576576215475",
"eventType":"197151",
"eventTime":"2018-08-10 20:00:00",
"personId":"1",
"personName":"a",
"doorName":"xxxDoor",
"doorIndexCode":"1"
}
]
}
}

394
 HikCentral Professional OpenAPI Developer Guide

5.8.4 POST /artemis/api/acs/v1/event/pictures

Get pictures of access control events.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/event/pictures
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
domainId Opt. Number Header Domain name of pictures to be
obtained.
picUri Req. String Body Picture URI (relative path). The
maximum length is 512 bytes.

Request Example
{
"picUri":"0B4E92A30AF914C1285613A4FBD9F761F"
}

Response Example
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls49L0y20yFyy29ukSs3UhVAB/
SigyEjFFG5+2RioRUV0P/2Q=="
"data:image/jpeg;base64,/9j/4AAQSkzFYSEbxpSTWIl7lb2dtYSUW4zd9E/K/U+h9Ls49L0y20yFyy29ukSs3UhVAB/
SigyEjFFG5+2RioRUV0P/2Q=="

5.8.5 POST /artemis/api/acs/v1/privilege/group

Get access level list.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/privilege/group

395
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
type Req. Number Body Access level type value: 1
(access control), 2 (visitor).

Request Example
{
"pageNo": 1,
"pageSize": 10,
"type": 1
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.

396
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Information list of access levels.
list[0] Opt. Object Information about an access level.
See details in PrivilegeGroupInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 10,
"list": [
{
"privilegeGroupId": "2",
"privilegeGroupName": "234",
"description": "",
"timeSchedule": {
"indexCode": "1",
"name": ""
}
},
{
"privilegeGroupId": "1",
"privilegeGroupName": "123",
"description": "",
"timeSchedule": {
"indexCode": "1",
"name": ""
}
}
]
}
}

5.8.6 POST /artemis/api/acs/v1/privilege/group/single/addPersons

Assign access levels to persons.

397
 HikCentral Professional OpenAPI Developer Guide

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/privilege/group/single/addPersons
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
privilegeGrou Req. String Body Access group ID, which consists
pId of up to 64 characters.
type Req. Number Body Access level type: 1 (access
control), 2 (visitor).
list Req. Array Body Person information list.
list[0] Req. Object Body Information about a person.
id Req. String Body Person (visitor) ID, which
consists of up to 64 characters.

Request Example
{
"privilegeGroupId": "1",
"type": 1,
"list": [
{
"id": "1"
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

398
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

5.8.7 POST /artemis/api/acs/v1/privilege/group/single/deletePersons

Unassign access levels to persons.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/privilege/group/single/deletePersons
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
privilegeGrou Req. String Body Access group ID, which consists
pId of up to 64 characters.
type Req. Number Body Access level type: 1 (access
control), 2 (visitor).
list Req. Array Body Person information list.

399
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
list[0] Req. Object Body Information about a person in
the list.
id Req. String Body Person (visitor) ID, which
consists of up to 64 characters.

Request Example
{
"privilegeGroupId": "1",
"type": 1,
"list": [
{
"id": "1"
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.

Response Example
{
"code": "0",
"msg": "Success",
"data": ""
}

400
 HikCentral Professional OpenAPI Developer Guide

5.8.8 POST /artemis/api/acs/v1/privilege/group/single/personList

Get information list of persons related to the access levels.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/acs/v1/privilege/group/single/personList
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
type Req. Number Body Access level type value: 1-
access control, 2 (visitor,
currently, it is not supported).
privilegeGrou Req. String Body Access group ID, the maximum
pId length is 64 characters.

Request Example
{
"pageNo": 1,
"pageSize": 2,
"type": 1,
"privilegeGroupId": "1"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer

401
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data details.
total Opt. Number Total number of search results.
pageNo Opt. Number The current page No.
pageSize Opt. Number Number of records on each page.
list Opt. Array Person information list.
list[0] Opt. Object Information about a person. See
details in PersonInfo .
id Req. String Person ID, which consists of up to 64
characters.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageNo": 1,
"pageSize": 2,
"list": [
{
"id": "1"
}
]
}
}

402
 HikCentral Professional OpenAPI Developer Guide

5.8.9 POST /artemis/api/visitor/v1/auth/reapplication

Apply persons' access level settings or information (person ID, person name, face picture,
fingerprint, card No., validity, etc. according to device capability) to device when the persons'
access level or person information changed.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/auth/reapplication
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
orderId Req. String Body Currently not in use.
ImmediateDo Opt. Integer Body 0-immdiately apply persons,
wnload including those which have
failed, 1-immdiately apply
persons, excluding those which
have failed
personIds Opt. String Body Person ID list. Multiple items
are separated by comma.
doorIndexCod Opt. String Body Door ID list. Multiple items are
es separated by comma.

Response Example
{
"ImmediateDownload": 0,
"personIds": "1",
"doorIndexCodes": "2"
}

403
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code contains up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description contains up
to 256 characters.
data Opt. String Response data.

Response Example
{
"code": "0",
"msg": "ok",
"data": ""
}

5.8.10 POST /artemis/api/visitor/v1/person/ID/elementDownloadDetail

Get the access level application information of a visitor.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/visitor/v1/person/ID/elementDownloadDetail
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
id Req. String Body Visitor ID. The maximum length
is 64.

404
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
"visitorId": "125"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. elementDownloa List of access level application
dDetail [] information. See details in
ElementDetail . The maximum length
of this field is 128.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"ElementDetailList": {
"ElementDetail": [
{
"BaseInfo": {
"Name": "undefined",
"ElementType": 0,
"Network": 0
},
"ElementStatus": {
"Status": "-1",
"ErrorModule": "0",
"ErrorCode": "0"
},
"CertificateStatusList": {
"CertificateStatus": [

405
 HikCentral Professional OpenAPI Developer Guide

{
"Type": "0",
"ID": "0",
"Status": "-1",
"ErrorModule": "0",
"ErrorCode": "0"
}
]
},
"ID": "0"
}
]
}
}
}

5.9 On-Board Monitoring API

5.9.1 POST /artemis/api/mobilesurveillance/v1/gpsdetails

Get GPS statistics information of on-board devices.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/mobilesurveillance/v1/gpsdetails
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
pageNo Req. Number Body The current page No., which is
between 1 and 2147483647.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.
mobilevehicleI Req. String Body IDs of vehicles linked to on-
ndexCodes board devices. Use comma to

406
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
separate multiple items, e.g.,
"1, 2, 5".
startTime Req. String Body Start time of search, in ISO
8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters.
endTime Req. String Body End time of search, in ISO 8601
format, which is represented
by "yyyy- MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 characters. It should not
exceed 31 days from start to
end.

Request Example
{
"pageNo": 1,
"pageSize": 15
"mobilevehicleIndexCodes":"1,2"
"startTime": "2022-02-10T15:00:00+08:00",
"endTime": "2022-02-11T16:00:00+08:00"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

407
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. PageInfo[] Response data details.

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No., which is
between 1 and 2147483647.
pageSize Opt. Number Number of records on each page,
which is between 1 and 500.
list Opt. detailInfo[] Detailed information list.

detailInfo Object Description

Parameter Name Req. or Opt. Data Type Description

mobilevehicleInd Req. String ID of vehicle linked to the on-board
exCode device.
plateNo Number License plate No.
regionIndexCode Number Area ID.
list Req. gpsInfo GPS information.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"total": 1,
"pageIndex": 1,
"pageSize": 10,

408
 HikCentral Professional OpenAPI Developer Guide

"list": [
{
"mobilevehicleIndexCode": "1",
"plateNo": "zhe123",
"regionIndexCode": "1",
"gps_info_list": [
{
"occurTime": "2022-02-16 11:20:08",
"longitude": -1,
"latitude": -1,
"direction": 0,
"gpsDisplay": "E120,13,42;N30,12,1",
"directionDisplay": "North",
"speed": 10
}
]
}
]
}
}

5.9.2 POST /artemis/api/mobilesurveillance/v1/recordOverview

Search for event records of vehicles linked to on-board devices (only including the brief
information). See details via specific event protocols.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/mobilesurveillance/v1/recordOverview
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
mobilevehicleI Req. String Body IDs of vehicles linked to on-
ndexCodes board devices. Use comma to
separate different items. The
maximum length is 64
characters.
eventTypes Opt. String Body Event types. Use comma to
separate different items. The

409
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
maximum length is 1024
characters.
beginTime Req. String Body Start time of search, in ISO
8601 format, which is
represented by "yyyy- MM-
ddTHH:mm:ss+current time
zone", e.g., "2018-07-
26T15:00:00 + 08:00". The
maximum length is 64
characters.
endTime Req. String Body End time of search, in ISO 8601
format, which is represented
by "yyyy- MM-ddTHH:mm:ss
+current time zone", e.g.,
"2018-07- 26T15:00:00
+ 08:00". The maximum length
is 64 characters. It should not
exceed 31 days from start to
end.
centerLongitu Opt. String Body Center longitude (0 by default).
de The maximum length is 16
characters.
centerLatitude Opt. String Body Center Latitude (0 by default).
The maximum length is 16
characters.
radius Opt. Number Body Radius (unit: m; 0 by default).
pageIndex Req. Number Body The target page No., which is
between 1 and 2147483648.
pageSize Req. Number Body Number of records on each
page, which is between 1 and
500.

Request Example
{
"pageIndex": 1,
"pageSize": 10,
"mobilevehicleIndexCodes": "1,2",

410
 HikCentral Professional OpenAPI Developer Guide

"eventTypes": "330203,330003",
"beginTime": "2022-02-14T15:00:00+08:00",
"endTime": "2022-02-15T15:00:00+08:00",
"centerLongitude": "0.0",
"centerLatitude": "0.0",
"radius": 0
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data: event records in page.

PageInfo Object Description

Parameter Name Req. or Opt. Data Type Description

total Opt. Number Total number of search results.
pageNo Opt. Number The current page No., which is
between 1 and 2147483647.
pageSize Opt. Number Number of records on each page,
which is between 1 and 500.
list Opt. RecordOverview Event record list.

Response Example
{

"code": "0",
"msg": "success",
"data": {
"total": "1",
"pageNo": "1",

411
 HikCentral Professional OpenAPI Developer Guide

"pageSize": "10",
"list": [
{
"eventIndexCode": "BF1A2B849C5E4EDC858EF295A4E7DD2D",
"eventType": "330406",
"mobilevehicleIndexCode": "1",
"plateNo": "zhe123",
"ownerName": "ll",
"regionName": "area1",
"occurTime": "2022-02-12T15:46:58+08:00",
"longitude": "0.0",
"latitude": "0.0",
"direction": "0",
"speed": 0,
"displayInfo": "E0,0,0;N0,0,0",
"directionInfo": "North"
}
]
}
}

5.9.3 POST /artemis/api/mobilesurveillance/v1/single/record

Search for event information of a on-board device.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/mobilesurveillance/v1/single/record
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
mobilevehicleI Req. String Header ID of vehicle linked to the on-
ndexCode board device. The maximum
length is 64 characters.
eventIndexCo Req. String Header Event record ID. The maximum
de length is 64 characters.

412
 HikCentral Professional OpenAPI Developer Guide

Request Example
{
“mobilevehicleIndexCode":"1",
" eventIndexCode ": "BF1A2B849C5E4EDC858EF295A4E7DD2D"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. MSEventRecord Response data: record of an event.

MSEventRecord Object Description

Parameter Name Req. or Opt. Data Type Description

eventType Req. Number Event type. The maximum length is 16
characters.
mobilevehicleInd Req. String ID of vehicle linked to the on-board
exCode device. The maximum length is 64
characters.
plateNo Req. String License plate No. The maximum
length is 10 characters.
regionName Req. Number Area name. The maximum length is 4
characters.
ownerName Opt. String Vehicle owner name.
phoneNo Opt. String Contact number of the vehicle owner.
The maximum length is 64 characters.

413
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

occurTime Req. String GPS report time, in ISO 8601 standard
time format: yyyy-MMdd'T'HH:
mm:ss.SSSzzz, e.g., 2018-07-
26T15:00:00 + 08:00. And the time
consists of up to 64 characters.
longitude Req. String Longitude (integer; including negative
values), actual degrees × 3600 × 100
＋ acutal minutes × 60 × 100 ＋
actual seconds × 100. The maximum
length is 16 characters.
latitude Req. String Latitude (integer; including negative
values), actual degrees × 3600 × 100
＋ acutal minutes × 60 × 100 ＋
actual seconds × 100. The maximum
length is 16 characters.
direction Req. Number Vehicle direction (calculated clockwise
from due north (0); the actual degree
* 100; [0, 36000)).
speed Req. Float Speed (consistent with the HCP
platform: km/h by default). The
maximum length is 16 characters.
speedLimit Req. Number Speed threshold (consistent with the
HCP platform: km/h by default). The
maximum length is 16 characters.
displayInfo Req. String Displayed GPS information, e.g., E120,
50, 20; N30, 50, 20. The maximum
length is 64 characters.
directionInfo Req. String Displayed direction ("North",
"Northeast", "East", "Southeast",
"South", "Southwest", "West",
"Northwest"). The maximum length is
16 characters.
image_url_list Opt. image_info_list[] Picture URL list. You can call POST /
artemis/api/mobilesurveillance/v1/

414
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

picture_download to download
pictures.
image_url Opt. String Picture URL. The maximum length is
256 characters. You can call POST /
artemis/api/mobilesurveillance/v1/
picture_download to download
pictures.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"eventType": 330203,
"mobilevehicleIndexCode": "1",
"plateNo": "zhe123",
"regionName": "车车",
"ownerName": "",
"phoneNo": "",
"occurTime": "2022-02-16T14:39:36-08:00",
"longitude": "120.204",
"latitude": "30.1894",
"direction": 5628,
"speed": 30,
"speedLimit": "80",
"displayInfo": "E120,12,13;N30,11,21",
"directionInfo": "Northeast",
"image_url_list": [
{
"image_url": "Vsm://PHQG#20220216#20220216_134335874.d:12:62692"
}
]
}
}

5.9.4 POST /artemis/api/mobilesurveillance/v1/picture_download

Download pictures and videos from on-board monitoring event search or notification pushing.

Request URL
https://[serverAddress]:[serverPort]/api/mobilesurveillance/v1/picture_download

415
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of up to
32 characters, but cannot
contain special characters like
' / \ : * ? " < > |.
url Req. String Header Download resource URL, which
can be obtained from on-board
monitoring event search or on-
board monitoring event
notification pushing. The
maximum length is 1024.
picType Req. Number Header Download resource type: 0-
picture, 1-video.

Request Example
{
"url":
"Dev://picture/Streaming/tracks/303/?name=405812&size=405812&DEVICE=26&TYPE=0&VSM=0",
"picType": 0
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
pic_data Req. String Returned picture or video data,
encrypted with Base64 method.

416
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"pic_data": "FGde2GG3438F934U324aF0DG…"
}
}

5.10 Person Search API

5.10.1 POST /artemis/api/body/v1/application/pictureRecognition

Detect the human body in the picture encoded by Base64 and get the coordinates of the body in
the picture, which is the first part of search for matched human bodies on Intelligent Fusion Server
and DeepinMind NVR. DeepinMind NVR accessed via ISUP supports configuring picture storage to
the local PC, CVR, or pStor storage.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/body/v1/application/pictureRecognition
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
protocolType Req. Number Body Device type to be accessed: 0-
Intelligent Fusion Server (by
default; when this field is not
configured), 1-DeepinMind
NVR.
intelligentServ Opt. String Body ID for Intelligent Fusion Server
erIndexCode on the HikCentral Professional
platform. The maximum length
is 32.

417
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
encodeDeviceI Opt. String Body DeepinMind NVR device ID on
ndexCode the HikCentral Professional
platform. This field is required
and valid when protocolType is
1.
pictureData Req. String Body Picture data encoded by
Base64.

Request Example
{
"protocolType": 1,
"intelligentServerIndexCode": "3",
"encodeDeviceIndexCode": "1",
"pictureData": "base64"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data.

Table 5-8 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
Rect Opt. bodyRecord[] List of detected human body
information. See details in bodyRect .

418
 HikCentral Professional OpenAPI Developer Guide

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"Rect": [
{
"height": "0.81",
"width": "0.15",
"x": "0.12",
"y": "0.21"
}
]
}
}

5.10.2 POST /artemis/api/body/v1/application/pictureModel

Model human body in the picture encoded by Base64 and get the modeling data, which is the
second part of search for matched human bodies on Intelligent Fusion Server and DeepinMind
NVR. DeepinMind NVR accessed via ISUP supports configuring picture storage to the local PC, CVR,
or pStor storage.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/body/v1/application/pictureModel
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
protocolType Req. Number Body Device type to be accessed: 0-
Intelligent Fusion Server (by
default; when this field is not
configured), 1-DeepinMind
NVR.
intelligentServ Req. String Body ID for Intelligent Fusion Server
erIndexCode on the HikCentral Professional

419
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
platform. The maximum length
is 32.
encodeDeviceI Opt. String Body DeepinMind NVR device ID on
ndexCode the HikCentral Professional
platform. This field is required
and valid when protocolType is
1.
pictureData Req. String Body Picture data encoded by
Base64.
data Req. Object Body Detected human body
information.

Table 5-9 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
bodyRect Req. Object Normalized x-coordinate from the
upper-​left corner to the right and y-
coordinate from the upper-​left corner
to the downward. Range of value:
[0.000, 1.000].
height Req. String Height of detected human body in the
picture, normalized to [0.000, 1.000].
width Req. String Width of detected human body in the
picture, normalized to [0.000, 1.000].
x Req. String Normalized x-coordinate from the
upper-​left corner to the right. Range
of value: [0.000, 1.000].
y Req. String Normalized y-coordinate from the
upper-​left corner to the downward.
Range of value: [0.000, 1.000].

Request Example
{
"protocolType": 1,
"intelligentServerIndexCode": "1",
"encodeDeviceIndexCode": "1",

420
 HikCentral Professional OpenAPI Developer Guide

"pictureData": "test",
"data": {
"Rect": {
"height": "0.81",
"width": "0.15",
"x": "0.21",
"y": "0.12"
}
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. Object Response data.

Table 5-10 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
ModelData Opt. String Human body modeling data.

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"ModelData": "test"
}
}

421
 HikCentral Professional OpenAPI Developer Guide

5.10.3 POST /artemis/api/body/v1/application/captureSearch

Get matched human bodies in a specified time period by a specified camera by body picture
comparison according to the human body modeling data, which is the third part of search for
matched human bodies on Intelligent Fusion Server and DeepinMind NVR. DeepinMind NVR
accessed via ISUP supports configuring picture storage to the local PC, CVR, or pStor storage.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/body/v1/application/captureSearch
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
protocolType Req. Number Body Device type to be accessed: 0-
Intelligent Fusion Server (by
default; when this field is not
configured), 1-DeepinMind
NVR.
intelligentServ Req. String Body ID of Intelligent Fusion Server
erIndexCode on the HikCentral Professional
platform. The maximum length
is 32.
encodeDeviceI Opt. String Body DeepinMind NVR device ID on
ndexCode the HikCentral Professional
platform. This field is required
and valid when protocolType is
1.
cameraIndexC Req. String Body ID of camera under Intelligent
odes Fusion Server or NVR, and the
maximum length is 32. Multiple
IDs are separated by comma
and up to 10 IDs are allowed.
modeldata Req. String Body Human body modeling data.

422
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
startTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:
yyyy-MMdd'T'HH:
mm:ss.SSSzzz, e.g., 2018-07-
26T15:00:00 + 08:00. And the
time consists of up to 64
characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:
yyyy-MMdd'T'HH:
mm:ss.SSSzzz, e.g., 2018-07-
26T15:00:00 + 08:00. And the
time consists of up to 64
characters.
similarity Req. String Body Similarity of the searched
pictures. The maximum length
is 32.
sortType Req. String Body Sort type of search results: sort
by time or sort by similarity.
The maximum length is 64.
maxResults Req. Number Body Max. number of search results.
searchResultP Opt. Number Body The start position of the search
osion result in the result list.
modelMaxNu Opt. Number Body Max. number of returned
m models. The max number is
100.

Request Example
{
"protocolType": 1,
"intelligentServerIndexCode": "1",
"encodeDeviceIndexCode": "1",
"cameraIndexCodes": "1,2,3",
"modelData": "test",
"startTime": "2022-08-13T17:30:08+08:00",
"endTime": "2022-08-13T17:30:08+08:00",
"similarity": "0.89",
"sortType": "time",

423
 HikCentral Professional OpenAPI Developer Guide

"maxResults": 100,
"searchResultPosition": 0,
"modelMaxNum": 100
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data.

Table 5-11 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
totalNum Req. Number Number of matched human bodies.
targetInfo Opt. targetInfo [] Searched human body information.
See details in bodyTargetInfo .

Response Example
{
"data": {
"totalNum": 1,
"targetInfo": [
{
"monitorPointIndexCode": "1",
"captureTime": "2022-05-03T17:30:08+08:00",
"cameraIndexCode": "1",
"similarity": "0.89",
"picUrl": "test",
"subPicUrl": "test",
"targetRect": {
"height": "0.89",
"width": "0.2",
"x": "0.15",

424
 HikCentral Professional OpenAPI Developer Guide

"y": "0.21"
},
"gender": 0,
"bag": 0,
"jacketType": 0,
"trousersType": 0,
"ageGroup": 0,
"hairStyle": 0,
"jacketColor": 0,
"trousersColor": 0,
"things": 0,
"mask": 0
}
]
}
}

5.10.4 POST /artemis/api/frs/v1/application/pictureRecognitionModel

Detect and model faces in the picture encoded by Base64 and get the modeling data, which is the
first part of search for matched faces on Intelligent Fusion Server and DeepinMind NVR. Multiple
faces in the picture can be detected and the modeling data for different faces can be identified by
the corresponding recognized coordinates. DeepinMind NVR accessed via ISUP supports
configuring picture storage to the local PC, CVR, or pStor storage.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/application/pictureRecognitionModel
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
protocolType Req. Number Body Device type to be accessed: 0-
Intelligent Fusion Server (by
default; when this field is not
configured), 1-DeepinMind
NVR.
intelligentServ Req. String Body ID for Intelligent Fusion Server
erIndexCode on the HikCentral Professional

425
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
platform. The maximum length
is 32.
encodeDeviceI Opt. String Body DeepinMind NVR device ID on
ndexCode the HikCentral Professional
platform. This field is required
and valid when protocolType is
1.
pictureData Req. String Body Picture data encoded by
Base64.

Request Example
{
"protocolType": 1,
"intelligentServerIndexCode": "3",
"encodeDeviceIndexCode": "1",
"pictureData": "base64"
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data.

426
 HikCentral Professional OpenAPI Developer Guide

Table 5-12 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
targets Req. faceTargets[] Face modeling data. See details in
faceTargets .

Response Example
{
"code": "0",
"msg": "success",
"data": {
"targets": [
{
"targetModelData": "test",
"faceRect": {
"height": "0.89",
"width": "0.15",
"x": "0.12",
"y": "0.21"
}
}
]
}
}

5.10.5 POST /artemis/api/frs/v1/application/captureSearch

Get matched faces in a specified time period by a specified camera by face picture comparison
according to the face modeling data, which is the second part of search for matched faces on
Intelligent Fusion Server and DeepinMind NVR. DeepinMind NVR accessed via ISUP supports
configuring picture storage to the local PC, CVR, or pStor storage.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/frs/v1/application/captureSearch
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot

427
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
contain special characters like
'/\:*?"<>|
protocolType Req. Number Body Device type to be accessed: 0-
Intelligent Fusion Server (by
default; when this field is not
configured), 1-DeepinMind
NVR.
intelligentServ Req. String Body ID for Intelligent Fusion Server
erIndexCode on the HikCentral Professional
platform. The maximum length
is 32.
encodeDeviceI Opt. String Body DeepinMind NVR device ID on
ndexCode the HikCentral Professional
platform. This field is required
and valid when protocolType is
1.
cameraIndexC Req. String Body ID of camera under Intelligent
odes Fusion Server or NVR. The
maximum length is 32. Multiple
IDs are separated by comma
and up to 10 IDs are allowed.
targetModelD Req. String Body Face modeling data.
ata
maxResults Req. Number Body Max. number of search results.
startTime Req. String Body Start time of search, which is in
ISO 8601 standard time format:
yyyy-MMdd'T'HH:
mm:ss.SSSzzz, e.g., 2018-07-
26T15:00:00 + 08:00. And the
time consists of up to 64
characters.
endTime Req. String Body End time of search, which is in
ISO 8601 standard time format:
yyyy-MMdd'T'HH:
mm:ss.SSSzzz, e.g., 2018-07-

428
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Parameter Description

Type
26T15:00:00 + 08:00. And the
time consists of up to 64
characters.
similarityMin Req. Number Body Min. similarity of the searched
pictures.
similarityMax Req. Number Body Max. similarity of the searched
pictures.
sortType Req. String Body Sort type of search results: sort
by time or sort by similarity.
The maximum length is 64.
searchResultP Opt. Number Body The start position of the search
osion result in the result list.
modelMaxNu Opt. Number Body Max. number of returned
m models. The max number is
100.

Request Example
{
"intelligentServerIndexCode": "3",
"cameraIndexCodes": "1,2,3",
"targetModelData": "test",
"maxResults": 100,
"startTime": "2022-08-15T17:30:08+08:00",
"endTime": "2022-08-18T17:30:08+08:00",
"similarityMin": "0.01",
"similarityMax": "0.98",
"sortType": "time",
"searchResultPosition": 0,
"modelMaxNum": 100
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).

429
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Opt. PageInfo Response data.

Table 5-13 PageInfo Object Description

Parameter Req. or Opt. Data Type Description
totalNum Req. Number Number of match results from face
picture comparison.
targets Opt. targetInfo [] Information of matched faces. See
details in faceTargetInfo .

Response Example
{
"code": "0",
"msg": "Success",
"data": {
"totalNum": 1,
"targets": [
{
"code": 1,
"captureTime": "2022-05-03T17:30:08+08:00",
"monitorPointIndexCode": "1",
"picUrl": "test",
"subpicUrl": "test",
"similarity": 1,
"faceRect": {
"height": "0.8",
"width": "0.3",
"x": "0.21",
"y": "0.12"
},
"currTemperature": "36.7",
"thermometryUnit": 0,
"mask": 1,
"gender": 1,
"glasses": 1,
"smile": 1,

430
 HikCentral Professional OpenAPI Developer Guide

"ageGroup": 1
}
]
}
}

5.11 Digital Signage API

5.11.1 POST /artemis/api/focsign/v1/material/dataSource/search

Search for data source.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/focsign/v1/material/dataSource/search
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
sourceType Req. String Body Data source type: "push" (auto
push data source), "pull" (third
party database).
dataType Req. String Body Data type: "pic" (picture),
"character" (text), "table"
(table data).
sourceFrom Req. String Body Where the source is from:
"inner" (internal), "custom"
(customized), "all".

Request Example
{
"sourceType": "push",
"dataType": "character",
"sourceFrom": "all"
}

431
 HikCentral Professional OpenAPI Developer Guide

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.
data Req. Object Data source list. See details in
dataSourceData .

Response Example
{
"code": "0x0190020f",
"msg": "Success",
"data": {
"total": 1,
"list": [
{
"materialNo": 238,
"sourceName": "test_text",
"sourceID": "991D5E0041974A6BAE3D94C2178FCDF8",
"sourceType": "push",
"dataType": "character",
"sourceFrom": "custom"
}
]
}
}

5.11.2 POST /artemis/api/focsign/v1/material/dataSource/update

Update data source.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/focsign/v1/material/dataSource/update

432
 HikCentral Professional OpenAPI Developer Guide

Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
sourceID Req. String Header UUID for data source.
dataSourceDat Req. Object Body Message of data source
a update. See details in
dataSourceData .

Request Example
{
"dataType": "character",
"dataUpdateType": "cover",
"maxMaterialNum": 2,
"characterInfo": {
"contentList": [
{
"id": 1,
"content": "1111",
"playTime": 1
}
]
}
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for

433
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

details. Each description can contain
up to 256 characters.

Response Example
{
"code": "0x0190020f",
"msg": "Success"
}

5.11.3 POST /artemis/api/focsign/v1/material/dataSource/update/batch

Batch update data sources.

Request URL
https://[serverAddress]:[serverPort]/artemis/api/focsign/v1/material/dataSource/update/batch
Request Parameters

Parameter Req. or Opt. Data Type Parameter Description

Type
userId Opt. String Header User ID, which consists of 1 to
32 characters, but cannot
contain special characters like
'/\:*?"<>|
dataSourceBat Req. Object Body Message of data resource
chUpdateList update in a batch. See details in
dataSourceBatchUpdateList .

Request Example
{
"dataSourceBatchUpdateList": [
{
"dataSourceUUID": "1",
"dataType": "character",
"dataUpdateType": "cover",
"maxMaterialNum": 2,
"characterInfo": {
"contentList": [
{
"id": 1,

434
 HikCentral Professional OpenAPI Developer Guide

"content": "1111",
"playTime": 1
}
]
}
}
]
}

Response Parameters

Parameter Req. or Opt. Data Type Description

code Req. String Response status or error code: 0-
succeeded, other codes-failed (refer
to Status or Error Code for details).
Each code can contain up to 32
characters.
msg Req. String Status or error description, which is in
one-to-one correspondence with the
code, refer to Status or Error Code for
details. Each description can contain
up to 256 characters.

Response Example
{
"code": "0x0190020f",
"msg": "Success"
}

435
 HikCentral Professional OpenAPI Developer Guide

Appendix A. Appendixes

A.1 Object Description

A.1.1 accessInfo
The table here shows the visitor's access permission.

Table A-1 accessInfo Object Description

Parameter Name Req. or Opt. Data Type Description
electrostaticDete Opt. Number Electrostatic discharge testing type: 0-
ctionType no testing, 1-hand testing, 2- foot
testing, 3-hand and foot testing.
qrCodeValidNum Req. Number Number of valid door openings by QR
code: 0 by default; valid when it is
from 1 to 4.
accessLevel Opt. Object List of access permissions. See details
in AccessLevel .

A.1.2 AccessLevel
The table here shows the visitor's access permission.

Table A-2 AccessLevel Object Description

Parameter Name Req. or Opt. Data Type Description
id Req. Number The access level ID.
baseInfo Req. BaseInfo The basic information about the
access level.

A.1.3 AcsDevInfo
The table here shows the information of an access control device.

436
 HikCentral Professional OpenAPI Developer Guide

Table A-3 AcsDevInfo Object Description

Parameter Name Req. or Opt. Data Type Description
acsDevIndexCode Opt. String Access control device ID, which
consists of up to 64 characters.
acsDevName Opt. String Access control device name, which
consists of up to 32 characters.
acsDevIp Req. String IP address of access control device.
acsDevPort Req. String Port No. of access control device.
acsDevCode Opt. String Serial No. of access control device,
which consists of up to 16 characters.
treatyType Opt. String Transfer protocol types, i.e., "hiksdk_
net" (Hikvision Private Protocol), and
"ehome_reg" (ISUP-Intelligent
Security Uplink Protocol).
status Opt. Number Status of the access control device: 0-
unknown, 1-online, 2-​offline.
timeZone Opt. Object Time zone information, returned for
getting the information of an access
control device. See details in
TimeZoneInfo .

A.1.4 AlarmInputInfo
The table here shows the alarm input information.

Table A-4 AlarmInputInfo Object Description

Parameter Name Req. or Opt. Data Type Description
alarmInputIndexC Opt. String Alarm input ID, which consists of up
ode to 64 characters.
alarmInputName Opt. String Alarm input name, which consists of
up to 32 characters.
regionIndexCode Opt. String Area ID, which consists of up to 64
characters.

437
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

devIndexCode Opt. String Device ID, which consists of up to 64
characters.
devResourceType Opt. String Device resource type, i.e., "acsDevice"
(access controller), "encodeDevice"
(encoding device), "alarmDevice"
(alarm device), and "mobileDevice"
(on-board device). And the field can
contain up to 32 characters.
networkStatus Opt. number Alarm input status: 0-unknown, 1-
online, 2-​offiline.

A.1.5 AlarmOutputInfo
The table here shows the alarm output information.

Table A-5 AlarmOutputInfo Object Description

Parameter Name Req. or Opt. Data Type Description
alarmOutputInde Opt. String Alarm output ID, which consists of up
xCode to 64 characters.
alarmOutputNam Opt. String Alarm output name, which consists of
e up to 32 characters.
regionIndexCode Opt. String Area ID, which consists of up to 64
characters.
devIndexCode Opt. String Device ID, which consists of up to 64
characters.
devResourceType Opt. String Device resource type, i.e., "acsDevice"
(access controller), "encodeDevice"
(encoding device), "alarmDevice"
(alarm device), and "mobileDevice"
(on-board device). And the field can
contain up to 32 characters.
status Opt. Number Alarm output status: -1 (unknown), 0
(disabled), 1 (enabled).

438
 HikCentral Professional OpenAPI Developer Guide

A.1.6 appendInfo
The table here shows the extra information of person.

Table A-6 appendInfo Object Description

Parameter Name Req. or Opt. Data Type Description
infoType Req. Number Information type.
infoValue Req. String Information value. The maximum
length is 2048.

A.1.7 ApplicationErrorResult
The table here shows the applying failure information.

Table A-7 ApplicationErrorResult Object Description

Parameter Name Req. or Opt. Data Type Description
pageSize Opt. Number Page size. The maximum length is 64
bytes.
pageNo Opt. Number Number of pages.
applicationFailCo Opt. Number Number of failures to apply data.
unt
list Req. Array List of device error information.
list[0] Req. Object Error information of a device in the
list. See details in DeviceError .

A.1.8 ApprovalFlowInfo
The table here shows the visitor reservation review information.

Table A-8 ApprovalFlowInfo Object Description

Parameter Name Req. or Opt. Data Type Description
approvalFlowCod Req. Number Reservation review No. The maximum
e length is 64.
id Opt. Number Monitoring list ID, 0 by default. The
maximum length is 64.

439
 HikCentral Professional OpenAPI Developer Guide

A.1.9 BaseInfo
The table here shows the basic information.

Table A-9 BaseInfo Object Description

Parameter Name Req. or Opt. Data Type Description
fullName Opt. String Name, the maximum length is 128
characters.

A.1.10 bodyRect
The table here shows information of the detected human body.

Table A-10 bodyRect Object Description

Parameter Name Req. or Opt. Data Type Description
height Req. String Height of detected human body in the
picture, normalized to [0.000, 1.000].
width Req. String Width of detected human body in the
picture, normalized to [0.000, 1.000].
x Req. String Normalized x-coordinate from the
upper-​left corner to the right. Range
of value: [0.000, 1.000].
y Req. String Normalized y-coordinate from the
upper-​left corner to the downward.
Range of value: [0.000, 1.000].

A.1.11 bodyTargetInfo
The table here shows information of target human body.

440
 HikCentral Professional OpenAPI Developer Guide

Table A-11 bodyTargetInfo Object Description

Parameter Name Req. or Opt. Data Type Description
monitorPointInde Req. String Camera serial No. The maximum
xCode length is 32.
captureTime Req. String Capture time. The maximum length is
64.
similarity Req. String Similarity of the searched pictures.
The maximum length is 64.
picUrl Req. String URL for downloading the full picture.
subPicUrl Req. String URL for downloading the thumbnail.
targetRect Req. Object Normalized x-coordinate from the
upper-​left corner to the right and y-
coordinate from the upper-​left corner
to the downward. Range of value:
[0.000, 1.000].
height Req. String Height of detected human body in the
picture, normalized to [0.000, 1.000].
The maximum length is 64.
width Req. String Width of detected human body in the
picture, normalized to [0.000, 1.000].
The maximum length is 64.
x Req. String Normalized x-coordinate from the
upper-​left corner to the right. Range
of value: [0.000, 1.000]. The
maximum length is 64.
y Req. String Normalized y-coordinate from the
upper-​left corner to the downward.
Range of value: [0.000, 1.000]. The
maximum length is 64.
gender Opt. Enum 0-unknown, 1-male, 2-female.
bag Opt. Enum With backpack or not: 0-unknown, 1-
no, 2-yes.
jacketType Opt. Enum Top type: 0-unknown, 1-short sleeves,
2-long sleeves.

441
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

trousersType Opt. Enum Bottom type: 0-unknown, 1-shorts, 2-
trousers, 3-skirt.
ageGroup Opt. Enum 0-unknown, 1-teenager, 2-young
adult, 3-middle age, 4-the elderly, 5-
infant, 6-child, 7-early youth, 8-prime,
9-middle to old age.
hairStyle Opt. Enum Hairstyle: 0-short hair, 1-long hair, 2-
unknown.
jacketColor Opt. Enum Top color: 0-unknown, 1-white, 2-
gray, 3-red, 4-dark blue, 5-blue, 6-
yellow, 7-brown, 8-pink, 9-purple, 10-
dark gray, 11-cyan, 12-orange, 13-
mixture, 14-green, 15-silver, 16-black.
trousersColor Opt. Enum Bottom color: 0-unknown, 1-white, 2-
gray, 3-red, 4-dark blue, 5-blue, 6-
yellow, 7-brown, 8-pink, 9-purple, 10-
dark gray, 11-cyan, 12-orange, 13-
mixture, 14-green, 15-silver, 16-black.
things Opt. Enum Carrying things or not: 0-unknown, 1-
no, 2-yes.
mask Opt. Enum Wear mask or not: 0-unknown, 1-no,
2-yes.

A.1.12 CameraInfo
The table here shows the information of a camera.

Table A-12 CameraInfo Object Description

Parameter Name Req. or Opt. Data Type Description
cameraIndexCode Opt. String Camera ID, which consists of up to 64
characters.
cameraName Opt. String Camera name, which consists of up to
32 characters.
capabilitySet Opt. String Capability set, i.e., "vss" (video
capability), "event_veh" (vehicle

442
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

capture capability), "gis" (field of view
capability), "event_heat" (thermal
capability), "event_pdc" (people
counting capability), and "ptz" (PTZ
capability). See details in Capability
Set .
encodeDevIndexC Opt. String Encoding device ID, which consists of
ode up to 64 characters.
devResourceType String Device resource type (encodeDevice,
acsDevice, mobileDevice). See details
in Resource Types / Resource
Permission Code .
devIndexCode String Device ID, which is valid for non-
encoding devices.
recordType Opt. String Recording type, i.e., "0" (main
recording) and "1" (auxiliary
recording). And this field can contain
up to 32 characters. See details in
Recording Type .
recordLocation Opt. String Storage location of video files, i.e., "0"
(central storage), "1" (device storage),
"2" (central cluster storage). And this
field can contain up to 32 characters.
See details in Recording Storage
Location .
regionIndexCode Opt. String Area ID, which consists of up 64
characters.
status Opt. Number Camera status, i.e., 0-unknown, 1-
online, 2-​offline.
siteIndexCode Opt. String Site ID, which consists of up to 64
characters.
treatyType Opt. String Currently, this extension field is
reserved.
Transfer protocol types, i.e., "hiksdk_
net" (Hikvision Private
Protocol),"ehome_reg" (Hikvision

443
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

Intelligent Security Uplink Protocol),
and "onvif_net" (ONVIF Protocol).
And this field can contain up to 32
characters.
See details in Access Protocol of
Device .
treatyTypeName Opt. String Currently, this extension field is
reserved.
Transfer protocol name, which
consists of up to 32 characters.
isSupportWakeUp Opt. Number Whether it supports the wakeup
function: 0-no, 1-yes (currently only
supported by solar camera).
This field consists of up to 32
characters.
wakeUpStatus Opt. Number Wakeup status: 0-awaken, 1-sleeping.
This field is valid when the camera is
online, and consists of up to 32
characters.

A.1.13 CameraRecordStatus
The table shows the storage status of a camera linked to the specific Storage Server.

Table A-13 CameraRecordStatus Object Description

Parameter Name Req. or Opt. Data Type Description
cameraIndexCode Opt. String Camera ID, which consists of up to 64
characters.
cameraName Opt. String Camera name, which consists of up to
64 characters.
deviceIp Opt. String Device IP address, and the maximum
length is 64 bytes.
siteName Opt. String Site name, which consists of up to 64
characters.

444
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

regionName Opt. String Area name, which consists of up to 64
characters.
recordingSchedul Opt. String Recording schedule name, which
eName consists of up to 32 characters.
storageType Opt. Number Storage type: 0-unknown, 1-
scheduled video storage, 2-ANR video
storage, 3-picture storage.
recordingStatus Opt. Number Recording status: 0-recording, 1-not
record, 2-recording exception, 3-
searching failed, 4-unknown.
networkStatus Opt. Number Network status: 0-unknown, 1-online,
2-​offline.

A.1.14 Card
The table here shows the information of a card .

Table A-14 Card Object Description

Parameter Name Req. or Opt. Data Type Description
cardNo Opt. String Card No.

A.1.15 CertificateStatus
The table here shows the status information of applying visitor's credential to device.

Table A-15 CertificateStatus Object Description

Parameter Name Req. or Opt. Data Type Description
type Req. Number Credential type: 0-physical card, 1-
fingerprint, 2-face picture, 3-iris.
id Req. Number Credential ID.
status Req. Number Status of credential application: 0-
applied, 1-to be applied, 2-applying
failed.

445
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

errorMordule Req. Number The module where the application
failed or error occurred.
errorCode Req. Number Error code of the failed application.

A.1.16 characterInfo
The table here shows the text content information.

Table A-16 characterInfo Object Description

Parameter Name Req. or Opt. Data Type Description
contentList Req. Array Text content list. Up to 20 pieces of
data can be transmitted at a time.
id Req. Number Text content ID.
content Req. String Text content.
playTime Req. Number Display duration of text content.

A.1.17 CustomField
The table here shows the custom information about a person.

Table A-17 CustomField Object Description

Parameter Name Req. or Opt. Data Type Description
id Opt. String Custom feature ID.
customFiledName Opt. String Custom feature name, which consists
of up to 32 characters.
customFieldType Opt. Number Text type: 0 (normal text, which
consists of 0 to 128 characters and
cannot contain ' / \ : * ? " < > |), 1
(numeric text, which consists of up to
32 digits), 2 (date text, its format is
YYYY/MM/DD hh:mm:ss) , 3 (single
selection).

446
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

customFieldValue Opt. String Value of the custom feature, which
consists of up to 128 characters.
When the value of customFieldType
is 3, this parameter indicates the
preset value ID of the CustomField
object.
presetValueList Opt. Array Preset value list.
presetValueList[0] Opt. PresetValue Information about a preset value in
the list.
isPublic Opt. Bool False-private (by default), true-public.
isShow Opt. Bool False-not displayed in the person list,
trued-displayed in the person list (by
default).

A.1.18 dataSourceBatchUpdateList
The table here shows the information of data resource update in a batch.

Table A-18 dataSourceData Object Description

Parameter Name Req. or Opt. Data Type Description
dataSourceBatch Req. Array Information of data resource update
UpdateList in a batch.
dataSourceUUID Req. String Data source UUID.
dataType Req. String Data source type: "pic" (picture),
"character" (text), "table" (table).
dataUpdateType Req. String Update type: "cover" (overwrite),
"add".
maxMaterialNum Req. Number Number of a single data source
cached in the digital signage terminal.
This node is valid when
dataUpdateType is "add".
picInfo Opt. Object Picture information. This node is valid
when dataType is "pic". See details in
picInfo .

447
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

characterInfo Opt. Object Text content information. See details
in characterInfo .
tableInfo Opt. Object Table information. See details in
tableInfo .

A.1.19 dataSourceData
The table here shows the information of data resource update.

Table A-19 dataSourceData Object Description

Parameter Name Req. or Opt. Data Type Description
dataType Req. String Data source type: "pic" (picture),
"character" (text), "table" (table).
dataUpdateType Req. String Update type: "cover" (overwrite),
"add".
maxMaterialNum Req. Number Number of a single data source
cached in the digital signage terminal.
This node is valid when
dataUpdateType is "add".
picInfo Opt. Object Picture information. This node is valid
when dataType is "pic". See details in
picInfo .
characterInfo Opt. Object Text content information. See details
in characterInfo .
tableInfo Opt. Object Table information. See details in
tableInfo .

A.1.20 DeviceError
The table here shows the error information of a device.

448
 HikCentral Professional OpenAPI Developer Guide

Table A-20 DeviceError Object Description

Parameter Name Req. or Opt. Data Type Description
deviceName Opt. String Device name. The maximum length is
32 bytes.
errorList Opt. Array Error details list.
errorList[0] Opt. Object Details of an error in the list. See
details in RelatedErrorInfo .

A.1.21 DoorControlResult
The table here shows the information of an access point control result.

Table A-21 DoorControlResult Object Description

Parameter Name Req. or Opt. Data Type Description
doorIndexCode Req. String Access point ID, which consists of up
to 64 characters.
controlResultCod Req. Number Control status code of access point,
e i.e., 0-succeeded, other codes-failed
(refer to Status or Error Code for
details).
controlResultDesc Opt. String Control status description of access
point, refer to Status or Error Code for
details.

A.1.22 DoorInfo
The table here shows the information of an access point.

Table A-22 DoorInfo Object Description

Parameter Name Req. or Opt. Data Type Description
doorIndexCode Opt. String Access point ID, which consists of up
to 64 characters.
doorName Opt. String Access point name, which consists of
up to 32 characters.

449
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

doorNo Opt. String Access point No. (or door No.), which
consists of up to 16 characters.
doorState Opt. Number Door status: 0-door remain open, 1-
door closed, 2-door open, 3-door
remain closed, 4-​offline. This field
represents the door status for entry
direction when doorOutState is not -
1.
doorOutState Opt. Number Door status for exit direction: -1
(invalid field, which indicates there is
no status for exit direction), 0 (remain
open), 1 (closed), 2 (open), 3 (remain
closed), 4 (offline).
acsDevIndexCode Opt. String Access control device ID, which
consists of up to 64 characters.
regionIndexCode Opt. String Area ID, which consists of up to 64
characters.

A.1.23 ElementDetail
The table here shows the information of access level application information.

Table A-23 ElementDetail Object Description

Parameter Name Req. or Opt. Data Type Description
elementID Req. Number Device ID.
Baseinfo Req. String[] Basic device information. See details
in ElementDetailBaseInfo .
ElementStatus Req. String[] Status information of the device. See
details in ElementStatus .
CertificateStatusL Req. CertificateStatusLi Status information of applying
ist st[] visitor's credential to device. See
details in CertificateStatus .

450
 HikCentral Professional OpenAPI Developer Guide

A.1.24 ElementDetailBaseInfo
The table here shows the information of the device which the access level is applied to.

Table A-24 ElementDetailBaseInfo Object Description

Parameter Name Req. or Opt. Data Type Description
elementName Req. String Device name.
elementType Req. Number Device type: 6-door, 11-​floor.
elementNetwork Req. Number Network status of device: 0-​offline, 1-
online.

A.1.25 ElementStatus
The table here shows the status information of the device which the access level is applied to.

Table A-25 ElementStatus Object Description

Parameter Name Req. or Opt. Data Type Description
elementStatus Req. Number Application status of the access level
to the device.
elementErrorMor Req. Number The module where the application
dule failed or error occurred.
elementErrorCod Req. Number Error code of the failed application.
e

A.1.26 EncodeDevInfo
The table here shows the information of an encoding device.

Table A-26 EncodeDevInfo Object Description

Parameter Name Req. or Opt. Data Type Description
encodeDevIndexC Optional String Encoding device ID, which consists of
ode up to 64 characters.
encodeDevName Optional String Encoding device name, which consists
of up to 32 characters.

451
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

encodeDevIp Required String IP address of encoding device
encodeDevPort Required String Port No. of encoding device.
encodeDevCode Optional String Serial No. of encoding device, which
consists of up to 16 characters.
treatyType Optional String Transfer protocol types, i.e., "hiksdk_
net" (Hikvision Private
Protocol),"ehome_reg" (Hikvision
Intelligent Security Uplink Protocol),
and "onvif_net" (ONVIF Protocol).
status Opt. Number Status of the encoding device: 0-
unknown, 1-online, 2-​offline.
isSupportWakeUp Opt. Number Whether it supports the wakeup
function: 0-no, 1-yes (currently only
supported by solar camera).
This field consists of up to 32
characters.
wakeUpStatus Opt. Number Wakeup status: 0-awaken, 1-sleeping.
This field is valid when the camera is
online, and consists of up to 32
characters.
timeZone Opt. Object Time zone information, returned for
getting the information of an access
control device. See details in
TimeZoneInfo .

A.1.27 ErrorcodeApprovalReviewInfo

Table A-27 ErrorcodeApprovalReviewInfo Object Description

Parameter Name Req. or Opt. Data Type Description
errorCode Opt. Number Error code. The maximum length is
64.
visitorID Opt. Number Visitor ID. The maximum length is 64.

452
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

approvalFlowCod Opt. String Visitor reservation review No. The
e maximum length is 128.
visitorName Opt. String Visitor's name. The maximum length
is 128.

A.1.28 eventLabelList
The table here shows information of event tags.

Table A-28 eventLabelList Object Description

Parameter Name Req. or Opt. Data Type Description
labelCode Req. String Tag ID. The maximum length of this
field is 32.
labelEvent Req. Number Tag type: 2 (person-​detection tag), 4
(vehicle-​detection tag).
startTime Req. String Start time of the tag, which is in ISO
8601 standard time format: yyyy-
MMdd'T'HH: mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00. And
the time consists of up to 64
characters.
endTime Req. String End time of the tag, which is in ISO
8601 standard time format: yyyy-
MMdd'T'HH: mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00. And
the time consists of up to 64
characters.

A.1.29 eventList
The table here shows information of the event.

453
 HikCentral Professional OpenAPI Developer Guide

Table A-29 eventList Object Description

Parameter Name Req. or Opt. Data Type Description
eventCode Req. Number Event ID.
eventType Req. Number Event type.
eventName Req. String Event name. The maximum length is
256.
rawEventName Req. String Original event name. The maximum
length is 256.
description Req. String Event description.
eventCategory Req. Number Event category: 100651-HEOP event,
100652-AIOP event.

A.1.30 EventPic
The table here shows the event picture information.

Table A-30 EventPic Object Description

Parameter Name Req. or Opt. Data Type Description
eventPicUri Opt. String URL of the event picture, the
maximum length is 256 characters.
picType Opt. Number Picture type: 1 (picture reported by
the device), 2 (picture captured by
linkage).

A.1.31 EventRecord
The table here shows the information of an event record.

Table A-31 EventRecord Object Description

Parameter Name Req. or Opt. Data Type Description
eventIndexCode Req. String Event ID, which consists of up to 64
characters.
eventType Req. String Event type, refer to Event Types or
Alarm Categories for details.

454
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

srcType Req. String Event source type: "acsDevice"
(access controller), "door" (access
point), "encodeDevice" (encoding
device), "camera", "ioIn" (alarm
input), "generalEventRule" (general
event). And the field can contain up to
64 characters. Refer to Event Types or
Alarm Categories for details.
srcIndex Req. String Event source No., which consists of up
to 64 characters.
subSrcType Opt. String Event source type, which is available
for search of license plate matched or
mismatched event. The maximum
length is 64 bytes.
subSrcIndex Opt. String Event source No., which is available
for search of license plate matched or
mismatched event. Each two No.
should be separated by comma. The
maximum length is 1024 bytes.
description Opt. String Event description information, which
consists of up to 1024 characters.
startTime Req. String Event occurred time, which is in ISO
8601 standard time format: yyyy-MM-
ddTHH:mm:ss+current zone, e.g.,
2018-07-26T15:00:00+08:00. And the
time consists of up to 64 characters.
stopTime Opt. String Stop time of event, which is in ISO
8601 standard time format: yyyy-MM-
ddTHH:mm:ss+current zone, e.g.,
2018-07-26T15:00:00+08:00. And the
time consists of up to 64 characters.
eventPicUri Opt. String Event picture URL, and the maximum
length is 256 characters.
eventPicList Opt. Array Event picture list.

455
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

eventPicList[0] Opt. EventPic Event picture information.
linkCameraIndexC Opt. String The linked camera ID, which consists
ode of up to 1024 characters.

A.1.32 face
The table here shows the information of a face.

Table A-32 face Object Description

Parameter Name Req. or Opt. Data Type Description
faceData Req. String A data string of face picture encoded
by Base64.

A.1.33 FaceGroupInfo
The table here shows the information of a face comparison group.

Table A-33 FaceGroupInfo Object Description

Parameter Name Req. or Opt. Data Type Description
indexCode Req. String Face comparison group ID, and it
consists of up to 64 characters.
name Req. String Name of face comparison group,
which consists of up to 32 characters.
description Req. String Description information, and it can
contain up to 128 characters.

A.1.34 FaceInfo
The table here shows the information of a face.

456
 HikCentral Professional OpenAPI Developer Guide

Table A-34 FaceInfo Object Description

Parameter Name Req. or Opt. Data Type Description
personGivenNam Req. String Person's given name; the total length
e of given name and family name
cannot be longer than 255 characters.
personFamilyNa Req. String Person's family name; the total length
me of given name and family name
cannot be longer than 255 characters.
sex Opt. String The person linked with the face
information: "1"-male, "2"-female,
"0"-unknown.

A.1.35 facePic
The table here shows the information of a face picture.

Table A-35 facePic Object Description

Parameter Name Req. or Opt. Data Type Description
faceBinaryData Opt. String A binary data string of face picture,
which is encoded by Base64. The
picture size must be between 10 KB
and 100 KB, and the format should be
JPG.

A.1.36 FaceMatchRecord
The table here shows the face comparison information.

Table A-36 FaceMatchRecord Object Description

Parameter Name Req. or Opt. Data Type Description
recordIndexCode Req. String Record ID.
cameraInfo Req. Object Camera information.
cameraIndexCode Req. String Camera ID.
cameraName Req. String Camera name.
faceGroupInfo Req. Object Face comparison group information.

457
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

faceGroupIndexCodes Req. String Face comparison group ID.
faceGroupName Req. String Face comparison group name.
PersonInfo Req. Object Face picture coordinates.
personId Req. String Person ID, GUID allocated by system and for
internal use. The maximum length is 64.
personCode Req. String Person code, a customized employee ID when
you add the person, which cannot be modified
once set. The maximum length is 16.
personName Req. String Name, the maximum length is 512 characters.
personFamilyName Req. String Person's family name, the maximum length is
256 characters.
personGivenName Req. String Person's given name, the maximum length is 256
characters.
similarity Req. Number Similarity between the picture in the library and
the captured picture.
faceTime Req. String Time when the picture is captured.
snapFacePicUrl Req. String URL of the captured picture.
faceRect Req. Object Face coordinate information.
height Req. Number Height.
width Req. Number Width.
x Req. Number X coordinate.
y Req. Number Y coordinate.
bkgPicUrl Opt. String URL of the background picture.
bkgRect Opt. Object Coordinate information of the background
picture.
height Opt. Number Height.
width Opt. Number Width.
x Opt. Number X coordinate.
y Opt. Number Y coordinate.
temperatureData Req. String Temperature.

458
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

temperatureStatus Req. Number Temperature status: -1 (all), 0 (unknown), 1
(normal), 2 (exception).
wearMaskStatus Req. Number Whether a wearing mask: -1 (all), 0 (unknown), 1
(yes), 2 (no).
gender Opt. Number 0 (unknown), 1 (male), 2 (female).
ageGroup Opt. Number Age group.
glasses Opt. Number Whether wearing glasses: 0 (unknown), 1 (yes),
2 (no), 3 (sunglasses).
smile Req. Number Smile or not: 1 (unknown), 2 (no), 3 (smile).

A.1.37 faceTargetInfo
The table here shows the information of the target face.

Table A-37 faceTargetInfo Object Description

Parameter Name Req. or Opt. Data Type Description
code Req. Number Serial No. The maximum length is 32.
captureTime Req. String Capture time. The maximum length is
64.
monitorPointInde Req. String Camera serial No. The maximum
xCode length is 32.
picUrl Req. String URL for downloading the full picture.
subPicUrl Req. String URL for downloading the thumbnail.
similarity Req. String Similarity of the searched pictures.
The maximum length is 64.
faceRect Req. Object Coordinate box for the face.
Normalized x-coordinate from the
upper-​left corner to the right and y-
coordinate from the upper-​left corner
to the downward. Range of value:
[0.000, 1.000].
height Req. String Height of detected face in the picture,
normalized to [0.000, 1.000]. The
maximum length is 64.

459
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

width Req. String Width of detected face in the picture,
normalized to [0.000, 1.000]. The
maximum length is 64.
x Req. String Normalized x-coordinate from the
upper-​left corner to the right. Range
of value: [0.000, 1.000]. The
maximum length is 64.
y Req. String Normalized y-coordinate from the
upper-​left corner to the downward.
Range of value: [0.000, 1.000]. The
maximum length is 64.
currTemperature Opt. String Face temperature. The maximum
length is 32.
thermometryUnit Opt. Enum Temperature unit: 0-Celsius, 1-
Fahrenheit, 2-Kelvin.
mask Opt. Enum Wear mask or not: 0-unknown, 1-no,
2-yes.
gender Opt. Enum 0-unknown, 1-male, 2-female.
glasses Opt. Enum Wearing glasses or not: 0-no, 1-
wearing sunglasses, 2-unknown, 2-
yes.
smile Opt. Enum Smiling or not: 0-no, 1-unknown, 2-
yes.
ageGroup Opt. Enum 0-teenager, 1-infant, 2-child, 3-middle
age, 4-middle to old age, 5-the
elderly, 6-prime, 7-early youth, 8-
unknown, 9-young adult.

A.1.38 faceTargets
The table here shows the information of face modeling.

460
 HikCentral Professional OpenAPI Developer Guide

Table A-38 faceTargets Object Description

Parameter Name Req. or Opt. Data Type Description
targetModelData Req. String Face modeling data.
faceRect Req. Object Coordinate box for the face.
Normalized x-coordinate from the
upper-​left corner to the right and y-
coordinate from the upper-​left corner
to the downward. Range of value:
[0.000, 1.000].
height Req. String Height of detected face in the picture,
normalized to [0.000, 1.000]. The
maximum length is 64.
width Req. String Width of detected face in the picture,
normalized to [0.000, 1.000]. The
maximum length is 64.
x Req. String Normalized x-coordinate from the
upper-​left corner to the right. Range
of value: [0.000, 1.000]. The
maximum length is 64.
y Req. String Normalized y-coordinate from the
upper-​left corner to the downward.
Range of value: [0.000, 1.000]. The
maximum length is 64.

A.1.39 FingerPrint
The table here shows the information of a fingerprint.

Table A-39 FingerPrint Object Description

Parameter Name Req. or Opt. Data Type Description
fingerPrintIndexC Opt. String Fingerprint ID, which consists of up to
ode 64 characters.
fingerPrintName Opt. String Fingerprint name, which consists of
up to 64 characters.
fingerPrintData Opt. String Fingerprint data, which consists of up
to 1024 characters. If this field is not

461
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

configured, the previous fingerprint
data will be used.
relatedCardNo Opt. String The linked card No. The maximum
length is 20 bytes.

A.1.40 fingerPrintUpdateResult
This table shows the a fingerprint updating result.

Table A-40 fingerPrintUpdateResult Object Description

Parameter Name Req. or Opt. Data Type Description
fingerPrintName Req. String Fingerprint name. The maximum
length is 64 bytes.
errorCode Req. String Error code returned when failed. See
details in Status or Error Code .
errorDesc Opt. String Error description. See details in Status
or Error Code .

A.1.41 FloorInfo
The table here shows the floor information.

Table A-41 FloorInfo Object Description

Parameter Name Req. or Opt. Data Type Description
floorIndexCode Req. String Floor ID.
floorName Req. String Floor name.
parkingLotIndexC Req. String Parking lot ID.
ode
parkingLotName Req. String Parking lot name.

A.1.42 FloorOverViewInfo
The table here shows the floor overview.

462
 HikCentral Professional OpenAPI Developer Guide

Table A-42 FloorOverViewInfo Object Description

Parameter Name Req. or Opt. Data Type Description
floorIndexCode Req. String Floor ID.
floorName Req. String Floor name.
parkingLotIndexC Req. String Parking lot ID.
ode
totalSpaceNum Req. Number Total number of parking spaces on the
floor.
freeSpaceNum Req. Number Number of vacant parking spaces on
the floor.
spaceTypeOverVi Req. Array List of all parking space types.
ew
spaceTypeOverVi Req. SpaceTypeOverVi Information about a parking space
ew[0] ewInfo type.

A.1.43 ForbiddenVehicleInfo
The table here shows information of the vehicle in the blocklist.

Table A-43 ForbiddenVehicleInfo Object Description

Parameter Name Req. or Opt. Data Type Description
vehicleIndexCode Req. String Blocklist vehicle ID, which consists of
up to 32 characters.
plateLicense Req. String License plate number, which consists
of 1 to 32 characters, but cannot
contain special characters like ' / \ :
* ? " < > |.
personGivenNam Req. String Person's given name, which consists
e of 1 to 16 characters, but cannot
contain special characters like ' / \ :
* ? " < > |.
personFamilyNa Req. String Person's family name, which consists
me of 1 to 16 characters, but cannot
contain special characters like ' / \ :
*?"<>|

463
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

phoneNo Req. String Contact number, which can contain
numbers from 0-9, and special
characters ＋ and －. The maximum
length is 32.
description Req. String Vehicle description, which consists of
1 to 128 characters, but cannot
contain special characters like ' / \ :
*?"<>|
effectiveDate Req. String Start time of blocking, in ISO 8601
format, which is represented by
"yyyy- MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00".
expiredDate Req. String End time of blobking, in ISO 8601
format, which is represented by
"yyyy- MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00".

A.1.44 GeneralEventRule
The table here shows information of generic event rule.

Table A-44 GeneralEventRule Object Description

Parameter Name Req. or Opt. Data Type Description
generalEventRuleI Opt. String Generic event rule ID, which consists
ndexCode of up to 64 characters.
generalEventRule Req. String Name of the generic event rule, which
Name consists of up to 32 characters.
transportType Req. Number Transmission type: 0-TCP, 1-UDP.
matchType Req. Number Match type: 0-search (the received
data package must contain the text
specified in expression, but may also
have more content), 1-match (the
received data package must contain
exactly the text specified in

464
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

expression, and nothing else). The
maximum length is 64 characters.
expression Req. String Description of the regular expression,
which consists of up to 256
characters.
regularExpression Req. String Regular expression of the generic
event rule.

A.1.45 gpsInfo
The table here shows the GPS information.

Table A-45 gpsInfo Object Description

Parameter Name Req. or Opt. Data Type Description
occurTime Req. String GPS report time. The maximum
length is 32 characters.
longitude Req. Float Longitude. The maximum length is 16
characters.
latitude Req. Float Latitude. The maximum length is 16
characters.
direction Req. Number Vehicle direction (calculated clockwise
from due north (0); the actual degree
* 100; [0, 36000)).
gpsDisplay Req. String Displayed GPS information. The
maximum length is 32 characters.
directionDisplay Req. String Displayed direction ("North",
"Northeast", "East", "Southeast",
"South", "Southwest", "West",
"Northwest"). The maximum length is
16 characters.
speed Req. Float Speed (consistent with the HCP
platform: km/h by default). The
maximum length is 16 characters.

465
 HikCentral Professional OpenAPI Developer Guide

A.1.46 HDDInfo
The table shows the information of a HDD.

Table A-46 HDDInfo Object Description

Parameter Name Req. or Opt. Data Type Description
poolID Opt. String Resource pool ID, which consists of up
to 32 characters.
poolName Opt. String Resource pool name, which consists
of up to 64 characters.
Status Opt. Number HDD status. Currently, this parameter
is reserved.
Capacity Opt. Number HDD capacity, unit: MB.
FreeSpace Opt. Number Free space of HDD, unit: MB.
UsedSpace Opt. Number HDD usage, unit: MB.

A.1.47 IntelligentServerInfo
The table shows the information of an Intelligent Server.

Table A-47 IntelligentServerInfo Object Description

Parameter Name Req. or Opt. Data Type Description
intelligentServerI Opt. String Intelligent Server ID, which consists of
ndexCode up to 64 characters.
intelligentServer Opt. String Intelligent Server name, which
Name consists of up to 64 characters.
intelligentServerI Opt. String IP address of Intelligent Server, whose
p maximum length is 64 bytes.
status Opt. Number Network status: 0-unknown, 1-online,
2-​offline.

A.1.48 MobileDeviceInfo
The table here shows the on-board device information.

466
 HikCentral Professional OpenAPI Developer Guide

Table A-48 MobileDeviceInfo Object Description

Parameter Name Req. or Opt. Data Type Description
mobileDevIndexC Opt. String On-board device ID. The maximum
ode length is 64 characters.
mobileDevName Opt. String On-board device name. The maximum
length is 32 characters.
mobileDevIp Opt. String On-board device IP. The maximum
length is 16 characters.
mobileDevPort Opt. String On-board device port. The maximum
length is 16 characters.
mobileDevCode Opt. String On-board device No. The maximum
length is 16 characters.
treatyType Opt. String Access protocol. The maximum length
is 16 characters. See details in Access
Protocol of Device .
status Opt. Number Online status (0-unknown, 1-online,
2-​offline).
timeZone Opt. Object Time zone information, returned for
getting the information of an access
control device. See details in
TimeZoneInfo .

A.1.49 MobilevehivleInfo
The table here shows the information of vehicles linked to on-board devices.

Table A-49 MobilevehivleInfo Object Description

Parameter Name Req. or Opt. Data Type Description
mobilevehicleInd Req. String ID of vehicle linked to the on-board
exCode device. The maximum length is 128
characters.
mobilevehicleNa Req. String Name of vehicle linked to the on-
me board device. The maximum length is
256 characters.

467
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

DevIndexCode Req. String Device ID. The maximum length is 128
characters.
regionIndexCode Req. String Area ID. The maximum length is 128
characters.
status Req. Number Online status (0-unknown, 1-online,
2-​offline).
plateNo Req. String License plate number of the vehicle.
The maximum length is 16 characters.
personName Req. String Person name. The maximum length is
64 characters.
personFamilyNa Opt. String Family name of the person. The
me maximum length is 64 characters.
personGivenNam Opt. String Given name of the person. The
e maximum length is 64 characters.
phoneNo Opt. String Contact number. The maximum
length is 20 characters.
vehicleColor Opt. Number Vehicle color. See details in Vehicle
Color .
vehicleType Opt. Number Vehicle type: 0-others, 1-small-sized
vehicle, 2-large-sized vehicle, 3-
motorcycle.
vehicleBrand Opt. Number Vehicle brand.

A.1.50 OrgInfo
The table here shows the information of an organization.

468
 HikCentral Professional OpenAPI Developer Guide

Table A-50 OrgInfo Object Description

Parameter Name Req. or Opt. Data Type Description
orgIndexCode Opt. String Organization ID, which consists of up
to 64 characters.
orgName Opt. String Organization name, which consists of
up to 64 characters.
parentOrgIndexC Opt. String Parent organization ID, which consists
ode of up to 64 characters.

A.1.51 ParkingFeeCalculate
The table here shows the information for parking fee calculation.

Table A-51 ParkingFeeCalculate Object Description

Parameter Name Req. or Opt. Data Type Description
plateLicense Opt. String License plate number, the maximum
length is 32 characters.
parkingInTime Req. String Time when the vehicle entered the
parking lot.
parkingDuration Opt. Number Total parking duration, unit: second.
feeRuleType Opt. Number parking fee type: 0-rule for temporary
vehicles, 1-rule for registered
vehicles, 2-rule for parking pass, 4-
rule for exceptional pass.
feeRuleIndexCod Opt. String Parking fee rule ID.
e
feeRuleName Opt. String Parking fee rule name.
fee Opt. String Parking fee.

A.1.52 ParkingFeeConfirm
The table here shows the information for parking fee confirmation.

469
 HikCentral Professional OpenAPI Developer Guide

Table A-52 ParkingFeeConfirm Object Description

Parameter Name Req. or Opt. Data Type Description
fee Req. String Parking fee.
feeTime Req. String Time when fee is charged.

A.1.53 ParkingLotInfo
The table here shows the information about a parking lot.

Table A-53 ParkingLotInfo Object Description

Parameter Name Req. or Opt. Data Type Description
parkingLotIndexC Req. String Parking lot ID.
ode
parkingLotName Req. String Parking lot name.
parentParkingLotI Opt. String Parent parking lot ID (if exists).
ndexCode
totalSpaceNum Req. Number Total number of parking spaces.
freeSpaceNum Req. Number Number of vacant parking spaces.
totalPermanentS Req. Number Total number of parking spaces for
paceNum registered vehicles.
freePermanentSp Req. Number Number of vacant parking spaces for
aceNum registered vehicles.
maxParkingTime Req. Number Max. parking duration (hour).

A.1.54 ParkingRecordInfo
The table here shows the information about a vehicle parking record.

Table A-54 ParkingRecordInfo Object Description

Parameter Name Req. or Opt. Data Type Description
guid Req. Number Vehicle parking record ID.
parkingLotIndexC Req. String Parking lot ID.
ode

470
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

parkingLotName Req. String Parking lot name.
floorIndexCode Req. String Floor ID.
floorName Req. String Floor name.
parkingSpaceSeri Req. String Parking space serial No.
al
plateLicense Req. String License plate number.
parkingStatusTyp Req. Number Status: 0 (parking), 1 (exited).
e
occurTime Req. String Time when the vehicle entered/exited
the parking space.
duration Opt. Number Parking duration (if the vehicle has
exited). The unit is second.

A.1.55 ParkingSpaceInfo
The table here shows the information about a parking space.

Table A-55 ParkingSpaceInfo Object Description

Parameter Req. or Opt. Data Type Description
Name
spaceIndexCo Req. String Parking space ID.
de
floorIndexCod Req. String Floor ID.
e
spaceType Req. Number Parking space type: 1 (general),
2 (allowed), 3 (forbidden), 4
(charging), 5 (private), 6
(registered), 7 (temporary).
serial Req. String Parking space serial No.
status Req. Number Status: 0 (unknown), 1 (vacant),
2 (occupied), 3 (overtime
parking), 4 (parking violations).
plateNumber Req. String License plate number.

471
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

Name
creatTime Req. String Time when the current status
started.
duration Req. Number Duration of the current status.
parkingImage Req. String URL of the background picture.
Url
platenumberI Req. String URL of the license plate.
mageUrl

A.1.56 PassingRecordInfo
The table here shows the information about a vehicle passing record.

Table A-56 PassingRecordInfo Object Description

Parameter Name Req. or Opt. Data Type Description
guid Req. String Vehicle passing record ID.
parkingLotInfo Req. Object Parking lot information.
parkingLotIndexC Req. String Parking lot ID.
ode
parkingLotName Req. String Parking lot name.
passagewayInfo Req. Object Entrance/exit information.
passagewayIndex Req. String Entrance/exit ID.
Code
passagewayName Req. String Entrance/exit name.
laneInfo Req. Object Lane information.
laneIndexCode Req. String Lane ID.
laneName Req. String Lane name.
direction Req. Number Direction: 1 (entry), 2 (exit).
personInfo Req. Object Vehicle owner information.
cardNum Req. Number ID number.
ownerName Req. String Owner name.

472
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

ownerPhoneNum Req. String Phone number.
carInfo Req. Object Vehicle information.
plateLicense Req. String License plate number.
carType Req. Number Vehicle type: 0 (Other), 1 (small-sized
vehicle), 2 (large-sized vehicle), 3
(bus), 4 (truck), 5 (sedan), 6 (minivan),
7 (small-sized truck).
ImageUrl Req. String URL of the vehicle picture.
EnterTime Req. String Time when the vehicle entered the
parking lot.
ExitTime Req. String Time when the vehicle exited the
parking lot.
allowType Req. Number Allow mode: 1 (manual), 2 (auto), 3
(not allowed).
allowResult Req. Number Whether the passing is allowed: 1
(allowed), 2 (not allowed).

A.1.57 PassVehicleRecord
The table here shows the information of a vehicle passing record.

Table A-57 PassVehicleRecord Object Description

Parameter Name Req. or Opt. Data Type Description
crossRecordSysco Req. String Vehicle passing record ID, which
de consists of up to 64 characters.
cameraIndexCode Req. String Camera ID, which consists of up to 64
characters.
plateNo Opt. String License plate number of vehicle,
which consists of up to 64 characters.
ownerName Opt. String Vehicle owner name, which consists
of up to 64 characters.
contact Opt. String Contact number of vehicle owner,
which consists of up to 32 characters.

473
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

vehicleColor Opt. Number Vehicle color: 0-other color, 1-white,
2- sliver, 3-grey, 4-black, 5-red, 6-dark
blue, 7- blue, 8-yellow, 9-green, 10-
brown, 11-pink, 12- purple.
vehicleType Opt. Number Vehicle type: 0-others, 1-small-sized
vehicle, 2-large-sized vehicle, 3-
motorcycle.
country Opt. Number Country of the vehicle.
vehiclePicUri Opt. String Vehicle picture URL, which consists of
up to 256 characters.
crossTime Opt. String Vehicle passed time, which is in ISO
8601 standard time format: yyyy-MM-
ddTHH:mm:ss+current zone, e.g.,
2018-07-26T15:00:00+08:00. And the
time consists of up to 64 characters.
createTime Opt. String Record created time, which is in ISO
8601 standard time format: yyyy-MM-
ddTHH:mm:ss+current zone, e.g.,
2018-07-26T15:00:00+08:00. And the
time consists of up to 64 characters.
vehicleDirectionT Opt. Number Driving direction: 0 (other directions),
ype 1 (downward, from far to near for the
camera), 2 (upward, from near to far
for the camera).

A.1.58 PatrolInfo
The table here shows the patrol information.

474
 HikCentral Professional OpenAPI Developer Guide

Table A-58 PatrolInfo Object Description

Parameter Name Req. or Opt. Data Type Description
patrolName Req. String Patrol name, which consists of up to
128 characters.
patrolIndex Req. Number Patrol No., which is between 1 and 8.
And the No. consists of up to 64
characters.
patrolPointInfoLis Opt. Array Preset information list of the patrol.
t
patrolPointInfoLis Opt. Object Information of a preset in the list of
t[0] the patrol. Refer to PatrolPointInfo
for details.

A.1.59 PatrolPointInfo
The table here shows the information of a preset in the patrol.

Table A-59 PatrolPointInfo Object Description

Parameter Name Req. or Opt. Data Type Description
presetIndex Req. Number Preset No., which is between 1 and
256. And the No. consists of up to 64
characters.
presetName Opt. String Preset name, which consists of up to
32 characters. This field is not Req.
when editing the preset, and it will
not be returned when searching
patrols, getting patrol information by
patrol No.
speed Req. Number Switching speed between each two
presets, which is between 1 and 40.
dwellTime Req. Number Dwell duration of a preset, which is
between 15 and 30.

475
 HikCentral Professional OpenAPI Developer Guide

A.1.60 PeopleCountInfo
This table shows people counting statistics information of an item.

Table A-60 PeopleCountInfo Object Description

Parameter Name Req. or Opt. Data Type Description
time Opt. String Statistics time. The maximum length
is 64 bytes.
cameraIndexCode Opt. String Camera ID. The maximum length is 64
bytes.
exitNum Opt. Number Number of people exited.
enterNum Opt. Number Number of people entered.

A.1.61 PeopleCountingParam
The table here shows people counting parameters.

Table A-61 PeopleCountingParam Object Description

Parameter Name Req. or Opt. Data Type Description
relatedResourceI Opt. RelatedResourceI Related resources.
nfoList nfo

A.1.62 PersonInfo
The table here shows the information of a person.

Table A-62 PersonInfo Object Description

Parameter Name Req. or Opt. Data Type Description
personId Opt. String Person ID, GUID allocated by system
and for internal use. The maximum
length is 64.
personCode Opt. String Person code, a customized employee
ID when you add the person, which
cannot be modified once set. The
maximum length is 16.

476
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

personName Opt. String Person name, which consists of up to
512 characters.
personFamilyNa Opt. String Family name of the person, which
me consists of up to 256 characters.
personGivenNam Opt. String Given name of the person, which
e consists of up to 256 characters.
gender Opt. Number 0-unknown, 1-male, 2-female; and
this field can contain up to 32
characters.
orgIndexCode Opt. String Person's organization ID, which
consists of up to 64 characters.
fingerPrint Opt. Object Fingerprint information. See details in
FingerPrint .
phoneNo Opt. String Contact number, which consists of up
to 64 characters.
personPhoto Opt. Object Person picture information. See
details in PersonPhoto .
email Opt. String Email address of the person, which
consists of up to 64 characters.
remark Opt. String Remarks, which consists of up to 256
characters.
cards Opt. Object Card information. See details in Card .
beginTime Req. String Start time in ISO 8601 format, which
is represented by "yyyy-MM-
ddTHH:mm:ss+current time zone",
e.g., "2018-07-26T15:00:00 + 08:00".
The maximum length is 64 bytes.
endTime Req. String End time in ISO 8601 format, which is
represented by "yyyy-MM-
ddTHH:mm:ss+current time zone",
e.g., "2018-07-26T15:00:00 + 08:00".
The maximum length is 64 bytes.

477
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

customFieldList Opt. Array List of custom information.
customFieldList[0 Opt. Object Custom information. See details in
] CustomField .

A.1.63 PersonInOutEvents
The table here shows the information of an access point event.

Table A-63 PersonInOutEvents Object Description

Parameter Name Req. or Opt. Data Type Description
eventId Req. String Event ID, which consists of up to 32
characters including digits and lower-
case letters.
eventType Req. Number Decimal event type code, refer to
Event Types or Alarm Categories for
details.
eventTime Req. String Event occurred time, which is in ISO
8601 standard time format: yyyy-MM-
ddTHH:mm:ss+current zone, e.g.,
2018-07-26T15:00:00+08:00. And the
time consists of up to 32 characters.
deviceTime Opt. String Event occurred time (device time),
which is in ISO 8601 time format. The
maximum length is 32 bytes.
personId Opt. String Person ID, which consists of up to 64
characters including digits, lower-case
letters, and dashes.
personName Opt. String Person name, which consists of 1 to
512 characters, but cannot contain
special characters like ' / \ : * ? " < > |
personFamilyNa Opt. String Family name of the person, which
me consists of 256 characters.
personGivenNam Opt. String Given name of the person, which
e consists of 256 characters.

478
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

doorName Opt. String Access point name, which consists of
1 to 32 characters, but cannot contain
special characters like ' / \ : * ? " < > |
doorIndexCode Opt. String Access control ID, which consists of up
to 64 characters including digits,
lower-case letters, and dashes.
cardNo Opt. String Card number, which consists of up to
32 characters.
checkInAndOutTy Opt. Number Attendance type, 0: unknown, 1:
pe check-in, 2: check-out, 3: break-out, 4:
break-in, 5: overtime-​in, 6: overtime-
out.
picUri Opt. String Captured picture URI (a relative path).
The maximum length is 512 bytes.
You can call POST /
artemis/api/acs/v1/event/pictures
to get the picture data from the URI.
temperatureData Opt. String Temperature value. The maximum
length is 64 bytes.
temperatureStatu Opt. Number Temperature status: 0-unknown, 1-
s normal, 2-abnormal.
wearMaskStatus Opt. Number Wearing mask or not: 0-unknown, 1-
yes, 2-no.
readerIndexCode Opt. String Card reader ID, which consists of up
to 64 characters.
readerName Opt. String Card reader name, which consists of
up to 64 characters.

A.1.64 PersonPhoto
The table here shows the information of a person picture.

479
 HikCentral Professional OpenAPI Developer Guide

Table A-64 PersonPhoto Object Description

Parameter Name Req. or Opt. Data Type Description
picUri Opt. String Person picture URL, which consists of
up to 256 characters.

A.1.65 picInfo
The table here shows the picture information.

Table A-65 picInfo Object Description

Parameter Name Req. or Opt. Data Type Description
picUrlList Opt. Array Picture list. Up to 20 pieces of data
can be transmitted at a time.
id Req. Number Picture ID.
type Req. String Picture uploading format. Currently
only uploading via "data" is
supported.
data Req. String A binary data string of picture
encoded by Base64. This node is valid
when type is "data".
playTime Req. Number Display duration of the picture.

A.1.66 PlaybackUrlVideoInfo
The table shows the information of playback URL and video segment.

Table A-66 PlaybackUrlVideoInfo Object Description

Parameter Name Req. or Opt. Data Type Description
list Req. Array Information list of video segments.
list[0] Req. Object Information of a video segment in the
list. See details in VideoInfo .
uuid Opt. String ID for searching by page. This UUID is
returned after the previous search
and it is used for the next search of

480
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

remaining videos. By default, it is
"null". And it consists of up to 64
characters.
url Req. String Streaming URL, which consists of up
to 128 characters, valid permanently.
authentication Opt. String The authentication information for
getting stream, which contains user
name, password, and token
information. And this field can contain
up to 1024 characters.
recordLocation Opt. String Video storage location: "0"-central
storage (default), "1"-device storage,
"2"-central cluster storage. This field
can contain up to 32 characters.

A.1.67 PresetInfo
This table shows the information of a preset.

Table A-67 PresetInfo Object Description

Parameter Req. or Opt. Data Type Description
presetName Req. String Preset name, which consists of up to
128 characters.
presetIndex Req. Number Preset No., which consists of up to
128 characters.

A.1.68 PresetValue
The table here shows the information about a preset value.

481
 HikCentral Professional OpenAPI Developer Guide

Table A-68 PresetValue Object Description

Parameter Name Req. or Opt. Data Type Description
id Opt. String Preset value ID, which consists of up
to 64 characters.
value Opt. String Preset value, which consists of up to
32 characters.

A.1.69 PrivilegeGroupInfo
The table here shows access group information.

Table A-69 PrivilegeGroupInfo Object Description

Parameter Name Req. or Opt. Data Type Description
privilegeGroupId Req. String Access level ID, which consists of up
to 64 characters.
privilegeGroupNa Req. String Access level name, which consists of
me up to 32 characters.
description Req. String Description, which consists of up to
128 characters.
timeSchedule Req. Object Time schedule template. See details
in TimeSchedule .

A.1.70 ReaderInfo
The table here shows card reader information.

Table A-70 ReaderInfo Object Description

Parameter Name Req. or Opt. Data Type Description
indexCode Req. String Card reader ID, which consists of up
to 64 characters.
name Req. String Card reader name, which consists of
up to 64 characters.
enable Opt. Number Whether to enable the card reader: 0-
disable, 1-enable. If this parameter

482
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

does not exist, it indicates that
configuring this item is not supported.

A.1.71 RealPeopleCountInfo
The table here shows the real-time statistics of a group.

Table A-71 RealPeopleCountInfo Object Description

Parameter Name Req. or Opt. Data Type Description
time Opt. String Time, which consists of up to 64
characters.
resourceGroupIn Opt. String Resource group ID, which consists of
dexCode up to 64 characters.
resourceGroupNa Opt. String Resource group name, which consists
me of up to 64 characters.
exitNum Opt. Number Number of people who exited the
area.
enterNum Opt. Number Number of people who entered the
area.
limitNum Opt. Number Number threshold.

A.1.72 RecordOverview
The table here shows the record overview.

Table A-72 RecordOverview Object Description

Parameter Name Req. or Opt. Data Type Description
eventIndexCode Req. String Event record ID. The maximum length
is 64 characters.
eventType Req. Number Event type. The maximum length is 16
characters.
mobilevehicleInd Req. String On-board vehicle ID. The maximum
exCode length is 64 characters.

483
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

plateNo Req. String License plate No. The maximum
length is 20 characters.
ownerName Req. String Vehicle owner name. The maximum
length is 64 characters.
regionName Req. String Area name. The maximum length is
64 characters.
occurTime Req. String GPS report time, in ISO 8601 format,
which is represented by "yyyy- MM-
ddTHH:mm:ss+current time zone",
e.g., "2018-07- 26T15:00:00 + 08:00".
The maximum length is 64 characters.
longitude Req. String Longitude (integer; including negative
values), actual degrees × 3600 × 100
＋ acutal minutes × 60 × 100 ＋
actual seconds × 100. The maximum
length is 16 characters.
latitude Req. String Latitude (integer; including negative
values), actual degrees × 3600 × 100
＋ acutal minutes × 60 × 100 ＋
actual seconds × 100. The maximum
length is 16 characters.
direction Req. Number Vehicle direction (calculated clockwise
from due north (0); the actual degree
* 100; [0, 36000)).
speed Req. Float Speed (consistent with the HCP
platform: km/h by default). The
maximum length is 16 characters.
displayInfo Req. String Displayed GPS information, e.g., E120,
50, 20; N30, 50, 20. The maximum
length is 64 characters.
directionInfo Req. String Direction information ("North",
"Northeast", "East", "Southeast",
"South", "Southwest", "West",
"Northwest"). The maximum length is
16 characters.

484
 HikCentral Professional OpenAPI Developer Guide

A.1.73 RelatedResourceInfo
The table here shows related resources.

Table A-73 RelatedResourceInfo Object Description

Parameter Name Req. or Opt. Data Type Description
resourceType Opt. Number Resource type: 1 (camera), 2 (door).
resourceIndexCod Opt. String Resource ID, the maximum length is
e 64 characters.
resourceName Opt. Number Resource name.
entryExitConfig Opt. Number Enter/exit direction: 1 (people
crossing along the entry direction (for
camera/door) will be calculated as
people entered this region), 2 (people
crossing along the entry direction (for
camera/door) will be calculated as
people exited this region).

A.1.74 RecordServerInfo
The table shows the information of a Storage Server.

Table A-74 RecordServerInfo Object Description

Parameter Name Req. or Opt. Data Type Description
recordServerInde Opt. String Storage Server ID, which consists of
xCode up to 64 characters.
recordServerNam Opt. String Storage Server name, which consists
e of up to 64 characters.
recordServerIp Opt. String IP address of Storage Server, whose
maximum length is 64 bytes.
recordingStatus Opt. Number Video status: 0-unknown, 1-normal,
2-​exception.
networkStatus Opt. Number Network status: 0-unknown, 1-online,
2-​offline.

485
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

hddList Opt. Array HDD information list. This parameter
is valid only when getting the
information of a single Storage Server.
hddList[0] Opt. Object Information of a HDD, refer to
HDDInfo for details.

A.1.75 RegionInfo
The table here shows the information of an area.

Table A-75 RegionInfo Object Description

Parameter Name Req. or Opt. Data Type Description
indexCode Opt. String Area ID, which consists of up to 64
characters.
name Opt. String Area name, which consists of up to 32
characters.
parentIndexCode Opt. String Parent area ID, which consists of up to
64 characters.
siteIndexCode Opt. String Site ID, which consists of up to 64
characters.

A.1.76 RelatedErrorInfo
The table here shows the details of an error.

Table A-76 RelatedErrorInfo Object Description

Parameter Name Req. or Opt. Data Type Description
personName Opt. String Person name. The maximum length is
64 bytes.
resourceName Opt. String Resource name. The maximum length
is 32 bytes. For multiple names, each

486
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

two names should be separated by
comma.
errorItems Opt. String Error type: 0-device exception;​ 1-
incorrect card information;​ 2-
incorrect fingerprint information;​ 3-
incorrect face information;​ 4-incorrect
person information. For multiple
types, each two types should be
separated by comma.

A.1.77 ResourceGroupInfo
The table here shows information about a resource group.

Table A-77 ResourceGroupInfo Object Description

Parameter Name Req. or Opt. Data Type Description
resourceGroupIn Opt. String Resource group ID, which consists of
dexCode up to 64 characters.
resourceGroupNa Opt. String Name of the resource group, which
me consists of up to 64 characters.
siteIndexCode Opt. String Site ID.
peopleCountingP Opt. PeopleCountingP People counting parameters.
aram aram

A.1.78 SiteInfo
The table here shows the information of a site.

Table A-78 SiteInfo Object Description

Parameter Name Req. or Opt. Data Type Description
siteIndexCode Opt. String Site ID, which consists of up to 64
characters.
siteName Opt. String Site name, which consists of up to 32
characters.

487
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

siteIp Req. String Site IP address.
sitePort Req. String Site port No.
description Opt. String Site description information, which
consists of up to 64 characters.

A.1.79 SpaceTypeOverViewInfo
The table here shows the information about a parking space type.

Table A-79 SpaceTypeOverViewInfo Object Description

Parameter Name Req. or Opt. Data Type Description
typeIndexCode Req. String Parking space type ID.
typeName Req. String Name of the parking space type.
typeColor Req. String Color of the parking space type.
totalSpaceNum Req. Number Total number of parking spaces of the
type.
freeSpaceNum Req. Number Vacant number of parking spaces of
the type.

A.1.80 StatisticResult
The table here shows the statistics result.

Table A-80 StatisticResult Object Description

Parameter Name Req. or Opt. Data Type Description
unApplicationCou Opt. Number Number of not applied attempts.
nt
applicationFailCo Opt. Number Number of failures to apply data.
unt
editAndUnApplic Opt. Number Number of edited and not applied
ationCount attempts.

488
 HikCentral Professional OpenAPI Developer Guide

A.1.81 StreamServerInfo
The table shows the information of a Stream Media Server.

Table A-81 StreamServerInfo Object Description

Parameter Name Req. or Opt. Data Type Description
streamServerInde Opt. String Stream Media Server ID, which
xCode consists of up to 64 characters.
streamServerNa Opt. String Stream Media Server name, which
me consists of up to 64 characters.
streamServerIp Opt. String IP address of Stream Media Server,
whose maximum length is 64 bytes.
totalStreamNum Opt. Number Total number of stream channels.
streamInNum Opt. Number Number of stream input channels.
streamOutNum Opt. Number Number of stream output channels.
status Opt. Number Network status: 0-​exception, 1-
normal.
CPUUsage Opt. Number CPU usage of Stream Media Server,
which is represented by percentage.
RAMUsage Opt. Number RAM usage of Stream Media Server,
which is represented by percentage.

A.1.82 SubscriptionInfo
The table here shows the details of a subscribed event.

Table A-82 SubscriptionInfo Object Description

Parameter Req. or Opt. Data Type Description
eventTypes Req. Array[Number] Event type code, which is a decimal
integer, refer to Event Types or Alarm
Categories for details.
eventDest Req. String Address to receive event information,
which consists of up to 1024
characters. The address adopts
RESTful callback mode, and supports

489
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

HTTP and HTTPS, its format is "http:/​/
ip:port/​eventRcv" or "https:/​/​ip:port/
eventRcv".

Note
Refer to Event Message Format for
the event details received in the
address.

passBack Req. Number Whether to enable event callback: 0-

no (by default), 1-yes.

A.1.83 tableInfo
The table here shows the table information.

Table A-83 tableInfo Object Description

Parameter Name Req. or Opt. Data Type Description
tableList Req. Array Table list. Up to 20 pieces of data can
be transmitted at a time.
id Req. Number Table ID.
dataList Req. Array Table content. Up to 20 pieces of data
can be transmitted at a time.
row Req. Number Row.
column Req. Number Column.
value Req. String table cell content.
playTime Req. Number Display duration of the table.

A.1.84 TimeSchedule
The table here shows the information of time schedule template.

490
 HikCentral Professional OpenAPI Developer Guide

Table A-84 TimeSchedule Object Description

Parameter Name Req. or Opt. Data Type Description
indexCode Req. String Time schedule template ID, which
consists of up to 64 characters.
name Req. String Name of the time schedule template,
which consists of up to 32 characters.

A.1.85 TimeZoneInfo
The table shows the time zone information.

Table A-85 TimeZoneInfo Object Description

Parameter Name Req. or Opt. Data Type Description
bias Req. Number Time difference (unit: minute)
between the current time zone and
zero zone.
enableDST Req. Number Whether to enable DST.
daylightBias Opt. Number DST duration (unit: minute).
daylightDate Opt. String Start time of DST, which is
represented by "MM:ww:dd:HH:mm".
MM (month), ww (xx week of the
month): 1, 2, 3, 4, 5 (the last week of
the month); dd (xx day of the week): 0
(Sunday), 1, 2, 3, 4, 5; HH (hour), mm
(minute). The maximum length of this
field is 9.
standardDate Opt. String End time of DST, which is represented
by "MM:ww:dd:HH:mm". MM
(month), ww (xx week of the month):
1, 2, 3, 4, 5 (the last week of the
month); dd (xx day of the week): 0
(Sunday), 1, 2, 3, 4, 5; HH (hour), mm
(minute). The maximum length of this
field is 9.

491
 HikCentral Professional OpenAPI Developer Guide

A.1.86 UrlInfo
The table shows the information of streaming URL.

Table A-86 UrlInfo Object Description

Parameter Name Req. or Opt. Data Type Description
url Req. String Streaming URL, which is permanently
valid and consists of up to 128
characters.
authentication Opt. String The authentication information for
getting stream, which contains user
name, password, and token
information. And this field can contain
up to 1024 characters.

A.1.87 VehicleGroupInfo
The table here shows the vehicle group information.

Table A-87 VehicleGroupInfo Object Description

Parameter Name Req. or Opt. Data Type Description
vehicleGroupInde Opt. String Vehicle group ID, which consists of up
xCode to 64 characters.
vehicleGroupNam Opt. String Vehicle group name, which consists of
e up to 32 characters.
description Opt. String Description, which consists of up to
128 characters.

A.1.88 VehicleInfo
The table here shows the information of a vehicle.

492
 HikCentral Professional OpenAPI Developer Guide

Table A-88 VehicleInfo Object Description

Parameter Name Req. or Opt. Data Type Description
vehicleId Opt. String Vehicle ID, which consists of up to 64
characters.
plateNo Opt. String License plate number of the vehicle,
which consists of up to 32 characters.
personName Opt. String Vehicle owner name, which consists
of up to 512 characters.
personFamilyNa Opt. String Family name of the vehicle owner,
me which consists of 256 characters.
personGivenNam Opt. String Given name of the vehicle owner,
e which consists of 256 characters.
phoneNo Opt. String Contact number of vehicle owner,
which consists of up to 32 characters.
plateCategory Opt. String License plate type, which consists of 1
to 32 characters, but cannot contain
special characters like ' / \ : * ? " < > |
plateArea Opt. Number Area of the license plate: 0-not
supported, 60-BHR, 62-LEB, 66-UAE,
68-OMN, 72-QAT, 77-KSA, 84-KUW,
85-SYR,90-IRQ, 93-YMN, 94-JOR, 104-
EGY, 256-AUH, 257-FUJ, 258-DXB, 259-
RAK, 260-AJM, 261-SHJ, 262-UAQ,
263-FED.
plateAreaName Opt. String License plate name.
vehicleColor Opt. Number Vehicle colors, i.e., 0-other color, 1-
white, 2-sliver, 3-grey, 4-black, 5-red,
6-dark blue, 7-blue, 8-yellow, 9-green,
10-brown, 11-pink, 12-purple, 13-dark
blue, 14-cyan.
vehicleGroupInde Opt. String Vehicle group ID, which consists of up
xcode to 64 characters.
effectiveDate Req. String Start time of validity, in ISO 8601
format, which is represented by
"yyyy- MM-ddTHH:mm:ss+current

493
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

time zone", e.g., "2018-07-
26T15:00:00 + 08:00".
expiredDate Req. String End time of validity, in ISO 8601
format, which is represented by
"yyyy- MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00".

A.1.89 Version
The table here shows the product version information.

Table A-89 Version Object Description

Parameter Name Req. or Opt. Data Type Description
produceName Req. String Product name, which consists of up to
64 characters.
softVersion Req. String Software version No. of the product,
which consists of up to 64 characters.

A.1.90 VideoInfo
This table shows the information of a video segment for playback.

Table A-90 VideoInfo Object Description

Parameter Req. or Opt. Data Type Description
beginTime Req. String Start time of video segment, which is
in ISO 8601 standard time format:
yyyy-MM-dd'T'HH:mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00. And
the time consists of up to 64
characters.
endTime Req. String End time of video segment, which is
in ISO 8601 standard time format:
yyyy-MM-dd'T'HH:mm:ss.SSSzzz, e.g.,
2018-07-26T15:00:00 + 08:00. And

494
 HikCentral Professional OpenAPI Developer Guide

Parameter Req. or Opt. Data Type Description

the time consists of up to 64
characters.
size Opt. Number Video segment size, unit: byte. This
field is invalid when mergeSegment is
1. The maximum length of this field is
64.
url Opt. String Streaming URL, which consists of up
to 128 characters.
authentication Opt. String Authentication information, which
can contain up to 1024 characters.

A.1.91 Visitor
The table here shows the visitor information.

Table A-91 Visitor Object Description

Parameter Name Req. or Opt. Data Type Description
ID Opt. Number Visitor ID, the maximum length is 32
characters.
BaseInfo Opt. BaseInfo Visitor's basic information, the
maximum length is 32 characters.

A.1.92 VisitorappointInfo
The table here shows the information of a reservation record.

Table A-92 VisitorappointInfo Object Description

Parameter Name Req. or Opt. Data Type Description
receptionistId Opt. String ID of the person to be visited, which
consists of up to 64 characters.
appointStartTime Req. String Expected time of arrival in ISO 8601
format, which is represented by
"yyyy-MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-

495
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

26T15:00:00 + 08:00". The maximum
length is 64 characters.
appointEndTime Req. String Expected time of leaving in ISO 8601
format, which is represented by
"yyyy-MM-ddTHH:mm:ss+current
time zone", e.g., "2018-07-
26T15:00:00 + 08:00". The maximum
length is 64 characters. If the visitor
has checked out, all permissions
assigned to the visitor will be
unassigned.
visitReasonType Req. Number Visiting purpose type: 0-business, 1-
training, 2-visit, 3-​meeting, 4-others.
visitReasonDetail Opt. String Visiting purpose, this parameters is
required when the value of
visitReasonType is 4. The maximum
length is 128 characters.
receptionistName Opt. String Name of the person to be visited. The
maximum length is 128 characters.
receptionistFullPa Opt. String Organization path of the person to be
th visited. The maximum length is 128
characters.
appointStatus Opt. String Reservation status: 0-reservation
record has been added; 1-reservation
record has been invalid; 2-visitor has
arrived. The maximum length is 64
characters.
appointID Opt. String Reservation record ID. The maximum
length is 64 characters.
appointCode Opt. String Reservation code. The maximum
length is 64 characters.
visitorInfo Opt. Object List of visitor information, which
consists of up to 128 characters.

496
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

Currently, it only supports one visitor
at a time. See details in VisitorInfo .
accessInfo Opt. Object Access information. See details in
accessInfo .

A.1.93 VisitorInfo
The table here shows visitor information.

Table A-93 VisitorInfo Object Description

Parameter Name Req. or Opt. Data Type Description
visitorId Opt. String Visitor ID, which consists of up to 64
characters.
visitorFamilyNam Req. String Visitor's family name, which consists
e of up to 256 characters, but cannot
contain special characters like ' / \ :
*?"<>|
visitorGivenName Req. String Visitor's given name, which consists of
up to 256 characters, but cannot
contain special characters like ' / \ :
*?"<>|
gender Req. Number 0-unknown, 1-male, 2-female.
email Opt. String Email address.
phoneNo Opt. String Phone number, which consists of up
to 20 characters.
plateNo Opt. String License plate number, which consists
of up to 16 characters, but cannot
contain special characters like ' / \ :
*?"<>|
companyName Opt. String Name of the company that the visitor
is from, which cannot contain special
characters like ' / \ : * ? " < > |
certificateType Opt. Number Certificate type: 111-ID card, 414-
passport, 335-driver's license.

497
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

certificateNo Opt. String Certificate number, which consists of
up to 20 characters. Certificate type is
required when certificate number
exists.
remark Opt. String Remark, which consists of up to 128
characters.
faces Opt. Array List of face information.
faces[0] Opt. Object Specific face information (Base64
picture data for adding face
information and picture URL for
getting face information).
fingerPrint Opt. Array List of finger print information.
fingerPrint[0] Opt. FingerPrint Specific finger print information.
cards Opt. Array List of card No.
cards[0] Opt. Card Specific card No.
identiPhoto Opt. Array List of visitor's ID photo.
identiPhoto[0] Opt. String Specific visitor's ID photo (Base64
picture data for adding photo and
picture URL for getting photo).
VisitorPhoto Opt. Array List of visitor's profile photo.
VisitorPhoto[0] Opt. VisitorPhoto Specific visitor's profile photo.
customField Opt. Object List of visitor custom information. See
details in CustomField .
accessInfo Opt. Object Access information. See details in
accessInfo .

A.1.94 VisitorPhoto
The table here shows visitor's photo information.

498
 HikCentral Professional OpenAPI Developer Guide

Table A-94 VisitorPhoto Object Description

Parameter Name Req. or Opt. Data Type Description
haveVisitorPhoto Opt. String Whether visitor's profile photo exists.
haveIdentiPhoto Opt. String Whether visitor's ID photo exists.

A.1.95 watchListInfo

Table A-95 watchListInfo Object Description

Parameter Name Req. or Opt. Data Type Description
ID Opt. String Visitor ID. The maximum length is 64.
enableRegister Opt. Number Whether it is approved. The
maximum length is 64.
rejectNum Opt. Number Number of rejections. The maximum
length is 64.
visitorType Opt. Number The maximum length is 64.
type Opt. String Monitored entity type. The maximum
length is 64.
remark Opt. String Remarks. The maximum length is 128.
visitorTypeName Opt. String Monitored visitor name. The
maximum length is 128.
identiFicationTyp Opt. Number Certificate type. The maximum length
e is 64.
identiFiyCode Opt. String Certificate No. The maximum length is
128.
haveVisitorHeadP Opt. Number Whether with visitor profile picture.
ic
haveVisitorIdenti Opt. Number Whether with visitor certificate
Pic picture.

A.2 Event Message Format

The event message is in JSON format, and the encoding format is UTF-8.

499
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Required/ Data Type Description

Optional
method Required String Method name for indicating the message use.
Here, it always be "OnEventNotify".
params Required Table 6-96 Event parameters.
isHistory Optional Number Whether to copy back history event: 1(yes), 0 or
not configured (real-​time event).

Table A-96 Params

Parameter Name Required/ Data Type Description
Optional
sendTime Required String Event sending time after processing by
program, which is in ISO 8601 standard time
format: YYYY-mm-dd hh:MM:ss + zone, e.g.,
2018-08-15T 15:53:47.000+08:00.
ability Required String Event category, such as video event (event_vss),
access control event (event_acs), ANPR event
(event_veh), and on-board monitoring event
(event_ms).
events Required Table 6-97 Event information.

Table A-97 Events

Parameter Name Required/ Data Type Description
Optional
eventId Required String Event ID (UUID), if the same event occurred for
multiple times, the IDs are same. Its maximum
size is 64 bytes.
srcIndex Required String Event source ID. For physical devices, it is the
resource No. Its maximum size is 64 bytes.
srcType Required String Event source type code, or resource type code.
srcName Optional String Event source name, which is customized by
application. The name is in UTF-8 encoding
format.
eventType Required Number Event types, refer to Event Types or Alarm
Categories for details.

500
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Required/ Data Type Description

Optional
status Required Number Event status: 0-occurred, 1-started, 2-ended, 3-
event pulse, 4-event linkage updated, 5-event
picture uploaded.
eventLvl Optional Number Event level: 0-​unconfigured (default), 1-low, 2-
medium, 3-high.
timeout Required Number Heartbeat timeout. Currently, this field is
reserved.
happenTime Required String Event occurred time (local time), which is in ISO
8601 standard time format, e.g., 2018-08-15T
15:53:47.000+08:00.
srcParentIdex Optional String Parent device No. of event source. If there is no
parent device, set it to "null". Its maximum size
is 64 bytes.
data Optional JSON Event extension information. Its maximum size
is 512 bytes. Refer to ANPR Event Message ,
License Plate Matched or Mismatched Event
Message , Access Control Event Message , and
Face Comparison Event Message for details.

Example
Event Message Example
{
"method": "OnEventNotify",
"params":{
"sendTime": "2017-07-01T15:34:01.000+08:00",
"ability":"event_vss",
"events":[{
"eventId":"c929d9f873eb48439bd2c59df358bbeb",
"srcIndex":"21000000001130001013",
"srcType":"camera",
"srcName":"optional_src_name",
"eventType":130001,
"status":1,
"timeout":30,
"happenTime":"2017-07-01T15:34:01.000+08:00",
"srcParentIdex":"optional-parent",
"data":{"extral event data info":""}
}
]
}

501
 HikCentral Professional OpenAPI Developer Guide

"isHistory":0
}

A.2.1 Access Control Event Message

The table here shows the parameter fields of access control event message.

Parameter Name Req. or Opt. Data Type Description

personId Req. String Person ID, GUID allocated by system
and for internal use.
personCode Opt. String Person code, a customized employee
ID when you add the person, which
cannot be modified once set.
cardNo Req. String Card No.
checkInAndOutTy Req. Number Attendance type, -1: unknown, 1:
pe check-in, 2: check-out, 3: break-out, 4:
break-in, 5: overtime-​in, 6: overtime-
out.
picUri Opt. String Picture URL.
temperatureData Opt. Float Temperature value.
temperatureStatu Opt. Number Temperature status: 0-unknown, 1-
s normal, 2-abnormal.
wearMaskStatus Opt. Number Wearing mask or not: 0-unknown, 1-
yes, 2-no.
readerIndexCode Opt. String Card reader ID.
readerName Opt. String Card reader name.

Example
Message Example of Access Control Event
{
"personId": "",
"cardNo": "",
"checkInAndOutType": ,
"picUri": "",
"temperatureData": ,
"temperatureStatus": ,
"wearMaskStatus": ,
"readerIndexCode": ,

502
 HikCentral Professional OpenAPI Developer Guide

"readerName":
}

A.2.2 ANPR Event Message

The table here shows the fields of ANPR event message.

Table A-98 Message Field Description

Parameter Name Req. or Opt. Data Type Description
plateNo Req. String License plate number.

Example
Message Example of ANPR Event
{
"plateNo":""
}

A.2.3 License Plate Matched or Mismatched Event Message

The table here shows the fields of license plate matched or mismatched event message.

Table A-99 Message Field Description

Parameter Name Req. or Opt. Data Type Description
plateNo Req. String License plate number.
vehicleGroupInde Req. String Vehicle group ID.
xCode

Example
Message Example of License Plate Matched or Mismatched Event
{
"plateNo":"",
"vehicleGroupIndexCode":""
}

A.2.4 Face Comparison Event Message

The table here shows the parameter fields of face comparison event message.

503
 HikCentral Professional OpenAPI Developer Guide

Table A-100 Message Field Description

Parameter Name Req. or Opt. Data Type Description
alarmResult Req. Object Face picture comparison results.
faces Req. Array Face information list.
faces[0] Req. Object Information of a face in the list.
URL Req. String Captured face picture URL.
snap_pic_data Opt. String Captured face picture data, which is
encoded by Base64.
age Opt. Object Age information.
ageGroup Opt. String "UNKNOWN", "CHILD", "YOUNG",
"MIDDLE", "OLD", "INFANT", "KID",
"TEENAGER", "PRIME",
"MIDDLEAGED".
faceRect Opt. Array Coordinates information list of a face
frame.
faceRect[0] Opt. Object Coordinates information of a face
frame in the list.
height Opt. Number Height.
width Opt. Number Width.
x Opt. Number X-coordinate.
y Opt. Number Y-coordinate.
temperature Opt. Object Temperature information.
temperatureData Opt. Float Temperature value.
temperatureStatu Opt. Number Temperature status: 0-unknown, 1-
s normal, 2-abnormal.
mask Opt. Object Wearing mask information.
wearMaskStatus Opt. Number Wearing mask or not: 0-unknown, 1-
yes, 2-no.
gender Opt. Object Gender information.
value Opt. String "0" (unknown), "1" (male), "2"
(female).
identify Opt. Object Identification information.

504
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

candidate Req. Object Matched face information.
blacklist_id Req. String Face comparison group ID of the
matched face.
human_data Req. Object Person data.
face_picurl Req. String Picture URL of the matched face.
face_pic_data Opt. String Picture data of the matched face,
which is encoded by Base64.
human_id Req. String Person ID of the matched face.
reserve_​field Opt. Object Reserved field.
name Opt. String Person name of the face.
similarity Req. Number Similarity between the matched face
and captured face.
targetAttrs Req. Object Target attributes.
cameraIndexCode Req. String Camera ID of the captured picture.
faceTime Req. String Captured time.
dataType Req. String Event types, for face picture
comparison event, the value of this
field is "faceMatch".

Example
Message Example of Face Comparison Event
{
"alarmResult":{
"faces":[{
"URL": "",
"snap_pic_data": "",
"age":{
"ageGroup":"CHILD"
},
"faceRect":[{
"height": ,
"width": ,
"x": ,
"y":
}],
"temperature":{
"temperatureData": ,
"temperatureStatus":

505
 HikCentral Professional OpenAPI Developer Guide

},
"mask":{
"wearMaskStatus":
},
"gender":{
"value":"1",
},
"identify":{
"candidate":{
"blacklist_id": "",
"human_data":{
"face_picurl": "",
"face_pic_data": ""
},
"human_id":"",
"reserve_field":{
"name":""
},
"similarity":
}
}
}],
"targetAttrs":{
"cameraIndexCode":"",
"faceTime": ""
}
}
dataType:""
}

A.2.5 On-Board Monitoring Event Message

The table here shows the parameter fields of on-board monitoring event message.

Parameter Name Req. or Opt. Data Type Description

gps Req. Object GPS information.
vehicle Req. Object Vehicle information.
urlList Opt. urlList[] URL of picutures or short videos.

Table A-101 gps field description

Parameter Name Req. or Opt. Data Type Description
occurTime Req. String GPS report time, in ISO 8601 standard
time format: yyyy-MM-ddTHH:mm:ss

506
 HikCentral Professional OpenAPI Developer Guide

Parameter Name Req. or Opt. Data Type Description

+current zone, e.g., 2018-07-
26T15:00:00+08:00.
longitude Req. Float Longitude.
latitude Req. Float Latitude.
direction Req. Number Vehicle direction (calculated clockwise
from due north (0); the actual degree
* 100; [0, 36000)).
speed Req. Float Speed (consistent with the HCP
platform: km/h by default). The
maximum length is 16 characters.
speedUnit Req. Number Speed unit: 0-km/h, 1-Mph.
displayInfo Req. String Displayed GPS information.
directionInfo Req. String Displayed direction ("North",
"Northeast", "East", "Southeast",
"South", "Southwest", "West",
"Northwest"). The maximum length is
16 characters.

Table A-102 vehicle field description

Parameter Name Req. or Opt. Data Type Description
plateNo Req. String License plate number of the vehicle,
which consists of up to 32 characters.
ownerName Req. String Vehicle owner name, which is the
specific field of the event message.
phoneNo Req. String Vehicle owner's contact number.
vehicleBrand Req. Number Vehicle brand.
vehicleColor Req. Number Vehicle color.
vehicleType Req. String Vehicle type: 0-others, 1-small-sized
vehicle, 2-large-sized vehicle, 3-
motorcycle.

507
 HikCentral Professional OpenAPI Developer Guide

Table A-103 urlList field description

Parameter Name Req. or Opt. Data Type Description
format Req. String Format: 0-URL format, 1-binary
format.
url Req. String URL of pictures or short videos, which
is the specific field of the event
message.
expandInfo Opt. String Extension information.

Table A-104 expandInfo field description

Parameter Name Req. or Opt. Data Type Description
suffixName Req. String File extension, e.g., "jpeg".
mediaType Req. String Media type: VideoClip- video files,
Image-pictures (default).

Example
Message Example of On-Board Monitoring Event
{
"urlList": [
{
"format": 0,
"url": "Vsm://PHQG#20220622#20220622_112325847.d:1941072:537216",
"expand": {
"suffixName": "jpeg",
"mediaType": "Image"
}
}
],
"gps": {
"occurTime": "2022-06-22T16:48:06+08:00",
"longitude": 120.21746826171875,
"latitude": 30.210418701171876,
"direction": 12000,
"speed": 0.0,
"speedUnit": 0,
"displayInfo": "E120,13,2;N30,12,37",
"directionInfo": "North"
},
"vehicle": {
"plateNo": "zhe123",
"ownerName": "",
"phoneNo": "",
"vehicleBrand": 0,

508
 HikCentral Professional OpenAPI Developer Guide

"vehicleColor": 0,
"vehicleTpe": 0
}
}

A.3 Data Dictionary

Resource Types / Resource Permission Code

Resource Code Resource Name Permission Permission Control Name

Control Code
region Area. view View.
acsDevice Access controller. view View.
eventRecv Receive events.
door Access point. view View.
eventRecv Receive events.
doorControl Open/Close door.
normalControl Remain open/closed door.
encodeDevice Encoding device. view View.
eventRecv Receive events.
intercom Device intercom.
mobileDevice On-board device. \ \
mobileVehicle Vehicle linked to \ \
on-board device.
camera Camera. view View.
preview Preview.
ptzControl PTZ control.
audioRecv Receive audio.
playback Playback recording.
eventRecv Receive events.
osdConfig OSD overlay configuration.
picQuery Search picture.

509
 HikCentral Professional OpenAPI Developer Guide

Resource Code Resource Name Permission Permission Control Name

Control Code
eventRecv Receive events.
histroyWay Playback pattern.
ioIn Alarm input. view View.
eventRecv Receive events.
ioOut Alarm output. view View.
ioOutControl Output Control.
generalEventRule General event view View.
rule.

Access Protocol of Device

Access Protocol Code Access Protocol Name

hiksdk_net Hikvision Private Protocol
ehome_reg Hikvision Intelligent Security Uplink Protocol
onvif_net ONVIF Protocol

Gender Type

Gender Type Type Description

0 Unknown.
1 Male.
2 Female.

Vehicle Color

Color Type Type Description

0 Other color.
1 White.
2 Silver.
3 Gray.

510
 HikCentral Professional OpenAPI Developer Guide

Color Type Type Description

4 Black.
5 Red.
6 Dark Blue.
7 Blue.
8 Yellow.
9 Green.
10 Brown.
11 Pink.
12 Purple.
13 Dark Gray.
14 Cyan.

Video Type

Enumeration Data Type Enumeration Enumeration Enumeration Value

Field Type Value Description
streamType Number Stream Type 0 Main Stream.
1 Sub Stream.
protocol String Stream Protocol rtsp RTSP protocol.
rtmp RTMP protocol.
hls HLS protocol.
websocket Websocket protocol
streaming (added in
HikCentral and applied in
jsdecoder).
rtsp_s Standard protocol
streaming (added in
HikCentral and applied in
RTSP streaming).
websocket_s WebSocket Secure
protocol streaming.

511
 HikCentral Professional OpenAPI Developer Guide

Enumeration Data Type Enumeration Enumeration Enumeration Value

Field Type Value Description
transmode Number Transmission 0 UDP.
Protocol
1 TCP.
recordLocation String Storage Type 0 Center Storage.
1 Device Storage.
action Number PTZ Control 0 Start.
1 Stop.
command String Control LEFT Turn left.
Command
RIGHT Turn right.
UP Turn up.
DOWN Turn down.
ZOOM_IN Zoom in.
ZOOM_OUT Zoom out.
LEFT_UP Turn upper left.
LEFT_DOWN Turn lower left.
RIGHT_UP Turn upper right.
RIGHT_ Turn lower right.
DOWN
FOCUS_NEAR Focus+.
FOCUS_FAR Focus-.
IRIS_ Iris+.
ENLARGE
IRIS_REDUCE Iris-.
GOTO_ Go to preset.
PRESET

512
 HikCentral Professional OpenAPI Developer Guide

Capability Set

Capability Set ID Capability Set Name

vss Video capability.
event_veh Vehice capture capability.
gis FoV capability.
event_heat Thermal imaging capability.
event_pdc People counting statistics capability.
ptz PTZ capability.

Recording Storage Location

Recording Storage Type Code Recording Storage Type

0 Center storage.
1 Device Storage.
2 Center cluster storage.

Transmission Protocol

Transmission Protocol Code Transmission Protocol Name

0 UDP
1 TCP

Recording Type

Recording Type Code

0 Main storage.
1 Main storage.

513
 HikCentral Professional OpenAPI Developer Guide

Age Group

Age Group Code Age Group Name Remarks

UNKNOWN Unknown. 0
CHILD Teenager. 3
YOUNG Youth. 5
MIDDLE Middle age. 7
OLD Elderly. 9
INFANT Infant. 1
KID Child. 2
TEENAGER Early youth. 4
PRIME Prime. 6
MIDDLEAGED Middle to old age. 8

A.4 Event Types or Alarm Categories

Camera Alarms

Alarm Category Category Code Resource Type

Vehicle Matched Event 130 camera
Vehicle Mismatched Event 131 camera
Temperature Exception 193 camera
No Mask 194 camera
Face Capture 49697 camera
Driving on the Lane Line 103008 camera
Video Loss 131329 camera
Video Tampering Detection 131330 camera
Motion Detection 131331 camera
Line Crossing 131585 camera
Region Entrance 131586 camera

514
 HikCentral Professional OpenAPI Developer Guide

Alarm Category Category Code Resource Type

Region Exiting 131587 camera
Intrusion 131588 camera
Loitering 131590 camera
Parking 131591 camera
Fast Moving 131592 camera
People Gathering Alarm 131593 camera
Unattended Baggage 131594 camera
Object Removal 131595 camera
Violent Motion Detection 131596 camera
Climbing Detection 131597 camera
Getting Up Detection 131598 camera
Operation Timeout 131600 camera
Sticking Script 131601 camera
Install Card Reader 131602 camera
Absence Detection 131603 camera
Tailing 131604 camera
Falling Down 131605 camera
In-Toilet Overtime Detection 131608 camera
Yard Overstay Detection 131609 camera
Key Person Getting Up Detection 131610 camera
Scene Change Detection 131612 camera
Defocus Detection 131613 camera
Audio Exception Detection 131623 camera
Abnormal Number of People 131664 camera
Standing Up Detection 131666 camera
Sitting Detection 131667 camera
Staying Overtime 131669 camera
People Density Analysis 131672 camera

515
 HikCentral Professional OpenAPI Developer Guide

Alarm Category Category Code Resource Type

Using Mobile Phone 131673 camera
Physical Conflict 131677 camera
Physical Conflict (Indoor) 131678 camera
Wrong-Way Driving 131679 camera
Police Absence 131682 camera
People Density 131702 camera
Abnormal Face 131704 camera
Sleep on Duty Detection 131717 camera
Vehicle Speeding 131841 camera
Making Phone Call 132374 camera
Waiting Time Detection Alarm 133121 camera
People Queuing-up Alarm 133122 camera
Fire and Smoke Detection 192515 camera
Temperature Alarm 192517 camera
Temperature Difference Alarm 192518 camera
Reverse Entering Alarm 200497 camera
Illegal Lane Change 225309 camera
Illegal Parking 254101 camera
PIR 364545 camera
Camera Recording Exception 385052 camera
Camera Recording Recovered 385053 camera
Hard Hat Detection 1417219 camera
Multi-​Target-​Type Detection 1421313 camera
Sudden Change of Sound Intensity Detection 1441795 camera
Intrusion Detection 1482753 camera
AIOP Event 3072-4071 camera
HEOP Event 4027 camera

516
 HikCentral Professional OpenAPI Developer Guide

Alarm Input Alarms

Alarm Category Category Code Resource Type

Alarm Input Triggered 589825 ioIn

Encoding Device Alarms

Alarm Category Category Code Resource Type

HDD Full 66050 encodeDevice
Illegal Login 66053 encodeDevice
R/W HDD Failure 66054 encodeDevice
Array Exception 66055 encodeDevice
Video Standard Mismatch 66065 encodeDevice
Camera/Recording Resolution Mismatch 66066 encodeDevice
Device Offline 66306 encodeDevice
Device Reconnected 66311 encodeDevice
Encoding Device Recording Exception 385050 encodeDevice
Encoding Device Recording Recovered 385051 encodeDevice
HDD Bad Sector 225404 encodeDevice
HDD High Temperature 225405 encodeDevice
HDD Impact Detection 225406 encodeDevice
HDD Severe Failure 225407 encodeDevice

Door Alarms

Alarm Category Category Code Resource Type

Remaining Locked Status Started 198148 door
Remaining Locked Status Ended 198150 door
Door Open Timed Out (Door Contact) 198400 door
Remaining Unlocked Status Started 198401 door
Remaining Unlocked Status Ended 198402 door

517
 HikCentral Professional OpenAPI Developer Guide

Alarm Category Category Code Resource Type

Force Accessing 198657 door
Door Abnormally Open (Door Contact) 198658 door
Door Open (Door Contact) 198913 door
Remote: Unlocked Door 198919 door
Remote: Remained Unlocked (Free Access) 198922 door
Door Closed (Door Contact) 199169 door
Remote: Locked Door 199171 door
Remote: Remained Locked (Credential Failed) 199172 door
Card Reader Tampering Alarm 199608 door
Door Unlocked (Door Lock) 199941 door
Door Locked (Door Lock) 199942 door

Access Control Device Alarms

Alarm Category Category Code Resource Type

Device Tampered 199708 acsDevice
Device Tampering Alarm Restored 199709 acsDevice

On-Board Device Alarms

Alarm Category Category Code Resource Type

On-Board Devices Online 641 mobileDevice
On-Board Devices Offline 642 mobileDevice

Person Alarms

Alarm Category Category Code Resource Type

Temperature Exception 193 camera/door
No Mask 194 camera/door

518
 HikCentral Professional OpenAPI Developer Guide

General Event Alarms

Event Type Event Type Code Resource Type

Generic Event 195 generalEventRule

Card Swiping Events

Event Type Event Type Code Resource Type

Multi-​Factor Authentication: Access 196883 door
Granted
Multi-​Factor Authentication: Super 196884 door
Password Access Granted
Access Granted by Card and Fingerprint 196885 door
Access Granted by Card, Fingerprint, and 196886 door
PIN
Access Granted by Fingerprint and PIN 196887 door
Access Granted by Face and Fingerprint 196888 door
Access Granted by Face and PIN 196889 door
Access Granted by Face and Card 196890 door
Access Granted by Face, PIN, and 196891 door
Fingerprint
Access Granted by Face, Card, and 196892 door
Fingerprint
Access Granted by Face 196893 door
Access Granted by Employee ID and 196894 door
Fingerprint
Access Granted by Employee ID, 196895 door
Fingerprint, and PIN
Access Granted by Employee ID and Face 196896 door
Access Granted by Employee ID and PIN 196897 door
Access Denied by Invalid M1 Card 196898 door
Verifying CPU Card Encryption Failed 196899 door

519
 HikCentral Professional OpenAPI Developer Guide

Event Type Event Type Code Resource Type

Access Denied (NFC Card Reading 196900 door
Disabled)
EM Card Reading Not Enabled 196901 door
M1 Card Reading Not Enabled 196902 door
CPU Card Reading Disabled 196903 door
Skin-Surface Temperature Measured 197107 door
Access Granted by Fingerprint 197127 door
Access Denied by Fingerprint 197128 door
Access Timed Out by Card and PIN 197132 door
Max. Card and Password Authentication 197133 door
Times
Access Denied by Card and Fingerprint 197134 door
Access Timed Out by Card and Fingerprint 197135 door
Access Denied by Card, Fingerprint, and 197136 door
PIN
Access Timed Out by Card, Fingerprint, 197137 door
and PIN
Access Denied by Fingerprint and PIN 197138 door
Access Timed Out by Fingerprint and PIN 197139 door
Fingerprint Does Not Exist 197140 door
Access Denied by Face and Fingerprint 197141 door
Access Timed Out by Face and Fingerprint 197142 door
Access Denied by Face and PIN 197143 door
Access Timed Out by Face and PIN 197144 door
Access Denied by Face and Card 197145 door
Access Timed Out by Face and Card 197146 door
Access Denied by Face, PIN, and 197147 door
Fingerprint
Access Timed Out by Face, PIN, and 197148 door
Fingerprint

520
 HikCentral Professional OpenAPI Developer Guide

Event Type Event Type Code Resource Type

Access Denied by Face, Card, and 197149 door
Fingerprint
Access Timed Out by Face, Card, and 197150 door
Fingerprint
Access Denied by Face 197151 door
Access Denied by Employee ID and 197152 door
Fingerprint
Access Timed Out by Employee ID and 197153 door
Fingerprint
Access Denied by Employee ID, 197154 door
Fingerprint, and PIN
Access Timed Out by Employee ID, 197155 door
Fingerprint, and PIN
Access Denied by Employee ID and Face 197156 door
Access Timed Out by Employee ID and 197157 door
Face
Access Denied by Employee ID and PIN 197158 door
Access Timed Out by Employee ID and PIN 197159 door
Facial Recognition Failed 197160 door
Live Facial Detection Failed 197161 door
Access Denied by Card and PIN 197382 door
Anti-​Passback Violation 197383 door
Invalid Time Period 197384 door
Card Not in Multi-​Factor Authentication 197391 door
Group
Card Not in Multi-​Factor Authentication 197392 door
Duration
Card No. Expired 197633 door
Card No. Does Not Exist 197634 door
No Access Level Assigned 197635 door
Multi-​Door Interlocking 198146 door

521
 HikCentral Professional OpenAPI Developer Guide

Event Type Event Type Code Resource Type

Access Granted by Card 198914 door
Access Granted by Card and PIN 198915 door
Max. Card Access Failed Attempts 199429 door
Access Denied: First Person Not 200477 door
Authorized
Access Denied (Door Remained Locked or 200513 door
Inactive)
Access Denied: Scheduled Sleep Mode 200514 door
Employee ID Does Not Exist 200515 door
Access Granted via Combined 200516 door
Authentication Modes
Combined Authentication Timed Out 200517 door
Authentication Mode Mismatch 200518 door
Password Mismatches 200519 door
Verifying Card Encryption Information 261952 door
Failed
Password Authenticated 263433 door
Duress Alarm 721678 door
Failed Password Attempts Alarm 983304 door

ANPR Events

Event Type Event Type Code Resource Type

License Plate Information Uploading 131622 camera

Facial Events

Event Type Event Type Code Resource Type

Face Picture Comparison Event 131659 camera

522
 HikCentral Professional OpenAPI Developer Guide

On-Board Monitoring Events

Event Type Event Type Code Resource Type

GPS Data Report 643 mobileVehicle
Forward Collision Warning 644 mobileVehicle
Headway Monitoring Warning 645 mobileVehicle
Lane Deviation Warning 646 mobileVehicle
Pedestrian Collision Warning 647 mobileVehicle
Speed Limit Warning 648 mobileVehicle
Blind Spot Warning 649 mobileVehicle
Smoking 650 mobileVehicle
Using Mobile Phone 651 mobileVehicle
Fatigue Driving 652 mobileVehicle
Distraction 653 mobileVehicle
Seatbelt Unbuckled 654 mobileVehicle
Video Tampering 655 mobileVehicle
Emergency Alarm 656 mobileVehicle
Sharp Turn 657 mobileVehicle
Sudden Brake 658 mobileVehicle
Sudden Acceleration 659 mobileVehicle
Rollover 660 mobileVehicle
Speeding 661 mobileVehicle
Collision 662 mobileVehicle
Fence for Entry Detection 663 mobileVehicle
Deviation 664 mobileVehicle
Fence for Exit Detection 665 mobileVehicle

A.5 Status or Error Code

523
 HikCentral Professional OpenAPI Developer Guide

API Gateway Status or Error

Status or Error Code Description

0x02401000 No AppKey is configured. Enter the correct AppKey in the
request.
0x02401001 The partner of AppKey does not exist. Check the AppKey in the
request.
0x02401002 No signature is configured. Enter the correct signature in the
request.
0x02401003 Invalid signature. Check the signature in the request.
0x02401004 Token authentication failed. Check the token.
0x02401005 No token is configured. Enter the token.
0x02401006 Token exception. Check the token.
0x02401007 No permission. Please contact the administrator to apply for
permissions.
0x02401008 Authentication exception. Check the gateway service.
0x02401009 Maximum API calling attempts reached. Please contact the
administrator to apply for adding access attempts.
0x0240100a Parameter conversion exception. Check the API parameters.
0x0240100b Calling statistics exception. Check the gateway.

Parameter Status or Error

Status or Error Code Description

0x00072001 The required parameters are not configured. Set the required
parameters in the request.
0x00072002 Invalid parameter value range.
0x00072003 Invalid parameter value format.
0x00072004 The response message is too long. Set the page size in the
request.

524
 HikCentral Professional OpenAPI Developer Guide

Internal Service Status or Error

Status or Error Code Description

0x00052101 Highest service performance reached. Try again later.
0x00052102 Service error. Try again later.
0x00052103 Service response timed out. Try again later.
0x00052104 Service is not available. Try again after restoring the service.

Resource Access Status or Error

Status or Error Code Description

0x00072201 No permission for resource access. Please contact the
administrator to apply for permissions.
0x00072202 The resource does not exist. Enter the correct resource No. in
the request.
0x00072203 Maximum number of Licenses reached. Check the License
information from the administrator.
0x00072204 No permission for this function. Check the License information
from the administrator.

Other Status or Error

Status or Error Code Description

0x00052301 Unknown error.

OpenAPI Translation Service Status or Error

Status or Error Code Description

1 Unknown error.
2 Incorrect request parameter.
3 Insufficient system resources.
4 Network timed out.
5 Service exception.

525
 HikCentral Professional OpenAPI Developer Guide

Status or Error Code Description

6 The server is busy.
7 Invalid network command.
8 This product version is not supported.
9 Invalid token.
10 Incorrect XML response message.
11 The HTTP is not supported.
12 The URL is not supported.
13 The authentication information between service and HikCentral
Professional OpenAPI mismatches.
14 The WAN information of HikCentral Professional OpenAPI is not
configured.
15 The NIC information of HikCentral Professional OpenAPI is not
configured.
16 Connecting to service exception.
17 No permission for OpenAPI access.
64 The user of third-party partner platform exception.
65 The user is locked.
66 The user does not exist.
67 Initialize before login for first time.
128 The request resource does not exist.
129 The resource is offline.
130 No permission for the resource access.
131 The request resource already exists.
132 The maximum number of resources reached.
133 The resource is occupied.
140 The recording schedule does not exist.
192 Operation and control failed.
193 Connecting to cloud storage failed.

526
 HikCentral Professional OpenAPI Developer Guide

Status or Error Code Description

194 Connecting to device failed.
195 The device does not support this function.

527
UD36307B