主要使用场景：组织机构接口7.0
机构、学校等组织的获取所有子部门列表，包括N层子部门
无
| url | https://opengate-basic.cq.smartedu.cn/user/openapi/org/get-org-child-list?org_id=***&accessToken={{accessToken}} |
| 请求方式 | get |
| 是否需要鉴权 | 是 |
| 请求数限制 | 否 |
| 接口方向 | 第三方应用->开放平台 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
org_id |
必选 |
String |
机构、学校等组织id | |
2 |
parent_id |
可选 |
String |
父节点id,查下级部门时不会包含当前部门(如果父节点和机构、学校节点相同，且is_all等于1时，等同于查所有部门) | |
3 |
is_all |
可选 |
String |
是否查下N级节点(1是，0否)，默认1 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
code |
必选 |
string |
结果编码,000000：成功, 100001：失败 | |
2 |
message |
必选 |
string |
结果描述 | |
3 |
result |
可选 |
json[] |
结果描述 | |
3.1 |
org_id |
必选 |
string |
部门id | |
3.2 |
org_name |
必选 |
string |
部门名称 | |
3.3 |
parent_id |
必选 |
string |
父部门id | |
3.4 |
org_type |
必选 |
string |
部门类型("1": "机构","2": "学校","3": "校区","4": "部门","5": "学段","6": "年级","7": "班级","8": "企业机构","9": "教学工作室","10": "平台") | |
3.5 |
display_order |
必选 |
int |
部门排序 |
请求示例
https://opengate-basic.cq.smartedu.cn/user/openapi/org/get-org-child-list?org_id=123&accessToken={{accessToken}}
返回示例
{
"code": "000000",
"message": "成功",
"result": {
"count": 3,
"list": [
{
"org_id": "1111111",
"org_name": "财务部",
"org_type": "4",
"parent_id": "111",
"display_order": "1"
}
]
}
}
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型，此时固定为：text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{
"msgtype": "text",
"text": {
"content": "zhxy msg text test 12"
}
}
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型，此时固定为：link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接，支持JPG、PNG格式，较好的效果为大图640*320，小图80*80。如不填，在客户端不显示图片 |
{
"msgtype": "link",
"link": {
"pcUrl": "http://www.baidu.com",
"appUrl": "http://www.baidu.com",
"picUrl": "http://xxx.yyy.com/zzz.jpg",
"content": "百度一下",
"title": "百度",
"busiId":"AQWER1234"
}
}
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型，此时固定为：oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符，其中前2为表示透明度，后6位表示颜色值。不要添加0x。默认值：FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示，不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单，最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |
京公网安备11010202010141号 渝ICP备09012933号-21