成绩排行榜接口.md 4.53 KB

env.url: https://api[api-online.test].boxfish.cn

notes:

  • 默认所有接口都要携带token access_token

成绩查询接口

  • URL {env.url}/training/report/clazz/lesson/{courseId}/{type}/completion
  • GET Method
  • path 参数:

    参数名 类型 必填 说明 示例
    courseId String Y 课程id
    type String Y 排行榜类型 [app,paper,total,challenge,omnipotent]
  • request 参数:

    参数名 类型 必填 说明 示例
    clazz_id String Y 课堂id
    practice_part String N 第几部分
    paper bool N 包含纸质课程 五星榜需要传 true,false
  • response:

  • A+榜

    参数名 类型 必填 说明 示例
    top List Y top3 最多三条记录,完成度最多10条
    finished List Y 已完成
    unfinished List Y 未完成
    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    completion_A_PLUS Int Y A+个数 0
    completion_grades List N [A_PLUS,A,B]
    completion_grade_list List N [{"completion_grade":"A_PLUS","count":2}]
   {
      "top": [{
                  "user_id": 100000007866,
                  "user_real_name": "张坤",
                  "figure_url": "https://avatars.boxfish.cn/user/100000007866/figure/1544409519.jpg",
                  "completion_A_PLUS":4,
                  "completion_grades": [
                    "A_PLUS",
                    "A_PLUS",
                    "A_PLUS",
                    "A_PLUS",
                    "A",
                    "A",
                    "A",
                    "A"
                  ]
               }],
      "finished": [],
      "unfinished": []
}

  • 分数榜

    参数名 类型 必填 说明 示例
    top List Y top3 最多三条记录
    finished List Y 已完成
    unfinished List Y 未完成
    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    paper_rate_score int N 练习得分 100
  • PK榜

    参数名 类型 必填 说明 示例
    top List Y top3 最多三条记录
    finished List Y 已完成
    unfinished List Y 未完成
    percent int Y 正确百分比 整数 100
    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    challenge_answer_right bool N 是否正确 100
  • 五星榜

    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    star int N 星星 [0-5]
    paper_rate_score int N 练习得分 100
    user_review_class_comment String N 外教练成绩 [EXCELLENT, GREAT, KEEP_TRYING]
  • 全能A+榜 {type} omnipotent

    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    completion_grade_list List N
     [{
        "user_id": 100000008806,
        "user_real_name": "Zhao",
        "figure_url": "https://avatars.boxfish.cn/user/1298889/figure/1467366361.jpg",
        "completion_grade_list": [
          {
            "count": 9,
            "completion_grade": "A_PLUS"
          },
          {
            "count": 4,
            "completion_grade": "A"
          }
        ]
  }]