批量操作通讯录数据
基地址:baseAddress
说明:
- 0.4.2版本提供以下批量操作的接口
- 编码存在则修改,不存在则新增
- 批量操作会把所有传入的数据返回出来,根据返回的syncMessageCode判断这条数据是否成功
批量操作部门
请求方式:
post
请求地址
baseAddress/hipspfm/hippius/v1/sync/dept/batchOperate?access_token=ACCESS_TOKEN
参数:
[{
"parentUnitCode": "00001",
"unitCode": "00003",
"unitName": "财务部",
"orderSeq":"2",
"_tls":{
"unitName":{
"zh_CN":"财务部",
"en_US":"Finance Department"
}
}
}
]
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
parentUnitCode | 否 | 父部门编码, 如果没有默认新增根部门(如果是修改就修改起父部门) |
unitCode | 是 | 部门编码,唯一不可重复,全大写及数字,必须以字母、数字开头,可包含“-”、“_”、“.”、“/” |
unitName | 是 | 部门名称 |
orderSeq | 是 | 父部门内的排序,int类型 |
_tls | 否 | 部门名称多语言(根据系统中维护的语言操作,默认只有中文和英文) |
zh_CN | 否 | 中文 |
en_US | 否 | 英文 |
返回结果:
-- 成功:
{
"code": "success",
"data": [
{
"_tls": {
"unitName": {
"zh_CN": "财务部门",
"en_US": "007caiwu"
}
},
"unitCode": "111201",
"unitName": "财务部门",
"orderSeq": 1,
"parentUnitCode": "007YF",
"syncStatus": "success",
"syncMessage": "成功"
},
{
"_tls": {
"unitName": {
"zh_CN": "零零七人事部",
"en_US": "007renshi"
}
},
"unitCode": "007RS@",
"unitName": "零零七人事部",
"orderSeq": 1,
"parentUnitCode": "111201",
"syncStatus": "failed",
"syncMessage": "编码不正确",
"syncMessageCode": "error.code_not_right"
}
],
"failed": false,
"message": "成功"
}
参数说明:
参数 | 说明 |
---|---|
failed | 结果,true:调用失败,false:调用成功 |
code | 返回码 |
message | 返回码的文本描述 |
syncStatus | 状态, 失败:failed 成功:success |
syncMessageCode | 错误编码 |
syncMessage | 描述 |
新增岗位
请求方式:
post
请求地址
baseAddress/hipspfm/hippius/v1/sync/position/batchOperate?access_token=ACCESS_TOKEN
参数:
[{
"positionCode": "FIN0001",
"positionName":"财务总监",
"unitCode":"00003",
"orderSeq":"1",
"_tls":{
"positionName":{
"zh_CN":"财务总监",
"en_US":"CFO"
}
}
}
]
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
positionCode | 是 | 岗位编码,唯一不可重复,全大写及数字,必须以字母、数字开头,可包含“-”、“_”、“.”、“/” |
positionName | 是 | 岗位名称(中文) |
unitCode | 是 | 部门编码 |
orderSeq | 是 | 岗位顺序,数字 |
_tls | 否 | 多语言(根据系统多语言决定) |
zh_CN | 否 | 中文 |
en_US | 否 | 英文 |
返回结果:
-- 成功:
{
"code": "success",
"data": [
{
"objectVersionNumber": null,
"_tls": {
"positionName": {
"zh_CN": "会计",
"en_US": "kj"
}
},
"positionId": null,
"unitCompanyId": null,
"unitId": null,
"parentPositionId": null,
"positionCode": "KUAIJI0001",
"positionName": "会计",
"description": null,
"orderSeq": 1,
"supervisorFlag": null,
"enabledFlag": null,
"unitCode": "111201",
"parentPositionCode": null,
"syncStatus": "success",
"syncMessage": "成功",
"syncMessageCode": "",
"name": "会计"
},
{
"objectVersionNumber": null,
"_tls": {
"positionName": {
"zh_CN": "出纳员",
"en_US": "CHY"
}
},
"positionId": null,
"unitCompanyId": null,
"unitId": null,
"parentPositionId": null,
"positionCode": "CN0002",
"positionName": "出纳员",
"description": null,
"orderSeq": 1,
"supervisorFlag": null,
"enabledFlag": null,
"unitCode": "111201",
"parentPositionCode": null,
"syncStatus": "success",
"syncMessage": "成功",
"syncMessageCode": "",
"name": "出纳员"
}
],
"failed": false,
"message": "成功"
}
参数说明:
参数 | 说明 |
---|---|
failed | 结果,true:调用失败,false:调用成功 |
code | 返回码 |
message | 返回码的文本描述 |
syncStatus | 状态, 失败:failed 成功:success |
syncMessageCode | 错误编码 |
syncMessage | 描述 |
新增/编辑员工
说明:0.4.1开始 propertyName
改成 propertyKey
请求方式:
post
请求地址
baseAddress/hipspfm/hippius/v1/sync/employee/batchOperate?access_token=ACCESS_TOKEN
参数:
[{
"name":"海马汇",
"nameEn":"hipius",
"employeeNum":"hips001",
"mobile":"",
"email":"",
"gender":"1",
"status":"ON",
"ldapFlag":0,
"password":"",
"imageUrl":"",
"enabledFlag":"1",
"list":[
{
"positionCode":"FIN0001",
"primaryPositionFlag":"1"
},{
"positionCode":"HR0001",
"primaryPositionFlag":"0"
}
],
"propertyInfoDTOS":[
{
"propertyKey":"address",
"infoName":"北京",
"_tls":{
"infoName":{
"zh_CN":"北京",
"en_US":"beijing"
}
}
}
]
}
]
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
name | 是 | 姓名 |
nameEn | 否 | 英文姓名 |
employeeNum | 是 | 员工编码,唯一不可重复,大小写及数字,必须以字母、数字开头,可包含“-”、“_”、“.”、“/” |
mobile | 否 | 手机号码 |
否 | 邮箱 | |
gender | 是 | 性别,1表示男性, 0表示女性 |
status | 是 | 员工状态 在职:ON,试用:TRIAL,实习:INTERNSHIP,离职:LEAVE |
ldapFlag | 否 | 是否是ldap用户 0表示否,1表示是 |
password | 否 | 密码(使用生成账号模式时候的密码,没有则默认) |
imageUrl | 否 | 头像地址(自动生成用户的时候) |
enabledFlag | 否 | 是否有效,0表示禁用 ,1表示启用 |
list | 是 | 部门和岗位集合 如下表list |
propertyInfoDTOS | 否 | 额外字段属性值,如下表propertyInfoDTOS,参考通讯录个性化配置 |
list:
参数 | 必须 | 说明 |
---|---|---|
positionCode | 是 | 岗位编码 |
primaryPositionFlag | 是 | 是否主岗,0表示非主岗,1表示主岗位,而且list集合中有且只能有一个主岗位 |
propertyInfoDTOS:
参数 | 必须 | 说明 |
---|---|---|
propertyKey | 是 | 字段编码,来自通讯录个性化配置(0.4.1增加) |
infoName | 是 | 员工对应的值 |
_tls | 否 | 多语言 |
zh_CN | 否 | 中文 |
en_US | 否 | 英文 |
返回结果:
-- 成功:
{
"code": "success",
"data": [
{
"name":"海马汇",
"nameEn":"hipius",
"employeeNum":"hips001",
"mobile":"",
"email":"",
"gender":"1",
"status":"ON",
"ldapFlag":0,
"password":"",
"imageUrl":"",
"enabledFlag":"1",
"list":[
{
"positionCode":"FIN0001",
"primaryPositionFlag":"1"
},{
"positionCode":"HR0001",
"primaryPositionFlag":"0"
}
],
"propertyInfoDTOS":[
{
"propertyKey":"address",
"infoName":"北京",
"_tls":{
"infoName":{
"zh_CN":"北京",
"en_US":"beijing"
}
}
}
]
"syncStatus": "success",
"syncMessage": "成功",
"syncMessageCode": ""
}
],
"failed": false,
"message": "成功"
}
参数说明:
参数 | 说明 |
---|---|
failed | 结果,true:调用失败,false:调用成功 |
code | 返回码 |
message | 返回码的文本描述 |
syncStatus | 状态, 失败:failed 成功:success |
syncMessageCode | 错误编码 |
syncMessage | 描述 |