成绩排行榜接口.md 4.45 KB

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

notes:

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

成绩查询接口

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

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

    参数名 类型 必填 说明 示例
    clazz_id String Y 课堂id
    page String Y all 全部 ,0 第几页
  • response:

  • A+榜

    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    completion_grade_list List N
    silence boolean Y 是否被禁言 [true,false]
     [{
        "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"
          }
        ]
  }]   
  • 分数榜

    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    paper_rate_score int N 练习得分 100
    silence boolean Y 是否被禁言 [true,false]
    [{
        "user_id": 100000008807,
        "user_real_name": "周",
        "figure_url": "https://avatars.boxfish.cn/user/1298889/figure/1467366361.jpg",
        "paper_rate": 0.89,
        "paper_rate_score": 89,
        "paper_rate_update_time": "2019-10-09T04:08:30.447"
    }]
    
    • 五星榜
    参数名 类型 必填 说明 示例
    user_id String Y 用户id
    user_real_name String Y 用户姓名
    figure_url String N 用户头像
    star String N 五星 "1"
    [{
        "user_id": 100000008807,
        "user_real_name": "周",
        "figure_url": "https://avatars.boxfish.cn/user/1298889/figure/1467366361.jpg",
        "paper_rate_score": 0,
        "total_completion_grade": 0.8,
        "star": "1"
    }]
    

    上节课成绩查询接口

  • URL {env.url}/omnipotent/thinking/clazz/group/{groupId}/last/total/completion

  • GET Method

  • path 参数:

|参数名 | 类型 | 必填 | 说明 | 示例 | |-------------|--------|------|----------|------| | groupId | Long | Y |班级id| classSmallId |

  • response:

    httpcode:404 没有上次课程成绩
    httpcode:200
    

|参数名 | 类型 | 必填 | 说明 | 示例 | |-------------|--------|------|----------|------| | coruse | object | Y |课程信息| | | total_completion | List | Y |排行榜 |

  • course

|参数名 | 类型 | 必填 | 说明 | 示例 | |-------------|--------|------|----------|------| | courseId | String | Y |课程id| | | courseName | String | Y |课程名称 | | paperId | String | N |纸质课程id | | paperName | String | N |纸质课程名字 | | | paperName | String | N |纸质课程名字 | |

  • total_completion

|参数名 | 类型 | 必填 | 说明 | 示例 | |-------------|--------|------|----------|------| | user_id | String | Y |用户id| | | user_real_name | String | Y |用户姓名 | | figure_url | String | N |用户头像 | | star | String | N |五星 | "1" |

  {
  "course":{
        "paperId":"",
        "paperName":""
  },
  "total_completion":[{
        "user_id": 100000008807,
        "user_real_name": "周",
        "figure_url": "https://avatars.boxfish.cn/user/1298889/figure/1467366361.jpg",
        "paper_rate_score": 0,
        "total_completion_grade": 0.8,
        "star": "1"
 }]
 }