枚举字典

domain说明

序号 系统 环境 地址 备注
1 宜兴政企通 测试 https://test-gateway.eazytec-cloud.com/YX 适用【宜兴政企通】
2 宜兴政企通 线上 https://gateway.eazytec-cloud.com/YX 暂未发布
3 宜兴政企通 线上-政务外网 http://10.36.12.1:8000/YX(vpn) http://2.18.243.11:8000/YX(政务外网) 暂未发布

枚举字典相关接口

序号 接口详情 地址
1.1 获取树形字典数据 {domain}/tng-boot/md/edic/dict/treeList
1.2 通过查询指定code 获取字典 {domain}/tng-boot/md/edic/dict/getDictItems/{dictCode}
1.3 通过查询指定code 指定字典值value 获取字典值text {domain}/tng-boot/md/edic/dict/getDictText/{dictCode}/{value}
1.4 新增字典 {domain}/tng-boot/md/edic/dict/add
1.5 编辑字典 {domain}/tng-boot/md/edic/dict/edit
1.6 删除字典 {domain}/tng-boot/md/edic/dict/delete
1.7 查询字典数据 {domain}/tng-boot/md/edic/dictItem/list
1.8 新增字典数据 {domain}/tng-boot/md/edic/dictItem/add
1.9 编辑字典数据 {domain}/tng-boot/md/edic/dictItem/edit
1.10 删除字典数据 {domain}/tng-boot/md/edic/dictItem/delete

获取树形字典数据

基本信息

Path: /tng-boot/md/edic/dict/treeList

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
dictName 字典名称

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须状态码 成功时返回200
msgstring必须成功时返回success 失败时返回用户提示信息
dataobject []必须成功时返回数据 失败时返回开发提示信息

item 类型: object

├─ keystring必须字典id
├─ titlestring必须字典名称
├─ idstring必须字典id
├─ typenumber,null必须字典类型,0 string,1 number,2 boolean
├─ dictNamenull必须字典名称
├─ dictCodestring必须字典编码
├─ descriptionnull,string必须描述
├─ delFlagnumber必须删除状态
├─ createBynull必须创建人
├─ createTimenull必须创建时间
├─ updateBynull必须更新人
├─ updateTimenull必须更新时间

通过查询指定code 获取字典

基本信息

Path: /tng-boot/md/edic/dict/getDictItems/{dictCode}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
dictCode 字典编码

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须状态码 成功时返回200
msgstring必须成功时返回success 失败时返回用户提示信息
dataobject []必须成功时返回数据 失败时返回开发提示信息

item 类型: object

├─ titlestring必须字典文本
├─ valuestring必须字典value
├─ textstring必须字典文本

通过查询指定code 指定字典值value 获取字典值text

基本信息

Path: /tng-boot/md/edic/dict/getDictText/{dictCode}/{value}

Method: GET

接口描述:

请求参数

路径参数

参数名称 示例 备注
dictCode 字典编码
value 字典value

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须状态码 成功时返回200
msgstring必须成功时返回success 失败时返回用户提示信息
datastring必须成功时返回数据 失败时返回开发提示信息

新增字典

基本信息

Path: /tng-boot/md/edic/dict/add

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
typenumber必须字典类型,0 string,1 number类型,2 boolean
dictNamestring必须字典名称
dictCodestring必须字典编码
descriptionstring非必须描述

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
datastring必须

编辑字典

基本信息

Path: /tng-boot/md/edic/dict/edit

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
idstring必须字典id
dictNamestring必须字典名称
dictCodestring必须字典编码
descriptionstring非必须描述

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
datastring必须

删除字典

基本信息

Path: /tng-boot/md/edic/dict/delete

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
id 字典id

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
statusnumber必须
msgstring必须
datastring必须

查询字典数据

基本信息

Path: /tng-boot/md/edic/dictItem/list

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
dictId 字典id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
dataobject非必须
├─ recordsobject []非必须数据列表

item 类型: object

├─ createBystring必须创建人
├─ createTimestring必须创建时间
├─ updateBystring,null必须更新人
├─ itemValuestring必须字典项值
├─ sortOrdernull必须排序
├─ descriptionnull必须描述
├─ updateTimestring,null必须更新时间
├─ idstring必须主键id
├─ dictIdstring必须字典id
├─ status_dictTextstring必须状态(1启用 0不启用)
├─ itemTextstring必须字典项文本
├─ statusnumber必须状态(1启用 0不启用)
├─ totalnumber非必须总条数
├─ sizenumber非必须每页条数
├─ currentnumber非必须当前页码
├─ pagesnumber非必须总页数

新增字典数据

基本信息

Path: /tng-boot/md/edic/dictItem/add

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
dictIdstring必须字典id
itemTextstring必须字典项文本
itemValuestring必须字典项值
descriptionstring非必须描述
sortOrdernumber必须排序
statusnumber必须状态(1启用 0不启用)

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring非必须

编辑字典数据

基本信息

Path: /tng-boot/md/edic/dictItem/edit

Method: PUT

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Body

名称类型是否必须默认值备注其他信息
dictIdstring必须字典id
itemTextstring必须字典项文本
itemValuestring必须字典项值
descriptionstring非必须描述
sortOrdernumber必须排序
statusnumber必须状态(1启用 0不启用)
idstring必须主键id

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring非必须

删除字典数据

基本信息

Path: /tng-boot/md/edic/dictItem/delete

Method: DELETE

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json

Query

参数名称 是否必须 示例 备注
id 字典数据id

Body

名称类型是否必须默认值备注其他信息

返回数据

名称类型是否必须默认值备注其他信息
statusnumber非必须
msgstring非必须
datastring非必须
江苏卓易信息科技股份有限公司-TNG基础平台组 all right reserved,powered by Gitbook该文件最后修改时间: 2021-01-27 06:23:28

results matching ""

    No results matching ""