企业客户端与中心管理服务器协议.docx

中心管理服务器——企业客户端接口说明

修改人
修改时间
修改内容
毕玮
2005-6-27

毕玮
2005-9-6
naming
赵向鹏
2005-11-3
用户登录接口增加
是否企业管理员属性
赵向鹏
2005-11-15
用户未接受报警接口增加报警结束时间以及增加参数date指定取某一天的数据
么永辉
2005-12-1

1:用户未接收的报警信息接口中增加录像时间
2:读取设备发出的报警事件中增加录像时间

么永辉
2005-12-2
1: 读取用户未接收的报警信息中增加了关联摄像头列表
2:读取设备发出的报警事件中增加了企业用户提交的报警意见信息列表
赵向鹏
2006-4-5
命名信息中添加平台id
魏婕
2006-4-19
6.2、6.3、6.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-26
5.1 5.2节添加是否支持预案属性
刘玄勒
2007-8-30
5.3 查询被禁用的设备
赵永强
2008-1-3
1节，用户登陆返回用户的id
5.1和5.2新增版本2的协议，并增加了x,y,z的属性； 增加5.4 更改用户视图的设备的属性

刁良海
2008-1-3
登录时增加IP
李占江
2008-4-7
用户登录指令请求时增加platformId参数，返回时增加platform信息

目录

1 用户登录 6
2 用户会话心跳 7
3 修改用户密码 7
4 用户注销 8
5 读取机构层次列表 8
5.1 用户登陆后，首次读取机构层次列表（根据该用户所属机构取列表）： 8
5.2 用户选择子机构后，读取子机构的机构层次列表： 10
5.3 查询被禁用的设备 11
5.4 更改用户视图的设备的属性 11
5.5 可能出现的错误： 12
6 读取资源详细信息 12
6.1 读取机构详细信息 12
6.2 读取视频输入通道详细信息 14
6.3 读取视频输出通道详细信息 16
6.4 读取输入报警通道详细信息 16
6.5 读取输出报警通道详细信息 17
6.6 可能出现的错误： 18
7 读取设备所在的视频服务器上的设备列表 18
8 取公司内（包括子机构内的）所有用户列表 19
9 读取用户未接收的报警信息记录数目 20
10 读取用户未接收的报警信息 21
11 读取设备发出的报警事件的数目 22
12 读取设备发出的报警事件 23
13 企业客户端机构设置模块入口 24
14 跨平台用户查找 24
14.1 互连平台列表 24
14.2 跨平台用户查找 25
15 报警预案 25
15.1 创建预案 25
15.2 修改预案 26
15.3 删除预案 27
15.4 查询预案列表 27
15.5 查询指定预案的详细信息 28
15.6 设置预案使用用户 29
15.7 用户权限查询(对于创建预案) 30
16 类型关系 31
17 异常和错误描述 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=192.168.5.188& platformId=010006

IP：如果客户端在内网，IP指内网IP。加入IP是为方便电信查询哪些网段有哪些IP在使用客户端。
响应XML：
<?xml version="1.0" encoding="GBK" ?>
<logon_success sessionId="0000000000000000000000000000007" userId=”0000000000000000000000000000011” naming="0000000000000000000000000000001:172.16.29.1:010001" isAdmin=”0” priority=”N” EndTime=”截止时间（2007-08-01 12:34:56）” >
<platform id="010006" ip="192.168.4.111" port="8080" ssh="false/true" />
</logon_success>

参数说明：
bindSoftdog ：加密狗版本登录时添加参数项（可选）
isAdmin 是否是企业管理员 0：否 1：是
priority 值是表示优先级的自然数N
EndTime 表示帐号有效截止时间，如果没有此属性，表示该帐号永久有效。

platformId 用户所属平台ID（用户首次使用企业客户端登录时不发送该参数）

可能出现的错误：
FailedCode.PARAMETER_NOT_FOUND
FailedCode.USER_ACCOUNT_ERROR
FailedCode.USER_ACCOUNT_SUSPENDED
FailedCode.COMPANY_SUSPENDED
FailedCode.USER_SESSION_MAX_AMOUNT_EXCEEDED
FailedCode.ACCESS_SERVER_EXCEPTION
FailedCode.UNKNOWN_ERROR

2 用户会话心跳

请求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.PARAMETER_NOT_FOUND
FailedCode.USER_SESSION_NOT_FOUND
FailedCode.UNKNOWN_ERROR

3 修改用户密码

请求URL：
https://host:port/web_xml_interface/change_user_password.xml?sessionId=0000000000000000000000000000007&oldPassword=UserPassword&newPassword=password

响应XML：
<?xml version="1.0" encoding="GBK" ?>
<change_user_passwrod_success sessionId="0000000000000000000000000000007" />

可能出现的错误：
FailedCode.PARAMETER_NOT_FOUND
FailedCode.USER_SESSION_NOT_FOUND
FailedCode.USER_ACCOUNT_ERROR
FailedCode.PARAMETER_VALUE_INVALIDED
FailedCode.UNKNOWN_ERROR

4 用户注销

请求URL：
https://host:port/web_xml_interface/user_logoff.xml?sessionId=0000000000000000000000000000007

响应XML：
<?xml version="1.0" encoding="GBK" ?>
<logoff_success sessionId="0000000000000000000000000000007" />

可能出现的错误：
FailedCode.PARAMETER_NOT_FOUND
FailedCode.USER_SESSION_NOT_FOUND
FailedCode.ACCESS_SERVER_EXCEPTION
FailedCode.UNKNOWN_ERROR

5 读取机构层次列表
地理信息系统：所的设备添加三个属性：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" ?>
<organ id="0000000000000000000000000000001" name="CompanyName">
<organ id="0000000000000000000000000000002" name="DepartmentName" />
<video_input_channel id="0000000000000000000000000000001" name="camera_1" naming="0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001" scheme="true"/>
<video_input_channel id="0000000000000000000000000000002" name="camera_2" naming="0000000000000000000000000000002:0000000000000000000000000000003:172.16.29.1: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="0000000000000000000000000000001" name="CompanyName" isAdmin=”true”>
<organ id="0000000000000000000000000000002" name="DepartmentName" isAdmin=”false” />
<organ id="0000000000000000000000000000001" name="CompanyName" isAdmin=”false”>
<organ id="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=0000000000000000000000000000002

响应XML：
<?xml version="1.0" encoding="GBK" ?>
<organ id="0000000000000000000000000000002" name="DepartmentName">
<organ id="0000000000000000000000000000003" name="DepartmentName2" />
<video_input_channel id="0000000000000000000000000000007" name="camera_7" naming="0000000000000000000000000000007:0000000000000000000000000000006:172.16.29.1:010001" scheme="true"/>
<video_output_channel id="0000000000000000000000000000003" name="monitor_3" naming="0000000000000000000000000000003:0000000000000000000000000000006:172.16.29.1:010001"/>
</organ>

版本2：
请求URL：
https://host:port/web_xml_interface/organ_hiberarchy_info.xml?sessionId=0000000000000000000000000000007&organId=0000000000000000000000000000002&version=2

响应XML：
<?xml version="1.0" encoding="GBK" ?>
<organ id="0000000000000000000000000000002" name="DepartmentName">
<video_input_channel id="0000000000000000000000000000007" name="camera_7" naming="0000000000000000000000000000007:0000000000000000000000000000006:172.16.29.1: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.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="0000000000000000000000000000002" name="DepartmentName">
<video_input_channel id="0000000000000000000000000000007" name="camera_7" naming="0000000000000000000000000000007:0000000000000000000000000000006:172.16.29.1:010001" status="被禁用原因（数字标志，目前只有被强行禁用）" 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>设备的名称</ 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_FOUND
FailedCode.USER_SESSION_NOT_FOUND
FailedCode.ORGAN_NOT_FOUND
FailedCode.UNKNOWN_ERROR

6 读取资源详细信息

6.1 读取机构详细信息

请求URL：
https://host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=organ&resourceId=0000000000000000000000000000001

响应XML：
根据机构类型的不同可能会有如下2种返回结果：
1） 是一个顶级机构（公司）
<?xml version="1.0" encoding="GBK" ?>
<company
id="0000000000000000000000000000001"
name="CompanyName"
linkman=""
email=""
phone=""
fax=""
postalcode=""
address=""
note=""
isSuspended="false"
/>

2） 是一个非顶级机构（部门）
<?xml version="1.0" encoding="GBK" ?>
<department
id="0000000000000000000000000000002"
name="DepartmentName"
linkman=""
email=""
phone=""
fax=""
note=""
/>

6.2 读取视频输入通道详细信息

请求URL：
https://host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=video_input_channel&resourceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001

响应XML：
根据视频输入通道类型的不同可能会有如下4种返回结果：
1） 普通摄像头
<?xml version="1.0" encoding="GBK" ?>
<general_camera_vic id="0000000000000000000000000000001"
name="camera_1"
installLocation=""
note=""
naming="0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001"
hasPan="true"
ptzDecodeType="HK"
videoFormat="MPEG4"
storeCycle="7"
storePlanHourFlag="010100001001001010010101"
frameRate="25"
maxBps="0"
brightness="0"
contrast="0"
saturation="0"
hue="0"
modelId="0000000000000000000000000000001"
modelName="SONY"
currentImageQualityLevelId="0000000000000000000000000000003"
currentImageQualityLevelName="较好"
/>

2） 矩阵摄像头，属性与普通摄像头相同，将general_camera_vic 改为 matrix_vic。
<?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 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="0000000000000000000000000000001"
……
/>

6.3 读取视频输出通道详细信息

请求URL：
https://host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=video_output_channel&resourceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001

响应XML：
<?xml version="1.0" encoding="GBK" ?>
<video_output_channel
id="0000000000000000000000000000001"
name="VideoName"
installLocation=""
note=""
naming="0000000000000000000000000000001:0000000000000000000000000000005:172.16.29.1:010001"
modelId="0000000000000000000000000000001"
modelName="监视器"
/>

6.4 读取输入报警通道详细信息

请求URL：
https://host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=alarm_input_channel&resourceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001

响应XML：
<?xml version="1.0" encoding="GBK" ?>
<alarm_input_channel
id="0000000000000000000000000000001"
name="AlarmInputChannel_1"
installLocation=""
note=""
naming="0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001"
typeId="0000000000000000000000000000002"
typeName="门磁"
/>

6.5 读取输出报警通道详细信息

请求URL：
https://host:port/web_xml_interface/resource_detail_info.xml?sessionId=0000000000000000000000000000007&resourceType=alarm_output_channel&resourceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001

响应XML：
<?xml version="1.0" encoding="GBK" ?>
<alarm_output_channel
id="0000000000000000000000000000001"
name="AlarmOutputChannel_1"
installLocation=""
note=""
naming="0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001"
typeId="0000000000000000000000000000001"
typeName="灯光"
isControllableByUser="true"
/>

6.6 可能出现的错误：
FailedCode.PARAMETER_NOT_FOUND
FailedCode.USER_SESSION_NOT_FOUND
FailedCode.RESOURCE_TYPE_UNKNOWN
FailedCode.ORGAN_NOT_FOUND
FailedCode.VIC_NOT_FOUND
FailedCode.VOC_NOT_FOUND
FailedCode.AIC_NOT_FOUND
FailedCode.AOC_NOT_FOUND
FailedCode.UNKNOWN_ERROR

7 读取设备所在的视频服务器上的设备列表

请求URL：
https://host:port/web_xml_interface/vis_relating_device_list.xml?sessionId=0000000000000000000000000000007&deviceType=alarm_input_channel&deviceId=0000000000000000000000000000001& naming=0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1: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" naming="0000000000000000000000000000003:172.16.29.1:010001">
<video_input_channel id="0000000000000000000000000000001" name="camera_1" naming="0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001"/>
<video_input_channel id="0000000000000000000000000000002" name="camera_2" naming="0000000000000000000000000000002:0000000000000000000000000000003:172.16.29.1:010001"/>
<alarm_input_channel id="0000000000000000000000000000001" name="alarm_in_1" naming="0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001"/>
<alarm_input_channel id="0000000000000000000000000000002" name="alarm_in_2" naming="0000000000000000000000000000002:0000000000000000000000000000003:172.16.29.1:010001"/>
<alarm_input_channel id="0000000000000000000000000000004" name="alarm_in_4" naming="0000000000000000000000000000004:0000000000000000000000000000003:172.16.29.1:010001"/>
<alarm_output_channel id="0000000000000000000000000000001" name="alarm_out_1" naming="0000000000000000000000000000001:0000000000000000000000000000003:172.16.29.1:010001"/>
</video_input_server>

可能出现的错误：
FailedCode.PARAMETER_NOT_FOUND
FailedCode.USER_SESSION_NOT_FOUND
FailedCode.DEVICE_TYPE_UNKNOWN
FailedCode.DEVICE_NOT_FOUND
FailedCode.UNKNOWN_ERROR

8 取公司内（包括子机构内的）所有用户列表

请求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="0000000000000000000000000000001" name="用户1" naming="0000000000000000000000000000001:172.16.29.1:010001"/>
<user id="0000000000000000000000000000004" name="用户4" naming="0000000000000000000000000000004:172.16.29.1:010001"/>
<user id="0000000000000000000000000000005" name="用户5" naming="0000000000000000000000000000005:172.16.29.1:010001"/>
<user id="0000000000000000000000000000006" name="用户6" naming="000000000000000000000000000000