DB11T553.5-2008政务信息资源共享交换平台技术规范第5部分接口规范.pdf 28页

'免费标准网(www.freebz.net)ICS01.040.35L72备案号xx-xxxxDB北京市地方标准DB11/T553.5—2008政务信息资源共享交换平台技术规范第5部分：接口规范TechnicalspecificationforgovernmentinformationresourcesharingandinterchangeplatformPart5:Interfacespecification2008-05-28发布2008-07-01实施北京市质量技术监督局发布免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008目次前言......................................................................................................................................................................II1范围..................................................................................................................................................................12规范性引用文件............................................................................................................错误！未定义书签。3概述..................................................................................................................................................................14政务信息资源目录服务接口..........................................................................................................................15政务信息资源交换服务接口...........................................................................................................................56认证授权服务接口.........................................................................................................................................10附录A（规范性附录）政务信息资源目录服务接口XMLSchema描述....................................................11附录B（规范性附录）政务信息资源交换服务接口XMLSchema描述....................................................18I免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008前言DB11/T553《政务信息资源共享交换平台技术规范》，分为5个部分：――第1部分：总体框架；――第2部分：政务信息资源目录管理；――第3部分：政务信息资源交换管理；――第4部分：认证授权；――第5部分：接口规范。本部分为DB11/T553的第5部分。本标准的附录A、附录B为规范性附录。本部分由北京市信息化工作办公室提出并归口。本部分的起草单位：北京市信息资源管理中心、中科软科技股份有限公司、北京数贝软件科技有限公司。本部分主要起草人：黄晓斌、林绍福、冯启民、程军、郭家义、崔建新、赵琰昉、李海蛟、李清、徐伟、李中、韩霖。II免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008政务信息资源共享交换平台技术规范第5部分：接口规范1范围本部分规定了政务信息资源共享交换平台的接口规范，包括政务信息资源目录服务接口、政务信息资源交换服务接口和认证授权服务接口。本部分适用于政务信息资源共享交换平台建设的规划、设计和实施。2概述2.1接口组成政务信息资源共享交换平台提供政务信息资源目录服务接口、政务信息资源交换服务接口和认证授权服务接口等三类接口。政务信息资源共享交换平台接口组成见图1。图1政务信息资源共享交换平台接口组成2.2接口技术要求a）应至少提供JMS和Web服务接口；b）应支持跨语言、跨操作系统调用。3政务信息资源目录服务接口3.1目录检索接口3.1.1用户目录检索接口根据指定的检索条件和用户访问权限对政务信息资源目录数据进行查询，并返回结果。用户目录检索接口参数说明见表1。表1用户目录检索接口参数表参数名称参数类型可选/必选参数含义用于存放查询条件的值对象。说明：MetaQuery查询条件为政务信息资源目录查询Query必选非空字符串，MetaQuery内部的参数为“与”的关系，对象MetaQuery数组MetaQuery之间为“或”的关系usercodeString必选用户ID，政务信息资源目录管理系统根据用户访问权限对1免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008查询结果进行过滤a）返回值：政务信息资源目录数据对象MetaData数组；b）政务信息资源目录数据对象MetaData的XMLSchema定义见附录A.1；c）政务信息资源目录数据对象MetaData的组成结构见图2；d）政务信息资源目录查询对象MetaQuery的XMLSchema定义见附录A.2；e）政务信息资源目录查询对象MetaQuery的组成结构见图3。2免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008图2政务信息资源目录数据对象MetaData的组成结构图3免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008图3政务信息资源目录查询对象MetaQuery的组成结构图4免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—20083.1.2角色目录检索接口根据检索条件和角色访问权限对政务信息资源目录数据进行查询，并返回结果。角色目录检索接口参数说明见表2。表2角色目录检索接口参数表参数名称参数类型可选/必选参数含义政务信息资源目录用于存放查询条件的值对象。说明：MetaQuery查询条件Query查询对象必选为非空字符串，MetaQuery内部的参数为“与”的关系，MetaQuery数组MetaQuery之间为“或”的关系用户角色ID，政务信息资源目录管理系统根据角色访问权Rolecodestring必选限对查询结果进行过滤a）返回值：政务信息资源目录数据对象MetaData数组；b）政务信息资源目录数据对象MetaData的XMLSchema定义见附录A.1；c）政务信息资源目录数据对象MetaData的组成结构见图2；d）政务信息资源目录查询对象MetaQuery的XMLSchema定义见附录A.2；e）政务信息资源目录查询对象MetaQuery的组成结构见图3。3.2目录注册更新接口根据权限实现符合规范的政务信息资源目录数据的注册、更新，并返回注册或更新成功的政务信息资源目录数据的元数据标识符。目录注册更新接口参数说明见表3。表3目录注册更新接口参数表参数名称参数类型可选/必选参数含义政务信息资源目录数据对请求目录注册、目录更新的政务信息资源目录数据RegisterData必选象MetaData数组对象用户ID，用于检验用户是否有权限进行目录注册Usercodestring必选或目录更新操作isRegisterBoolean必选TRUE表示目录注册，FALSE表示目录更新a）返回值：如果注册或更新成功，返回注册或更新成功的政务信息资源目录数据的元数据标识符；如果失败，返回-1；b）政务信息资源目录数据对象MetaData的XMLSchema定义见附录A.1；c）政务信息资源目录数据对象MetaData的组成结构见图2。4政务信息资源交换服务接口4.1数据库交换接口4.1.1数据库交换请求接口将数据库交换请求信息发送到交换中心，并在发送数据的交换节点与接收数据的交换节点之间建立会话。数据库交换请求接口参数说明见表4。表4数据库交换请求接口参数表参数名称参数类型可选/必选参数含义数据库交换请求对象Message必选数据库交换请求信息DBExRequest5免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008参数名称参数类型可选/必选参数含义采用的传送模式，支持的传送模式至少应包括持deliveryModeint可选续传送模式PERSISTENT和一次性传送模式NON_PERSISTENT请求的优先级，共有10个优先级。0是最低优Priorityint可选先级，9是最高优先级。默认的优先级是4请求的存在时间，单位为毫秒，由发送方指定，timeToLiveint可选0为无限制a）返回值：TRUE表示发送成功，FALSE表示发送失败；b）数据库交换请求对象DBExRequest的XMLSchema定义见附录B.1；c）数据库交换请求对象DBExRequest的组成结构见图4。图4数据库交换请求对象DBExRequest的组成结构图4.1.2数据库数据发送接口将需交换的数据库数据发送给接收数据的交换节点。数据库数据发送接口参数说明见表5。表5数据库数据发送接口参数表参数名称参数类型可选/必选参数含义数据库交换数据对dbData必选需要通过数据库数据发送接口发送的数据集象DBExDataa）返回值：无；b）数据库交换数据对象DBExData的XMLSchema定义见附录B.2；c）数据库交换数据对象DBExData的组成结构见图5。6免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008图5数据库交换数据对象DBExData的组成结构图4.1.3数据库数据接收接口接收从提供数据的交换节点发送的数据库数据。数据库数据接收接口参数说明见表6。表6数据库数据接收接口参数表参数名称参数类型可选/必选参数含义数据库交换数据对dbData必选需要通过数据库数据接收接口接收的数据集象DBExDataa）返回值：无；b）数据库交换数据对象DBExData的组成结构见图5；c）数据库交换数据对象DBExData的XMLSchema定义见附录B.2。4.2文件交换接口4.2.1文件交换请求接口将文件交换请求信息发送到交换中心，并在发送数据的交换节点与接收数据的交换节点之间建立会话。文件交换请求接口参数说明见表7。表7文件交换请求接口参数表参数名称参数类型可选/必选参数含义文件交换请求对象Message必选文件交换请求信息FileExRequest7免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008参数名称参数类型可选/必选参数含义采用的传送模式，支持的传送模式至少应包括持续deliveryModeInt可选传送模式PERSISTENT和一次性传送模式NON_PERSISTENT请求的优先级，共有10个优先级。0是最低优先级，PriorityInt可选9是最高优先级。默认的优先级是4请求的存在时间，单位为毫秒，由发送方指定，0timeToLiveInt可选为无限制a）返回值：TRUE表示发送成功，FALSE表示发送失败；b）文件交换请求对象FileExRequest的XMLSchema定义见附录B.3；c）文件交换请求对象FileExRequest的组成结构见图6。图6文件交换请求对象FileExRequest的组成结构图4.2.2文件数据发送接口将需交换的文件数据发送给接收数据的交换节点。文件数据发送接口参数说明见表8。表8文件数据发送接口参数表参数名称参数类型可选/必选参数含义文件交换数据对象fData必选需要通过文件数据发送接口发送的数据集FileExData8免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008a）返回值：无；b）文件交换数据对象FileExData的XMLSchema定义见附录B.4；c）文件交换数据对象FileExData的组成结构见图7。图7文件交换数据对象FileExData的组成结构图4.2.3文件数据接收接口接收从提供数据的交换节点发送的文件数据。文件数据接收接口参数说明见表9。表9文件数据接收接口参数表参数名称参数类型可选/必选参数含义文件交换数据对象fData必选需要通过文件数据接收接口接收的数据集FileExDataa）返回值：无；b）文件交换数据对象FileExData的XMLSchema定义见附录B.4；c）文件交换数据对象FileExData的组成结构见图7。9免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—20085认证授权服务接口认证授权服务接口另作专门规定。10免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008附录A（规范性附录）政务信息资源目录服务接口XMLSchema描述A.1政务信息资源目录数据对象XMLSchema描述11免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—200812免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008政务信息资源目录数据对象参数说明见表A.1：表A.1政务信息资源目录数据对象参数表参数名称参数类型参数说明resTitleString资源名称AbstractString资源摘要ClassString资源安全限制分级dataCharString资源字符集13免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008参数名称参数类型参数说明dataLangString资源语种descKeysResKeysType关键字说明fmInfoResFormatType资源格式信息idPoCResSupplyType资源负责方idPoC1ResConsumptionType资源需求方mdContactResSupplyType元数据联系方mdDateStString元数据创建日期mdLangString元数据语种mdIDString元数据标识符mdClassString元数据安全限制分级onLineSrcString在线资源链接地址PeriodResPeriodType时间范围pubDateString资源出版日期resIDString资源标识符resCatResCategoryType资源分类spatDomString空间范围StatementString数据志说明resTypeString资源类型useConstsString资源使用限制表A.2关键字说明（ResKeysType）参数表参数名称参数类型参数说明KeywordString关键字thesaNameString词典名称表A.3资源格式信息（ResFormatType）参数表参数名称参数类型参数说明formatNameString资源格式名称formatVerString资源格式版本表A.4资源负责方/元数据联系方（ResSupplyType）参数表参数名称参数类型参数说明eMailAddString单位邮箱cntAddressString单位地址rpOrgNameString单位名称表A.5资源需求方（ResConsumptionType）参数表参数名称参数类型参数说明eMailAddString单位邮箱cntAddressString单位地址rpOrgNameString单位名称applicationNameString应用名称表A.6时间范围（ResPeriodType）参数表14免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008参数名称参数类型参数说明begDateString起始时间endDateString结束时间表A.7资源分类（ResCategoryType）参数表参数名称参数类型参数说明cateCodeString类目编码cateNameString类目名称cateStdString分类标准A.2政务信息资源目录查询对象XMLSchema描述15免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—200816免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008政务信息资源目录查询对象参数说明见表A.8。表A.8政务信息资源目录查询对象参数表参数名称参数类型参数说明metaIDString元数据标识符metaCreateDateString元数据创建日期metaLangString元数据语种metaRpAddressString元数据联系方地址metaRpEMailString元数据联系方电子邮件地址metaRpOrgNameString元数据联系单位metaSecurityLevelString元数据安全限制分级resAbstractString资源摘要resBeginDateString起始时间resEndDateString结束时间resCategoryCodeString类目编码resCategoryNameString类目名称resCategoryStandardString分类标准resCharSetString资源字符集resDataExplainString数据志说明resFormatNameString资源格式名称resFormatVersionString资源格式版本resIDString资源标识符resKeywordString关键字resKeywordDictionayString辞典名称resLangString资源语种resNameString资源名称resOnLineSrcString在线资源链接地址resPubDateString资源出版日期resRpAddressString资源负责方地址resRpEMailString资源负责方电子邮件地址resRpOrgNameString资源负责单位resRqAddressString资源需求方地址resRqAppNameString业务应用名称resRqEmailString资源需求方电子邮件地址resRqOrgNameString资源需求单位resSecurityLevelString资源安全限制分级resSpaceString空间范围resTypeString资源类型resUseLimitString资源使用限制17免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008附录B（规范性附录）政务信息资源交换服务接口XMLSchema描述B.1数据库交换请求对象XMLSchema描述18免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008数据库交换请求对象参数说明见表B.1。表B.1数据库交换请求对象参数表参数名称参数类型参数说明VersionString服务版本号senderCodeString发送方机构编码senderAppCodeString发送方应用系统编码resourceIDString资源标识符resourceNameString资源名称userIDString用户标识符userNameString用户名称timeStampString时间戳messageIDString消息标识符receiverReceiverType接收方表B.2接收方(ReceiverType)参数表参数名称参数类型参数说明receiverCodeString接收方机构编码receiverAppCodeString接收方应用系统编码B.2数据库交换数据对象XMLSchema描述19免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008数据库交换数据对象参数说明见表B.3。表B.3数据库交换数据对象参数表20免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008参数名称参数类型参数说明senderAppCodeString发送方应用系统编码senderCodeString发送方机构编码senderPeerNameString发送方节点名称receiverAppCodeString接收方应用系统编码receiverCodeString接收方机构编码receiverPeerNameString接收方节点名称sendTimeString发送时间resourceIDString资源标识符resourceTypeString资源类型userIDString用户标识符userNameString用户名processNameString交换流程名称dataSetDataSetType交换的数据集表B.4数据集（DataSetType）参数表参数名称参数类型参数说明operationTypeString操作码，I－增加U－修改D－删除recordDataRecordDataType组成数据集的基本单位，表示一条记录。表B.5记录（RecordDataType）参数表参数名称参数类型参数说明数据项，组成数据记录的基本单位，表示关系数据库表中的某unitDataUnitDataType个字段表B.6数据项（UnitDataType）参数表参数名称参数类型参数说明unitIDNameString数据项的标识符unitDisplayNameString数据项的名称unitValueString数据项的值B.3文件交换请求对象XMLSchema描述21免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008文件交换请求对象参数说明见表B.7。表B.7文件交换请求对象参数表参数名称参数类型参数说明versionString服务版本号senderCodeString发送方机构编码22免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008senderAppCodeString发送方应用系统编码resourceIDString资源标识符resourceNameString资源名称userIDString用户标识符userNameString用户名称timeStampString时间戳messageIDString消息标识符sourceFileSourceFileType交换的文件数据receiverReceiverType接收方表B.8源文件（SourceFileType）参数表参数名称参数类型参数说明sourceFileNameString文件名sourceFilePathString文件路径表B.9接收方（ReceiverType）参数表参数名称参数类型参数说明receiverCodeString接收方机构编码receiverAppCodeString接收方应用系统编码B.4文件交换数据对象XMLSchema描述23免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008文件交换数据对象参数说明见表B.10。表B.10文件交换数据对象参数表参数名称参数类型参数说明senderAppCodeString发送方应用系统编码24免费标准网(www.freebz.net)无需注册即可下载 免费标准网(www.freebz.net)DB11/T553.5—2008参数名称参数类型参数说明senderCodeString发送方机构编码senderPeerNameString发送方节点名称receiverAppCodeString接收方应用系统编码receiverCodeString接收方机构编码receiverPeerNameString接收方节点名称sendTimeString发送时间resourceIDString资源标识符resourceTypeString资源类型userNameString用户名称userIDString用户标识符processNameString流程名称dataSetDataSetType交换的文件数据集表B.11数据集（DataSetType）参数表参数名称参数类型参数说明recordDataRecordDataType组成数据集的基本单位，表示一个文件。表B.12记录（RecordDataType）参数表参数名称参数类型参数说明fileNameString文件名称fileTypeString文件类型（doc、xls等）isBinaryBoolean是否为二进制文件，TRUE二进制，FALSE文本格式fileSizeString文件大小unitDataString经过base64编码后的文件内容25免费标准网(www.freebz.net)无需注册即可下载'