- 关于本文档
- API调用指南
- 服务端接口
- 一、鉴权管理
- 二、企业信息
- 三、业务数据
- 四、事件订阅
- 五、通用数据
- 六、其他
员工同步
测试环境
https://openapi-uat.z-trip.cn
测试环境
https://openapi-uat.z-trip.cn
POST
/tmc/v1/user/sync
功能描述:此接口用于同步企业的员工数据至在途系统中,此接口通过员工编号或邮箱来作为员工的唯一标识。
注意:调用此接口时,如果员工的状态值小于0,则只会更新状态字段,不会更新其他字段的数据。
入参数据量不能大于100条,大小不能超过10M
限流说明:同一时刻最多处理100个用户的同步(如果单次请求携带100个用户数据,则只能并发1个请求;如果单次请求携带1个用户数据,则最多并发100个请求),超过返回错误码:RATE_LIMITED
请求参数
Query 参数
access_token
string
必需
示例值:
{{openApiToken}}
Body 参数application/json
array of:
orgId
string
员工主属部门编码
empCode
string
必需
<= 30 字符
status
enum<string>
必需
<= 1 字符
枚举值:
1-10-99
fullname
string
姓名(全名)
<= 50 字符
gender
string
可选
<= 1 字符
title
string
职位/头衔名称
<= 50 字符
rank
string
在途职级编码
<= 50 字符
email
string
可选
<= 50 字符
mobile
string
可选
<= 11 字符
country
string
可选
<= 20 字符
lastName
string
英文姓
<= 50 字符
firstName
string
英文名
<= 50 字符
birthDay
string
可选
orgs
object
可选
orgId
string
组织单位编码
title
string
职位信息
<= 50 字符
orgExpand
string
可选
<= 30 字符
userCert
array [object {3}]
员工证件信息
idType
string
必需
"idType":"IDENTITY",
"idTypeName":"身份证"
},
{
"idType":"PASSPORT",
"idTypeName":"护照"
},
{
"idType":"SERVICE_PASSPORT",
"idTypeName":"因公护照"
},
{
"idType":"GANGAO",
"idTypeName":"港澳通行证"
},
{
"idType":"TAIWAN",
"idTypeName":"台湾通行证"
},
{
"idType":"JUNDUI",
"idTypeName":"军队证件"
},
{
"idType":"HAIYUAN",
"idTypeName":"海员证"
},
{
"idType":"TAIBAO",
"idTypeName":"台胞证"
},
{
"idType":"HUIXIANG",
"idTypeName":"回乡证"
}
idNumber
string
证件号码
validDate
string
可选
extend1
string
可选
corpCode
string
可选
在开启了法人信息来源于员工时数据方可同步到系统中
<= 50 字符
userExtension
object
可选
注意:不传该扩展信息为删除原来扩展信息
column1
string
扩展字段1
column2
string
扩展字段2
column3
string
扩展字段3
column4
string
扩展字段4
column5
string
扩展字段5
column6
string
扩展字段6
column7
string
扩展字段7
column8
string
扩展字段8
示例
[
{
"empCode": "DD101001010",
"fullname": "袁小文",
"gender": "0",
"orgId": "6EA6BAB719F9CAABF2E60EE377702E86",
"title": "经理",
"email": "yuanzw@grgtest.com",
"mobile": "13816199999",
"status": "1"
},
{
"empCode": "DD101001020",
"fullname": "陈晨",
"gender": "0",
"orgId": "6EA6BAB719F9CAABF2E60EE377702E86",
"title": "经理",
"status": "1"
}
]
返回响应
🟢200成功
application/json
Body
error
string
必需
示例值:
0
error_description
string
错误信息描述
示例值:
同步成功
data
string
返回的业务数据
示例
{
"error": "0",
"error_description": "同步成功",
"data": "string"
}