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

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

《企业客户端与中心管理服务器协议.docx》由会员分享，可在线阅读，更多相关《企业客户端与中心管理服务器协议.docx（33页珍藏版）》请在冰点文库上搜索。

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

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

修改人

修改时间

修改内容

毕玮

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.15.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：

xmlversion="1.0"encoding="GBK"?

>

172.16.29.1:

010001"isAdmin=”0”priority=”N”EndTime=”截止时间（2007-08-0112:

34:

56）”>

参数说明：

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：

xmlversion="1.0"encoding="GBK"?

>

可能出现的错误：

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：

xmlversion="1.0"encoding="GBK"?

>

可能出现的错误：

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：

xmlversion="1.0"encoding="GBK"?

>

可能出现的错误：

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：

xmlversion="1.0"encoding="GBK"?

>

0000000000000000000000000000003:

172.16.29.1:

010001"scheme="true"/>

0000000000000000000000000000003:

172.16.29.1:

010001"scheme="false"/>

版本2：

https:

//host:

port/web_xml_interface/organ_hiberarchy_info.xml?

sessionId=0000000000000000000000000000007&version=2

响应XML：

xmlversion="1.0"encoding="GBK"?

>

说明：

版本2返回用户所有的可以查看的机构

5.2用户选择子机构后，读取子机构的机构层次列表：

版本1：

请求URL：

https:

//host:

port/web_xml_interface/organ_hiberarchy_info.xml?

sessionId=0000000000000000000000000000007&organId=0000000000000000000000000000002

响应XML：

xmlversion="1.0"encoding="GBK"?

>

0000000000000000000000000000006:

172.16.29.1:

010001"scheme="true"/>

0000000000000000000000000000006:

172.16.29.1:

010001"/>

版本2：

请求URL：

https:

//host:

port/web_xml_interface/organ_hiberarchy_info.xml?

sessionId=0000000000000000000000000000007&organId=0000000000000000000000000000002&version=2

响应XML：

xmlversion="1.0"encoding="GBK"?

>

0000000000000000000000000000006:

172.16.29.1:

010001"scheme="true"x=”1200.33”y=”1100.12”z=”100.05”/>

0000000000000000000000000000006:

172.16.29.1:

010001"x=”1200.33”y=”1100.12”z=”100.05”/>

说明：

版本2只返回机构下的设备，没有机构信息

5.3查询被禁用的设备

请求URL：

https:

//host:

port/web_xml_interface/get_forbid_dev_list.xml?

sessionId=0000000000000000000000000000007

响应XML：

xmlversion="1.0"encoding="GBK"?

>

0000000000000000000000000000006:

172.16.29.1:

010001"status="被禁用原因（数字标志，目前只有被强行禁用）"organid="机构ID"organname="机构名称"/>

5.4更改用户视图的设备的属性

请求URL：

http:

//host:

port//web_xml_interface/update_device_info.xml?

sessionId=%s&xml==:

XML：

设备的名称

1000.10

2000.10

3200.20

响应XML：

TRUE

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）是一个顶级机构（公司）

xmlversion="1.0"encoding="GBK"?

>

id="0000000000000000000000000000001"

name="CompanyName"

linkman=""

email=""

phone=""

fax=""

postalcode=""

address=""

note=""

isSuspended="false"

/>

2）是一个非顶级机构（部门）

xmlversion="1.0"encoding="GBK"?

>

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）普通摄像头

xmlversion="1.0"encoding="GBK"?

>

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。

xmlversion="1.0"encoding="GBK"?

>

……

/>

注：

这个接口没有使用。

3）IpCamera摄像头，属性与普通摄像头相同，general_camera_vic改为ip_camera_vic，并增加host、port两个属性

xmlversion="1.0"encoding="GBK"?

>

……

host=""

port="12345"

/>

4）IpCamera视频服务器摄像头，属性与IpCamera摄像头相同，将ip_camera_vic改为ip_camera_video_server_vic。

xmlversion="1.0"encoding="GBK"?

>

……

/>

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

请求URL：

https:

//host:

port/web_xml_interface/resource_detail_info.xml?

sessionId=0000000000000000000000000000007&resourceType=video_output_channel&resourceId=000000000