枚举字典
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 | 否 | 字典名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 必须 | 状态码 成功时返回200 | ||
| msg | string | 必须 | 成功时返回success 失败时返回用户提示信息 | ||
| data | object [] | 必须 | 成功时返回数据 失败时返回开发提示信息 | item 类型: object | |
| ├─ key | string | 必须 | 字典id | ||
| ├─ title | string | 必须 | 字典名称 | ||
| ├─ id | string | 必须 | 字典id | ||
| ├─ type | number,null | 必须 | 字典类型,0 string,1 number,2 boolean | ||
| ├─ dictName | null | 必须 | 字典名称 | ||
| ├─ dictCode | string | 必须 | 字典编码 | ||
| ├─ description | null,string | 必须 | 描述 | ||
| ├─ delFlag | number | 必须 | 删除状态 | ||
| ├─ createBy | null | 必须 | 创建人 | ||
| ├─ createTime | null | 必须 | 创建时间 | ||
| ├─ updateBy | null | 必须 | 更新人 | ||
| ├─ updateTime | null | 必须 | 更新时间 |
通过查询指定code 获取字典
基本信息
Path: /tng-boot/md/edic/dict/getDictItems/{dictCode}
Method: GET
接口描述:
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| dictCode | 字典编码 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 必须 | 状态码 成功时返回200 | ||
| msg | string | 必须 | 成功时返回success 失败时返回用户提示信息 | ||
| data | object [] | 必须 | 成功时返回数据 失败时返回开发提示信息 | item 类型: object | |
| ├─ title | string | 必须 | 字典文本 | ||
| ├─ value | string | 必须 | 字典value | ||
| ├─ text | string | 必须 | 字典文本 |
通过查询指定code 指定字典值value 获取字典值text
基本信息
Path: /tng-boot/md/edic/dict/getDictText/{dictCode}/{value}
Method: GET
接口描述:
请求参数
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| dictCode | 字典编码 | |
| value | 字典value |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 必须 | 状态码 成功时返回200 | ||
| msg | string | 必须 | 成功时返回success 失败时返回用户提示信息 | ||
| data | string | 必须 | 成功时返回数据 失败时返回开发提示信息 |
新增字典
基本信息
Path: /tng-boot/md/edic/dict/add
Method: POST
接口描述:
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| type | number | 必须 | 字典类型,0 string,1 number类型,2 boolean | ||
| dictName | string | 必须 | 字典名称 | ||
| dictCode | string | 必须 | 字典编码 | ||
| description | string | 非必须 | 描述 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 必须 | |||
| msg | string | 必须 | |||
| data | string | 必须 |
编辑字典
基本信息
Path: /tng-boot/md/edic/dict/edit
Method: PUT
接口描述:
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| id | string | 必须 | 字典id | ||
| dictName | string | 必须 | 字典名称 | ||
| dictCode | string | 必须 | 字典编码 | ||
| description | string | 非必须 | 描述 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 必须 | |||
| msg | string | 必须 | |||
| data | string | 必须 |
删除字典
基本信息
Path: /tng-boot/md/edic/dict/delete
Method: DELETE
接口描述:
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 是 | 字典id |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 必须 | |||
| msg | string | 必须 | |||
| data | string | 必须 |
查询字典数据
基本信息
Path: /tng-boot/md/edic/dictItem/list
Method: GET
接口描述:
请求参数
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| dictId | 是 | 字典id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 非必须 | |||
| msg | string | 非必须 | |||
| data | object | 非必须 | |||
| ├─ records | object [] | 非必须 | 数据列表 | item 类型: object | |
| ├─ createBy | string | 必须 | 创建人 | ||
| ├─ createTime | string | 必须 | 创建时间 | ||
| ├─ updateBy | string,null | 必须 | 更新人 | ||
| ├─ itemValue | string | 必须 | 字典项值 | ||
| ├─ sortOrder | null | 必须 | 排序 | ||
| ├─ description | null | 必须 | 描述 | ||
| ├─ updateTime | string,null | 必须 | 更新时间 | ||
| ├─ id | string | 必须 | 主键id | ||
| ├─ dictId | string | 必须 | 字典id | ||
| ├─ status_dictText | string | 必须 | 状态(1启用 0不启用) | ||
| ├─ itemText | string | 必须 | 字典项文本 | ||
| ├─ status | number | 必须 | 状态(1启用 0不启用) | ||
| ├─ total | number | 非必须 | 总条数 | ||
| ├─ size | number | 非必须 | 每页条数 | ||
| ├─ current | number | 非必须 | 当前页码 | ||
| ├─ pages | number | 非必须 | 总页数 |
新增字典数据
基本信息
Path: /tng-boot/md/edic/dictItem/add
Method: POST
接口描述:
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| dictId | string | 必须 | 字典id | ||
| itemText | string | 必须 | 字典项文本 | ||
| itemValue | string | 必须 | 字典项值 | ||
| description | string | 非必须 | 描述 | ||
| sortOrder | number | 必须 | 排序 | ||
| status | number | 必须 | 状态(1启用 0不启用) |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 非必须 | |||
| msg | string | 非必须 | |||
| data | string | 非必须 |
编辑字典数据
基本信息
Path: /tng-boot/md/edic/dictItem/edit
Method: PUT
接口描述:
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| dictId | string | 必须 | 字典id | ||
| itemText | string | 必须 | 字典项文本 | ||
| itemValue | string | 必须 | 字典项值 | ||
| description | string | 非必须 | 描述 | ||
| sortOrder | number | 必须 | 排序 | ||
| status | number | 必须 | 状态(1启用 0不启用) | ||
| id | string | 必须 | 主键id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 非必须 | |||
| msg | string | 非必须 | |||
| data | string | 非必须 |
删除字典数据
基本信息
Path: /tng-boot/md/edic/dictItem/delete
Method: DELETE
接口描述:
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| id | 是 | 字典数据id |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| status | number | 非必须 | |||
| msg | string | 非必须 | |||
| data | string | 非必须 |