获取对应培训下的所有课次列表信息。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/course/{courseId}/
lesson/list
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
extId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
courseId | long | Body | 是 | 无 | 培训id |
pageIndex | int | Body | 是 | 无 | 页码 |
pageSize | int | Body | 是 | 无 | 分页大小(不超过50) |
courseStatus | String | Body | 否 | 无 | 课次状态过滤条件(in_course:开课中,before_course:未开课 after_course:已结课) |
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"total":1,//总数
"pageSize":10,//每页查询数量
"pageIndex":1,//页码
"list":[
{
"lessonId":"462985830659526656",//讲次id
"lessonNo":1,//讲次序号,第一讲
"lessonName":"语文讲次",//讲次名称
"lessonTime":{//讲次开课时间段
"lessonDate":"2020-07-01",//开课日期
"endTime":"15:05:00",//课次结束时间点
"startTime":"15:00:00"//课次开始时间点
},
"status":{//讲次状态
"name":"未开课",
"value":"before_course"
},
"sync":true //同步直播开关状态 true-开 false-关
}
}
返回参数说明
参数名称 | 说明 |
total | 总数 |
pageSize | 每页查询数量 |
pageIndex | 页码 |
list | |
lessonId | 讲次id |
lessonNo | 讲次序号,第一讲 |
lessonName | 讲次名称 |
lessonTime | 讲次开课时间段 |
lessonDate | 开课日期 |
endTime | 课次结束时间点 |
startTime | 课次开始时间点 |
status | 讲次状态 |
name | 状态中文名称 |
value | 状态英文名称 |
sync | 同步直播开关状态 true-开 false-关 |