系統(tǒng)之間接口V3.0_第1頁
系統(tǒng)之間接口V3.0_第2頁
系統(tǒng)之間接口V3.0_第3頁
系統(tǒng)之間接口V3.0_第4頁
系統(tǒng)之間接口V3.0_第5頁
已閱讀5頁，還剩10頁未讀， 繼續(xù)免費閱讀

下載本文檔

版權說明：本文檔由用戶提供并上傳，收益歸屬內(nèi)容提供方，若內(nèi)容存在侵權，請進行舉報或認領

文檔簡介

1、系統(tǒng)接口定義2011-05-05目 錄1.概述32.結(jié)構(gòu)圖443.總體說明43.1.接口列表43.2.接口訪問方式54.接口描述54.1.添加日志54.1.1.接口說明54.1.2.接口定義54.1.3.響應報文64.2.用戶登陸64.2.1.接口說明64.2.2.接口定義64.2.3.響應報文64.3.導出數(shù)據(jù)74.3.1.接口說明74.3.2.接口定義74.3.3.響應報文74.4.獲取數(shù)據(jù)庫與表的配置信息84.4.1.接口說明84.4.2.接口定義84.4.3.響應報文84.5.獲取部門名稱94.5.1.接口說明94.5.2.接口定義94.5.3.響應報文94.6.獲取數(shù)據(jù)字典中導出文件

2、路徑94.6.1.接口說明94.6.2.接口定義104.6.3.響應報文104.7.獲取數(shù)據(jù)字典中導出數(shù)據(jù)最大值，一頁多少數(shù)據(jù)配置104.7.1.接口說明104.7.2.接口定義104.7.3.響應報文114.8.獲取表信息（數(shù)據(jù)庫類型、數(shù)據(jù)庫名稱、表名稱、可以同步的數(shù)據(jù)總數(shù)）114.8.1.接口說明114.8.2.接口定義114.8.3.響應報文124.9.獲取用戶基本信息124.9.1.接口說明124.9.2.接口定義124.9.3.響應報文124.10.導入數(shù)據(jù)134.10.1.接口說明134.10.2.接口定義134.10.3.響應報文144.11.修改同步標志144.11.1.接口說

3、明144.11.2.接口定義144.11.3.響應報文151. 概述本文檔用于描述數(shù)據(jù)交互系統(tǒng)中，平臺部分與應用系統(tǒng)之間的接口。平臺部分作為基礎服務端，應用部分作為接口客戶端。平臺提供部門、用戶、權限、日志、字典等基本功能，應用部分進行調(diào)用。調(diào)用協(xié)議主要為基于Xml的Web Service協(xié)議。2. 結(jié)構(gòu)圖 WebServiceClientDB1DB2DB3DB 配置信息3. 總體說明3.1. 接口列表基礎服務平臺接口列表序號接口名稱接口說明備注1addOperLog記錄日記2checkLogin用戶登陸接口3generateXml導出數(shù)據(jù)4getDbTableName獲取數(shù)據(jù)庫與表的配置信息

4、5getDeptName獲取部門名稱6getFileRoot獲取文件的默認導出路徑7getPageSizeAndMaxCount獲取數(shù)據(jù)字典中導出數(shù)據(jù)最大值，一頁多少數(shù)據(jù)配置8getRowData獲取表信息（數(shù)據(jù)庫類型，數(shù)據(jù)庫名稱，表名稱，需要同步的數(shù)據(jù)總數(shù)）9getUser獲取用戶信息10loadToDBFromXmlFile導入數(shù)據(jù)11updateSynchflag修改數(shù)據(jù)同步標志3.2. 接口訪問方式一、 WSDL路徑：http:/localhost:8080/dataService/services/DataexchangeService?wsdl4. 接口描述4.1. 添加日志4.1

5、.1. 接口說明向數(shù)據(jù)庫添加操作日志4.1.2. 接口定義Ø 接口：void addOperLog(String userCode,String password,OpeLog opeLog)Ø 功能：添加用戶日志參數(shù)： userCode：用戶代碼 userPassword：用戶密碼opeLog：操作日志對象Ø 返回：無返回值4.1.3. 響應報文無4.2. 用戶登陸4.2.1. 接口說明應用系統(tǒng)登陸時，可以在自己的界面中調(diào)用此接口進行登陸認證。4.2.2. 接口定義Ø 接口：String checkLogin(String userCode,Strin

6、g userPassword)Ø 功能：用戶登陸Ø 參數(shù)： userCode：用戶代碼 userPassword：用戶密碼Ø 返回：見響應報文 4.2.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_CODE>返回代碼，true表示成功，false表示失敗</ RET_CODE ><RET_MSG>返回消息</RET_MSG></HEAD><BODY&

7、gt;</BODY></MSG>4.3. 導出數(shù)據(jù)4.3.1. 接口說明導出數(shù)據(jù)，返回ExportReturn對象，對象包含String success;（成功信息）String fail（異常信息），String primarKey（主鍵類型）;PkValue pkValue（主鍵值）;byte dataXML（導出的二進制數(shù)據(jù)）;4.3.2. 接口定義Ø 接口：ExportReturn generateXml(String userCode, String password, String srcDbName, String srcTbName, int

8、pageSize, int page, String pass)Ø 功能：導出二進制數(shù)據(jù)，日志等信息。Ø 參數(shù)：userCode:用戶賬號password:用戶密碼srcDbName:數(shù)據(jù)庫名稱srcTbName：表名pageSize：一次導多少條數(shù)據(jù)page：當前頁pass：加密密碼Ø 返回：ExportReturn 對象(Success：成功信息、Fail：異常信息、primarKey：主鍵列名、pkValue：導出數(shù)據(jù)的主鍵值、dataXML：導出的二進制數(shù)據(jù)）4.3.3. 響應報文<?xml version="1.0" encod

9、ing="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><DATA_XML>二進制數(shù)據(jù)</ DATA_XML > <PK_VALUE >主鍵值</ PK_VALUE><FAIL>異常信息</ FAIL >< PRIMARKEY >主鍵列名</ PRIMARKEY >< SUCCESS >成功信息</

10、SUCCESS></REC></BODY></MSG>4.4. 獲取數(shù)據(jù)庫與表的配置信息4.4.1. 接口說明獲取數(shù)據(jù)庫與表的配置信息，形成樹型結(jié)構(gòu)圖,返回一維數(shù)組。格式如下：String0:數(shù)據(jù)庫名稱，表名，表名，表名;String1:數(shù)據(jù)庫名稱，表名，表名4.4.2. 接口定義Ø 接口：String getDbTableName(String userCode, String password)Ø 功能：獲取數(shù)據(jù)庫與表配置信息Ø 參數(shù)：userCode：用戶代碼Password：用戶密碼Ø 返回：String

11、:4.4.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC>< ns:return >數(shù)據(jù)庫名稱，表名，表名。</ ns:return > < ns:return >數(shù)據(jù)庫名稱，表名。</ ns:return > </REC></BODY><

12、/MSG>4.5. 獲取部門名稱4.5.1. 接口說明通過部門ID獲取部門名稱4.5.2. 接口定義Ø 接口：String getDeptName(String userCode, String password, String deptId)Ø 功能：獲取用戶基本信息Ø 參數(shù)：userCode：用戶代碼Password：用戶名稱deptId：部門IDØ 返回：String 部門名稱4.5.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG&g

13、t;<HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC>< ns:return >部門名稱</ ns:return > </REC></BODY></MSG>4.6. 獲取數(shù)據(jù)字典中導出文件路徑4.6.1. 接口說明應用系統(tǒng)調(diào)用此接口獲取數(shù)據(jù)字典中導出文件的路徑。4.6.2. 接口定義Ø 接口：getFileRoot(String userCode, String password,String userKey)

14、Ø 功能：獲取導出時，文件夾的默認路徑Ø 參數(shù)：userCode:用戶編碼Password：用戶密碼userKey用戶編碼+”IN” or “OUT”Ø 返回：文件路徑4.6.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><ns:return>默認導出文件路徑</ns

15、:return > </REC></BODY></MSG>4.7. 獲取數(shù)據(jù)字典中導出數(shù)據(jù)最大值，一頁多少數(shù)據(jù)配置4.7.1. 接口說明獲取數(shù)據(jù)字典中導出數(shù)據(jù)最大值，一頁多少數(shù)據(jù)配置4.7.2. 接口定義Ø 接口：int getPageSizeAndMaxCount(String userCode, String password)Ø 功能：業(yè)務日志記錄Ø 參數(shù)：userCode:用戶編碼Password：用戶密碼Ø 返回：int0:tableSize(一次最多可導多少條數(shù)據(jù)),int1:pageSize（一個文

16、件存儲多少條數(shù)據(jù)）4.7.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><TABLESIZE>一次最多可導多少條數(shù)據(jù)</TABLESIZE > < PAGESIZE>一個文件存儲多少條數(shù)據(jù)</PAGESIZE ></REC></BODY><

17、;/MSG>4.8. 獲取表信息（數(shù)據(jù)庫類型、數(shù)據(jù)庫名稱、表名稱、可以同步的數(shù)據(jù)總數(shù)）4.8.1. 接口說明查詢導出數(shù)據(jù)表的，數(shù)據(jù)類型，數(shù)據(jù)庫名稱，表名稱，可以同步的數(shù)據(jù)總數(shù)4.8.2. 接口定義Ø 接口：String getRowData(String userCode, String password,String dbName, String tblName)Ø 功能：業(yè)務日志記錄Ø 參數(shù)：userCode:用戶編碼Password：用戶密碼dbName：數(shù)據(jù)庫名稱tblName：表名稱Ø 返回：String0:dbType(數(shù)據(jù)庫類型),S

18、tring1:dbName（數(shù)據(jù)庫名稱）,String2:tableName表名，String3 synCount:可同步的數(shù)據(jù)總數(shù)4.8.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><ns:return>數(shù)據(jù)庫類型</ns:return> <ns:return>數(shù)據(jù)庫名稱&l

19、t;/ns:return>< ns:return>表名稱</ ns:return ><ns:return>可同步的數(shù)據(jù)總條數(shù)</ns:return></REC></BODY></MSG>4.9. 獲取用戶基本信息4.9.1. 接口說明根據(jù)用戶代碼獲取用戶基本信息4.9.2. 接口定義Ø 接口：getUser(String userCode, String password)Ø 功能：獲取用戶基本信息Ø 參數(shù)：userCode：用戶代碼Password：密碼Ø 返回：

20、見響應報文4.9.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><USER_CODE>用戶代碼</USER_CODE > <USER_NAME >用戶名稱</ USER_NAME ><DEPT_ID >所屬部門序號</ DEPT_ID><

21、/REC></BODY></MSG>4.10. 導入數(shù)據(jù)4.10.1. 接口說明通過IO字節(jié)流獲取導入文件（加過密）的二進制byte導入數(shù)據(jù)，webService 服務器端會先解密byte，再以xml的方式解析byte，最后導入數(shù)據(jù)庫。4.10.2. 接口定義Ø 接口：String loadToDBFromXmlFile(String userCode, String password,String dbName, String tableName, byte data, String pass,String fileName)Ø 功能：通過I

22、mportParam里的DataHandler導入數(shù)據(jù)Ø 參數(shù)：userCode：用戶代碼Password：用戶密碼dbName：數(shù)據(jù)庫名稱tableName：表名data：二進制數(shù)據(jù)pass：加密密碼fileName：文件名稱Ø 返回：String0:true(成功) or false (失敗)Stirng1:成功信息String2:異常信息4.10.3. 響應報文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><USER_CODE>用戶代碼</USER_CODE > <USER_NAME >用戶名稱</ USER_NAME ><

溫馨提示

  • 1. 本站所有資源如無特殊說明，都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等，如果需要附件，請聯(lián)系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙，網(wǎng)頁內(nèi)容里面會有圖紙預覽，若沒有圖紙預覽就沒有圖紙。
  • 4. 未經(jīng)權益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間，僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理，對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯，并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權或不適當內(nèi)容，請與我們聯(lián)系，我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論