CaμsAPI 接口定义

3. 学生课程动态获取

功能介绍:

  • 开发者通过此 API 获取学生本学期所学课程动态

接口: /learnhelper/{username}/courses

请求类型:POST

请求参数:

{
    "apikey": "API Key",
    "apisecret": "API Secret Key"
}

返回结果:

  • 学生课程动态获取成功
Response 200
{
    "message": "Success",
    "username": "Request username",
    "courses": [
        {
            "coursename": "Course Name",
            "courseid": "a semantic identifier for courses",
            "teacher": "Teacher Name",
            "email": "Teacher Email",
            "phone": "Teacher Phone",
            "unreadnotice": Unread Notice Number,
            "newfile": New File Number,
            "unsubmittedoperations": Unsubmitted Operations Number
        }
    ]
}

参数说明:

字段 含义 备注
courseid 课程ID 字符串,构成为"year-year-(1/2)-coursenumber-coursesequence", 可保证该字符串中的 "coursenumber-coursesequence" 子串对不同的课程是互异的
unreadnotice 课程未读公告数 非负整数
newfile 课程新文件数 非负整数
unsubmittedoperations 课程未交作业数 非负整数

参数示例:

Response 200

{
    "message": "Success",
    "username": "mzj14",
    "courses": [
      {
        "coursename": "计算机与网络体系结构(1)(0)(2016-2017秋季学期)",
        "courseid": "2016-2017-1-34100294-0",
        "teacher": "刘云浩",
        "email": "[email protected]",
        "phone": "62797784",
        "unsubmittedoperations": 2,
        "unreadnotice": 0,
        "newfile": 0
      },
      {
        "coursename": "Java语言程序设计(91)(2016-2017秋季学期)",
        "courseid": "2016-2017-1-00740123-91",
        "teacher": "谌卫军",
        "email": "[email protected]",
        "phone": "62782934",
        "unsubmittedoperations": 2,
        "unreadnotice": 0,
        "newfile": 0
      },
    ]
}
  • 学生课程动态获取失败 (即username非法)
Response 400

{
    "message": "Failure",
    "username": "Request username",
    "reason": "Invalid username"
}

results matching ""

    No results matching ""