kboss/b/appcode/编码表接口说明.md

### 编码增加

请求URL：

<http://47.93.12.75:8888/appcode/appCodesAdd.dspy>

请求示例

```
添加Code表
{
   'id': 'user_status',
   'name': '用户状态',
   'hierarchy_flg': '0'
}

添加kv表
{
		'kv': '1', 
    'codeid':'user_status', 
    'parentid': '123', 
    'k': '2', 
    'v': '休息中'
}
```

请求参数说明 

添加Code表

| 参数          | 类型   | 必填 | 描述                  |
| ------------- | ------ | ---- | --------------------- |
| id            | String | 是   | 英文名称例如：status  |
| name          | String | 是   | 中文名称 例如：状态   |
| hierarchy_flg | String | 是   | 多级标志 0/1 是否多级 |



添加kv表

| 参数     | 类型   | 必填 | 描述           |
| -------- | ------ | ---- | -------------- |
| kv       | String | 是   | 添加kv表 值为1 |
| codeid   | String | 是   | Code表中的id   |
| parentid | String | 是   | 父级id         |
| k        | String | 是   | 键             |
| v        | String | 是   | 值             |

返回示例 

```
添加成功
    {
    	"status": true,
    	"msg": "add success"
		}
添加失败
    {
    	"status": False,
    	"msg": "add failed"
		}
```

### 编码删除

请求URL：

<http://47.93.12.75:8888/appcode/appCodesDelete.dspy>

请求示例

```
删除Code表对应字段
{
   'id': 'user_status'
}

添加kv表
{
		'kv': '1', 
    'id': 'kv表中对应id'
}
```

请求参数说明 

| 参数 | 类型   | 必填 | 描述            |
| ---- | ------ | ---- | --------------- |
| kv   | String | 是   | 删除kv表 值为1  |
| id   | String | 是   | Code/kv表中的id |

返回示例 

```
删除成功
    {
    	"status": true,
    	"msg": "appCodes delete success"
		}
删除失败
    {
    	"status": False,
    	"msg": "appCodes delete failed"
		}
```

### 编码更新

请求URL：

<http://47.93.12.75:8888/appcode/appCodesUpdate.dspy>

请求示例

```
更新Code表
{
   'id': 'user_status',
   'name': '用户状态',
   'hierarchy_flg': '0'
}

更新kv表
{
		'kv': '1', 
    'codeid':'user_status', 
    'parentid': '123', 
    'k': '2', 
    'v': '休息中'
}
```

请求参数说明 

更新Code表

| 参数          | 类型   | 必填 | 描述                  |
| ------------- | ------ | ---- | --------------------- |
| id            | String | 是   | 英文名称例如：status  |
| name          | String | 否   | 中文名称 例如：状态   |
| hierarchy_flg | String | 否   | 多级标志 0/1 是否多级 |



更新kv表

| 参数     | 类型   | 必填 | 描述           |
| -------- | ------ | ---- | -------------- |
| kv       | String | 是   | 更新kv表 值为1 |
| codeid   | String | 否   | Code表中的id   |
| parentid | String | 否   | 父级id         |
| k        | String | 否   | 键             |
| v        | String | 否   | 值             |

返回示例 

```
添加成功
    {
    	"status": true,
    	"msg": "update success"
		}
添加失败
    {
    	"status": False,
    	"msg": "update failed"
		}
```

### 编码查询

请求URL：

<http://47.93.12.75:8888/appcode/appCodesSearch.dspy>

请求示例

```
查询code表时不需要参数
	返回data为[{},{},{}]

查询kv表
{
		'kv': '1', 
    'codeid': 'kv表中对应id'
}
```

请求参数说明 

| 参数 | 类型   | 必填              | 描述            |
| ---- | ------ | ----------------- | --------------- |
| kv   | String | 否/查询kv为必填项 | 查询kv表 值为1  |
| id   | String | 否/查询kv为必填项 | Code/kv表中的id |

返回示例 

```
查询成功
    {
    	"status": True,
			"msg": "appCodes_kv search success",
			"data": app_code_result
		}
查询失败
    {
    	"status": False,
			"msg": "appCodes_kv search failed",
			"data": ""
		}
 
 查询成功示例
[
    {
        "parentid": null,
        "k": "0",
        "v": "未认证",
        "id": "8KxM0iIY",
        "codeid": "status"
    },
    {
        "parentid": null,
        "k": "1",
        "v": "认证",
        "id": "GZx0dzSd",
        "codeid": "status",
        "son": [
            {
                "parentid": "1",
                "k": "0",
                "v": "手机号",
                "id": "37HmJ8T7",
                "codeid": "status",
                "son": [
                    {
                        "parentid": "1-0",
                        "k": "0",
                        "v": "华南地区",
                        "id": "eVF9aerQ",
                        "codeid": "status"
                    },
                    {
                        "parentid": "1-0",
                        "k": "1",
                        "v": "华中地区",
                        "id": "j1rhnW6p",
                        "codeid": "status"
                    },
                    {
                        "parentid": "1-0",
                        "k": "2",
                        "v": "华北地区",
                        "id": "Cr0nWLIU",
                        "codeid": "status",
                        "son": [
                            {
                                "parentid": "1-0-2",
                                "k": "0",
                                "v": "甘肃",
                                "id": "Gnd5WA4b",
                                "codeid": "status"
                            },
                            {
                                "parentid": "1-0-2",
                                "k": "1",
                                "v": "内蒙古",
                                "id": "FRHOrEep",
                                "codeid": "status"
                            }
                        ]
                    }
                ]
            },
            {
                "parentid": "1",
                "k": "1",
                "v": "微信",
                "id": "f1MRJscT",
                "codeid": "status"
            },
            {
                "parentid": "1",
                "k": "2",
                "v": "QQ",
                "id": "m3M39BI8",
                "codeid": "status"
            }
        ]
    }
]
```