批量同步接口

  • 接口：common/users/v2/batch
  • Method：POST
  • 数据格式：JSON
  • 限流信息：150次每天和50次每小时
  • 多语言环境：在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
  • 接口说明：该接口用作人员信息的批量同步(根据code是否存在判断新增/更新)，在整批数据中如果只有几条数据因为其他原因失败，那么只有这几条数据不会被处理，其他数据仍会被正常处理
  • 其他补充信息：该接口用作人员信息的批量同步(根据code是否存在判断新增/更新)，在整批数据中如果只有几条数据因为其他原因失败，那么只有这几条数据不会被处理，其他数据仍会被正常处理
  • 默认情况下，仍使用员工号新增更新, 员工号为空时，可在请求头上添加参数keyCode=user_name, 将使用用户名新增更新

参数:

请求参数

字段名称 字段类型 字段描述 是否必填 长度限制(字节)
bizId String 当前次接口同步的唯一标识 TRUE 36
timestamp long 当前次接口同步对应的时间戳 TRUE 13
clear_field_array Array 清除字段 FALSE 必填字段不能清除，需清除字段在data中不能有值，例如需清空mobile，则data中的mobile字段不能传值，如果传值的话依然会按照传的值进行更新
data Array 当前次接口同步的数据集合 TRUE 无
data.code String 用户员工号 TRUE 64
data.email_address String 用户电子邮箱地址 FALSE 255
data.full_name String 用户全名 TRUE 255
data.department_code String 用户所属部门代码 TRUE 64
data.branch_code String 默认核算公司 FALSE 64
data.cost_center_code String 用户所属成本中心编码 FALSE 64
data.position_codes Array 用户所属职位编码信息集合(取第一位为默认职位) FALSE 无
data.position_flag String 是否保留原有职位信息标识(Y/N) FALSE 1
data.level String 用户等级 FALSE 64
data.base_city String 用户默认城市 FALSE 64
data.mobile String 用户手机号 FALSE 64
data.user_name String 用户名 TRUE 64
data.inactive_flag String 用户启用标志(Y/N,默认为Y) FALSE 1
data.gender String 用户性别(M/F) FALSE 16
data.birthday Date 用户生日(格式 yyy-MM-dd HHss) FALSE 0
data.surname String 用户姓氏 FALSE 255
data.date_of_joining Date 用户入职日期(格式 yyy-MM-dd HHss) FALSE 0
data.resignation_date Date 用户离职日期(格式 yyy-MM-dd HHss) FALSE 0
data.inactive_date Date 用户禁用日期(格式 yyy-MM-dd HHss) FALSE 0
data.nationality String 用户国籍 FALSE 64
data.credit_level Integer 信用分等级 FALSE 10
data.credit_score Integer 信用分 FALSE 10
data.approval_level Integerr 审批层级，用于审批权限设置 FALSE 10
data.parent_code String 上级员工号 FALSE 64
data.column1-column50 String column字段信息 FALSE 255
data.attribute1-attribute5 String attribute字段信息 FALSE 255

返回参数

字段名称 字段类型 字段描述
bizId String 当前次接口同步的唯一标识
resCode Integer 响应状态码（见附录）
resMsg String 返回信息描述
created String 创建成功的条数
updated String 更新成功的条数
validatorErrors Array 字段强校验不合格的数据
dbErrors Array 数据持久化时出现错误的数据
warnings Array 字段弱校验不合格的数据，任会做同步处理

示例：

请求数据

{
  "bizId" : "d162175f-5bdf-43c8-a245-a013dc219ffd",
  "timestamp" : 1591261960559,
  "data" : [ {
    "mobile" : "13858923834",
    "gender" : "M",
    "birthday" : "1993-07-14 00:00:00",
    "nationality" : "CHN",
    "code" : "E000521",
    "email_address" : "haibo21.wang@mail.com",
    "full_name" : "王海波",
    "inactive_flag" : "Y",
    "date_of_joining" : "2017-05-02 00:00:00",
    "resignation_date" : "2017-05-03 00:00:00",
    "approval_level" : "2",
    "department_code" : "D010",
    "branch_code" : "D010",
    "position_codes" : [ {
      "code" : "P017"
    }, {
      "code" : "P018"
    }, {
      "code" : "P103"
    } ],
    "base_city" : "上海"
  }, {
    "mobile" : "13858923835",
    "gender" : "M",
    "birthday" : "1993-07-15 00:00:00",
    "nationality" : "CHN",
    "code" : "E000622",
    "email_address" : "haiwen22.wang@mail.com",
    "full_name" : "王海文",
    "inactive_flag" : "Y",
    "date_of_joining" : "2017-05-03 00:00:00",
    "resignation_date" : "2017-05-04 00:00:00",
    "approval_level" : "2",
    "department_code" : "D011",
    "position_codes" : [ {
      "code" : "P017"
    }, {
      "code" : "P018"
    }, {
      "code" : "P103"
    } ],
    "base_city" : "上海"
  }, {
    "mobile" : "13858923834",
    "gender" : "M",
    "birthday" : "1993-07-16 00:00:00",
    "nationality" : "CHN",
    "code" : "E000722",
    "email_address" : "",
    "full_name" : "王海易",
    "inactive_flag" : "Y",
    "date_of_joining" : "2017-05-05 00:00:00",
    "resignation_date" : "2017-05-06 00:00:00",
    "approval_level" : "2",
    "department_code" : "D012",
    "position_codes" : [ {
      "code" : "P017"
    }, {
      "code" : "P018"
    }, {
      "code" : "P103"
    } ],
    "base_city" : "北京"
  } ]
}

返回数据

{
  "resCode" : 200000,
  "resMsg" : "success",
  "bizId" : "d162175f-5bdf-43c8-a245-a013dc219ffd",
  "data" : {
    "validatorErrors" : [ {
      "code" : "E000722",
      "messages" : [ "用户邮箱不能为空" ]
    } ],
    "created" : "此次请求新建成功了0条数据",
    "warnings" : [ {
      "code" : "P103",
      "messages" : [ "职位编码P103不存在，现将其设置为空", "职位编码P103不存在，现将其设置为空" ]
    } ],
    "dbErrors" : [ ],
    "updated" : "此次请求更新成功了2条数据"
  }
}

results matching ""

    No results matching ""