系统之间的接口V3.0 - 范文中心

系统之间的接口V3.0

09/21

系统 接口定义

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. 响应报文 无


相关内容

  • ITIL_V3_服务设计
    ITIL 版本3 服务设计 免责声明: 一.本文档不对其中包含或引用的信息的准确性.可靠性或完整性提供任何明示或暗示的保证.对于任何因直接或间接采用本文档提供的信息造成的损失,均不承担责任.如因使用本文档出现法律责任,使用者应自行承担全部责 ...
  • 现代通信网综合练习题_含答案_
    <现代通信网>综合练习题与答案 第一部分 练习题 一.填空题 1.通信网的硬件构成要素有____________._____________和________________ . 2.通信网按服务范围可分为___________ ...
  • 联通数据网网络管理
    网络管理 1． 综 述 一个没有网络管理和网络控制的网络将是低效的网络,网络也不能被称为智能的,网络的故障诊断.运行状态.收费等都很难实现.对于一个先进的网络来说,用网管软件对网络进行管理是必不可少的. 联通数据网是一个宠大而复杂的系统.其 ...
  • 通力电梯调试资料
    基 本 设 置 菜单 功能 说明 备注 1-1 基站 1-N 1-2 控制方式 1＝SBC单按钮 2＝DC下集选 3＝FC全集选 4＝PB按钮 1-10 开门时间 门完全打开到开始关门 单位秒 (1-60) 1-11 重开门时间 重开门后门 ...
  • 移动app测试项目实践
    移动互联网APP 测试流程及测试点 1 APP测试基本流程 1.1流程图 仍然为测试环境 1.2测试周期 测试周期可按项目的开发周期来确定测试时间,一般测试时间为两三周(即15个工作日),根据项目情况以及版本质量可适当缩短或延长测试时间.正 ...
  • 遥控窗帘电路的设计-毕业设计
    遥控窗帘电路的设计 学生:XX 指导教师:XX 内容摘要:本文主要介绍了遥控窗帘的电路设计.电机工作的时候是否有鸣响提示,以及光控状态下环境亮度的控制参数的调整等等都可以通过遥控器随着电子技术和自动化技术的发展,人们对生活质量的要求越来越高 ...
  • 集控中心实施方案
    下索子沟流域集中控制中心 实施方案 康定县吉能水电开发有限责任公司 二○一○年六月 1．下索子沟流域项目简介 1.1 流域及电站概况 下索子沟又名座棚沟,为康定县境内大渡河右岸一级支流.下索子沟发源于康定以北的滑山(主峰海拔约5518m ) ...
  • 正多面体的顶点坐标
    正多面體的頂點坐標 國立台灣師範大數學系 陳創義 要利用GSP來作多面體,先要從立體的基本正多面體下手,在正多面體中有許多的對稱,包括旋轉對稱.面對稱.線對稱.點對稱等,因此下列舉出旋轉對稱中的旋轉軸置於z軸時,某些較簡單形式的頂點坐標標出 ...
  • 省客服中心培训心得体会
    前言: 经过了在邮电学校为期15天的军训和相关基础业务知识的培训,迎来了省客服为期20天的客服方面的培训,如今培训即将结束,我们也即将进入各自的工作岗位,在这20天的培训中我学到了很多,感受了很多,也思考了很多．．．．．． 业务学习: 培训 ...
  • 通力电梯故障码
    通力电梯资料-通力错误码News代码 通力电梯资料-通力错误码News代码 故障名称 原因 状态 操作 0001 驱动时间长 位置信号 30/B30 经过一段运行时间后没有变化 立即停止 关电 0004 连续三次同步运行失败 连续三次同步运 ...

热门内容