文档首页> Classroom> API参考> API> classroom> 根据课堂ID获取指定课堂的课堂成员列表
更新时间:2021-11-25 GMT+08:00
分享

根据课堂ID获取指定课堂的课堂成员列表

功能介绍

根据课堂ID获取指定课堂的课堂成员列表,支持分页,搜索字段默认同时匹配姓名,学号,用户名,班级。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/classrooms/{classroom_id}/members

表1 路径参数

参数

是否必选

参数类型

描述

classroom_id

String

课堂ID

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

信息记录的起始编号

最小值:1

最大值:1000

limit

Integer

每页包含的信息记录数

最小值:1

最大值:100

filter

String

按照条件搜索学生,搜索字段会同时匹配姓名,学号,用户名,班级

最小长度:1

最大长度:200

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

用户token

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

members

Array of ClassroomMember objects

课堂成员列表

total

Integer

课堂成员总数

表5 ClassroomMember

参数

参数类型

描述

member_id

String

成员ID

name

String

成员名称

number

String

成员学号/工号

class_name

String

成员所在班级的名字

user_name

String

成员用户名

join_time

String

成员加入课堂时间,日期格式:yyyy-MM-dd HH:mm:ss

job_received_count

Integer

该成员已接收到的作业数量

job_finished_count

Integer

该成员已完成的作业数量

job_finished_rate

Number

该成员作业完成率

请求示例

GET https://{endpoint}/v3/classrooms/{classroom_id}/members

响应示例

状态码: 200

OK

{
  "members" : [ {
    "member_id" : "f37ad8c959c24bd880fd20296867c1ef",
    "name" : "张三",
    "number" : "0001",
    "class_name" : "Java高级编程一班",
    "user_name" : "zhangsan001",
    "join_time" : "2019-11-19 01:56:21",
    "job_received_count" : "4",
    "job_finished_count" : "0",
    "job_finished_rate" : "0"
  } ],
  "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

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读