养老保险待遇状态比对查询服务系统接口开发手册.doc

此文档收集于网络，如有侵权，请联系网站删除养老保险待遇状态比对查询服务系统接口开发手册（1.0版）2011.7.25目 录1接口API使用说明11.1接口API概述12JAVA接口使用说明12.1JAVA接口类列表12.2Java接口API说明22.2.1上传FileUploadAgentFileUploadParamsFileUploadResponse62.2.2通用查询CommQueryAgentCommQueryResponse92.2.3错误文件下载ErrFileDownloadAgentErrFileDownloadParamsErrFileDownloadResponse142.2.4证书有效期查询CertQueryAgent162.3Java接口开发举例162.3.1领取人员批量查询领取人员批量查询上传通用查询（查询领取待遇人员批量查询结果）错误文件列表查询错误文件下载183C接口使用说明193.1C接口API说明193.1.1上传FileUploadAgentInitSetFileUploadParamsFileUploadSendAndReceiveGetFileUploadResponseFileUploadAgentEnd213.1.2通用查询CommQueryAgentInitSetCommQueryParamsCommQuerySendAndReceiveGetCommQueryResponseCommQueryAgentEnd233.1.3错误文件下载ErrFileDownloadAgentInitsetErrFileDownloadParamsErrFileDownloadSendAndReceiveGetErrFileDownloadResponseErrFileDownloadAgentEnd253.1.4证书有效期查询GetCertPeriod25附录1比对查询系统反馈的错误代码列表1附录2：接口反馈代码2附录3：查询条件列表6附录4：开发常见问题及解答8此文档仅供学习与交流1 接口API使用说明1.1 接口API概述在采用嵌入式或前置系统接入模式下，基于本手册进行本地后台接口的开发。比对查询业务接口API提供了基于Java和C语言的两种接口封装形式，各地可根据本地业务管理系统的开发环境选用。Java接口采用Jar包形式，C语言采用动态链接库dll形式并提供开发需要的.h头文件和.lib库文件。在实际的运行环境中，需要将jar或者dll文件部署到使用比对查询业务接口的系统库文件目录内，部署接口api的服务器必须能够通过网络直接访问部级养老保险待遇状态比对查询服务系统进行数据交换，同时由于接口会自动对传输的数据进行数字签名，需要在此服务器上部署安装金保工程统一的设备数字证书以及相关认证软件包。2 JAVA接口使用说明2.1 JAVA接口类列表接口名称接口描述FileUploadAgent文件上传代理FileUploadParams上传文件参数对象FileUploadResponse上传文件结果返回对象CommQueryAgent通用查询代理CommQueryResponse通用查询返回对象ErrFileDownloadAgent下载错误文件代理ErrFileDownloadParams下载错误文件参数对象ErrFileDownloadResponse下载错误结果返回对象CertQueryAgent查询证书有效期对象2.2 Java接口API说明Jar包名称：sitrb.jar依赖包：Axis 1.4开发环境要求：支持Eclipse等各类Java开发工具，J2SE1.4及以上版本。运行环境要求：JRE1.4以及上版本，可以部署在J2EE容器内运行。2.2.1 上传 FileUploadAgent上传文件代理类，上传文件时调用此类。构造方法摘要FileUploadAgent()初始化一个建新的FileUploadAgent对象。方法摘要FileUploadResponse sendAndReceive(FileUploadParams upParams)将请求信息发送给服务器,并返回一个FileUploadResponse对象。构造方法详细信息.1 FileUploadAgentpublic FileUploadAgnet()初始化一个新建的FileUploadAgent对象。方法详细信息.2 sendAndReceivepublic FileUploadResponse sendAndReceive(FileUploadParams upParams)将请求信息发送给服务器,并返回一个FileUploadResponse对象。参数：upParams 上传文件参数对象。返回：FileUploadResponse 上传文件结果返回对象。 FileUploadParams上传文件参数类，用于传入上传文件请求的各种参数。构造方法摘要FileUploadParams()初始化一个建新的FileUploadParams对象。方法摘要void setOrgID(String orgID)传入组织机构代码void setBuzzType(String transType)传入业务数据分类标识void setSendType(String upType)传入上传方式，1-以文件方式上传；2-以流方式上传void setUploadFileName (String uploadFileName)传入上传文件的文件名。void setUploadStream(String stream)传入待上传字符流。以文件方式上传时不需传入该值。void setCertType (String certType)传入证书类型。public void setXzscope(String xzScope)上传文件所属险种，必须是具体一个险种类型，如110、120、150。构造方法详细信息.1 FileUploadParamspublic FileUploadParams()初始化一个新建的FileUploadParams对象。方法详细信息.2 setBuzzTypepublic void setBuzzType(String buzzType)传入本次上传的交易类型。参数：buzzType 本次上传的业务类型代码。返回：无。.3 setDataFileTypepublic void setDataFileType(String dataFileType)传入数据文件类型。参数：dataFileType 数据文件类型。1TXT文件。返回：无。.4 setSendTypepublic void setSendType(String sendType)传入上传方式。参数：sendType 上传方式，1- 以文件方式上传。2- 以流方式上传。返回：无。.5 setFileDatepublic void setFileDate(String sendDate)传入文件生成日期。参数：fileDate 文件生成日期，格式为YYYYMMDD。返回：无。.6 setUploadFileNamepublic void setUploadFileName(String uploadFileName)传入上传文件的文件名。参数：uploadFileName 文件名。返回：无。.7 setUploadStreampublic void setUploadStream(String stream)传入待上传字符流。参数：stream 待上传字符流，当上传方式为文件方式时返回值无意义。返回：无。.8 setCertTypepublic void setCertType(String certType)传入证书类型。参数：certType 证书类型。2设备证书。返回：无。.9 setXzscopepublic void setXzscope(String xzScope)传入险种类型。参数：xzScope ,险种类型：110城镇企业职工基本养老保险，120机关事业单位养老保险，150新型农村社会养老保险，160城镇居民社会养老保险，170城乡居民社会养老保险。返回：无。 FileUploadResponse上传结果返回对象，返回上传文件处理是否成功标志及处理信息。构造方法摘要FileUploadResponse()初始化一个建新的FileUploadResponse对象。方法摘要String getErrorFlag()获取上传文件处理是否成功标志。String getRetMsg()获取上传文件处理结果信息。String getStackStrace()获取查询操作的错误堆栈构造方法详细信息.1 FileUploadResponsepublic FileUploadResponse()初始化一个新建的FileUploadResponse对象。方法详细信息.2 getErrorFlagpublic String getErrorFlag()获取上传文件处理是否成功标志。参数：无。返回：String 是否成功标志。0成功，非0失败（具体类型参见错误类型列表）.3 getRetMsgpublic String getRetMsg()获取上传文件处理结果信息。参数：无。返回：String 上传文件处理结果信息。.4 getStackTracepublic String getStackTrace()获取上传操作的错误堆栈。参数：无。返回：String 上传操作的错误堆栈。2.2.2 通用查询 CommQueryAgent通用查询代理类，向后台发送各类业务查询请求，后台业务程序按约定格式返回查询结果。构造方法摘要CommQueryAgent()初始化一个建新的CommQueryAgent对象。方法摘要void setOrgID(String orgID)传入组织机构代码String setCertType (String certType)传入证书类型。void setBuzztype(String FuncID)传入查询请求业务类型。void setQueryParams(Hashmap params)传入查询请求参数。不同的业务查询所需要的参数不尽相同，具体业务查询参数详见接口功能说明部分。String query()将请求信息发送给服务器，查询业务数据，业务程序按约定格式返回结果字符串，具体格式参见数据传输封装规范。public void setXzscope(String xzScope)查询所属险种，具体一个险种类型，如110、120、150。对应上传文件的险种类型。构造方法详细信息.1 CommQueryAgentpublic CommQueryAgent ()初始化一个新建的CommQueryAgent对象。方法详细信息.2 setBuzzTypepublic void setBuzzType (String Buzztype)传入查询业务类型，具体类型对应业务详见接口功能列表。参数：BuzzType 查询请求业务类型返回：无。.3 setDataFileTypepublic void setDataFileType(String dataFileType)传入数据文件类型。参数：dataFileType 数据文件类型。1TXT文件。返回：无。.4 setCertTypepublic void setCertType(String certType)传入证书类型。参数：certType 证书类型。”2” 设备证书返回：无。.5 setQueryParampublic void setQueryParam(Hashmap params)传入查询参数。参数：params 查询参数，不同的查询业务所需要的参数不尽相同，全部为String类型，具体参数详见接口功能列表。返回：无。.6 querypublic CommQueryResponse query()将查询请求发送到服务器，查询业务数据，业务程序按约定格式返回结果字符串，具体格式参见数据传输封装模范。参数：无返回：CommQueryResponse 返回的查询数据。.7 setXzscopepublic void setXzscope(String xzScope)传入险种类型。参数：xzScope ,险种类型：110城镇企业职工基本养老保险，120机关事业单位养老保险，150新型农村社会养老保险，160城镇居民社会养老保险，170城乡居民社会养老保险。返回：无。 CommQueryResponse查询结果返回对象，返回下载文件处理是否成功标志,查询得到的信息和文件名。构造方法摘要CommQueryResponse()初始化一个建新的FileDownloadResponse对象。方法摘要String getErrorFlag()获取查询是否成功标志。String getRetMsg()获取查询结果信息。String getStackStrace()获取查询操作的错误堆栈String getDownFileName()获取查询结果的文件名称。String getDownStream()获取查询结果。构造方法详细信息.1 CommQueryResponsepublic FileDownloadResponse()初始化一个新建的FileDownloadResponse对象。方法详细信息.2 getErrorFlagpublic String getErrorFlag()获取下载文件处理是否成功标志。参数：无。返回：String 是否成功标志。0成功，非0失败（具体类型参见错误类型列表）.3 getRetMsgpublic String getRetMsg()获取下载文件处理结果信息。参数：无。返回：String 下载文件处理结果信息。.4 getDownFileNamepublic String getDownFileName()获取下载后的文件名称。参数：无。返回：String 下载后的文件名称。.5 getStackTracepublic String getStackTrace()获取上传文件处理结果信息。参数：无。返回：String 上传操作的错误堆栈。.6 getDownStreampublic String getDownStream()获取下载的字符流。参数：无。返回：String 下载的字符流。2.2.3 错误文件下载 ErrFileDownloadAgent错误文件下载代理类，下载错误文件时调用此类。构造方法摘要ErrorFileDownloadAgent()初始化一个建新的ErrorFileDownloadAgent对象。方法摘要FileDownloadResponse sendAndDownloadErrFile(ErrFileDownloadParams errDownParams)将下载错误文件的请求参数发送给服务器，下载错误文件，并返回一个FileDownloadResponse对象。public void setXzscope(String xzScope)下载文件所属险种，是具体一个险种类型，如110、120、150。对应上传文件的险种类型。构造方法详细信息.1 ErrFileDownloadAgentpublic FileDownloadAgnet()初始化一个新建的FileDownloadAgent对象。方法详细信息.2 sendAndDownloadErrFilepublic FileDownloadResponse sendAndDownloadErrFile(ErrFileDownloadParams errDownParams)将请求信息发送给服务器，下载错误文件，并返回一个FileDownloadResponse对象。参数：errDownParams 下载错误文件参数对象。返回：FileDownloadResponse 下载文件结果返回对象。 ErrFileDownloadParams下载错误文件参数类，用于传入下载错误文件的各种参数。构造方法摘要ErrFileDownloadParams()初始化一个建新的ErrFileDownloadParams对象。方法摘要void setOrgID(String orgID)传入组织机构代码String setDataFileType (String dataFileType)传入数据文件类型。String setOrignalFileName (String orignalFileName)传入上传原文件名。String setCertType (String certType)传入证书类型。public void setXzscope(String xzScope)下载文件所属险种，是具体一个险种类型，如110、120、150。对应上传文件的险种类型。构造方法详细信息方法详细信息.1 setCertTypepublic void setCertType(String certType)传入证书类型。参数：certType 证书类型。”2” 设备证书返回：无。.2 setDataFileTypepublic void setDataFileType(String dataFileType)传入数据文件类型。参数：dataFileType 数据文件类型。1TXT文件。返回：无。.3 setOrignalFileNamepublic void setOrignalFileName(String orignalFileName)传入证书类型。参数：orignalFileName 待下载的错误文件名。返回：无。.4 setXzscopepublic void setXzscope(String xzScope)传入险种类型。参数：xzScope ,险种类型：110城镇企业职工基本养老保险，120机关事业单位养老保险，150新型农村社会养老保险，160城镇居民社会养老保险，170城乡居民社会养老保险。返回：无。 ErrFileDownloadResponse下载文件结果返回对象，返回下载文件处理是否成功标志、处理信息和下载后的文件名。构造方法摘要ErrFileDownloadResponse()初始化一个建新的FileDownloadResponse对象。方法摘要String getErrorFlag()获取上传文件处理是否成功标志。String getRetMsg()获取上传文件处理结果信息。String getDownFileName()获取下载后的文件名称。当下载数据文件类型为2-字符流时，文件名无意义。String getDownStream()获取下载后的字符流。构造方法详细信息.1 ErrFileDownloadResponsepublic FileDownloadResponse()初始化一个新建的FileDownloadResponse对象。方法详细信息.2 getErrorFlagpublic String getErrorFlag()获取下载文件处理是否成功标志。参数：无。返回：String 是否成功标志。0成功，非0失败（具体类型参见错误类型列表）public String getRetMsg()获取下载文件处理结果信息。参数：无。返回：String 下载文件处理结果信息。.3 getStackTracepublic String getStackTrace()获取上传文件处理结果信息。参数：无。返回：String 上传操作的错误堆栈。.4 getDownFileNamepublic String getDownFileName()获取下载后的文件名称。参数：无。返回：String 下载后的文件名称。.5 getDownStreampublic String getDownStream()获取下载的字符流。参数：无。返回：String 下载的字符流。2.2.4 证书有效期查询 CertQueryAgent方法详细信息public static String getCertPeriod()获取证书的有效期参数：无返回：无异常直接返回 有效期 格式为YYYY年MM月DD日 如：2018年01月12日 异常返回 获取本地证书有效期失败+exception2.3 Java接口开发举例Java接口与界面方式一样，分多个业务类型和环节。现根据业务类型和环节对接口的使用说描述。业务场景为领取人员批量查询。2.3.1 领取人员批量查询 领取人员批量查询上传引入相关包，对文件上传参数对象设置，调用sendAndReceiveASync方法，该方法会抛出异常import java.io.InputStreamimport com.icss.client.FileUploadAgent;import com.icss.client.FileUploadParams;import com.icss.client.FileUploadResponse;FileUploadParams upParams = new FileUploadParams();/ 对upParams进行封装.FileUploadAgent fileupAgent = new FileUploadAgent();FileUploadResponse fileUploadResponse = fileupAgent.sendAndReceiveASync(upParams);String errorFlag = fileUploadResponse.getErrorFlag();/ 针对其中错误做出一些处理(以下以209、211、212和215为例)if (209.equals(errorFlag) | 211.equals(errorFlag)| 212.equals(errorFlag) | 215.equals(errorFlag) / 针对错误进行处理 . 通用查询（查询领取待遇人员批量查询结果）CommQueryAgent commQueryAgent = new CommQueryAgent();Map queryParams = new HashMap();/ 对queryParams进行封装.commQueryAgent.setQueryParams(queryParams);CommQueryResponse commQueryResponse = commQueryAgent.query();String errorFlag = commQueryResponse.getErrorFlag();/ 针对其中错误做出一些处理(以下以209、211、212和215为例)if (209.equals(errorFlag) | 211.equals(errorFlag)| 212.equals(errorFlag) | 215.equals(errorFlag) / 针对错误进行处理 . 错误文件列表查询查询出所有的错误文件以便下载错误文件：ErrFileListQueryParams queryListParams = new ErrFileListQueryParams()/ 对queryParams进行设值封装.ErrFileListQueryAgent filedownAgent = new ErrFileListQueryAgent();ErrFileListQueryResponse errFileListresponse = filedownAgent.sendAndGetQueryResult(queryListParams);String errorFlag = errFileListresponse.getErrorFlag();/ 针对其中错误做出一些处理(以下以209、211、212和215为例)if (209.equals(errorFlag) | 211.equals(errorFlag)| 212.equals(errorFlag) | 215.equals(errorFlag) / 针对错误进行处理 . 错误文件下载ErrFileDownloadParams errDownParams = new ErrFileDownloadParams()/ 对errDownParams进行设值封装.ErrFileDownloadAgent fileDownAgent = new ErrFileDownloadAgent();ErrFileDownloadResponse errFileDownloadResponse = fileDownAgent.sendAndDownloadErrFile(errDownParams);String errorFlag = errFileDownloadResponse.getErrorFlag();/ 针对其中错误做出一些处理(以下以209、211、212和215为例)if (209.equals(errorFlag) | 211.equals(errorFlag)| 212.equals(errorFlag) | 215.equals(errorFlag) / 针对错误进行处理 .3 C接口使用说明3.1 C接口API说明3.1.1 上传 FileUploadAgentInit功能简介初始化上传代理。接口名称long FileUploadAgentInit ()参数说明入参说明无出参说明无返回值FileUploadAgent的句柄。 SetFileUploadParams功能简介设置上传参数。接口名称char *SetFileUploadParams(long Handle, char* pParamName, char* pParamValue)参数说明入参说明nHandle：FileUploadAgent的句柄；pParamName：参数名称，具体支持的参数见下表；pParamValue：参数值。出参说明 无返回值“000”为成功，其余为失败，具体错误参见错误代码表。参数表：参数名参数常量定义参数说明组织机构代码UPLOAD_ORGID请求上传文件的经办机构的行政区划编码业务类型代码UPLOAD_BUZZTYPE如”T01011”上传方式UPLOAD_SENDTYPE“1”-文件方式，”2”-流方式数据文件类型UPLOAD_DATAFILETYPE传输的数据文件类型,1-TXT文件文件名UPLOAD_UPLOADFILENAME请求上传的文件名证书类型UPLOAD_CERTTYPE使用的证书类型,”2”-设备证书。文件流UPLOAD_UPLOADSTREAM文件流险种范围UPLOAD_XZSCOPE险种范围，如110，310等。具体见Java语言中的具体说明 FileUploadSendAndReceive功能简介将请求信息发送给服务器，上传数据。 接口名称char* FileUploadSendAndReceive (long nHandle)参数说明入参说明FileUploadAgent的句柄出参说明 无返回值“000”为成功，其余为失败，具体错误参见错误代码表。 GetFileUploadResponse功能简介获取上传文件处理描述信息。接口名称char* GetFileUploadResponse(long nHandle,char* pParamName)参数说明入参说明nHandle :FileUploadAgent的句柄pParamName：参数名称，具体支持的参数见下表；出参说明 无返回值参数的值参数表：参数名参数常量定义参数说明错误代码UPLOAD_ERRORFLAG“000”为成功，其余为失败，具体错误参见错误代码表。返回信息描述UPLOAD_RETMSG返回的具体信息异常堆栈UPLOAD_STACKTRACE异常的代码堆栈 FileUploadAgentEnd功能简介释放上传代理。接口名称char* FileUploadAgentEnd (long nHandle)参数说明入参说明FileUploadAgent的句柄出参说明 无返回值“000”为成功，其余为失败，具体错误参见错误代码表。3.1.2 通用查询 CommQueryAgentInit功能简介初始化通用查询代理。接口名称long CommQueryAgentInit ()参数说明入参说明无出参说明无返回值CommQueryAgent的句柄 SetCommQueryParams功能简介设置通用查询参数。接口名称char* SetCommQueryParams(int nHandle, char* pParamName, char* pParamValue)参数说明入参说明nHandle：CommQueryAnget的句柄；pParamName：参数名称，具体支持的参数见下表；pParamName：参数值。出参说明 无返回值“000”为成功，其余为失败，具体错误参见错误代码表。参数表（通用查询除以下参数外还可使用额外参数）：参数名参数常量定义参数说明组织机构代码COMMQUERY_ORGID请求下载业务数据文件的组织机构代码业务类型COMMQUERY_BUZZTYPE请求下载的业务数据类型数据类型COMMQUERY_DATAFILETYPE下载的数据文件类型。1txt文件（目前只支持txt文件）证书类型COMMQUERY_CERTTYPE使用的证书类型。1-用户证书，2-服务器证书险种范围COMMQUERY _XZSCOPE险种范围，如110，310等。具体见Java语言中的具体说明 CommQuerySendAndReceive功能简介将请求信息发送给服务器，进行查询操作。接口名称char* CommQuerySendAndReceive (long nHandle)参数说明入参说明CommQueryAgent的句柄出参说明 无返回值“000”为成功，其余为失败，具体错误参见错误代码表。 GetCommQueryResponse功能简介获取通用查询结果。接口名称char* GetCommQueryResponse (long nHandle,char* pParamName)参数说明入参说明nHandle :CommQueryAgent的句柄pParamName：参数名称，具体支持的参数见下表；出参说明 无返回值参数的值参数表：参数名参数常量定义参数说明错误代码COMMQUERY_ERRORFLAG“000”为成功，其余为失败，具体错误参见错误代码表。返回信息描述COMMQUERY _RETMSG返回的具体信息异常堆栈COMMQUERY_STACKTRACE异常的代码堆栈数据文件名COMMQUERY_DOWNFILENAME查询结果文件名数据文件内容COMMQUERY_DOWNSTREAM查询数据结果 CommQueryAgentEnd功能简介释放通用查询代理。接口名称char* CommQueryAgentEnd (long nHandle)参数说明入参说明CommQueryAnget的句柄出参说明 无返回值“000”为成功，其余为失败，具体错误参见错误代码表。3.1.3 错误文件下载 ErrFileDownloadAgentInit功能简介初始化下载代理。接口名称long FileDownloadAgentInit ()参数说明入参说明无出参说明无返回值ErrFileDownloadAgent的句柄 setErrFileDownloadParams功能简介设置下载