同步通讯录数据

同步部门员工数据

基地址：baseAddress

说明：

1. hippius-platform0.3.3和hippius-all0.3.2开始

2. 修改员工不会同时修改用户信息

3. 岗位/部门/员工新增接口， 如果编码已经存在则修改，不存在则新增

4. 修改部门/岗位/员工编码规则

5. 增加多语言数据维护

6. 去除删除功能，增加禁用功能

7. 0.4.1开始提供接口：员工禁用/启用，以及所有标签接口

新增/修改部门

请求方式：

post

请求地址 > baseAddress/hipspfm/hippius/v1/sync/dept/create?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",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.code_repeat",
    "message": "编码重复"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

修改部门

请求方式： > put

请求地址 > baseAddress/hipspfm/hippius/v1/sync/dept/update?access_token=ACCESS_TOKEN

参数：

{
    "unitCode": "00003",
    "unitName": "财务部",
    "parentUnitCode": "00001",
    "orderSeq":"2",
    "_tls":{
            "unitName":{
                "zh_CN":"财务部",     
                "en_US":"Finance Department"    
            }
        }
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
unitCode	是	部门编码
unitName	是	部门名称
parentUnitCode	否	不为空则修改父部门
orderSeq	否	父部门中的次序值。order值大的排序靠前，数字类型
_tls	否	部门名称多语言（根据系统中维护的语言操作，默认只有中文和英文）
zh_CN	否	中文
en_US	否	英文

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.dept_not_exists",
    "message": "部门不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

删除部门

请求方式： > delete

请求地址 > baseAddress/hipspfm/hippius/v1/sync/dept/delete?access_token=ACCESS_TOKEN

参数：

{
    "unitCode": "00003"
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
unitCode	是	部门编码

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.dept_not_exists",
    "message": "部门不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

禁用部门

请求方式：

Put

请求地址：

baseAddress/hipspfm/hippius/v1/sync/dept/disabled?access_token=ACCESS_TOKEN

参数：

{
  "unitCode": "00003"
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
unitCode	是	部门编码

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.dept_not_exists",
    "message": "部门不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

启用部门

请求方式：

Put

请求地址：

baseAddress/hipspfm/hippius/v1/sync/dept/enabled?access_token=ACCESS_TOKEN

参数：

{
  "unitCode": "00003"
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
unitCode	是	部门编码

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.dept_not_exists",
    "message": "部门不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

新增/修改岗位

请求方式： > post

请求地址 > baseAddress/hipspfm/hippius/v1/sync/position/create?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",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.data_invalid",
    "message": "数据校验不通过",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

编辑岗位

请求方式： > put

请求地址 > baseAddress/hipspfm/hippius/v1/sync/position/update?access_token=ACCESS_TOKEN

参数：

{
    "positionCode": "FIN0001",
    "positionName":"财务总监",
    "orderSeq":"2",
    "_tls":{
            "positionName":{
                "zh_CN":"财务总监",     
                "en_US":"CFO"    
            }
        }
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
positionCode	是	岗位编码
positionName	是	岗位名称
orderSeq	否	岗位顺序，数字
_tls	否	多语言
zh_CN	否	中文
en_US	否	英文

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.position_not_exists",
    "message": "岗位不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

禁用岗位

请求方式：

put

请求地址

baseAddress/hipspfm/hippius/v1/sync/position/disable?access_token=ACCESS_TOKEN

参数：

{
    "positionCode": "FIN0001"
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
positionCode	是	岗位编码

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.position_not_exists",
    "message": "岗位不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

启用岗位

请求方式：

put

请求地址

baseAddress/hipspfm/hippius/v1/sync/position/enable?access_token=ACCESS_TOKEN

参数：

{
    "positionCode": "FIN0001"
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
positionCode	是	岗位编码

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.position_not_exists",
    "message": "岗位不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

新增/编辑员工

说明：0.4.1开始 propertyName 改成 propertyKey

请求方式：

post

请求地址 > baseAddress/hipspfm/hippius/v1/sync/employee/create?access_token=ACCESS_TOKEN

参数：

{
    "name":"海马汇",
    "nameEn":"hipius",
    "employeeNum":"hips001",
    "mobile":"",
    "email":"",
    "gender":"1",
    "status":"ON",
    "ldapFlag":0,
    "password":"",
    "imageUrl":""
    "list":[
    	{
    		"unitCode":"00003",
    		"positionCode":"FIN0001",
    		"primaryPositionFlag":"1"
    	},{
    		"unitCode":"00002",
    		"positionCode":"HR0001",
    		"primaryPositionFlag":"0"
    	}
    	],
     "propertyInfoDTOS":[
     	{
     		"propertyKey":"address",
     		"infoName":"北京",
     	"_tls":{
     		"infoName":{
                "zh_CN":"北京",     
                "en_US":"beijing"    
            }
     	   }
     	}
     	]
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
name	是	姓名
nameEn	否	英文姓名
employeeNum	是	员工编码，唯一不可重复，大小写及数字，必须以字母、数字开头，可包含“-”、“_”、“.”、“/”
mobile	否	手机号码
email	否	邮箱
gender	是	性别，1表示男性， 0表示女性
status	是	员工状态 在职:ON，试用:TRIAL，实习:INTERNSHIP，离职:LEAVE
ldapFlag	否	是否是ldap用户 0表示否，1表示是
password	否	密码（使用生成账号模式时候的密码，没有则默认）
imageUrl	否	头像地址
list	是	部门和岗位集合 如下表list
propertyInfoDTOS	否	额外字段属性值，如下表propertyInfoDTOS，参考通讯录个性化配置

list：

参数	必须	说明
unitCode	是	部门编码，0.4.2开始不需要提供
positionCode	是	岗位编码
primaryPositionFlag	是	是否主岗，0表示非主岗，1表示主岗位，而且list集合中有且只能有一个主岗位

propertyInfoDTOS：

参数	必须	说明
propertyKey	是	字段编码，来自通讯录个性化配置
infoName	是	员工对应的值
_tls	否	多语言
zh_CN	否	中文
en_US	否	英文

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.code_repeat",
    "message": "编码重复",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

编辑员工

说明：0.4.1不在提供此接口

请求方式：

put

请求地址 > baseAddress/hipspfm/hippius/v1/sync/employee/update?access_token=ACCESS_TOKEN

参数：

{
    "name":"海马汇",
    "nameEn":"hippius",
    "employeeNum":"HIPS001",
    "mobile":"",
    "email":"",
    "gender":"1",
    "status":"ON",
    "list":[
    	{
    		"unitCode":"00003",
    		"positionCode":"FIN0001",
    		"primaryPositionFlag":"1"
    	}
    	],
     "propertyInfoDTOS":[
     	{
     		"propertyName":"地址",
     		"infoName":"北京",
     	"_tls":{
     		"infoName":{
                "zh_CN":"北京",     
                "en_US":"beijing"    
            }
     	   }
     	}
     	]
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
name	否	姓名
nameEn	否	英文姓名
employeeNum	是	员工编码
mobile	否	手机号码
email	否	邮箱
gender	否	性别，1表示男性， 0表示女性
status	否	员工状态 在职:ON，试用:TRIAL，实习:INTERNSHIP，离职:LEAVE
list	否	部门和岗位集合,如果有值就会替换已有岗位和部门 字段如下表list
propertyInfoDTOS	否	额外字段属性值，如下表propertyInfoDTOS，参考通讯录个性化配置

list：

参数	必须	说明
unitCode	是	部门编码，0.4.2开始不需要提供
positionCode	是	岗位编码
primaryPositionFlag	是	是否主岗，0表示非主岗，1表示主岗位，而且list集合中有且只能有一个主岗位

propertyInfoDTOS：

参数	必须	说明
propertyName	是	字段名
infoName	是	员工对应的值
_tls	否	多语言
zh_CN	否	中文
en_US	否	英文

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.code_repeat",
    "message": "编码重复",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

禁用员工

请求方式：

put

请求地址

baseAddress/hipspfm/hippius/v1/sync/employee/disabled?access_token=ACCESS_TOKEN

参数：

{
    "employeeNum":"ABC1021"
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
employeeNum	是	员工编码

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.data_not_exists",
    "message": "数据不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

启用员工

请求方式：

put

请求地址

baseAddress/hipspfm/hippius/v1/sync/employee/enabled?access_token=ACCESS_TOKEN

参数：

{
    "employeeNum":"ABC1021"
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
employeeNum	是	员工编码

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.data_not_exists",
    "message": "数据不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

新增/修改标签

请求方式：

post

请求地址

baseAddress/hipspfm/hippius/v1/sync/tag/createOrUpdate?access_token=ACCESS_TOKEN

参数：

{
   "tagId": 23,
    "tagName": "移动海马汇",
    "tagStatus":"unlock",
    "loginName":"sync1",
    "_tls":{
            "tagName":{
                "zh_CN":"海马汇",     
                "en_US":"hippius"    
            }
        }
}

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
tagId	否	标签ID，如果存在则更新，没有就会新建
tagName	是	标签名称
tagStatus	是	标签状态：unlock, lock (lock的标签只有所属人才能修改)
loginName	否	标签所属人，不写则默认所有人都可以操作
_tls	否	多语言
tagName	否	标签名字
zh_CN	否	中文
en_US	否	英文

返回结果：

-- 成功：
{
    {
    "_tls": {
        "tagName": {
            "zh_CN": "海马汇",
            "en_US": "hippius"
        }
    },
    "tagId": 23,
    "tagName": "移动海马汇",
    "tagStatus": "unlock",
    "tagOwner": 128,
    "tenantId": 105,
    "loginName": "sync1"
}
}

--- 失败
{
    "failed": true,
    "code": "error.user_not_exists",
    "message": "用户不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

删除标签

请求方式：

delete

请求地址

baseAddress/hipspfm/hippius/v1/sync/tag/delete?access_token=ACCESS_TOKEN&tagId=22

参数：

参考url地址

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
tagId	是	标签ID

返回结果：

-- 成功：
{
    "code": "success",
    "failed": false,
    "message": "成功"
}

--- 失败
{
    "failed": true,
    "code": "error.data_not_exists",
    "message": "数据不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

获取所有标签

请求方式：

get

请求地址

baseAddress/hipspfm/hippius/v1/sync/tag/list?access_token=ACCESS_TOKEN

参数：

参考url地址

参数说明：

参数	必须	说明
access_token	是	调用接口凭证

返回结果：

-- 成功：
[
    {
        "objectVersionNumber": 1,
        "tagId": 23,
        "tagName": "海马汇",
        "tagStatus": "unlock",
        "tagOwner": 128,
        "tenantId": 105,
        "ownerName": "sync1",
        "loginName": "sync1"
    }
]

参数说明：

参数	说明
tagId	标签ID
tagName	标签名称
tagStatus	标签状态
tagOwner	标签所属人ID
tenantId	租户
ownerName	标签所属人姓名
loginName	标签所属人账号

获取单个标签详情

请求方式：

get

请求地址

baseAddress/hipspfm/hippius/v1/sync/tag/detail?access_token=ACCESS_TOKEN&tagId=23

参数：

参考url地址

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
tagId	是	标签ID

返回结果：

-- 成功：
    {
        "objectVersionNumber": 1,
        "tagId": 23,
        "tagName": "海马汇",
        "tagStatus": "unlock",
        "tagOwner": 128,
        "tenantId": 105,
        "ownerName": "sync1",
        "loginName": "sync1"
    }

参数说明：

参数	说明
tagId	标签ID
tagName	标签名称
tagStatus	标签状态
tagOwner	标签所属人ID
tenantId	租户
ownerName	标签所属人姓名
loginName	标签所属人账号

添加标签成员（批量）

请求方式：

post

请求地址

baseAddress/hipspfm/hippius/v1/sync/tagMember/insert?access_token=ACCESS_TOKEN

参数：

[{
	"tagId": "23",
	"memberCode": "007COMPANY",
	"memberType": "dept"
}, {
	"tagId": "23",
	"memberCode": "ABC1021.",
	"memberType": "staff"
},{
	"tagId": "230",
	"memberCode": "ABC1021.",
	"memberType": "staff"
}


]

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
tagId	是	标签ID
memberCode	是	成员编码（部门编码，员工编码）
memberType	是	类型：staff(员工)，dept(部门)

返回结果：

-- 成功：
    {
    "code": "success",
    "failed": false,
    "message": "成功"
}

-- 失败
{
    "failed": true,
    "code": "error.data_not_exists",
    "message": "数据不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

删除标签成员(批量)

请求方式：

delete

请求地址

baseAddress/hipspfm/hippius/v1/sync/tagMember/delete?access_token=ACCESS_TOKEN

参数：

[{
	"tagId": "23",
	"memberCode": "007COMPANY",
	"memberType": "dept"
}, {
	"tagId": "23",
	"memberCode": "ABC1021.",
	"memberType": "staff"
},{
	"tagId": "230",
	"memberCode": "ABC1021.",
	"memberType": "staff"
}


]

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
tagId	是	标签ID
memberCode	是	成员编码（部门编码，员工编码）
memberType	是	类型：staff(员工)，dept(部门)

返回结果：

-- 成功：
    {
    "code": "success",
    "failed": false,
    "message": "成功"
}

-- 失败
{
    "failed": true,
    "code": "error.data_not_exists",
    "message": "数据不存在",
    "type": "warn"
}

参数说明：

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述

标签成员列表

请求方式：

get

请求地址

baseAddress/hipspfm/hippius/v1/sync/tagMember/list/{tagId}?access_token=ACCESS_TOKEN&page=0&size=2

例如：baseAddress/hipspfm/hippius/v1/sync/tagMember/list/23?access_token=ACCESS_TOKEN&page=0&size=2

参数：

参考url地址

参数说明：

参数	必须	说明
access_token	是	调用接口凭证
tagId	是	标签ID
page	是	成员编码（部门编码，员工编码）
size	是	一页返回条数

返回结果：

-- 成功：
   {
    "totalPages": 1,
    "totalElements": 2,
    "numberOfElements": 2,
    "size": 2,
    "number": 0,
    "content": [
        {
            "tagMemberId": 28,
            "tagId": 23,
            "memberId": 89,
            "memberType": "staff",
            "memberName": "孙大圣",
            "unitNamePath": "零零七公司>零零七研发部",
            "tenantId": null,
            "memberUnitId": 45,
            "levelPath": "007COMPANY|007YF",
            "memberCode": "ABC1021."
        },
        {
            "tagMemberId": 27,
            "tagId": 23,
            "memberId": 44,
            "memberType": "dept",
            "memberName": "零零七公司",
            "unitNamePath": "零零七公司",
            "tenantId": null,
            "memberUnitId": 44,
            "memberCode": "007COMPANY"
        }
    ],
    "empty": false
}

-- 失败
{
    "failed": true,
    "code": "error.data_not_exists",
    "message": "数据不存在",
    "type": "warn"
}

参数说明：

参数	说明
tagId	标签ID
tagMemberId	标签成员ID
tagStatus	标签状态
tagOwner	类型：dept/staff
memberName	成员名字
unitNamePath	所属主部门的名称路径
memberUnitId	成员所属主部门ID
memberCode	成员所属部门编码

参数	说明
failed	结果，true:调用失败，false:调用成功
code	返回码
message	返回码的文本描述