简要描述:
- 查询学校下班级信息
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
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 | 是否查询学校信息 |
返回示例:
正确时返回:
{
"id": 0,
"name": "string",
"class_type": "string",
"class_type_name": "string",
"cover_url": "string",
"grade_id": 0,
"grade_name": "string",
"school_id": 0,
"school_name": "string"
}
错误时返回:
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
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 创建时间:2023-10-08 10:41
更新时间:2023-11-14 11:11
更新时间:2023-11-14 11:11