获取学生在教师下有权限的班级列表(user/class/get)
使用场景: 查询学生在教师的哪些班级下边,用于判断学生是否有权限上教师的课。
是否需额外授权: 否
请求方式: GET(HTTPS)
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
student_userid | 是 | 学生的userid,可以通过/school/user/list获得 |
teacher_userid | 是 | 教师的userid,可以通过/user/list获得 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"departments":[
{
"id": 123,
"class_name": "一班",
"type":3
},
{
"id": 124,
"class_name": "劳动",
"type":4
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
departments | object list | 有权限的班级列表 |
departments.id | int | 班级ID |
departments.class_name | string | 班级名 |
departments.type | int | 教师类型 3:班主任 4:任课教师 |
获取班级列表(class/list)
使用场景: 按班级类型分页查询班级列表, 用于班级列表展示。
是否需额外授权: 否
请求方式: GET(HTTPS)
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
department_type | 是 | 班级类型: 0-全部, 1-行政班, 8-课程班 |
page_index | 是 | 页码,从1开始 |
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
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
total | int | 班级总数 |
departments | object list | 班级列表 |
departments.id | int | 班级ID |
departments.class_name | string | 班级名 |
departments.parentid | int | 班级的父节点ID |
departments.level | int | 班级所在的层级 |
通过教师获取任课班级(teacher/class/list)
使用场景: 按班级类型查询教师的任课班级列表, 用于教师任课信息展示。
是否需额外授权: 否
请求方式: GET(HTTPS)
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
department_type | 否 | 班级类型: 0-全部, 1-行政班, 8-课程班, 10-教学班 |
teacher_userid | 是 | 教师的ID,可以通过/user/list获取 |
full_path | 是 | 是否返回部门全路径:0-不返回,1-返回 |
department_info | 是 | 是否返回学部、学段、校区信息: 0-不返回, 1-返回 |
注意:access_token,可以使用用户票据access_token代替(由/open/access_token获得。) 此时teacher_userid可以不传,由用户本身userid确定教师ID。
返回结果:
注意:不是所有的班级都拥有学部、学段、校区等信息,如果没有,则返回相应类型的空值。
{
"errmsg": "ok",
"errcode": 0,
"departments": [
{
"id": 12966844,
"class_name": "美术",
"userid": "92452708",
"name": "letter",
"type": 3,
"subject": [
"美术",
"数学"
]
"full_id_path": "/11807265/11807266/12739734/12966844",
"full_path": "/园丁开发测试测试学校1/学生/2017级/美术",
"grade_id": 12739734,
"grade_name": "2017级",
"standard_grade": 64,
"academic_dpt_id": 5666173,
"academic_dpt_name": "高中部",
"org_attribute": 3,
"org_attribute_name": "高中",
"campus_id": 0,
"campus_name": ""
},
{
"id": 12966858,
"class_name": "体育",
"userid": "92452708",
"name": "letter",
"type": 3,
"subject": [
"体育"
]
"full_id_path": "/11807265/11807266/12794859/12966858",
"full_path": "/园丁开发测试测试学校1/学生/2020级/体育",
"grade_id": 12794859,
"grade_name": "2020级",
"standard_grade": 31,
"academic_dpt_id": 5674330,
"academic_dpt_name": "初中部",
"org_attribute": 5,
"org_attribute_name": "初中",
"campus_id": 5666174,
"campus_name": "大学城校区"
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
departments | object list | 班级列表 |
departments.id | int | 班级ID |
departments.class_name | string | 班级名 |
departments.userid | string | 教师ID |
departments.name | string | 教师名 |
departments.type | int | 教师类型: 3-班主任, 4-任课老师 |
departments.full_id_path | string | 部门id完整路径 |
departments.full_path | string | 部门完整路径 |
departments.subject | string list | 教师在班级里的任课科目列表 |
departments.grade_id | int | 年级id |
departments.grade_name | string list | 年级名称 |
departments.standard_grade | int | 标准年级,仅当部门类型为年级(2)时有效,参数值含义参考《标准年级对照表》 |
departments.academic_dpt_id | int | 学部id |
departments.academic_dpt_name | string | 学部名称 |
departments.org_attribute | int | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
departments.org_attribute_name | string | 学段名称 |
departments.campus_id | int | 校区id |
departments.campus_name | string | 校区名称 |
通过班级获取教师(class/teacher/list)
使用场景: 查询班级的教师列表, 用于班级信息展示。
是否需额外授权: 否
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/class/teacher/list?access_token=ACCESS_TOKEN&department_id=XXX
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
department_id | 是 | 班级的ID |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"departments":[
{
"id": 123,
"userid": "123",
"name": "张三",
"type": 3,
"subject": [
"语文"
]
},
{
"id": 123,
"userid": "234",
"name": "李四",
"type": 4,
"subject": [
"数学"
]
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
departments | obejct list | 班级列表 |
departments.id | int | 班级ID |
departments.userid | string | 教师ID |
departments.name | string | 教师名 |
departments.type | int | 教师类型: 3-班主任, 4-任课老师 |
departments.subject | []string | 学科列表 |
获取学生所属班级列表(student/class/list)
使用场景: 需要支持拉取指定学生所在的班级列表。
是否需额外授权: 否
请求方式: GET(HTTPS)
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
userid | 是 | 学生ID |
department_type | 是 | 班级类型: 0-全部, 1-行政班, 8-课程班, 10-教学班 |
full_path | 是 | 是否返回部门全路径:0-不返回,1-返回 |
department_info | 是 | 是否返回学部、学段、校区信息: 0-不返回, 1-返回 |
注意:access_token,可以使用用户票据access_token代替(由/open/access_token获得。) 此时userid可以不传,由用户本身userid确定学生ID。
返回结果:
注意:不是所有的班级都拥有学部、学段、校区等信息,如果没有,则返回相应类型的空值。
{
"errmsg": "ok",
"errcode": 0,
"departments": [
{
"id": 12966843,
"class_name": "物理",
"department_type": 8,
"full_id_path": "/11807265/11807266/11810634/12966843",
"full_path": "/园丁开发测试测试学校1/学生/2019级/物理",
"grade_id": 5665864,
"grade_name": "2020级",
"standard_grade": 91,
"academic_dpt_id": 5665647,
"academic_dpt_name": "高中一部",
"org_attribute": 3,
"org_attribute_name": "高中",
"campus_id": 0,
"campus_name": ""
},
{
"id": 12966844,
"class_name": "美术",
"department_type": 8,
"full_id_path": "/11807265/11807266/12739734/12966844",
"full_path": "/园丁开发测试测试学校1/学生/2017级/美术",
"grade_id": 5665864,
"grade_name": "2020级",
"standard_grade": 91,
"academic_dpt_id": 5665637,
"academic_dpt_name": "高中二部",
"org_attribute": 3,
"org_attribute_name": "高中",
"campus_id": 5668438,
"campus_name": "大学城校区"
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
departments | object list | 班级列表 |
departments.id | int | 班级ID |
departments.class_name | string | 班级名 |
departments.department_type | int | 班级类型 |
departments.full_id_path | string | 部门id完整路径 |
departments.full_path | string | 部门完整路径 |
departments.grade_id | int | 年级id |
departments.grade_name | string | 年级名称 |
departments.standard_grade | string | 标准年级,仅当部门类型为年级(2)时有效,参数值含义参考《标准年级对照表》 |
departments.academic_dpt_id | int | 学部id |
departments.academic_dpt_name | string | 学部名称 |
departments.org_attribute | int | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
departments.org_attribute_name | string | 学段名称 |
departments.campus_id | int | 校区id |
departments.campus_name | string | 校区名称 |
批量添加班级教师(/class/teacher/batch_add)
使用场景: 批量添加班级的教师
是否需额外授权: 否
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/class/teacher/batch_add?access_token=ACCESS_TOKEN
请求包体:
{
"department_id":3032762,
"teachers":[
{"userid":"30046158", "type":3,"subject":["语文","其他学科"]},
{"userid":"30046160", "type":3,"subject":["数学"]}
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
department_id | 是 | 班级id |
teachers | obejct list | 教师列表 |
teachers.userid | 是 | 教师id |
teachers.type | 是 | 3:班主任 4:任课教师 |
teachers.subject | 否 | 语文 数学 物理 英语 化学 其他 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"result_list": [
{
"errcode": 0,
"errmsg": "OK",
"userid": "30046158"
},
{
"errcode": 0,
"errmsg": "OK",
"userid": "30046160"
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
result_list | obejct list | 列表 |
result_list.errcode | int | 0:成功 其他:失败 |
result_list.errmsg | string | "OK":成功 其他:错误信息 |
result_list.userid | string | 用户的userid |
批量删除班级教师(/class/teacher/batch_delete)
使用场景: 批量删除班级的教师
是否需额外授权: 否
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/class/teacher/batch_delete?access_token=ACCESS_TOKEN
请求包体:
{
"department_id":3032762,
"teachers":[
{"userid":"30046158", "type":3},
{"userid":"30046160", "type":3}
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证,使用corp_access_token,由/service/get_corp_token获得 |
department_id | 是 | 班级id |
teachers | obejct list | 教师列表 |
teachers.userid | 是 | 教师id |
teachers.type | 是 | 3:班主任 4:任课教师 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"result_list": [
{
"errcode": 0,
"errmsg": "OK",
"userid": "30046158"
},
{
"errcode": 1,
"errmsg": "班级不存在该教师",
"userid": "30046160"
}
]
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | int | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
result_list | obejct list | 列表 |
result_list.errcode | int | 0:成功 其他:失败 |
result_list.errmsg | string | "OK":成功 其他:错误信息 |
result_list.userid | string | 用户的userid |