ATS用户中心
所有文章
系统应用
升级公告
常见问题
公开课
校招专栏
内推和门店
数据平台
亮点功能
热门活动
基础操作视频
API文档
时间字段格式说明(Date)
API开发指南(Guide)
主动推送说明(Webhooks)
公共API
招聘官网API
企业信息API
门店API
组织架构API
职责API
招聘需求 API
候选人API
人才库API
职位API
面试API
Offer API
入职API
内推账户API
猎头API
BI报表API
district code
错误码
同步人事信息
最后更新于 2024/04/03   阅读数 117

Moka 系统中会根据请求的列表对当前系统中的人员进行同步(新增,更新,标记删除)。每次同步最多100条。 同步以用户的邮箱、工号、手机号任意一个为主键,与系统中用户的邮箱、工号、手机号任意一个进行对比: 1、当前系统没有,同步时有:新增一个用户 2、当前系统有,同步时也有:更新已经存在的用户信息。如果同步时有,当前系统职责状态标识为删除,更新后,状态改为正常。

HTTP 请求

POST https://api.mokahr.com/api-platform/v2/users/syncInfo

请求body参数

字段

必填

类型

描述

usersInfo

array

用户信息数组

usersInfo[].email

否/uniqueType为email时必填

string

邮箱

usersInfo[].name

string

姓名

usersInfo[].phone

否/uniqueType为phone时必填

string

电话

usersInfo[].number

否/uniqueType为number时必填

string

工号

usersInfo[].roleId

否/首次创建用户必填

int

自定义角色id

usersInfo[].departmentCode

array

部门编号列表,通过组织架构同步进来的departmentCode,如果传空数组,则判断为所有部门。

usersInfo[].superiorEmail

string

上级邮箱,传空字符串会清空moka系统中的汇报关系,可以通过设置updateSuperiorEmail 参数,选择是否更新汇报关系

usersInfo[].deactivated

int

是否禁用/初次创建用户传1,则用户不会创建成功
0-不禁用 1-禁用

usersInfo[].thirdPartyId

string

功能性字段 用作单点登录 没有传空字符串

usersInfo[].uniqueType

string

email或者number或者phone,判断此次传输时用来判断账号唯一性的标识

usersInfo[].updateDepartment

boolean

!!!注意:不传默认是true
是否更新部门
true:更新
false:不更新

usersInfo[].updateSuperiorEmail

boolean

是否更新上级汇报人,true更新false不更新

usersInfo[].autoActivated

int

0-不自动激活,1-自动激活,传空字符串默认为0

usersInfo[].locale

string

用户语言:zh-CN为中文,不传默认为中文;en-US为English

返回json

返回body的JSON数据如下:

字段

类型

描述

code

number

响应码,非200代表失败

msg

string

响应信息

data

object

返回数据

data.successCount

number

同步成功数据数量。例:"successCount": 1, // 成功了一条数据

data.errorList

Array

同步失败的数据。

data.errorList[].code

int

响应码

data.errorList[].msg

string

该条数据失败的原因

data.errorList[].data

object

数据信息

data.errorList[].data.email

string

邮箱

data.errorList[].data.name

string

姓名

data.errorList[].data.phone

string

电话

data.errorList[].data.number

string

工号

data.errorList[].data.roleId

int

自定义角色id

data.errorList[].data.locale

string

用户语言: zh-CN为中文,不传默认为中文 en-US为English

data.errorList[].data.departmentCode

array

部门编号列表,通过组织架构同步进来的departmentCode,如果传空数组,则判断为所有部门。

data.errorList[].data.superiorEmail

string

上级邮箱

data.errorList[].data.deactivated

int

是否禁用/初次创建用户传1,则用户不会创建成功 0-不禁用 1-禁用

data.errorList[].data.thirdPartyId

string

功能性字段 用作单点登录 没有传空字符串

data.errorList[].data.uniqueType

string

email或者number或者phone,判断此次传输时用来判断账号唯一性的标识

请求样例 (JSON)

请求样例z

$ curl https://api.mokahr.com/api-platform/v2/users/syncInfo
    -u 'your-api-key:'
    -X POST
    -H 'Content-Type: application/json'
    -d '{ "usersInfo": [ { "email": "huohuohou2@mokahr.com", "name": "liu大哥89", "phone": "15101069886", "number": "6661889", "roleId": 60, "departmentCode": [], "superiorEmail": "", "deactivated": 0, "thirdPartyId": "", "uniqueType": "number", "autoActivated": 1, "locale": "zh-CN" } ] }'
1
2
3
4
5
plaintext

操作成功

{ "code": 200, "msg": "success", "data": { "successCount": 1, "errorList": [] } }
1
plaintext

操作失败

{ "code": -1, "msg": "success", "data": { "successCount": 0, "errorList": [ { "data": { "email": "huohuohou2@mokahr.com", "name": "liu大哥89", "phone": "15101069886", "number": "6661889", "roleId": 60, "departmentCode": [], "superiorEmail": "", "deactivated": 0, "thirdPartyId": "", "uniqueType": "number", "locale": "zh-CN" }, "msg": "参数错误: roleId", "code": -1 } ] } }
1
plaintext
未能解决您的问题?请联系
本篇目录

HTTP 请求

请求body参数

返回json

操作成功

操作失败