第三方组织机构同步

一、准备工作

• 通过中台获取到企业的code，例如高新区：hitech
• 需要使用中台生成的后端工程，暂不支持外部项目调用

二、maven依赖

在pom.xml 添加依赖，pai.version版本需要>=1.7.2

<dependency>
    <groupId>cn.flyrise</groupId>
    <artifactId>pai-common-user-center</artifactId>
    <version>${pai.version}</version>
</dependency>

三、代码示例

场景：调用创建用户信息的接口

    @Resource
    private IPaiOrgSyncService paiOrgSyncService;

    @ApiOperation("创建用户")
    @PostMapping
    public Reply createUser(@RequestBody AddStaffRequest request,@RequestParam String code) {

        return Reply.success(this.paiOrgSyncService.addStaff(request,code, SecurityConstants.FROM_IN));
    }

四、API描述

• IPaiOrgSyncService 目前拥有添加部门信息、更新部门信息、查看部门信息、删除部门信息、获取企业的所有部门信息、添加员工信息、更新员工信息、查看员工信息、删除员工信息、员工离职、获取全部的员工、清空企业同步数据 12个Api。

4.1、添加部门信息

代码示例：

this.paiOrgSyncService.addStaff(request,code, SecurityConstants.FROM_IN)

参数解析：

request参数解析：

返回参数：

{
    "annex": {},
    "code": "200",
    "data": {
        "deptId": "",
        "deptName": "",
        "orderNum": 0,
        "parentId": "",
        "sourceIdentifier": "",
        "sourceParentId": "",
        "status": 0
    },
    "msg": "",
    "success": true,
    "time": 0
}

4.2、更新部门信息

代码示例：

this.paiOrgSyncService.updateDept(request,code, SecurityConstants.FROM_IN)

参数解析：

request参数解析：

返回参数：

{
    "annex": {},
    "code": "200",
    "data": {
        "deptId": "",
        "deptName": "",
        "orderNum": 0,
        "parentId": "",
        "sourceIdentifier": "",
        "sourceParentId": "",
        "status": 0
    },
    "msg": "",
    "success": true,
    "time": 0
}

4.3、查看部门信息

代码示例：

this.paiOrgSyncService.viewDept(sourceIdentifier,code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "200",
    "data": {
        "deptId": "",
        "deptName": "",
        "orderNum": 0,
        "parentId": "",
        "sourceIdentifier": "",
        "sourceParentId": "",
        "status": 0
    },
    "msg": "",
    "success": true,
    "time": 0
}

4.4、删除部门信息

代码示例：

this.paiOrgSyncService.delDept(sourceIdentifier,code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "200",
    "data": true,
    "msg": "",
    "success": true,
    "time": 0
}

4.5、获取全部的部门

代码示例：

this.paiOrgSyncService.getAllDepartment(code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": [
        {
            "deptId": "",
            "deptName": "",
            "orderNum": 0,
            "parentId": "",
            "sourceIdentifier": "",
            "sourceParentId": "",
            "status": 0
        }
    ],
    "msg": "",
    "success": true,
    "time": 0
}

4.6、添加员工

代码示例：

this.paiOrgSyncService.addStaff(request,code, SecurityConstants.FROM_IN)

参数解析：

request参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": {
        "sourceDeptId": "",
        "sourceIdentifier": "",
        "staffEmail": "",
        "staffHiredate": "",
        "staffId": "",
        "staffName": "",
        "staffNo": "",
        "staffPhone": "",
        "staffSex": 0,
        "staffStatus": 0,
        "staffUsId": ""
    },
    "msg": "",
    "success": true,
    "time": 0
}

返回参数解析：

sourceDeptId 部门唯一标识，企业内唯一
sourceIdentifier 来源id，企业内唯一
staffEmail 邮箱
staffHiredate 入职日期
staffId 员工信息id
staffName 员工名称
staffNo 员工编号
staffPhone 手机号码
staffSex 性别(0女、1男、2未知)
staffStatus 状态(0未激活 1已激活 2停用)
staffUsId 用户id

4.7、更新员工信息

代码示例：

this.paiOrgSyncService.updateStaff(request,code, SecurityConstants.FROM_IN)

参数解析：

request参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": {
        "sourceDeptId": "",
        "sourceIdentifier": "",
        "staffEmail": "",
        "staffHiredate": "",
        "staffId": "",
        "staffName": "",
        "staffNo": "",
        "staffPhone": "",
        "staffSex": 0,
        "staffStatus": 0,
        "staffUsId": ""
    },
    "msg": "",
    "success": true,
    "time": 0
}

返回参数解析：

sourceDeptId 部门唯一标识，企业内唯一
sourceIdentifier 来源id，企业内唯一
staffEmail 邮箱
staffHiredate 入职日期
staffId 员工信息id
staffName 员工名称
staffNo 员工编号
staffPhone 手机号码
staffSex 性别(0女、1男、2未知)
staffStatus 状态(0未激活 1已激活 2停用)
staffUsId 用户id

4.8、查看员工信息

代码示例：

this.paiOrgSyncService.viewStaff(sourceIdentifier,code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": {
        "sourceDeptId": "",
        "sourceIdentifier": "",
        "staffEmail": "",
        "staffHiredate": "",
        "staffId": "",
        "staffName": "",
        "staffNo": "",
        "staffPhone": "",
        "staffSex": 0,
        "staffStatus": 0,
        "staffUsId": ""
    },
    "msg": "",
    "success": true,
    "time": 0
}

返回参数解析：

sourceDeptId 部门唯一标识，企业内唯一
sourceIdentifier 来源id，企业内唯一
staffEmail 邮箱
staffHiredate 入职日期
staffId 员工信息id
staffName 员工名称
staffNo 员工编号
staffPhone 手机号码
staffSex 性别(0女、1男、2未知)
staffStatus 状态(0未激活 1已激活 2停用)
staffUsId 用户id

4.9、员工离职

描述：
只有离职的才能删除

代码示例：

this.paiOrgSyncService.departureStaff(sourceIdentifier,code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": true,
    "msg": "",
    "success": true,
    "time": 0
}

4.10、删除员工信息

描述：
只有离职的才能删除

代码示例：

this.paiOrgSyncService.delStaff(sourceIdentifier,code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": true,
    "msg": "",
    "success": true,
    "time": 0
}

4.11、获取全部的员工

代码示例：

this.paiOrgSyncService.getAllStaff(code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": [
        {
            "sourceDeptId": "",
            "sourceIdentifier": "",
            "staffEmail": "",
            "staffHiredate": "",
            "staffId": "",
            "staffName": "",
            "staffNo": "",
            "staffPhone": "",
            "staffSex": 0,
            "staffStatus": 0,
            "staffUsId": ""
        }
    ],
    "msg": "",
    "success": true,
    "time": 0
}

返回参数解析：

sourceDeptId 部门唯一标识，企业内唯一
sourceIdentifier 来源id，企业内唯一
staffEmail 邮箱
staffHiredate 入职日期
staffId 员工信息id
staffName 员工名称
staffNo 员工编号
staffPhone 手机号码
staffSex 性别(0女、1男、2未知)
staffStatus 状态(0未激活 1已激活 2停用)
staffUsId 用户id

4.12、清空企业同步数据

代码示例：

this.paiOrgSyncService.cleanData(code, SecurityConstants.FROM_IN)

参数解析：

返回参数：

{
    "annex": {},
    "code": "",
    "data": true,
    "msg": "",
    "success": true,
    "time": 0
}