课程学习列表查询服务（API名称：openApiGetPageMyUserCourse）
功能介绍
开放我的学习页面数据OpenAPI接口支持查询课程列表接口服务
相关接口
接口名称 |
调用说明 |
|---|---|
调用该接口获取到Token，再调用其他接口时，需要在请求消息头中添加“Authorization”，其值即为Token。 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
|---|---|---|---|
POST |
https://isdp+域名/openapi/v1/openApiGetPageMyUserCourse/openApiGetPageMyUserCourse |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
|---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
courseName |
String |
是 |
课程名称，支持模糊搜索 |
learnStatus |
String |
是 |
课程状态，课程状态(默认0 -1-删除 0-草稿、1-已发布、2-取消发布) |
learnType |
String |
是 |
课程类型，1-必修 2-选修 |
page入参：
参数 |
类型 |
是否必填 |
描述 |
|---|---|---|---|
start |
String |
是 |
起始 |
count |
String |
是 |
容量 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
result |
Object |
响应消息体 |
errorMessage |
String |
错误信息，接口错误时有值，正常调用时为空 |
stateCode |
String |
响应状态，“0”为成功，其他值失败 |
result出参：
参数 |
类型 |
描述 |
|---|---|---|
pos |
无 |
待定 |
total_count |
Int |
总数量 |
entityName |
String |
实体 |
totalCount |
Int |
总数量 |
data |
List |
数据 |
data出参：
参数 |
类型 |
描述 |
|---|---|---|
categoryId |
Long |
课程类别主键ID |
categoryName |
String |
课程类别名称 |
categoryCode |
String |
课程类别编码 |
courseId |
Long |
课程id |
courseName |
String |
课程名称 |
coverFileId |
String |
封面文件ID |
lastUpdateTimestamp |
Long |
最后更新时间戳 |
courseRemark |
String |
课程描述/课程简介 |
courseDuration |
String |
课程时长 单位:分钟 |
learnStatus |
Int |
课程状态 |
learnProgress |
Int |
课程学习进度百分数 默认0 |
userStartTimestamp |
Long |
学员课程开始时间对应的毫秒数 |
userEndTimestamp |
Long |
学员课程完成时间对应的毫秒数 |
learnType |
Int |
课程类型 |
creationTimestamp |
Long |
创建时间戳 |
learnDay |
Int |
学习天数 |
learnValidTimestamp |
Long |
学习有效时间戳 |
createdBy |
Long |
创建人 |
createName |
String |
创建人名称 |
courseCount |
Int |
章节数量 |
请求示例
{
"courseName" : "",
"learnType" : "",
"learnStatus" : "1",
"page" : {
"start" : 0,
"count" : 12
}
响应示例
{
"stateCode" : "0",
"errorMessage" : null,
"result" : {
"data" : [{
"categoryId" : 1005,
"categoryName" : "语言类",
"categoryCode" : null,
"courseId" : 1076,
"courseName" : "测试更新yqq",
"coverFileId" : 1315754,
"lastUpdateTimestamp" : 1626494052484,
"courseRemark" : "sfds",
"courseDuration" : 35,
"learnStatus" : 1,
"learnProgress" : 0,
"userStartTimestamp" : 1668387615190,
"userEndTimestamp" : null,
"learnType" : 1,
"creationTimestamp" : 1668387615307,
"learnDay" : 1,
"learnValidTimestamp" : 1668474015190,
"createdBy" : 1823,
"createName" : "张三",
"courseCount" : 0
}
],
"pos" : 0,
"total_count" : 1,
"entityName" : null,
"totalCount" : 1
}
}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码。
