企业客户端与中心管理服务器协议书范本

1、 .中心管理服务器企业客户端接口说明修改人修改时间修改内容毕玮2005-6-27毕玮2005-9-6naming赵向鹏2005-11-3用户登录接口增加是否企业管理员属性赵向鹏2005-11-15用户未接受报警接口增加报警结束时间以及增加参数date指定取某一天的数据么永辉 2005-12-11:用户未接收的报警信息接口中增加录像时间2:读取设备发出的报警事件中增加录像时间么永辉2005-12-21: 读取用户未接收的报警信息中增加了关联摄像头列表2:读取设备发出的报警事件中增加了企业用户提交的报警意见信息列表赵向鹏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参数李建全2007-5-9用户登录,增加优先级朴希闯2007-7-265.1 5.2节添加是否支持预案属性刘玄勒2007-8-305.3 查询被禁用的设备赵永强2008-1-31节，用户登陆返回用户的id5.1和5.2新增版本2的协议，并增加

3、了x,y,z的属性； 增加5.4 更改用户视图的设备的属性刁良海2008-1-3登录时增加IP李占江2008-4-7用户登录指令请求时增加platformId参数，返回时增加platform信息目录1 用户登录62 用户会话心跳73 修改用户密码74 用户注销85 读取机构层次列表85.1 用户登陆后，首次读取机构层次列表（根据该用户所属机构取列表）：85.2 用户选择子机构后，读取子机构的机构层次列表：105.3 查询被禁用的设备115.4 更改用户视图的设备的属性115.5 可能出现的错误：126 读取资源详细信息126.1 读取机构详细信息126.2 读取视频输入通道详细信息146.3

4、读取视频输出通道详细信息166.4 读取输入报警通道详细信息166.5 读取输出报警通道详细信息176.6 可能出现的错误：187 读取设备所在的视频服务器上的设备列表188 取公司内（包括子机构内的）所有用户列表199 读取用户未接收的报警信息记录数目2010 读取用户未接收的报警信息2111 读取设备发出的报警事件的数目2212 读取设备发出的报警事件2313 企业客户端机构设置模块入口2414 跨平台用户查找2414.1 互连平台列表2414.2 跨平台用户查找2515 报警预案2515.1 创建预案2515.2 修改预案2615.3 删除预案2715.4 查询预案列表2715.5 查询

5、指定预案的详细信息2815.6 设置预案使用用户2915.7 用户权限查询(对于创建预案)3016 类型关系3117 异常和错误描述31说明：本文档描述 中心管理服务器（CMS） 为 企业客户端（EC） 提供的数据操作接口。CMS使用Http(s)协议、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：如果客户端在内网，IP指内网IP。加入IP是为方便电信查询哪些网段有哪些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>参数说明：bindSoftdog ：加密狗版本登录时添加参数项（可选）isAdmin 是否是企业管理员 0：否 1：是 priority 值是表示优先级的自然数

8、NEndTime 表示帐号有效截止时间，如果没有此属性，表示该帐号永久有效。platformId 用户所属平台ID（用户首次使用企业客户端登录时不发送该参数）可能出现的错误：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" />可能出现的错误：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" />可能出现的错误：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" />可能出现的错误：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.A

13、CCESS_SERVER_EXCEPTIONFailedCode.UNKNOWN_ERROR5 读取机构层次列表地理信息系统：所的设备添加三个属性：x, y, z，分别表示经度，纬度，高度。5.1 用户登陆后，首次读取机构层次列表（根据该用户所属机构取列表）：版本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="被禁用原因（数字标志，目前只

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 可能出现的错误：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：根据机构类型的不同可能会有如下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、根据视频输入通道类型的不同可能会有如下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="监视器" />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 可能出现的错误：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>可能出现的错误：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>可能出现的错误：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.UNKNOWN_ERROR9 读取用户未接收的报警信息记录数目取回用户上次登陆以来一共未确认接收的报警信息记录数目。请求

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>可能出现的错误：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是用户名称，可能会有重复可能出现的错误：FailedCode.PARAMETER_NOT_FOUNDFailedCode.USER_SESSION_NOT_FOUNDFailedCode.UNKNOWN_ERROR11 读取设备发出的报警事件的数目取回某段时间内与某个用户相关联的一个设备的报警