接口调用说明文档.docx

1、接口调用说明文档XXXX科技有限公司数据接口2015-5-26第1章 引言1.1 背景为进一步保证业务的正确性及数据的安全统一性，并为后续各方开发工作提供指导，特编写此文档。本接口通过Webservice方式进行交互，由市公共信用中心提供信息查询Webservice服务，供经授权的调用使用。第2章 接口与数据定义2.1 曝光台查询接口2.1.1 曝光台列表查询2.1.1.1 方法定义访问地址：http:/ 曝光台Webservice接口及参数定义如下: 序号方法名方法参数数据类型注释1queryBGTList空空查询曝光台列表信息（该方法默认返回最新的50条数据）示例代码(Java) : pu

2、blic String queryBGTList ( ) /*todo*/2.1.1.2 返回数据返回数据为字符串，内容格式为json，格式样板如下：id:94a349902,title:江苏省2014年12月份违法药品医疗器械保健食品广告公告,createTime:2015-05-15,id:94a349e04,title:省食品药品监督管理局暂停销售利肺胶囊等2个药品的公告,createTime:2015-05-15,id:94a2432e24,title:江苏省2014年5月份违法药品医疗器械保健食品广告公告,createTime:2015-05-15序号节点标示节点名称数据类型1Id编

3、号String2Title标题String3createTime时间String2.1.2 曝光台详情查询2.1.2.1 方法定义曝光台Webservice接口及参数定义如下: 序号方法名方法参数数据类型注释1queryBGTDetailIdString查询指定的某条曝光台新闻详情示例代码(Java) : public String queryBGTDetail (String id ) /*todo*/2.1.2.2 返回数据返回数据为字符串，内容格式为json，格式样板如下：title:江苏省2014年12月份违法药品医疗器械保健食品广告公告,content:根据江苏省药品监督管理条例第三

4、十二条的规定，我局经研究决定，自2015年2月15日起，对标示为吉林通化百信药业有限公司利肺胶囊等2种违法广告药品（品种名单见附件）采取暂停销售措施，在我省范围内暂停上述2品种的销售，现予以公告。序号节点标示节点名称数据类型1Title标题String2Content内容String2.2 信用公示查询接口定义2.2.1 守信公示列表查询2.2.1.1 方法定义访问地址：http:/ :8001/webserviceForApp曝光台Webservice接口及参数定义如下: 序号方法名方法参数数据类型注释11querySHOUXINList空查询守信公示列表信息（该方法默认返回最新的50条数据

5、）示例代码(Java) : public String querySHOUXINList ( ) /*todo*/2.2.1.2 返回数据返回数据为字符串，内容格式为json，格式样板如下：id:94a349902,title: 2014年度江苏省价格诚信单位名单,createTime:2015-05-15,id:94a349e04,title:【单位】苏州市水利工程有限公司,createTime:2015-05-15,id:94a2432e24,title:市政府办公室关于表彰2012年度全市政府信息公开工作优秀单位的通报,createTime:2015-05-15序号节点标示节点名称数据类

6、型1Id编号String2Title标题String3createTime时间String2.2.2 守信公示详情查询2.2.2.1 方法定义曝光台Webservice接口及参数定义如下: 序号方法名方法参数数据类型注释1querySHOUXIilIdString查询指定的某条守信公示详情示例代码(Java) : public String querySHOUXINDetail (String id ) /*todo*/2.2.2.2 返回数据返回数据为字符串，内容格式为json，格式样板如下：title:江苏省2014年12月份违法药品医疗器械保健食品广告公告,content:各市、区人民政

7、府，苏州工业园区、苏州高新区管委会；市各有关部门和单位： 2012年，各地各部门认真贯彻中华人民共和国政府信息公开条例，进一步建立健全政府信息公开工作制度，深化公开内容，丰富公开载体，拓展公开范 围，不断提高政府信息公开的及时性、完整性和实用性，较好地发挥了政府信息对人民群众生产、生活和经济社会活动的服务作用。根据市政府办公室关于开展 2012年度全市政府信息公开工作考核的通知（苏府办201314号）精神，综合各地自查、平时检查、网上测评和实地调研考核等方面情况，经市政府 同意，决定对昆山市人民政府办公室、苏州市发改委等政府信息公开工作优秀单位予以通报表彰。各地各部门要以先进为榜样，进一步加强

8、组织领导，完善工作机 制，强化制度建设，加大公开力度，不断提升政府信息公开整体工作水平。 附件：2012年度全市政府信息公开工作优秀单位序号节点标示节点名称数据类型1Title标题String2Content内容String2.2.3 失信公示列表查询2.2.3.1 方法定义曝光台Webservice接口及参数定义如下: 序号方法名方法参数数据类型注释1querySHIXINList空空查询失信公示列表信息（该方法默认返回最新的50条数据）示例代码(Java) : public String querySHIXINList ( ) /*todo*/2.2.3.2 返回数据返回数据为字符串，内容

9、格式为json，格式样板如下：id:94a349902,title: 2014年度江苏省价格诚信单位名单,createTime:2015-05-15,id:94a349e04,title:【单位】苏州市水利工程有限公司,createTime:2015-05-15,id:94a2432e24,title:市政府办公室关于表彰2012年度全市政府信息公开工作优秀单位的通报,createTime:2015-05-15序号节点标示节点名称数据类型1Id编号String2Title标题String3createTime时间String2.2.4 失信公示详情查询2.2.4.1 方法定义曝光台Webser

10、vice接口及参数定义如下: 序号方法名方法参数数据类型注释1querySHIXINDetailIdString查询指定的某条失信公示详情示例代码(Java) : public String querySHIXINDetail (String id ) /*todo*/2.2.4.2 返回数据返回数据为字符串，内容格式为json，格式样板如下：title:江苏省2014年12月份违法药品医疗器械保健食品广告公告,content:各市、区人民政府，苏州工业园区、苏州高新区管委会；市各有关部门和单位： 2012年，各地各部门认真贯彻中华人民共和国政府信息公开条例，进一步建立健全政府信息公开工作制度

11、，深化公开内容，丰富公开载体，拓展公开范 围，不断提高政府信息公开的及时性、完整性和实用性，较好地发挥了政府信息对人民群众生产、生活和经济社会活动的服务作用。根据市政府办公室关于开展 2012年度全市政府信息公开工作考核的通知（苏府办201314号）精神，综合各地自查、平时检查、网上测评和实地调研考核等方面情况，经市政府 同意，决定对昆山市人民政府办公室、苏州市发改委等政府信息公开工作优秀单位予以通报表彰。各地各部门要以先进为榜样，进一步加强组织领导，完善工作机 制，强化制度建设，加大公开力度，不断提升政府信息公开整体工作水平。序号节点标示节点名称数据类型1Title标题String2Cont

12、ent内容String2.3 企业名称查询接口定义2.3.1 Webservice方法定义访问地址：http:/ :8001/webserviceForApp企业列表Webservice接口及参数定义如下: 序号方法名方法参数注释1enterpriseList获取符合条件的企业列表，该方法为模糊查询示例代码(Java) : public String enterpriseList (String organCode,String registerNum,String organName)/*todo*/2.3.2 请求参数请求参数为下列数据。序号参数类型参数参数名称注释1Stringorgan

13、Code组织机构代码2StringregisterNum工商注册号3StringorganName企业名称2.3.3 返回数据返回数据为字符串，内容格式为JSON，格式样板如下：id:0,organName:企业名称0,id:1,organName:企业名称1序号节点标示节点名称数据类型1id数据主键String2organName企业名称String2.4 企业信息查询接口定义2.4.1 Webservice方法定义访问地址：http:/ :8001/webserviceForApp企业信息Webservice接口及参数定义如下: 序号方法名方法参数注释1enterpriseCreditIn

14、fo获取企业的信用信息示例代码(Java) : public String enterpriseCreditInfo(String organId)/*todo*/2.4.2 请求参数请求参数为下列数据。序号参数类型参数参数名称注释1StringorganId企业ID2.4.3 返回数据返回数据为字符串，内容格式为JSON，格式样板如下：baseInfo:organName:江苏华晨海洋工程服务有限公司 ,organCode:590*347 ,scope:机械设备租赁,address:张家港保税区新世纪广场306,registerNum:3205*8896,legalPerson:张三,tis

15、hiInfo:checkResult:通过 ,year:2000,checkTime:2000-05-01,registerNum:3205*8896, checkResult:通过 ,year:2001,checkTime:2001-05-01,registerNum:3205*8896, honorInfo:identiDept:环保局 ,organCode:1111111,identiTime:2000, identiDept:环保局 ,organCode:1111111, identiTime :2001, baseInfo中是基本信息其中：organName：企业名称organCode：组织机构代码scope：经营范围address：注册地址registerNum：工商注册号legalPerson：法定代表人tishiInfo中是提示信息其中：checkResult：年检结论year：年检年度checkTime：（年检）核准日期registerNum：工商注册号honorInfo中是荣誉信息其中：identiDept：认定机关名称organCode：组织机构代码identiTime：认定日期