可以获取企业或者对应班级下的所有培训表信息。departmentId=null获取企业的培训信息
默认接口请求频率限制:20次/秒。
REST URL
GET https://sdk.xylink.com/api/rest/external/{version}/edu/adapter/course/list
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 |
version | String | Path | 是 | 无 | v1 |
extId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 |
pageIndex | int | Query | 是 | 无 | 页码 |
pageSize | int | Query | 是 | 无 | 分页大小(不超过50) |
schoolTypeId | long | Query | 否 | 无 | 培训类别id |
subjectId | long | Query | 否 | 无 | 培训科目id |
keywords | String | Query | 否 | 无 | 关键字过滤(培训名称,讲师或云课堂号) |
departmentId | long | Query | 否 | 无 | 机构id,不传查询企业下所有培训,传值查询对应机构下培训 |
status | String | Query | 否 | 无 | 开课状态过滤条件(in_course:开课中,before_course:未开课 after_course:已结课) |
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"total":1,//总数目
"pageSize":10,//查询数量
"pageIndex":1,//页码
"list":[ //培训列表数据
{
"courseId":"462985830101684224",//培训id
"courseName":"培训提醒时间",//培训名称
"status":{ //培训状态
"name":"未开课", //培训状态名称
"value":"before_course" //培训状态值
},
"cloudMeetingNumber":"9021636785",//云课堂号
"grade":null,//培训类别
"gradeId":null,//培训类别id
"subject":"数学",//培训科目
"subjectId":"401768143686467610",//培训科目id
"schoolType":"初中",//培训类型
"schoolTypeId":"401768143652913153",//培训类型
"edit":true,// 培训是否可编辑
"creatorId":"27731788",//培训发起人id
"creatorName":"王老师",//培训发起人姓名
"teacher":[ //培训讲师或培训终端
{
"id":"27678189", //讲师id
"name":"李老师",//讲师姓名
"type":"people"//类型 people-讲师,device-终端
},
{
"id":"3678181", //终端id
"name":"主班级终端",//终端名称
"type":"device" //类型终端
}
]
}
]
}
返回参数说明
参数名称 | 说明 |
total | 总数目 |
pageSize | 查询数量 |
pageIndex | 页码 |
list | 培训列表数据 |
courseId | 培训id |
courseName | 培训名称 |
status | 培训状态 |
name | 培训状态名称 |
value | 培训状态值 |
cloudMeetingNumber | 云课堂号 |
grade | 培训类别 |
gradeId | 培训类别id |
subject | 培训科目 |
subjectId | 培训科目id |
schoolType | 培训类型 |
schoolTypeId | 培训类型 |
edit | 培训是否可编辑 |
creatorId | 培训发起人id |
creatorName | 培训发起人姓名 |
teacher | 培训讲师或培训终端 |
id | 讲师id |
name | 讲师姓名 |
type | 类型 people-讲师,device-终端 |
id | 终端id |
name | 终端名称 |
type | 类型终端 |