GAVI项目数据交换CaseService接口说明 v11

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