文档首页> Classroom> API参考> API> classroom> 根据课堂ID获取指定课堂的详细信息
更新时间:2023-07-03 GMT+08:00
分享

根据课堂ID获取指定课堂的详细信息

功能介绍

根据课堂ID获取指定课堂的详细信息

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v3/classrooms/{classroom_id}

表1 路径参数

参数

是否必选

参数类型

描述

classroom_id

String

课堂ID

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

用户token

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

name

String

课堂名称

description

String

课堂描述

announcement

String

课堂公告

announcement_time

String

课堂公告创建时间,日期格式:yyyy-MM-dd

create_time

String

课堂创建时间,日期格式:yyyy-MM-dd HH:mm:ss

update_time

String

课堂最新更新时间,日期格式:yyyy-MM-dd HH:mm:ss

teacher

String

当前课堂的授课人

credit

Number

课堂学分

start_time

String

课堂开始时间,日期格式:yyyy-MM-dd HH:mm:ss

end_time

String

课堂结束时间,日期格式:yyyy-MM-dd HH:mm:ss

role

String

当前用户在课堂下角色,取值范围:teacher:老师,student:学生

school

String

授课学校

content_count

Integer

课堂下目录数量

courseware_count

Integer

课堂下课件数量

job_count

Integer

课堂下作业数量

member_count

Integer

课堂下成员数量

status

String

课堂当前的状态,normal:课堂处于正常状态,archive:课堂已归档

状态码: 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误描述

状态码: 403

表5 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误描述

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误描述

请求示例

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

响应示例

状态码: 200

OK

{
  "name" : "Java高级编程",
  "description" : "这是第一个课堂",
  "announcement" : "这是一个公告",
  "announcement_time" : "2019-11-19",
  "create_time" : "2019-11-19 01:56:21",
  "update_time" : "2019-11-19 01:56:21",
  "teacher" : "张三",
  "start_time" : "2019-11-19 00:00:00",
  "end_time" : "2019-11-20 00:00:00",
  "role" : "teacher",
  "school" : "华为云",
  "content_count" : 1,
  "courseware_count" : 1,
  "job_count" : 1,
  "member_count" : 10,
  "credit" : 1.5,
  "status" : "normal"
}

状态码: 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

错误码

请参见错误码

分享:

    相关文档

    相关产品