北京市住房和城乡建设信息中心

数据库接口说明文档

北京市住房和城乡建设信息中心

2019年6月

版权声明

本文档由北京市住房和城乡建设信息中心授权北京市施工现场人员管理服务信息平台项目组撰写，未经以上单位同意，任何人不得复制、抄袭、转载本文档的全部或部分内容及其它侵害本单位相关权益的行为。任何上述行为，本单位将保留采取法律手段予以解决的权利。

在没有约定的情况下，对于使用本文档带来的任何损失，与本单位无关，本单位不承担任何责任与风险。

如果您不同意上述条款，请不要阅读和使用本文档，一旦阅读和使用本文档，表明您已经同意和接受上述条款和内容。

更新记录

目录

1接口基本情况 PAGEREF _Toc6391817 \h 5

1.1接口访问 PAGEREF _Toc6391818 \h 5

1.2通用接口函数 PAGEREF _Toc6391819 \h 5

2通用接口描述 PAGEREF _Toc6391820 \h 6

2.1获取接口服务的数据结构（DataSet形式） PAGEREF _Toc6391821 \h 6

2.2以分页的方式按照查询条件来查找数据 PAGEREF _Toc6391822 \h 6

2.3以分页的方式按照查询条件来查找数据，结果以html页面的形式展现 PAGEREF _Toc6391823 \h 7

2.4按照指定的数据结构（DataSet形式）插入数据 PAGEREF _Toc6391824 \h 7

2.5按照指定的数据结构（DataSet形式）更新数据 PAGEREF _Toc6391825 \h 8

2.6按照指定的数据结构（DataSet形式）删除数据 PAGEREF _Toc6391826 \h 8

3接口服务的数据结构及属性 PAGEREF _Toc6391827 \h 9

3.1（填写接口名称）的结构及属性 PAGEREF _Toc6391828 \h 9

4、接口地址 PAGEREF _Toc6391829 \h 10

5、保留字段说明 PAGEREF _Toc6391830 \h 11

6、数据更新方式 PAGEREF _Toc6391831 \h 12

7、接口调用时间规定 PAGEREF _Toc6391832 \h 13

1接口基本情况

1.1接口访问

接口服务地址：http://120.52.185.190:8080/SQSWeb_Silverlight（正式对接后提供）

接口调用端IP：***.***.***.***（多个单个地址用应为你逗号隔开，多个连续地址可写地址段）

接口调用频率：实时/定时（如果是定时需要写明具体时间）

数据更新方式：增量/全量

1.2通用接口函数

2通用接口描述

2.1获取接口服务的数据结构（DataSet形式）

函数名称：GetIServiceStruct

功能请求所用的参数：

功能请求返回的结果是：

成功返回服务对应的DataSet对象，DataSet对象中包含一个DataTable对象，该DataTable 的结构与该接口服务使用的数据库表结构或查询服务结构相对应，

但DataTable中不包含数据。

2.2以分页的方式按照查询条件来查找数据

函数名称：PageQueryData

功能请求所用的参数

功能请求返回的结果：

成功返回服务对应的DataSet对象，DataSet对象中包含一个DataTable对象，该DataTable 的结构与该接口服务使用的数据库表结构或查询服务结构相对应。 但结果只是参数中指定页码的部分结果。

失败抛出错误信息。

2.3以分页的方式按照查询条件来查找数据，结果以html页面的形式展现

函数名称：QueryDataToHtml

功能请求所用的参数：

功能请求返回的结果是：

成功返回以html页面的形式展现结果，但结果只是参数中指定页码的部分结果。

 失败抛出错误信息。

2.4按照指定的数据结构（DataSet形式）插入数据

函数名称：AddData

功能请求所用的参数：

功能请求返回的结果：

返回bool值成功返回true；失败抛出错误信息

2.5按照指定的数据结构（DataSet形式）更新数据

函数名称：UpdateData

功能请求所用的参数

功能请求返回的结果：

返回bool值成功返回true；失败抛出错误信息

2.6按照指定的数据结构（DataSet形式）删除数据

函数名称：DeleData

功能请求所用的参数：

功能请求返回的结果：

返回bool值成功返回true；失败抛出错误信息

3接口服务的数据结构及属性

3.1（填写接口名称）的结构及属性

服务id:1C1D9801-297C-47B8-BEB9-7EBC8C0367B8

服务名称:互联网汇聚_考勤_测试

具体数据结构见数据标准

4、接口地址

正式地址： http://120.52.185.190:8080/SQSWeb_Silverlight（正式对接后提供）

5、保留字段说明

为便于数据管理，数据库设置了ID等8个保留字段。这8个字段不允许业务数据占用，在业务系统调用接口时接口会根据调用的方法自动向数据库中添加值，无需业务系统更新。

6、数据更新方式

业务系统通过调用接口更新基础数据库的数据需要采用先删后插的方式，具体才做流程如下：

说明：数据查询需要通过业务主键查询，例如施工企业资质证书需要通过组织机构代码+资质证书编号查询。业务主键的设定需要业务系统和数据库签订本协议后在数据结构中确定，不允许轻易修改，除非业务出现重大变化。

7、接口调用时间规定

基础数据库写入接口开放时间为每天8:00至23:59:59，在此时间窗口内业务系统可调用接口向数据库写入数据。

每天00:00:00至7:59:59时间窗口为数据库数据处理、数据加工、对外交换包含委办局之间的共享交换时间，在此时间窗口内严禁业务系统向基础数据库写入数据。

数据库不定期会在7:00:00重启服务器，清理系统垃圾释放锁死资源。

数据库系统维护不定期在周六或周日进行，系统维护前一周以简报的形式通知业务系统和信息中心相关负责人，系统维护期间暂停所有的数据共享交换服务。