02班级API - PandaTofu/FishPound GitHub Wiki

新建班级

  • 请求地址: http://app_domain/class/add
  • 请求方法: POST
  • 请求参数:
参数 是否必填 类型 说明
access_token int 访问令牌
class_name string 班级名字
enroll_year int 入学年份(第几届)
  • 返回数据:
参数 类型 说明
result bool 结果(成功/失败)
error_code int 错误码(说明具体失败原因)
class_id int 班级ID(用以在数据库中唯一识别的ID)

生成邀请码

  • 请求地址: http://app_domain/class/invitation_code
  • 请求方法: POST
  • 请求参数:
参数 是否必填 类型 说明
access_token int 访问令牌
class_id int 班级ID
  • 返回数据:
参数 类型 说明
result bool 结果(成功/失败)
error_code int 错误码(说明具体失败原因)
invitation_code int 邀请码

申请加入某班级

  • 请求地址: http://app_domain/class/join
  • 请求方法: POST
  • 请求参数:
参数 是否必填 类型 说明
access_token int 访问令牌
invitation_code int 邀请码
  • 返回数据:
参数 类型 说明
result bool 结果(成功/失败)
error_code int 错误码(说明具体失败原因)
class_id int 班级ID

获取班级列表

  • 请求地址: http://app_domain/class/list
  • 请求方法: GET
  • 请求参数:
参数 是否必填 类型 说明
access_token int 访问令牌
max_item_number int 每次返回的最大班级数量(默认为10)
  • 返回数据:
参数 类型 说明
result bool 结果(成功/失败)
error_code int 错误码(说明具体失败原因)
class_list list 班级列表(班级格式待定)
⚠️ **GitHub.com Fallback** ⚠️