获取部门列表
使用场景: 获取家校的部门列表,应用可缓存起来构建部门树,用于展示校区、学段、年级和班级列表。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/school/department/list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
id | 否 | 否 | 部门id。获取指定部门及其子部门。如果不填,默认获取全量组织架构 |
department_type | 否 | 否 | 部门类型,1 - 行政部门 (在校生的校区,学段,年级,班级)、4 - 毕业部门 (毕业的校区,学段,年级,班级)、8 - 课程班 (也叫兴趣班)、10 - 教学班 (仅高校支持)。不填,默认拉取行政部门 |
is_next_level_only | int32 | 否 | 只取直属的下一层级 0:表示返回所有子节点 1:表示不返回孙结点以及以下层级的节点 -- 【推荐】按需拉取,可减少时延问题 |
need_role_node | bool | 否 | 是否需要返回第二层的角色节点,即教师、临时成员、退休老师等的角色根节点 false:不返回 true:返回 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
department | 部门列表 | |
id | uint32 | 部门id,在机构内唯一 |
type | int32 | 部门类型,1表示班级,2表示年级,3表示学段,4表示校区,5表示学校(根部门)(注意:和/school/department/get返回的type含义不同) |
tag | int32 | 部门标签,(示例:4-年级,5-班级) 详情参数值含义参考《部门标签对照表》。其中,对部门标签的限制可参考《部门标签限制对照表》 |
name | string | 部门名称 |
parentid | uint32 | 父部门id,当查询部门是根部门时该项为0 |
register_year | int32 | 入学年份,仅标准年级返回,格式为YYYY |
standard_grade | int32 | 标准年级,当为部门为标准年级或班级时返回,参数值含义参考《标准年级对照表》 |
custom_grade | uint32 | 自定义年级 |
order | int32 | 在父部门中的次序值,order值小的排序靠前。仅在API设置后才返回 |
code | string | 部门代码 |
org_attribute | uint32 | 部门学段 |
level | int32 | 部门层级 |
department_admins | 部门管理员列表 | |
department_admins.userid | string | 部门管理员id |
department_admins.type | int32 | 管理员类型,参数值含义参考《家校部门管理员类型对照表》 |
department_admins.subject | string | 班级任课教师的科目 |
department_admins.subject_code | string | 班级任课教师的科目编码 |
department_admins.source | uint32 | 教师来源,1表示桂教通,2表示教务基础 |
department_admins.director_type | int32 | 1-正负责人(或正班主任) 2-副负责人(或副班主任) |
请求示例:
GET https://jz.hasmartedu.com/oapi/school/department/list?access_token=ACCESS_TOKEN&id=ID&department_type=DEPARTMENT_TYPE
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"departments": [
{
"id": 2,
"type": 1,
"name": "一年级5班",
"parentid": 1,
"register_year": 0,
"standard_grade": 0,
"custom_grade": 0,
"order": 1,
"department_admins": [
{
"userid": "123",
"type": 4,
"subject": "数学",
"subject_code": "P002",
"source": 1,
"director_type" : 1
}
],
"code": "870543",
"org_attribute": 3,
"level": 5,
"tag": 5
}
]
}
获取部门详情
使用场景: 可以获取部门学生部门的详情,包括全路径。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/school/department/get
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
id | uint32 | 否 | 部门id,0表示返回机构根节点,默认为0 |
is_full_path | uint32 | 否 | 是否返回部门全路径,0表示不返回,1表示返回,默认为0 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
id | uint32 | 部门id |
type | uint32 | 部门类型 , 1 - 行政部门 (在校生的校区,学段,年级,班级)、4 - 毕业部门 (毕业的校区,学段,年级,班级)、8 - 课程班 (也叫兴趣班)、10 - 教学班 (仅高校支持)(该值为创建部门时的department_type字段,注意:和/school/department/list返回的type含义不同) |
tag | int32 | 部门标签,(示例:4-年级,5-班级) 详情参数值含义参考《部门标签对照表》。其中,对部门标签的限制可参考《部门标签限制对照表》 |
name | string | 部门名称 |
parentid | uint32 | 部门父节点id,查询部门为根部门时该项为0 |
register_year | uint32 | 入学年份,仅当部门标签为年级(4)时有效,格式为YYYY |
standard_grade | uint32 | 标准年级,仅当部门标签为年级或班级时有效,参数值含义参考《标准年级对照表》 |
custom_grade | uint32 | 自定义年级 |
order | uint32 | 在父部门中的次序值,越小排序越前。 |
code | string | 部门代码,机构内唯一 |
org_attribute | uint32 | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
full_id_path | string | 部门id全路径 |
full_path | string | 部门全路径 |
department_admins | 部门管理员列表 | |
department_admins.userid | string | 部门管理员id |
department_admins.type | int32 | 管理员类型,参数值含义参考《家校部门管理员类型对照表》 |
department_admins.subject | string | 教师的任课科目 |
department_admins.subject_code | string | 教师的任课科目编码 |
department_admins.source | uint32 | 教师来源,1表示桂教通,2表示教务基础 |
department_admins.director_type | int32 | 1-正负责人(或正班主任) 2-副负责人(或副班主任) |
请求示例:
GET https://jz.hasmartedu.com/oapi/school/department/get?access_token=ACCESS_TOKEN&id=ID&is_full_path=IS_FULL_PATH
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"id": 97,
"code": "870543",
"name": "6",
"type": 1,
"parentid": 96,
"register_year": 0,
"standard_grade": 0,
"custom_grade": 0,
"org_attribute": 3,
"order": 1,
"tag": 5,
"department_admins": [
{
"userid": "62",
"type": 4,
"subject": "数学",
"subject_code": "P002",
"source": 1,
"director_type" : 1
}
],
"full_id_path": "/40/41/88/96/97",
"full_path": "/实验中学/学生/一年级/2020级/6班"
}
批量查询部门详情
使用场景: 根据部门id列表,查询部门的详情
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 不支持 | |
机构凭证 | 支持 | - |
请求方式: POST (HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/common/department/list?access_token=ACCESS_TOKEN
请求包体:
{
"department":[5952576,5952579]
}
参数说明:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证,使用机构凭证access_token |
department | uint32数组 | 是 | 部门ID列表 |
返回结果:
{
"errmsg": "ok",
"errcode": 0,
"department": [
{
"department_id": 5952576,
"name": "2015级",
"level": 3,
"parentid": 5165436,
"tag": 4,
"full_path": "/倩倩标准版十中/学生/2015级",
"department_type": 1,
"section": 3,
"code": "1009697_1_352079",
"standard_grade": 0,
"register_year": 2015,
"sort": 3,
"full_id_path": "/5165435/5165436/5952576"
},
{
"department_id": 5952579,
"name": "3班",
"level": 4,
"parentid": 5952576,
"tag": 5,
"full_path": "/倩倩标准版十中/学生/2015级/3班",
"department_type": 1,
"section": 3,
"code": "1009697_1_36741",
"standard_grade": 0,
"register_year": 0,
"sort": 3,
"full_id_path": "/5165435/5165436/5952576/5952579"
}
]
}
返回值参数说明:
参数 | 类型 | 说明 |
---|---|---|
errcode | uint32 | 返回码 |
errmsg | string | 对返回码的文本描述内容 |
department.department_id | uint32 | 部门id |
department.name | string | 部门名称 |
department.level | uint32 | 层级 |
department.parentid | uint32 | 父节点 |
department.department_type | uint32 | 部门类型, 参数值含义参考《部门类型对照表》。 |
department.tag | uint32 | 部门标签,(仅部门为学生的部门有效, 示例:4-年级,5-班级) 详情参数值含义参考《部门标签对照表》。 |
department.full_path | string | 全路径 |
department.section | uint32 | 部门学段,参数值含义参考《部门学段对照表》。 |
department.code | string | 部门编码 |
department.standard_grade | uint32 | 标准年级,仅当部门类型为年级或班级时有效,参数值含义参考《标准年级对照表》 |
department.custom_grade | uint32 | 自定义年级 |
department.register_year | uint32 | 入学年份,格式为YYYY,仅当部门标签为年级(4)时有效 |
department.sort | uint32 | 排序值,值越小排前面 |
department.full_id_path | string | 部门id的全路径 |
检索部门
使用场景: 学生部门检索,可以根据name, code,parentid三个任意一个来搜索学生部门,并且名称支持模糊检索,部门type限制为行政班,课程班,教学班之一。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/school/department/search
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
name | string | 否 | 部门名称, 参数 name / code / parentid 不能全为空 |
is_name_fuzzy | uint32 | 否 | 部门名称是否模糊搜索,0表示精确检索,1表示模糊搜索,默认为精确搜索 |
code | string | 否 | 部门代码,机构内唯一 |
parentid | uint32 | 否 | 部门父节点id,主要通过部门父节点id和部门名称精确查找 |
type | uint32 | 否 | 班级类别,仅支持传入0/1(行政班),8(课程班),10(教学班)。默认行政班 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
total | uint32 | 符合条件的部门总数 |
school_departments | 部门信息列表 | |
school_departments.id | uint32 | 部门id |
school_departments.name | string | 部门名称 |
请求示例:
POST https://jz.hasmartedu.com/oapi/school/department/search?access_token=ACCESS_TOKEN
请求包体:
{
"name": "一",
"is_name_fuzzy": 1,
"type": 1
}
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"total": 2,
"school_departments": [
{
"id": 5956,
"name": "一年级"
},
{
"id": 5957,
"name": "一班"
}
]
}
获取指定类型部门列表
使用场景: 根据部门类型分页获取部门列表,用于获取指定类型的部门进行展示。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: [GET, POST](HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/school/department/list_by_tag
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
tag | int32 | 是 | 架构属性, 1表示学生, 2表示学部, 3表示学院, 4表示年级, 5表示班级, 6表示系别, 7表示专业, 8表示学年, 9表示学期, 10表示校区 |
page_size | int32 | 否 | 每页多少条数据,默认10 |
page_index | int32 | 否 | 分页页码,默认1 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
total | int32 | 部门信息总数,用于分页 |
departments | uint32 | 部门信息列表 |
departments.department_id | uint32 | 部门id |
departments.name | string | 部门名称 |
departments.level | int32 | 部门层级,1为第一层 |
departments.parentid | uint32 | 部门父节点id |
departments.tag | int32 | 部门标签,参数值含义参考《部门标签对照表》。其中,对部门标签的限制可参考《部门标签限制对照表》 |
departments.full_path | string | 部门全路径 |
departments.extra | string | 部门额外信息,预留字段 |
departments.code | string | 部门代码 |
departments.standard_grade | int32 | 标准年级,仅当部门类型为年级或班级时有效,参数值含义参考《标准年级对照表》 |
departments.custom_grade | uint32 | 自定义年级 |
departments.register_year | int32 | 入学年份,格式为YYYY,仅当部门标签为年级(4)时有效 |
departments.section | int32 | 部门学段,参数值含义参考《部门学段对照表》。其中,学校类型对部门学段的限制可参考《学校类型对照表》,而版本类型对学校类型的限制可参考《版本类型对照表》 |
请求示例:
GET https://jz.hasmartedu.com/oapi/school/department/list_by_tag?access_token=ACCESS_TOKEN&page_index=PAGE_INDEX&page_size=PAGE_SIZE&tag=TAG
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"total": 3,
"departments": [
{
"department_id": 6624,
"name": "2020级",
"level": 5,
"parentid": 6623,
"tag": 4,
"full_path": "/实验中学/学生/大学城/高中部/2020级",
"extra": "二年级",
"code": "1081630",
"standard_grade": 92,
"custom_grade": 0,
"register_year": 2020,
"section": 3
}
]
}
获取班级的学生数量
使用场景: 调用本接口,可以获取班级部门的学生数量。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: POST(HTTPS)
请求地址: https://jz.hasmartedu.com/oapi/school/department/get_student_num
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
Body参数:
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
department_ids | []uint32 | 是 | 班级id列表 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
data_list | 班级学生数量列表 | |
data_list.department_id | []uint32 | 班级id |
data_list.student_num | []uint32 | 班级的学生数量 |
请求示例:
POST https://jz.hasmartedu.com/oapi/school/department/get_student_num?access_token=ACCESS_TOKEN
请求包体:
{
"department_ids": [
10001,
10002
]
}
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"department_id": 10001,
"student_num": 30
},
{
"department_id": 10002,
"student_num": 10
}
]
}