获取当前用户的课堂列表
功能介绍
获取当前用户的课堂列表，课堂课表分为我创建的课堂，我加入的课堂以及所有课堂，支持分页查询。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v3/classrooms
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
信息记录的起始编号 最小值：1 最大值：1000 |
limit |
否 |
Integer |
每页包含的信息记录数 最小值：1 最大值：100 |
query_type |
否 |
String |
查询的课堂类别，默认查询所有的课堂。 取值范围： create：只查询当前用户创建的课堂。 attend：只查询当前用户加入的课堂。 all：查询当前用户所有的课堂。 最小长度：3 最大长度：6 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
x-auth-token |
是 |
String |
用户token |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
classrooms |
Array of ClassroomCard objects |
课堂列表 |
total |
Integer |
课堂总数 |
参数 |
参数类型 |
描述 |
|---|---|---|
classroom_id |
String |
课堂ID |
name |
String |
课堂名称 |
description |
String |
课堂描述 |
credit |
Number |
课堂学分 |
status |
String |
课堂当前的状态，normal：课堂处于正常状态，archive：课堂已归档 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
异常错误码 |
error_msg |
String |
异常错误描述 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
异常错误码 |
error_msg |
String |
异常错误描述 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
异常错误码 |
error_msg |
String |
异常错误描述 |
请求示例
GET https://{endpoint}/v3/classrooms
响应示例
状态码： 200
OK
{
"classrooms" : [ {
"classroom_id" : "0632910a5115448da1eb92202592fa24",
"name" : "Java高级编程",
"description" : "这是第一个课堂",
"credit" : "1.5",
"status" : "normal"
} ],
"total" : 1
}
状态码： 400
Bad Request
{
"error_code" : "CM.0003",
"error_msg" : "请求参数有误"
}
状态码： 403
Forbidden
{
"error_code" : "CM.0001",
"error_msg" : "请求被拒绝访问"
}
状态码： 500
Internal Server Error
{
"error_code" : "CM.0000",
"error_msg" : "服务内部错误"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
403 |
Forbidden |
500 |
Internal Server Error |
错误码
请参见错误码。
