2022年数据字典系统接口文定义 .pdf

《2022年数据字典系统接口文定义 .pdf》由会员分享，可在线阅读，更多相关《2022年数据字典系统接口文定义 .pdf（11页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、数据字典接口文档数据字典接口文档（V0.0.1 ）版本修订信息2015年6 月名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 11 页 - - - - - - - - - 数据字典接口文档版本号完成日期拟稿和修改人发布日期变更说明V1.0.0 新建文档名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 11 页 - - - - - - - - - 数据字

2、典接口文档目录1文档说明 . 41.1功能描述 . 41.2阅读对象 . 41.3业务术语 . 42ERP系统开发准备 . 42.1技术资料获取及准备. 42.1.1确认调用系统信息 . 42.2环境搭建 . 53数据字典接口调用流程 . 53.1数据字典接口调用流程图. 53.2数据字典接口调用步骤. 53.2.1构造请求数据 . 53.2.2发送请求数据 . 63.2.3请求字符集设置 . 错误！未定义书签。3.2.4数据字典系统对请求数据进行处理 . 63.2.5返回处理的结果数据 . 64接口说明 . 64.1获取数据字典生效KEY . 错误！未定义书签。4.1.1请求参数列表 . 错

3、误！未定义书签。4.1.2应答参数 . 错误！未定义书签。4.1.3使用举例 . 错误！未定义书签。5常见问题及注意事项 . 105.1调用方式 . 105.2页面组件使用 . 错误！未定义书签。6附录 . 106.1请求响应码 . 106.2数据字典系统KEY列表 . 11名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 11 页 - - - - - - - - - 数据字典接口文档1 文档说明1.1功能描述本文档从技术角度描述了使用字典系统的字典数据的使用方法，进而指导

4、系统开发者与数据字典系统的对接。1.2阅读对象本文档是面向具有一定开发能力的开发者。1.3业务术语术语解释字典类目类似字典的分类分组描述。字典项具体使用的字典数据包括编码名称和值。字典关联配置配置两个字典类目间字典项的关联2 ERP系统开发准备2.1技术资料获取及准备2.1.1 确认调用系统信息确认要调用的接口，以及对应数据项的KEY 。确系统使用的编码格式为UTF-8 。确认拿到的是接口资料为要使用的版本。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 11 页 - -

5、 - - - - - - - 数据字典接口文档2.2环境搭建本机电脑的调试环境开发工具： Eclipse 或 Myeclipse 等；编辑工具： EditPlus 、NotePad+ 、电脑自带的“记事本”等环境配置：使用 JAVA开发需要 JAVA的环境配置。使用其他语言开发需要配置相对该语言的环境。服务器的调试环境硬件方面：由于网上支付平台提供的软件同商户的系统紧密集成，通常不需要额外的硬件投资。软件方面： java 语言的 JDK1.5或以上，操作系统不限，服务器需要支持各开发语言对应的环境，如果是 pom工程 需要引入： com.caissa.erp dict 0.0.1 备注：版本号

6、可能会随着系统升级发生变化，以接入时的系统给出的为准。3数据字典接口调用流程3.1数据字典接口调用流程图3.2数据字典接口调用步骤3.2.1 构造请求数据系统开发人员根据要需求确认要请求的接口，以及接口的主要数据，主要包括：接口的方法，接口的参数值。(1) 请求参数如下：将请求参数拼装成请求对象后，名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 11 页 - - - - - - - - - 数据字典接口文档3.2.2 发送请求数据接口交互方式为： dubbo。服务注册中心

7、 zookeeper 地址如下：生产环境地址：测试环境地址：3.2.3 数据字典系统对请求数据进行处理3.2.4 返回处理的结果数据4接口说明为了方便接口的统一管理，以下接口都需要基于基础请求和基础应答。基础请求参数参数参数名称类型长度必填参数说明version 版本号字符串16 是Version=0.0.1 method 接口编码字符串64 是reqSysCode 请求系统编码字符串8 是Uic reqSysDate 请求系统时间字符串是格式yyyyMMddHH24mmssexpandAttr 请求扩展字段Json 字符串否请求数据需扩展时，使用此字段基础应答参数参数参数名称类型长度必填参数

8、说明respCode 应答编码字符串是Succ 成功其他未异常respDesc 应答描述字符串expandAttr 应答扩展属性字符串否接口使用的 dubbo 接口接口需要引入 dict0.0.1.jar 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页，共 11 页 - - - - - - - - - 数据字典接口文档在 dubbo配置文件加入 4.1获取类目下的字典项接口编号： DICT-002 方法名称： getCatalogDownItem4.1.1 请求参数参数参数名

9、称类型长度必填参数说明类目编号catalogCode 字符串是根据此编码查找对应的本级和下级类目信息类目编码是多个串，用逗号隔开 但是类目顺序是也是层级关系例如：省，市，县而且类目编码的数量和字典项深度是一致如何类目编码是俩个字典项深度是1 会提示参数错误归属系统belongSys 字符串12 否字典项深度Level 数字否数字从 1 开始，如果为1 返回当前类目下的字典项，如果非 0 返回 level层级的字典项字符串，如果实际层级小于穿过来的层级，则返回实际层级。最大级不能超过3. 默认： 1名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - -

10、- - - - 名师精心整理 - - - - - - - 第 7 页，共 11 页 - - - - - - - - - 数据字典接口文档4.1.2应答参数参数参数名称类型长度必填参数说明类目列表：ItemList List DictItem属性：类目编号catalogCode 字符串6 是类目名称catalogName 字符串32 是字典项编码itemCode 字符串6 否字典项名称itemName 字典项值itemValue 字典排序SequenceNum 数字是否启用isEnable 字符串扩展属性extendAttr 字符串生效时间起startDate 字符串格式yyyyMMddHH24

11、mmss生效时间止endDate 字符串格式yyyyMMddHH24mmss4.1.3使用举例在使用类里需要注入进来，和使用service 是一样调用。Resource (name = dictItemsService) private DictItemsService dictItemsService;4.2获取字典项下的字典项接口编号： DICT-003方法名称： getCatalogAndItemDownItem 4.2.1 请求参数参数参数名称类型长度必填参数说明名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整

12、理 - - - - - - - 第 8 页，共 11 页 - - - - - - - - - 数据字典接口文档类目编号catalogCode 字符串6 是根据此编码查找对应的本级和下级类目信息类目编码是多个串，用逗号隔开 但是类目顺序是也是层级关系例如：省，市，县而且类目编码的数量和字典项深度是一致如何类目编码是俩个字典项深度是1 会提示参数错误字典项编码itemCode 字符串8 是这个就是一个编码归属系统belongSys 字符串12 否字典项深度Level 数字否数字从 1 开始，如果为1 返回当前类目下的字典项，如果非 0 返回 level层级的字典项字符串，如果实际层级小于穿过来的层

13、级，则返回实际层级。最大级不能超过3. 默认： 14.2.2应答参数参数参数名称类型长度必填参数说明类目列表：ItemList List DictItem属性：类目编号catalogCode 字符串6 是类目名称catalogName 字符串32 是字典项编码itemCode 字符串6 否名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 9 页，共 11 页 - - - - - - - - - 数据字典接口文档字典项名称itemName 字典项值itemValue 字典排序Sequen

14、ceNum 数字是否启用isEnable 字符串扩展属性extendAttr 字符串生效时间起startDate 字符串格式yyyyMMddHH24mmss生效时间止endDate 字符串格式yyyyMMddHH24mmss4.2.3使用举例和上面的使用方式一样5常见问题及注意事项5.1调用方式调用方式有两种 1 接口调用获取数据6附录6.1请求响应码响应码说明SUCCESS 成功ILLEGAL_ARGUMENT 参数不正确ILLEGAL_MERCHANT_NO KEY不存在NO_DATA 无数据名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 10 页，共 11 页 - - - - - - - - - 数据字典接口文档6.2数据字典系统KEY列表序列编码类别描述1 2 3 4 5 6 7 8 9 10 11 12 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 11 页，共 11 页 - - - - - - - - -