CaμsAPI 接口定义
4. 学生课程公告获取
功能介绍:
- 开发者通过此 API 获取学生本学期所学课程的公告
接口: /learnhelper/{username}/courses/{courseid}/notices
请求类型:POST
请求参数:
{
"apikey": "API Key",
"apisecret": "API Secret Key"
}
返回结果:
- 学生课程公告获取成功
Response 200
{
"message": "Success",
"username": "Request username",
"courseid": "Request courseid",
"notices": [
{
"noticeid": Notice ID,
"title": "Title",
"publisher": the person publishing the notice,
"publishtime": Publish Time,
"state": "read/unread",
"content": "Content"
}
]
}
参数说明:
字段 | 含义 | 备注 |
---|---|---|
noticeid | 公告id | 字符串类型的正整数,可保证所有公告id互异 |
publishtime | 公告发布时间 | 值为时间戳(ms为单位,以东八区为基准) |
state | 公告是否已读 | 值为”read”/”unread” |
参数示例:
Response 200
{
"message": "Success",
"username": "mzj14",
"courseid": "2016-2017-1-34100325-0",
"notices": [
{
"noticeid": "9162414",
"title": "后八周组队报名",
"publishtime": 1478016000000,
"state": "read",
"content": "请大家在课程讨论“后八周大作业组队报名区”填写组队信息"
},
{
"noticeid": "4123414",
"title": "关于十一假期调课通知",
"publishtime": 1474992000000,
"state": "read",
"content": "根据学校十一假期的安排,下周四(10月6日)的课程调整到10月8日,请同学们互相转告。"
}
]
}
- 学生课程公告获取失败 (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"
}