查询下属机构
使用场景: 获取行政单位下属的行政单位或学校列表(需要业务侧根据使用场景做好缓存)
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 仅支持租户管理员和机构管理员 |
机构凭证 | 支持 | - |
请求方式:GET(HTTPS)
请求地址:https://oapi.epaas.qq.com/corp/relation/list?access_token=ACCESS_TOKEN&type=XXX
请求示例:
{
"corpid": 1,
"type": 2,
"is_need_all": true
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户调用接口凭证 |
corpid | 否 | 机构id (支持下属机构) |
type | 否 | 获取类型: 2:教育局, 4: 学校 10: 虚拟机构, 0: 不限制类型 默认为0 |
is_need_all | 否 | 是否查询全部下属机构,传true时忽略type参数的取值(默认只查找下一级机构, 一般不推荐查询全部下属机构,数量多时,时延较大,请根据时间情况使用) |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"relation_list": [
{
"corpid": 2,
"name": "深圳教育局",
"type": 2,
"logo": "xxx.xxx",
"parent_corpid":1
},
{
"corpid": 3,
"name": "广州教育局",
"type": 2,
"logo": "xxx.xxx",
"parent_corpid":1
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
relation_list | 机构列表 |
relation_list.corpid | 机构id |
relation_list.name | 名字 |
relation_list.type | 机构类型 2:教育局, 4: 学校,10: 虚拟机构 |
relation_list.logo | 机构Logo |
relation_list.parent_corpid | 父机构id |
批量查询上级单位
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | |
机构凭证 | 支持 | - |
使用场景: 批量获取上级单位, 支持学校,教育局和虚拟机构
调用权限:
- 需要额外授权:应用申请白名单
- 支持用户票据
- 支持机构票据
请求方式:POST(HTTPS)
请求地址:https://oapi.epaas.qq.com/corp/office/superior?access_token=ACCESS_TOKEN
请求示例:
{
"corpid_list":[1072324]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户调用接口凭证 |
corpid_list | 是 | 机构id列表 (教育局可查下属机构, 学校只能查自己和中心校) |
is_deputy_office | 否 | 获取类型: 0-主上级,1-副上级 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"corpid": 1072324,
"superior_corpid": 1041801,
"superior_name": "机构jimmy地区1",
"is_deputy_office": 1
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
data_list | 机构列表 |
data_list.corpid | 机构id |
data_list.superior_corpid | 上级单位的id |
data_list.superior_name | 上级单位的名称 |
绑定上下级关系
使用场景: 绑定机构上下级关系
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 租户管理员角色 + 机构管理员角色 |
机构凭证 | 不支持 | - |
请求方式:POST(HTTPS)
请求地址:https://oapi.epaas.qq.com/corp/relation/bind?access_token=ACCESS_TOKEN
请求示例
{
"corpid": 2,
"sub_corpid_list": [
1,
3
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户调用接口凭证 |
corpid | 否 | 上级机构 id,机构票据查询使用自身id,用户票据使用传入的corpid,教育局只能管理level比自己低的教育局作为下级 |
sub_corpid_list | 是 | 下级机构列 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"sub_corpid": 1,
"errmsg": ""
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
data_list.sub_corpid | 下级 |
data_list.errmsg | 对返回码的文本描述内容 |
解绑上下级关系
使用场景: 解除机构间的绑定关系
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 需要 | |
用户凭证 | 支持 | 租户管理员角色 + 机构管理员角色 |
机构凭证 | 不支持 | - |
请求方式:POST(HTTPS)
请求地址:https://oapi.epaas.qq.com/corp/relation/unbind?access_token=ACCESS_TOKEN
请求示例
{
"corpid": 2,
"sub_corpid_list": [
1,
3
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 用户调用接口凭证 |
corpid | 否 | 上级机构 id,机构票据查询使用自身id,用户票据使用传入的corpid |
sub_corpid_list | 是 | 下级机构列表 |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"data_list": [
{
"sub_corpid": 1,
"errmsg": ""
}
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
data_list.sub_corpid | 下级 |
data_list.errmsg | 对返回码的文本描述内容 |