[关闭]
@sewise-dev 2018-01-08T09:00:58.000000Z 字数 4482 阅读 667

微录播api(题库+播放记录)

微录播


更新历史

编号 版本 说明 作者 日期
1 v1.0 1.微录播相关接口 cjr 2017-01-13
2 v3.5.0 1.微录播问答接口 huanghy 2017-06-23

目录


1. 题目保存

接口功能

保存题目,新增题目

接口地址

/question

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
RequestBody
topicStr Json 题目内容,JSON字符串,如JSON.stringify({"question":"2+2=?","type":"single","option":["3","4","5"],"answerArray":[1]})
topicStr

组成形式:{json},如下为json的参数

参数 必选 类型 说明
type string 类型:多选multiselect、单选single、填空fill
question string 题目、问题
option array 选项内容如:[选项1,选项2,选项3,选项4]
answerArray array 答案的数组下标,如[1,2]
from string 问答来源
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 添加任务结果
msg string 错误信息,如错误,返回,否则没有
data json 新增的题目信息

其他响应状态描述请参照:【备注】-【错误码】

接口示例

Request
url: http://ip:port/question
Response
成功:{"success":true,"data":{"topic_id":"ab548019-0a5c-47d0-8f28-f193fe35199d","creator_uid":"777","question":"2+2=?","option":["3","4","5"],"answer":[1],"type":"single","create_time":"2017-06-23 09:18:26","from":"","_id":"594c6c622d374406a37038a9"}}
失败:{"success":false,"msg":"XXX"}

2. 题目更新

接口功能

更新题目

接口地址

/question

HTTP Content-Type

application/json

HTTP 请求方式

PUT

请求参数
参数 必选 类型 说明
RequestBody
topic_id string id
topicStr Json 题库内容,JSON字符串,如JSON.stringify({"question":"2+2=?","type":"single","option":["3","4","5"],"answerArray":[1]})
topicStr

组成形式:{json},如下为json的参数

参数 必选 类型 说明
type string 类型:多选multiselect、单选single、填空fill
question string 题目、问题
option array 选项内容如:[选项1,选项2,选项3,选项4]
answerArray array 答案的数组下标,如[1,2]
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息,如错误,返回,否则没有
topic_id string 题目topic_id

其他响应状态描述请参照:【备注】-【错误码】

接口示例

Request
url: http://ip:port/question
Response
成功:{"success":true}
失败:{"success":false,"msg":"XXX"}

3. 删除题目

接口功能

删除题目

接口地址

/question

HTTP Content-Type

application/json

HTTP 请求方式

DELETE

请求参数
参数 必选 类型 说明
RequestBody
topic_id string id
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息,如错误,返回,否则没有
topic_id string 题目topic_id

其他响应状态描述请参照:【备注】-【错误码】

接口示例

Request
url: http://ip:port/question
Response
成功:{"success":true}
失败:{"success":false,"msg":"XXX"}

4. 题目详情

接口功能

获取单个或多个题目信息

接口地址

/question/title

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
RequestBody
topic_id string topic_id,若要获取多个,用“,”分开,如:“1576542,132t4341”
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息,如错误,返回,否则没有
data array 数组形式返回题目信息

其他响应状态描述请参照:【备注】-【错误码】

接口示例

Request
url: http://ip:port/question
Response
成功:{"success":true,"data":[{"_id":"594a674cbbeb40304ce63e82","topic_id":"179d4bd3-52f8-4ad5-82d9-8e51c548ca68","creator_uid":"777","question":"1+1=?","option":["21","2"],"answer":[1],"type":"single","create_time":"2017-06-21 20:32:12","from":""}]}
失败:{"success":false,"msg":"XXX"}

5. 题库列表

接口功能

查询题库列表

接口地址

/question

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParam
page int 查询页数,默认为1
size int 一页显示数量,默认为15
q String 题目名称模糊搜索
tid String 老师userid(学生筛选老师问答时,此字段才有用)
stime String 开始时间,格式为2017-02-06 10:02:23
etime String 结束时间,有开始时间的时候必传
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息,如错误,返回,否则没有
data array 数据集合

其他响应状态描述请参照:【备注】-【错误码】

接口示例

Request
url: http://ip:port/question?page=""&size=""&q=""

Response
成功:{"success":true,"data":[{},{},...]}
失败:{"success":false,"error":"XXX"}

6. 答题

接口功能

回答题目

接口地址

/question/answer

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数
参数 必选 类型 说明
QueryParam
uid string 用户id
klgid string 知识点id
swlid string 课件id
questionid string 问题id值
answerid string 数组JSON字符串,如JSON.stringify(['xxx','xxx'])
tid string 老师名称
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
isRight boolean 是否回答正确
msg string 错误信息,如错误,返回,否则没有

其他响应状态描述请参照:【备注】-【错误码】

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {questionid:"",klgid:"",answerid:"",swpid:""}
url: http://ip:port/question/answer

Response
成功:{"success":true,"isRight": false}
失败:{"success":false,"error":"XXX"}

7.播放记录入库

接口功能

播放记录入库

接口地址

/question/addplay

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数
参数 必选 类型 说明
username string cookie里的用户信息(用户id)
swlid string 课件的swlid
total_time string 课件的视频总时长
callback_time string 播放回调间隔时间
precent string 播放视频的百分比
image string 当前播放的知识点图片
klgid string 默认为空;每一个知识点一开始播放时传当前播放知识点的klgid
HTTP 响应状态

200

返回字段 字段类型 说明
success boolean 任务结果
msg string 错误信息,如错误,返回,否则没有
data string 回调结果
接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {swlid:"",total_time:"",callback_time:"",precent:"",image:""}
url: http://ip:port/question/addplay

Response
成功:{"success":true,data: "XXX"}
失败:{"success":false,"msg":"XXX"}

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注