部门同步接口

  • 接口:第三方提供
  • Method:POST
  • 数据格式:JSON
  • 接口说明:该接口用于同步部门主数据
  • 本接口的请求不携带 sign,鉴权仅使用 account + sessionId
  • 部分字段是否传递取决于云简侧的渠道配置:branchCodebranchName 由渠道的所属公司配置决定;ownerBindId 由渠道的部门领导配置决定;parentDepartmentCode 由渠道的组织架构配置决定,取该部门的上级部门或所属公司,若与自身部门编码相同则不传递
  • 文档末尾有文档版本记录

参数:

请求参数

字段名称 字段类型 字段描述 是否必填
account String 对接的公司编号,用于唯一确认对接公司 Y
sessionId String 身份验证信息 Y
data List<DepartmentInfo> 同步的部门信息 Y

DepartmentInfo

字段名称 字段类型 字段描述 是否必填
departmentName String 部门名称
departmentCode String 部门代码
branchName String 部门所属公司名称
branchCode String 部门所属公司代码
enabledFlag String 是否启用("Y":启用;"N":禁用)
type String 部门类型("B":公司;"D":部门)
parentDepartmentCode String 上级部门代码
ownerBindId String 部门领导id

返回参数

字段名称 字段类型 字段描述 是否必填
resCode Integer 错误码,同步成功填10000 Y
resMsg String 错误描述,正确写success Y
data List<DepartInfo> 同步失败的部门的信息 Y

DepartInfo

字段名称 字段类型 字段描述 是否必填
departmentCode String 部门code Y
errorMsg String 错误信息 Y
status Integer 0是失败,1 是成功 Y

说明:

  • 云简按返回项中的 departmentCode 与请求中的部门匹配:status=1 视为成功,其余取 errorMsg 记录失败原因;未出现在 data 中的部门按成功处理。
  • 第三方未返回结果、或云简侧无法生成身份验证信息(sessionId 获取失败)时,本批部门会被标记为同步失败。

示例:

请求数据

{
 "sessionId": "123321",
 "account": "avcsd123",
 "data": [
 {
 "departmentName": "研发部一组",
 "departmentCode": "3100",
 "enabledFlag": "Y",
 "parentDepartmentCode": "3000",
 "ownerBindId": "123"
 }
 ]
}

返回数据

{
 "resCode": 10000,
 "resMsg": "部分同步失败",
 "data": [
 {
 "departmentCode": "3100",
 "errorMsg": "部门已存在",
 "status": 0
 }
 ]
}
{
    "resCode": 10000,
    "resMsg": "同步成功",
    "data": []
}

文档版本记录

版本号 编写日期 更改内容
V1.0 2023.10.07 初稿
V1.1 2024.05.23 增加type参数
V1.2 2024.05.30 增加branchCode,branchName参数
V1.3 2026.09.11 补充字段取值来源(所属公司、部门领导、组织架构配置)与请求不携带 sign 的说明;补充返回结果的匹配与失败处理规则

results matching ""

    No results matching ""