工作总结

政务信息资源,数据服务接口注册信息表范文、描述信息填写示例、使用申请信息表范文

时间:2020-10-17 21:28:23  作者:  阅读: 关键词: 信息 示例 信息资源

 附 录 A (资料性)

 服务接口注册信息表模板 服务接口注册信息表模板见表A.1。

 表A.1 服务接口注册信息表 序号 名称 描述 1 服务名称 数据服务接口的中文名称,确保唯一性 2 服务摘要 提供服务的简单描述 3 服务提供方代码 数据服务接口的服务提供方代码(统一社会信用代码)

 4 服务提供方名称 数据服务接口的服务提供方名称 5 所属资源目录 数据服务接口所属的资源目录,资源目录由服务提供方编目并注册,当服务接口注册时,选择相应的资源目录 6 服务地址 服务接口的 IP 地址 7 协议类型 基于 HTTP 协议的类型,如 RPC、RESTFUL、SOAP WEBSERVICE 8 请求方法 数据服务接口的请求方法,如 POST 9 响应格式 数据服务接口的响应方法,如 JSON 10 调用频率 服务接口的每天调用频次之和的上限值,(如:1000 次/天)

 11 服务有效日期 服务接口调用的有效截止日期,日期格式(YYYY-MM-DD)

 12 参数表 参数表 13 参数名 参数名 14 参数位置 参数位置(1:header;2:body)

 15 参数类型 参数类型包括但不限于 string、int、long、array、boolean、object 16 约束条件 参数约束限制条件,如字符长度等 17 描述信息 参数的描述信息 18 服务接口说明文档 详细的服务接口使用说明文档,内容应包括但不限于服务接口概述、服务接口访问限制、服务接口参数说明、服务接口授权说明、服务接口调用示例 注:避免在服务接口使用说明文档中暴露原始服务接口地址。

 A

 B

 附 录 B (资料性)

 服务接口描述信息填写示例 B.1 服务接口返回JSON格式示例 用户信息查询接口描述信息填写示例见表B.1。

 表B.1 用户信息查询接口描述信息填写示例 接口概述 通过姓名、身份证件号码,在人口信息资源库中定位人员信息,并将该人员的性别、民族、出生日期和出生地信息进行反馈 接口名称 省公安厅山东省户籍人口信息查询接口 接口分类 查询类 接口方式 REST 接口地址 http://XX.XXX.XXX.XXX:XXX/gateway/1/sgatxxcx

 接口授权 服务提供方授权 接口方法 GET 输入(业务请求参数说明)

 参数名 参数说明 类型 约束 姓名 在户籍管理部门正式登记注册,人事档案中正式记载的姓氏名称。

 字符型

 必填

 身份证件号码 身份证件上记载的、可唯一标识个人身份的号码。

 字符型

 必填 输出(业务返回参数)

 参数名 参数说明 类型 备注 姓名 在户籍管理部门正式登记注册,人事档案中正式记载的姓氏名称。

 字符型 非空项 身份证件号码 身份证件上记载的、可唯一标识个人身份的号码。

 字符型 非空项 性别 性别的标识代码按 GB/T 2261.1—2003 的规定取值。

 字符型 非空项 民族 民族的标识代码按 GB/T 3304—1991 的规定取值。

 字符型 非空项 出生日期 出生证签署的,并在户籍部门正式登记注册,人事档案中记载的日期。

 字符型 非空项 出生地 出生地,国家-省-市-县-详细地址。

 字符型 非空项 返回数据格式 JSON 接口返回模板如下:

 {

 status:’’ data:{}||[]

 msg:’’ }

 B.2 服务接口返回XML格式示例 用户信息查询接口描述信息填写示例见表B.2。

 表B.2 用户信息查询接口描述信息填写示例 接口概述 通过姓名、身份证件号码,在人口信息资源库中定位人员信息,并将该人员的性别、民族、出生日期和出生地信息进行反馈 接口名称 省公安厅山东省户籍人口信息查询接口 接口分类 查询类 接口方式 WebService 接口地址 http://XX.XXX.XXX.XXX:XXX/gateway/api/1/gjrkk_jzxxcx

 接口授权 服务提供方授权 接口方法 cxreceiveRequest 输入(业务请求参数说明)

 参数名 参数说明 类型 约束 姓名 在户籍管理部门正式登记注册,人事档案中正式记载的姓氏名称。

 字符型

 必填 身份证件号码 身份证件上记载的、可唯一标识个人身份的号码。

 字符型

 必填

 输出(业务返回参数)

 参数名 参数说明 类型 备注 姓名 在户籍管理部门正式登记注册,人事档案中正式记载的姓氏名称。

 字符型 非空项 身份证件号码 身份证件上记载的、可唯一标识个人身份的号码。

 字符型 非空项 性别 性别的标识代码按 GB/T 2261.1 — 2003 的规定取值。

 字符型 非空项 民族 民族的标识代码按 GB/T 3304 — 1991 的规定取值。

 字符型 非空项 出生日期 出生证签署的,并在户籍部门正式登记注册,人事档案中记载的日期。

 字符型 非空项 出生地 出生地,国家-省-市-县-详细地址。

 字符型 非空项 返回数据格式 XML 接口返回模板如下:

 <?xml version="1.0" encoding="UTF-8"?> <root></root> <message></message> <code></code> <data></data> <list></list>

 B

 C

 附 录 C (资料性)

 服务使用申请信息表模板 服务使用申请信息表模板见表C.1。

 表C.1 服务使用申请信息表 序号 名称 描述 1 服务名称 服务使用方申请使用的服务名称 2 服务使用方代码 服务使用方的统一社会信用代码 3 服务使用方名称 服务使用方的名称 4 服务使用方联系人 服务使用方的联系人 5 服务使用方联系人电话 服务使用方的联系人电话 6 服务使用方联系人邮箱 服务使用方的联系人电子邮箱 7 服务应用系统名称 使用该服务接口的业务系统名称 8 涉及的办理事项名称 使用该服务用于办理的业务事项名称 9 申请依据 描述服务使用方办理所涉及事项时使用该服务的具体依据,如相关法律、法规、政策等 10 业务场景 服务使用方应用该服务的具体业务场景 11 服务使用期限 服务期限以天为单位,如 980 天;特殊情况下须详细说明每年服务使用具体日期,如 1 月 1 日-5 月 1 日等 12 服务使用时间范围 服务使用的具体时间范围,比如 1:工作日(8:00-18:00)或 2:全天(含非工作日)

 13 附件 附件包括但不限于加盖服务使用方印章的申请表扫描件等


相关文章

©2020 新文秘网 版权所有

本站资源来自互联网收集,仅供用于学习和交流,请勿用于商业用途。如有侵权、不妥之处,请联系站长并出示版权证明以便删除。敬请谅解!