用户
创建用户
POST /api/user
权限
- 需要认证
参数
字段 | 是否必须 | 描述 |
---|---|---|
truename string |
是 | 真实姓名 |
nickname string |
是 | 用户名称 |
orgCodes string |
是 | 部门编码(用,分开, eg: 1.3,1.2,) |
password string |
是 | 密码 |
email string |
是 | 邮箱 |
roles |
否 | 角色(eg:["ROLE_USER"]) |
postId |
否 | 岗位id |
hireDate |
否 | 入职时间 |
idcard |
否 | 身份证号码 |
mobile |
否 | 手机号 |
permissionOrgIds |
否 | 管理范围(用,分开, eg: 3,2,) |
响应
字段 | 描述 |
---|---|
id int string |
用户ID |
nickname string |
昵称 |
verifiedMobile |
手机号 |
avatar Picture |
头像 |
uuid string |
uuid |
title string |
头衔 |
loginTime string |
登录时间 |
hireDate string |
入职时间 |
当前用户
GET /me
权限
- 需要认证
响应
成功响应AuthenticatedUser结构体
字段 | 描述 |
---|---|
id int string |
用户ID |
nickname string |
昵称 |
postName |
岗位名称 |
avatar Picture |
头像 |
gender string |
性别 |
iam string |
|
city string |
所在城市 |
qq string |
|
signature string |
个人签名 |
about string |
自我介绍 |
company string |
公司 |
job string |
职业 |
school string |
学校 |
class string |
班级 |
weibo string |
微博 |
weixin string |
微信 |
isQQPublic string |
QQ是否公开 |
isWeixinPublic string |
微信是否公开 |
isWeiboPublic string |
微博是否公开 |
email string |
|
locale string |
|
uri string |
|
title string |
头衔 |
type string |
注册方式 |
roles list<string> |
角色 |
promotedSeq string |
|
promotedTime datetime |
|
locked bool |
用户是否被锁 |
lastPasswordFailTime string |
上次密码输入错误时间 |
loginTime datetime |
登录时间 |
approvalTime datetime |
|
vip simpleVip |
会员信息 |
字段 | 描述 |
---|---|
id int string |
用户ID |
nickname int string |
昵称 |
title string |
头衔 |
avatar Picture |
头像 |
字段 | 描述 |
---|---|
id int string |
用户ID |
nickname int string |
昵称 |
title string |
头衔 |
avatar Picture |
头像 |
about string |
自我介绍 |
字段 | 描述 |
---|---|
small string |
小图 |
middle string |
中图 |
large string |
大图 |
我的教学计划
GET /me/courses
权限
- 需要认证
参数
字段 | 描述 |
---|---|
offset int string |
分页偏移值, 默认0 |
limit int string |
每一页数量, 默认10 |
courseTitle string |
课程标题 |
learnStatus string |
学习状态(all-全部、notStart-未学习、learning-学习中、learned-已学完) |
响应
成功响应成功响应pageList<SimpleMeCourse
>结构体
字段 | 描述 |
---|---|
id int string |
计划id |
title string |
计划名称 |
totalLearnTime int string |
学习时长 |
compulsoryTaskNum int string |
必修任务数量 |
learnedCompulsoryTaskNum int string |
已学必修任务数 |
courseSet SimpleCourseSet |
课程信息 |
课程学习进度规则:learnedCompulsoryTaskNum/compulsoryTaskNum
我的直播课程
GET /me/live_course_sets
权限
- 需要认证
- 按照最近查看时间排序
响应
成功响应list<SimpleCourseSet>结构体
我的班级
GET /me/classrooms
权限
- 需要认证
响应
成功响应list<SimpleClassroom>结构体
查询用户
GET /users/{nickname,id,email,mobile}
权限
- 不需要认证
参数
字段 | 是否必填 | 描述 |
---|---|---|
identifyType string |
是 | 标示类型 {nickname,id,email,mobile} |
响应
成功响应list<SimpleClassroom>结构体
获取用户列表
GET /user/users_list/list
权限
- Access-Token认证方式可获取全部用户
- X-Auth-Token认证方式可获取属于该用户管理范围内的用户
参数
字段 | 是否必填 | 描述 |
---|---|---|
orgCode | 否 | 部门orgCode(eg:1.2.) |
postId | 否 | 岗位id(eg:1) |
roles | 否 | 角色编码code(eg:USER_ROLE) |
keywordType | 否 | 关键词类型(5选1:truename、nickname、phone、email、ip 真实姓名、用户名、手机号、邮箱、ip) |
keyword | 否 | 对应关键词内容(eg:张三) |
locked | 否 | 封禁状态 unlocked、locked 未封禁、封禁 |
hireDate_GTE | 否 | 入职起始时间(eg:2022-01-13) |
hireDate_LTE | 否 | 入职结束时间(eg:2022-01-14) |
响应
字段 | 描述 |
---|---|
id int string |
用户ID |
nickname string |
昵称 |
uuid string |
用户识别码 |
hireDate string |
入职时间 |
locked int string |
是否封禁 1表示封禁, 0表示未封禁 |
profile list<string> |
用户信息:真实姓名、性别 |
postId int string |
岗位ID |
post list<string> |
岗位信息:岗位id、岗位名称 |
orgCodes list<string> |
部门信息:部门orgCode合集 |
org list<string> |
部门信息:部门id、部门名称、部门code、部门orgCode |
roles list<string> |
角色信息:角色code合集 |
role list<string> |
角色信息:角色名称、角色code |