CaμsAPI 接口定义
5. 学生课程文件信息获取
功能介绍：
- 开发者通过此 API 获取学生本学期所学课程的文件信息
接口: /learnhelper/{username}/courses/{courseid}/documents
请求类型：POST
请求参数：
{
"apikey": "API Key",
"apisecret": "API Secret Key"
}
返回结果：
- 学生课程文件信息获取成功
Response 200
{
"message": "Success",
"username": "Request username",
"courseid": "Request courseid",
"documents": [
{
"title": "Title",
"explanation": "Brief explanation",
"updatingtime": Updating Time,
"state": "new/previous/unknown",
"size": "Size of file",
"url": "File url"
}
]
}
参数说明：
| 字段 | 含义 | 备注 |
|---|---|---|
| explanation | 文件描述 | |
| updatingtime | 文件更新时间 | 值为时间戳(ms为单位,以东八区为基准) |
| state | 文件是否已被下载 | 值为”new”/”previous”/“unknown”（unknown的原因是新版网络学堂不提供文件被下载的情况） |
| url | 文件下载地址 |
参数示例：
Response 200
{
"message": "Success",
"username": "mzj14",
"courseid": "2016-2017-1-34100325-0",
"documents": [
{
"title": "软件体系结构",
"explanation": "",
"updatingtime": 1479830400000,
"state": "new",
"size": "4.02M",
"url": "http://learn.tsinghua.edu.cn//uploadFile//downloadFile_student.jsp？module_id=322&filePath=2n2e5nUtUFn1P2nPup00yEVhifXGf4C6n%2Bi7VVnkZbTdi3aFD9Gh41GEi%2BiQxdQTwve19JUn6Ms%3D&course_id=137929&file_id=1701009"
}
]
}
- 学生课程文件信息获取失败 (username非法)
Response 400
{
"message": "Failure",
"username": "Request username",
"reason": "Invalid username"
}
- 学生课程文件信息获取失败 (courseid非法)
Response 400
{
"message": "Failure",
"username": "Request username",
"courseid": "Request courseid",
"reason": "Invalid courseID"
}