WebServices业务接口规范说明书

1、开放式虚拟仿真实验教学系统Web Services业务接口规范说明书1. 范围本规范文档主要适用于开放式虚拟仿真实验教学系统和其它业务系统信息数据的接入。2. 术语、定义和缩略语2.1 术语、定义术语/定义含义XML描述数据的标准方法SOAP表示信息交换的协议WSDLWeb服务描述语言UDDI基于XML语言的用于在互联网上描述服务的协议2.2 缩略语缩略语英文原文中文含义JDKJava Development KitJava开发工具包JREJava Runtime EnvironmentJava 运行环境JVMJava Virtual MachineJava 虚拟机DBSDatabase Se

2、rvice数据库服务3. 接口设计3.1 接口公共参数接口服务器通过：http:/IP:port/EIP/WebService/ 连接服务器，同时对外提供业务功能接口，接收的参数和返回的参数都用一定的xml格式进行封装。3.1.1 请求参数1. 请求类型为String类型<?xml version="1.0" encoding="utf-8" ?><request><header type ="xx01" version="1.0" reqtype="0" user

3、id="user000000000001"></header> <param> </param></request> 2. 头部参数体head定义请求参数的头部参数体header格式固定，定义如下：参数名参数说明type请求业务系统对应功能方法，具体详见各业务接口说明version请求业务系统版本号reqtype请求业务系统类型userid请求业务系统当前用户id3. 请求参数体param定义参数体param中的具体请求参数，根据不同的业务而不同，详见各业务接口。3.1.2 返回参数1. 返回类型为String类型<

4、;?xml version="1.0" encoding="utf-8"?><response><header type ="XX01" value="XX00" info="成功"></header> <result> </result></response>2. 头部参数体head定义返回参数的头部参数体header格式固定，定义如下：参数名参数说明type相应业务系统对应功能方法（与请求对应）value标识成功或

5、失败返回码（xx00为成功，其余为失败，具体失败码详见各业务接口）info返回信息说明3. 返回值参数体result定义参数体result中的具体返回参数，根据不同的业务而不同。详见各业务功能返回值参数体result定义。注意：在value值标识为失败时，无论在任何业务功能下result都有可能为空。4. 返回value 值错误码说明1001错误:SecurityException1002错误:NoSuchMethodExceptio1003错误:IllegalArgumentException1004错误:IllegalAccessException1005错误:InvocationTarg

6、etException1006错误:UnkownException1007无数据1008数据已被删除1111传入参数错误3.2 业务功能接口3.2.1 登陆及版本信息接口 模块说明1. 接口类型说明：编码接口1101登录验证1201退出系统1301版本信息及更新2. 错误类型说明：编码接口1101连接service服务失败1102解析请求失败1103解析业务模块失败1104解析参数失败1105查询失败1106用户不存在1107密码错误1108用户无效120 功能1：登陆验证1. 功能描述对用户名和密码进行验证，记录登陆时间、ip地址等信息2. 请求参数体param

7、定义<?xml version="1.0" encoding="utf-8" ?><request><header type ="1101" version="1.0" reqtype="0" userid=""></header><param username="admin" password="E10ADC3949BA59ABBE56E057F20F883E "></

8、param></request> 头部参数体header中的定义参数，详见本文档“请求参数头部参数体header定义”（以下各业务接口中头部参数体header定义相同，不再赘述），type属性值1101，参数体param说明如下：参数说明username终端登陆用户名password终端登录密码（说明：密码采用MD5加密传输，具体密钥见后）3. 返回值参数体result定义<?xml version="1.0" encoding="utf-8" ?><response> <header type="

9、;1101" value="1100" info="成功"></header> <result username="admin" userid="user000000000001" realname="管理员"> </result></response>头部参数体header中的定义参数，详见本文档“返回参数头部参数体header定义” （以下各业务接口中头部参数体header定义相同，不再赘述），type属性值1101，参数体re

10、sult说明如下：参数说明username登陆用户名userid登录用户idrealname当前登陆用户的姓名 功能2：退出系统1. 功能描述记录退出相关信息，如时间以及退出类型。2. 请求参数体param定义略3. 返回值参数体result定义略 功能3：版本信息及更新4. 功能描述版本信息交互，查询到新版本后，自动更新，并记录更新信息。5. 请求参数体param定义略3.2.2 虚拟仿真实验数据接口 模块说明3. 接口类型说明：编码接口2101常规实验数据采集接口2201实验考核数据采集接口4. 错误类型说明：编码接口2101连接service服务失败2102解析请求失败2103解析业务模块失败2104解析参数失败2105查询失败2106数据不完整2107数据错误2108数据无效220 功能一：常规实验数据采集接口1. 功能描述对用户实验数据进行采集，包括进入、退出实验时间，用户实验模块名称，正常实验完成时间，实验完成情况、