部门管理
# 创建部门
平台新增一个部门,部门名称同级不能重复,且部门ID不能为1(1为根节点ID)
请求方式 :POST
请求地址 :https://api.zkbiocloud.com/open/edu/school/basic/v1/department/save
请求数据
header域
| 入参名称 | 入参类型 | 默认值 | 必填 | 入参说明 |
|---|---|---|---|---|
| Content-Type | String | application/json | 是 | 指定请求的媒体类型 |
| Authorization | String | 是 | 令牌,详见令牌说明 |
body域
{
"payload": {
"params": {
"departmentId": "",
"departmentName": "云产品部",
"departmentParentId": ""
}
}
}
2
3
4
5
6
7
8
9
入参说明
| 入参名称 | 入参类型 | 参数长度 | 默认值 | 必填 | 入参说明 |
|---|---|---|---|---|---|
| departmentId | String | 32 | 否 | 部门ID(若部门ID为空,则熵基智联平台会自动生成;反之则第三方的为准) | |
| departmentName | String | 100 | 是 | 部门名称 | |
| departmentParentId | String | 32 | 0 | 否 | 部门父级ID,为空则默认为根节点 |
返回结果
{
"code": "00000000",
"payload": {
"results": {
"departmentId": "239399281d1b472ba663173eaeb92e3b"
}
}
}
2
3
4
5
6
7
8
出参说明
| 出参名称 | 出参类型 | 出参说明 |
|---|---|---|
| code | String | 响应返回码 |
| departmentId | String | 部门ID(32位的uuid) |
# 删除部门
删除一个部门,有子部门或有教职工的部门不能删除
请求方式:POST
请求地址:https://api.zkbiocloud.com/open/edu/school/basic/v1/department/delete
请求数据
header域
| 入参名称 | 入参类型 | 默认值 | 必填 | 入参说明 |
|---|---|---|---|---|
| Content-Type | String | application/json | 是 | 指定请求的媒体类型 |
| Authorization | String | 是 | 令牌,详见令牌说明 |
body域
{
"payload": {
"params": {
"departmentId": "bd3ffc623e364d82a8e493382ed4a0cc"
}
}
}
2
3
4
5
6
7
入参说明
| 入参名称 | 入参类型 | 参数长度 | 默认值 | 是否必填 | 入参说明 |
|---|---|---|---|---|---|
| departmentId | String | 32 | 是 | 部门ID(32位的uuid) |
返回结果
{
"code": "00000000",
"message": "success"
}
2
3
4
出参说明
| 出参名称 | 出参类型 | 出参说明 |
|---|---|---|
| code | String | 响应返回码 |
| message | String | 成功响应消息内容 |
# 更新部门
修改主体中一个部门的基本信息(部门ID无法变更)
请求方式:POST
请求地址:https://api.zkbiocloud.com/open/edu/school/basic/v1/department/update
请求数据
header域
| 入参名称 | 入参类型 | 默认值 | 必填 | 入参说明 |
|---|---|---|---|---|
| Content-Type | String | application/json | 是 | 指定请求的媒体类型 |
| Authorization | String | 是 | 令牌,详见令牌说明 |
body域
{
"payload": {
"params": {
"departmentId": "bd3ffc623e364d82a8e493382ed4a0cc",
"departmentName": "云产品部",
"departmentParentId": "0"
}
}
}
2
3
4
5
6
7
8
9
入参说明
| 入参名称 | 入参类型 | 参数长度 | 默认值 | 是否必填 | 入参说明 |
|---|---|---|---|---|---|
| departmentId | String | 32 | 是 | 部门ID(32位的uuid) | |
| departmentName | String | 100 | 是 | 部门名称 | |
| departmentParentId | String | 32 | 是 | 部门父级ID |
返回结果
{
"code": "00000000",
"message": "success"
}
2
3
4
出参说明
| 出参名称 | 出参类型 | 出参说明 |
|---|---|---|
| code | String | 响应返回码 |
| message | String | 成功响应消息内容 |
# 查询部门列表
查询所有的部门信息列表
请求方式:POST
请求地址:https://api.zkbiocloud.com/open/edu/school/basic/v1/department/list
请求数据
header域
| 入参名称 | 入参类型 | 默认值 | 必填 | 入参说明 |
|---|---|---|---|---|
| Content-Type | String | application/json | 是 | 指定请求的媒体类型 |
| Authorization | String | 是 | 令牌,详见令牌说明 |
body域
{
"payload": {
"params": {}
}
}
2
3
4
5
入参说明
| 入参名称 | 入参类型 | 参数长度 | 默认值 | 是否必填 | 入参说明 |
|---|
返回结果
{
"code": "00000000",
"message": "success",
"payload": {
"results": [
{
"departmentName": "测试API专用主体二",
"departmentFullName": "测试API专用主体二",
"departmentParentId": "0",
"departmentId": "1"
},
{
"departmentName": "测试33部",
"departmentFullName": "测试API专用主体二/测试33部",
"departmentParentId": "1",
"departmentId": "4"
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
出参说明
| 出参名称 | 出参类型 | 出参说明 |
|---|---|---|
| code | String | 响应返回码 |
| message | String | 成功响应消息内容 |
| departmentId | String | 部门ID(32位的uuid) |
| departmentName | String | 部门名称 |
| departmentFullName | String | 部门全名 |
| departmentParentId | String | 父部门ID(32位的uuid) |
# 查询部门树型列表
查询所有的部门信息树型列表
请求方式:POST
请求地址:https://api.zkbiocloud.com/open/edu/school/basic/v1/department/tree/list
请求数据
header域
| 入参名称 | 入参类型 | 默认值 | 必填 | 入参说明 |
|---|---|---|---|---|
| Content-Type | String | application/json | 是 | 指定请求的媒体类型 |
| Authorization | String | 是 | 令牌,详见令牌说明 |
body域
{
"payload": {
"params": {}
}
}
2
3
4
5
入参说明
| 入参名称 | 入参类型 | 参数长度 | 默认值 | 是否必填 | 入参说明 |
|---|
返回结果
{
"code": "00000000",
"message": "success",
"payload": {
"results": [
{
"departmentName": "测试API专用主体二",
"departmentFullName": "测试API专用主体二",
"departmentParentId": "0",
"departmentId": "1",
"childDepartments": [
{
"departmentName": "测试33部",
"departmentFullName": "测试API专用主体二/测试33部",
"departmentParentId": "1",
"departmentId": "4"
}
]
},
{
"departmentName": "cs",
"departmentFullName": "测试API专用主体二/cs",
"departmentParentId": "3",
"departmentId": "44"
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
出参说明
| 出参名称 | 出参类型 | 出参说明 |
|---|---|---|
| code | String | 响应返回码 |
| message | String | 成功响应消息内容 |
| departmentId | String | 部门ID(32位的uuid) |
| departmentName | String | 部门名称 |
| departmentFullName | String | 部门全名 |
| departmentParentId | String | 父部门ID(32位的uuid) |
| childDepartments | String | 子部门集合 |
# 同步部门
新增部门,若部门ID已存在,则更新部门信息
请求方式:POST
请求地址:https://api.zkbiocloud.com/open/edu/school/basic/v1/department/synchronize
请求数据
header域
| 入参名称 | 入参类型 | 默认值 | 必填 | 入参说明 |
|---|---|---|---|---|
| Content-Type | String | application/json | 是 | 指定请求的媒体类型 |
| Authorization | String | 是 | 令牌,详见令牌说明 |
body域
{
"payload": {
"params": {
"departments": [
{
"seqId": "1",
"event": "saveOrUpdate",
"departmentId": "1",
"departmentName": "123",
"departmentParentId": ""
}, {
"seqId": "2",
"event": "saveOrUpdate",
"departmentId": "2",
"departmentName": "456",
"departmentParentId": ""
}, {
"seqId": "3",
"event": "delete",
"departmentId": "3"
}
]
}
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
入参说明
| 入参名称 | 入参类型 | 参数长度 | 默认值 | 是否必填 | 入参说明 |
|---|---|---|---|---|---|
| departments | List | 是 | 部门集合(最大支持500) | ||
| seqId | String | 32 | 是 | 流水号 | |
| event | String | 20 | 是 | 事件(saveOrUpdate/delete) | |
| departmentId | String | 32 | 是 | 部门ID(32位的uuid) | |
| departmentName | String | 100 | 是 | 部门名称 | |
| departmentParentId | String | 32 | 0 | 否 | 部门父级ID,为空则默认为根节点 |
返回结果
{
"code": "00000000",
"payload": {
"results": [
{
"code": "00000000",
"mid": "1",
"payload": {
"results": {
"departmentId": "1"
}
}
}, {
"code": "00000000",
"mid": "2",
"message": "success"
}, {
"code": "00000000",
"mid": "3",
"message": "success"
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
出参说明
| 出参名称 | 出参类型 | 出参说明 |
|---|---|---|
| code | String | 响应返回码 |
| message | String | 成功响应消息内容 |
| departmentId | String | 部门ID(32位的uuid) |