简要描述:

  • 查询学校下班级信息

接口版本:

版本号 制定人 制定日期 修订日期
v0.1 dev 2019-09-02 init

请求URL:

请求方式:

  • GET

认证方式:

  • HMAC

详细可参见 开放平台API的认证说明

请求头:

参数名 是否必须 类型 说明
Content-Type string 请求类型: application/json
Date string http协议标准头
Authorization string hmac 签名
sdp-app-id string 应用租户ID,具体信息获取方式参见应用的sdp-app-id参数获取方式

请求参数:

参数名 是否必须 类型 默认值 说明
school_id long 学校id
class_id long 年级id
with_detail bool 是否查询班级信息
with_grade bool 是否查询年级信息
with_school bool 是否查询学校信息

返回示例:

正确时返回:

  1. {
  2. "id": 0,
  3. "name": "string",
  4. "class_type": "string",
  5. "class_type_name": "string",
  6. "cover_url": "string",
  7. "grade_id": 0,
  8. "grade_name": "string",
  9. "school_id": 0,
  10. "school_name": "string"
  11. }

错误时返回:

返回参数说明:

参数名 类型 说明
id long 班级ID
name string 班级名称 仅在with_detail为true时返回
class_type string 班级类型 目前支持类型:class-行政班, teaching_class-教学班;以后可能支持更多类型,请自行过滤不需要的班级类型。
class_type_name string 班级类型名称
cover_url string 班级封面 仅在with_detail为true时返回
grade_id long 年级ID 仅在with_detail为true时返回
grade_name string 年级名称 仅在with_grade为true时返回
school_id string 学校ID 仅在with_detail为true时返回
school_name string 学校名称 仅在with_school为true时返回
作者:wangtc  创建时间:2019-09-17 11:51
 更新时间:2023-11-14 10:57