GAVI 项目免疫规划信息管理系统
数据交换子系统接口规范
CaseService
中国软件与技术服务股份有限公司
二○一一年六月
目 录
1 【个案信息采集】上传个案数据 .............................................................................3
接口说明..........................................................................................................3
数据说明..........................................................................................................3
地址说明..........................................................................................................4
状态代码..........................................................................................................4
2 【个案处理反馈】获取异常处理信息 .....................................................................5
接口说明..........................................................................................................5
数据说明..........................................................................................................5
地址说明..........................................................................................................6
状态代码..........................................................................................................6
3 附录 .............................................................................................................................7
1 【个案信息采集】上传个案数据
接口说明
输入:
1、CredentialData data, 身份认证信息
2、String idemark , 报文标识,可根据 IDEML 规范生成
3、byte[] ideml 报文内容
输出:String ,返回响应 IDEML 报文,标识本次上传是否成功
调用函数:uploadChildrenDataAsyn
调用场合:
由预防接种客户端上传其系统内的发生变化的个案信息,根据 IDEML 规范要求生成相关个案报文数
据,通过调用此接口上传到国家平台。该接口只返回报文是否上传成功,至于处理是否成功则需要调用接
口 2 来实现
方法调用:
@WebMethod()
public String uploadChildrenDataAsyn(CredentialData data,String mark, byte[] ideml);
注:字节数组 ideml 的内容是根据 IDEML 规范生成的个案报文数据经 gzip 算法压缩而产生的。Mark
为该报文的标识,用于在异步处理时识别特定的报文,此处不可忽略。
数据说明
☼ CredentialData 类
字段 类型 说明
user String 由国家 CDC 设置的具有访问权限的用户
password String 与 user 相对应的密码
organCode String User 所在的机构编码
license String 验证码,暂时保留
地址说明
状态代码
参见附录 A
:8080/services/Service?wsdl
2 【个案处理反馈】获取异常处理信息
接口说明
输入:
1、CredentialData data, 身份认证信息
2、String sendDate, 报文上传日期,用来获取该日期之后的所有异常信息
输出:byte[],返回响应 IDEML 报文
调用函数:getUploadError
调用场合:由预防接种客户端在上传个案报文后一定时期内(通常是半个月内),通过调用此接口
来获取处理失败的个案信息,返回的 IDEML 报文经 gzip 压缩后产生的字节流。
方法调用:
@WebMethod()
public byte[] getUploadError(CredentialData data, String sendDate);
注:sendDate 为发送报文的日期,表示获取个该发送日期之后的异常个案信息。返回的字节数组为
将 IDEML 报文同过 gzip 算法压缩而成的字节数组,可解压后构建 XML 文档。
数据说明
☼ CredentialData 类,同服务一。
字段 类型 说明
user String 由国家 CDC 设置的具有访问权限的用户
password String 与 user 相对应的密码
organCode String User 所在的机构编码
license String 验证码,暂时保留
地址说明
状态代码
参见附录 A
:8080/services/CaseService?wsdl
3 附录
附录 A:GAVI 项目数据交换系统接口服务状态码
访问状态代码 说明
CDCS0000 处理成功!
CDCSFFFF 处理失败!
CDCSEEEE 处理完毕,但有异常发生!
CDCS0001 身份验证失败!
CDCS0101 用户不属于该组织机构!
CDCS0102 认证信息不能为空!
CDCS0103 用户尚无任何权限
CDCS0104 访问被拒绝,无相关权限
CDCS0002 IP 不匹配
CDCS0003 没有访问接口的权限
CDCS0004 缺少请求凭据信息
CDCS0006 请求参数错误,缺少报文
CDCS0007 请求参数错误,查询参数不充分
CDCS0008 请求参数错误,儿童编码数据为空
CDCS0009 请求参数错误,疫苗编码数据为空
CDCS1111 主索引查询成功,但是省平台无数据返回
CDCS1001 上传数据格式不正确,非正确的 gzip 格式
CDCS1002 上传数据格式不正确,非正确的 ideml 格式
CDCS1003 服务异常,发送报文到指定的处理队列失败
CDCS1004 指定单位的配置不存在
CDCS1005 无效参数值:非法队列类型,必须为 1 或者 2
CDCS1006 无效参数值:发送单位编码非法