數(shù)據(jù)字典系統(tǒng)接口文檔

1、數(shù)據(jù)字典接口文檔版本修訂信息數(shù)據(jù)字典接口文檔（V0.0.1 ）2015 年 6 月版本號完成日期擬稿和修改人發(fā)布日期變更說明V1.0.0新建文檔目錄1 文檔說明 41.1 功能描述 41.2 閱讀對象 41.3 業(yè)務(wù)術(shù)語 42 ERP系統(tǒng)開發(fā)準(zhǔn)備 42.1 技術(shù)資料獲取及準(zhǔn)備 42.1.1 確認(rèn)調(diào)用系統(tǒng)信息 42.2 環(huán)境搭建 53 數(shù)據(jù)字典接口調(diào)用流程 53.1 數(shù)據(jù)字典接口調(diào)用流程圖 53.2 數(shù)據(jù)字典接口調(diào)用步驟 53.2.1 構(gòu)造請求數(shù)據(jù) 53.2.2 發(fā)送請求數(shù)據(jù) 63.2.3 請求字符集設(shè)置 錯(cuò)誤！未定義書簽。3.2.4 數(shù)據(jù)字典系統(tǒng)對請求數(shù)據(jù)進(jìn)行處理 63.2.5 返回處理的結(jié)果

2、數(shù)據(jù) 64 接口說明 64.1 獲取數(shù)據(jù)字典生效 KEY 錯(cuò)誤！未定義書簽。4.1.1 請求參數(shù)列表 錯(cuò)誤！未定義書簽。4.1.2 應(yīng)答參數(shù) 錯(cuò)誤！未定義書簽。4.1.3 使用舉例 錯(cuò)誤！未定義書簽。5 常見問題及注意事項(xiàng) 105.1 調(diào)用方式 105.2 頁面組件使用 錯(cuò)誤！未定義書簽。6 附錄 106.1 請求響應(yīng)碼 106.2 數(shù)據(jù)字典系統(tǒng)KEY列表 111 文檔說明1.1 功能描述本文檔從技術(shù)角度描述了使用字典系統(tǒng)的字典數(shù)據(jù)的使用方法， 進(jìn)而指導(dǎo)系統(tǒng)開發(fā)者與 數(shù)據(jù)字典系統(tǒng)的對接。1.2 閱讀對象本文檔是面向具有一定開發(fā)能力的開發(fā)者。1.3 業(yè)務(wù)術(shù)語術(shù)語解釋字典類目類似字典的分類 分組描

3、述。字典項(xiàng)具體使用的字典數(shù)據(jù) 包括編碼 名稱和值。字典關(guān)聯(lián)配置配置兩個(gè)字典類目間字典項(xiàng)的關(guān)聯(lián)2 ERP系統(tǒng)開發(fā)準(zhǔn)備2.1 技術(shù)資料獲取及準(zhǔn)備2.1.1 確認(rèn)調(diào)用系統(tǒng)信息確認(rèn)要調(diào)用的接口，以及對應(yīng)數(shù)據(jù)項(xiàng)的 KEY。 確系統(tǒng)使用的編碼格式為 UTF-8 。確認(rèn)拿到的是接口資料為要使用的版本2.2 環(huán)境搭建本機(jī)電腦的調(diào)試環(huán)境開發(fā)工具： Eclipse 或 Myeclipse 等；編輯工具： EditPlus 、NotePad+、電腦自帶的“記事本”等 環(huán)境配置：使用 JAVA開發(fā)需要 JAVA的環(huán)境配置。 使用其他語言開發(fā)需要配 置相對該語言的環(huán)境。服務(wù)器的調(diào)試環(huán)境 硬件方面：由于網(wǎng)上支付平臺提供的

4、軟件同商戶的系統(tǒng)緊密集成， 通常不需 要額外的硬件投資。軟件方面： java 語言的 JDK1.5或以上，操作系統(tǒng)不限，服務(wù)器需要支持各 開發(fā)語言對應(yīng)的環(huán)境，如果是 pom工程 需要引入：com.caissa.erpdict 0.0.1 備注：版本號可能會隨著系統(tǒng)升級發(fā)生變化，以接入時(shí)的系統(tǒng)給出的為準(zhǔn)。3 數(shù)據(jù)字典接口調(diào)用流程3.1 數(shù)據(jù)字典接口調(diào)用流程圖3.2 數(shù)據(jù)字典接口調(diào)用步驟3.2.1 構(gòu)造請求數(shù)據(jù)系統(tǒng)開發(fā)人員根據(jù)要需求確認(rèn)要請求的接口，以及接口的主要數(shù)據(jù)，主要包 括：接口的方法，接口的參數(shù)值。(1) 請求參數(shù)如下：將請求參數(shù)拼裝成請求對象后，3.2.2 發(fā)送請求數(shù)據(jù)接口交互方式為：

5、dubbo。 服務(wù)注冊中心 zookeeper 地址如下： 生產(chǎn)環(huán)境地址： 測試環(huán)境地址：3.2.3 數(shù)據(jù)字典系統(tǒng)對請求數(shù)據(jù)進(jìn)行處理3.2.4 返回處理的結(jié)果數(shù)據(jù)4 接口說明為了方便接口的統(tǒng)一管理，以下接口都需要基于基礎(chǔ)請求和基礎(chǔ)應(yīng)答基礎(chǔ)請求參數(shù)參數(shù)參數(shù)名稱類型長度必填參數(shù)說明version版本號字符串16是Version=0.0.1method接口編碼字符串64是reqSysCode請求系統(tǒng)編碼字符串8是UicreqSysDate請求系統(tǒng)時(shí)間字符串是格式y(tǒng)yyyMMddHH24mmssexpandAttr請求擴(kuò)展字段Json 字 符串否請求數(shù)據(jù)需擴(kuò)展時(shí)，使用此字段基礎(chǔ)應(yīng)答參數(shù)參數(shù)參數(shù)名稱類型

6、長度必填參數(shù)說明respCode應(yīng)答編碼字符串是Succ 成功 其他未異常respDesc應(yīng)答描述字符串expandAttr應(yīng)答擴(kuò)展屬性字符串否接口使用的 dubbo 接口接口需要引入 dict0.0.1.jar在 dubbo 配置文件 加入4.1 獲取類目下的字典項(xiàng)接口編號： DICT-002方法名稱： getCatalogDownItem4.1.1 請求參數(shù)參數(shù)參數(shù)名稱類型長度必填參數(shù)說明類目編號catalogCode字符串是根據(jù)此編碼查找對應(yīng)的本級 和下級類目信息 類目編碼是多個(gè)串，用逗號 隔開 但是類目順序是 也是 層級關(guān)系 例如：省，市，縣 而且類目編碼的數(shù)量和字典 項(xiàng)深度是一致 如

7、何類目編 碼是倆個(gè) 字典項(xiàng)深度是 1 會提示參數(shù)錯(cuò)誤歸屬系統(tǒng)belongSys字符串12否字典項(xiàng)深度Level數(shù)字否數(shù)字從 1 開始，如果為 1 返 回當(dāng)前類目下的字典項(xiàng)，如 果非 0 返回 level 層級的字 典項(xiàng)字符串，如果實(shí)際層級 小于穿過來的層級，則返回 實(shí)際層級。最大級不能超過 3. 默認(rèn)： 14.1.2 應(yīng)答參數(shù)參數(shù)參數(shù)名稱類型長度必填參數(shù)說明類目列表：ItemListListDictItem 屬性：類目編號catalogCode字符串6是類目名稱catalogName字符串32是字典項(xiàng)編碼itemCode字符串6否字典項(xiàng)名稱itemName字典項(xiàng)值itemValue字典排序Se

8、quenceNum數(shù)字是否啟用isEnable字符串?dāng)U展屬性extendAttr字符串生效時(shí)間起startDate字符串格式y(tǒng)yyyMMddHH24mmss生效時(shí)間止endDate字符串格式y(tǒng)yyyMMddHH24mmss4.1.3 使用舉例在使用類里需要注入進(jìn)來，和使用 service 是一樣調(diào)用 Resource (name = dictItemsService ) private DictItemsService dictItemsService ;4.2 獲取字典項(xiàng)下的字典項(xiàng)接口編號： DICT-003方法名稱： getCatalogAndItemDownItem4.2.1 請求參數(shù)參

9、數(shù)參數(shù)名稱類型長度必填參數(shù)說明類目編號catalogCode字符串6是根據(jù)此編碼查找對應(yīng)的本級 和下級類目信息 類目編碼是多個(gè)串，用逗號 隔開 但是類目順序是 也是 層級關(guān)系 例如：省，市，縣 而且類目編碼的數(shù)量和字典 項(xiàng)深度是一致 如何類目編 碼是倆個(gè) 字典項(xiàng)深度是 1 會提示參數(shù)錯(cuò)誤字典項(xiàng)編碼itemCode字符串8是這個(gè)就是一個(gè)編碼歸屬系統(tǒng)belongSys字符串12否字典項(xiàng)深度Level數(shù)字否數(shù)字從 1 開始，如果為 1 返 回當(dāng)前類目下的字典項(xiàng)，如 果非 0 返回 level 層級的字 典項(xiàng)字符串，如果實(shí)際層級 小于穿過來的層級，則返回 實(shí)際層級。最大級不能超過 3. 默認(rèn)： 14.2.2 應(yīng)答參數(shù)參數(shù)參數(shù)名稱類型長度必填參數(shù)說明類目列表：ItemListListDictItem 屬性：類目編號catalogCode字符串6是類目名稱catalogName字符串32是字典項(xiàng)編碼itemCode字符串6否字典項(xiàng)名稱itemName字典項(xiàng)值itemValue字典排序SequenceNum數(shù)字是否啟用isEnable字符串?dāng)U展屬性extendAttr字符串生效時(shí)間起startDate字符串格式y(tǒng)yyyMMddHH24mmss生效時(shí)間止endDate字符串格式y(tǒng)yyyMMddHH24mmss4.2.3 使用舉例和上面的使用方式一樣5 常