分页获取企业课次列表。
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdkapi.xylink.com/api/rest/external/{version}/edu/adapter/lesson/list
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
extId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
pageIndex | int | Query | 是 | 无 | 页码 |
pageSize | int | Query | 是 | 无 | 分页大小(不超过50) |
courseStatus | String | Query | 否 | 无 | 课次状态过滤条件(in_course:开课中,before_course:未开课 after_course:已结课) |
searchStartTime | date | Query | 否 | 无 | 课次更新的开始查询时间 |
searchEndTime | date | Query | 否 | 无 | 课次更新的结束查询时间 |
schoolTypeId | long | Query | 否 | 无 | 培训类别id |
subjectId | long | Query | 否 | 无 | 培训科目id |
keywords | String | Query | 否 | 无 | 关键字过滤(培训名称,讲师或云课堂号) |
departmentId | long | Query | 否 | 无 | 机构id,不传查询企业下所有课次,传值查询对应机构下课次 |
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"total": 1, //总数目
"pageSize": 10, //查询数量
"pageIndex": 1, //页码
"list": [ //培训列表数
{
"lessonId": "401768143652913153" //课次id
"subjectId": "401768143686467610", //培训科目id
"subject": "数学", //培训科目
"schoolTypeId": "401768143652913153", //培训类型
"schoolType": "初中", //培训课程分类
"lessonName": "培训提醒时间", //课次名称
"lessonNo": 1, //讲次序号,第一讲
"teacherList": [{
"id": "27678189", //讲师id
"name": "李老师", //讲师姓名
"type": "people" //类型 people-讲师,device-终端
}],
"listenerList":[{ //听课老师或终端
"id": "27678120", //听课老师id
"name": "王老师", //听课老师
"type": "people" //类型 people-讲师,device-终端
}],
"startTime": "2020-09-01 10:44:21.0", //课次开始时间点
"endTime": "2020-09-01 11:44:21.0", //课次结束时间点
"updateTime": "2020-09-01 10:44:21.0", //课次更新时间点
"videoList": [{
"id": "473797242004713472", //id
"vodId": "5263329", //;录制文件id
"courseItemId": "473558688288735234", //课次id
"mimeType": "mp4", //录制文件类型
"fileSize": "3.9", //录制文件大小
"startTime": "2020-07-31 10:20", //录制文件开始时间
"cover": "https://cloud.xylink.com/vods/sharecenter/thumbnail?fileName=cloudcloud/9005803465/1156074676489_0_1596162040374_1280_720.jpg&fileId=11141074&securityKey=f4c672eb544dd17a8f69f0c7047242ba173b2231f9e", //录制文件封面
"fileName": "Z大语文" //录制文件名称
}]
}
]
}
返回参数说明
参数名称 | 说明 |
total | 总数目 |
pageSize | 查询数量 |
pageIndex | 页码 |
list | 培训列表数 |
lessonId | 课次id |
subjectId | 培训科目id |
subject | 培训科目 |
schoolTypeId | 培训类型 |
schoolType | 培训课程分类 |
lessonName | 课次名称 |
lessonNo | 讲次序号,第一讲 |
teacherList | 讲师列表 |
teacherList.id | 讲师id |
teacherList.name | 讲师姓名 |
teacherList.type | 类型 people-讲师,device-终端 |
listenerList | 听课老师或终端 |
listenerList.id | 听课老师id |
listenerList.name | 听课老师 |
listenerList.type | 类型 people-讲师,device-终端 |
startTime | 课次开始时间点 |
endTime | 课次结束时间点 |
updateTime | 课次更新时间点 |
videoList | 录制文件 |
videoList.id | 主键 |
vodId | 录制文件id |
courseItemId | 课次id |
mimeType | 录制文件类型 |
fileSize | 录制文件大小 |
startTime | 录制文件开始时间 |
cover | 录制文件名称 |