课程数据
1、获取课程信息
2、获取学习成绩
3、获取学员待参加课程
获取学习成绩
获取某个课程的所有学习成绩,如学习记录、学习时间、次数、学时、成绩、学分、状态等信息。
接口地址:https://api.kaoshiyun.com.cn/api/v5/lessongrade.ashx?token=[Token]&action=getLessonGrade&lessonID=[examid]&pageIndex=[pageIndex]&pageSize=[pageSize]
请求方式:GET或POST
参数说明:
参数名称 | 说明 |
token | 接口调用凭证,2小时内有效,请注意时效性 |
action | getLessonGrade |
lessonID | 课程编号 |
pageIndex | 分页页码,默认第1页 |
pageSize | 每页条数,默认1000条 |
返回值说明:
1、执行成功
JSON返回值格式
{ "lessonID": "b1e8ef", "lessonName": "第一季度在线培训课程", "totalCount": 750, "pageSize": 1000, "currentPageIndex": 1, "items": [ { "account": "c089d6", "userName": "陈翰林", "deptName": "销售部", "fullDeptName": "考试云/销售中心/销售部", "gradeID": "dc3d4020622b46a0bf82d8fa1e38bc00", "beginTime": "2022-04-25 13:03:03", "endTime": "2022-04-28 13:33:07", "learnedTime": "210分4秒", "learnedCount": "5", "gradeScore": "80.0", "isPass": "Y", "integral": "10", "finishPercent": "100%", "statusCode": "finished", "status": "已完成" }, { "account": "c089d6", "userName": "李一鸣", "deptName": "技术部", "fullDeptName": "考试云/研发中心/开发部", "gradeID": "28e4bea1f2904c15814d0b6cca39457d", "beginTime": "2022-04-25 13:01:50", "endTime": "2022-04-29 13:54:53", "learnedTime": "53分3秒", "learnedCount": "2", "gradeScore": "-", "isPass": "-", "integral": "10", "finishPercent": "40%", "statusCode": "progress", "status": "学习中" } ] }
返回值参数说明:
参数名称 | 说明 |
lessonID | 课程编号 |
lessonName | 课程名称 |
totalCount | 总记录数 |
pageSize | 每页条数,默认1000条 |
currentPageIndex | 当前页码 |
account | 考生账号 |
userName | 考生姓名 |
deptName | 所属部门 |
fullDeptName | 部门全路径 |
beginTime | 学习开始时间 |
endTime | 学习结束时间 |
learnedTime | 学习时长 |
learnedCount | 学习次数 |
gradeScore | 考试成绩(如果有设定课程考试) |
isPass | 是否通过考试,Y为通过,N为未通过. |
integral | 所得积分 |
finishPercent | 课程学习进度 |
integral | 所得积分 |
status | 课程学习状态: nostart 未学习 progress 学习中 examing 待考试 examfailed未通过考试 finished已完成 unfinished 未完成 |
2、执行失败,返回值
{"errcode":"40006","errmsg":"AccessToken has expired"}
{"errcode":"40902","errmsg":"lessonID不存在,获取失败"}
{"errcode":"40903","errmsg":"课程参加方式为非账号密码,获取失败"}
获取课程信息
获取当前学员所有待参加练习和练习入口。如在第三方应用或App中,需要展示考试云待参加练习列表。
接口地址:https://api.kaoshiyun.com.cn/api/v5/lessonaction.ashx?token=[Token]&action=getLessonList&pageIndex=[pageIndex]&pageSize=[pageSize]
请求方式:GET或POST
参数说明:
参数名称 | 说明 |
token | 接口调用凭证,2小时内有效,请注意时效性 |
action | getLessonList |
pageIndex | 分页页码,默认第1页 |
pageSize | 每页条数,默认1000条 |
返回值说明:
1、执行成功
JSON返回值格式
{ "totalCount": 2, "currentPageIndex": 1, "items": [ { "lessonID": "8bf058", "lessonName": "第一季度岗位培训在线课程", "beginTime": "2022-01-11 17:17", "endTime": "2022-04-01 17:17", "passCondition": "达到课程学时", "attendNum": "4", "passNum": "2", "unPassNum": "2", "creatTime": "2021-07-25 17:17:34", "lessonUrl": "https://课程地址/v5/lesson/8bf058" }, { "lessonID": "06a1ad", "lessonName": "第二季度岗位培训在线课程 ", "beginTime": "2022-04-24 15:05", "endTime": "2022-07-01 15:05", "passCondition": "通过课程考试", "attendNum": "9", "passNum": "0", "unPassNum": "9", "creatTime": "2022-03-24 15:06:41", "lessonUrl": "https://课程地址/v5/lesson/06a1ad" } ] }
返回值参数说明
参数名称 | 说明 |
totalCount | 总记录数 |
currentPageIndex | 当前页码 |
lessonID | 课程编号 |
lessonName | 课程名称 |
beginTime | 课程开始时间 |
endTime | 课程结束时间 |
passCondition | 课程通过条件 |
attendNum | 参加课程人数 |
passNum | 通过课程人数 |
unPassNum | 未通过课程人数 |
lessonURL | 学习入口链接,点击链接进入课程学习 |
2、执行失败,返回值
{"errcode":"40006","errmsg":"AccessToken has expired"}
{"errcode":"40501","errmsg":"account参数不允许为空"}
{"errcode":"40502","errmsg":"account:[账号]在考试云中不存在"}
获取学员待参加课程
获取当前学员待参加练习和练习入口。如在第三方应用或App中,需要展示考试云待参加练习列表。
接口地址:https://api.kaoshiyun.com.cn/api/v5/lessonaction.ashx?token=[Token]&action=getUserLesson&account=[account]&pageIndex=[pageIndex]&pageSize=[pageSize]
请求方式:GET或POST
参数说明:
参数名称 | 说明 |
token | 接口调用凭证,2小时内有效,请注意时效性 |
action | getUserLesson |
account | 考生(学员)账号 |
pageIndex | 分页页码,默认第1页 |
pageSize | 每页条数,默认10条 |
返回值说明:
1、执行成功
JSON返回值格式
{ "totalCount": 2, "currentPageIndex": 1, "items": [ { "lessonID": "8bf058", "lessonName": "第一季度岗位培训在线课程", "beginTime": "2022-01-11 17:17", "endTime": "2022-03-01 17:17", "passCondition": "达到课程学时", "lessonUrl": "https://学习链接/v5/lesson/8bf058" }, { "lessonID": "06a1ad", "lessonName": "第二季度岗位培训在线课程", "beginTime": "2022-03-24 15:05", "endTime": "2022-06-01 15:05", "passCondition": "通过课程考试", "lessonUrl": "https://学习链接/v5/lesson/06a1ad" } ] }
返回值参数说明
参数名称 | 说明 |
totalCount | 总记录数 |
currentPageIndex | 当前页码 |
lessonID | 课程编号 |
lessonName | 课程名称 |
beginTime | 课程开始时间 |
endTime | 课程结束时间 |
passCondition | 课程通过条件 |
lessonURL | 学习入口链接,点击链接进入课程学习 |
2、执行失败,返回值
{"errcode":"40006","errmsg":"AccessToken has expired"}
{"errcode":"40501","errmsg":"account参数不允许为空"}
{"errcode":"40502","errmsg":"account:[账号]在考试云中不存在"}