简要描述:
- 获取部门列表
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
v0.1 | dev | 2022-03-23 | init |
请求URL:
- http://{api-gateway-host}/ding/topapi/edu/dept/list
请求方式:
- POST
认证方式:
- HMAC
详细可参见 开放平台API的认证说明
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
Content-Type | 是 | string | 请求类型: application/json |
Date | 是 | string | http协议标准头 |
Authorization | 是 | string | hmac 签名 |
sdp-app-id | 是 | string | 应用租户ID,具体信息获取方式参见应用的sdp-app-id参数获取方式 |
请求参数:
参数名 | 是否必须 | 类型 | 默认值 | 说明 |
---|---|---|---|---|
page_size | 是 | int | 最小1 最大30 | |
page_no | 是 | int | 从1开始 | |
super_id | 是 | long | 父部门节点ID |
请求示例:
{
"page_size": 0,
"page_no": 0,
"super_id": 0
}
返回示例:
正确时返回:
{
"request_id": "string",
"success": true,
"errcode": 0,
"result": {
"has_more": true,
"super_id": 0,
"details": [
{
"nick": "string",
"chain": "string",
"feature": "string",
"name": "string",
"contact_type": "string",
"dept_type": "string",
"dept_id": 0
}
]
}
}
错误时返回:
返回参数说明:
参数名 | 类型 | 说明 |
---|---|---|
request_id | string | 请求ID |
success | boolean | 是否成功 |
errcode | int | 返回码 |
result.has_more | boolean | 是否有更多数据 |
result.super_id | long | 父部门ID |
result.details | array | 部门节点列表 |
result.details.nick | string | 部门别名 |
result.details.chain | string | 节点链。从顶层节点到当前节点的中间节点 |
result.details.feature | string | 部门节点特有属性 |
result.details.name | string | 部门名 |
result.details.contact_type | string | 通讯录类型: classic:传统经典4层结构。校区/学段/年级/班级 custom:自定义结构 |
result.details.dept_type | string | 节点类型: grade:年级 class:班级 dept:普通节点,没有业务含义,主用存在于自定义通讯录中 |
result.details.dept_id | long | 部门ID |
作者:wangtc 创建时间:2023-10-08 10:41
最后编辑:wangtc 更新时间:2023-11-14 11:11
最后编辑:wangtc 更新时间:2023-11-14 11:11