获取学生在教师的班级列表
使用场景: 调用本接口,查询学生在教师的哪些班级中,用于判断学生是否有权限上教师的课。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/class/get
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
student_userid | string | 是 | 学生id,可以通过/school/user/list获得 |
teacher_userid | string | 是 | 教师id,可以通过/user/list获得 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
department | 班级列表 | |
department.id | uint32 | 班级id |
department.subject | uint32 | 班级教师任教科目,可填语文、数学、物理、英语、化学或其他(自定义) |
department.type | uint32 | 班级教师类型,3表示班主任,4表示任课教师 |
department.full_path | string | 班级全路径 |
department.class_name | string | 班级名称 |
department.source | uint32 | 教师来源,1表示教育号,2表示教务基础 |
请求示例:
GET https://test-oapi.epaas.qq.com/user/class/get?access_token=ACCESS_TOKEN&student_userid=STUDENT_USERID&teacher_userid=TEACHER_USERID
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"departments": [
{
"id": 5896625,
"subject": "物理",
"type": 3,
"full_path": "/实验中学/学生/大学城/高中部/2020级/5班",
"class_name": "5班",
"source": 1
}
]
}
获取班级列表
使用场景: 调用本接口,按班级类型分页查询班级列表, 用于班级列表展示。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/class/list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
department_type | uint32 | 否 | 拉取班级类型,0表示全部,1表示行政班,8表示课程班 |
page_index | uint32 | 是 | 分页页码, 从1开始 |
page_size | uint32 | 是 | 每页大小 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
total | uint32 | 班级总数, 用于分页控制 |
department | 班级列表 | |
department.id | uint32 | 班级id |
department.class_name | string | 班级名称 |
department.parentid | uint32 | 班级的父节点id |
department.level | uint32 | 班级所在的层级 |
请求示例:
GET https://test-oapi.epaas.qq.com/class/list?access_token=ACCESS_TOKEN&department_type=DEPARTMENT_TYPE&page_index=PAGE_INDEX&page_size=PAGE_SIZE
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"total": 100,
"departments":[
{
"id": 123,
"class_name": "一班",
"parentid": 10,
"level": 4
},
{
"id": 124,
"class_name": "二班",
"parentid": 12,
"level": 3
}
]
}
通过教师获取任课班级
使用场景: 调用本接口,按班级类型查询教师的任课班级列表, 用于教师任课信息展示。注意:不是所有的班级都拥有学部、学段、校区等信息,如果没有,则返回相应类型的空值。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 支持 | 使用用户凭证时,Query参数 teacher_userid 可以不传,由用户的userid确定教师id |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/teacher/class/list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
department_type | uint32 | 否 | 拉取班级类型,0表示全部,1表示行政班,8表示课程班,10表示教学班 |
teacher_userid | string | 是 | 教师id,可以通过/user/list获取 |
full_path | uint32 | 否 | 是否返回部门全路径,0表示不返回,1表示返回 |
department_info | uint32 | 否 | 是否返回学部、学段、校区信息,0表示不返回,1表示返回 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
departments | object list | 班级列表 |
departments.id | uint32 | 班级id |
departments.class_name | string | 班级名称 |
departments.userid | string | 教师id |
departments.name | string | 教师名称 |
departments.type | uint32 | 班级教师类型,3表示班主任,4表示任课教师 |
departments.full_id_path | string | 部门id全路径 |
departments.full_path | string | 部门全路径 |
departments.subject | []string | 教师在班级里的任课科目列表 |
departments.grade_id | uint32 | 年级id |
departments.grade_name | string | 年级名称 |
departments.source | uint32 | 教师来源,1表示教育号,2表示教务基础 |
departments.standard_grade | int32 | 标准年级,仅当部门类型为年级或班级时有效,参数值含义参考《标准年级对照表》 |
departments.academic_dpt_id | uint32 | 学部id |
departments.academic_dpt_name | string | 学部名称 |
departments.org_attribute | int32 | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
departments.org_attribute_name | string | 学段名称 |
departments.campus_id | uint32 | 校区id |
departments.campus_name | string | 校区名称 |
请求示例:
GET https://test-oapi.epaas.qq.com/teacher/class/list?access_token=ACCESS_TOKEN&department_type=DEPARTMENT_TYPE&teacher_userid=TEACHER_USERID&full_path=FULL_PATH&department_info=DEPARTMENT_INFO
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"departments": [
{
"id": 5896625,
"class_name": "5班",
"userid": "372533",
"name": "小明",
"type": 3,
"subject": [
"物理"
],
"source": 1,
"full_id_path": "/5891840/5891841/5896622/5896623/5896624/5896625",
"full_path": "/实验中学/学生/大学城/高中部/2020级/5班",
"grade_id": 5896624,
"grade_name": "2020级",
"standard_grade": 92,
"academic_dpt_id": 5896623,
"academic_dpt_name": "高中部",
"org_attribute": 3,
"org_attribute_name": "高中",
"campus_id": 5896622,
"campus_name": "大学城"
}
]
}
通过班级获取教师
使用场景: 调用本接口,查询班级的教师列表, 用于班级信息展示。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/class/teacher/list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
department_id | uint32 | 是 | 班级id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
departments | object list | 班级列表 |
departments.id | uint32 | 班级id |
departments.userid | string | 教师id |
departments.name | string | 教师名称 |
departments.type | uint32 | 班级教师类型,3表示班主任,4表示任课教师 |
departments.subject | []string | 教师在班级里的任课科目列表 |
departments.source | uint32 | 教师来源,1表示教育号,2表示教务基础 |
请求示例:
GET https://test-oapi.epaas.qq.com/class/teacher/list?access_token=ACCESS_TOKEN&department_id=DEPARTMENT_ID
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"departments":[
{
"id": 123,
"userid": "123",
"name": "张三",
"type": 3,
"subject": [
"语文"
],
"source":1
},
{
"id": 123,
"userid": "234",
"name": "李四",
"type": 4,
"subject": [
"数学"
],
"source":2
}
]
}
获取学生所属班级列表
使用场景: 调用本接口,获取指定学生所在的班级列表。注意:不是所有的班级都拥有学部、学段、校区等信息,如果没有,则返回相应类型的空值。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/student/class/list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
department_type | uint32 | 否 | 拉取班级类型,0表示全部,1表示行政班,8表示课程班,10表示教学班 |
userid | string | 是 | 学生id |
full_path | uint32 | 否 | 是否返回部门全路径,0表示不返回,1表示返回 |
department_info | uint32 | 否 | 是否返回学部、学段、校区信息,0表示不返回,1表示返回 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
departments | object list | 班级列表 |
departments.id | uint32 | 班级id |
departments.class_name | string | 班级名称 |
departments.userid | string | 教师id |
departments.name | string | 教师名称 |
departments.type | uint32 | 班级教师类型,3表示班主任,4表示任课教师 |
departments.full_id_path | string | 部门id全路径 |
departments.full_path | string | 部门全路径 |
departments.subject | []string | 教师在班级里的任课科目列表 |
departments.grade_id | uint32 | 年级id |
departments.grade_name | string | 年级名称 |
departments.source | uint32 | 教师来源,1表示教育号,2表示教务基础 |
departments.standard_grade | int32 | 标准年级,仅当部门类型为年级或班级时有效,参数值含义参考《标准年级对照表》 |
departments.academic_dpt_id | uint32 | 学部id |
departments.academic_dpt_name | string | 学部名称 |
departments.org_attribute | int32 | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
departments.org_attribute_name | string | 学段名称 |
departments.campus_id | uint32 | 校区id |
departments.campus_name | string | 校区名称 |
请求示例:
GET https://test-oapi.epaas.qq.com/student/class/list?access_token=ACCESS_TOKEN&department_type=DEPARTMENT_TYPE&userid=USERID
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"departments": [
{
"id": 5896625,
"class_name": "5班",
"userid": "372533",
"name": "小明",
"type": 3,
"subject": [
"物理"
],
"source": 1,
"full_id_path": "/5891840/5891841/5896622/5896623/5896624/5896625",
"full_path": "/实验中学/学生/大学城/高中部/2020级/5班",
"grade_id": 5896624,
"grade_name": "2020级",
"standard_grade": 92,
"academic_dpt_id": 5896623,
"academic_dpt_name": "高中部",
"org_attribute": 3,
"org_attribute_name": "高中",
"campus_id": 5896622,
"campus_name": "大学城"
}
]
}
批量通过班级获取班主任
使用场景: 调用本接口,批量通过班级获取班主任
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/user/batch_get_class_admins
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
department_ids | uint32数组 | 是 | 班级id列表 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
data_list | object list | 数据列表 |
data_list.department_id | uint32 | 班级id |
data_list.userid | string | 教师id |
data_list.name | string | 教师名称 |
请求示例:
POST https://test-oapi.epaas.qq.com/user/batch_get_class_admins?access_token=ACCESS_TOKEN
请求示例:
{
"department_ids":[10001,10002]
}
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"data_list":[
{
"department_id": 123,
"userid": "123",
"name": "张三"
},
{
"department_id": 123,
"userid": "234",
"name": "李四"
}
]
}