标签管理

# 创建标签

平台新增一个标签，标签名称不能重复

请求方式 ：POST

请求地址 ：https://api.zkbiocloud.com/open/edu/school/basic/v1/tag/save

请求数据

header域

入参名称	入参类型	默认值	必填	入参说明
Content-Type	String	application/json	是	指定请求的媒体类型
Authorization	String		是	令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "tagCategory": "faculty",
            "tagName": "老师"
        }
    }
}

1
2
3
4
5
6
7
8

入参说明

入参名称	入参类型	参数长度	默认值	必填	入参说明
tagCategory	String	20		是	标签类别，faculty-教职工；student-学生
tagName	String	100		是	标签名称

返回结果

{
    "code": "00000000",
    "payload": {
        "results": {
            "id": "239399281d1b472ba663173eaeb92e3b"
        }
    }
}

1
2
3
4
5
6
7
8

出参说明

出参名称	出参类型	出参说明
code	String	响应返回码
id	String	标签ID（32位的uuid）

# 删除标签

删除一个标签，有被教职工或学生绑定的标签不能删除

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/tag/delete

请求数据

header域

入参名称	入参类型	默认值	必填	入参说明
Content-Type	String	application/json	是	指定请求的媒体类型
Authorization	String		是	令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "tagId": "bd3ffc623e364d82a8e493382ed4a0cc"
        }
    }
}

1
2
3
4
5
6
7

入参说明

入参名称	入参类型	参数长度	默认值	是否必填	入参说明
tagId	String	32		是	标签ID（32位的uuid）

返回结果

{
    "code": "00000000",
    "message": "success"
}

1
2
3
4

出参说明

出参名称	出参类型	出参说明
code	String	响应返回码
message	String	成功响应消息内容

# 更新标签

修改主体中一个标签的基本信息（标签ID无法变更）

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/tag/update

请求数据

header域

入参名称	入参类型	默认值	必填	入参说明
Content-Type	String	application/json	是	指定请求的媒体类型
Authorization	String		是	令牌，详见令牌说明

body域

{
    "payload": {
        "params": {
            "tagId": "bd3ffc623e364d82a8e493382ed4a0cc",
            "tagName": "教师"
        }
    }
}

1
2
3
4
5
6
7
8

入参说明

入参名称	入参类型	参数长度	默认值	是否必填	入参说明
tagId	String	32		是	标签ID（32位的uuid）
tagName	String	100		是	标签名称

返回结果

{
    "code": "00000000",
    "message": "success"
}

1
2
3
4

出参说明

出参名称	出参类型	出参说明
code	String	响应返回码
message	String	成功响应消息内容

# 查询标签列表

查询所有的标签信息列表

请求方式：POST

请求地址：https://api.zkbiocloud.com/open/edu/school/basic/v1/tag/list

请求数据

header域

入参名称	入参类型	默认值	必填	入参说明
Content-Type	String	application/json	是	指定请求的媒体类型
Authorization	String		是	令牌，详见令牌说明

body域

{
    "payload": {
        "params": {}
    }
}

1
2
3
4
5

入参说明

入参名称	入参类型	参数长度	默认值	是否必填	入参说明

返回结果

{
    "code": "00000000",
    "message": "success",
    "payload": {
        "results": [
            {
                "tagName": "教师",
                "tagCategory": "faculty",
                "tagDefaultFlag": 0,
                "tagId": "bd3ffc623e364d82a8e493382ed4a0cc"
            },
            {
                "tagName": "小学生",
                "tagCategory": "student",
                "tagDefaultFlag": 0,
                "tagId": "bd3ffc623e364d82a8e493382ed4a0cc"
            }
        ]
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

出参说明

出参名称	出参类型	出参说明
code	String	响应返回码
message	String	成功响应消息内容
tagId	String	标签ID（32位的uuid）
tagName	String	标签名称
tagCategory	String	标签类别，faculty-教职工；student-学生
tagDefaultFlag	Integer	标签默认标记，0-否；1-是）

← 部门管理教职工管理→