Skip to content

admin user

chaowen edited this page Oct 16, 2021 · 4 revisions

用户管理接口

用户查询接口

接口说明

用户后台管理系统查询用户,该接口只有管理员和业务员能访问。

提交地址

get /users

请求参数

变量定义:

字段名 类型 必输 默认值 说明
size int 否 10 如果要分页,传入分页大小
current int 否 1 如果要分页,传入目标页码
roleCategory string 是 选择要查询的用户分类,"student"/"teacher"/"all"
name string 否 "" 用户姓名
studentJobId string 否 "" 学号或工号
clazzName string 否 "" 班级名称
majorName string 否 "" 专业名称
secondaryDeptName string 否 "" 二级部门名称

特别说明:

roleCategory告诉服务器要查询的用户种类,如果传入"all", 表示查询范围包含所有用户;如果传入"student",那么查询用户的范围是:本科生、研究生;如果传入"teacher",那么查询用户的范围是:教师、二级部门领导、院级领导、业务员、管理员;

  • 如果要查询学生类的用户,请选传以下参数:name、studentJobId、clazzName、majorName;

  • 如果要查询教师类的用户,请选传以下参数:name、studentJobId、secondaryDeptName;

  • 如果要查询所有类型的用户,请选传以下参数:name、studentJobId;

请求参数示例:

/users?size=3&current=1&roleCategory=student&studentJobId=2019

/users?size=3&current=1&roleCategory=teacher&secondaryDeptName=计算

/users?size=3&current=1&roleCategory=all&name=wc&studentJobId=19

成功返回

{
    "code": 200,
    "message": "成功",
    "data": {
        "records": [
            {
                "id": 17,
                "createTime": "2021-08-16 22:11:33",
                "updateTime": "2021-09-30 09:13:17",
                "deleted": 0,
                "openId": null,
                "unionId": null,
                "sessionKey": null,
                "name": "丁鑫",
                "infoComplete": 0,
                "gender": null,
                "avatarUrl": null,
                "nickName": null,
                "collegeId": 1,
                "majorId": 1,
                "clazzName": "网工1902",
                "grade": 3,
                "studentId": null,
                "secondaryDeptId": 1,
                "jobId": null,
                "isLock": 0,
                "token": null,
                "collegeName": null,
                "majorName": null,
                "secondaryDeptName": null,
                "roleId": null,
                "roleCategory": null,
                "major": {
                    "id": 1,
                    "name": "计算机学院",
                    "collegeId": null
                },
                "secondaryDept": {
                    "id": 1,
                    "name": "计算机系",
                    "collegeId": null
                },
                "college": {
                    "id": 1,
                    "name": "计算机学院"
                },
                "roleList": [
                    {
                        "id": 6,
                        "createTime": null,
                        "updateTime": null,
                        "deleted": null,
                        "name": "UNDERGRADUATE",
                        "text": "本科生"
                    }
                ],
                "studentJobId": "20194333"
            },
            {
                ...
            },
            {
                ...
            }
        ],
        "total": 3,
        "size": 3,
        "current": 1,
        "orders": [],
        "hitCount": false,
        "searchCount": true,
        "pages": 1
    }
}

锁定/解封用户账号

接口说明

用于锁定或解封用户账号

提交地址

put /lock/{id}/{status}

请求参数

变量定义:

字段名 类型 必输 默认值 说明
id int 是 用户id
status int 是 1表示锁定,0表示解锁

成功返回

{
    "code": 200,
    "message": "成功",
    "data": null
}

用户更新接口

接口说明

用户后台管理系统更改用户信息,该接口只有管理员和业务员能访问。

提交地址

put /users

请求参数

变量定义:

字段名 类型 必输 默认值 说明
id int 是 用户id
name string 是 用户姓名
roleId int 是 用户角色id
studentJobId string 是 学号/工号
collegeId int 是 学院id
majorId int 是 专业id
clazzName string 是 班级名字
grade int 是 学生年级
secondaryDeptId string 是 二级部门id

特别说明:

  • 公共必填参数:id、name、roleId、collegeId、studentJobId

      * 如果一个用户有多重角色:一个用户不可能既是老师又是学生,用户角色重叠的情况只可能有以下几种:
         * 一个用户同时是**教师**(还可以是领导)又是**管理员**(或业务员)
         * 一个用户同时是**本科生**(或研究生)又是**管理员**(或业务员)
      * 前端应该选择用户的**非管理员**角色的id上传到后端接口,比如,如果用户A的角色是上述情况2,那么前端可以选择上传的角色id只能是:
         * 教师角色对应的id
    
  • 如果roleId属于student类别,以下参数必填:majorId、clazzName、grade

  • 如果roleId属于teacher类别,以下参数必填:secondaryDeptId

  • 该接口不提供修改用户角色功能,传入的roleId参数只用于判断更新的用户类型

请求参数示例:

{
    "id": 1,
    "name": "文超",
    "roleId": "6",
    "collegeId": "2",
    "studentJobId": "87687576567",
    
    "majorId": "1",
    "clazzName": "软工1902",
    "grade": 1
}

成功返回

{
    "code": 200,
    "message": "成功",
    "data": {
        "id": 1,
        "createTime": "2021-08-16 22:11:33",
        "updateTime": "2021-10-16 17:13:58",
        "deleted": 0,
        "openId": null,
        "unionId": null,
        "sessionKey": null,
        "name": "文超",
        "infoComplete": 1,
        "gender": null,
        "avatarUrl": null,
        "nickName": null,
        "collegeId": 2,
        "majorId": 1,
        "clazzName": "软工1902",
        "grade": 1,
        "secondaryDeptId": 2,
        "isLock": 0,
        "token": null,
        "collegeName": null,
        "majorName": null,
        "secondaryDeptName": null,
        "roleId": null,
        "roleCategory": null,
        "major": {
            "id": 2,
            "name": "理学院",
            "collegeId": null
        },
        "secondaryDept": {
            "id": 2,
            "name": "实验中心",
            "collegeId": null
        },
        "college": {
            "id": 2,
            "name": "理学院"
        },
        "roleList": [
            {
                "id": 6,
                "createTime": null,
                "updateTime": null,
                "deleted": null,
                "name": "UNDERGRADUATE",
                "text": "本科生"
            },
            {
                "id": 1,
                "createTime": null,
                "updateTime": null,
                "deleted": null,
                "name": "ADMIN",
                "text": "管理员"
            }
        ],
        "studentJobId": "9999999"
    }
}

Clone this wiki locally