系统之间的接口V3.0

系统接口定义

2011-05-05

1. 概述........................................................................................................................................... 3 2. 结构图....................................................................................................................................... 4

. ......................................... 4

3. 总体说明 . .................................................................................................................................. 4

3.1. 接口列表 . ...................................................................................................................... 4 3.2. 接口访问方式 . .............................................................................................................. 5 4. 接口描述 . .................................................................................................................................. 5

4.1. 添加日志 . ...................................................................................................................... 5

4.1.1. 接口说明 . .......................................................................................................... 5 4.1.2. 接口定义 . .......................................................................................................... 5 4.1.3. 响应报文 . .......................................................................................................... 6 4.2. 用户登陆 . ...................................................................................................................... 6

4.2.1. 接口说明 . .......................................................................................................... 6 4.2.2. 接口定义 . .......................................................................................................... 6 4.2.3. 响应报文 . .......................................................................................................... 6 4.3. 导出数据 . ...................................................................................................................... 7

4.3.1. 接口说明 . .......................................................................................................... 7 4.3.2. 接口定义 . .......................................................................................................... 7 4.3.3. 响应报文 . .......................................................................................................... 7 4.4. 获取数据库与表的配置信息 . ...................................................................................... 8

4.4.1. 接口说明 . .......................................................................................................... 8 4.4.2. 接口定义 . .......................................................................................................... 8 4.4.3. 响应报文 . .......................................................................................................... 8 4.5. 获取部门名称 . .............................................................................................................. 9

4.5.1. 接口说明 . .......................................................................................................... 9 4.5.2. 接口定义 . .......................................................................................................... 9 4.5.3. 响应报文 . .......................................................................................................... 9 4.6. 获取数据字典中导出文件路径 . .................................................................................. 9

4.6.1. 接口说明 . .......................................................................................................... 9 4.6.2. 接口定义 . ........................................................................................................ 10 4.6.3. 响应报文 . ........................................................................................................ 10 4.7. 获取数据字典中导出数据最大值，一页多少数据配置 ......................................... 10

4.7.1. 接口说明 . ........................................................................................................ 10 4.7.2. 接口定义 . ........................................................................................................ 10

4.7.3. 响应报文 . ........................................................................................................ 11 4.8. 获取表信息（数据库类型、数据库名称、表名称、可以同步的数据总数） ..... 11

4.8.1. 接口说明 . ........................................................................................................ 11 4.8.2. 接口定义 . ........................................................................................................ 11 4.8.3. 响应报文 . ........................................................................................................ 12 4.9. 获取用户基本信息 . .................................................................................................... 12

4.9.1. 接口说明 . ........................................................................................................ 12 4.9.2. 接口定义 . ........................................................................................................ 12 4.9.3. 响应报文 . ........................................................................................................ 12 4.10. 导入数据 . ................................................................................................................ 13

4.10.1. 接口说明 . ........................................................................................................ 13 4.10.2. 接口定义 . ........................................................................................................ 13 4.10.3. 响应报文 . ........................................................................................................ 14 4.11. 修改同步标志 . ............................................................................................................ 14

4.11.1. 接口说明 . ........................................................................................................ 14 4.11.2. 接口定义 . ........................................................................................................ 14 4.11.3. 响应报文 . ........................................................................................................ 15

1. 概述

本文档用于描述数据交互系统中，平台部分与应用系统之间的接口。平台部分作为基础服务端，应用部分作为接口客户端。平台提供部门、用户、权限、日志、字典等基本功能，应用部分进行调用。调用协议主要为基于Xml 的Web Service协议。

2. 结构图

3. 总体说明

3.1. 接口列表

基础服务平台接口列表

3.2. 接口访问方式

一、WSDL 路径：

4. 接口描述

4.1. 添加日志 4.1.1. 接口说明

向数据库添加操作日志

4.1.2. 接口定义

接口：void addOperLog(String userCode,String password,OpeLog opeLog) 功能：添加用户日志

参数： userCode ：用户代码

userPassword ：用户密码 opeLog ：操作日志对象

返回：无返回值

4.1.3. 响应报文

无

4.2. 用户登陆 4.2.1. 接口说明

应用系统登陆时，可以在自己的界面中调用此接口进行登陆认证。

4.2.2. 接口定义

接口：String checkLogin(String userCode,String userPassword) 功能：用户登陆

参数： userCode ：用户代码 userPassword ：用户密码返回：见响应报文

4.2.3. 响应报文

返回代码，true 表示成功，false 表示失败返回消息

4.3. 导出数据 4.3.1. 接口说明

导出数据，返回ExportReturn 对象，对象包含String success; （成功信息）String

fail （异常信息），String primarKey[]（主键类型）;PkValue pkValue[]（主键值）;byte[] dataXML （导出的二进制数据）;

4.3.2. 接口定义

接口：ExportReturn generateXml(String userCode, String password, String

srcDbName, String srcTbName, int pageSize, int page, String pass)

功能：导出二进制数据，日志等信息。

参数：userCode :用户账号

password:用户密码 srcDbName:数据库名称 srcTbName ：表名

pageSize ：一次导多少条数据 page ：当前页 pass ：加密密码

返回：ExportReturn 对象(Success ：成功信息、Fail ：异常信息、primarKey ：

主键列名、pkValue ：导出数据的主键值、dataXML ：导出的二进制数据）

4.3.3. 响应报文

返回消息

二进制数据主键值

异常信息

主键列名成功信息

4.4. 获取数据库与表的配置信息 4.4.1. 接口说明

获取数据库与表的配置信息，形成树型结构图, 返回一维数组。格式如下： String[0]:数据库名称，表名，表名，表名; String[1]:数据库名称，表名，表名

4.4.2. 接口定义

接口：String [] getDbTableName(String userCode, String password) 功能：获取数据库与表配置信息参数：userCode ：用户代码

Password ：用户密码

返回：String[]:

4.4.3. 响应报文

返回消息

数据库名称，表名，表名。。。

数据库名称，表名。。。

4.5. 获取部门名称 4.5.1. 接口说明

通过部门ID 获取部门名称

4.5.2. 接口定义

接口：String getDeptName(String userCode, String password, String deptId) 功能：获取用户基本信息参数：userCode ：用户代码

Password ：用户名称 deptId ：部门ID

返回：String 部门名称

4.5.3. 响应报文

返回消息

部门名称

4.6. 获取数据字典中导出文件路径 4.6.1. 接口说明

应用系统调用此接口获取数据字典中导出文件的路径。

4.6.2. 接口定义

接口：getFileRoot(String userCode, String password,String userKey) 功能：获取导出时，文件夹的默认路径参数：userCode:用户编码

Password ：用户密码

userKey 用户编码+”IN ” or “OUT ”

返回：文件路径

4.6.3. 响应报文

返回消息

默认导出文件路径

4.7. 获取数据字典中导出数据最大值，一页多少数据配置 4.7.1. 接口说明

获取数据字典中导出数据最大值，一页多少数据配置

4.7.2. 接口定义

接口：int[] getPageSizeAndMaxCount(String userCode, String password) 功能：业务日志记录

参数：userCode:用户编码

Password ：用户密码

返回：int[0]:tableSize(一次最多可导多少条数据),

int[1]:pageSize（一个文件存储多少条数据）

返回消息

一次最多可导多少条数据

一个文件存储多少条数据

4.8. 获取表信息（数据库类型、数据库名称、表名称、可以

同步的数据总数）

4.8.1. 接口说明

查询导出数据表的，数据类型，数据库名称，表名称，可以同步的数据总数

4.8.2. 接口定义

接口：String[] getRowData(String userCode, String password,String dbName, String tblName)

功能：业务日志记录

参数：userCode:用户编码

Password ：用户密码

dbName ：数据库名称

tblName ：表名称

返回：String[0]:dbType(数据库类型),

String[1]:dbName（数据库名称）,

String[2]:tableName表名，

String[3] synCount:可同步的数据总数

返回消息

数据库类型

数据库名称

表名称

可同步的数据总条数

4.9. 获取用户基本信息

4.9.1. 接口说明

根据用户代码获取用户基本信息

4.9.2. 接口定义

接口：getUser(String userCode, String password)

功能：获取用户基本信息

参数：userCode ：用户代码

Password ：密码

返回：见响应报文

4.9.3. 响应报文

返回消息

用户代码

用户名称

所属部门序号

4.10. 导入数据

4.10.1. 接口说明

通过IO 字节流获取导入文件（加过密）的二进制byte[]导入数据，webService 服务器端会先解密byte[]，再以xml 的方式解析byte[]，最后导入数据库。

4.10.2. 接口定义

接口：String[] loadToDBFromXmlFile(String userCode, String password,String

dbName, String tableName, byte[] data, String pass,String fileName)

功能：通过ImportParam 里的DataHandler 导入数据

参数：userCode ：用户代码

Password ：用户密码

dbName ：数据库名称

tableName ：表名

data ：二进制数据

pass ：加密密码

fileName ：文件名称

返回：String[0]:true(成功) or false (失败)

Stirng[1]:成功信息

String[2]:异常信息

4.10.3. 响应报文

返回消息

用户代码

用户名称

所属部门序号

所属部门名称

用户类别

排序号

是否允许登陆1:允许0:禁止备注

备注1

备注2

备注3

状态：1：正常 0:无效

4.11. 修改同步标志

4.11.1. 接口说明

文件导出成功并生成文件后，再通过这个接口去修改表的同步标志（1）。

4.11.2. 接口定义

接口：void updateSynchflag(String userCode, String password, String dbName, String tableName, String[] pkName, PkValue[] pkValue)

功能：修改数据同步标志为1

参数：userCode ：用户代码

Password ：密码

dbName ：数据库名称

tableName ：表名

pkName ：主键名称 pkValue ：主键值返回：无

4.11.3. 响应报文无

系统接口定义

2011-05-05

. ......................................... 4

3. 总体说明 . .................................................................................................................................. 4

4.1. 添加日志 . ...................................................................................................................... 5

1. 概述

2. 结构图

3. 总体说明

3.1. 接口列表

基础服务平台接口列表

3.2. 接口访问方式

一、WSDL 路径：

4. 接口描述

4.1. 添加日志 4.1.1. 接口说明

向数据库添加操作日志

4.1.2. 接口定义

接口：void addOperLog(String userCode,String password,OpeLog opeLog) 功能：添加用户日志

参数： userCode ：用户代码

userPassword ：用户密码 opeLog ：操作日志对象

返回：无返回值

4.1.3. 响应报文

无

4.2. 用户登陆 4.2.1. 接口说明

应用系统登陆时，可以在自己的界面中调用此接口进行登陆认证。

4.2.2. 接口定义

接口：String checkLogin(String userCode,String userPassword) 功能：用户登陆

参数： userCode ：用户代码 userPassword ：用户密码返回：见响应报文

4.2.3. 响应报文

返回代码，true 表示成功，false 表示失败返回消息

4.3. 导出数据 4.3.1. 接口说明

导出数据，返回ExportReturn 对象，对象包含String success; （成功信息）String

fail （异常信息），String primarKey[]（主键类型）;PkValue pkValue[]（主键值）;byte[] dataXML （导出的二进制数据）;

4.3.2. 接口定义

接口：ExportReturn generateXml(String userCode, String password, String

srcDbName, String srcTbName, int pageSize, int page, String pass)

功能：导出二进制数据，日志等信息。

参数：userCode :用户账号

password:用户密码 srcDbName:数据库名称 srcTbName ：表名

pageSize ：一次导多少条数据 page ：当前页 pass ：加密密码

返回：ExportReturn 对象(Success ：成功信息、Fail ：异常信息、primarKey ：

主键列名、pkValue ：导出数据的主键值、dataXML ：导出的二进制数据）

4.3.3. 响应报文

返回消息

二进制数据主键值

异常信息

主键列名成功信息

4.4. 获取数据库与表的配置信息 4.4.1. 接口说明

获取数据库与表的配置信息，形成树型结构图, 返回一维数组。格式如下： String[0]:数据库名称，表名，表名，表名; String[1]:数据库名称，表名，表名

4.4.2. 接口定义

接口：String [] getDbTableName(String userCode, String password) 功能：获取数据库与表配置信息参数：userCode ：用户代码

Password ：用户密码

返回：String[]:

4.4.3. 响应报文

返回消息

数据库名称，表名，表名。。。

数据库名称，表名。。。

4.5. 获取部门名称 4.5.1. 接口说明

通过部门ID 获取部门名称

4.5.2. 接口定义

接口：String getDeptName(String userCode, String password, String deptId) 功能：获取用户基本信息参数：userCode ：用户代码

Password ：用户名称 deptId ：部门ID

返回：String 部门名称

4.5.3. 响应报文

返回消息

部门名称

4.6. 获取数据字典中导出文件路径 4.6.1. 接口说明

应用系统调用此接口获取数据字典中导出文件的路径。

4.6.2. 接口定义

接口：getFileRoot(String userCode, String password,String userKey) 功能：获取导出时，文件夹的默认路径参数：userCode:用户编码

Password ：用户密码

userKey 用户编码+”IN ” or “OUT ”

返回：文件路径

4.6.3. 响应报文

返回消息

默认导出文件路径

4.7. 获取数据字典中导出数据最大值，一页多少数据配置 4.7.1. 接口说明

获取数据字典中导出数据最大值，一页多少数据配置

4.7.2. 接口定义

接口：int[] getPageSizeAndMaxCount(String userCode, String password) 功能：业务日志记录

参数：userCode:用户编码

Password ：用户密码

返回：int[0]:tableSize(一次最多可导多少条数据),

int[1]:pageSize（一个文件存储多少条数据）

返回消息

一次最多可导多少条数据

一个文件存储多少条数据

4.8. 获取表信息（数据库类型、数据库名称、表名称、可以

同步的数据总数）

4.8.1. 接口说明

查询导出数据表的，数据类型，数据库名称，表名称，可以同步的数据总数

4.8.2. 接口定义

接口：String[] getRowData(String userCode, String password,String dbName, String tblName)

功能：业务日志记录

参数：userCode:用户编码

Password ：用户密码

dbName ：数据库名称

tblName ：表名称

返回：String[0]:dbType(数据库类型),

String[1]:dbName（数据库名称）,

String[2]:tableName表名，

String[3] synCount:可同步的数据总数

返回消息

数据库类型

数据库名称

表名称

可同步的数据总条数

4.9. 获取用户基本信息

4.9.1. 接口说明

根据用户代码获取用户基本信息

4.9.2. 接口定义

接口：getUser(String userCode, String password)

功能：获取用户基本信息

参数：userCode ：用户代码

Password ：密码

返回：见响应报文

4.9.3. 响应报文

返回消息

用户代码

用户名称

所属部门序号

4.10. 导入数据

4.10.1. 接口说明

通过IO 字节流获取导入文件（加过密）的二进制byte[]导入数据，webService 服务器端会先解密byte[]，再以xml 的方式解析byte[]，最后导入数据库。

4.10.2. 接口定义

接口：String[] loadToDBFromXmlFile(String userCode, String password,String

dbName, String tableName, byte[] data, String pass,String fileName)

功能：通过ImportParam 里的DataHandler 导入数据

参数：userCode ：用户代码

Password ：用户密码

dbName ：数据库名称

tableName ：表名

data ：二进制数据

pass ：加密密码

fileName ：文件名称

返回：String[0]:true(成功) or false (失败)

Stirng[1]:成功信息

String[2]:异常信息

4.10.3. 响应报文

返回消息

用户代码

用户名称

所属部门序号

所属部门名称

用户类别

排序号

是否允许登陆1:允许0:禁止备注

备注1

备注2

备注3

状态：1：正常 0:无效

4.11. 修改同步标志

4.11.1. 接口说明

文件导出成功并生成文件后，再通过这个接口去修改表的同步标志（1）。

4.11.2. 接口定义

接口：void updateSynchflag(String userCode, String password, String dbName, String tableName, String[] pkName, PkValue[] pkValue)

功能：修改数据同步标志为1

参数：userCode ：用户代码

Password ：密码

dbName ：数据库名称

tableName ：表名

pkName ：主键名称 pkValue ：主键值返回：无

4.11.3. 响应报文无

系统之间的接口V3.0

相关文章