数据字典系统接口文档.doc

数据字典接口文档 数据字典接口文档（V0.0.1） 2015年6月 版本修订信息版本号完成日期拟稿和修改人发布日期变更说明V1.0.0新建文档 目录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发送请求数据53.2.3请求字符集设置63.2.4数据字典系统对请求数据进行处理63.2.5返回处理的结果数据64接口说明64.1获取数据字典生效KEY64.1.1请求参数列表64.1.2应答参数64.1.3使用举例75常见问题及注意事项75.1调用方式75.2页面组件使用76附录76.1请求响应码76.2数据字典系统KEY列表71 文档说明1.1 功能描述本文档从技术角度描述了使用字典系统的字典数据的使用方法，进而指导系统开发者与数据字典系统的对接。1.2 阅读对象本文档是面向具有一定开发能力的开发者。1.3 业务术语术语解释字典类目类似字典的分类 分组描述。字典项具体使用的字典数据 包括编码 名称和值。字典关联配置配置两个字典类目间字典项的关联2 ERP系统开发准备2.1 技术资料获取及准备2.1.1 确认调用系统信息u 确认要调用的接口，以及对应数据项的KEY。u 确系统使用的编码格式为UTF-8 。u 确认拿到的是接口资料为要使用的版本。 2.2 环境搭建u 本机电脑的调试环境 开发工具： Eclipse 或 Myeclipse 等； 编辑工具：EditPlus、NotePad+、电脑自带的“记事本”等 环境配置：使用JAVA开发需要JAVA的环境配置。使用其他语言开发需要配置相对该语言的环境。 u 服务器的调试环境 硬件方面：由于网上支付平台提供的软件同商户的系统紧密集成，通常不需要额外的硬件投资。软件方面：java语言的JDK1.5或以上，操作系统不限，服务器需要支持各开发语言对应的环境， 如果是pom工程 需要引入： com.caissa.erp dict 0.0.1备注：版本号可能会随着系统升级发生变化，以接入时的系统给出的为准。3 数据字典接口调用流程3.1 数据字典接口调用流程图3.2 数据字典接口调用步骤3.2.1 构造请求数据系统开发人员根据要需求确认要请求的接口，以及接口的主要数据，主要包括：接口的方法，接口的参数值。(1)请求参数如下：将请求参数拼装成请求对象后， 3.2.2 发送请求数据接口交互方式为：dubbo。服务注册中心 zookeeper地址如下：生产环境地址：测试环境地址：3.2.3 数据字典系统对请求数据进行处理3.2.4 返回处理的结果数据 4 接口说明为了方便接口的统一管理，以下接口都需要基于基础请求和基础应答。基础请求参数参数参数名称类型长度必填参数说明version版本号字符串16是Version=0.0.1method接口编码字符串64是reqSysCode请求系统编码字符串8是UicreqSysDate请求系统时间字符串是格式yyyyMMddHH24mmssexpandAttr请求扩展字段Json字符串否请求数据需扩展时，使用此字段基础应答参数参数参数名称类型长度必填参数说明respCode应答编码字符串是Succ 成功 其他未异常respDesc应答描述字符串expandAttr应答扩展属性字符串否接口使用的dubbo 接口接口需要引入dict0.0.1.jar 在dubbo配置文件 加入4.1 获取类目下的字典项接口编号：DICT-002方法名称：getCatalogDownItem4.1.1 请求参数参数参数名称类型长度必填参数说明类目编号catalogCode字符串是根据此编码查找对应的本级和下级类目信息类目编码是多个串，用逗号隔开 但是类目顺序是 也是层级关系 例如：省，市，县 而且类目编码的数量和字典项深度是一致 如何类目编码是俩个 字典项深度是1 会提示参数错误归属系统belongSys字符串12否字典项深度Level数字否数字从1开始，如果为1返回当前类目下的字典项，如果非0返回level层级的字典项字符串，如果实际层级小于穿过来的层级，则返回实际层级。最大级不能超过3. 默认：14.1.2 应答参数参数参数名称类型长度必填参数说明类目列表：ItemListListDictItem属性：类目编号catalogCode字符串6是类目名称catalogName字符串32是字典项编码itemCode字符串6否字典项名称itemName字典项值itemValue字典排序SequenceNum数字是否启用isEnable字符串扩展属性extendAttr字符串生效时间起startDate字符串格式yyyyMMddHH24mmss生效时间止endDate字符串格式yyyyMMddHH24mmss4.1.3 使用举例在使用类里需要注入进来，和使用service 是一样调用。Resource(name = dictItemsService)private DictItemsService dictItemsService;4.2 获取字典项下的字典项接口编号：DICT-003方法名称：getCatalogAndItemDownItem4.2.1 请求参数参数参数名称类型长度必填参数说明类目编号catalogCode字符串6是根据此编码查找对应的本级和下级类目信息类目编码是多个串，用逗号隔开 但是类目顺序是 也是层级关系 例如：省，市，县 而且类目编码的数量和字典项深度是一致 如何类目编码是俩个 字典项深度是1 会提示参数错误字典项编码itemCode字符串8是这个就是一个编码归属系统belongSys字符串12否字典项深度Level数字否 数字从1开始，如果为1返回当前类目下的字典项，如果非0返回level层级的字典项字符串，如果实际层级小于穿过来的层级，则返回实际层级。最大级不能超过3. 默认：14.2.2 应答参数参数参数名称类型长度必填参数说明类目列表：ItemListListDictItem属性：类目编号catalogCode字符串6是类目名称catalogName字符串32是字典项编码itemCode字符串6否字典项名称itemName字典项值itemValue字典排序SequenceNum数字是否启用isEnable字符串扩展属性extendAttr字符串生效时间起startDate字符串格式yyyyMMddHH24mmss生效时间止endDate字符串格式yyyyMMddHH24mmss4.2.3 使用举例和上面的使用方式一样5 常见问题及注意事