文档首页/ Classroom/ API参考/ API/ job/ 查询指定课堂下的作业列表信息
更新时间:2023-07-03 GMT+08:00
分享

查询指定课堂下的作业列表信息

功能介绍

查询指定课堂下的作业列表信息,支持分页查询。

调试

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

URI

GET /v3/jobs

表1 Query参数

参数

是否必选

参数类型

描述

source_from

String

作业来源于课堂或课程。 取值范围: classroom:课堂作业 course:课程作业

最小长度:6

最大长度:9

source_id

String

课堂ID或者课程ID。

最小长度:32

最大长度:32

offset

Integer

信息记录的起始编号

最小值:1

最大值:1000

limit

Integer

每页包含的信息记录数

最小值:1

最大值:100

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

用户token

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

jobs

Array of JobCard objects

作业列表

total

Integer

作业总数

表4 JobCard

参数

参数类型

描述

name

String

作业名称

job_id

String

作业ID

is_send

String

作业下发状态(unsend:作业未下发, send:作业已下发)

end_time

String

作业截止时间, 日期格式:yyyy-MM-dd HH:mm:ss

average_score

String

作业均分

submit_job_num

Integer

作业提交人数

create_status

String

作业创建状态(yes:作业可以下发, no:作业不能下发)

send_type

String

作业下发类型(specific:指定成员下发, all:下发课堂全员)

is_score_visibility

String

作业成绩是否公布(unpublish:表示未公布成绩, publish:表示已公布成绩)

send_time

String

作业下发时间, 日期格式:yyyy-MM-dd HH:mm:ss

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误描述

状态码: 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误描述

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

异常错误码

error_msg

String

异常错误描述

请求示例

GET https://{endpoint}/v3/jobs

响应示例

状态码: 200

OK

{
  "jobs" : [ {
    "name" : "作业",
    "job_id" : "0632910a5115448da1eb92202592fa24",
    "is_send" : "send",
    "end_time" : "2019-12-12 12:00:00",
    "average_score" : "1.5",
    "submit_job_num" : 10,
    "create_status" : "yes",
    "send_type" : "all",
    "is_score_visibility" : "unpublish",
    "send_time" : "2019-12-12 12:00:00"
  } ],
  "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

错误码

请参见错误码

相关文档