创建部门
使用场景: 调用本接口,创建校区、学段、年级或班级,用于学年开始时的数据初始化。创建后会返回部门的ID,可以继续作为参数来创建下一级的部门。一般情况下,使用/school/department/list获取到家校部门后,可以取出Level=0(一般为首条数据)的根节点,来创建校区,然后根据校区的部门ID来创建学段,根据学段ID来创建年级,根据年级ID来创建班级。其中班级必须是在年级下边的,年级则可以在根节点、校区、学段任一级别下。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | - |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/school/department/create
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
name | string | 是 | 部门名称 |
parentid | uint32 | 是 | 父部门id,部门id可以由/school/department/list获得,也可以调用此接口创建部门后返回 |
order | uint32 | 否 | 在父部门中的次序值,越小排序越前, 0表示自动增加 |
tag | int32 | 是 | 部门标签,(示例:4-年级 5-班级) 详情参数值含义参考《部门标签对照表》。其中,对部门标签的限制可参考《部门标签限制对照表》 。 |
department_type | int32 | 否 | 部门类型,仅支持传入1 - 行政部门 (在校生的校区,学段,年级,班级)、4 - 毕业部门 (毕业的校区,学段,年级,班级)、8 - 课程班 (也叫兴趣班)、10 - 教学班 (仅高校支持)。默认创建行政班 |
standard_grade | uint32 | 否 | 标准年级,仅当部门标签为年级(4)时有效,参数值含义参考《标准年级对照表》,建议使用标准年级来创建年级,能够自动升学 (注意: standard_grade,register_year和org_attribute都有值,会做standard_grade和register_year是否正确的校验) |
custom_grade | uint32 | 否 | 自定义年级 |
code | string | 否 | 部门代码,机构内唯一 |
org_attribute | uint32 | 否 | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
register_year | uint32 | 否 | 入学年份,格式为YYYY,仅当部门标签为年级(4)时有效 |
department_admins | 否 | 部门管理员列表 | |
department_admins.userid | string | 是 | 管理员id,需要是教职工,可以由/user/list获得,也可以由/user/create创建后获得 |
department_admins.type | uint32 | 是 | 管理员类型,参数值含义参考《家校部门管理员类型对照表》 |
department_admins.subject | string | 否 | 教师的任课科目, 该字段仅在班级(tag=5)时可用(废弃使用,请先试用查询学科列表接口查到科目编码) |
department_admins.subject_code | string | 否 | 教师的任课科目编码, 该字段仅在班级(tag=5)时可用 |
department_admins.director_type | uint32 | 否 | 管理员正副属性。当type为班级或年级等负责人时必须要指定 1-正 2-副 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
id | uint32 | 创建的部门id |
请求示例:
POST https://test-oapi.epaas.qq.com/school/department/create?access_token=ACCESS_TOKEN
请求包体:
{
"name": "一年级",
"parentid": 1,
"order": 1,
"tag": 5,
"department_type":4,
"register_year": 2020,
"standard_grade": 1,
"custom_grade": 0,
"code": "2020ynj",
"org_attribute":0,
"department_admins": [
{
"userid": "123",
"type": 3,
"subject": "语文",
"subject_code": "P001"
},
{
"userid": "456",
"type": 4,
"subject": "数学",
"subject_code": "P001"
}
]
}
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"id": 2
}
修改部门
使用场景: 修改指定部门的数据,可以迁移部门节点到同样类型的父部门下边,也可以增删改班级类型的部门管理员,更新和删除部门管理员是以userid和type作为判断依据的。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/school/department/update
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
id | uint32 | 是 | 部门Id,可以由/school/department/list获得,也可以由/school/department/create创建后返回 |
name | string | 是 | 部门名称 |
parentid | uint32 | 是 | 父部门id,部门id可以由/school/department/list获得,也可以调用此接口创建部门后返回 |
order | uint32 | 否 | 在父部门中的次序值,越小排序越前, 0表示自动增加 |
code | string | 否 | 部门代码,机构内唯一 |
org_attribute | uint32 | 否 | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
custom_grade | uint32 | 否 | 自定义年级 |
register_year | uint32 | 否 | 入学年份 |
override_update_admins | uint32 | 否 | 是否覆盖更新管理员列表 0-忽略该字段 1-覆盖更新 |
department_admins | 否 | 部门管理员列表 | |
department_admins.op | uint32 | 是 | 部门管理员操作类型,0-新增,1-删除 (如果override_update_admins=1, 该接口请求中只能有op=0的数据) |
department_admins.userid | string | 是 | 管理员id,需要是教职工,可以由/user/list获得,也可以由/user/create创建后获得 |
department_admins.type | uint32 | 是 | 管理员类型,参数值含义参考《家校部门管理员类型对照表》 |
department_admins.subject | string | 否 | 教师的任课科目, 该字段仅在班级(tag=5)时可用(废弃使用,请先试用查询学科列表接口查到科目编码) |
department_admins.subject_code | string | 否 | 教师的任课科目编码, 该字段仅在班级(tag=5)时可用 |
department_admins.director_type | uint32 | 否 | 管理员正副属性。当type为班级或年级等负责人时必须要指定 1-正 2-副 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
请求示例:
POST https://test-oapi.epaas.qq.com/school/department/update?access_token=ACCESS_TOKEN
请求包体:
{
"id": 2,
"name": "一年级",
"parentid": 1,
"order": 1,
"code": "ynj",
"org_attribute":0,
"custom_grade": 0,
"register_year":2022,
"department_admins": [
{
"op": 0,
"userid": "123",
"type": 3,
"subject": "语文",
"subject_code": "P001"
},
{
"op": 1,
"userid": "456",
"type": 4,
"subject": "数学",
"subject_code": "P002"
}
]
}
返回示例:
{
"errcode": 0,
"errmsg": "ok"
}
删除部门
使用场景: 调用本接口,删除指定部门,部门下不能含有子部门或学生。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/school/department/delete
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
id | uint32 | 是 | 部门id,可以由/school/department/list获得,也可以由/school/department/create创建后返回, 不能删除根部门,含有子部门、学生的部门 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
请求示例:
GET https://test-oapi.epaas.qq.com/school/department/delete?access_token=ACCESS_TOKEN&id=ID
返回示例:
{
"errcode": 0,
"errmsg": "ok"
}
班级毕业
使用场景: 调用本接口,令班级所有学生毕业,成为毕业生。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | 申请方式:联系项目接口人申请 |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://test-oapi.epaas.qq.com/school/department/graduate
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
department_id | uint32 | 是 | 部门id,必须是行政班级 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
请求示例:
POST https://test-oapi.epaas.qq.com/school/department/graduate?access_token=ACCESS_TOKEN
请求包体:
{
"department_id":8542
}
返回示例:
{
"errcode": 0,
"errmsg": "ok"
}