企業(yè)客戶端與中心管理服務器協(xié)議書范本

1、 .中心管理服務器企業(yè)客戶端接口說明修改人修改時間修改內容畢瑋2005-6-27畢瑋2005-9-6naming趙向鵬2005-11-3用戶登錄接口增加是否企業(yè)管理員屬性趙向鵬2005-11-15用戶未接受報警接口增加報警結束時間以及增加參數(shù)date指定取某一天的數(shù)據(jù)么永輝 2005-12-11:用戶未接收的報警信息接口中增加錄像時間2:讀取設備發(fā)出的報警事件中增加錄像時間么永輝2005-12-21: 讀取用戶未接收的報警信息中增加了關聯(lián)攝像頭列表2:讀取設備發(fā)出的報警事件中增加了企業(yè)用戶提交的報警意見信息列表趙向鵬2006-4-5命名信息中添加平臺id魏婕2006-4-196.2、6.3、6

2、.4、6.5、7請求url中增加naming項魏婕2006-5-12增加14在11、12中在增加deviceNaming項魏婕2006-5-12修改10、12 ，將返回的報警信息填寫完整。修改14.2，返回信息中增加organName胡志強2007-1-11增加報警預案樸希闖2007-5-2在第5章添加GIS坐標屬性樸希闖2007-5-4第一章添加date參數(shù)李建全2007-5-9用戶登錄,增加優(yōu)先級樸希闖2007-7-265.1 5.2節(jié)添加是否支持預案屬性劉玄勒2007-8-305.3 查詢被禁用的設備趙永強2008-1-31節(jié)，用戶登陸返回用戶的id5.1和5.2新增版本2的協(xié)議，并增加

3、了x,y,z的屬性； 增加5.4 更改用戶視圖的設備的屬性刁良海2008-1-3登錄時增加IP李占江2008-4-7用戶登錄指令請求時增加platformId參數(shù)，返回時增加platform信息目錄1 用戶登錄62 用戶會話心跳73 修改用戶密碼74 用戶注銷85 讀取機構層次列表85.1 用戶登陸后，首次讀取機構層次列表（根據(jù)該用戶所屬機構取列表）：85.2 用戶選擇子機構后，讀取子機構的機構層次列表：105.3 查詢被禁用的設備115.4 更改用戶視圖的設備的屬性115.5 可能出現(xiàn)的錯誤：126 讀取資源詳細信息126.1 讀取機構詳細信息126.2 讀取視頻輸入通道詳細信息146.3

4、讀取視頻輸出通道詳細信息166.4 讀取輸入報警通道詳細信息166.5 讀取輸出報警通道詳細信息176.6 可能出現(xiàn)的錯誤：187 讀取設備所在的視頻服務器上的設備列表188 取公司內（包括子機構內的）所有用戶列表199 讀取用戶未接收的報警信息記錄數(shù)目2010 讀取用戶未接收的報警信息2111 讀取設備發(fā)出的報警事件的數(shù)目2212 讀取設備發(fā)出的報警事件2313 企業(yè)客戶端機構設置模塊入口2414 跨平臺用戶查找2414.1 互連平臺列表2414.2 跨平臺用戶查找2515 報警預案2515.1 創(chuàng)建預案2515.2 修改預案2615.3 刪除預案2715.4 查詢預案列表2715.5 查詢

5、指定預案的詳細信息2815.6 設置預案使用用戶2915.7 用戶權限查詢(對于創(chuàng)建預案)3016 類型關系3117 異常和錯誤描述31說明：本文檔描述 中心管理服務器（CMS） 為 企業(yè)客戶端（EC） 提供的數(shù)據(jù)操作接口。CMS使用Http(s)協(xié)議、XML格式提供如下服務：1 用戶登錄請求URL：https:/host:port/web_xml_interface/user_logon.xml?logonName=UserLogonName&password=UserPassword&bindSoftdog=1&IP=88& platf

6、ormId=010006 IP：如果客戶端在內網(wǎng)，IP指內網(wǎng)IP。加入IP是為方便電信查詢哪些網(wǎng)段有哪些IP在使用客戶端。響應XML： <?xml version="1.0" encoding="GBK" ?> <logon_success sessionId="0000000000000000000000000000007" userId=”0000000000000000000000000000011” naming="0000000000000000000000000000001:172.16.29.

7、1:010001" isAdmin=”0” priority=”N” EndTime=”截止時間（2007-08-01 12:34:56）” ><platform id="010006" ip="11" port="8080" ssh="false/true" /></logon_success>參數(shù)說明：bindSoftdog ：加密狗版本登錄時添加參數(shù)項（可選）isAdmin 是否是企業(yè)管理員 0：否 1：是 priority 值是表示優(yōu)先級的自然數(shù)

8、NEndTime 表示帳號有效截止時間，如果沒有此屬性，表示該帳號永久有效。platformId 用戶所屬平臺ID（用戶首次使用企業(yè)客戶端登錄時不發(fā)送該參數(shù)）可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_ACCOUNT_ERRORFailedCode.USER_ACCOUNT_SUSPENDEDFailedCode.COMPANY_SUSPENDEDFailedCode.USER_SESSION_MAX_AMOUNT_EXCEEDEDFailedCode.ACCESS_SERVER_EXCEPTIONFailedCode.UNKNO

9、WN_ERROR2 用戶會話心跳請求URL：https:/host:port/web_xml_interface/user_session_heartbeat.xml?sessionId=0000000000000000000000000000007響應XML： <?xml version="1.0" encoding="GBK" ?> <heartbeat_success sessionId="0000000000000000000000000000007" />可能出現(xiàn)的錯誤：FailedCode.PARA

10、METER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.UNKNOWN_ERROR3 修改用戶密碼請求URL：https:/host:port/web_xml_interface/change_user_password.xml?sessionId=0000000000000000000000000000007&oldPassword=UserPassword&newPassword=password響應XML： <?xml version="1.0" encoding="GBK&

11、quot; ?> <change_user_passwrod_success sessionId="0000000000000000000000000000007" />可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.USER_ACCOUNT_ERRORFailedCode.PARAMETER_VALUE_INVALIDEDFailedCode.UNKNOWN_ERROR4 用戶注銷請求URL：https:/host:port/web_xml

12、_interface/user_logoff.xml?sessionId=0000000000000000000000000000007響應XML： <?xml version="1.0" encoding="GBK" ?> <logoff_success sessionId="0000000000000000000000000000007" />可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.A

13、CCESS_SERVER_EXCEPTIONFailedCode.UNKNOWN_ERROR5 讀取機構層次列表地理信息系統(tǒng)：所的設備添加三個屬性：x, y, z，分別表示經(jīng)度，緯度，高度。5.1 用戶登陸后，首次讀取機構層次列表（根據(jù)該用戶所屬機構取列表）：版本1：請求URL：https:/host:port/web_xml_interface/organ_hiberarchy_info.xml?sessionId=0000000000000000000000000000007響應XML： <?xml version="1.0" encoding="GBK

14、" ?> <organ id="0000000000000000000000000000001" name="CompanyName"> <organ id="0000000000000000000000000000002" name="DepartmentName" /> <video_input_channel id="0000000000000000000000000000001" name="camera_1" namin

15、g="0000000000000000000000000000001:0000000000000000000000000000003::010001" scheme="true"/> <video_input_channel id="0000000000000000000000000000002" name="camera_2" naming="0000000000000000000000000000002:0000000000000000000000000000003:

16、:010001" scheme="false"/> </organ>版本2：https:/host:port/web_xml_interface/organ_hiberarchy_info.xml?sessionId=0000000000000000000000000000007&version=2響應XML： <?xml version="1.0" encoding="GBK" ?> <organ id="000000000000000000000

17、0000000001" name="CompanyName" isAdmin=”true”><organ id="0000000000000000000000000000002" name="DepartmentName" isAdmin=”false” /> <organ id="0000000000000000000000000000001" name="CompanyName" isAdmin=”false”> <organ id="

18、0000000000000000000000000000002" name="DepartmentName" isAdmin=”false”/> </organ> </organ>說明：版本2返回用戶所有的可以查看的機構5.2 用戶選擇子機構后，讀取子機構的機構層次列表：版本1：請求URL：https:/host:port/web_xml_interface/organ_hiberarchy_info.xml?sessionId=0000000000000000000000000000007&organId=000000000

19、0000000000000000000002響應XML：<?xml version="1.0" encoding="GBK" ?><organ id="0000000000000000000000000000002" name="DepartmentName"><organ id="0000000000000000000000000000003" name="DepartmentName2" /><video_input_channe

20、l id="0000000000000000000000000000007" name="camera_7" naming="0000000000000000000000000000007:0000000000000000000000000000006::010001" scheme="true"/><video_output_channel id="0000000000000000000000000000003" name="monitor_3&qu

21、ot; naming="0000000000000000000000000000003:0000000000000000000000000000006::010001"/></organ>版本2：請求URL：https:/host:port/web_xml_interface/organ_hiberarchy_info.xml?sessionId=0000000000000000000000000000007&organId=0000000000000000000000000000002&version=2響應XML：

22、<?xml version="1.0" encoding="GBK" ?><organ id="0000000000000000000000000000002" name="DepartmentName"><video_input_channel id="0000000000000000000000000000007" name="camera_7" naming="0000000000000000000000000000007:000

23、0000000000000000000000000006::010001" scheme="true" x=”1200.33” y=”1100.12” z=”100.05” /><video_output_channel id="0000000000000000000000000000003" name="monitor_3" naming="0000000000000000000000000000003:0000000000000000000000000000006:172.16

24、.29.1:010001" x=”1200.33” y=”1100.12” z=”100.05”/></organ>說明：版本2只返回機構下的設備，沒有機構信息5.3 查詢被禁用的設備請求URL：https:/host:port/web_xml_interface/ get_forbid_dev_list.xml?sessionId=0000000000000000000000000000007響應XML：<?xml version="1.0" encoding="GBK" ?><organ id="

25、;0000000000000000000000000000002" name="DepartmentName"><video_input_channel id="0000000000000000000000000000007" name="camera_7" naming="0000000000000000000000000000007:0000000000000000000000000000006::010001" status="被禁用原因（數(shù)字標志，目前只

26、有被強行禁用）" organid="機構ID" organname="機構名稱"/></organ>5.4 更改用戶視圖的設備的屬性請求URL：http:/host:port/web_xml_interface/update_device_info.xml?sessionId=%s&xml=:XML：<Message><Device OrganID="" Type="" Naming="" ><Name>設備的名稱</

27、 Name ><X>1000.10</X><Y>2000.10</Y><Z>3200.20</Z></Device ></Message>響應XML：<Message><Device ID="設備編號"/><Sucess>TRUE</Success></Message>5.5 可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUN

28、DFailedCode.ORGAN_NOT_FOUNDFailedCode.UNKNOWN_ERROR6 讀取資源詳細信息6.1 讀取機構詳細信息請求URL：https:/host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=organ&resourceId=0000000000000000000000000000001響應XML：根據(jù)機構類型的不同可能會有如下2種返回結果：1） 是一個頂級機構（公司） <?xm

29、l version="1.0" encoding="GBK" ?> <company id="0000000000000000000000000000001" name="CompanyName" linkman="" email="" phone="" fax="" postalcode="" address="" note="" isSuspended=&quo

30、t;false" />2） 是一個非頂級機構（部門） <?xml version="1.0" encoding="GBK" ?> <department id="0000000000000000000000000000002" name="DepartmentName" linkman="" email="" phone="" fax="" note="" />6.2 讀取視頻

31、輸入通道詳細信息請求URL：https:/host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=video_input_channel&resourceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003::010001響應XML：

32、根據(jù)視頻輸入通道類型的不同可能會有如下4種返回結果：1） 普通攝像頭 <?xml version="1.0" encoding="GBK" ?> <general_camera_vic id="0000000000000000000000000000001" name="camera_1" installLocation="" note="" naming="0000000000000000000000000000001:0000000000000

33、000000000000000003::010001" hasPan="true" ptzDecodeType="HK" videoFormat="MPEG4" storeCycle="7" storePlanHourFlag="010100001001001010010101" frameRate="25" maxBps="0" brightness="0" contrast="0"

34、 saturation="0" hue="0" modelId="0000000000000000000000000000001" modelName="SONY" currentImageQualityLevelId="0000000000000000000000000000003" currentImageQualityLevelName="較好" />2） 矩陣攝像頭，屬性與普通攝像頭相同，將general_camera_vic 改為 matrix_vic。 &l

35、t;?xml version="1.0" encoding="GBK" ?> <matrix_vic id="0000000000000000000000000000001" />注：這個接口沒有使用。3） IpCamera攝像頭，屬性與普通攝像頭相同，general_camera_vic改為ip_camera_vic，并增加 host、port兩個屬性 <?xml version="1.0" encoding="GBK" ?> <ip_camera_vic

36、id="0000000000000000000000000000001" host="" port="12345" />4） IpCamera視頻服務器攝像頭，屬性與IpCamera攝像頭相同，將ip_camera_vic 改為ip_camera_video_server_vic。 <?xml version="1.0" encoding="GBK" ?> <ip_camera_video_server_vic id="000000000000000000000

37、0000000001" />6.3 讀取視頻輸出通道詳細信息請求URL：https:/host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=video_output_channel&resourceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000

38、000003::010001響應XML： <?xml version="1.0" encoding="GBK" ?> <video_output_channel id="0000000000000000000000000000001" name="VideoName" installLocation="" note="" naming="0000000000000000000000000000001:0000000000000

39、000000000000000005::010001" modelId="0000000000000000000000000000001" modelName="監(jiān)視器" />6.4 讀取輸入報警通道詳細信息請求URL：https:/host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=alarm_input_channel&resource

40、Id=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003::010001響應XML： <?xml version="1.0" encoding="GBK" ?> <alarm_input_channel id="0000000000000000000000000000001" name="AlarmInputChannel_

41、1" installLocation="" note="" naming="0000000000000000000000000000001:0000000000000000000000000000003::010001" typeId="0000000000000000000000000000002" typeName="門磁" />6.5 讀取輸出報警通道詳細信息請求URL：https:/host:port/web_xml_interface/resour

42、ce_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=alarm_output_channel&resourceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003::010001響應XML： <?xml version="1.0" encoding="GBK&q

43、uot; ?> <alarm_output_channel id="0000000000000000000000000000001" name="AlarmOutputChannel_1" installLocation="" note="" naming="0000000000000000000000000000001:0000000000000000000000000000003::010001" typeId="00000000000000000

44、00000000000001" typeName="燈光" isControllableByUser="true" />6.6 可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.RESOURCE_TYPE_UNKNOWNFailedCode.ORGAN_NOT_FOUNDFailedCode.VIC_NOT_FOUNDFailedCode.VOC_NOT_FOUNDFailedCode.AIC_NOT_FOUND Failed

45、Code.AOC_NOT_FOUND FailedCode.UNKNOWN_ERROR7 讀取設備所在的視頻服務器上的設備列表請求URL：https:/host:port/web_xml_interface/vis_relating_device_list.xml?sessionId=0000000000000000000000000000007&deviceType=alarm_input_channel&deviceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0

46、000000000000000000000000000003::010001注意：deviceType := video_input_channel | alarm_input_channel | alarm_output_channel響應XML： <?xml version="1.0" encoding="GBK" ?> <video_input_server id="0000000000000000000000000000003" name="terminal_1" n

47、aming="0000000000000000000000000000003::010001"> <video_input_channel id="0000000000000000000000000000001" name="camera_1" naming="0000000000000000000000000000001:0000000000000000000000000000003::010001"/> <video_input_channel

48、 id="0000000000000000000000000000002" name="camera_2" naming="0000000000000000000000000000002:0000000000000000000000000000003::010001"/> <alarm_input_channel id="0000000000000000000000000000001" name="alarm_in_1" naming="0000000

49、000000000000000000000001:0000000000000000000000000000003::010001"/> <alarm_input_channel id="0000000000000000000000000000002" name="alarm_in_2" naming="0000000000000000000000000000002:0000000000000000000000000000003::010001"/> <ala

50、rm_input_channel id="0000000000000000000000000000004" name="alarm_in_4" naming="0000000000000000000000000000004:0000000000000000000000000000003::010001"/> <alarm_output_channel id="0000000000000000000000000000001" name="alarm_out_1"

51、naming="0000000000000000000000000000001:0000000000000000000000000000003::010001"/> </video_input_server>可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.DEVICE_TYPE_UNKNOWNFailedCode.DEVICE_NOT_FOUNDFailedCode.UNKNOWN_ERROR8 取公司內（包括子機構內的

52、）所有用戶列表請求URL：https:/host:port/web_xml_interface/company_user_list.xml?sessionId=0000000000000000000000000000007響應XML： <?xml version="1.0" encoding="GBK" ?> <company id="0000000000000000000000000000001" name="CompanyName"> <user id="00000000

53、00000000000000000000001" name="用戶1" naming="0000000000000000000000000000001::010001"/> <user id="0000000000000000000000000000004" name="用戶4" naming="0000000000000000000000000000004::010001"/> <user id="0000

54、000000000000000000000000005" name="用戶5" naming="0000000000000000000000000000005::010001"/> <user id="0000000000000000000000000000006" name="用戶6" naming="0000000000000000000000000000006::010001"/> <user id="

55、0000000000000000000000000000007" name="用戶7" naming="0000000000000000000000000000007::010001"/> <user id="0000000000000000000000000000009" name="用戶9" naming="0000000000000000000000000000009::010001"/> <user id=&q

56、uot;0000000000000000000000000000002" name="用戶2" naming="0000000000000000000000000000002::010001"/> <user id="0000000000000000000000000000008" name="用戶8" naming="0000000000000000000000000000008::010001"/> <user i

57、d="0000000000000000000000000000003" name="用戶3" naming="0000000000000000000000000000003::010001"/> </company>可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.UNKNOWN_ERROR9 讀取用戶未接收的報警信息記錄數(shù)目取回用戶上次登陸以來一共未確認接收的報警信息記錄數(shù)目。請求

58、URL：https:/host:port/web_xml_interface/user_unreceived_alarm_event_listnum.xml?sessionId=0000000000000000000000000000007響應XML：<?xml version="1.0" encoding="GBK" ?><alarm_events><alarm_event _num alarmEventNum=100 /></alarm_events>可能出現(xiàn)的錯誤：FailedCode.PARAMET

59、ER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.UNKNOWN_ERROR10 讀取用戶未接收的報警信息取回用戶上次登陸以來某一天未確認接收的報警信息。請求URL：https:/host:port/web_xml_interface/user_unreceived_alarm_event_list.xml?sessionId=0000000000000000000000000000007&start=1&count=20響應XML：<?xml version="1.0" encoding=

60、"GBK" ?><alarm_events> <alarm_event> id="0000000000000000000000000000002" sourceType="video_input_channel" sourceId="0000000000000000000000000000001" sourceName="camera_1" startTime="1092347213211" endTime="1092347213211

61、" KinescopeTime ="1092347213211" AlarmOutTime="1092347213211" typeName="移動偵測報警"><video_input_ channels> <video_input_channel id="0000000000000000000000000000001" name="camera_1" RelatedPresent=”123” RelatedTrack=”123456” IsKinescope=

62、 "false" naming= ""/> <video_input_channel id="0000000000000000000000000000002" name="camera_2" RelatedPresent=”123” RelatedTrack=”123456” IsKinescope= "false" naming= ""/> </video_input_ channels> <alarm_out_list> <

63、alarm_out id="0000000000000000000000000000001" name="alarm_1" naming= ""> . <alarm_out id="0000000000000000000000000000001" name="alarm_1" naming= ""> </alarm_out_list> <reciever_explains> <reciever_explain userName=

64、"yaoyao" naming="0000000000000000000000000000003::010001" recieverExplain="同意" /> < reciever_explain userName="yaoyao1" naming="0000000000000000000000000000003::010001" recieverExplain="同意"/> </ reciever_explains > <alarm_event></alarm_events>注：userName是用戶名稱，可能會有重復可能出現(xiàn)的錯誤：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.UNKNOWN_ERROR11 讀取設備發(fā)出的報警事件的數(shù)目取回某段時間內與某個用戶相關聯(lián)的一個設備的報警