专题

专题

获取专题信息

GET /classrooms/{classroomId}

权限

• 不需要认证
• 普通用户可以获得public状态的班级
• 管理员用户可以获得任何状态的班级 [TODO]

响应

成功响应Classroom结构体

字段	描述
id int string	ID
title string	标题
status enum{closed,draft,published}	状态
about string	简介
price float string	价格
vipLevelId int string	vipId
cover Picture	封面
headTeacher list<PublicUser>	班主任
teachers list<SimpleUser>	教师
assistants list<SimpleUser>	助教
hitNum int string	浏览量
auditorNum int string	旁听生数量
studentNum int string	学生数量
courseNum int string	计划数量
threadNum int string	帖子数量
noteNum int string	笔记扣量
postNum int string	回复数量
service list<Service>	承诺服务
recommended bool	是否被推荐
recommendedSeq int string	推荐权重
rating int string	评价分数
ratingNum int string	评价数量
maxRate int string	最大抵扣率
showable bool	是否在首页展示
buyable float string	是否开发购买
expiryMode enum{date,days,forever}	学习有效期 date:指定时间之内有效,days:固定天数之内有效,forever:永久有效
expiryValue mixed	有效期值 如果expiryMode是date,则类型是datetime,days则是整数,forever则是0
createdTime datetime	创建时间
updatedTime datetime	最后更新时间
creator SimpleUser	创建者
access Access	是否可以加入班级 success:可以加入 classroom.not_found:专题不存在 classroom.unpublished:专题未发布 classroom.closed:班级已关闭 classroom.not_buyable:专题被设置不可加入 classroom.expired:专题过期 user.not_login:用户未登录 user.locked:用户被锁 member.member_exist:已经是学员 classroom.only_vip_join_way:只能通过VIP加入

错误

失败响应Error结构体，错误码有

Code	错误说明	HTTP状态码
10	专题不存在	404

获取班级列表

GET /classrooms

权限

• 不需要认证
• 普通用户可以获得public状态的专题
• 管理员用户可以获得任何状态的班级 [TODO]

参数

字段	是否必填	描述
categoryId int string	否	分类ID,默认all
title string	否	班级标题，模糊搜索
sort string	否	排序字段 'name','createdTime','recommendedSeq','studentNum',updatedTime'
offset int string	否	分页偏移值, 默认0
limit int string	否	每一页数量, 默认10

响应

成功响应pagelist<Classroom>结构体

专题成员

GET /me/classroom_members/{classroomId}

权限

• 需要认证

响应

成功响应ClassroomMember结构体

字段	描述
id int string	ID
classroomId int string	专题ID
userId int string	用户ID
noteNum int string	笔记数量
threadNum int string	帖子数量
locked int string	是否被锁
role list<string>	角色
deadline datetime	有效期
access Access	是否可以学习专题 success:可以加入 classroom.not_found:专题不存在 classroom.unpublished:专题未发布 user.not_login:用户未登录 user.locked:用户被锁 classroom.expired:专题学习有效期到达 member.not_found:不是学员 member.auditor:旁听生不能学习 member.expired:有效期已过期 vip.member_expired:vip过期 vip.level_not_exist:vip等级不存在 vip.level_low:等级过低

获取专题计划

GET /classrooms/{classroomId}/courses

权限

• 不需要认证

响应

成功响应list<Course>结构体

加入专题

POST /classrooms/{classroomId}/members

权限

• 需要认证

响应

成功响应ClassroomMember结构体