企业部门 最后更新时间: 2023年07月28日
产品介绍
该 API 是通过 HTTPS 协议访问远程服务的接口，提供修改组织信息、添加/移除组织成员、修改组织成员信息的能力。
使用限制
详细的服务调用量限制可点我查阅。
业务身份和业务签名
bizToken和bizSign的详情可点我查阅 。
使用说明
如无特殊声明，接口的输入参数和输出数据编码全部统一为 UTF-8 编码方式。
1. 创建部门
请求地址
URL | |
请求方式 | POST |
签名参数 | openId |
特别注意：
- 一个部门下最多创建1000个直接子部门。
- 创建部门层级最多为20。
- 一个企业下部门名称不允许重复。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 管理员高德开放用户ID | 管理员用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
superDeptId | 父部门ID | 未填时表示根部门下创建一级部门 | 否 | 无 |
name | 部门名称 | 不超过20个字符 | 是 | 无 |
desc | 部门描述 | 部门描述，不超过100个字符 | 否 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | 创建成功的部门ID |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
110102：部门级别达到最大值 |
110103：部门名称重复 |
110104：直接子部门个数已达最大值 |
110105：部门名称违规 |
110105：部门描述违规 |
2. 修改部门
请求地址
URL | |
请求方式 | POST |
签名参数 | openId |
特别注意：暂无。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 管理员高德开放用户ID | 管理员用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
deptId | 部门ID | 被修改的父部门ID | 是 | 无 |
name | 部门名称 | 不超过20个字符，非null时表示修改 | 否 | 无 |
desc | 部门描述 | 部门描述，不超过100个字符，非null时表示修改 | 否 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | 无数据 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
110101：部门无效 |
110103：部门名称重复 |
110105：部门名称违规 |
110105：部门描述违规 |
3. 删除部门
请求地址
URL | |
请求方式 | POST |
签名参数 | openId |
特别注意：暂无。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 管理员高德开放用户ID | 管理员用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
deptId | 部门ID | 被修改的父部门ID | 是 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | 无数据 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
110107：删除的部门下还有子部门 |
110108：删除的部门下还有员工 |
4. 多个成员移动到指定部门
请求地址
URL | https://restwia.amap.com/api/v1/wia/org/dept/batchUserToDept |
请求方式 | POST |
签名参数 | openId |
特别注意：
- 移动成功后，会移除所有员工原加入的所有部门，除了目标部门。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 管理员高德开放用户ID | 管理员用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
deptId | 部门ID | 目标部门ID | 是 | 无 |
empIds | 员工ID列表 | 大小不能超过50。员工已在目标部门的话，则不处理，但不算有效的输入参数；如果所有的empIds都在目标部门，则报参数错误。 | 是 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | 无数据 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
110101：部门无效 |
110109：员工个数达到上限 |
5. 设置员工部门
请求地址
URL | https://restwia.amap.com/api/v1/wia/org/dept/userFinalToDepts |
请求方式 | POST |
签名参数 | openId |
特别注意：
- 用户最多加入10个部门。
- 该操作以用户输入的部门列表为最终结果，表示用户加入的部门列表。即用户之前加入的但本次未设置，则会从之前加入的部门退出。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 管理员高德开放用户ID | 管理员用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
empId | 员工ID | 是 | 无 | |
deptIds | 部门ID列表 | 用户最多加入10个部门。 | 是 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | 无数据 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
附表
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
110110：设置员工部门时，部门个数达到上限 |
6. 获取用户部门列表
请求地址
URL | https://restwia.amap.com/api/v1/wia/org/dept/getDeptsForUser |
请求方式 | POST |
签名参数 | openId |
特别注意：暂无。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 高德开放用户ID | 用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | List<DeptInfoDTO>，DeptInfoDTO的定义见文档末尾。 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
7. 获取指定部门信息
请求地址
URL | |
请求方式 | POST |
签名参数 | openId |
特别注意：暂无。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 高德开放用户ID | 用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
deptId | 部门ID | 是 | 无 | |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | DeptInfoDTO，DeptInfoDTO的定义见文档末尾。 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
8. 分页获取部门的子部门列表
请求地址
URL | |
请求方式 | POST |
签名参数 | openId |
特别注意：暂无。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 高德开放用户ID | 用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
deptId | 部门ID | 未传时，获取根部门下的数据 | 是 | 无 |
cursor | 分页游标 | 第一次可为null，后面以上一次请求返回的结果为准 | 否 | 无 |
limit | 分页大小 | 不能超过50 | 是 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | List<DeptPageResultDTO>，DeptPageResultDTO的定义见文档末尾。 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
9. 分页获取部门的子部门列表和员工列表
请求地址
URL | https://restwia.amap.com/api/v1/wia/org/dept/pageGetDeptsAndEmps |
请求方式 | POST |
签名参数 | openId |
特别注意：暂无。
请求参数
参数名 | 含义 | 规则说明 | 是否必填 | 缺省值 |
key | 请求服务权限标识 | 用户在高德地图官网申请Web服务API类型KEY | 是 | 无 |
openId | 高德开放用户ID | 用户在高德的身份ID | 是 | 无 |
bizToken | 工作地图身份token | 用户申请的工作地图身份token，一个组织一个token | 是 | 无 |
deptId | 部门ID | 未传时，获取根部门下的数据 | 是 | 无 |
cursor | 分页游标 | 第一次可为null，后面以上一次请求返回的结果为准 | 否 | 无 |
limit | 分页大小 | 不能超过50 | 是 | 无 |
bizSign | 业务签名 | 是 | 无 |
返回参数
返回字段 | 含义 | 规则说明 |
data | 数据体 | List<DeptAndEmpPageResultDTO>，DeptAndEmpPageResultDTO的定义见文档末尾。 |
code | 返回结果编码 | 1 表示成功 |
message | 返回状态说明 | 成功时返回Successful，否则返回错误原因 |
version | 版本号 | 字符串类型 |
timestamp | 时间戳 | Unix 时间戳，参考文档：《Unix 时间戳》 |
requestId | requestId是RPC链路的全局唯一标识，排查问题时需要提供 | 字符串格式，长度30 |
状态码code
0：异常 |
1：成功 |
2：失败 |
3：参数错误 |
110001：成员不在组织内 |
110002：组织不存在 |
对象实体信息定义
DeptInfoDTO
返回字段 | 含义 | 规则说明 |
orgId | 企业ID | |
deptId | 部门ID | |
superDeptId | 父部门ID | |
deptName | 部门名称 | 不超过20个字符 |
deptDesc | 部门描述 | 不超过100个字符 |
deptLevel | 部门级别 | 1-20级。 |
deptEmpCount | 部门下去重后的员工个数 | 包括所有子部门里的员工 |
directSubDeptCount | 部门下的直接子部门个数 | |
directDeptEmpCount | 部门下直属员工个数 | 不包括所有子部门里的员工 |
deptLink | 部门链 | List<DeptLinkElementDTO>，DeptLinkElementDTO的对象定义见下方。 |
DeptLinkElementDTO
返回字段 | 含义 | 规则说明 |
deptId | 部门ID | |
deptName | 部门名称 | 不超过20个字符 |
deptLevel | 部门级别 | 1-20级。 |
DeptPageResultDTO
返回字段 | 含义 | 规则说明 |
nextCuosor | 下一次分页请求要传入的游标 | |
hasMore | 是否还有更多数据 | |
deptList | 部门列表 | List<DeptInfoDTO>，DeptInfoDTO的定义见上文。 |
DeptAndEmpPageResultDTO
返回字段 | 含义 | 规则说明 |
nextCuosor | 下一次分页请求要传入的游标 | |
hasMore | 是否还有更多数据 | |
deptList | 部门列表 | List<DeptInfoDTO>，DeptInfoDTO的定义见上文。 |
empList | 员工列表 | List<EmpInfoDTO>，EmpInfoDTO的定义见下文。 |
EmpInfoDTO
返回字段 | 含义 | 规则说明 |
orgId | 企业ID | |
empId | 员工ID | |
openId | 用户的身份ID | |
empNickName | 员工昵称 | |
empIconImage | 员工头像 |
