Home

IP Media Device Management Protocol User Guide

1. 2009 2014 by HIKVISION All rights reserved 64 HIKVISION Raw Data 8 8 Security Security Service v1 0 Notes 8 8 1Users Security users General Resource v1 0 Description It is used to get the user list for the device Query None Inbound Data None Success Return UserList Description It is used to update the user list for the device Query None Inbound Data UserList Success Return hik ResponseStaus ResponseStatus POST Administrator Description It is used to add a user for the device Query None Inbound Data User Success Return hik ResponseStaus ResponseStatus DELETE Administrator Description It is used to delete the user list for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes A default user account admin must be provided Its default password is 12345 It has an Administrator user level and must not be deleted Passwords can only be uploaded they are never revealed during GET operations UserList XML Block lt UserList version 1 0 xmlns http www hikvision com ver10 XMLSchema gt lt User gt lt opt gt 2009 2014 by HIKVISION All rights reserved 65 HIKVISION lt UserList gt 8 8 2User Security users D General Resource v1 0 Description It is used to get a particular user configuration for the device Query None Inbound Data None Success Return User
2. xmins http www hikvision com ver10 XMLSchema gt lt id gt lt req xs string id gt lt id gt lt url gt lt req xs string gt lt url gt lt protocolType gt lt req xs string HTTP HTTPS gt lt protocolType gt lt parameterFormatType gt lt req xs string XML querystring gt lt parameterFormatType gt lt addressingFormatType gt lt req xs string ipaddress hostname gt lt addressingFormatType gt lt hostName gt lt dep xs string gt lt hostName gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt ipv6Address gt lt dep xs string gt lt ipv6Address gt lt portNo gt lt opt xs integer gt lt portNo gt lt userName gt lt dep xs string gt lt userName gt lt password gt lt dep xs string gt lt password gt lt httpAuthenticationMethod gt lt req xs string MD5digest none gt lt httpAuthenticationMethod gt lt HttpHostNotification gt 8 11 12 Notification alertStream Event notification alertStream General Resource v1 0 It is used to get the event notification data stream through HTTP Description server push Query None 2009 2014 by HIKVISION All rights reserved 92 HIKVISION Inbound Data None Success Return Stream of lt EventNotificationAlert gt Notes This function is used to get an event notification alert stream f
3. 2009 2014 by HIKVISION All rights reserved 69 HIKVISION channel lt audioResolution gt is the resolution for the outbound audio stream in bits StreamingChannel XML Block lt StreamingChannel version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer 1 2 gt lt id gt lt channelName gt lt ro req xs string gt lt channelName gt lt enabled gt lt ro req xs boolean gt lt enabled gt lt Transport gt lt req gt lt rtspPortNo gt lt opt xs integer gt lt rtspPortNo gt lt maxPacketSize gt lt ro opt xs integer gt lt maxPacketSize gt lt sourcePortNo gt lt opt xs integer gt lt sourcePortNo gt lt ControlProtocolList gt lt req gt lt ControlProtocol gt lt opt gt lt streamingTransport gt lt ro req xs string RTSP gt lt streaming Transport gt lt ControlProtocol gt lt ControlProtocolList gt lt Unicast gt lt opt gt lt enabled gt lt ro req xs boolean true gt lt enabled gt lt Unicast gt lt Multicast gt lt opt gt lt enabled gt lt ro req xs boolean true gt lt enabled gt lt destIPAddress gt lt opt xs string gt lt destIPAddress gt lt destPortNo gt lt opt xs integer gt lt destPortNo gt lt Multicast gt lt Transport gt lt Video gt lt enabled gt
4. Image channels lt ID gt Focus General Resource v1 0 Description It is used to get focus parameters of a specified image channel Query None Inbound Data None Success Return Focus Description It is used to update focus parameters of a specified image channel Query None Inbound Data Focus Success Return hik ResponseStaus ResponseStatus Notes AUTO auto focus MANUAL manual focus SEMIAUTOMATIC semi automatic FocusValue s PUT operator is enabled only when FocusStyle s value is MANUAL focusSpeed focus vector data Negative numbers focus near positive numbers focus far Numerical value is a percentage of the maximum focus speed of the lens module Focus XML Block lt Focus version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt FocusStyle gt _ lt req xs string AUTO MANUAL SEMIAUTOMATIC gt 2009 2014 by HIKVISION All rights reserved 127 HIKVISION lt FocusLimited gt lt req xs string 1cm 10cm 30cm 1m 1 5m 3m 6m INFINITE gt lt FocusValue gt lt optdep depends on lt FocusStyle gt xs integer gt lt focusSpeed gt lt opt xs intger 100 100 gt lt focusSpeed gt lt Focus gt 8 14 6 Image channels lt ID gt Lenslnitialization Image channels lt ID gt LensInitialization General Resource v1 0 It is used to get the initizlization status of the lens of a specified image Description channe
5. Only support the rectangular region which will be drawn from four coordinates The four points is counterclockwise direction and the beginning point is the top left point Ordering of lt PrivacyMaskRegion gt blocks is insignificant PrivacyMaskRegion XML Block lt PrivacyMaskRegion version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt 2009 2014 by HIKVISION All rights reserved 53 HIKVISION lt RegionCoordinatesList gt lt req gt lt RegionCoordinates gt lt req gt lt positionX gt lt req xs integer coordinate gt lt positionX gt lt positionY gt lt req xs integer coordinate gt lt positionY gt lt RegionCoordinates gt lt RegionCoordinatesList gt lt RegionExt gt lt opt gt lt enabled gt lt req xs boolean gt lt enabled gt lt privacymaskName gt lt opt xs string gt lt privacymaskName gt lt maskType gt lt opt xs string gray red yellow blue orange green transparent half transparent mosaic gt lt maskType gt lt RegionExt gt lt PrivacyMaskRegion gt Example for priavacyMask Region Origin coordinate 8 4 10 Input channel shelterAlarm Video inputs channels D shelterAlarm General Resource v1 0 It is used to get the shelter alarm configuration for a video input Description channel Query None Inbound Data Non
6. lt req xs strings disable atuoscan framescan randomscan panoramascan patrol pattern preset tiltscan periodreboot periodadjust auxoutput gt lt TaskType gt lt TaskNum gt lt dep xs integer 0 8 gt lt TaskNum gt lt Task gt lt TimeTaskRange gt lt TimeTaskBlock gt 8 13 36 PTZCtrl channels lt ID gt timetasks lt ID gt copytask PTZCirl channels lt ID gt timetasks lt ID gt copytask General Resource v1 0 It is used to get the default copy time of a tasks list of a specified PTZ Description channel Query None Inbound Data None Success Return TimeTaskCopy PUTO Operator Description It is used to update the default copy time of a tasks list of a specified PTZ channel Query None Inbound Data TimeTaskCopy Success Return hik ResponseStaus ResponseStatus Notes lt curDayOfWeek gt specify the current day of a week lt copyDayOfWeek gt specify the days that will have the same settings as the current day TimeTaskCopy XML Block lt TimeTaskCopy version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt curDayOfWeek gt lt req xs integer SO8601 weekday number 1 Monday gt lt curDay gt lt copyDayOfWeek gt lt req xs integer SO8601 weekday number 1 Monday gt lt copyDay gt lt TimeTaskCopy gt 2009 2014 by HIKVISION All rights reserved 123 HIKVISION 8 13 37 PTZCtrl channels lt ID g
7. Only used when movement limitation is enabled 8 13 32 PTZCtrl channels lt ID gt ptzlimiteds lt ID gt set PTZCirl channels lt ID gt ptzlimiteds lt ID gt set General Resource v1 0 Description Set other positions of a movement limitation of a PTZ channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Only used when movement limitation is enabled and setstart already been used Order of the positions is left gt right gt up down Please save the settings after setup 8 13 33 PTZCtrl channels lt ID gt saveptzpoweroff PTZCirl channels lt ID gt saveptzpoweroff General Resource v1 0 Description It is used to get the PTZ power off memory settings information Query None Inbound Data None Success Return PTZChannel Description It is used to update the PTZ power off memory settings information Query None Inbound Data PTZChannel 2009 2014 by HIKVISION All rights reserved 120 HIKVISION Success Return hik ResponseStaus ResponseStatus Notes lt savePtzPoweroff gt Power off memory savePtzPoweroff XML Block lt savePtzPoweroff version 1 0 xmlIns http www hikvision com ver10 XMLSchema gt lt savePtzPoweroffType gt lt req xs integer disable 30sec 60sec 300sec 600sec gt lt savePtzPowerofflype gt lt savePtzPoweroff gt 8 13 34 PTZCtrl channels lt ID gt timetasks PTZCtrl channels lt ID gt timetasks General Resource
8. Query None Inbound Data None Success Return ImageFreeze ine It is used to update ImageFreeze status of a specified image Description channel Query None Inbound Data ImageFreeze Success Return ResponseStaus ResponseStatus Notes ImageFreeze XML Block lt ImageFreeze version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt ImageFreeze gt 8 14 9 Image channels lt ID gt proportionalpan Image channels lt ID gt proportionalpan General Resource v1 0 It is used to get proportional pan status of a specified image channel Query None Description 2009 2014 by HIKVISION All rights reserved 129 HIKVISION Inbound Data None Success Return proportionalpan It is used to update proportional pan status of a specified image Description channel Query None Inbound Data proportionalpan Success Return ResponseStaus ResponseStatus Notes proportionalpan XML Block lt proportionalpan version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt proportionalpan gt 8 14 10 Image channels lt ID gt WDRExt Image channels lt ID gt WDRExt General Resource v1 5 9 It is used to get the value of wide dynamic range for a specified Description Image channel Query None Inbound Data None Success Return WDRExt It is used to configure the value of wide
9. gt lt enabled gt lt req gt lt enabled gt lt PTZLimited gt lt opt gt lt PTZLimitedList gt 8 13 30 PTZCtri channels lt ID gt ptzlimiteds lt ID gt PTZCirl channels lt ID gt ptzlimiteds lt ID gt General Resource v1 0 Description It is used to get movement limitations of a PTZ channel Query None Inbound Data None Success Return PTZLimited Description It is used to clear movement limitations of a PTZ channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes It is used to get or set the parameter that whether movement limitation is enabled or disabled Speed dome add two types of movement limitation lt ID gt 1 Manual control movement limitation lt ID gt 2 Panorama scan movement limitation PTZLimited XML Block lt PTZLimited version 1 0 xmlns http www hikvision com ver 10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt id gt lt req xs string id gt lt id gt lt PTZLimited gt 2009 2014 by HIKVISION All rights reserved 119 HIKVISION 8 13 31 PTZCtrl channels lt ID gt ptzlimiteds lt ID gt setsta rt PTZCirl channels lt ID gt ptzlimiteds lt ID gt setstart General Resource v1 0 Set the start position of a movement limitation of a PTZ Description channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes
10. lt dep xs integer 0 100 gt lt sensitivityLevel gt lt IrLight gt 8 14 34 Image channels lt ID gt WDR 1 5 8 old version Image channels lt ID gt WDR General Resource v1 0 2009 2014 by HIKVISION All rights reserved 145 HIKVISION It is used to get the value of wide dynamic range for a specified Description Image channel Query None Inbound Data None Success Return WDR It is used to configure the value of wide dynamic range for a specified Description Image channel Query None Inbound Data WDR Success Return ResponseStaus ResponseStatus Notes The range of WDRLevel s value is needed according to the capbilites of devices WDR XML Block lt WDR version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt WDRLevel gt lt opt xs string 0 1 2 100 B0 B1 B2 B100 gt lt WDRContrastLevel gt lt opt xs integer 0 100 gt lt WDR gt 8 14 35 Image channels lt ID gt NoiseReduce 1 5 8 old version Image channels lt ID gt NoiseReduce General Resource v1 0 It is used to get the NoiseReduce s value of a specified image Description channel Query None Inbound Data None Success Return NoiseReduce ae It is used to configure the NoiseReduce s value of a specified image Description channel Query None Inbound Data NoiseReduce Success Return ResponseStaus ResponseStatus Notes
11. opt gt lt Sharpness gt lt opt gt lt lris gt lt opt gt lt Shutter gt lt opt gt lt Gain gt lt opt gt lt gamaCorrection gt lt opt gt lt powerLineFrequency gt lt opt gt lt Color gt lt opt gt lt NosiseReduceExt gt lt opt gt lt IrcutFilterExt gt lt opt gt lt WDRExt gt lt opt gt lt Scene gt lt opt gt lt EPTZ gt lt opt gt lt PTZ gt lt opt gt lt EIS gt lt opt gt lt HLC gt lt opt gt lt ChromaSuppress gt lt opt gt lt ZoomLimit gt lt opt gt lt ExpComp gt lt opt gt lt ImageChannel gt 8 14 3 Image channels lt ID gt resetimage Image channels lt ID gt resetimage General Resource v1 0 It is used to reset an image channel cut off the power and reboot the Description speed dome Query None Inbound Data None 2009 2014 by HIKVISION All rights reserved 126 HIKVISION Success Return hik ResponseStaus ResponseStatus Notes Image reset only reboot the camera unit 8 14 4 Image channels lt ID gt restorelmageparam Image channels lt ID gt restorelmageparam General Resource v1 0 It is used to reset the image configure parameter to the factory Description default Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 8 14 5 Image channels lt ID gt Focus
12. opt xs integer 100 100 gt lt zoom gt lt Momentary gt lt duration gt lt opt xs integer milliseconds gt lt duration gt lt Momentary gt lt PTZData gt 8 13 7 PTZCtrl channels lt ID gt relative PTZCtrl channels lt ID gt relative General Resource v1 0 It is used to move the position which is defined by positionXx Description h i o positionY to the screen center and relative zoom for the device Query positionX positiony relative Zoom Inbound Data PTZData Success Return hik ResponseStaus ResponseStatus Notes Mouse clicking function PTZData XML Block lt PTZData version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt Relative gt lt positionX gt lt opt xs integer gt lt positionX gt lt positionY gt lt opt xs integer gt lt positionY gt lt relativeZoom gt lt opt xs integer 100 100 gt lt relativeZoom gt lt Relative gt lt PTZData gt 8 13 8 PTZCtrl channels lt ID gt absolute PTZCtrl channels lt ID gt absolute General Resource v1 0 It is used to move a particular PTZ channel to a absolute position Description peed i which is defined by Absolute for the device Query elevation azimuth absoluteZoom Inbound Data PTZData 2009 2014 by HIKVISION All rights reserved 106 HIKVISION Success Return hik ResponseStaus ResponseStatus Notes Absolute position function lt
13. ro req xs string gt lt volumeName gt lt volumePath gt lt ro opt xs string gt lt volumePath gt lt volumeDescription gt lt ro opt xs string gt lt volumeDescription gt lt volumeType gt lt ro req xs string VirtualDisk RAIDO RAID1 RAIDO 1 RAID5 etc gt lt volumeType gt lt storageDescription gt lt ro opt xs string DAS DAS USB etc gt lt storageDescription gt lt storageLocation gt lt ro opt xs string HDD Flash SDIO etc gt lt storageLocation gt lt storageType gt lt ro opt xs string internal external gt lt storage Type gt lt Capacity gt lt ro req xs float in MB gt lt capacity gt lt status gt lt ro req xs string HD NORMAL HD_ERROR HD_IDLE gt lt status gt lt StorageVolume gt 8 1 13 3 Storage volumes ID status System Storage volumes ID status Description It is used to get a special storage volume status on a device Query None Inbound Data None Success Return StorageVolumeStatus Notes Query the volume status Currently only the amount of free space is returned Devices may extend the XML to allow for querying additional information Storage VolumeStatus XML Block lt StorageVolumeStatus version 1 0 xmins urn psialliance org gt lt freeSpace gt lt ro req xs float in MB gt lt freeSpace gt lt StorageVolume
14. 0x41 boot 0x42 shutdown 0x43 illegal shut down 0x50 login local 2009 2014 by HIKVISION All rights reserved 27 0x51 0x52 0x53 0x54 0x55 0x56 0x57 0x58 0x59 Ox5a 0x70 0x71 0x72 0x73 0x74 0X79 0x76 0x77 0x78 0x79 0x7a 0x7b Ox7c Ox7d Ox7e HIKVISION logout local config parameter local playback by file name local playback by time local start record local stop record local PTZ control local preview local modify date time local upgrade software local login remote logout remote start record remote stop record remote start transparent channel remote stop transparent channel remote get parameter remote config parameter remote get status remote on guard remote disarm remote reboot remote start voice talk stop voice talk upgrade software remote 0x7f playback by file name remote 0x80 0x81 playback by time remote PTZ control remote The format of start Time and stopTime is YYYY MM DDThh mm ss Devices support up to 2000 log LogList XML Block lt LogList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt Log gt lt opt gt lt id gt lt req xstinteger gt lt id gt lt time gt lt req xs datetime gt lt time gt lt majorlType gt lt req xs string gt lt majorlype gt lt minorlype gt lt req xs string gt lt minorTy
15. Description channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 8 13 17 PTZCtrl channels lt ID gt patrols lt ID gt stop PTZCirl channels lt ID gt patrols lt ID gt stop General Resource v1 0 lt is used to stop running particular patrol route of a particular PTZ Description channel Query None 2009 2014 by HIKVISION All rights reserved 112 HIKVISION Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes It is available to stop the patrol route which is in running state or in pause state 8 13 18 PTZCtri channels lt ID gt patrols lt ID gt pause PTZCirl channels lt ID gt patrols lt ID gt pause General Resource v1 0 e It is used to pause particular patrol route which is in running state of a Description F particular channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Patrolstart is used to restart patrol route It doesn t support dome at this moment 8 13 19 PTZCtrl channels lt ID gt patrols lt ID gt status PTZCirl channels lt ID gt patrols lt ID gt status General Resource v1 0 It is used to get particular patrol route state of a particular PTZ Description channel Query None Inbound Data PTZPatrolStatus Success Return hik ResponseStaus ResponseStatus Notes It doesn t support dome at this moment PTZPatrolStatus XML Block lt PTZPatrol version 1 0
16. Description It is used to add a motion detection region for a video input channel Query None Inbound Data MotionDetectionRegion Success Return hik ResponseStaus ResponseStatus It is used to delete the motion detection regions configuration for a Description i video input channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes All motion detection regions share a sensitivity level It is possible to define mask regions that are subtracted from other regions MotionDetectionRegionList XML Block lt MotionDetectionRegionList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt sensitivityLevel gt lt req gt lt req xs integer 0 5 0 is least sensitive gt lt sensitivityLevel gt lt MotionDetectionRegion gt lt opt gt lt MotionDetectionRegionList gt 2009 2014 by HIKVISION All rights reserved TI HIKVISION 8 10 3 Motion detection region MotionDetection D regions ID General Resource v1 0 It is used to get a particular motion detection region configuration for Description i a video input channel Query None Inbound Data None Success Return MotionDetectionRegion It is used to update a particular motion detection region configuration Description for a video input channel Query None Inbound Data MotionDetectionRegion Success Return hik ResponseStaus ResponseStatus It is used to delet
17. Description It is used to update a particular user configuration for the device Query None Inbound Data User Success Return hik ResponseStaus ResponseStatus DELETE Administrator Description It is used to delete a particular user for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes lt id gt of admin account is 1 admin account must not be deleted lt password gt is a write only field User XML Block lt User version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer 1 16 gt lt id gt lt userName gt lt req xs string gt lt userName gt lt password gt lt wo req xs string gt lt password gt lt priority gt lt opt xs string low middle high gt lt priority gt lt ipAddress gt lt opt xs string gt lt ipAddress gt lt macAddress gt lt opt xs string gt lt macAddress gt lt userLevel gt lt opt xs string Administrator Operator Viewer gt lt userLevel gt lt User gt 8 8 3adminAccess Security adminAccess General Resource v1 0 2009 2014 by HIKVISION All rights reserved 66 HIKVISION Description It is used to get administrative access protocol for the device Query None Inbound Data None Success Return AdminAccessProtocol PUTO Administrator Description It is used to update administrative ac
18. NoiseReduce XML Block 2009 2014 by HIKVISION All rights reserved 146 HIKVISION lt NoiseReduce version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt NoiseReduceLevel gt lt opt xs string low normal high gt lt NoiseReduce gt 8 14 36 Image channels lt ID gt IrcutFilter 1 5 8 old version Image channels lt ID gt IrcutFilter General Resource v1 0 BE It is used to get the IrcutFilter s configuration of a specified image Description channel Query None Inbound Data None Success Return IrcutFilter It is used to configure the IrcutFilter s configuration of a specified Description i image channel Query None Inbound Data IrcutFilter Success Return ResponseStaus ResponseStatus Notes IrcutFilter XML Block lt IrcutFilter version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt IrcutFilterType gt lt opt xs string auto day night gt lt IrcutFilterLevel gt lt opt xs string low normal high gt lt IrcutFilterTime gt lt opt xs integer gt lt IrcutFilter gt 8 15 Record Record Service v1 0 Notes service of Recording 2009 2014 by HIKVISION All rights reserved 147 HIKVISION 8 15 1 Record Schedule Record schedule Description It is used to get recording time range Query None Inbound Data None Suc
19. Query None Inbound Data EventTriggerNotificationList Success Return hik ResponseStaus ResponseStatus POST Operator Description It is used to add a notification method and behavior for an event trigger Query None Inbound Data EventTriggerNotification Success Return hik ResponseStaus ResponseStatus Description It is used to delete the list of notification method and behavior for an event trigger Query None 2009 2014 by HIKVISION All rights reserved 84 HIKVISION Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes This section determines the kinds of notifications that are supported for a particular event trigger and their recurrences and behaviors EventTriggerNotificationList XML Block lt EventTriggerNotificationList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt EventTriggerNotification gt lt opt gt lt EventTriggerNotificationList gt 8 11 4 Trigger notification Event triggers D notifications ID General Resource v1 0 It is used to get a particular notification method and behavior for an Description i event trigger Query None Inbound Data None Success Return EventTriggerNotification PUTO Operator Description It is used to update a particular notification method and behavior for an event trigger Query None Inbound Data EventTriggerNotification Success Return hik ResponseStaus ResponseStatus DELETE Operator Description I
20. RFC2616 Hypertext Transfer Protocol HTTP 1 1 2 W3C XML 1 0 specification 3 W3C Character encodings 4 RFC 2396 Uniform Resource Identifiers URI Generic Syntax and Semantics 5 RFC 2617 HTTP Authentication Basic and Digest Access Authentication 6 International Electrotechnical Commission ISO IEC standard on UPnP device architecture makes networking simple and easy 2008 12 09 Retrieved on 2009 05 07 7 International Organization for Standardization ISO IEC standard on UPnP device architecture makes networking simple and easy 2008 12 10 Retrieved on 2009 05 07 8 UPnP Forum UPnP Specifications Named International Standard for Device Interoperability for IP based Network Devices 2009 02 05 Retrieved on 2009 05 07 2009 2014 by HIKVISION All rights reserved 1 HIKVISION 3 Definitions and abbreviations 3 1 Definitions For the purposes of the present document the following terms and definitions apply Special Resources index indexr description and capabilities resources that are contained in all Services and General Resources and provide a special description for these resources Services a set of resources consisting of relevant General Resources General Resources physical resources that supported by the devices Node Services and General Resources 3 2 Abbreviations For the purposes of the present document the following abbreviations apply FQD
21. Success Return hik ResponseStaus ResponseStatus Notes 8 6 3Send data TwowayAudio sendData General Resource v1 0 Description It is used to send the intercom data Query None Inbound Data TwowayAudio Data Success Return hik ResponseStaus ResponseStatus Notes Example PUT TwowayAudio sendData HTTP 1 1 Content Type audio basic Content Length xxx Wun TwowayAudio Data 8 6 4Receive data TwowayAudio receiveData General Resource v1 0 GET Operator Description It is used to receive the intercom data Query None Inbound Data None Success Return TwowayAudio Data Notes 2009 2014 by HIKVISION All rights reserved 60 HIKVISION Example GET TwowayAudio receiveData HTTP 1 1 HTTP 1 1 200 OK Content Type audio basic Content Length xxx r n TwowayAudio Data 8 7 Serial Serial Service v1 0 Notes Serial port service 8 7 1Ports Serial ports General Resource v1 0 Description It is used to get the list of serial ports supported by the device Query None Inbound Data None Success Return SerialPorList Notes Since serial ports are resources that are defined by the hardware configuration of the device they cannot be created or deleted SerialPortList XML Block lt SerialPortList version 1 0 xmlns http www hikvision com ver10 XMLSchema gt lt SerialPort gt lt opt gt lt SerialPortList gt 8 7 2Port Seria
22. Verison 1 0 videoResolutionWidth gt and Se SE 2010 05 Revision 5 5 lt videoResolutionHeight gt in the Streaming channels ID Redefine the mean of ID in the Verison 1 0 boosts i Revision 5 6 URI Event triggers ID notifications ID it just a 2010 06 sequence number of a trigger or a notification T Add resource Custom HIKCGI Event schedule ID Revision E 7 The lt dynamiclP gt tag is supported in the block XML of 2010 09 Network interfaces ID pppoe Verison 1 0 New resource System Storage is defined 2011 01 2009 2014 by HIKVISION All rights reserved Revision 5 8 HIKVISION New service PTZCtrl is defined New service Image is defined New service Record is defined Service is Custom HIKCGI Event schedule ID is redefined to Event schedule ID Verison 1 0 Revision 5 9 New service Network interfaces D Adapter is defined Service Event notification mailing ID definition is updated to support multi email receivers New service Image channels lt ID gt NosiseReduceExt is defined New service Image channels lt ID gt Scene is defined New service Image channels lt ID gt EPTZ is defined New service Image channels lt ID gt PTZ is defined New service Image channels lt ID gt EIS is defined Service Image channels lt ID gt IrcutFilter has been replaced by Image channels lt ID gt IrcutFilterExt and the IrcutFilterTime can t meet the need of setting
23. WhiteBlance Image channels lt ID gt WhiteBlance General Resource v1 0 Description It is used to get the WhiteBlance value of a specified ilmage channel Query None Inbound Data None Success Return WhiteBlance SAS It is used to configure the WhiteBlance value of a specified ilmage Description channel Query None Inbound Data WhiteBlance Success Return hik ResponseStaus ResponseStatus Notes WhiteBlanceRed and WhiteBlanceBlue s PUT operator is enabled only when WhiteBlanceStyle s value is manual WhiteBlance XML Block lt WhiteBlance version 1 0 xmIins http www hikvision com ver10 XMLSchema gt lt WhiteBlanceStyle gt lt req xs string auto manual indoor outdoor autotrace onece sodiumlight mercurylight daylightLamp auto1 auto2 gt lt WhiteBlanceRed gt lt dep depends on lt WhiteBlanceStyle gt xs integer 0 100 gt lt WhiteBlanceBlue gt lt dep depends on lt WhiteBlanceStyle gt xs integer 0 100 gt lt WhiteBlance gt 8 14 17 Image channels lt ID gt Exposure Image channels lt ID gt Exposure General Resource v1 0 Description It is used to get the exposure mode of a specified image channel Query None Inbound Data None Success Return Exposure e It is used to configure the exposure mode of a specified image Description channel Query None Inbound Data Exposure 2009 2014 by HIKVISION All rights reserved 135 HIK
24. application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt StreamingChannel version 1 0 xmins http www hikvision com ver10 XMLSchema gt 2009 2014 by HIKVISION All rights reserved 72 HIKVISION lt id opt 1 2 gt 1 lt id gt lt channelName min OT max 64 gt Input 1 H 264 lt channelName gt lt enabled opt true gt true lt enabled gt lt Transport gt lt rtspPortNo min 0 max 65535 def 554 gt 554 lt rtspPortNo gt lt maxPacketSize opt 1000 gt 1000 lt maxPacketSize gt lt sourcePortNo min 0 max 65535 def 8200 gt 8200 lt sourcePortNo gt lt ConitrolProtocolList gt lt ConitrolProtocol gt lt streamingTransport opt RTSP gt RTSP lt streamingTransport gt lt ControlProtocol gt lt ControlProtocolList gt lt Unicast gt lt enabled opt true def true gt true lt enabled gt lt Unicast gt lt Multicast gt lt enabled opt true def true gt true lt enabled gt lt destIPAddress min 8 max 16 gt 224 16 74 1 lt destIPAddress gt lt destPortNo min 0 max 65535 def 8600 gt 8600 lt destPortNo gt lt Multicast gt lt Transport gt lt Video gt lt enabled opt true gt true lt enabled gt lt videolnputChannellD opt 1 gt 1 lt videolnputChannellD gt lt videoCodecType opt H 264 MJPEG gt H 264 lt videoCodecType gt lt vi
25. encoding UTF 8 gt lt DeviceStatus version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt DeviceStatus gt For data i e firmware configuration file etc the Content Type may be application octet stream For example HTTP Request Message PUT System configurationData HTTP 1 1 Content Type application octet stream proprietary configuration file data content HTTP Response Message HTTP 1 1 200 OK Content Type application xml charset UTF 8 lt xml version 1 0 encoding UTF 8 gt lt ResponseSiatus version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt ResponseStatus gt 4 5 4Operations Different resources will specify different operation The set device configuration resources use PUT operation If there is an XML block parameter for the request the inbound XML format is defined according to a resource special XML schema Request status will be returned by the XML response information of the device and can be used for indicating the PUT operation status The responded XML format is defined by XML Response Schema please refer to section 4 5 5 for detail description After the device configuration is updated successfully it will return an XML response with status code OK while another status code will be used for indicating unsuccessful operations In either case the device only responses after it is ready to continue n
26. lt ro req xs boolean true gt lt enabled gt lt videolnputChannellD gt lt req xs integer gt lt videolnputChannellD gt lt videoCodecType gt lt ro opt xs string H 264 MJPEG gt lt videoCodecType gt lt videoScanType gt _ lt ro opt xs string progressive gt lt videoScanType gt lt videoResolutionWidth gt lt req xs integer gt lt videoResolutionWidth gt lt videoResolutionHeight gt lt req xs integer gt lt videoResolutionHeight gt lt videoQualityControlType gt lt req xs string CBR VBR gt lt videoQualityControlType gt lt constantBitRate gt lt opt xs integer in kbps gt lt constantBitRate gt lt fixedQuality gt lt opt xs integer percentage 0 100 gt lt fixedQuality gt lt maxFrameRate gt lt req xs integer maximum frame rate x100 gt 2009 2014 by HIKVISION All rights reserved 70 HIKVISION lt maxFrameRate gt lt keyFramelnterval gt lt opt xs integer gt lt keyFramelnterval gt lt BPFramelnterval gt lt opt xs integer gt lt BPFramelnterval gt lt mirrorStatus gt lt opt xs string OFF UpToDown LeftToRight gt lt mirrorStatus gt lt rotationDegree gt lt opt xs integer 0 180 gt lt rotationDegree gt lt snapShotIlmageType gt lt ro opt xs string JPEG gt lt snapShotImageType gt lt
27. lt Schedule gt lt EventTrigger gt lt dep gt lt eventType gt lt req xs string IO VMD gt lt eventType gt lt IrcutFilterAction gt lt req xs string day noh lt IrcutFilterAction gt lt EventTrigger gt lt IrcutFilterExt gt 8 14 14 Image channels lt ID gt NoiseReduceExt Image channels lt ID gt NoiseReduceExt General Resource v1 5 9 It is used to get 3D noise reduce parameters of a specified Image Description channel Query None Inbound Data None Success Return NoiseReduceExt It is used to configure3D noise reduce parameter of a specified Description Image channel Query None Inbound Data NoiseReduceExt Success Return hik ResponseStaus ResponseStatus Notes 3D noise reduce method is related to 2D noise reduce 2D noise reduce method is a noise reduce method that try to reduce the noise in the frame 3D noise reduce method can reduce noise in the frame and the noice between ervery adjacent two frames 3D nosie reduce depend on FrameNoiseReduceLevel and InterFrameNoiseReduceLevel FrameNoiseReduceLevel affects noise reduce in the frame InterFrameNoiseReduceLevel affects noise reduce between frames 2009 2014 by HIKVISION All rights reserved 133 HIKVISION If the GeneralMode was chosen the generalLevel will be used then the FrameNoiseReduceLevel and InterFrameNoiseReduceLevel would be set to the same value as generalLevel NosiseReduceExt XML Block lt
28. 10 HIKVISION HTTP Status REST Meaning GET PUT POST DELETE Codes common reason for this is that the device does not support the requested functionality Header Notes The Reason Phrase sent with the HTTP status header may contain information on the error Body Notes The response may contain more information of the underlying error that occurred in addition to the Reason Phrase Not Found The requested resource does not exist SES Header Notes None y K y K Body Notes None Method Not Allowed The request used an HTTP method that is not supported for the resource because the specification does not allow this method If the device does 405 support the Rider but it is d J J J a valid operation that has been defined in this specification then 403 is returned Header Notes The Allow header lists the supported HTTP methods for this resource Body Notes None Internal Server Error An internal server error has 500 occurred V y V y Header Notes None Body Notes None Service Unavailable The HTTP Server is up but the 503 REST service is not available J J J J Typically this is caused by too many client requests Header Notes The Retry After 2009 2014 by HIKVISION All rights reserved 11 HIKVISION HTTP Status Codes REST Meaning GET PUT POST DELETE header suggests to the client when to try resubmitting the
29. 17 24 45 D9 F4 lt macAddress gt lt channellD gt 1 lt channellD gt lt dateTime gt 2009 11 141T15 27Z lt dateTime gt lt activePostCount gt 1 lt activePostCount gt lt eventType gt VMD lt eventType gt lt eventState gt active lt eventState gt lt eventDescription gt Motion alarm lt eventDescription gt lt DetectionRegionList gt lt DetectionRegionEntry gt lt regionID gt 2 lt region ID gt lt sensitivityLevel gt 4 lt sensitivityLevel gt lt DetectionRegionEntry gt lt DetectionRegionList gt lt EventNotificationAlert gt lt boundary gt 8 11 13 Event Triggering Examples Example Trigger Events on IO Port The command below enables detection for input port 1 When the input signal is detected according to lt inputIOPortID gt two event notification responses are used output port 2 will be triggered for the duration of the input signal detection and an SMTP server will be notified with the E mail Event Notification Alert The behavior of this notification is as follows ASMTP notification is sent at detection time and every some seconds after while 2009 2014 by HIKVISION All rights reserved 94 HIKVISION the signal is present This is denoted by the lt notificationRecurrence gt tags These APIs will have an lt eventState gt of active When the input port 1 signal detection stops one last E mail notification is sent to the server with an lt eventState gt of act
30. AbsoluteHigh gt is high precision positioning which is accurate to a bit after the decimal point _For example elevation 900 2700 is corresponding to vertical 90 0 270 0 degree and azimuth 0 3600 is corresponding to horizontal 0 0 360 0 degree absoluteZoom is corresponding to zoom 0 0 100 0 PTZData XML Block lt PTZData version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt AbsoluteHigh gt lt elevation gt lt opt xs integer 900 2700 gt lt elevation gt lt azimuth gt lt opt xs integer 0 3600 gt lt azimuth gt lt absoluteZoom gt lt opt xs integer 0 1000 gt lt absoluteZoom gt lt AbsoluteHigh gt lt PTZData gt 8 13 9 PTZCtri channels lt ID gt digital PTZCirl channels lt ID gt digital General Resource v1 0 It is used to move the position number which is defined by positionX Description ue ae position to the screen center and digital zoom for the device Query position position digitalZoomLevel Inbound Data PTZData Success Return hik ResponseStaus ResponseStatus Notes Digital zoom function digitalZoomLevel 0 indicates that maintain the original image ratio PTZData XML Block lt PTZData version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt Digital gt lt positionX gt lt opt xs integer gt lt positionX gt lt positionY gt lt opt xs integer gt lt positionY gt lt digitalZoo
31. Applicable SE Description Syntax XML Data Attribute Types The minimum character Examples All except fixed length for a string or the min 0 data types ole minimum numerical value of min 19 a number min 74 numerical only min 1 6 The maximum character Examples All except fixed length for a string or the max 4 data types max maximum numerical value max 37 of a number max 8192 max 14 61 Indicates the possible range Ranges are listed in All numerical of numerical values within numerical order data types the min and max separated by a y attributes of an element character A range has This attribute should only be the form x y where x is used if the possible value the range floor and y is for an XML element does the range ceiling Single not include the entire numbers may also be range numerical range between used min and max attributes Example if an XML element supports values 0 456 1674 to 2009 and 2012 the syntax would be range 0 456 1674 2009 2012 Lists the supported options If all options are CodelD for a CodelD data type supported the syntax is Required for XML elements all Otherwise apt with a CodelD data type supported options ae This attribute should not be used for any other data type listed separated by a character Examples 2009 2014 by HIKVISION All righ
32. Image channels lt ID gt ExpComp General Resource v1 0 It is used to get the value of exposure compensation for a specified Description Image channel Query None Inbound Data None Success Return ExpComp It is used to configure the value of exposure compensation for a Description B specified Image channel Query None 2009 2014 by HIKVISION All rights reserved 144 HIKVISION Inbound Data ExpComp Success Return hik ResponseStaus ResponseStatus Notes ExpComp XML Block lt ExpComp version 1 5 9 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt ExpCompLevel gt lt opt xs integer 0 100 gt lt ExpComp gt 8 14 33 Image channels lt ID gt IrLight Image channels lt ID gt IrLight General Resource v1 0 It is used to get the IR Light configuration for a specified Image Description channel Query None Inbound Data None Success Return IrLight PUTO Operator Description It is used to configure IR Light for a specified Image channel Query None Inbound Data IrLight Success Return hik ResponseStaus ResponseStatus Notes IrLight XML Block lt lrLight version 1 5 9 xmIns http www hikvision com ver10 XMLSchema gt lt mode gt lt req xs string auto manual gt lt mode gt lt brightnessLevel gt lt dep xs integer 0 100 gt lt brightnessLevel gt lt sensitivityLevel gt
33. NoiseReduceExt version 1 5 9 xmIns http www hikvision com ver1 0 XMLSchema gt lt mode gt lt req xs string close general advanced gt lt mode gt lt GeneralMode gt lt dep depends on lt mode gt gt lt generalLevel gt lt req xs integer 0 100 gt lt generalLevel gt lt GeneralMode gt lt AdvancedMode gt lt FrameNoiseReduceLevel gt lt req xs integer 0 100 gt lt FrameNoiseReduceLevel gt lt InterFrameNoiseReduceLevel gt lt req xs integer 0 100 gt lt InterFrameNoiseReduc eLevel gt lt AdvancedMode gt lt NoiseReduceExt gt 8 14 15 Image channels lt ID gt DSS Image channels lt ID gt DSS General Resource v1 0 It is used to get the the configuration of digital slow shutter for a Description a specified Image channel Query None Inbound Data None Success Return DSS It is used to configure the configuration of digital slow shutter for a pegs eee specified Image channel Query None Inbound Data DSS Success Return ResponseStaus ResponseStatus Notes DSSLevel is only enabled when enabled value is true DSS XML Block lt DSS version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt DSSLevel gt lt opt xs string low normal high gt lt DSS gt 2009 2014 by HIKVISION All rights reserved 134 HIKVISION 8 14 16 Image channels lt ID gt
34. Query None Inbound Data None Success Return StreamingChannelList It is used to update the properties of streaming channels for the Description i device Query None Inbound Data StreamingChannelList Success Return hik ResponseStaus ResponseStatus POST Administrator Description It is used to add a streaming channel for the device Query None Inbound Data StreamingChannel Success Return hik ResponseStaus ResponseStatus DELETE Administrator Description It is used to delete the list of streaming channels for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Streaming channels may be hardwired or it may be possible to create multiple streaming channels per input if the device supports it To determine whether it is possible to dynamically create streaming channels check the defined HTTP methods in Streaming channels description StreamingChannelList XML Block lt StreamingChannelList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt StreamingChannel gt _ lt opt gt lt StreamingChannelList gt 2009 2014 by HIKVISION All rights reserved 68 HIKVISION 8 9 3Channel Streaming channels ID General Resource v1 0 It is used to get the properties of a particular streaming channel for Description the device Query None Inbound Data None Success Return StreamingChannel It is used to update the properties of a
35. Success Return PTZPresetList S It is used to update preset configuration information of a particular Description i PTZ channel for the device Query None Inbound Data _PTZPresetList Success Return hik ResponseStaus ResponseStatus 2009 2014 by HIKVISION All rights reserved 108 Description Query Inbound Data Success Return HIKVISION It is used to add a preset configuration information of a particular PTZ channel for the device None PTZPreset hik ResponseStaus ResponseStatus Description Query Inbound Data Success Return Notes It is used to delete a preset configuration information of a particular PTZ channel for the device None None hik ResponseStaus ResponseStatus PTZPresetList XML Block lt PTZPresetList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt PTZPreset gt lt opt gt lt PTZPresetList gt 8 13 12 PTZCitrl channels lt ID gt presets lt ID gt PTZCirl channels lt ID gt presets lt ID gt General Resource v1 0 Description Query Inbound Data Success Return lt is used to get particular_preset configuration information of a particular PTZ channel for the device None None PTZPreset Description Query Inbound Data Success Return lt is used to update particular_preset configuration information of a particular PTZ channel for the device None PTZPreset hik ResponseStaus ResponseSta
36. Video gt lt Audio gt lt enabled gt lt ro req xs boolean true false gt lt enabled gt lt audiolnputChannellD gt lt ro req xs integer gt lt audiolnputChannellD gt lt audioCompressionType gt lt ro opt xs string G 711ulaw gt lt audioCompressionType gt lt Audio gt lt StreamingChannel gt Example Getting Streaming Channel Properties The following is an example of a GET on the streaming parameters of a particular channel that has been preconfigured by the IP media device Depending on the device some streaming channels may be already preconfigured or the device while other may require that channels be manually configured before use GET Streaming channels 1 HTTP 1 1 HTTP 1 1 200 OK Content Type application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt StreamingChannel version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt id gt 1 lt id gt lt channelName gt lInput 1 H 264 lt channelName gt lt enabled gt true lt enabled gt lt Transport gt lt rtspPortNo gt 554 lt rtspPortNo gt lt maxPacketSize gt 1000 lt maxPacketSize gt lt sourcePortNo gt 8200 lt sourcePortNo gt lt ControlProtocolList gt lt ConitrolProtocol gt lt streamingTransport gt RTSP lt streamingTransport gt lt ControlProtocol gt lt ControlProtocolList gt lt Unicast gt 2009 2014 by HI
37. a particular PTZ channel Query None Inbound Data None Success Return PTZOSDDisplay lt is used to update OSD display information of a particular PTZ Description channel Query None Inbound Data PTZOSDDisplay Success Return hik ResponseStaus ResponseStatus Notes lt zoomlable gt indicates the zoom progress bar display lt azimuth gt _indicates the azimuth display lt presetlable gt indicates the preset title display PTZOSDDisplay XML Block lt PTZOSDDisplay version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt zoomlable gt lt req xs strings 2sec 5sec 10sec alwaysclose alwaysopen gt lt zoomlable gt lt azimuth gt lt req xs strings 2sec 5sec 10sec alwaysclose alwaysopen gt lt azimuth gt lt presetlable gt lt req xs strings 2sec 5sec 10sec alwaysclose alwaysopen gt lt presetlable gt lt PTZOSDDisplay gt 8 13 28 PTZCtrl channels lt ID gt parkaction PTZCirl channels lt ID gt parkaction General Resource v1 0 Description It is used to get park action information of a PTZ channel Query None Inbound Data None Success Return ParkAction 2009 2014 by HIKVISION All rights reserved 117 HIKVISION Description It is used to update park action information of a PTZ channel Query None Inbound Data ParkAction Success Return hik ResponseStaus ResponseStatus Notes lt Parktime gt Time span that wi
38. data returned from the device This is used for uploading passwords A type defined in XML Schema Part 2 Datatypes Second Edition see http www w3 org TR xmlschema 2 xs lt type gt Remark optional XML structures may contain required fields for the operation which mean that even if the entire XML block is optional some of its contained fields may still be necessary if required 7 Special Resources 7 1 index index Special Resource v1 0 Description Enumerate child resources of a resource Query None Inbound Data None Success Return hik ResourceList ResourceList Notes Returns a non recursive resource listing of all child resources 7 2 indexr indexr Special Resource v1 0 Description Enumerate child resources of a resource Query None Inbound Data None 2009 2014 by HIKVISION All rights reserved 16 HIKVISION Success Return hik ResourceList ResourceList Notes Returns a recursive resource listing of all child resources 7 3 description description Special Resource v1 0 Description Describe the corresponding resource Query None Inbound Data None Success Return hik ResourceDescription ResourceDescription Notes lt version gt set the version of resource In this specification its value is 1 0 A version attribute is included in the description This means resources with different versions may exist within the same Services In that case the version of Services is the ver
39. delete a particular patrol route configuration of a particular PTZ channel None None hik ResponseStaus ResponseStatus 2009 2014 by HIKVISION All rights reserved 111 HIKVISION Notes lt PatrolSequence gt indicates the patrol point lt presetID gt indicates the preset number lt seqSpeed gt indicates the patrol speed lt delay gt _indicates the dwell time in seconds PTZPatrol XML Block lt PTZPatrol version 1 0 xmIins http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt id gt lt req xs string id gt lt id gt lt patrolName gt lt req xs string gt lt patrolName gt lt resumelType gt lt opt xs string relative absolute gt lt resumeType gt lt PatrolSequenceList gt lt req at least one entry gt lt PatrolSequence gt lt req gt lt id gt lt req xs string id gt lt id gt lt presetID gt lt req xs string id gt lt presetID gt lt seqSpeed gt lt req xs string id gt lt seqSpeed gt lt delay gt lt req xs integer milliseconds gt lt delay gt lt PatrolSequence gt lt PatrolSequenceList gt lt PTZPatrol gt 8 13 16 PTZCtrl channels lt ID gt patrols lt ID gt start PTZCirl channels lt ID gt patrols lt ID gt start General Resource v1 0 lt is used to start running particular patrol route of a particular PTZ
40. device proceeds to reboot 8 1 6Status System status General Resource v1 0 Description It is used to get the status information of the device 2009 2014 by HIKVISION All rights reserved 22 HIKVISION Query None Inbound Data None Success Return DeviceStatus Notes DeviceStatus XML Block lt DeviceStatus version 1 0 xmIns http www hikvision com ver1 0 XMLSchema gt lt currentDeviceTime gt lt req xs datetime gt lt currentDevice Time gt lt deviceUpTime gt lt req xs integer seconds gt lt deviceUpTime gt lt CPUList gt lt req gt lt CPU gt lt cpuDescription gt lt req xs string gt lt cpuDescription gt lt cpuUtilization gt lt req xs integer percentage 0 100 gt lt cpuUtilization gt lt CPU gt lt CPUList gt lt MemoryList gt lt req gt lt Memory gt lt memoryDescription gt lt req xs string gt lt memoryDescription gt lt memoryUsage gt lt req xs float in MB gt lt memoryUsage gt lt memoryAvailable gt lt req xs float in MB gt lt memoryAvailable gt lt Memory gt lt MemoryList gt lt DeviceStatus gt 8 1 7Time System time General Resource v1 0 GET Wiewer Description It is used to get the device time information Query None Inbound Data None Success Return Time PUTO Administrator Description It is used to udpate the device time information Query None Inboun
41. dynamic range for a specified Description Image channel Query None Inbound Data WDRExt Success Return hik ResponseStaus ResponseStatus Notes lt WDRLevelExt gt is optional Some camera may use more than one level to control WDR working lt mode gt value can be open close or auto some camera may not surpport the auto mode If camera worked in auto mode WDR would automatically open or close according to scene WDRExt XML Block lt WDRExt version 1 5 9 xmIns http www hikvision com ver1 0 XMLSchema gt lt mode gt lt req xs string open close auto gt lt mode gt lt WDR_Level gt lt opt xs integer 0 100 gt lt WDRLevel gt lt WDRContrastLevel gt lt opt xs integer 0 100 gt lt WDRContrastLevel gt 2009 2014 by HIKVISION All rights reserved 130 HIKVISION lt WDRLevelExt gt lt opt gt lt Level2 gt lt opt xs integer 0 100 gt lt Level2 gt lt WDRLevelExt gt lt WDRExt gt 8 14 11 Image channels lt ID gt BLC Image channels lt ID gt BLC General Resource v1 0 It is used to get the configuration of backlight compensation for a Description SE specified image channel Query None Inbound Data None Success Return BLC It is used to configure the configuration of backlight compensation for Description ee a specified image channel Query None Inbound Data BLC Success Return Respons
42. ee eier ees eee 98 8 124 dE 98 I 8 13 8 12 5 8 12 6 8 12 7 PTZCtrl 8 13 1 8 13 2 8 13 3 8 13 4 8 13 5 8 13 6 8 13 7 8 13 8 8 13 9 8 13 10 8 13 11 8 13 12 8 13 13 8 13 14 8 13 15 8 13 16 8 13 17 8 13 18 8 13 19 8 13 20 8 13 21 8 13 22 8 13 23 8 13 24 8 13 25 8 13 26 8 13 27 8 13 28 8 13 29 8 13 30 8 13 31 8 13 32 8 13 33 8 13 34 8 13 35 8 13 36 8 13 37 HIKVISION Patrol key PONtS Neiegkeete endisi eg eene e 99 Patrol Key SE 100 PTZ COMMU as scescidurstiovaisnstianwssnaienieducalsoeniivesliowilnastavatncassalunceaelsstayalacieutearaieits 101 a chadatecayblausdibeleveasundaueabeleveciandaiel disladuaibeiaietateds EE eege CERS 102 e Eegen 102 PTZCtrl channels lt lD gt E 103 PTZCtrl channels lt ID gt NOMEPOSITION EEN 104 DT ZCirlichannels JD Abomeposittorndgoto 105 P EZ irl channels lt IDs Contin WOU ccsicvscescassusecavinndessmiasan aaanetinmnanberamatss 105 PTZCtrl channels lt lD gt momentary scisvssisscessuensnensstintavstarotarsutvanessuninnnness 105 PTZCtrl channels lt ID gt relative EEN 106 PTZCtrl channels lt lD gt absolute s icsavavusassiansnenevensananeasseasneanssanevenisiavestoens 106 RS L tzebuger EIER cc avssevesspoveresnunnadianhvsnuonansedianasivsinensenvonsonen 107 PT Eet ETC 108 PTZCtrl channels lt ID gt preSet csecsscssecesececseeseseseceesaceeceeeeeaseeeees 108 PTZCtrl channels lt ID gt presets lt ID gt eneen 109 PTZCtrl channels lt ID gt presets lt I
43. gt lt NetworkInterfaceList gt 8 2 2Interface Network interfaces D General Resource v1 0 Description It is used to get a particular network interface Query None Inbound Data None Success Return Networkinterface Description It is used to update a particular network interface Query None Inbound Data Networkinterface Success Return hik ResponseStaus ResponseStatus Notes Networkinterface XML Block lt NetworkInterface version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer 1 gt lt id gt lt IPAddress gt lt req gt lt Discovery gt lt opt gt lt PPPOE gt lt opt gt lt DDNS gt lt opt gt lt NetworkInterface gt 2009 2014 by HIKVISION All rights reserved 32 HIKVISION 8 2 3IPAddress Network interfaces D ipAddress General Resource v1 0 Description It is used to get the ip address of a particular network interface Query None Inbound Data None Success Return IPAddress Description It is used to update the ip address of a particular network interface Query None Inbound Data IPAddress Success Return hik ResponseStaus ResponseStatus Notes If lt addressingType gt is dynamic fields below it need not be provided If lt addressingType gt is dynamic a DHCP client is used for the device If lt addressingType gt is static the device IP address is configured manually an
44. gt lt opt gt 2009 2014 by HIKVISION All rights reserved 36 HIKVISION lt enabled gt lt req xs boolean gt lt enabled gt lt Zeroconf gt lt Discovery gt 8 2 8PPPoE Network interfaces ID pppoe General Resource v1 0 It is used to get the PPPoE configuration of a particular network Description i interface Query None Inbound Data None Success Return PPPoE e It is used to update the PPPoE configuration of a particular network Description interface Query None Inbound Data PPPoE Success Return hik ResponseStaus ResponseStatus Notes lt password gt is a write only field PPPoE XML Block lt PPPoE version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt userName gt lt req xs string gt lt userName gt lt password gt lt wo req xs string gt lt password gt lt dynamiclP gt lt opt xs string gt lt dynamiclP gt lt PPPoE gt 8 2 9DDNS Network interfaces D ddns General Resource v1 0 Description It is used to get DDNS configuration of a particular network interface Query None Inbound Data None Success Return DDNS Description It is used to update DDNS configuration of a particular network 2009 2014 by HIKVISION All rights reserved 37 HIKVISION interface Query None Inbound Data DDNS Success Return hik Resp
45. lt tilMaxSpeed gt lt presetSpeed gt lt opt xs integer1 8 gt lt presetSpeed gt lt autoPatrolSpeed gt lt opt xs integer 0 100 gt lt autoPatrolSpeed gt lt keyBoardControlSpeed gt lt opt xs string low normal high gt lt keyBoardControlSpeed gt lt controlProtocol gt lt opt xs string pelco d gt lt controlProtocol gt lt controlAddress gt lt opt gt lt enabled gt lt req xs boolean gt lt enabled gt lt Address gt lt opt xs string 1 255 gt lt Address gt lt controlAddress gt lt defaultPresetID gt lt opt xs string id gt lt defaultPresetID gt lt PTZChannel gt 8 13 3 PTZCtrl channels lt ID gt homeposition PTZCirl channels lt ID gt homeposition General Resource v1 0 It is used to set the current horizontal position as horizontal SE coordinate zero point for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus It is used to delete system horizontal coordinate zero point and Description restore default zero point for the device The photoelectric detection location Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 2009 2014 by HIKVISION All rights reserved 104 HIKVISION 8 13 4 PTZCtrl channels lt ID gt homeposition goto PTZCirl channels lt ID gt homeposition goto General Resource v1 0 It is used t
46. lt ID gt gamaCorrection General Resource v1 0 Description It is used to get the gama correction of a specified Image channel 2009 2014 by HIKVISION All rights reserved 138 HIKVISION Query None Inbound Data None Success Return gammaCorrection Be It is used to configure the gama correction of a specified Image Description channel Query None Inbound Data gammaCorrection Success Return hik ResponseStaus ResponseStatus Notes hik gammaCorrection XML Block lt gammaCorrection version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt gammaCorrectionEnabled gt lt opt xs boolean gt lt gammaCorrectionEnabled gt lt gammaCorrectionLevel gt lt opt xs integer 0 100 gt lt gammaCorrectionLevel gt lt gammaCorrection gt 8 14 23 Image channels lt ID gt powerLineFrequency Image channels lt ID gt powerLineFrequency General Resource v1 0 It is used to get the powerLineFrequency value of a specified Image Description GR g H y R g channel Query None Inbound Data None Success Return powerLineFrequency It is used to configure the powerLineFrequency value of a specified Description Image channel Query None Inbound Data powerLineFrequency Success Return hik ResponseStaus ResponseStatus Notes Configure the powerlineFrequency requires to reboot the camera hik powerlineFrequency XML Block lt powerLineFrequency version 1 0 mins http
47. particular streaming channel RER for the device Query None Inbound Data StreamingChannel Success Return hik ResponseStaus ResponseStatus DELETE Administrator Description It is used to delete a particular streaming channel for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes To support multi video input devices the streaming ID in URL should be indicate video input channel number so it is defined as straming Id video input ld 100 for example Streaming channels 101 indicates the first streaming from the first video input Streaming channels 202 indicates the second streaming from the second video input For IPC becourse of only one video input case is simeple it can accecpt 1 as the main stream id 2 as the sub stream lt ControlProtocolList gt identifies the control protocols that are valid for this type of streaming lt Unicast gt is for direct unicast streaming lt Multicast gt is for direct multicast streaming lt sourcePortNo gt is the unicast source port parameter for the outbound video and audio streams and the specific port number is device dependant lt destPortNo gt is the multicast destination port parameter for the outbound video and audio streams and the specific port number is device dependant lt videolnputChannellD gt refers to Video inputs channels D lt audiolnoutChannellD gt refers to Audio channels D It must be configured as an input
48. request Body Notes None Responses to many resources calls contain data in XML format XML Response Schema is defined in Annex XML Response Schema consists of the following sections requestURI the URI of the corresponding HTTP request message statusCode indicating the status of the REST operations Table 4 statusCode Description OK indicate a successful operation is done remark if the request contains some parameters that are not supported the device will ignore those parameters and return OK as statusCode Device Busy for a command which cannot be processed at that time i e if the device receives a reboot command during upgrading process Device Error if the device can not perform the request for a hardware error An error message in statusString format to indicate operation failure Invalid Operation either if the operation is not supported by the device or if the user has not passed the authentication or if the user does not have enough privilege for this operation Invalid XML Format if the XML format is not recognized by the system There will be statusString returned to represent different errors Invalid XML Content an incomplete message or a message containing an out of range parameter Relative statusString will be return Reboot Required If a reboot is required before the operation taking effect s
49. rights reserved 35 HIKVISION detectedWirelessList XML Block lt DetectedWireless version 1 0 xmlIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt wirelessNetworkMode gt lt opt xs string infrastructure adhoc gt lt wirelessNetworkMode gt lt channel gt lt opt xs string 1 14 auto gt lt channel gt lt ssid gt lt req xs string gt lt ssid gt lt speed gt lt opt xs lnteger in Mbps gt lt speed gt lt signalStrength gt lt opt xs lnteger 0 100 gt lt signalStrength gt lt securityMode gt lt req xs string disable VEP WPA personal WPA2 personal WPA RADIUS WPA enterprise WPA2 enterprise gt lt securityMode gt lt DetectedWireless gt 8 2 7Discovery Network interfaces D discovery General Resource v1 0 It is used to get the discovery settings of a particular network Description j interface Query None Inbound Data None Success Return Discovery It is used to update the discovery settings of a particular network Description interface Query None Inbound Data Discovery Success Return hik ResponseStaus ResponseStatus Notes Discovery XML Block lt Discovery version 1 0 xmlns http www hikvision com ver10 XMLSchema gt lt UPnP gt lt req gt lt enabled gt lt req xs boolean gt lt enabled gt lt UPnP gt lt Zeroconf
50. to acceptance of the HIKVISION agreement required to use this product HIKVISION reserves the right to make changes to its products as circumstances may warrant without notice This documentation is provided as is without warranty of any kind Please send any comments regarding the documentation to overseabusiness hikvision com Find out more about HIKVISION at www hikvision com 2009 2014 by HIKVISION All rights reserved HIKVISION Contents GOLGI einiino aea a aaa araa araa N sates ates eaves invests ibncavissea a vibiesns I 1 SCOPE EE E A E E E E E eet 1 2 EEEE EEE A Ee 1 3 Definitions and abbreviations 20 eee ececeseeseeceeeeeeseesecesecseeseeeesecsecseeseeeeessecaeeneeeees 2 3 1 Definition Sern ee 2 3 2 Apbreviat ONS cid istecidedstecidvaticesanctswesdeat E N REA 2 4 Architecture and Transmission Mechanisme 2 4 1 REST and HITP Methods isis cscsaisccssessiesesiesdercescsses oth E a cea ed 3 4 2 DM E E E A E A A A E E AE E A E E 3 4 3 Resources OVERVIEW irsnonernernn anaa a a E A N A NaN 4 4 4 Protocol E E 3 Gs STEE 5 4 5 1 Connection Header Feld 6 4 5 2 Authorization and WWW Authenticate Header Fields cece 6 4 5 3 Entity le VE 6 45 4 ele TE 7 45 5 Error Handling EE 8 Apr Namespaces csicsseissesensdciecessasionetescavieiaciaesess deddedoaapnesi sd Eege EER deed dE 12 Ae SOCUIILY E 13 5 Device EE 13 6 Resource DeSCription iscissi nensis e E E iene 14 6 1 Resource Description Outline seis vwstdscsavesSedev
51. to this specification the IP devices will use appropriate HTTP protocol defined status codes for error reporting and when received handle accordingly 2009 2014 by HIKVISION All rights reserved 8 HIKVISION Application Errors which are generated as a result of REST operations errors All such application errors must be reported and handled through HTTP messages The following table indicates the mapping relationship between HTTP status codes and REST operations and also the information contained in response header and bodies Table 3 HTTP Status Codes REST Meaning GET PUT POST DELETE 200 OR The request has succeeded Header Notes None d y Body Notes The requested resource will be returned in the body 201 Created The request has created a new resource Header Notes The Location header contains the URI of the y y newly created resource Body Notes The response returns an entity describing the newly created resource 204 No Content The request succeeded but there is no data to return V y Header Notes None Body Notes No body is allowed 301 Moved Permanently The requested resource has moved permanently Header Notes The Location Header contains the URI of the V new location Body Notes The body may contain the new resource location 302 Found he requested resource should be accessed through this location but the resou
52. transparent channel so D value in the Resource_URI can only be 1 8 7 5 Transparent channel close Serial ports D transChanClose General Resource v1 0 Description It is used to close the transparent channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Only support RS485 transparent channel so D value in the Resource_URI can only be 1 2009 2014 by HIKVISION All rights reserved 63 HIKVISION 8 7 6 Transparent channel send data Serial ports D transChanSendData General Resource v1 0 Description It is used to send data on the transparent channel Query None Inbound Data Raw Data Success Return hik ResponseStaus ResponseStatus Notes Only support RS485 transparent channel so D value in the Resource_URI can only be 1 Example PUT Serial ports 1 transChanSendData HTTP 1 1 Content Type application binary charset UTF 8 Content Length xxx r n Raw Data 8 7 7Transparent channel receive data Serial ports D transChanRecvData General Resource v1 0 GET Operator Description It is used to receive data on the transparent channel Query None Inbound Data None Success Return Raw Data Notes Only support RS485 transparent channel so D value in the Resource_URI can only be 1 Example GET Serial ports 1 transChanRecvData HTTP 1 1 HTTP 1 1 200 OK Content Type application binary charset UTF 8 Content Length xxx r n
53. type xs string minOccurs 0 maxOccurs 1 gt 2009 2014 by HIKVISION All rights reserved 150 HIKVISION Notes 2009 2014 by HIKVISION All rights reserved 151 HIKVISION For IP Camera now only support one input channel lt id gt associated with the input channel can only be 1 2009 2014 by HIKVISION All rights reserved 152
54. www hikvision com ver10 XMLSchema gt lt powerLineFrequencyMode gt _ lt opt xs string 50hz 60hz gt lt powerLineFrequencyMode gt lt powerLineFrequency gt 2009 2014 by HIKVISION All rights reserved 139 HIKVISION 8 14 24 Image channels lt ID gt Color Image channels lt ID gt Color General Resource v1 0 Description It is used to get the color s value of a specified Image channel Query None Inbound Data None Success Return Color Description It is used to configure the color s value of a specified Image channel Query None Inbound Data Color Success Return hik ResponseStaus ResponseStatus Notes color XML Block lt Color version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt brightnessLevel gt lt opt xs integer 0 100 gt lt brightnessLevel gt lt contrastLevel gt lt opt xs integer 0 100 gt lt contrastLevel gt lt saturationLevel gt lt opt xs integer 0 100 gt lt saturationLevel gt lt hueLevel gt lt opt xs integer 0 100 gt lt hueLevel gt lt grayScale gt lt grayScaleMode gt lt opt xs string indoor outdoor gt lt grayScaleMode gt lt grayScale gt lt Color gt 8 14 25 Image channels lt ID gt Scene Image channels lt ID gt Scene General Resource v1 0 Description It is used to get sene mode of a camera Query None Inbound Data None Success Return
55. xmIins http www hikvision com ver10 XMLSchema gt lt PTZPatrolStatus gt lt opt gt lt patrollD gt lt req xs string id gt lt patrolID gt lt patrolStatus gt lt req xs string running stopped paused gt lt patrolStatus gt lt PTZPatrolStatus gt lt PTZPatrol gt 2009 2014 by HIKVISION All rights reserved 113 HIKVISION 8 13 20 PTZCtrl channels lt ID gt patrols lt ID gt schedule PTZCirl channels lt ID gt patrols lt ID gt schedule General Resource v1 0 Description It is used to get patrol schedule of a particular PTZ channel Query None Inbound Data None Success Return TimeBlockList Description It is used to update patrol schedule of a particular PTZ channel Query None Inbound Data TimeBlockList Success Return hik ResponseStaus ResponseStatus Notes 8 13 21 PTZCtrl channels lt ID gt patterns PTZCirl channels lt ID gt patterns General Resource v1 0 GET Viewer Description It is used to get pattern configuration of a particular PTZ channel Query None Inbound Data None Success Return PTZPatternList Notes It is similar to presets Ee It is used to delete all patterns configuration of a particular PTZ Description channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus PTZPatternList XML Block lt PTZPatternList version 1 0 xmlIns http www hikvision com ver10 XMLSchema gt lt PT
56. xs integer gt lt actionNum gt lt ptzAction gt lt EventTriggerNotification gt 8 11 5 Schedule Event schedule General Resource v1 0 Description It is used to get event schedules Query None Inbound Data None Success Return EventSchedule Description It is used to update event schedules Query None Inbound Data EventSchedule Success Return hik ResponseStaus ResponseStatus Notes Defines the schedule The schedule is defined as a set of time blocks that define when the events are active The schedule is always valid It only supports one TimeBlock every day now EventSchedule XML Block lt EventSchedule version 1 0 xmIns http www hikvision com ver1 0 XMLSchema gt lt TimeBlockList gt lt req gt lt TimeBlock gt lt dayOfWeek gt 2009 2014 by HIKVISION All rights reserved 86 HIKVISION lt opt xs integer SO8601 weekday number 1 Monday gt lt dayOfWeek gt lt TimeRange gt lt req gt lt beginTime gt lt req xs time ISO8601 time gt lt beginTime gt lt endTime gt lt req xs time ISO8601 time gt lt endTime gt lt TimeRange gt lt TimeBlock gt lt TimeBlockList gt lt EventSchedule gt 8 11 6 Schedule ID Event Schedule ID General Resource v1 0 Description It is used to get event schedules Query None Inbound Data None Success Return EventSchedule Description It is used to upd
57. 10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt posX gt lt req xs integer coordinate gt lt posX gt 2009 2014 by HIKVISION All rights reserved ST HIKVISION lt posY gt lt req xs integer coordinate gt lt posY gt lt type gt lt req xs integer gt lt type gt lt displayWeek gt lt req xs boolean gt lt displayWeek gt lt attribute gt lt req xs integer gt lt attribute gt lt OsdDatetime gt 8 5 Audio Audio Service v1 0 Notes 8 5 1Channels Audio channels General Resource v1 0 It is used to get the audio channels configuration on an IP media Description i device Query None Inbound Data None Success Return AudioChannelList Notes Since inputs are resources that are defined by the hardware configuration of the device audio channels cannot be created or deleted AudioChannelList XML Block lt AudioChannelList version 1 0 xmins http www hikvision com ver1 0 XMLSchema gt lt AudioChannel gt lt opt gt lt AudioChannelList gt 8 5 2Channel Audio channels D General Resource v1 0 It is used to get a particular audio channel configuration on an IP Description media device Query None 2009 2014 by HIKVISION All rights reserved 58 HIKVISION Inbound Data None Success Return AudioChannel Notes lt audioMode gt is the d
58. 14 by HIKVISION All rights reserved 115 HIKVISION Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Remaining space information will be uploaded in real time during the recording process 8 13 24 PTZCitrl channels lt ID gt patterns lt ID gt recordst op PTZCirl channels lt ID gt patterns lt ID gt recordstop General Resource v1 0 lt is used to stop a particular pattern information recording of a SE particular PTZ channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 8 13 25 PTZCtrl channels lt ID gt patterns lt ID gt run PTZCirl channels lt ID gt patterns lt ID gt run General Resource v1 0 Description It is used to start a particular pattern of a particular PTZ channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 8 13 26 PTZCtrl channels lt ID gt patterns lt ID gt stop PTZCirl channels lt ID gt patterns lt ID gt stop General Resource v1 0 It is used to stop a particular pattern which is in running status of a Description particular PTZ channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 2009 2014 by HIKVISION All rights reserved 116 HIKVISION 8 13 27 PTZCtri channels lt ID gt PTZOSDDisplay PTZCtrl channels lt ID gt PTZOSDDisplay General Resource v1 0 Description It is used to get OSD display information of
59. 52 gt lt wepKeyLength gt lt wepKeyType gt lt opt xs string HEX ASICII gt lt wepKeyType gt lt EncryptionKeyList gt 2009 2014 by HIKVISION All rights reserved 34 HIKVISION lt encryptionKey gt lt req xs HexBinary string or ASICII string gt lt encryptionKey gt lt EncryptionKeyList gt lt WEP gt lt WPA gt lt dep depends on lt securityMode gt gt lt algorithmType gt lt req xs string TKIP AES TKIP AES gt lt algorithmType gt lt sharedKey gt lt req xs string pre shared key used in WPA gt lt sharedKey gt lt wpakeyLength gt lt req xs integer 8 63 gt lt wpaKeyLength gt lt WPA gt lt WirelessSecurity gt lt Wireless gt 8 2 5 Detected WirelessList Network interfaces D detectedWirelessList General Resource v1 0 Description It is used to get all detected wireless networks Query None Inbound Data None Success Return detectedWirelessList detectedWireless XML Block lt DetectedWirelessList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt DetectedWireless gt lt DetectedWirelessList gt 8 2 6 Detected Wireless Network interfaces D detectedWirelessList ID General Resource v1 0 Description It is used to get a special detected wireless network Query None Inbound Data None Success Return detectedWireless 2009 2014 by HIKVISION All
60. CESS erionenn tise aE E E E Ea a 66 Streami NE sScibwcetsdoacesdecabedtane usesansuveliacasatesseabbaseeoarasessucseedeeeatets sansovvas E EE EE 67 8 9 1 e 67 8 9 27 Eet 68 893 Channelin E RT E ET AE 69 8 9 4 Channel StatUS eege eebe 74 89 5 PICUUIC eserin en aaeeea eeo a e EEU T EEE EE TES AAEE TE 74 8 9 6 Request keyframe 0 cc csccssscsssecsssecceeecscesseecsceseacsseesseeesseeeeaceceessseasseees 75 Motion Detection sissioni i EE O R 75 8 10 1 One channel motion deiechon EEN 76 8 10 2 Motion detection regions e neseesesesesessesesesesseseseseseosesenesrosesesesesceseseses 77 8 10 3 Motion detection region ssssesesesssseseseseesesesessesesesesessenenesessesesesesesseseses 78 8 10 4 Motion Detection Exvample 79 VOI cosas sctiscseanccavisiaccsuisieestaaneteanaaieisayaiacvstaaauaccaeaenensaesteousienes A 81 GE WR Ne Le TC 82 SA2 MOJE eaa eer tc rer prey peoer rere ory oer etre ory eter eer ere er erat ererer perry 83 8 11 3 Trigger notifications oo eeesessteeeeeeesecesseecseceaeseeessccsseeeeaceceaeseeesseees 84 8 11 4 Trigger notification seeeseeeeeeeeeeeseseeeesesesrsrereseststsresssrsrteresrsrsresesesrsrereseses 85 CN NEW 86 8 11 6 SATAN EE EE 87 811 7 e re le EE 88 8 11 8 Mails Notification iiinis 89 GRO We re te ET 90 8 11 10 Notification alertStream tritt Egeter ee Eege 92 8 11 11 Event Triggering Examples A 94 KEE 96 e2 mea en El 96 812 2 Channel ege tard dee ege eieiei AEN 97 te PANOS eege
61. D gt QOto eceseeceseseseseteteeeeeeseneeeeees 110 PTZCtrl channels lt lD gt patrols 4 sccsasvcsavaways cavnulishsvnntueiannudeplavnntvaccusaiuctauseds 110 PT ZCtrl channels lt ID gt patrols lt IDS csssscsnavasseassradenseesedsnseanatansensntenvovonss 111 PTZCtrl channels lt ID gt patrols lt ID gt Start eccesseseeeeseeteeeeeeeeseeeeeeees 112 PTZCtrl channels lt ID gt patrols lt ID gt StOp ecsseseeseseseseeteeeeeeeeseseneeees 112 PTZCtrl channels lt ID gt patrols lt ID gt PAUSE ceseeseeeseseeteeeeeeeeseseeeeees 113 PTZCtrl channels lt ID gt patrols lt ID gt Status cseeseeseteteeeeeeeeseseneeees 113 PTZCtrl channels lt ID gt patrols lt ID gt SCNECUIE eeseseteeeeeeeeseseeeeees 114 PE ZC irl chaniels lt I Sate nS isis ocssasnsan sasindecavennceyumsastpbananercantiacesamanss 114 PTZCtrl channels lt ID gt patterns lt ID gt ceeeseseeseseeeceeseceeeeeeeeeeeeeeees 115 PTZCtrl channels lt ID gt patterns lt ID gt recordstart sseececeeeteeees 115 PTZCtrl channels lt ID gt patterns lt ID gt reCordstOp eseeeeeeeeeeeseeeees 116 PTZCtrl channels lt ID gt patterns lt ID gt rUN eeceseseeseseseseseeeeeeeeeseneneeees 116 PTZCtrl channels lt ID gt patterns lt ID gt StOp eceseeseeeseseeteeeeeeeeseseneeees 116 PTZCtrl channels lt ID gt PTZOSDDisplay cecseeseseseteteeeeeeeeseseneeees 117 PT ZCirlichannels JD Aperkachon ENE
62. E 117 PTZCtrl channels lt ID gt ptzZlimited een 118 PTZCtrl channels lt ID gt ptzlimiteds lt ID gt cecesesesseseseseseceeeeeeeseeeneeees 119 DT ZCirlichanneleiJD dptslimttede JD ieeteiart 120 PTZCtrl channels lt ID gt ptzlimiteds lt ID gt Set eeeeeseeeeteeeeeeseseseeeeees 120 PTZCtrl channels lt ID gt SaveptZPOWELOff ee eeseseeeeseseseseseeeeeeeeseseneeees 120 PTZCtrl channels lt ID gt timetaskS EEN 121 PTZCtrl channels lt ID gt timetaskS lt ID gt cececeseseeseseseseseseeeeeeeeseseneeees 122 PTZCtrl channels lt ID gt timetasks 1D Acopwtaek 123 PE ZCirl channels lt IDs auxCa nial jis isiniaceceeswueesunnsdesnasannannetnmannpananss 124 eege Ee eege Eege eege ege eege ge 124 uf Le ele sessesseciacscevescatssaseecasheteassstavaants eveassgrteeaderasvaaneaaetanaeeseanveeads 124 Image channels lt ID gt snaa a aiaia 125 TV HIKVISION 8 14 3 Image channels lt lD gt resetlmage s sesssesesesesereeesrsseserrsrsreresesesrsseseses 126 8 14 4 Image channels lt lD gt restorelmageparam s seeeeseeeeeeesrerereersrsreree 127 8 14 5 Image channels lt ID gt FOCUS eeseeseeseeceseeseseeeeceseeeeseeeeseeeeeeneeeeaeeeeaes 127 8 14 6 Image channels lt ID gt LensInitialiZation eee eeseeseeeeeeeeeeeteeeeeeeeeees 128 8 14 7 Image channels lt ID gt IMAQEFIIP ee eeeeseeeeeeeeceeeeesceeeseeeeeseeeeaeeeeees 128 8 14 8 Image channels lt ID gt IMAQEFreeZe ee ee
63. Example 9600 Colar RGB triplet in hexadecimal format 3 bytes without the preceding 0x Example FFOOFF A positive numerical value in pixels A coordinate pair of 0 0 x y indicates the Coordinate bottom left corner of the video image Value is gt 0 Maximum value is dependent on video resolution FPS Frame rate multiplied by 100 Example 2500 PAL IPv4 Notation is XXX XXX XXX XXX Address Example 3 137 217 220 MAC MAC E Notation is aa bb cc dd ee ff with 6 hex bytes 6 3 Annotation The XML Data Blocks described in this document contains annotations for the field s properties Please refer to the XML schema definitions for detail description The following annotation content is inserted into the comments to describe the data carried in the field 2009 2014 by HIKVISION All rights reserved 15 HIKVISION Table 6 Annotation Description req Required field api Optional field For data uploaded to the device if the field is present but the device does not support it it should be ignored dep This field is required depending on the value of another field Read only For XML data that is both read and written to the device this ro field is only present in XML returned from the device If this field is present in XML uploaded to the device it should be ignored Write only This field is only present in XML that can be uploaded to the wo device This field should never be present in
64. KVISION All rights reserved 71 HIKVISION lt enabled gt true lt enabled gt lt Unicast gt lt Multicast gt lt enabled gt true lt enabled gt lt destIPAddress gt 224 16 74 1 lt destIPAddress gt lt destPortNo gt 8600 lt destPortNo gt lt Multicast gt lt Transport gt lt Video gt lt enabled gt true lt enabled gt lt videoInputChannellD gt 1 lt videolnputChannellD gt lt videoCodecType gt H 264 lt videoCodecType gt lt videoScanType gt progressive lt videoScanType gt lt videoResolutionWidth gt 640 lt videoResolutionWidth gt lt videoResolutionHeight gt 480 lt videoResolutionHeight gt lt videoQualityControlType gt CBR lt videoQualityControlType gt lt constantBitRate gt 3072 lt constantBitRate gt lt fixedQuality gt 80 lt fixedQuality gt lt maxFrameRate gt 2500 lt maxFrameRate gt lt keyFramelnterval gt 25 lt keyFramelInterval gt lt BPFramelnterval gt 0 lt BPFramelnterval gt lt mirrorStatus gt OFF lt mirrorStatus gt lt rotationDegree gt 180 lt rotationDegree gt lt snapShotlmageType gt JPEG lt snapShotIlmageType gt lt Video gt lt Audio gt lt enabled gt true lt enabled gt lt audiolnputChannellD gt 11 lt audiolnputChannellD gt lt audioCompressionType gt G 7 11 ulaw lt audioCompressionType gt lt Audio gt lt StreamingChannel gt Example Getting Streaming Capabilities GET Streaming channels 1 capabilities HTTP 1 1 HTTP 1 1 200 OK Content Type
65. MIK VISION IP Media Device Management Protocol User Guide Version 1 0 Revision 5 9 2010 09 HIKVISION http www hikvision com COPYRIGHT 2009 Hikvision Digital Technology Co Ltd HIKVISION Revision Description Date History Version 1 0 Initial version i ae 2009 6 Revision 1 Version 1 0 Finished the Man r rvi l shed the Mandatory services 2009 8 Revision 2 Version 1 0 Corrections S SEN 2009 10 Revision 3 expanded services Version 1 0 Corrections updates services and resources 2009 11 Revision 4 Version 1 0 Pr revision l otocol revisio 2009 12 Revision 5 Verison 1 0 Corrections amend PTZ service and 2010 01 Revision 5 1 resources Verison 1 0 Update the PTZ channels ID PTZControl resources ici 2010 01 Revision 5 2 Verison 1 0 Amend the DDNS related resources add the a e l 2010 02 Revision 5 3 Security adminAccess resources The lt Zeroconf gt tag is supported in the block XML of System Network interfaces D discovery Add the System logging The lt pulseDuration gt tag is supported in the block Verison 1 0 XML of lO outputs ID 2010 04 Revision 5 4 The lt pulseDuration gt tag is not supported in the block XML of lO outputs ID trigger Modify some parameter values in Audio Service The lt enabled gt can be configured inthe lt Audio gt of the block XML Streaming channels ID lt videoResolution gt is replaced with
66. ML Block lt Devicelnfo version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt deviceName gt lt req xs string gt lt deviceName gt lt devicelD gt lt req xs integer 1 255 gt lt devicelD gt 2009 2014 by HIKVISION All rights reserved 20 HIKVISION lt Note The following are read only parameters gt lt deviceDescription gt lt ro req xs string gt lt deviceDescription gt lt deviceLocation gt lt ro req xs string gt lt deviceLocation gt lt systemContact gt lt ro req xs string gt lt systemContact gt lt model gt lt ro req xs string gt lt model gt lt serialNumber gt lt ro req xs string gt lt serialNumber gt lt macAddress gt lt ro req xs string gt lt macAddress gt lt firmwareVersion gt lt ro req xs string gt lt firmwareVersion gt lt firmwareReleasedDate gt lt ro opt xs string gt lt firmwareReleasedDate gt lt bootVersion gt lt ro opt xs string gt lt bootVersion gt lt bootReleasedDate gt lt ro opt xs string gt lt bootReleasedDate gt lt hardwareVersion gt lt ro opt xs string gt lt hardwareVersion gt lt Devicelnfo gt 8 1 2Configuration file s System configurationFile General Resource v1 0 Description It is used to get device s configuration file s Query None Inbound Data None
67. N All rights reserved 97 HIKVISION lt PatrollD gt lt PatrollDList gt lt PatternIDList gt lt opt gt lt PatternID gt lt opt gt lt id gt lt ro req xs integer 1 16 gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt PatternID gt lt PatternIDList gt lt PTZChannel gt 8 12 3 Patrols PTZ channels D patrols General Resource v1 0 GET Viewer Description It is used to get the list of patrols for a PTZ channel Query None Inbound Data None Success Return PTZPatrolList Notes PTZPatrolList XML Block lt PTZPatrolList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt PTZPatrol gt lt opt gt lt PTZPatrolList gt 8 12 4 Patrol PTZ channels D patrols ID General Resource v1 0 Description It is used to get a particular patrol configuration for a PTZ channel Query None Inbound Data None Success Return PTZPatrol It is used to update a particular patrol configuration for a PTZ Description channel Query None Inbound Data PTZPatrol 2009 2014 by HIKVISION All rights reserved 98 HIKVISION Success Return hik ResponseStaus ResponseStatus Notes PTZPatrol XML Block lt PTZPatrol version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt PatrolPointList gt lt opt gt
68. N Fully Qualified Domain Name REST REpresentational State Transfer IO Input Output UPnP Universal Plug and Play 4 Architecture and Transmission Mechanism The IP Media Device Management Protocol is based on REST architecture The management and control interfaces defined in this specification are treated as resources utilizing the REpresentational State Transfer REST architecture This architecture facilitates users by grouping related resources within hierarchical namespaces and is more flexible for service discovery and future expansion REST architecture consists of clients and servers among which clients initiate request to servers while servers handle requests and response accordingly Requests and responses are established via the transmission of representations of resources REST architecture need to be based on an Application Layer protocol which provides various of standard communication formats for applications based on the transfer of meaningful representational state HTTP 1 has a very rich vocabulary in terms of verbs or methods 2009 2014 by HIKVISION All rights reserved 2 HIKVISION URIs request and response headers Internet media types HTTP request and response codes etc In addition HTTP also has some features particularly suitable for REST architecture So HTTP is used as external Application Layer protocol in this specification In the architecture clients are physical security and vid
69. PortID gt lt ioPortType gt lt req xs string input output gt lt ioPortType gt lt ioState gt lt req xs string active inactive gt lt ioState gt lt lIOPortStatus gt lt OPortStatusList gt 8 3 2Inputs O inputs General Resource v1 0 Description It is used to get the Input ports information Query None Inbound Data None Success Return lOInputPortList Notes IO inputs are hardwired meaning that the inputs are statically allocated by the device and cannot be created or deleted lOInputPortList XML Block lt lOInputPortList version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt lOlnputPort gt lt opt gt lt lOlInputPort gt 8 3 3lnput O inputs ID General Resource v1 0 2009 2014 by HIKVISION All rights reserved 43 HIKVISION Description It is used to get particular input port information Query None Inbound Data None Success Return lOlnputPort Pur Operator Description It is used to update particular input port information Query None Inbound Data lOlnputPort Success Return hik ResponseStaus ResponseStatus Notes lt triggering gt indicates the signal conditions to trigger the input port High Low will continuously trigger for the duration of high low input signal lOlnputPort XML Block lt lOlnputPort version 1 0 xmlns http www hikvision com ver10 XMLSchema gt lt id gt lt r
70. Scene Description It is used to set sene mode of a camera Query None 2009 2014 by HIKVISION All rights reserved 140 HIKVISION Inbound Data Scene Success Return hik ResponseStaus ResponseStatus Notes Scene XML Block lt Scene gt lt mode gt lt req xs string indoor outdoor gt lt mode gt lt Scene gt 8 14 26 Image channels lt ID gt EPTZ Image channels lt ID gt EPTZ General Resource v1 0 Description It is used to get electronic PTZ enabled status Query None Inbound Data None Success Return EPTZ Description It is used to get electronic PTZ enabled status Query None Inbound Data EPTZ Success Return hik ResponseStaus ResponseStatus Notes EPTZ XML Block lt EPTZ gt lt enabled gt lt req xs boolean true false gt lt enabled gt lt EPTZ gt 8 14 27 Image channels lt ID gt PTZ Image channels lt ID gt PTZ General Resource v1 0 It is used to get PTZ status if a camera support PTZ enabled tag Description j EE value is true otherwise is false Query None Inbound Data None 2009 2014 by HIKVISION All rights reserved 141 HIKVISION Success Return PTZ PTZ XML Block lt PTZ gt lt enabled gt lt ro xs boolean true false gt lt enabled gt lt PTZ gt 8 14 28 Image channels lt ID gt EIS Image channels lt ID gt EIS General Resource v1 0 It is used to get the electronic image stabi
71. Status gt 2009 2014 by HIKVISION All rights reserved 30 HIKVISION 8 1 13 4 Storage volumes ID format System Storage volumes ID format Description It is used to format a storage device Query None Inbound Data None Success Return StorageVolumeStatus Notes Formating may take time 8 1 13 5 Storage volumes ID isFormat System Storage volumes ID IsFormat Description It is used to access the procedure of formating Query None Inbound Data None Success Return StorageVolumeFormatSatus Notes formatSatus show the percentage of formatted part of the storage device Storage VolumeStatus XML Block lt StorageVolumeFormatSatus version 1 0 xmIns urn psialliance org gt lt formatSatus gt lt req xs integer 0 100 gt lt formatSatus gt lt StorageVolumeFormatSatus gt 8 2 Network Network Service v1 0 Notes Network configuration 8 2 1Interfaces Network interfaces General Resource v1 0 2009 2014 by HIKVISION All rights reserved 31 HIKVISION GET Viewer Description It is used to get the device network interfaces Query None Inbound Data None Success Return NetworkinterfaceList Notes As hardwired system resources network interfaces cannot be created or destroyed NetworkinterfaceList XML Block lt NetworkInterfaceList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt NetworkInterface gt lt opt
72. Success Return Opaque Data Description It is used to update device s configuration file s Query None Inbound Data Opaque Data Success Return hik ResponseStaus ResponseStatus Notes Configuration file is device dependant it may be binary or any other format Should reboot device after configuration file is applied 8 1 3Factory default System factoryDefault General Resource v1 0 It is used to reset the configuration for the device to the factory default Query mode Description 2009 2014 by HIKVISION All rights reserved 21 HIKVISION Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Two factory reset modes are supported full resets all device parameters and settings to their factory values basic resets all device parameters and settings except the values in Network Service The default mode is full The device should be rebooted after it is reset 8 1 4Firmware upgrade System firmwareUpgrade General Resource v1 0 Description It is used to upgrade the firmware of the device Query None Inbound Data Opaque Data Success Return hik ResponseStaus ResponseStatus Notes The device should be rebooted after the upgrade is completed 8 1 5Reboot System reboot General Resource v1 0 Description It is used to reboot the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes ResponseStatus is returned before the
73. Suppress General Resource v1 0 It is used to get the chroma suppress configuration of a specified Description 4 image channel Query None Inbound Data None Success Return ChromaSuppress It is used to set the chroma suppress configuration of a specified Description j image channel Query None Inbound Data ChromaSuppress Success Return hik ResponseStaus ResponseStatus Notes ChromaSuppress XML Block lt ChromaSuppress version 1 5 9 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt ChromaSuppressLevel gt lt opt xs integer 0 100 gt lt ChromaSuppressLevel gt lt ChromaSuppress gt 2009 2014 by HIKVISION All rights reserved 143 HIKVISION 8 14 31 Image channels lt ID gt ZoomLimit Image channels lt ID gt ZoomLimit General Resource v1 0 Ta It is used to get the zoomlimitconfiguration of a specified Image Description channel Query None Inbound Data None Success Return ZoomLimit Description It is used to set the zoomlimit value of the camera Query None Inbound Data ZoomLimit Success Return hik ResponseStaus ResponseStatus Notes ZoomLimit XML Block lt ZoomLimit version 1 5 9 xmIns http www hikvision com ver10 XMLSchema gt lt ZoomLimitRatio gt lt opt xs integer gt lt ZoomLimitRatio gt lt ZoomLimit gt 8 14 32 Image channels lt ID gt ExpComp
74. T DOWN_RIGHT DAN AUTO the default is 8 13 PTZCtrl PTZCtrl Service v1 0 Notes PT ZCirl control service 8 13 1 PTZCirl channels PTZCtrl channels General Resource v1 0 d It is used to get the list of PTZ channels for the device Description Query None Inbound Data None Success Return PTZChannelList PUTO Operator Description It is used to update the list of PTZ channels for the device Query None Inbound Data PTZChannelList Success Return hik ResponseStaus ResponseStatus It is used to add a PTZ channel for the device Description Query None Inbound Data PTZChannel Success Return hik ResponseStaus ResponseStatus 2009 2014 by HIKVISION All rights reserved 102 HIKVISION Description It is used to delete the list of PTZ channels for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes PTZ channels may be hardwired or it may be possible to create channels if the device supports it To determine whether it is possible to dynamically PTZ channels check the defined HTTP methods in PTZCtrl channels description PTZChannelList XML Block lt PTZChannelList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt PTZChannel gt lt opt gt lt PTZChannelList gt 8 13 2 PTZCtrl channels lt ID gt PTZCtrl channels lt ID gt General Resource v1 0 Description It is used to get a particular PTZ
75. VISION Success Return hik ResponseStaus ResponseStatus Notes hik Exposure XML Block lt Exposure version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt ExposureType gt lt req xs string auto IrisFirst ShutterFirst gainFirst manual gt lt OverexposeSuppress gt lt opt gt lt enabled gt lt req xs boolean gt lt enabled gt lt OverexposeSuppress gt lt Exposure gt 8 14 18 Image channels lt ID gt Sharpness Image channels lt ID gt Sharpness General Resource v1 0 Description It is used to get the sharpness s value of a specified image channel Query None Inbound Data None Success Return Sharpness It is used to configure the sharpness s value of a specified image Description channel Query None Inbound Data Sharpness Success Return hik ResponseStaus ResponseStatus Notes Sharpness XML Block lt Sharpness version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt SharpnessLevel gt lt req xs integer 0 100 gt lt SharpnessMode gt lt opt xs string manual auto gt lt SharpnessMode gt lt Sharpness gt 8 14 19 Image channels lt ID gt Iris Image channels lt ID gt Iris General Resource v1 0 Description It is used to get the iris s value of a specified image channel 2009 2014 by HIKVISION All rights reserved 136 HIKVISION Query None Inbound Data None Suc
76. ZPattern gt lt opt gt lt PTZPatternList gt 2009 2014 by HIKVISION All rights reserved 114 HIKVISION 8 13 22 PTZCtrl channels lt ID gt patterns lt ID gt PTZCirl channels lt ID gt patterns lt ID gt General Resource v1 0 It is used to get a particular pattern configuration of a particular PTZ Description channel Query None Inbound Data None Success Return PTZPattern lt is used to update a particular pattern configuration of a particular GE PTZ channel Query None Inbound Data PTZPattern Success Return hik ResponseStaus ResponseStatus It is used to delete a particular pattern configuration of a particular EEN PTZ channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes lt space gt x indicates the remaining space for pattern PTZPattern XML Block lt PTZPattern version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt id gt lt req xs integer gt lt id gt lt space gt lt req xs integer 0 100 gt lt space gt lt PTZPattern gt 8 13 23 PTZCtrl channels lt ID gt patterns lt ID gt recordst art PTZCirl channels lt ID gt patterns lt ID gt recordstart General Resource v1 0 lt is used to start particular_pattern information recording of a particular PTZ channel Query None Description 2009 20
77. ageichannelei IDDIE 141 8 14 28 Image channels lt ID gt EIS ws vvousss ceshanssawsatrssaisneraeanancasnnisienntavatioslaruesienenty 142 8 14 29 Image channels lt ID gt HLC ascissssiscccnentensesasnsarsnonwaradvensbnadvorsnnsiannetnavanaeseads 142 8 14 30 Imageichannels JD AChromauppress 143 8 14 31 Image channels lt ID gt ZOOMLIMIt eee eeetceeeeeeeceteeeeseeeeceeeeeeneeeeaeeeeees 144 8 14 32 Image channels lt ID gt EXpPCOMp EEN 144 8 14 33 Imagoeichannelsi WD rt obt 145 8 14 34 Image channels lt ID gt WDR 1 5 8 old version 145 8 14 35 Image channels lt ID gt NoiseReduce 1 5 8 old version 146 8 14 36 Image channels lt ID gt IrcutFilter 1 5 8 old version 147 El E WE 147 SLS IRECOrd SCHEAUIE E 148 ANNEX As MOMMALIVG EE 149 GEAR 149 HIKVISION 1 Scope This specification defines a HTTP based application programming interface that enables physical security and video management systems to communicate with IP media devices in a particular way With regard to Media Streaming please refer to develop API of RTSP protocol 2 References The following documents contain provisions which through reference in this text constitute provisions of the present document e References are either specific identified by date of publication edition number version number etc or non specific e For a specific reference subsequent revisions do not apply e For a non specific reference the latest version applies 1
78. ameter gt lt xs sequence gt lt xs element name description type xs string gt lt xs element name queryParameterList type hik QueryParameterList gt lt xs element name inboundData type xs string gt lt xs element name successReturn type xs string gt lt xs sequence gt lt xs complexType gt lt xs complexType name ResourceDescription gt lt xs sequence gt lt xs element name name type xs string gt lt xs element name version type xs string gt lt xs element name type type hik Resource Type gt lt xs element name get type hik OperationParameter minOccurs 0 maxOccurs 1 gt lt xs element name Dout type hik OperationParameter minOccurs 0 maxOccurs 1 gt lt xs element name post type hik OperationParameter minOccurs 0 maxOccurs 1 gt lt xs element name delete type hik OperationParameter minOccurs 0 maxOccurs 1 gt lt xs element name notes type xs string minOccurs 0 maxOccurs 1 gt lt xs sequence gt lt xs attribute name version type xs string use required gt lt xs complexType gt lt xs complexType name Resource gt lt xs sequence gt lt xs element name name type xs string gt lt xs element name version type xs string gt lt xs element name type type hik ResourceType gt lt xs element name description
79. ansactions it is required to implement Connection Keep Alive HTTP header field while also adopt the Connection close HTTP header field for the last transaction of the persistent connection This process will assume that the application can identify the last request in a sequence of multiple requests 4 5 2Authorization and WWwW Authenticate Header Fields When a video management system or client application sends any request to the device it must be authenticated by means of Basic Access 5 according to RFC 2617 and thus all the devices are required to support Basic Access Authorization header field is sent along with each request and if a user is authenticated the request will follow the normal execution flow If client HTTP request is with no authentication credentials unauthorized HTTP response 401 will be returned with WWW Authenticate header field 4 5 3Entity Body The Content Type entity header field indicates the media type of the entity body The Content Type may be designated as application xml charset UTF 8 application octet stream etc For configuration information the Content Type is usually application xml zm charset UTF 8 For example HTTP Request Message GET System status HTTP 1 1 HTTP Response Message HTTP 1 1 200 OK Content Type application xml charset UTF 8 2009 2014 by HIKVISION All rights reserved 6 HIKVISION lt xml version 1 0
80. ate event schedules Query None Inbound Data EventSchedule Success Return hik ResponseStaus ResponseStatus Notes This is anew resource may be some old firmware is unsurpported the old url is Custom HIKCGI Event schedule ID the new firmware will support both of them ID is defined as TypeName If the event type is IO the ID is IO_IN_PortNumber the ID is 1O_OUT_PortNumber Examples VMD Video Motion Detection videoloss Video Loss shelteralarm Shelter Alarm IO IN _1 the first IO input port IO_OUT_2 the second IO output port EventSchedule XML Block lt EventSchedule version 1 0 xmlIns http www hikvision com ver10 XMLSchema gt lt eventT ype gt lt req gt lt req xs string 2009 2014 by HIKVISION All rights reserved 87 HIKVISION 10 VMD videoloss shelteralarm gt lt eventT ype gt lt inputlOPortID gt lt dep xs string gt lt inputIOPortID gt lt outputlOPortID gt lt dep xs string gt lt inputIOPortID gt lt TimeBlockList gt lt req gt lt TimeBlock gt lt dayOfWeek gt lt opt xs integer ISO8601 weekday number 1 Monday gt lt dayOfWeek gt lt TimeRange gt lt req gt lt beginTime gt lt req xs time ISO8601 time gt lt beginTime gt lt endTime gt lt req xs time ISO8601 time gt lt endTime gt lt TimeRange gt lt TimeBlock gt lt TimeBlockL
81. ates inbound data for the resources Success Return the Type if present and the name of XML Data Block Notes describes any special processing rules for the resource Type refers to Special Resource Service and General Resource Version is used to determine the version of the protocol The version number shall be set to 1 0 in this specification Operation_Name refers to GET PUT POST and DELETE Inbound Data includes three types as follows NONE no input data DataBlock the name of an XML Data Block Datablocks used here must be 2009 2014 by HIKVISION All rights reserved 14 HIKVISION defined according to the specification Mime type mime type for the input data in the HTTP payload Remark application xml is not a valid mime type If a device does not support particular XML tags or blocks then it may not be supported by the resource operations Generally if a field is not provided in the inbound XML then its current values shall not be modified in the device s repository If a required field did not exist in the device s repository then it must be provided in the applicable resource operations Success Return and Error Return detailed description see Section 4 5 5 6 2 Built in Types Table 5 Type Description A positive numerical value indicating the data transmission rate in symbols BaudRate P ona Value is gt 0
82. ce event behavior Description ieee scheduling and notifications Inbound Data Noe sss sSSSSCis EventNotification Se It is used to udpate the configuration of the device event behavior Description 8 GE scheduling and notifications 2009 2014 by HIKVISION All rights reserved 81 HIKVISION Query None Inbound Data EventNotification Success Return hik ResponseStaus ResponseStatus Notes The event trigger list defines the set of device behaviors that trigger events The event schedule defines when event notifications are active The event notification methods define what types of notification e mail are supported EventNotification XML Block lt EventNotification version 1 0 xmIns http Awww hikvision com ver1 0 XMLSchema gt lt EventTriggerList gt lt opt gt lt EventSchedule gt lt opt gt lt EventNotificationMethods gt lt opt gt lt EventNotification gt 8 11 1 Triggers Event triggers General Resource v1 0 Description It is used to get the list of event triggers Query None Inbound Data None Success Return EventTriggerList Description It is used to update the list of event triggers Query None Inbound Data EventTriggerList Success Return hik ResponseStaus ResponseStatus Description It is used to add an event trigger Query None Inbound Data EventTrigger Success Return hik ResponseStaus ResponseStatus Description It is used to d
83. cess Return Iris PT Operator Description It is used to configure the iris s value of a specified image channel Query None Inbound Data Iris Success Return hik ResponseStaus ResponseStatus Notes lris s PUT operate is enabled only when lt ExposureType gt is IrisFirst irisSpeed negative numbers close iris positive numbers open iris Numerical value is a percentage of the maximum iris speed of the lens module hik lrisValue XML Block lt lris version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt lrisLevel gt lt dep depends on lt ExposurelType gt xs string TA f1 6 f2 0 f2 4 f2 8 13 4 f4 0 4 8 5 6 6 8 8 0 19 6 f11 f14 f16 f19 f22 close gt lt irisSpeed gt lt opt xs integer 100 100 gt lt irisSpeed gt lt lris gt 8 14 20 Image channels lt ID gt Shutter Image channels lt ID gt Shutter General Resource v1 0 Description It is used to get the Shutter value of a specified image channel Query None Inbound Data None Success Return Shutter Description It is used to configure the Shutter value of a specified image channel Query None Inbound Data Shutter Success Return hik ResponseStaus ResponseStatus Notes Shutter s PUT operate is enabled only when lt ExposureType gt is ShutterFirst hik ShutterValue XML Block lt Shutter version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt ShutterLevel gt lt dep depen
84. cess Return RecordSchedule PUTO Operator Description It is used to update recording time range Query None Inbound Data RecordSchedule Success Return hik ResponseStaus ResponseStatus Notes RecordSchedule XML Block lt RecordSchedule version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enalbled gt lt req xs boolean gt lt enalbled gt lt RecordDelayTime gt lt req xs integer gt lt RecordDelayTime gt lt PreRecordTime gt lt req xs integer gt lt PreRecordTime gt lt TimeBlockList gt lt req gt lt TimeBlock gt lt recordType gt lt req xs string Alarm Motion Timing gt lt recordType gt lt dayOfWeek gt lt opt xs integer SO8601 weekday number 1 Monday gt lt dayOfWeek gt lt TimeRange gt lt req gt lt beginTime gt lt req xs time ISO8601 time gt lt beginTime gt lt endTime gt lt req xs time ISO8601 time gt lt endTime gt lt TimeRange gt lt TimeBlock gt lt TimeBlockList gt lt RecordSchedule gt 2009 2014 by HIKVISION All rights reserved 148 HIKVISION Annex A normative XML Schema Definition A 0 hik xsd The following XML Schema Document contains XML schema definitions for data structures in this specification lt xml version 1 0 encoding UTF 8 gt lt xs schema xmins hik http www hikvision com ver10 XMLSchema xmin
85. cess protocol for the device Query None Inbound Data AdminAccessProtocol Success Return hik ResponseStaus ResponseStatus Notes lt protocol gt is the protocol name for admin access i e HTTP HTTPS etc AdminAccessProtocol XML Block lt AdminAccessProtocol version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt protocol gt lt req xs string HTTP HTTPS gt lt protocol gt lt portNo gt lt req xs integer gt lt portNo gt lt netClientPort gt lt req xs integer gt lt netClientPort gt lt AdminAccessProtocol gt 8 9 Streaming Streaming Service v1 0 Notes 8 9 1Status Streaming status General Resource v1 0 Description It is used to get a device streaming status Query None Inbound Data None Success Return StreamingStatus Notes This command accesses the status of all device streaming sessions StreamingStatus XML Block 2009 2014 by HIKVISION All rights reserved 67 HIKVISION lt StreamingStatus version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt totalStreamingSessions gt lt req xs integer gt lt totalStreamingSessions gt lt StreamingSessionStatusList gt lt dep only if there are sessions gt lt StreamingStatus gt 8 9 2Channels Streaming channels General Resource v1 0 Description It is used to get the properties of streaming channels for the device
86. channel configuration for the device Query None Inbound Data None Success Return PTZChannel It is used to update a particular PTZ channel configuration for the Description i device Query None Inbound Data PTZChannel Success Return hik ResponseStaus ResponseStatus DELETE Operator Description It is used to delete a particular PTZ channel on a device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes lt videolnputID gt links the PTZ channel to a video channel lt presetSpeed gt indicates the movement speed level about calling preset lt autoScanSpeed gt indicates the movement speed level about park function 2009 2014 by HIKVISION All rights reserved 103 HIKVISION lt keyPadControlSpeed gt indicates the movement speed level to be controlled by keyboard lt controlProtocol gt indicates the control protocol to be used for PTZ lt controlAddress gt indicates the soft address enabled means soft address is used PTZChannel XML Block lt PTZChannel version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt enabled gt lt ro req xs boolean gt lt enabled gt lt videolnputID gt lt req xs integer gt lt videolnputID gt lt panMaxSpeed gt lt ro opt xs integer degrees sec gt lt panMaxSpeed gt lt tiltMaxSpeed gt lt ro opt xs integer degrees sec gt
87. d Data Time Success Return hik ResponseStaus ResponseStatus Notes If lt timeMode gt is present and set to local the lt localTime gt and lt timeZone gt fields are required The lt localTime gt block sets the device time If lt timeMode gt is present and set to NTP only the lt timeZone gt field is required The 2009 2014 by HIKVISION All rights reserved 23 HIKVISION device time is set by synchronizing with NTP Time XML Block lt Time version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt timeMode gt lt req xs string NTP manual gt lt timeMode gt lt localTime gt lt req xs datetime gt lt localTime gt lt timeZone gt lt req xs string POSIX time zone string gt lt timeZone gt lt Time gt 8 1 8LocalTime System time localTime General Resource v1 0 Description It is used to get the device local time information Query None Inbound Data None Success Return ISO 8601 Date Time String Description It is used to udpate the device local time information Query None Inbound Data ISO 8601 Date Time String Success Return hik ResponseStaus ResponseStatus Notes An ISO 8601 Date Time string is accepted and returned If the date time value has a time zone the time is converted into the device s local time zone If the device time mode is set to ntp setting this value has no effect 8 1 9TimeZone System time
88. d the gateway and DNS fields are optional lt subnetMask gt notation is XXX XXX XXX XXX IPAddress XML Block lt IPAddress version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt ipVersion gt lt req xs string v4 gt lt ipVersion gt lt addressinglype gt lt req xs string static dynamic gt lt addressingType gt lt ipAddress gt lt req xs string gt lt ipAddress gt lt subnetMask gt lt req xs string subnet mask for IPv4 address gt lt subnetMask gt lt DefaultGateway gt lt dep gt lt ipAddress gt lt req xs string gt lt ipAddress gt lt DefaultGateway gt lt PrimaryDNS gt lt dep gt lt ipAddress gt lt req xs string gt lt ipAddress gt lt PrimaryDNS gt lt IPAddress gt 8 2 4Wireless Network interfaces D wireless General Resource v1 0 Description It is used to get the WIFI information of a wireless network interface 2009 2014 by HIKVISION All rights reserved 33 HIKVISION Query None Inbound Data None Success Return Wireless It is used to update the WIFI information of a wireless network Description i interface Query None Inbound Data Wireless Success Return hik ResponseStaus ResponseStatus Notes If the lt securityMode gt field is WEP the lt WEP gt block must be provided If the lt securityMode gt field is WPA or WPA2 personal the
89. ddress gt lt receiverEmailAddressList gt lt receiverEmailAddress gt lt id gt lt req xs integer gt lt id gt lt EmailAddress gt lt req xs string gt lt EmailAddress gt lt receiverEmailAddress gt lt receiverEmailAddressList gt lt EmailFormatExt gt lt MailingNotification gt 8 11 10 HTTP Hosts Event notification httpHost General Resource v2 0 aaa aa Description It is used to get the configuration of e mail Query None Inbound Data None Success Return HttpHostNotificationList PUT Description It is used to set the configuration of e mail Query None Inbound Data HttpHostNotificationList Success Return ResponseStatus Notes HttpHostNotificationList XML Block lt HttpHostNotificationList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt HttpHostNotification gt lt opt gt lt HttpHostNotificationList gt 8 11 11 HTTP Host Event notification httpHost ID General Resource v2 0 Description It is used to get the configuration of a particular e mail 2009 2014 by HIKVISION All rights reserved 91 HIKVISION Query None Inbound Data None Success Return HttpHostNotification Pi ee Description It is used to set the configuration of a particular e mail Query None Inbound Data HttpHostNotification Success Return ResponseStatus Notes HttpHostNotification XML Block lt HttpHostNotification version 1 0
90. deoScanType opt progressive gt progressive lt videoScanType gt lt videoResolutionWidth opt 640 480 gt 640 lt videoResolutionWidth gt lt videoResolutionHeight opt 640 480 gt 480 lt videoResolutionHeight gt lt videoQualityControlType opt CBR VBR gt CBR lt videoQualityControlType gt lt constantBitRate min 32 max 4000 gt 3072 lt constantBitRate gt lt fixedQuality opt 1 20 40 60 80 100 gt 80 lt fixedQuality gt lt maxFrameRate opt 2500 2200 2000 1800 1600 1500 1200 1000 800 600 400 200 100 50 25 12 6 gt 2500 lt maxFrameRate gt lt keyFramelnterval min 1 max 400 gt 25 lt keyFramelnterval gt lt BPFramelnterval opt 0 1 2 gt 0 lt BPFramelnterval gt lt mirrorStatus opt OFF UpToDown LeftToRight gt OFF lt mirrorStatus gt lt rotationDegree opt 0 180 gt 180 lt rotationDegree gt lt snapShotlmageType opt JPEG def JPEG gt JPEG lt snapShotlmageType gt lt Video gt lt Audio gt lt enabled opt true false gt true lt enabled gt lt audiolnputChannellD opt 11 12 gt 11 lt audiolnputChannellD gt 2009 2014 by HIKVISION All rights reserved 73 HIKVISION lt audioCompressionType opt G 7 11ulaw gt G 711ulaw lt audioCompressionType gt lt Audio gt lt StreamingChannel gt 8 9 4Channel status Streaming channels D status General Resource v1 0 It is used to get the list of streaming sessions associated wi
91. detection algorithm Motion detection is enabled with a granularity of a 22x18 grid this means the detection region coordinates will ultimately be defined by a grid of 396 regions For a resolution of 1600x1200 this means that each granule will be 1600 22 x 1200 18 pixels If a coordinate doesn t exactly match the configured granularity it should be mapped internally to the nearest possible point Two detection regions are defined the second containing an inner overlapping region that is disabled Region 1 occupies the bottom left 16 granules Region 2 occupies the middle 16 granules with the top right most corner granule region 3 disabled by use of the lt maskEnabled gt tag 1200 Mask Region 3 Region 2 Region 1 0 1600 PUT MotionDetection 1 HTTP 1 1 Content Type application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt MotionDetection version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt 1 lt id gt lt enabled gt true lt enabled gt lt MotionDetectionRegionList gt lt sensitivityLevel gt 2 lt sensitivityLevel gt lt MotionDetectionRegion gt 2009 2014 by HIKVISION All rights reserved 79 HIKVISION 2009 2014 by HIKVISION All rights reserved 80 HIKVISION 8 11 Event Event Service v1 0 It is used to get the configuration of the devi
92. ds on lt ExposureType gt xs string 1 1 1 2 1 3 1 6 1 12 1 25 1 50 1 75 1 100 1 120 1 150 1 215 1 300 1 425 1 600 1 1000 1 1250 1 1750 2009 2014 by HIKVISION All rights reserved 137 HIKVISION 1 2500 1 3500 1 6000 1 10000 gt lt Shutter gt 8 14 21 Image channeles lt ID gt Gain Image channels lt ID gt Gain General Resource v1 0 Description It is used to get the gain configuration of a specified Image channel Query None Inbound Data None Success Return Gain EN It is used to configure the gain configuration of a specified Image Description channel Query None Inbound Data Gain Success Return hik ResponseStaus ResponseStatus Notes Gain s PUT operate is enabled only when lt ExposureType gt is gainFirst hik gain XML Block lt Gain version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt GainLevel gt lt dep depends on lt ExposureType gt xs integer 0 100 gt lt GainWindow gt lt opt gt lt RegionCoordinatesList gt lt opt gt lt RegionCoordinates gt lt opt gt lt positionX gt lt req xs integer coordinate gt lt positionX gt lt positionY gt lt req xs integer coordinate gt lt positionY gt lt RegionCoordinates gt lt RegionCoordinatesList gt lt GainWindow gt lt Gain gt 8 14 22 Image channeles lt ID gt GamaCorrection Image channels
93. e Success Return ShelterAlarm 2009 2014 by HIKVISION All rights reserved 54 HIKVISION DS It is used to update the shelter alarm configuration for a video input Description channel Query None Inbound Data ShelterAlarm Success Return hik ResponseStaus ResponseStatus Notes ShelterAlarm XML Block lt ShelterAlarm version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt ShelterAlarmRegionList gt lt opt gt lt ShelterAlarm gt 8 4 11 Input channel shelterAlarm regions Video inputs channels D shelterAlarm regions General Resource v1 0 It is used to get the shelter alarm regions configuration for a video Description input channel Query None Inbound Data None Success Return ShelterAlarmRegionList It is used to update the shelter alarm regions configuration for a video Description input channel Query None Inbound Data ShelterAlarmRegionList Success Return hik ResponseStaus ResponseStatus POST Operator Description It is used to add a shelter alarm region for a video input channel Query None Inbound Data ShelterAlarmRegion Success Return hik ResponseStaus ResponseStatus It is used to delete the shelter alarm regions configuration for a video Description input channel Query None Inbound Data None 2009 2014 by HIKVISION All rights reserved 55 HIKVISION Succe
94. e themselves A UPnP compatible device will automatically announce its network address supported devices and services types when connected to a network and therefore becoming plug and play by allowing clients recognize those information and begin using this device immediately The UPnP architecture supports zero configuration networking and the device can dynamically join a network obtain IP address announce its name convey its capabilities upon request and gets the on line status and capabilities of other devices DHCP and DNS servers are optional and are only used if they are available on the network Devices can leave the network automatically without leaving any unwanted status information behind UPnP was published as a 73 part International Standard ISO IEC 29341 in December 2008 6 7 8 The foundation for UPnP networking is IP addressing When a device is connected to the network for the first time its Dynamic Host Configuration Protocol DHCP client will search for a DHCP server If the device successfully get its domain name via DNS server or DNS forwarding then it should use this domain name for the following network operations if the network is unmanaged and no DHCP server is found the device must assign an address for itself which is known as AutolP of the UPnP Device Architecture 2009 2014 by HIKVISION All rights reserved 13 HIKVISION 9 10 and use this IP address for the following network o
95. e 2 Services Description Reference System Configuis and operate the general system 8 1 functions Network Configure network interfaces 8 2 IO Configure the Input Output IO 8 3 Video Handle video related configuration 8 4 Audio Configure the Audio 8 5 Two way audio Control two ways audio 8 6 Serial Configure and control the Serial ports 8 7 2009 2014 by HIKVISION All rights reserved 4 HIKVISION Services Description Reference Security Provide Security functions 8 8 Configure and control the streaming media Streaming g 9 8 9 content Configure and control the motion detection of the Motion Detection f 8 10 device Event Provide event notification functions 8 11 PTZ Control the device pan tilt and zoom 8 12 4 4 Protocol URL The URL scheme is used to locate device resources via a specific protocol in the network This section defines the syntax and semantics for http s URLs lt protocol gt lt host gt port abs_path query protocol URL scheme for the particular request The http and https protocols are allowed in this specification host The host field refer to the hostname IP address or the FQDN of an IP device port The port field refer to the port number of that host on which the identified resource is located at the IP device listening for TCP connections If the port is empty or not given the default port is assumed For HTTP the default port 80 F
96. e a particular motion detection region configuration Description i for a video input channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes The region detection coordinate space depends on the value of lt regionType gt Only support the rectangular region which will be drawn from four coordinates The four points is clockwise direction and the beginning point is the low left point MotionDetectionRegion XML Block lt MotionDetectionRegion version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer 1 16 gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt maskEnabled gt lt req xs boolean gt lt maskEnabled gt lt RegionCoordinatesList gt lt req gt lt RegionCoordinates gt lt Note at least four coordinates are required gt lt positionX gt lt req xs integer gt lt positionX gt lt positionY gt lt req xs integer gt lt positionY gt lt RegionCoordinates gt lt RegionCoordinatesList gt lt MotionDetectionRegion gt 2009 2014 by HIKVISION All rights reserved 78 HIKVISION 8 10 4 Motion Detection Example Set up Motion Detection The following command configures two rectangular detection regions with one masked region on video input channel ID 1 Example assumes a resolution of 1600x1200 and a grid motion
97. eBlockList gt lt EventSchedule gt 2009 2014 by HIKVISION All rights reserved 95 HIKVISION 8 12 PTZ PTZ Service v1 0 Notes PTZ control service 8 12 1 Channels PTZ channels General Resource v1 0 Description It is used to get the list of PTZ channels for the device Query None Inbound Data None Success Return PTZChannelList Description It is used to update the list of PTZ channels for the device Query None Inbound Data PTZChannelList Success Return hik ResponseStaus ResponseStatus Description It is used to add a PTZ channel for the device Query None Inbound Data PTZChannel Success Return hik ResponseStaus ResponseStatus Description It is used to delete the list of PTZ channels for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes PTZ channels may be hardwired or it may be possible to create channels if the device supports it To determine whether it is possible to dynamically PTZ channels check the defined HTTP methods in PTZ channels description PTZChannelList XML Block lt PTZChannelList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt PTZChannel gt lt opt gt lt PTZChannelList gt 2009 2014 by HIKVISION All rights reserved 96 HIKVISION 8 12 2 Channel PTZ channels D General Resource v1 0 Description It is used to get a particular PTZ channel configuration for t
98. eStaus ResponseStatus Notes BLC XML Block lt BLC version 1 0 xmIins http Awww hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt BLCMode gt lt opt xs string UP DOWN LEFT RIGHT CENTER MULTI AREA Region gt lt BLCLevel gt lt opt xs integer 0 100 gt lt BLCLevel gt lt BLCRegionList gt lt dep gt lt BLCRegion gt lt id gt lt req integer gt lt id gt lt RegionCoordinatesList gt lt BLCRegion gt lt BLCRegionList gt lt BLC gt 8 14 12 Image channels lt ID gt Imageenhancement Image channels lt ID gt Imageenhancement General Resource v1 0 2009 2014 by HIKVISION All rights reserved 131 HIKVISION It is used to get the ImageEnhancement s configuration of a specified Description image channel Query None Inbound Data None Success Return ImageEnhancement It is used to configure the ImageEnhancement s configuration of a Description GEN specified image channel Query None Inbound Data ImageEnhancement Success Return ResponseStaus ResponseStatus Notes Imageenhancement XML Block lt ImageEnhancement version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt ImageEnhancementLevel gt lt opt xs integer gt lt ImageEnhancement gt 8 14 13 Image channels lt ID gt IrcutFilterExt Image chann
99. eeceseceteeeesceeeeeeeeeaeeeeaeeeeees 129 8 14 9 Image channels lt ID gt proportionalan ee eeceseeeeteeeeseeeeeeeeeeeeeeeees 129 8 14 10 Image channels lt ID gt WDREXE AAA 130 8 14 11 Image channels lt ID gt BLC sais cscssrsorasscoeindtasinnnarscaemlensanaaeesamanebilninenranes 131 8 14 12 Imagoeichannelsi W Jmageenbancement 131 8 14 13 Image channels lt ID gt IrcutFilterEXxt 2 eee eseeeeceeeeeeeeeeceeeeeeneeeeaeeeeees 132 8 14 14 Imageichannelsi JD Nosisebieducetxt eee eeeecceeeseseeeeeeeeeteeseeeeeees 133 8 14 15 Image Channels lt IDs DSS sscsunscesscansesnorsnsnvnidiacisvnesannsantonnvednonarnedibuieaens 134 8 14 16 Image channels lt ID gt WhiteBlance AA 135 8 14 17 Image channels lt ID gt ExpoSure sssssesesssesesessresestsrsserrsrsreresesrsresesesns 135 8 14 18 Imageichannels JD JGhartpness ENEE 136 8 14 19 Image channels lt ID gt ITiS 2 ee eeeeseeeeseteeceseeeeseeeceseeeeaeeeeaeeeeeeneeeeaeereees 136 8 14 20 Image channels lt ID gt Shutter isvccscstssaswnsasacsssteranswencvanenssnvannvncivotersvevensnents 137 8 14 21 Image channeles lt D gt Gain wisscssscicsnntsrscsssvansssenssraduentorstvartsnadsuseavsianncannes 138 8 14 22 Image channeles lt ID gt GaMAaCOrrection ceeseeeeeeeeeeeeeseseeeeteeeees 138 8 14 23 Imagoeichannelsi WD poowerl metreouencn 139 8 14 24 Image channels lt ID gt COlOr EEN 140 8 14 25 Image channels lt ID gt SCeNe EEN 140 8 14 26 Imageichannelei WD ERT 141 8 14 27 Im
100. elete the list of event triggers Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 2009 2014 by HIKVISION All rights reserved 82 HIKVISION Event triggering defines how the device reacts to particular events such as video loss or motion detection EventTriggerList XML Block lt EventTriggerList version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt EventTrigger gt lt opt gt lt EventTriggerList gt 8 11 2 Trigger Event triggers D General Resource v1 0 Description It is used to get a particular event trigger configuration Query None Inbound Data None Success Return EventTrigger Description It is used to update a particular event trigger configuration Query None Inbound Data EventTrigger Success Return hik ResponseStaus ResponseStatus Description It is used to delete a particular event trigger Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes An event trigger determines how the device reacts when a particular event is detected The following types are supported IO trigger when an input IO port changes state VMD trigger on video motion detection Video loss trigger when the input video signal cannot be detected Shelter alarm trigger when shelter is set The ID in the URI is the sequence number of a trigger the max value of lt id gt is depend on device The first trig
101. els lt ID gt IrcutFilterExt General Resource v1 5 9 It is used to get the IrcutFilter s configuration of a specified image Description channel Query None Inbound Data None Success Return IrcutFilterExt It is used to configure the IrcutFilter s configuration of a specified Description image channel Query None Inbound Data IrcutFilterExt Success Return hik ResponseStaus ResponseStatus Notes IrcutFilter XML Block lt IrcutFilterExt version PO xmIns http www hikvision com ver10 XMLSchema gt lt IrcutFilterType gt lt opt xs string auto day night schedule eventTrigger gt lt IrcutFilterType gt 2009 2014 by HIKVISION All rights reserved 132 HIKVISION lt day ToNightFilterLevel gt lt opt xs string low normal high gt lt dayToNightFilterLevel gt lt day ToNightFilterTime gt lt opt xs integer gt lt dayToNightFilterTime gt lt nightToDayFilterLevel gt lt opt xs string low normal high gt lt nightToDayFilterLevel gt lt nightToDayFilterTime gt lt opt xs integer gt lt nightToDayFilterTime gt lt Schedule gt lt dep gt lt scheduleType gt lt req xs string day night gt lt scheduleType gt lt TimeRange gt lt req gt lt beginTime gt lt req xs time ISO8601 time gt lt beginTime gt lt endTime gt lt req xs time ISO8601 time gt lt endTime gt lt TimeRange gt
102. ema as defined in Annex Any resources can specify separate input and output XML Documents If a specific data 2009 2014 by HIKVISION All rights reserved HIKVISION structure is defined inside these documents then they must be specified as XML Schema Documents xsd in Annex Lists contained in XML blocks will be represented in the format of lt XXXList gt and each lt XXXList gt tag may contain one or more nodes 4 3 Resources overview Three kinds of resources are defined in this specification They are Special Resources Services and General Resources Related General Resources are grouped by Services Services and General Resources contain Special Resources Figure 1 shows their relationship Services A General Resources Special Resources Special Resources Figure 1 The index indexr description and capabilities are defined as Special Resources in this specification Both index and description will be mandatorily included by each node and both indexr and capabilities will be optionally included by each node For more detailed description see Section 6 Services defined in this specification are divided into different services categories Each category has its own name spaces see Section 4 6 for the name space definitions The following services are defined Tabl
103. eo management systems servers are IP media devices This specification also contains full XML schema for the introduced resources 4 1 REST and HTTP Methods The following table shows how HTTP verbs are typically used to implement a web service based on REST architecture Table 1 Resource GET PUT POST DELETE Collection URI such as List the Meaning defined Create a new Meaning http webServer resour members of as replace the entry in the defined ces collection entire collection collection where as delete complete with with another the ID is assigned the entire their member collection automatically by collection URIs for the collection The further ID created is navigation usually included as part of the data returned by this operation Member URI such as Retrieve a Update the Treat the Delete http webServer resour representation addressed member addressed the ces 7416 of the of the collection or member as a addresse addressed create it with the collection in its d member member of the specified ID own right and of the collection create a new collection expressed in subordinate of it an appropriate MIME type 4 2 XML A device must support the syntax defined by W3C XML 1 0 specification 2 and UTF 8 character set 3 All XML files must adopt UTF 8 encoding according to RFC3629 Additionally all resources share a common XML sch
104. eq xs integer gt lt id gt lt triggering gt lt req xs string high low gt lt triggering gt lt lOInputPort gt 8 3 4Input status O inputs ID status General Resource v1 0 Description It is used to get the status of a particular input port Query None Inbound Data None Success Return lOPortStatus Notes See lO status for an explanation of the fields 8 3 5Outputs O outputs General Resource v1 0 Description It is used to get the output ports information Query None Inbound Data None 2009 2014 by HIKVISION All rights reserved 44 HIKVISION Success Return 1OOutputPortList Notes IO outputs are hardwired meaning that the outputs are statically allocated by the device and cannot be created or deleted l1OOutputPortList XML Block lt lOOutputPortList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt lOOutputPort gt lt opt gt lt IOOutputPort gt 8 3 6Output NO outputs D General Resource v1 0 Description It is used to get particular output port information Query None Inbound Data None Success Return OOutputPort Description It is used to update particular output port information Query None Inbound Data l OOutputPort Success Return hik ResponseStaus ResponseStatus Notes lt PowerOnState gt defines the output port configuration when the device is powered on lt defaultState gt is the default output port s
105. g ID order TextOverlayList XML Block lt TextOverlayList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt TextOverlay gt lt opt gt lt TextOverlayList gt 8 4 5Input channel overlay text Video inputs channels D overlays text D General Resource v1 0 Description It is used to get a particular text overlay configuration for a video input 2009 2014 by HIKVISION All rights reserved 49 HIKVISION channel Query None Inbound Data None Success Return TextOverlay It is used to update a particular text overlay configuration for a video Description i input channel Query None Inbound Data TextOverlay Success Return hik ResponseStaus ResponseStatus It is used to delete a particular text overlay configuration for a video Description i input channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes lt posY gt value is a multiple of 16 TextOverlay XML Block lt TextOverlay version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer 1 4 gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt posX gt lt req xs integer gt lt posX gt lt posY gt lt req xs integer gt lt posY gt lt message gt lt req xs string gt lt message gt lt TextOverlay gt 8 4 6Input channel channelNameOverla
106. ger id is 1 lt inputlOPortID gt is only required if lt eventType gt is IO The trigger ID in URL is defined as 1 to N are assigned for alarm input port 1 to N N 1 is assigned for VMD event 2009 2014 by HIKVISION All rights reserved 83 HIKVISION N 2 is assigned for video loss event N 3 is assigned for Shelter alarm event Example For an IPC that with three alarm input ports trigger 1 is alarm input 1 trigger 3 is for alarm input 3 trigger 4 is for VMD trigger 5 is for Video loss trigger 6 is for shelter alarm EventTriggerList XML Block lt EventTrigger version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt eventlype gt lt req xs string IO VMD videoloss shelteralarm gt lt eventType gt lt eventDescription gt lt ro req xs string gt lt eventDescription gt lt inputlOPortID gt lt ro req xs string gt lt inputlOPortID gt lt EventTriggerNotificationList gt lt req gt lt EventTrigger gt 8 11 3 Trigger notifications Event triggers D notifications General Resource v1 0 It is used to get the list of notification methods and behaviors for an Description event trigger Query None Inbound Data None Success Return EventTriggerNotificationList PUTO Operator Description It is used to update the list of notification methods and behaviors for an event trigger
107. he NTP server NTPServer XML Block lt NTPServer version 1 0 xmins http www hikvision com ver1 0 XMLSchema gt lt id gt lt req xs integer 1 gt lt id gt lt addressingFormatType gt lt xs string ipaddress hostname gt 2009 2014 by HIKVISION All rights reserved 26 HIKVISION lt addressingFormatType gt lt hostName gt lt dep xs string gt lt hostName gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt portNo gt lt ro opt xs integer gt lt portNo gt lt NTPServer gt 8 1 12 Log System logging General Resource v1 0 Description It is used to get the log information of the device major Type minor Type Quer EC startTime stopTime Inbound Data None Success Return LogList Notes The value of major Type is 0x1 Alarm Ox2 Exception 0x3 Operation When the value of major Type is 0x1 the value of minor Type is 0x1 alarm input 0x2 alarm output 0x3 motion detection alarm start 0x4 motion detection alarm stop 0x5 shelter alarm start Ox6 shelter alarm stop When the value of major Type is 0x2 the value of minor Type is 0x21 video loss 0x22 illegal access 0x23 hard disk full 0x24 hard disk error 0x25 modem off line 0x26 ip address conflict 0x27 network not connected When the value of major Type is 0x3 the value of minor Type is
108. he device Query None Inbound Data None Success Return PTZChannel It is used to update a particular PTZ channel configuration for the Description i device Query None Inbound Data PTZChannel Success Return hik ResponseStaus ResponseStatus DELETE Operator Description It is used to delete a particular PTZ channel for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes lt videolnputID gt links the PTZ channel to a video channel lt controlProtocol gt indicates the control protocol to be used for PTZ PTZChannel XML Block lt PTZChannel version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt videolnputID gt lt req xs integer gt lt videolnputID gt lt controlProtocol gt lt req xs string gt lt controlProtocol gt lt controlAddress gt lt req xs integer gt lt controlAddress gt lt PresetIDList gt lt opt gt lt PresetID gt lt opt gt lt id gt lt ro req xs integer 1 128 gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt PresetID gt lt PresetIDList gt lt PatrollIDList gt lt opt gt lt PatrolID gt lt opt gt lt id gt lt ro req xs integer 1 16 gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt 2009 2014 by HIKVISIO
109. i e firmware upgrade import configuration etc will use PUT operation The content of the data will be stored in the body of the HTTP request If successful the result will be returned an XML response with status code OK A separate status code is used for unsuccessful operations This XML format is defined according to XML Response Schema see section 4 5 5 for details Data receiving resources i e export configuration file use GET operation If successful the result will be returned the data according to the resource description An XML block is used for unsuccessful operations This XML format is defined according to XML Response Schema see section 4 5 5 for details For Special Resources GET operation will be used For more detailed description see Section 6 If there is an XML block for the HTTP request or response the Content Type and Content Length will be set in the headers of the HTTP message 4 5 5Error Handling As with any other protocol errors may occur during communications protocol or message processing and the specification classifies error handling into categories below Protocol Errors which are result of an incorrectly formed protocol message Protocol Errors may contain header value or be received in an not expected or experience a socket timeout To indicate and interpret protocol error HTTP protocol has defined a set of standard status codes e g 1xx 2xx 3xx 4xx 5xx According
110. ignal when it is not being triggered lt outputState gt is the output port signal when it is being triggered Pulse will cause the output port to send a signal opposite of the lt defaultState gt for a duration specified by the lt pulseDuration gt tag lt pulseDuration gt is the duration of a output port signal when it is being triggered It must be provided if the lt outputState gt is pulse lOOutputPort XML Block lt lOOutputPort version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt id gt lt req xs integer 2 gt lt id gt lt PowerOnState gt lt req gt lt defaultState gt lt ro req xs string high low gt lt defaultState gt lt outputState gt lt ro req xs string high low pulse gt lt outputState gt lt pulseDuration gt lt dep xs integer milliseconds gt lt pulseDuration gt lt PowerOnState gt 2009 2014 by HIKVISION All rights reserved 45 HIKVISION lt IOOutputPort gt 8 3 7Output status O outputs D status General Resource v1 0 Description It is used to get the status of a particular output port Query None Inbound Data None Success Return 10PortStatus Notes See lO status for an explanation of the fields 8 3 8Output trigger O outputs D trigger General Resource v1 0 Description It is used to manually trigger a particular output port Query None Inbound Data lOP
111. in both directions It needs to explain the unit of time in notes Service Image channels lt ID gt WDR has been replaced by Image channels lt ID gt WDRExt The new service adopt lt mode gt tag support a level and can by extended by other level Comments were added on the service Image channels lt ID gt HLC All sub branches were list in the service Image channels Added Id to the NFS xml block 2012 03 2009 2014 by HIKVISION All rights reserved HIKVISION Added lt exposureMode gt tag and lt WDREnabled gt tag to the service video PTZ were extended to HIKCGI Added FTP HTTP and PTZ to Linking Method Added lt enabled gt tag lt privacymaskName gt tag and lt maskType gt tag to service Video inputs channels D privacyMask regions D Service System Storage volumes ID URL was revised as System Storage volumes ID Format IR was reached agreement No index was used in tag lt ZoomLimitRatio gt The new lt mode gt tag in service Image channels lt ID gt WDRExt was optional Add MULTI AREA option to the tag lt BLCMode gt in service Image channels lt ID gt BLS New service Image channels lt ID gt HLC is defined New service Image channels lt ID gt ChromaSuppress is defined New service Image channels lt ID gt ZoomLimit is defined New service Image channels lt ID gt ExpComp is defined Delete PSIA Custom HIK PTZ channels ID patterns PSIA Cus
112. ist gt lt EventSchedule gt 8 11 7 Notification Event notification General Resource v1 0 Description It is used to get event notifications configuration Query None Inbound Data None Success Return EventNotificationMethods Description It is used to update event notifications configuration Query None Inbound Data EventNotificationMethods Success Return hik ResponseStaus ResponseStatus Notes E mail notification type is supported E mail a mail with relevant information is sent in an e mail to a list of servers EventNotificationMethods XML Block lt EventNotificationMethods version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt MailingNotificationList gt lt opt gt 2009 2014 by HIKVISION All rights reserved 88 HIKVISION lt EmailFormat gt lt opt gt lt senderEmailAddress gt lt req xs string gt lt senderEmailAddress gt lt receiverEmailAddress gt lt req xs string gt lt receiverEmailAddress gt lt EmailFormat gt lt EvenNotificationMethods gt 8 11 8 Mails notification Event notification mailing General Resource v1 0 Description It is used to get the list of E mail notifications Query None Inbound Data None Success Return MailingNotificationList Description It is used to update the list of E mail notifications Query None Inbound Data MailingNotificationList Success Return hik ResponseSta
113. ive After the signal detection stops for input port 1 the device will wait some seconds before starting to detect the signal again for this port PUT Event triggers HTTP 1 1 Content Type application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt EventTrigger version 1 0 xmins http Awww hikvision com ver1 0 KMLSchema gt lt id gt 1 lt id gt lt eventType IO gt lt EventTriggerNotificationList gt lt EventTriggerNotification gt lt id gt 1 lt id gt lt notificationMethod email gt lt EventTriggerNotification gt lt EventTriggerNotification gt lt id gt 2 lt id gt lt notificationMethod IO gt lt EventTriggerNotification gt lt EventTriggerNotificationList gt lt EventTrigger gt Example Schedule event detection and triggering The command below schedules event detection and triggering from 7 00 am to 5 00 pm every Tuesday PUT Event schedule HTTP 1 1 Content Type application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt EventSchedule version 1 0 xmIns http www hikvision com ver1 0 XMLSchema gt lt TimeBlockList gt lt TimeBlock gt lt dayOfWeek gt 2 lt dayOfWeek gt lt TimeRange gt lt beginTime gt 07 00 00 lt beginTime gt lt endTime gt 17 00 00 lt endTime gt lt TimeRange gt lt TimeBlock gt lt Tim
114. k interface card The following speed mode are supported 10M half duplex 10M duplex 100M half duplex 100M duplex auto NFS XML Block lt Adapter version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt description gt lt ro req xs string gt lt description gt lt mode gt lt req xs string gt lt mode gt lt Adapter gt 8 2 13 Examples Example Getting the Network Settings GET Network interfaces HTTP 1 1 HTTP 1 1 200 OK Content Type application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt NetworkinterfaceList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt NetworkInterface gt lt id gt 1 lt id gt lt IPAddress gt lt ipVersion gt v4 lt ipVersion gt lt addressing Type gt static lt addressing Type gt lt ipAddress gt 172 6 64 7 lt ipAddress gt lt subnetMask gt 255 255 255 0 lt subnetMask gt lt DefaultGateway gt 2009 2014 by HIKVISION All rights reserved 40 HIKVISION Example Setting the IP Address 2009 2014 by HIKVISION All rights reserved 41 HIKVISION lt PrimaryDNS gt lt ipAddress gt 192 0 0 200 lt ipAddress gt lt PrimaryDNS gt lt IPAddress gt HTTP 1 1 200 OK Content Type application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt ResponseStat
115. l Query None Inbound Data None Success Return Lenslnitialization Description It is used to update focus parameters of a specified image channel Query None Inbound Data Lenslnitialization Success Return hik ResponseStaus ResponseStatus Notes LensInitialization XML Block lt Lenslnitialization version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt Lenslnitialization gt 8 14 7 Image channels lt ID gt ImageFlip Image channels lt ID gt ImageFlip General Resource v1 0 Description It is used to get the mirror status of a specified image channel Query None Inbound Data None Success Return ImageFlip Description It is used to update mirror status of a specified image channel Query None 2009 2014 by HIKVISION All rights reserved 128 HIKVISION Inbound Data ImageFlip Success Return ResponseStaus ResponseStatus Notes ImageFlipStyle is enabled only when enabled value is true ImageFlip XML Block lt ImageFlip version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt ImageFlipStyle gt lt opt xs string LEFTRIGHT UPDOWN CENTER gt lt ImageFlip gt 8 14 8 Image channels lt ID gt ImageFreeze Image channels lt ID gt ImageFreeze General Resource v1 0 Description It is used to get ImageFreeze status of a specified Image channel
116. l eebe ere Eet Cette steriyel etiam a a Eo e a 48 8 4 4 Input Channel overlay texts 0 eee eesceeeseeeeceeeeeseeeeseseeeeeeeeeaeeetaeeeeeeeeees 49 8 4 5 Input channel overlay Text 49 8 4 6 Input channel channelNameOverlay s ssssesssssessessssesrssesresessesrssesresrsses 50 8 4 7 Input Channel privacvhMaek A 51 8 4 8 Input channel privacyMask regions ee eeeeeceseeeeseeeeceeeeesceeeeeeeeeeeeees 52 8 4 9 Input channel privacyMask region ou eeecesceceteeeeseeeeceseeeeseeeeaeeeteeeeees 53 8 4 10 Input channel shelterAlarm AA 54 8 4 11 Input channel shelterAlarM regions ce eeeeeeeseeeeseeeeceeeeeseeeeseeeeeeaeees 55 8 4 12 Input channel shelterAlarM region ce eeeeseeceteeseseeeeceeeeeseeeeeeeeeeeeeees 56 8 4 13 Input channel OSdDatetiMe 0 0 ee ee eeceeeseeseeeteeceseeeesceeeeeseeeesceetaeeeeeeneees 57 PUI EE 58 8 5 1 Kb 58 8 5 2 e E 58 TWO Way aUdiO nsima eini arii an i nn EENAA TIAA AANEREN INTES 59 8 6 1 CDCI E 59 I 8 7 8 8 8 9 HIKVISION CN EH 60 8 63 ee E EE 60 8 64 Receive EC 60 EE 61 8 7 1 NC 61 8 7 2 RO dE Eed Seed Eed eegen End Eed 61 873 OUTING EE 62 8 7 4 Transparent Channel open 63 8 7 5 Transparent Channel close 63 8 7 6 Transparent channel Send data 64 8 7 7 Transparent channel receive datz 64 ee aoaaa nisau naa aE EAA Ra SEES E AEA aE AS SE Ea EEE EAA 65 8 8 1 USES inion a nE E EE TE EE E E E EEE EEE ESERE E Teens 65 8 8 2 Heer sett aaa EEN 66 88 37 AdMINAC
117. l ports ID General Resource v1 0 2009 2014 by HIKVISION All rights reserved 61 HIKVISION GET Viewer WS It is used to get the configuration of a serial port supported by the Description device Query None Inbound Data None Success Return SerialPort It is used to update the configuration of a serial port supported by the Description device Query None Inbound Data SerialPort Success Return hik ResponseStaus ResponseStatus Notes lt serialPortType gt set the type of port RS232 RS485 When lt id gt value is 1 lt serialPortType gt value is RS485 When lt id gt value is 3 lt serialPortType gt value is RS232 lt serialPortType gt value can not set directly SerialPort XML Block lt SerialPort version 1 0 xmIns http www hikvision com ver1 0 XMLSchema gt lt id gt lt req xs integer 1 3 gt lt id gt lt enabled gt lt ro req xs boolean gt lt enabled gt lt serialPortType gt lt req xs string RS485 RS232 gt lt serialPortType gt lt baudRate gt lt req xs integer gt lt baudRate gt lt dataBits gt lt req xs integer gt lt dataBits gt lt parityType gt lt req xs string none even odd gt lt parityType gt lt stopBits gt lt req xs string 1 1 5 2 gt lt stopBits gt lt SerialPort gt 8 7 3Command Serial ports D command General Resource v1 0 Descrip
118. leted VideolnputChannelList XML Block lt VideolnputChannelList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt VideolnputChannel gt lt opt gt lt VideolnputChannelList gt 2009 2014 by HIKVISION All rights reserved 47 HIKVISION 8 4 3Input channel Video inputs channels D General Resource v1 0 It is used to get a particular video input channel configuration on an a de IP media device Query None Inbound Data None Success Return VideolnputChannel It is used to update a particular video input channel configuration on GE an IP media device Query None Inbound Data VideolnputChannel Success Return hik ResponseStaus ResponseStatus Notes lt powerLineFrequencyMode gt is used to adjust correct video image based on different power frequencies lt whiteBalanceMode gt indicates the white balance operational mode lt gainLevel gt indicates the gain level percentage value 0 is low gain 100 is high gain VideolnputChannel XML Block lt VideolnputChannel version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt powerLineFrequencyMode gt lt opt xs string 50hz 60hz gt lt powerLineFrequencyMode gt lt whiteBalanceMode gt lt opt xs string manual auto indoor incandescent gt lt whiteBalanceMode gt lt gainLevel gt lt opt xs in
119. list of tasks of one day Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Tasks based on a schedule consist of time blocks ad tasked This task is enabled always lt TimeTaskBlock gt get all the time span and tasks of one day lt dayOfWeek gt specify the day of a week ranging from 1 to 7 lt TimeTaskRange gt time span of each task Up to ten time spans and 10 tasks are supported in one day lt beginDateTime gt specify the begin time of each task ranig from 0 0 0 23 59 00 format is consistent to ISO 8601 lt endDateTime gt specify the end time of each task ranig from 0 0 0 23 59 00 format is consistent to ISO 8601 endDateTime should be larger than or equal to beginDateTime lt TaskType gt Tasks type lt TaskNum gt Tasks number Enabled when park action is patrol pattern preset or auxoutput otherwise the value is 0 TimeTaskBlock XML Block lt TimeTaskBlock version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt dayOfWeek gt lt req xs integer SO8601 weekday number 1 Monday gt lt dayOfWeek gt lt TimeTaskRange gt lt TaskID gt lt req xs string id gt lt TaskID gt 2009 2014 by HIKVISION All rights reserved 122 HIKVISION lt beginTime gt lt req xs time ISO8601 time gt lt beginTime gt lt endTime gt lt req xs time ISO8601 time gt lt endTime gt lt Task gt lt TaskType gt
120. lizer configuration of a Description bere specified image channel Query None Inbound Data None Success Return EIS It is used to set the the electronic image stabilizer configuration of a Description ean specified image channel Query None Inbound Data EIS Success Return hik ResponseStaus ResponseStatus Notes EIS XML Block lt EIS version 1 5 9 xmIns http Awww hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt ElSLevel gt lt opt xs integer 0 100 gt lt ElSLevel gt lt EIS gt 8 14 29 Image channels lt ID gt HLC Image channels lt ID gt HLC General Resource v1 0 It is used to get the high light compensation configuration of a specified image channel Query None Description 2009 2014 by HIKVISION All rights reserved 142 HIKVISION Inbound Data None Success Return HLC It is used to set the high light compensation configuration of a Description ee specified image channe Query None Inbound Data HLC Success Return hik ResponseStaus ResponseStatus Notes HLC XML Block lt HLC version 1 5 9 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt HLCLevel gt lt opt xs integer 0 100 gt lt HLCLevel gt lt HLC gt 8 14 30 Image channels lt ID gt ChromaSuppress Image channels lt ID gt Chroma
121. ll rights reserved 38 HIKVISION lt NFSList version 1 0 xmIns http Awww hikvision com ver10 XMLSchema gt lt NFS gt lt NFSList gt 8 2 11 NFS Network interfaces D NFSList ID General Resource v1 0 Description Query Inbound Data Success Return It is used to get the NFS configuration of a particular network interface None None NFS Description Query Inbound Data Success Return Notes NFS XML Block It is used to update the NFS configuration of a particular network interface None NFS hik ResponseStaus ResponseStatus lt NFS version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt NFSIPAddress gt lt req xs string gt lt NFSIPAddress gt lt NFSDirectory gt lt req xs string gt lt NFSDirectory gt lt NFS gt 8 2 12 Adapter Network interfaces D Adapter General Resource v1 0 Description Query Inbound Data Success Return It is used to get the adapter configuration of a particular network interface None None Adapter Description It is used to update the adapter configuration of a particular network 2009 2014 by HIKVISION All rights reserved 39 HIKVISION interface Query None Inbound Data Adapter Success Return hik ResponseStaus ResponseStatus Notes lt mode gt identifies the transmission speed mode of networ
122. ll trigger an park action lt Action gt park action lt ActionNum gt park action number It is used when park action is patrol pattern or preset For others it is 0 ParkAction XML Block lt ParkAction version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt Parktime gt lt req xs integer seconds gt lt Parktime gt lt Action gt lt ActionType gt lt req xs strings atuoscan framescan randomscan panoramascan patrol pattern preset gt lt ActionType gt lt ActionNum gt lt req xs integer 0 255 gt lt ActionNum gt lt Action gt lt ParkAction gt 8 13 29 PTZCtrl channels lt ID gt ptzlimiteds PTZCirl channels lt ID gt ptzlimiteds General Resource v1 0 GET Menuer Description It is used to get movement limitations of PTZ channels Query None Inbound Data None Success Return PTZLimitedList Notes Description It is used to set movement limitations of PTZ channels Query None Inbound Data None Success Return PTZLimitedList Notes Description It is used to clear movement limitations of a PTZ channel 2009 2014 by HIKVISION All rights reserved 118 HIKVISION Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus PTZLimitedList XML Block lt PTZLimitedList version 1 0 xmIns http Awww hikvision com ver10 XMLSchema
123. lt PTZPatrol gt 8 12 5 Patrol keyPoints PTZ channels D patrols D keyPoints General Resource v1 0 It is used to get the list of key points of a particular patrol for a PTZ Description channel Query None Inbound Data None Success Return PatrolPointList Gre It is used to update the list of key points of a particular patrol for a Description PTZ channel Query None Inbound Data PatrolPointList Success Return hik ResponseStaus ResponseStatus POST Operator Description It is used to add a key point of a particular patrol for a PTZ channel Query None Inbound Data PatrolPoint Success Return hik ResponseStaus ResponseStatus It is used to delete the list of key points of a particular patrol for a PTZ Description channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes PatrolPointList XML Block lt PatrolPointList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt 2009 2014 by HIKVISION All rights reserved 99 HIKVISION lt PatrolPoint gt lt opt gt lt PatrolPointList gt 8 12 6 Patrol keyPoint PTZ channels D patrols D keyPoints D General Resource v1 0 It is used to get a particular key point of a particular patrol for a PTZ Description ee g Ke GE H H Channel Query None Inbound Data None Success Return PatrolPoint It is used to update a particular key point of a particular patrol fo
124. lt WPA gt block must be provided lt channel gt corresponds to an 802 11g wireless channel number or auto for autoconfiguration lt wmmeEnabled gt enables 802 11e QoS for IEEE 802 11 networks Wi Fi Multimedia lt defaultTransmitKeylndex gt indicates which encryption key is used for WEP security lt encryptionKey gt is the WEP encryption key in hexadecimal format lt sharedKey gt is the pre shared key used in WPA Wireless XML Block lt Wireless version 1 0 xmlns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt wirelessNetworkMode gt lt opt xs string infrastructure adhoc gt lt wirelessNetworkMode gt lt channel gt lt opt xs string 1 14 auto gt lt channel gt lt ssid gt lt opt xs string gt lt ssid gt lt wmmeEnabled gt lt opt xs boolean gt lt wmmEnabled gt lt WirelessSecurity gt lt opt gt lt securityMode gt lt opt xs string disable WEP WPA personal WPA2 personal WPA RADIUS WPA enterprise WPA2 enterprise gt lt securityMode gt lt WEP gt lt dep depends on lt securityMode gt gt lt authenticationType gt lt req xs string open sharedkey auto gt lt authenticationType gt lt defaultTransmitKeylndex gt lt req xs integer gt lt defaultTransmitKeylndex gt lt wepKeyLength gt lt opt xs integer 64 128 1
125. mLevel gt lt opt xs integer 0 100 gt lt digitalZoomLevel gt lt Digital gt lt PTZData gt 2009 2014 by HIKVISION All rights reserved 107 HIKVISION 8 13 10 PTZCtrl channels lt ID gt status PTZCirl channels lt ID gt status General Resource v1 0 GET Vere Description Itis used to get currently PTZ coordinate position for the device Query None Inbound Data None Success Return _PTZStatus Notes ss lt AbsoluteHigh gt is high precision positioning which is accurate to a bit after the decimal point For example elevation 900 2700 is corresponding to vertical 90 0 270 0 degree and azimuth 0 3600 is corresponding to horizontal 0 0 360 0 degree absolute Zoom is corresponding to zoom 0 0 100 0 PTZStatus XML Block lt PTZStatus version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt AbsoluteHigh gt lt elevation gt lt opt xs integer 900 2700 gt lt elevation gt lt azimuth gt lt opt xs integer 0 3600 gt lt azimuth gt lt absoluteZoom gt lt opt xs integer 0 1000 gt lt absoluteZoom gt lt AbsoluteHigh gt lt PTZStatus gt 8 13 11 PTZCtrl channels lt ID gt presets PTZCirl channels lt ID gt presets General Resource v1 0 d It is used to get preset configuration information of a particular PTZ Description channel for the device Query None Inbound Data None
126. n 1 0 2009 2014 by HIKVISION All rights reserved 56 HIKVISION xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer 1 gt lt id gt lt RegionCoordinatesList gt lt req gt lt RegionCoordinates gt lt req gt lt positionX gt lt req xs integer coordinate gt lt positionX gt lt positionY gt lt req xs integer coordinate gt lt positionY gt lt RegionCoordinates gt lt RegionCoordinatesList gt lt ShelterAlarmRegion gt 8 4 13 Input channel osdDatetime Video inputs channels D osdDatetime General Resource v1 0 Description It is used to get the OSD configuration for a video input channel Query None Inbound Data None Success Return OsdDatetime Description It is used to update the OSD configuration for a video input channel Query None Inbound Data OsdDatetime Success Return hik ResponseStaus ResponseStatus Notes lt posY gt value is a multiple of 16 lt type gt is the type of the year month day and should be 0 XXXX XX XX Y M D 1 XX XX XXXX M D Y 4 XX XX XXXX D M Y lt displayWeek gt means display the week or not lt attribute gt is the configuration of the OSD the value should be 1 transparent flash 2 transparent not flash 3 not transparent flash 4 not transparent not flash OsdDatetime XML Block lt OsdDatetime version 1 0 xmIins http www hikvision com ver
127. o move a particular PTZ channel to horizontal GE coordinate zero point position for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 8 13 5 PTZCtrl channels lt ID gt continuous PTZCtrl channels lt ID gt continuous General Resource v1 0 Description It is used to control PTZ move around and zoom for the device Query pan tilt Zoom Inbound Data PTZData Success Return hik ResponseStaus ResponseStatus Notes PTZData XML Block lt PTZData version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt pan gt lt opt xs integer 100 100 gt lt pan gt lt tilt gt lt opt xs integer 100 100 gt lt tilt gt lt zoom gt lt opt xs integer 100 100 gt lt zoom gt lt PTZData gt 8 13 6 PTZCtri channels lt ID gt momentary PTZCirl channels lt ID gt momentary General Resource v1 0 It is used to control PTZ move around and zoom in a period of time Description i for the device Query pan tilt zoom duration Inbound Data PTZData Success Return hik ResponseStaus ResponseStatus Notes 2009 2014 by HIKVISION All rights reserved 105 HIKVISION PTZData XML Block lt PTZData version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt pan gt lt opt xs integer 100 100 gt lt pan gt lt tilt gt lt opt xs integer 100 100 gt lt tilt gt lt zoom gt lt
128. on com ver10 XMLSchema gt lt lmageChannel gt lt opt gt lt ImageChannellist gt 8 14 2 Image channels lt ID gt Image channels lt ID gt General Resource v1 0 Description It is used to get a special channel Image configuration Query None Inbound Data None Success Return ImageChannel Description It is used to update Image configuration for a special channel Query None Inbound Data ImageChannel Success Return hik ResponseStaus ResponseStatus Notes ImageChannellist XML Block lt ImageChannel version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt videolnputID gt lt req xs integer gt lt videolnputID gt lt resetimage gt lt opt gt lt restorelmageparam gt lt opt gt 2009 2014 by HIKVISION All rights reserved 125 HIKVISION lt Focus gt lt opt gt lt Lenslnitialization gt lt opt gt lt ImageFilp gt lt opt gt lt ImageFreeze gt lt opt gt lt proportionalpan gt lt opt gt lt WDR gt lt opt gt lt BLC gt lt opt gt lt NoiseReduce gt lt opt gt lt ImageEnhancement gt lt opt gt lt IrcutFilter gt lt opt gt lt DSS gt lt opt gt lt WhiteBlance gt lt opt gt lt Exposure gt lt
129. one Success Return PTZPatrolList lt is used to update patrol configuration information of a particular Description PTZ channel for the device Query None Inbound Data PTZPatrolList 2009 2014 by HIKVISION All rights reserved 110 Success Return HIKVISION hik ResponseStaus ResponseStatus Description Query Inbound Data Success Return lt is used to add a patrol point configuration for a particular PTZ channel None PTZPatrol hik ResponseStaus ResponseStatus Description Query Inbound Data Success Return It is used to delete patrol configuration for a particular PTZ channel None None hik ResponseStaus ResponseStatus Notes It is similar to presets PTZPatrolList XML Block lt PTZPatrolList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt PTZPatrol gt lt opt gt lt PTZPatrolList gt 8 13 15 PTZCtrl channels lt ID gt patrols lt ID gt PTZCirl channels lt ID gt patrols lt ID gt General Resource v1 0 Description Query Inbound Data Success Return It is used to get a particular patrol route configuration of a particular PTZ channel None None PTZPatrol Description Query Inbound Data Success Return lt is used to update a particular patrol configuration of a particular PTZ channel None PTZPatrol hik ResponseStaus ResponseStatus Description Query Inbound Data Success Return lt is used to
130. onseStaus ResponseStatus Notes When lt provider gt is IPServer lt serverlPAddress gt is required When lt provider gt is DysDNS all fields are required except the lt portNo gt When lt provider gt is PeanutHall all fields are required except the lt serverlPAddress gt and lt portNo gt lt password gt is a write only field DDNS XML Block lt DDNS version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt provider gt lt req xs string IPServer DynDNS PeanutHall gt lt provider gt lt serverlPAddress gt lt dep xs string gt lt serverlPAddress gt lt portNo gt lt dep xs integer gt lt portNo gt lt domainName gt lt dep xs string gt lt domainName gt lt userName gt lt dep xs string gt lt userName gt lt password gt lt wo dep xs string gt lt password gt lt DDNS gt 8 2 10 NFSList Network interfaces D NFSList General Resource v1 0 It is used to get the configuration of NFSs for a particular network Description interface Query None Inbound Data None Success Return NFSList It is used to update the configuration of NFSs for a particular network Description i interface Query None Inbound Data NFSList Success Return hik ResponseStaus ResponseStatus Notes NFSList XML Block 2009 2014 by HIKVISION A
131. ontivavevesdvds vest e a aaa 14 EST EEN KE 15 6 3 AMINO PAU e E 15 7 Geleet ergin e E Ea R E SEEE ES 16 7 1 INO OX 5 E E A E E 16 12 MEIER Erde Eege ee Eeer EE EE eat 16 E E Een EE 17 TA Capabilities eege Eege ed 17 8 Services and General Resources sesessesesesssseseserttsesesererstsesesatesstseserersnsiseserseses 20 8 1 e EE 20 8 1 1 RECH tel unn le E 20 812 GONTIGUPALIOM GUS czech vtec eect terete vtec ac teehee hate ees 21 8 13 Factory 0 III 21 81 4 FINMWALE Upgrade sisisi eiseres a ea N e a 22 8 1 5 Beboek 200 en EE Eed a a 22 8A 6 SAUS pe A S 22 Ce Fey Vin GE 23 8 1 8 Reie Minn 24 GEN ECNN Vlait 24 8 1 10 e 25 8 111 INIDSS VEN cnnan aa a a 26 8 2 8 3 8 4 8 5 8 6 HIKVISION BTS WO TEEN 27 GER We 29 KE eiswsdcesssstecedeesdeve aricii aie aT TE E E LE OE E OEE nda 31 8 2 1 ale 31 B22 Mera Ereid e Er E ERE RE 32 8 2 9 JEC EIER aenn e e Eed EE eu 33 8 2 4 IER 33 8 2 5 Detected a EE EE 35 8 2 6 Detected E 35 8 2 DESCENTE 36 8 28 IPP POE tere Eege Eeer tee ere 37 829 e 37 8 22 10 NFSULISE ersecsaisocenreersieiissepirp een Son EEK E EE EEEE EEE i 38 8 2110 Seeerei 39 8 2 12 Ee EE 39 8 213 EXAMPIOS sieer ena E EEE 40 ET 42 8 3 1 Eeer 42 8 3 2 INDUS annnars 43 833 ETag eege 43 8 34 NPT E TEE 44 BK Eeer 44 8 3 6 COE E 45 e el 46 838 CO tigger cosciran lanterns en ones eese se aei 46 ATTEN th cbaiensat aster tututacstauseture 46 8 4 1 ll 47 84 2 lee le e 47 84 3 Joputebenpg
132. or HTTPS the default port 443 abs_path The Request URI 1 for the resources is abs_path 4 The abs_path in this specification is most often of the form Services General Resources Special Resources which is suitable for resources to update or restore device configurations ID which appears in the abs_path identifies one resource of a list resource in this specification query The query field is a string of information to be interpreted by the resource It can include some resource related parameters It must be listed in name value pair syntax p1 v1 amp p2 v2 amp amp pn vn Each resource can define a set of parameters Defining input data which is specific to the resource will be prior than query usage 4 5 Messages HTTP messages are used for communication between physical security and video management systems and IP media devices in this specification In order to configure and control the device some provisions are specified for these HTTP message 2009 2014 by HIKVISION All rights reserved 5 HIKVISION 4 5 1Connection Header Field Devices that implement HTTP 1 1 should support persistent connections in order to meet video management systems or client applications requirements that issue multiple HTTP s transactions HTTP 1 1 is implemented and utilized according to RFC 2616 in the IP devices For a video management system or client application that uses persistent connection for multiple tr
133. ormal operation i e accepting streaming request receiving configuration commands etc The get device configuration resources use GET operation After a successful GET operation the result will be returned in XML format according to the 2009 2014 by HIKVISION All rights reserved 7 HIKVISION resource description For an unsuccessful request i e users is not authenticated the result will be returned in XML format according to XML Response Schema Resources to create device configurations information will use the POST operation If there is an XML block parameter for the request the inbound XML format is defined according to a resource special XML schema The request status will be indicated by the XML response information returned from the device and can be used to indicate the status of the POST operation This XML format is defined according to XML Response Schema see section 4 5 5 for details After successfully creating the data the device returns an XML response with status code OK A separate status code is used for unsuccessful operations Resources to delete device configurations information will use the Delete operation If successful the result will be returned an XML response with status code OK Aseparate status code is used for unsuccessful operations This XML format is defined according to XML Response Schema see section 4 5 5 for details Data uploading resources
134. ortData Success Return hik ResponseStaus ResponseStatus Notes Note that the ID used here MUST correspond to the ID in lO outputs ID The IO output port is toggled to a high or low signal accordingly lOPortData XML Block lt lOPortData xmIns http www hikvision com ver10 XMLSchema gt lt outputState gt lt req xs string high low gt lt outputState gt lt IOPortData gt 8 4 Video Video Service v1 0 Notes 2009 2014 by HIKVISION All rights reserved 46 HIKVISION 8 4 1 Input Video inputs General Resource v1 0 Description It is used to get the video inputs configuration on an IP media device Query None Inbound Data None Success Return Videolnput Notes An IP media device may contain a set of video inputs These inputs are hardwired by the device meaning that the IDs can be discovered but not created or deleted Videolnput XML Block lt Videolnput version 1 0 xmins http www hikvision com ver1 0 XMLSchema gt lt VideolnputChannelList gt lt opt gt lt Videolnput gt 8 4 2Input channels Video inputs channels General Resource v1 0 It is used to get the video input channels configuration on an IP Bebe media device Query None Inbound Data None Success Return VideolnputChannelList Notes Since video input channels are resources that are defined by the hardware configuration of the device they cannot be created or de
135. pe gt lt netUser gt lt req xs string gt lt netUser gt lt hostIPAddress gt lt req xs string gt lt hostIPAddress gt lt channel gt lt req xs integer gt lt channel gt lt Log gt 2009 2014 by HIKVISION All rights reserved 28 HIKVISION lt LogList gt 8 1 13 Storage System Storage resource v1 0 Notes service of Storage 8 1 13 1 Storage volumes System Storage volumes Description It is used to get the storage volumes and files information on a device Query None Inbound Data None Success Return StorageVolumeList It is used to update the storage volumes and files configuration on a Description device Query None Inbound Data StorageVolumeList Success Return hik ResponseStaus ResponseStatus Notes Storage VolumeList XML Block lt StorageVolumeList version 1 0 xmins urn psialliance org gt lt StorageVolume gt lt ro opt gt lt StorageVolumeList gt 8 1 13 2 Storage volumes ID System Storage volumes ID Description It is used to get a special storage volume information on a device Query None Inbound Data None Success Return StorageVolume 2009 2014 by HIKVISION All rights reserved 29 HIKVISION Notes StorageVolume XML Block lt StorageVolume version 1 0 xmIns urn psialliance org gt lt id gt lt ro req xs string id gt lt id gt lt volumeName gt lt
136. perations Once given an IP address the Discovery process will be executed in UPnP networking The UPnP discovery protocol is also knows as Simple Service Discovery Protocol SSDP When a device is added to the network SSDP allow that device to announce its services to the control points on the network Similarly when a control point is added to the network SSDP allows that control point to search for relative devices on the network During the above searching or announcing process a a discovery message which contains essential device specifics or one of its services will be transfered for example device type identifier and a pointer to more detailed information After a control point has discovered a device the control point still needs more operations to request more information about the device or to interact with it An HTTP GET request for mandatory index Special Resource will return a list of the resources supported by the device Remark the index resource will only return the first level resources of a node while the indexr Special Resource will return a complete folder list in tree structure with the current resource as root folder 6 Resource Description 6 1 Resource Description Outline Each resource in this specification is defined using the following format Resource_URI Type Version Description Description of the operation Query Indicates the name value pairs p1 p2 p3 0n for the resource Inbound Data Indic
137. ponseStaus ResponseStatus Notes Note that the ID used here MUST correspond to the video input ID The interface supports grid based motion detection Grid based motion detect divides the image into a set of fixed bins that delimit the motion detection area boundaries MotionDetection XML Block lt MotionDetection version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt regionlype gt lt ro req xs string grid gt lt regionlype gt lt Grid gt lt req gt lt rowGranularity gt lt ro req xs integer gt lt rowGranularity gt lt columnGranularity gt lt ro req xs integer gt lt columnGranularity gt lt Grid gt lt MotionDetectionRegionList gt lt req gt lt MotionDetection gt 2009 2014 by HIKVISION All rights reserved 76 HIKVISION 8 10 2 Motion detection regions MotionDetection D regions General Resource v1 0 It is used to get the motion detection regions configuration for a video Description A input channel Query None Inbound Data None Success Return MotionDetectionRegionList It is used to update the motion detection regions configuration for a Ge video input channel Query None Inbound Data MotionDetectionRegionList Success Return hik ResponseStaus ResponseStatus POST Operator
138. r a Description PTZ channel Query None Inbound Data PatrolPoint Success Return hik ResponseStaus ResponseStatus ge It is used to delete a particular key point of a particular patrol for a Description PTZ channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes lt presetNo gt is Preset s series number lt speed gt is Patrol speed lt dwellTime gt is the stay time for the patrol point the unit is second PatrolPoint XML Block lt PatrolPoint version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt presetNo gt lt req xs integer gt lt presetNo gt lt speed gt lt opt xs integer gt lt speed gt lt dwellTime gt lt opt xs integer gt lt dwellTime gt lt PatrolPoint gt 2009 2014 by HIKVISION All rights reserved 100 HIKVISION 8 12 7 PTZControl PTZ channels D PTZControl General Resource v1 0 PUTO Operator Description It is used to control PTZ command presetNo Query patrolNo mode speed Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes The value of command is LIGHT Light WIPER Wiper FAN Fan HEATER Heater AUX1 auxiliary equipment 1 AUX2 auxiliary equipment 2 SET_PRESET Set preset CLE_PRESET Clear preset ZOOM_IN Zoom in the specified speed ZOOM_OUT Zoom out in the specified speed FOCUS_NEAR focu
139. rce actually lives at another location This is typically used to set up an alias 2009 2014 by HIKVISION All rights reserved 9 HIKVISION HTTP Status Codes REST Meaning GET PUT POST DELETE Header Notes The Location header contains the URI of the resource Body Notes The body may contain the new resource location 400 Bad Request The request was badly formed This is commonly used for creating or updating a resource but the data was incomplete or incorrect Header Notes The Reason Phrase sent with the HTTP status header may contain information on the error Body Notes The response may contain more information of the underlying error that occurred in addition to the Reason Phrase 401 Unauthorized The request requires user authentication to access this resource If the request contains invalid authentication data this code is sent Header Notes At least one authentication mechanism must be specified in the WWW Authenticate header The Reason Phrase sent with the HTTP status header may contain information on the error Body Notes The response may contain more information of the underlying error that occurred in addition to the Reason Phrase 403 Forbidden The request is not allowed because the server is refusing to fill the request A 2009 2014 by HIKVISION All rights reserved
140. rom the media device via HTTP or HTTPS This function does not require that a client VMS system be added as an HTTP S destination on the media device Instead the client VMS system can call this API to initialize a stream of event information from the device In other words a connection is established with the device when this function is called and stays open to constantly receive event notifications This API uses HTTP server push with the MIME type multipart mixed defined in RFC 2046 lt protocol gt is the protocol name i e HTTP or HTTPS lt channellD gt is present for video and analytics events lt activePostCount gt is the sequence number of current notification for this particular event It starts at 1 Useful for recurring notifications of an event Each event maintains a separate post count EventNotificationAlert XML Block lt EventNotificationAlert version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt portNo gt lt opt xs integer gt lt portNo gt lt protocol gt lt opt xs string gt lt protocol gt lt macAddress gt lt opt xs string MAC gt lt macAddress gt lt channellD gt lt dep xs string gt lt channellD gt lt dateTime gt lt req xs datetime gt lt dateTime gt lt activePostCount gt lt req xs integer gt lt activePostCount gt lt eventl
141. s do not contain themselves om mn 6b The requestURIs index indexr description are required 2009 2014 by HIKVISION All rights reserved 19 HIKVISION 8 Services and General Resources 8 1 System System Service v1 0 Notes 8 1 1Device Information System devicelnfo General Resource v1 0 Description It is used to get device information Query None Inbound Data None Success Return Devicelnfo Description It is used to update device information Query None Inbound Data Devicelnfo Success Return hik ResponseStaus ResponseStatus Notes Some fields are read only and may not be set If these fields are present in the inbound XML block they are ignored For the lt Devicelnfo gt uploaded to the device during a PUT operation all fields are considered optional and any fields that are not present in the inbound XML are not changed on the device This allows setting of the fields individually without having to load the entire XML block to the device lt deviceDescription gt is a description of the device as defined in RFC1213 For IPC the lt deviceDescription gt value is PCamera For IP speed Dome the lt deviceDescription gt value is PDome For DVR or DVS the lt deviceDescription gt value is DVRDVS lt deviceLocation gt is the location of the device as defined in RFC1213 lt systemContact gt is the contact information for the device as defined in RFC1213 Devicelnfo X
142. s near in the specified speed FOCUS _FAR focus far in the specified speed IRIS_OPEN IRIS is open in the specified speed IRIS_CLOSE IRIS is cloesd in the specified speed TILT_UP PTZ is tilt up in the specified speed TILT_DOWN PTZ is tilt down in the specified speed PAN_LEFT PTZ is pan left in the specified speed PAN_RIGHT PTZ is pan right in the specified speed Up LEET PTZ is up left in the specified speed UP_RIGHT PTZ is up right in the specified speed DOWN_LEFT PTZ is down left in the specified speed DOWN_RIGHT PTZ is down right in the specified speed PAN_AUTO PTZ scans pan with the specified speed MEM_PATTERN memory pattern RUN_PATTERN Start pattern PATROL patrol GOTO_PRESET Go to preset 2009 2014 by HIKVISION All rights reserved 101 HIKVISION mode value is start and stop It indicates the start or stop of some actions for PTZ or the turn on or turn off of external equipment power for PTZ The default is start In addition to the SET_PRESET CLE PRESET RUN_PATTERN and GOTO_PRESET command all commands require the mode query parameters speed range is 1 7 When the command is ZOOM_IN ZOOM_OUT FOCUS NEAR FOCUS_FAR IRIS_OPEN or IRIS_CLOSE the default is 1 When the command is TILT_UP TT DONT PAN_LEFT PAN_RIGHT UP_LEFT UP_RIGHT DOWN_LEF
143. s xs http Awww w3 org 2001 XMLSchema xmins xsi http www w3 org 2001 XMLSchema instance xmlins xlink http www w3 org 1999 xlink targetNamespace http www hikvision com ver10 XMLSchema elementFormDefault qualified gt lt xs import namespace http www w3 org 1999 xlink schemaLocation xlink xsd gt lt xs annotation gt lt xs documentation gt HIK Core XML Schema lt xs documentation gt lt xs annotation gt Ales ee cos lt Resource Types gt lt Eeer lt xs simpleType name ResourceType gt lt xs restriction base xs string gt lt xs enumeration value Special Resource gt lt xs enumeration value Service gt lt xs enumeration value General Resource gt lt xs restriction gt lt xs simpleType gt lt xs complexType name QueryParameter gt lt xs sequence gt lt xs element name name type xs string gt lt xs element name type type xs string gt lt xs element name description type xs string minOccurs 0 maxOccurs 1 gt lt xs sequence gt lt xs complexType gt 2009 2014 by HIKVISION All rights reserved 149 HIKVISION lt xs complexType name QueryParameterList gt lt xs sequence gt lt xs element name queryParameter type hik QueryParameter minOccurs 0 maxOccurs unbounded gt lt xs sequence gt lt xs complexType gt lt xs complexType name OperationPar
144. sion of the contained resource with the lowest version and all resources in the Services container must be backward compatible If any resource of a Service container can not maintain backward compatibility with previous versions a new Services version should be introduced 7 4 capabilities capabilities Special Resource v1 0 Description Describe the capabilities of the corresponding resource Query None Inbound Data None Success Return the XML Data Block resource specified Notes For the General Resource which inbound data is specified as an XML payload the Special Resource capabilities is provided for video management systems or client applications to query an IP device and understand what XML tags are supported Capabilities is essentially an XML instance of the corresponding General Resource XML Data Block Capabilities must contain the acceptable values for each attribute While XML Schema Document are also required of any XML data defined by this specification and xsd documents are capable of defining the acceptable range of values 2009 2014 by HIKVISION All rights reserved 17 HIKVISION for any attribute using a global xsd to define capacities would imply that all devices support the same options for any parameter By allowing devices to respond to the capabilities request each device can support different values for any attribute within the constraints of the schema Table 7 ae
145. ss Return hik ResponseStaus ResponseStatus Notes ShelterAlarmRegionList XML Block lt ShelterAlarmRegionList version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt sensitivityLevel gt lt req gt lt req xs string low middle high gt lt sensitivityLevel gt lt ShelterAlarmRegion gt lt opt gt lt ShelterAlarmRegionList gt 8 4 12 Input channel shelterAlarm region Video inputs channels D shelter Alarm regions ID General Resource v1 0 It is used to get a particular shelter alarm region configuration for a Description 8 video input channel Query None Inbound Data None Success Return ShelterAlarmRegion It is used to update a particular shelter alarm region configuration for Description k a video input channel Query None Inbound Data ShelterAlarmRegion Success Return hik ResponseStaus ResponseStatus It is used to delete a particular shelter alarm region configuration for a Description S A video input channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Region coordinates are dependent on video resolution Only support the rectangular region which will be drawn from four coordinates The four points is clockwise direction and the beginning point is the low left point Ordering of lt ShelterAlarmRegion gt blocks is insignificant ShelterAlarmRegion XML Block lt ShelterAlarmRegion versio
146. sts of a set of regions that are combined to grey or black out areas of a video input PrivacyMaskRegionList XML Block lt PrivacyMaskRegionList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt 2009 2014 by HIKVISION All rights reserved 52 HIKVISION lt PrivacyMaskRegion gt lt opt gt lt PrivacyMaskRegionList gt 8 4 9Input channel privacyMask region Video inputs channels D privacyMask regions ID General Resource v1 0 It is used to get a particular privacy mask region configuration for a Description j video input channel Query None Inbound Data None Success Return PrivacyMaskRegion It is used to update a particular privacy mask region configuration for Description a video input channel Query None Inbound Data PrivacyMaskRegion Success Return hik ResponseStaus ResponseStatus It is used to delete a particular privacy mask region configuration for a Description i j video input channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Region coordinates are dependent on normalized screen size For IPC and DVR the normalized screen size is 4CIF 704 576 under 50Hz or 704 480 under 60Hz For IP dome the normalized screen size is 255 255 The computer screen coordinate system is used which the origin coordinate is on top left corner the Y axis is vertical downwards the X axis horizontal rightwards
147. t auxcontrol PTZCtrl channels lt ID gt auxcontrol General Resource v1 0 It is used to get auxillary PTZ control information of a specified E PTZchannel Query command Inbound Data None Success Return PTZAuxStatus TA It is used to update auxillary PTZ control information of a specified Description PTZchannel Query command Inbound Data PTZAuxStatus Success Return hik ResponseStaus ResponseStatus Notes Auxillary PTZ functions Commands LIGHT_PWRON open light WIPER_PWRON turn on wiper FAN_PWRON turn on fun HEATER _PWRON turn on heater lt enabled gt 1 means turned on 0 means turned off PTZAuxStatus XML Block lt PTZAuxStatus version 1 0 xmlns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt PTZAuxStatus gt 8 14 Image Image Service v1 0 Notes service of camera Image 8 14 1 Image channels Image channels General Resource v1 0 2009 2014 by HIKVISION All rights reserved 124 HIKVISION Description It is used to get the list of channel Image configuration Query None Inbound Data None Success Return ImageChannellist PUTO Operator Description It is used to update Image configuration for all channels Query None Inbound Data ImageChannellist Success Return hik ResponseStaus ResponseStatus Notes ImageChannellist XML Block lt ImageChannellist version 1 0 xmIns http www hikvisi
148. t is used to delete a particular notification method and behavior for an event trigger Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes The first ID in the URI is the sequence number of a trigger the max value of lt id gt is depend on device The first trigger id is 1 The second ID in the URI is the sequence number a notification the max value of lt id gt is depend on device The first notification id is 1 lt outputlOPortID gt is only required if the lt notifiocationMethod gt is IO lt ptzAction gt is only required if the lt notifiocationMethod gt is PTZ 2009 2014 by HIKVISION All rights reserved 85 HIKVISION EventTriggerNotification XML Block lt EventTriggerNotification version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt id gt lt req xs integer gt lt id gt lt notificationMethod gt lt req xs string email O record HTT P FTP ptz gt lt notificationMetho d gt lt notificationRecurrence gt lt ro req xs string beginning gt lt notificationRecurrence gt lt outputlIOPortID gt lt ro dep xs integer gt lt outputlOPortID gt lt ptzAction gt lt dep gt lt ptzChannellD gt lt req xs string id gt lt ptzChannellD gt lt actionName gt lt req xs string preset pattern patrol gt lt actionName gt lt actionNum gt lt dep
149. tatusString error type for the not completed operation id Return the ID created by the device in POST operation 4 6 Namespaces The namespace xmins hik http Awww hikvision com ver1 0 XMLSchema is used in this specification The following namespaces are referenced by this specification 2009 2014 by HIKVISION All rights reserved 12 HIKVISION e xmins xs http www w3 org 2001 XMLSchema e x mIns xsi http Awww w3 org 2001 XMLSchema instance e xmins xlink http Awww w3 org 1999 xlink 4 7 Security User based access control is adopted in this specification Security policy configuration in this specification based on three different user levels e Administrator the privilege can access all supported resources on IP device e Operator the privilege can access some general level and higher level resources See the Resource Description of each resource for details e Viewer the privilege can only access some general level resources See the Resource Description of each resource for details In order to access all supported resources one account with Administrator privilege level must be active at all times A default user account admin is provided by all IP devices It has an Administrator user level and must not be deleted Its default password is 12345 5 Device discovery The IP devices support Universal Plug and Play UPnP technology to discovery locat
150. taus ResponseStatus POST Administrator Description It is used to add the configuration of a NTP server for the device Query None Inbound Data NTPServer Success Return hik ResponseStaus ResponseStatus 2009 2014 by HIKVISION All rights reserved 25 HIKVISION Description It is used to delete the configuration of NTP servers for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes When the lt timeMode gt is set to NTP the servers in this list are used to synchronize the device s system time NTPServerList XML Block lt NTPServerList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt NTPServer gt lt opt gt lt NTPServerList gt 8 1 11 NtpServer System time ntpServers D General Resource v1 0 Description It is used to get the configuration of a NTP server for the device Query None Inbound Data None Success Return NTPServer Description It is used to update the configuration of a NTP server for the device Query None Inbound Data NTPServer Success Return hik ResponseStaus ResponseStatus DELETE Administrator Description It is used to delete the configuration of a NTP server for the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Depending on the value of lt addressingFormatType gt either the lt hostName gt or the IP address fields will be used to locate t
151. teger 0 100 gt lt gainLevel gt lt brightnessLevel gt lt opt xs integer 0 100 gt lt brightnessLevel gt lt contrastLevel gt lt opt xs integer 0 100 gt lt contrastLevel gt lt saturationLevel gt lt opt xs integer 0 100 gt lt saturationLevel gt lt DayNightFilter gt lt opt gt lt dayNightFilterType gt lt opt xs string day night auto gt lt dayNightFilterlype gt lt DayNightFilter gt lt VideolnputChannel gt 2009 2014 by HIKVISION All rights reserved 48 HIKVISION 8 4 4Input channel overlay texts Video inputs channels D overlays text General Resource v1 0 It is used to get the text overlays configuration for a video input Description channel Query None Inbound Data None Success Return TextOverlayList It is used to update the text overlays configuration for a video input Description channel Query None Inbound Data TextOverlayList Success Return hik ResponseStaus ResponseStatus POST Operator Description It is used to add a text overlay for a video input channel Query None Inbound Data TextOverlay Success Return hik ResponseStaus ResponseStatus It is used to delete the text overlays configuration for a video input Description channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes A set of text overlays is managed They are composited over the video signal in increasin
152. th a Description i particular channel Query None Inbound Data None Success Return StreamingSessionStatusList Notes StreamingSessionStatusList XML Block lt StreamingSessionStatusList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt StreamingSessionStatus gt lt clientAddress gt lt req gt lt ipAddress gt lt req xs string gt lt ipAddress gt lt clientAddress gt lt StreamingSessionStatus gt lt StreamingSessionStatusList gt 8 9 5Picture Streaming channels D picture General Resource v1 0 Description It is used to get a snapshot of the current image videoResolutionWidth Query videoResolutionHeight snapShotIlmageType Inbound Data None Success Return Picture over HTTP Notes All devices must support lt snapShotlmageType gt of JPEG Only support the main stream channel snapshot 2009 2014 by HIKVISION All rights reserved 74 HIKVISION To determine the format of the picture returned either the parameters in lt Video gt or the query string values are used or if the Accept header field is present in the request and the server supports it the picture is returned in that format For supported values query Streaming channels D picture capabilities Examples GET Streaming channels 1 picture snapShotImageType JPEG GET Streaming channels 1 picture Accept image jpeg 8 9 6Request keyframe Streaming channels D req
153. the privacy masking configuration for a video Description input channel Query None Inbound Data PrivacyMask Success Return hik ResponseStaus ResponseStatus Notes Privacy masking can be enabled and the region list configured per channel 2009 2014 by HIKVISION All rights reserved 51 HIKVISION PrivacyMask XML Block lt PrivacyMask version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt PrivacyMaskRegionList gt lt opt gt lt PrivacyMask gt 8 4 8Input channel privacyMask regions Video inputs channels D privacyMask regions General Resource v1 0 It is used to get the privacy mask regions configuration for a video Description i input channel Query None Inbound Data None Success Return PrivacyMaskRegionList It is used to update the privacy mask regions configuration for a video Description input channel Query None Inbound Data PrivacyMaskRegionList Success Return hik ResponseStaus ResponseStatus POST Operator Description It is used to add a privacy mask region for a video input channel Query None Inbound Data PrivacyMaskRegion Success Return hik ResponseStaus ResponseStatus It is used to delete the privacy mask regions configuration for a video Description input channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Privacy masking consi
154. timeZone General Resource v1 0 Description It is used to get the device time zone information Query None Inbound Data None Success Return Time zone string Description It is used to udpate the device time zone information Query None 2009 2014 by HIKVISION All rights reserved 24 HIKVISION Inbound Data Time zone string Success Return hik ResponseStaus ResponseStatus Notes Time zones are defined by POSIX 1003 1 section 8 3 time zone notations Note that the value following the is the amount of time that must be added to the local time to result in UTC Example EST 5EDT01 00 00 M3 2 0 02 00 00 M11 1 0 02 00 00 Defines eastern standard time as EST with a GMT 5 offset Daylight savings time is called EDT is one hour later and begins on the second Sunday of March at 2am and ends on the first Sunday of November at 2am CET 1CEST01 00 00 M3 5 0 02 00 00 M10 5 0 03 00 00 Defines central European time as GMT 1 with a one hour daylight savings time CEST that starts on the last Sunday in March at 2am and ends on the last Sunday in October at 3am 8 1 10 NtpServers System time ntpServers General Resource v1 0 Description It is used to get the configuration of NTP servers for the device Query None Inbound Data None Success Return NTPServerList Description It is used to update the configuration of NTP servers for the device Query None Inbound Data NTPServerList Success Return hik ResponseS
155. tion It is used to send a command to a serial port Query chainNo Inbound Data SerialCommand or Raw Data Success Return hik ResponseStaus ResponseStatus Notes If the IP device is an analog to digital encoder and is connected to analog PTZ enabled camera s it is the device s responsibility to relay the request to the appropriate serial interface based on the lt chainNo gt tag or query string If the IP device is itself a PTZ enabled digital camera it is the device s responsibility to 2009 2014 by HIKVISION All rights reserved 62 HIKVISION address the correct serial interface for the corresponding PTZ command The serial command can either be encapsulated in the lt commands gt field in which case the data should be encoded in hexadecimal notation or the data can be uploaded directly as the HTTP payload in which case the content type should be application octet stream SerialCommand XML Block lt SerialCommand version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt chainNo gt lt req xs string gt lt chainNo gt lt command gt lt req xs string bytes in hexadecimal gt lt command gt lt SerialGommand gt 8 7 4Transparent channel open Serial ports D transChanOpen General Resource v1 0 Description It is used to open the transparent channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Only support RS485
156. tom HIK PTZ channels ID ptzlimiteds and PSIA Custom HIK PTZ channels ID timetasks in PTZ 2009 2014 by HIKVISION All rights reserved HIKVISION HIKVISION http www hikvision com COPYRIGHT Hikvision Digital Technology Co Ltd Notices The information in this documentation is subject to change without notice and does not represent any commitment on behalf of HIKVISION HIKVISION disclaims any liability whatsoever for incorrect data that may appear in this documentation The product s described in this documentation are furnished subject to a license and may only be used in accordance with the terms and conditions of such license Copyright 2009 2014 by HIKVISION All rights reserved This documentation is issued in strict confidence and is to be used only for the purposes for which it is supplied It may not be reproduced in whole or in part in any form or by any means or be used for any other purpose without prior written consent of HIKVISION and then only on the condition that this notice is included in any such reproduction No information as to the contents or subject matter of this documentation or any part thereof or arising directly or indirectly therefrom shall be given orally or in writing or shall be communicated in any manner whatsoever to any third party being an individual firm or company or any employee thereof without the prior written consent of HIKVISION Use of this product is subject
157. ts reserved 18 HIKVISION Capabilities Attribute Description Syntax Applicable XML Data Types opt all opt 1 4 6 7 def Indicates the default value of the XML element If the element has not default value this attribute should not be used Examples def 7416 def ace All data types reqReboot Indicates if configuration of this XML element requires a device reboot before taking effect If an element does not require a boot this attribute should not be used reqReboot true All data types dynamic Indicates if an XML element has dynamic capabilities dependent on other XML configuration For example if an elements data range changes based on another element s configured value this attribute must be used In this case the element s capability attributes must always reflect the current device configuration dynamic true All data types Size Indicates the maximum number of entries in an XML List This attribute is only applicable to XML list elements This attribute should not be used for any other type of element Example If a device supports 16 users the example would be lt UserList size 16 gt lt User gt lt UserList gt Only supported for list elements 1 Fixed pre defined data types do not need certain capability attributes because their formats data ranges are already defined Special Resource
158. tus Description Query Inbound Data Success Return It is used to delete a particular preset configuration information of a particular PTZ channel for the device None None hik ResponseStaus ResponseStatus 2009 2014 by HIKVISION All rights reserved 109 HIKVISION Notes lt id gt _indicates the preset number lt presetName gt indicates the preset name Enable is used to indicate whether preset have been set PUT is used to set preset and update title of new preset Enable value import to PTZPreset should be 1 when PUT PTZPreset XML Block lt PTZPreset version 1 0 xmins http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt id gt lt req xs string id gt lt id gt lt presetName gt lt req xs string gt lt presetName gt lt PTZPreset gt 8 13 13 PTZCtrl channels lt ID gt presets lt ID gt goto PTZCirl channels lt ID gt presets lt ID gt goto General Resource v1 0 It is used to move a particular PTZ channel to a ID preset position for GE the device Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 8 13 14 PTZCtrl channels lt ID gt patrols PTZCirl channels lt ID gt patrols General Resource v1 0 lt is used to get patrol configuration information of a particular PTZ Description channel for the device Query None Inbound Data N
159. uestKeyFrame General Resource v1 0 It is used to request that the device issue a key frame on a particular Description channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes The key frame that is issued should include everything necessary to initialize a video decoder i e parameter sets for H 264 8 10 Motion Detection MotionDetection Service v1 0 RW It is used to get the motion detection configuration for all video input Description channels Query None Inbound Data None Success Return MotionDetectionList Notes If motion detection is supported by the device a motion detection ID will be allocated for each video input channel ID The motion detection ID must correspond to the video input channel ID 2009 2014 by HIKVISION All rights reserved 75 HIKVISION MotionDetectionList XML Block lt MotionDetectionList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt MotionDetection gt lt opt gt lt MotionDetectionList gt 8 10 1 One channel motion detection MotionDetection D General Resource v1 0 It is used to get the motion detection configuration for a video input Description channel Query None Inbound Data None Success Return MotionDetection It is used to udpate the motion detection configuration for a video Description input channel Query None Inbound Data MotionDetection Success Return hik Res
160. uplex mode for audio transmission between the client and media device lt microphoneVolume gt Volume control percentage for device microphone lt speakerVolume gt Volume control percentage for device speaker AudioChannel XML Block lt AudioChannel version 1 0 xmIns http Awww hikvision com ver1 0 XMLSchema gt lt id gt lt req xs integer 11 12 gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt audioMode gt lt req xs string talkonly talkandlisten gt lt audioMode gt lt microphoneEnabled gt lt req xs boolean gt lt microphoneEnabled gt lt microphoneSource gt lt req xs string external gt lt microphoneSource gt lt microphoneVolume gt _ lt req xs integer 0 100 gt lt microphoneVolume gt lt speakerEnabled gt lt req xs boolean gt lt speakerEnabled gt lt speakerVolume gt lt req xs integer 0 100 gt lt speakerVolume gt lt AudioChannel gt 8 6 Two way audio TwowayAudio Service v1 0 Notes 8 6 1Open TwowayAudio open General Resource v1 0 Description It is used to open intercom Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes 2009 2014 by HIKVISION All rights reserved 59 HIKVISION 8 6 2Close TwowayAudio close General Resource v1 0 Description It is used to close intercom Query None Inbound Data None
161. us ResponseStatus Description It is used to add an E mail notification Query None Inbound Data MailingNotification Success Return hik ResponseStaus ResponseStatus Description It is used to delete the list of E mail notifications Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes When the notification is triggered an e mail with relevant information is mailed to the each of the addresses in the mailing list MailingNotificationList XML Block lt MailingNotificationList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt MailingNotification gt lt opt gt lt MailingNotificationList gt 2009 2014 by HIKVISION All rights reserved 89 HIKVISION 8 11 9 Mail notification Event notification mailing ID General Resource v1 0 Description It is used to get a particular E mail notification configuration Query None Inbound Data None Success Return MailingNotification Description It is used to update a particular E mail notification configuration Query None Inbound Data MailingNotification Success Return hik ResponseStaus ResponseStatus Description It is used to delete a particular E mail notification Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes Depending on the value of lt addressingFormatType gt either the lt hostName gt or the IP address fields will be used to locate the SMTP ser
162. us version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt requestURL gt Network interfaces 1 ipAddress lt requestURL gt lt statusCode gt 1 lt statusCode gt lt statusString gt OK lt statusString gt lt ResponseStatus gt 8 3 IO No Service v1 0 Description It is used to get the I O ports information Query None Inbound Data None Success Return IObort Let Notes The allocation of IDs between input and output ports must be unique 1OPortList XML Block lt lOPortList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt lOlInputPortList gt lt opt gt lt lOOutputPortList gt lt opt gt lt IOPortList gt 8 3 1Status NO status General Resource v1 0 Description It is used to get the status of the I O ports 2009 2014 by HIKVISION All rights reserved 42 HIKVISION Query None Inbound Data None Success Return 10PortStatusList Notes lt ioPortID gt refers to lO inputs ID or lO outputs ID The port IDs are guaranteed to be unique across input and output ports lt ioState gt indicates whether the input port is active or inactive In most applications a high signal is considered active 1OPortStatus XML Block lt lOPortStatusList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt lOPortStatus gt lt req gt lt ioPortID gt lt req xs integer 1 2 gt lt io
163. v1 0 Description It is used to get a list of tasks based on a schedule Query None Inbound Data None Success Return TimeTaskList PUTO Operator Description It is used to update a list of tasks based on a schedule Query None Inbound Data TimeTaskList Success Return hik ResponseStaus ResponseStatus Notes GET is used to get a list of tasks of a whole week 7 lt enabled gt Enable all the tasks lt Parktime gt Time span for a task to resume Description It is used to delete all lists of tasks Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus TimeTaskList XML Block lt TimeTaskList version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt Parktime gt lt req xs integer seconds gt lt Parktime gt lt TimeTaskBlock gt lt opt gt 2009 2014 by HIKVISION All rights reserved 121 HIKVISION lt TimeTaskList gt 8 13 35 PTZCtri channels lt ID gt timetasks lt ID gt PTZCtrl channels lt ID gt timetasks lt ID gt General Resource v1 0 Description It is used to get a list of tasks of one day Query None Inbound Data None Success Return TimeTaskBlock Description It is used to update a list of tasks of one day Query None Inbound Data TimeTaskBlock Success Return hik ResponseStaus ResponseStatus DELETE Operator Description It is used to delete a
164. ver lt authenticationMode gt determines the authentication requirements for sending an email from the device lt portNo gt is the port number of the SMTP server entry lt accountNames gt is the user account name for the SMTP server MailingNotification XML Block lt MailingNotification version 1 0 xmIns http www hikvision com ver1 0 XMLSchema gt lt id gt lt req xs integer 1 gt lt id gt lt authenticationMode gt lt req xs string SMTP none gt lt authenticationMode gt lt addressingFormatType gt lt req xs string ipaddress hostname gt lt addressingFormatType gt lt hostName gt lt dep xs string gt lt hostName gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt portNo gt lt ro req xs integer gt lt portNo gt lt accountName gt lt req xs string gt lt accountName gt lt password gt lt req xs string gt lt password gt lt attachmentEnable gt lt opt xs Boolean true false gt lt attachmentEnable gt 2009 2014 by HIKVISION All rights reserved 90 HIKVISION lt attachmentinterval gt lt opt xs integer gt lt attachmentInterval gt lt sslEnable gt lt opt xs Boolean true false gt lt sslEnable gt lt EmailFormatExt gt lt opt gt lt senderEmailAddress gt lt req xs string gt lt senderEmailA
165. y Video inputs channels D overlays General Resource v1 0 channelNameOverlay It is used to get a particular channel name configuration for a video Description i input channel Query None Inbound Data None Success Return channelNameOverlay 2009 2014 by HIKVISION All rights reserved 50 HIKVISION It is used to update a particular channel name configuration for a Description i i video input channel Query None Inbound Data channelNameOverlay Success Return hik ResponseStaus ResponseStatus It is used to delete a particular text overlay configuration for a video Description i input channel Query None Inbound Data None Success Return hik ResponseStaus ResponseStatus Notes lt posY gt value is a multiple of 16 channelNameOverlay XML Block lt channelNameOverlay version 1 0 xmIns urn selfextension psiaext ver1 0 xsd gt lt enabled gt lt req xs boolean gt lt enabled gt lt positionX gt lt req xs integer coordinate gt lt positionX gt lt positionY gt lt req xs integer coordinate gt lt positionY gt lt name gt lt opt xs string gt lt name gt lt channelNameOverlay gt 8 4 7Input channel privacyMask Video inputs channels D privacyMask General Resource v1 0 It is used to get the privacy masking configuration for a video input Description channel Query None Inbound Data None Success Return PrivacyMask It is used to update
166. ype gt lt req xs string IO VMD videoloss shelteralarm gt lt eventType gt lt eventState gt lt req xs string active inactive gt lt eventState gt lt eventDescription gt lt req xs string gt lt eventDescription gt lt inputlOPortID gt lt dep xs integer if lt eventType gt is IO gt lt inputlOPortID gt lt DetectionRegionList gt lt dep if lt eventType gt is VMD gt lt DetectionRegionEntry gt lt req gt lt regionID gt lt req xs string gt lt region D gt lt sensitivityLevel gt lt req xs integer 0 100 gt lt sensitivityLevel gt lt DetectionRegionEntry gt lt DetectionRegionList gt lt EventNotificationAlert gt Example The following is an example of an HTTP event stream that pushes a VMD event from video channel 1 2009 2014 by HIKVISION All rights reserved 93 HIKVISION GET Event notification alertStream HTTP 1 1 HTTP 1 1 200 OK MIME Version 1 0 Content Type multipart mixed boundary lt boundary gt lt boundary gt Content Type application xml charset UTF 8 Content Length xxx lt xml version 1 0 encoding UTF 8 gt lt EventNotificationAlert version 1 0 xmIns http www hikvision com ver10 XMLSchema gt lt ipAddress gt 172 6 64 7 lt ipAddress gt lt portNo gt 80 lt portNo gt lt protocol gt HT TP lt protocol gt lt macAddress gt 01

IP Media Device Management Protocol User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents