JIEP1.0 SD 接口规范说明书.doc

文档介绍：
接口规范说明书
版本<>
修订历史记录
日期
版本
说明
作者
<2010-03-22>
<>
<初始版本>
<向默>
目录
1. 简介 3
目的 3
范围 3
定义、首字母缩写词和缩略语 3
参考资料 3
2. 接口文件结构 4
3. 接口文件格式描述 4
获取字段格式接口 4
获取信息总数接口 6
获取信息接口 6
获取附件接口 8
接收信息接口 9
接收附件接口 10
任务完成情况接口 11
错误代码描述 12
4. 同步列表 12

简介
目的
为其他系统使用信息交换平台功能提供指导作用,方便其他系统的顺利集成。
范围
供需要信息交换平台进行信息交换的其他应用系统使用。
定义、首字母缩写词和缩略语
无
参考资料
《》
《》
《》
接口文件结构
接口文件格式描述
第三方系统需要实现统一的WebService接口,并要求具有相同名称的访问点和接口方法。
访问点:http://路径:端口号/应用名称/service/wsInfo?wsdl
获取字段格式接口
方法名称:getInfoFormat()
参数说明
strLoginId String 第三方的系统在本系统中注册的用户名(必须)
strPwd String 登陆密码。如果加密密钥为空,则视为明文;反之视其为密文。(必须)
strKey String 加密密钥。如果登录密码需要加密,取当前时间字符串作为加密密钥。如果登录密码不需要加密,则可以为空字符串。(必须)
加密方式:MD5、BASE64+MD5
iType int 类型 1 发送字段格式 2 接收字段格式(必须)
其他参数可根据需要自行增加
返回
成功返回如下的XML字符串:
<?xml version="" encoding="utf-8" ?>
<root>
<field>
<cname>中文名称</cname>
<ename>英文名称</ename>
<fieldtype>字段类型</fieldtype>
<isrequired>是否必填(1必填,0不必填)</isrequired>
</field>
<field>
……
</field>
……
……
</root>
字段类型规定如下:
类型值
描述
int
整数
double
小数
string
文本
time
时间(YYYY-MM-DD HH:mm:ss)
date
日期(YYYY-MM-DD)
失败返回xml文件格式的字符串,具体格式参看“错误代码描述”。
获取接口参数数据接口
方法名称:getParaData()
参数说明
strLoginId String 第三方的系统在本系统中注册的用户名(必须)
strPwd String 登陆密码。如果加密密钥为空,则视为明文;反之视其为密文。(必须)
strKey String 加密密钥。如果登录密码需要加密,取当前时间字符串作为加密密钥。如果登录密码不需要加密,则可以为空字符串。(必须)
加密方式:MD5、BASE64+MD5
strParameter String 参数名称(必须)
返回
成功返回如下的XML字符串:
<?xml version="" encoding="utf-8" ?>
<root>
<mustwrite>是否必填(0 为不必填,1 必填)< /mustwrite>
<mulpitiselect>是否允许多选(0 为不允许,1 允许)</mulpitiselect>
<nodes id=”节点ID” name=”节点集名称”>
<node id=”节点ID” text=”节点内容” allowed=”是否允许选择(0 不允许, 1 允许)”>
-----该处“节点ID”需加一节点标示,相当于父机构id
<node id=”节点ID” text=”节点内容” allowed=”是否允许选择(0 不允许, 1 允许)”></node>
<node id=”节点ID” text=”节点内容” allowed=”是否允许选择(0 不允许, 1 允许)”></node>
……
</node>
<node id=”节点ID” text=”节点内容” allowed=”是否允许选择(0 不允许, 1 允许)”>
…