API文档

如果以下接口没有满足你的需求，你可以联系相关的开发人员并将你的需求进行反馈。
我们在确认可以为此给你提供接口之后，会尽快的更新哦。(●’◡’●)。

阅读须知(重点)：

内部接口，不需要通过传递token来校验身份，只需传内部调用凭证即可，你也可也理解为无需授权。

内部调用凭证：SecurityConstants.FROM_IN

实际上它是一个常量：

public static final String FROM_IN = "Y";

maven依赖

1.调用方法所需依赖：

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

调用方法示例

场景：调用获取用户信息的接口

普通接口(方法)调用:

第一步：在pom.xml文件中引入上述所说的依赖
第二步：在需要调用的地方，注入IUserService

第三步：调用对应的方法

内部接口(方法)调用：

接口描述

一、部门信息接口(IDeptService)

1. 获取部门信息

    /**
     * 获取部门信息
     *
     * @param deptId 部门id
     * @return
     */
Reply<DeptEntity> findById(@PathVariable("deptId") String deptId)

2.获取多个部门信息

    /**
     * 获取多个部门信息
     *
     * @param ids 部门id集合
     * @return
     */
Reply<List<DeptEntity>> findByIds(@RequestBody List<String> ids);

3.获取多个部门信息 - 免鉴权

   /**
     * 获取多个部门信息
     *
     * @param ids 部门id集合
     * @return
     */
Reply<List<DeptEntity>> findByIds(@RequestBody List<String> ids, @RequestHeader("from") String from);

4. 获取简单的部门信息(名称)

 /**
     * 获取简单的部门信息
     *
     * @param id 部门id
     * @return
     */
Reply<String> findSimpleById(@PathVariable("deptId") String id)

5.获取简单的部门信息 - 免鉴权

    /**
     * 获取简单的部门信息
     *
     * @param id 部门id
     * @param from 内部标识
     * @return
     */
Reply<DeptEntity> findSimpleById(@RequestParam("deptId") String id, @RequestHeader("from") String from);

6. 获取多个部门信息(Map<String, String>)

  /**
     * 获取多个部门信息 key(部门id)-value(部门名称)
     *
     * @param ids 部门id集合
     * @return
     */
Reply<Map<String, String>> findSimpleByIds(@RequestBody List<String> ids)

7. 获取组织机构树 - 免鉴权

/**
     * 获取组织机构树
     *
     * @param entId 企业id
     * @return
     */
Reply<List<TreeSelect>> deptTree(@PathVariable("entId") String entId,@RequestHeader("from") String from)

8. 获取部门负责人

 /**
     * 获取部门负责人
     *
     * @param deptId 部门id
     * @return
     */
Reply<ContactEntity> findLeaderByDeptId(@PathVariable("deptId") String deptId)

9. 获取部门分管领导

/**
     * 获取部门分管领导
     *
     * @param deptId 部门id
     * @return
     */
Reply<ContactEntity> findMinisterByDeptId(@PathVariable("deptId") String deptId)

10. 获取下属的组织机构

    /**
     * 获取下属的组织机构
     *
     * @param entId  企业id
     * @param deptId 部门id 为0获取最顶级的部门
     * @return
     */
Reply<DeptEntity> findById(@PathVariable("deptId") String deptId)

12. 获取下属的人员及组织机构

    /**
     * 获取下属的人员及组织机构
     *
     * @param entId     企业id
     * @param deptId    部门id
     * @param showLeave 是否显示离职
     * @return
     */
Reply<DeptEntity> findById(@PathVariable("deptId") String deptId)

13.添加部门

    /**
     * 添加部门
     *
     * @param request req
     * @param from    内部标识
     * @return
     */
Reply<DeptEntity> addDept(@RequestBody AddDeptRequest request, @RequestHeader("from") String from);

14.更新部门

    /**
     * 更新部门
     *
     * @param request req
     * @param from    内部标识
     * @return
     */
Reply<?> updateDept(@RequestBody EditDeptRequest request, @RequestHeader("from") String from);

15.删除部门

    /**
     * 删除部门
     *
     * @param id   主键id
     * @param from 内部标识
     * @return
     */
Reply<?> deleteDept(@PathVariable("id") String id, @RequestHeader("from") String from);

16. 通过部门ID集合获取对应部门的id、名称

    /**
     * 通过部门ID集合获取对应部门的id、名称
     *
     * @param deptIds 部门id列表
     * @param from    内部标识
     * @return id, name
     */ 
Reply<Map<String, String>> findDeptName(@RequestBody Collection<String> deptIds, @RequestHeader("from") String from);

二、企业信息接口(IEnterpriseService)

1. 获取企业信息

    /**
     * 获取企业信息
     *
     * @param entId 企业id
     * @return
     */
Reply<EnterpriseEntity> findById(@PathVariable("entId") String entId)

2. 获取多个企业信息

   /**
     * 获取多个企业信息
     *
     * @param ids 企业id集合
     * @return
     */
Reply<List<EnterpriseEntity>> findByIds(@RequestBody List<String> ids)

3. 获取简单企业信息(企业名称)

    /**
     * 获取简单企业信息
     *
     * @param entId 企业id
     * @return
     */
Reply<String> findSimpleById(@PathVariable("entId") String entId)

4. 获取多个简单企业信息

    /**
     * 获取多个简单企业信息 key(企业id)-value(企业名称)
     *
     * @param ids 企业id集合
     * @return
     */
Reply<Map<String,String>> findSimpleByIds(@RequestBody List<String> ids)

5. 获取我的企业列表

    /**
     * 获取我的企业列表
     *
     * @return
     */
Reply<List<EnterpriseEntity>> findMyEnterprises()

6. 获取企业信息-园区信息 (获取当前我的企业信息)

    /**
     * 获取企业信息-园区信息 (获取当前我的企业信息)
     *
     * @return
     */
Reply<EnterpriseEntity> findMyEnterprise();

7. 获取所有的入驻企业

    /**
     * 获取所有的入驻企业
     *
     * @param entId 企业id
     * @return
     */
Reply<List<ParkTenant>> findTenantEnterpriseByEntId(@RequestParam("entId") String entId)
    /**
     * 取所有的入驻企业
     *
     * @param parkId 园区id
     * @return
     */
Reply<ParkTenant> findTenantEnterpriseByParkId(@RequestParam("parkId") String parkId)

    /**
     * 获取所有的入驻企业Id
     *
     * @param entId  运营企业
     * @param search 搜索
     * @param from   内部标识
     * @return
     */
Reply<List<String>> findEntIdsByEntIdAndSearch(@RequestParam("entId") String entId,
                                                   @RequestParam("search") String search,
                                                   @RequestHeader("from") String from);


    /**
     * 获取所有的入驻企业Id
     *
     * @param entId  运营企业
     * @param search 搜索
     * @param from   内部标识
     * @return
     */
Reply<List<EnterpriseEntity>> findEntByEntIdAndSearch(@RequestParam("entId") String entId,
                                                          @RequestParam("search") String search,
                                                          @RequestHeader("from") String from);



    /**
     * 获取所有的入驻企业Id
     *
     * @param parkId 园区
     * @param search 搜索
     * @param from   内部标识
     * @return
     */
Reply<List<String>> findEntIdsByParkIdAndSearch(@RequestParam("parkId") String parkId,
                                                    @RequestParam("search") String search,
                                                    @RequestHeader("from") String from);



    /**
     * 获取所有的入驻企业Id
     *
     * @param parkId 园区id
     * @param search 搜索
     * @param from   内部标识
     * @return
     */
Reply<List<EnterpriseEntity>> findEntsByParkIdAndSearch(@RequestParam("parkId") String parkId,
                                                            @RequestParam("search") String search,
                                                            @RequestHeader("from") String from);

8.邀请入驻企业

    /**
     * 邀请入驻企业
     *
     * @param model 入驻企业信息
     * @param from  内部标识
     * @return
     */
Reply<InviteInEntResponse> inviteInEnt(@RequestBody InviteInEntModel model, @RequestHeader("from") String from);

9. 通过集团id获取所有的企业id

    /**
     * 通过集团id获取所有的企业id
     *
     * @param groupId 集团id
     * @param from    内部标识
     * @return
     */
    @GetMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/ent/group")
    Reply<List<String>> findEntIdsByGroupId(@RequestParam(name = "groupId") String groupId,
                                            @RequestHeader("from") String from);

10. 通过企业id获取所有的子企业

  /**
     * 通过企业id获取所有的子企业
     *
     * @param entId           企业id
     * @param isExcludeCurEnt isExcludeCurEnt 是否排除当前企业 默认true
     * @param from            内部标识
     * @return
     */
    @GetMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/ent/sub")
    Reply<List<EnterpriseEntity>> findSubEntByEntId(@RequestParam(name = "entId") String entId,
                                                    @RequestParam(name = "isExcludeCurEnt") Boolean isExcludeCurEnt,
                                                    @RequestHeader("from") String from);

11.通过企业id列表获取企业的id和名称 (去重、内部接口)

    /**
     * 通过企业id列表获取企业的id和名称 (去重、免鉴权)
     *
     * @param entIds 企业id列表
     * @param from   内部标识
     * @return
     */
Reply<Map<String, String>> findEntName(@RequestBody Collection<String> entIds,
                                           @RequestHeader("from") String from);

三、园区信息接口(IParkService)

1. 根据园区id获取园区信息

    /**
     * 根据园区id获取园区信息
     *
     * @param parkId 园区id
     * @return
     */
Reply<ParkModel> findParkById(@PathVariable("parkId") String parkId)

2. 根据园区id获取园区名称

    /**
     * 根据园区id获取园区名称
     *
     * @param parkId 园区id
     * @return
     */
Reply<String> findSimpleParkById(@PathVariable("parkId") String parkId);

3. 根据多个园区id获取多个园区信息

    /**
     * 根据多个园区id获取多个园区信息
     *
     * @param parkIds 园区id集合
     * @return
     */
Reply<List<ParkModel>> findParkByIds(@RequestBody List<String> parkIds)

4. 根据园区id获取园区信息 - 内部接口

    /**
     * 根据园区id获取园区信息-无鉴权
     *
     * @param parkId 园区id
     * @param from 内部调用凭证
     * @return
     */
Reply<ParkModel> findParkByIdNoAuth(@PathVariable String parkId, @RequestHeader("from") String from)

5.根据多个园区id获取多个园区信息 key(园区id)-value(园区名称)

    /**
     * 根据多个园区id获取多个园区信息 key(园区id)-value(园区名称)
     *
     * @param parkIds 园区id集合
     * @return
     */
Reply<Map<String, String>> findSimpleParkByIds(@RequestBody List<String> parkIds);

6. 根据多个园区id获取多个园区信息 - 内部接口

    /**
     * 根据多个园区id获取多个园区信息-无鉴权
     *
     * @param parkIds 园区id集合
     * @param from 内部调用凭证
     * @return
     */
Reply<List<ParkModel>> findParkByIdsNoAuth(@RequestBody List<String> parkIds, @RequestHeader("from") String from)

7. 获取多个简单的园区信息(Map<String, String>)

    /**
     * 根据多个园区id获取多个园区信息 key(园区id)-value(园区名称)
     *
     * @param parkIds 园区id集合
     * @return
     */
Reply<Map<String, String>> findSimpleParkByIds(@RequestBody List<String> parkIds)

8.模糊查询园区

    /**
     * 模糊查询园区
     *
     * @param entId  企业id
     * @param search 查询条件
     * @return
     */
Reply<List<ParkModel>> getParksByEntAndSearch(@PathVariable("entId") String entId,
                                                  @RequestParam("search") String search);

9.模糊查询园区 - 内部接口

    /**
     * 模糊查询园区
     *
     * @param search 查询条件
     * @parma from
     * @return
     */
Reply<List<String>> getParkIdsBySearch(@RequestParam("search") String search,
                                           @RequestHeader("from") String from);

10.模糊查询园区 - 内部接口

    /**
     * 模糊查询园区
     *
     * @param entId 运营企业id
     * @param search 查询条件
     * @parma from 内部标识
     * @return
     */
Reply<List<String>> getParkIdsByEndAndSearch(@PathVariable("entId") String entId,
                                                 @RequestParam("search") String search,
                                                 @RequestHeader("from") String from);

11.模糊查询园区 - 内部接口

    /**
     * 模糊查询园区
     *
     * @param entId  企业id
     * @param search 查询条件
     * @param from   内部标识
     * @return
     */
Reply<List<ParkModel>> getParksByEntAndSearchNoAuth(@PathVariable("entId") String entId,
                                                        @RequestParam("search") String search,
                                                        @RequestHeader("from") String from);

12. 通过企业id获取子企业管理的所有园区

    /**
     * 通过企业id获取子企业管理的所有园区
     *
     * @param entId           企业id
     * @param isExcludeCurEnt isExcludeCurEnt 是否排除当前企业 默认true
     * @param from            内部标识
     * @return
     */
    @GetMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/park/sub")
    Reply<List<ParkModel>> findParksBySubEnt(@RequestParam(name = "entId") String entId,
                                             @RequestParam(name = "isExcludeCurEnt") Boolean isExcludeCurEnt,
                                             @RequestHeader("from") String from);

13. 通过集团id获取所有的园区

    /**
     * 通过集团id获取所有的园区
     *
     * @param groupId 集团id
     * @param from    内部标识
     * @return
     */
    @GetMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/park/group")
    Reply<List<ParkModel>> findParksByGroupId(@RequestParam(name = "groupId") String groupId,
                                              @RequestHeader("from") String from);

14. 添加园区-需要是运营企业并且具备园区功能的账号

     /**
     * 添加园区
     *
     * @param request
     * @return Reply<ParkModel>
     * @author Y.zc
     * @date 2022/7/28
     * @since 1.9.0
     */
    @PostMapping(value = "/consolePark/v1/add")
    Reply<ParkModel> addPark(@Validated @RequestBody AddParkRequest request);

四、数据权限接口(IPermissionService)

1. 获取当前用户的数据权限

    /**
     * 获取当前用户的数据权限
     *
     * @param suiteCode 套件标识
     * @param tenantId  租户id
     * @return
     */
Reply<List<DataAccessPermissions>> getCurrentUserDataAccess(@RequestParam("suiteCode") String suiteCode, @RequestParam("tenantId") String tenantId)

2. 获取用户的数据权限-内部接口

    /**
     * 内部接口
     * 获取用户的数据权限
     *
     * @param suiteCode 套件标识
     * @param tenantId  租户id
     * @param staffId   员工id
     * @param from      内部调用凭证
     * @return
     */
Reply<List<DataAccessPermissions>> getStaffDataAccess(@RequestParam("suiteCode") String suiteCode,@RequestParam("tenantId") String tenantId, @RequestParam("staffId") String staffId, @RequestHeader("from") String from)

3. 查看用户拥有的套件的权限 - 内部接口

    /**
     * 内部接口
     * 查看用户拥有的套件的权限
     *
     * @param suiteCode 套件标识
     * @param uid       用户id
     * @param entId     企业id
     * @param from      内部调用凭证
     * @return
     */
Reply<RoleAndPermEntity> findAppPermsByCode(@RequestParam("suiteCode") String suiteCode, @RequestParam("uid") String uid,@RequestParam("entId") String entId, @RequestHeader("from") String from)

4.查看用户拥有的套件的权限 - 内部接口

    /**
     * 内部接口
     * 查看用户拥有的套件的权限
     *
     * @param uid   用户id
     * @param entId 企业id
     * @param from  内部调用凭证
     * @return
     */
Reply<RoleAndPermEntity> findAppPermsByEnt(@RequestParam("uid") String uid, @RequestParam("entId") String entId, @RequestHeader("from") String from);

5. 判断是否拥有应用权限 - 内部接口

    /**
     * 判断是否拥有应用权限
     *
     * @param entId      企业id
     * @param uid        用户id
     * @param permission 权限 {suiteCode}:{role}:{perm}
     * @param from       内部调用凭证
     * @return
     */
Reply<Boolean> hasAppPermission(@RequestParam(value = "entId") String entId, @RequestParam(value = "uid") String uid, @RequestParam("permission") String permission, @RequestHeader(SecurityConstants.FROM) String from)

6.获取角色配置

    /**
     * 获取角色配置
     *
     * @param suiteCode 套件标识
     * @param entId     企业id
     * @param from
     * @return
     */
Reply<List<RoleConfig>> findRoleByEntAndSuiteCode(@RequestParam("entId") String entId,
                                                     @RequestParam("suiteCode") String suiteCode,
                                                     @RequestHeader("from") String from);

7.获取角色配置

    /**
     * 获取角色配置
     * @param suiteCode 套件标识
     * @param entId     企业id
     * @param roleKey   角色标识
     * @param from
     * @return
     */
 Reply<RoleConfig> findRoleByEntAndSuiteCodeAndRoleKey(@RequestParam("entId") String entId,
                                                                @RequestParam("suiteCode") String suiteCode,
                                                                @RequestParam("roleKey") String roleKey,
                                                                @RequestHeader("from") String from);

五、岗位信息接口(IPostService)

1. 获取公司下的所有岗位

    /**
     * 获取公司下的所有岗位
     *
     * @param entId  企业id
     * @param enable 是否启用 true|false
     * @param page   页码
     * @param size   页数
     * @param search 搜索条件 （岗位名称）
     * @return
     */
Reply<?> findPostByEntId(@RequestParam("entId") String entId,@RequestParam(value = "enable", required = false) String enable,@RequestParam(value = "page", required = false) Integer page, @RequestParam(value = "size", required = false) Integer size,@RequestParam(value = "search", required = false) String search)

2. 根据岗位id获取岗位信息

    /**
     * 根据岗位id获取岗位信息
     *
     * @param postId 岗位id
     * @return
     */
Reply<PostEntity> findPostById(@PathVariable("postId") String postId)

3.根据多个岗位id获取多个岗位信息

    /**
     * 根据多个岗位id获取多个岗位信息
     *
     * @param postIds 岗位id集合
     * @return
     */
Reply<List<PostEntity>> findPostByIds(@RequestBody List<String> postIds);

4.根据岗位id获取岗位信息-内部接口

    /**
     * 根据岗位id获取岗位信息-无鉴权
     *
     * @param postId 岗位id
     * @param from   内部调用凭证
     * @return
     */
Reply<PostEntity> findPostByIdNoAuth(@PathVariable("postId") String postId, @RequestHeader("from") String from)

5. 根据多个岗位id获取多个岗位信息-内部接口

    /**
     * 根据多个岗位id获取多个岗位信息-无鉴权
     *
     * @param postIds 岗位id集合
     * @param from    内部调用凭证
     * @return
     */
Reply<List<PostEntity>> findPostByIdsNoAuth(@RequestBody List<String> postIds, @RequestHeader("from") String from)

6. 获取岗位名称

    /**
     * 获取岗位名称
     *
     * @param postId
     * @return
     */
Reply<String> findSimplePostById(@PathVariable("postId") String postId)

7. 获取简单的岗位信息(Map<String, String>)

    /**
     * 获取岗位信息 key(岗位id)-value(岗位名称)
     *
     * @param postIds
     * @return
     */
Reply<Map<String, String>> findSimplePostByIds(@RequestBody List<String> postIds)

8. 通过岗位id列表获取岗位的id、名称

    /**
     * 通过岗位id列表获取岗位的id、名称
     *
     * @param postIds 岗位id列表
     * @param from    内部标识
     * @return id, name
     */
    @ApiOperation("通过岗位id列表获取岗位的id、名称")
    @PostMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/post")
    Reply<Map<String, String>> findPostName(@RequestBody Collection<String> postIds,
                                            @RequestHeader(SecurityConstants.FROM) String from);

9.获取岗位下的员工

    /**
     * 获取岗位下的员工
     *
     * @param request req
     * @param from    内部标识
     * @return rep
     */
@ApiOperation("获取岗位下的员工")
Reply<List<StaffPostResponse>> getStaffByPost(@SpringQueryMap GetStaffByPostRequest request,
                                                  @RequestHeader(SecurityConstants.FROM) String from);

10.获取岗位下的员工-分页

    /**
     * 获取岗位下的员工-分页
     *
     * @param request req
     * @param from    内部标识
     * @return rep
     */
@ApiOperation("获取岗位下的员工-分页")
Reply<PageInfo<StaffPostResponse>> getStaffPageByPost(@SpringQueryMap GetStaffPageByPostRequest request,
                                                          @RequestHeader(SecurityConstants.FROM) String from);

11.通过岗位id列表获取岗位的id、名称

    /**
     * 通过岗位id列表获取岗位的id、名称
     *
     * @param postIds 岗位id列表
     * @param from    内部标识
     * @return id, name
     */
@ApiOperation("通过岗位id列表获取岗位的id、名称")
Reply<Map<String, String>> findPostName(@RequestBody Collection<String> postIds,
                                            @RequestHeader(SecurityConstants.FROM) String from);

六、员工信息接口(IStaffService)

1. 获取员工详情

    /**
     * 获取员工详情
     *
     * @param id 员工id
     * @return
     */
Reply<StaffEntity> findById(@PathVariable("id") String id)

2. 获取员工详情-内部接口

    /**
     * 获取员工详情-无鉴权
     *
     * @param id   员工id
     * @param from 内部调用凭证
     * @return
     */
Reply<StaffEntity> findByIdNoAuth(@PathVariable("id") String id, @RequestHeader("from") String from)

3. 通过多个员工id获取多个员工信息

    /**
     * 通过多个员工id获取多个员工信息
     *
     * @param ids 员工id集合
     * @return
     */
Reply<List<StaffEntity>> findStaffByIds(@RequestBody List<String> ids)

4. 通过多个员工id获取多个员工信息-内部接口

    /**
     * 通过多个员工id获取多个员工信息-无鉴权
     *
     * @param ids  员工id集合
     * @param from 内部调用凭证
     * @return
     */
Reply<List<StaffEntity>> findStaffByIdsNoAuth(@RequestBody List<String> ids, @RequestHeader("from") String from)

5. 获取员工部分信息

    /**
     * 获取员工部分信息
     *
     * @param id 员工id集合
     * @return
     */
Reply<SimpleStaffModel> findPartStaffById(@PathVariable("id") String id)

6. 通过多个员工id获取多个员工部分信息

    /**
     * 通过多个员工id获取多个员工部分信息
     *
     * @param ids 员工id集合
     * @return
     */
Reply<List<SimpleStaffModel>> findPartStaffByIds(@RequestBody List<String> ids)

7. 通过部门id获取部门的员工信息

    /**
     * 通过部门id获取部门的员工信息
     *
     * @param page   页码
     * @param size   页数
     * @param search 搜索条件 （邮箱|员工名称|员工编号|手机号）
     * @param deptId 部门id
     * @param status 状态(0未激活 1已激活 2停用 3离职)
     * @return
     */
Reply<PageInfo<StaffEntity>> findStaffByDeptId(@RequestParam(name = "page", required = false) Integer page,
                                                   @RequestParam(name = "size", required = false) Integer size,
                                                   @RequestParam(name = "search", required = false) String search,
                                                   @RequestParam(name = "deptId") String deptId,
                                                   @RequestParam(name = "status", required = false) String status
    )

8. 通过用户id、企业id查找对应的员工数据

    /**
     * 通过用户id、企业id查找对应的员工数据
     *
     * @param userId 用户id
     * @param entId  企业id
     * @return
     */
Reply<StaffEntity> findStaffByUser(@RequestParam("userId") String userId,
                                       @RequestParam("entId") String entId)

9. 通过用户id、企业id查找对应的员工数据-内部接口

    /**
     * 通过用户id、企业id查找对应的员工数据
     *
     * @param entId 企业id
     * @param uid   用户id
     * @param from  内部调用凭证
     * @return
     */
Reply<StaffEntity> findStaffByUserNoAuth(@RequestParam("entId") String entId,
                                             @RequestParam("uid") String uid,
                                             @RequestHeader("from") String from)

10. 获员工名称

    /**
     * 获取员工名称
     *
     * @param id 用户id
     * @return
     */
Reply<String> findSimpleStaffById(@PathVariable String id)

11. 获取简单的员工信息(Map<String, String>)

    /**
     * 获取简单的员工信息 key(员工id)-value(员工名称)
     *
     * @param ids 用户id集合
     * @return
     */
Reply<Map<String, String>> findSimpleStaffByIds(@RequestBody List<String> ids)

12. 通过企业id获取员工名称信息-支持模糊查询

    /**
     * 根据租户id模糊搜索员工名称 key员工id-value员工名称
     *
     * @param entId  企业id/租户id
     * @param search 搜索条件(员工名称)
     * @param status 员工状态(0未激活 1已激活 2停用 3离职),null为全部。
     * @return
     */
    Reply<Map<String, String>> findStaffByEntId(@RequestParam("entId") String entId,
                                                @RequestParam(value = "search", required = false) String search,
                                                @RequestParam(value = "status", required = false) String status)

13. 通过企业id获取员工名称信息-支持模糊查询(内部接口)

    /**
     * 模糊查询
     *
     * @param entId 企业id
     * @param name 名称
     * @param from 内部标识
     * @return
     */
Reply<List<String>> findStaffIdsByName(@RequestParam("entId") String entId,
                                           @RequestParam("name") String name,
                                           @RequestHeader("from") String from);

14. 通过园区标识获取已激活入驻企业的员工名称信息-支持模糊查询

    /**
     * 根据园区标识获取已激活入驻企业员工名称 key员工id-value员工名称
     *
     * @param parkCode 园区标识
     * @param search   搜索条件(员工名称)
     * @param status   员工状态(0未激活 1已激活 2停用 3离职),null为全部。
     * @return
     */
Reply<Map<String, String>> findStaffByParkCode(@RequestParam("parkCode") String parkCode,
                                                   @RequestParam(value = "search", required = false) String search,
                                                   @RequestParam(value = "status", required = false) String status)

15. 通过园区id获取已激活入驻企业的员工名称信息-支持模糊查询

    /**
     * 根据园区id获取已激活入驻企业员工名称 key员工id-value员工名称
     *
     * @param parkId 园区id
     * @param search 搜索条件(员工名称) 模糊搜索
     * @param status 员工状态(0未激活 1已激活 2停用 3离职),null为全部。
     * @return
     */
Reply<Map<String, String>> findStaffByParkId(@RequestParam("parkId") String parkId,
                                                 @RequestParam(value = "search", required = false) String search,
                                                 @RequestParam(value = "status", required = false) String status)

16.获取部门领导

    /**
     * 获取部门领导
     *
     * @param usId  用户id
     * @param entId 企业id
     * @param from  内部标识
     * @return {user:StaffEntity,leader:StaffEntity}
     */
Reply<JSONObject> findLeaderByUserAndEnt(@PathVariable("usId") String usId, @PathVariable("entId") String entId,@RequestHeader("from") String from);

17. 通过部门查找对应的员工数据

    /**
     * 通过部门查找对应的员工数据
     *
     * @param entId    企业id
     * @param deptId   部门id
     * @param allChild 是否所有子部门
     * @param search   查询条件
     * @param from     内部标识
     * @return
     */
Reply<List<StaffEntity>> getStaffByDeptId(@RequestParam("entId") String entId,
                                              @RequestParam("deptId") String deptId,
                                              @RequestParam("allChild") Boolean allChild,
                                              @RequestParam("search") String search,
                                              @RequestHeader(SecurityConstants.FROM) String from);

18.通过用户id查找对应的员工数据

    /**
     * 通过用户id查找对应的员工数据
     *
     * @param userId 用户id
     * @return
     */
Reply<List<StaffEntity>> findStaffByUser(@RequestParam("userId") String userId);

19. 通过用户id查找对应的员工数据 - 内部接口

    /**
     * 通过用户id查找对应的员工数据
     *
     * @param userId 用户id
     * @param from   内部标识
     * @return
     */
Reply<List<StaffEntity>> findStaffByUserNoAuth(@RequestParam("userId") String userId, @RequestHeader("from") String from);

20. 根据部门id获取部门下面的员工数据

    /**
     * 根据部门id获取部门下面的员工数据
     *
     * @param entId    企业id
     * @param deptId   部门id
     * @param allChild 是否包含子部门
     * @param status   员工状态(0未激活 1已激活 2停用 3离职),不填为全部。
     * @param from     内部标识
     * @return 部门id - id,name
     */
    @PostMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/staff/dept")
    Reply<Map<String, Map<String, String>>> findStaffByDept(@RequestParam(name = "entId") String entId,
                                                            @RequestParam(name = "deptId") String deptId,
                                                            @RequestParam(name = "allChild") Boolean allChild,
                                                            @RequestParam(name = "status", required = false) Integer status,
                                                            @RequestHeader("from") String from);

21. 通过公司/部门/岗位 的ID集合获取下面的员工的id、名称

    /**
     * 通过公司/部门/岗位 的ID集合获取下面的员工的id、名称
     *
     * @param ids       主键id列表
     * @param queryType 0：公司 1：部门 2：岗位
     * @param status    员工状态(0未激活 1已激活 2停用 3离职),不填为全部。
     * @param from      内部标识
     * @return 业务id - id,name
     */
    @PostMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/staff/type")
    Reply<Map<String, Map<String, String>>> findStaffName(@RequestBody Collection<String> ids,
                                                          @RequestParam(name = "queryType") Integer queryType,
                                                          @RequestParam(name = "status", required = false) Integer status,
                                                          @RequestHeader("from") String from);

22. 通过员工id列表获取员工的id、名称

    /**
     * 通过员工id列表获取员工的id、名称
     *
     * @param staffIds 员工id列表
     * @param from     内部标识
     * @return id, name
     */
    @PostMapping("${api.service.console.path:}/user/center/${api.service.console.version:v1}/staff")
    Reply<Map<String, String>> findStaffNameByIds(@RequestBody Collection<String> staffIds,
                                                  @RequestHeader("from") String from);

七、用户信息接口(IUserService)

1. 通过用户id获取用户信息

    /**
     * 通过用户id获取用户信息
     *
     * @param id 用户id
     * @return
     */
Reply<UserEntity> findUserById(@PathVariable("id") String id)

2. 通过用户id获取用户信息-内部接口

    /**
     * 通过用户id获取用户信息-无鉴权
     *
     * @param id   用户id
     * @param from 内部调用凭证
     * @return
     */
Reply<UserEntity> findUserByIdNoAuth(@PathVariable("id") String id, @RequestHeader("from") String from)

3. 通过多个用户id获取多个用户信息

    /**
     * 通过多个用户id获取多个用户信息
     *
     * @param ids 用户id集合
     * @return
     */
Reply<List<UserEntity>> findUserByIds(@RequestBody List<String> ids)

4. 通过多个用户id获取多个用户信息-内部接口

    /**
     * 通过多个用户id获取多个用户信息-无鉴权
     *
     * @param ids  用户id集合
     * @param from 内部调用凭证
     * @return
     */
Reply<List<UserEntity>> findUserByIdsNoAuth(@RequestBody List<String> ids, @RequestHeader("from") String from);

5. 获取当前登录用户的基本信息

    /**
     * 当前登录用户的基本信息
     *
     * @return
     */
Reply<UserEntity> findMyInfo()

6. 根据用户id和企业entId获取用户权限

    /**
     * 根据用户id和企业entId获取用户权限
     *
     * @param userId 用户id
     * @param entId  企业id
     * @return
     */
Reply<RoleAndPermEntity> findUserPermByEntId(@RequestParam("userId") String userId,
                                                 @RequestParam("entId") String entId
    )

7. 获取简单的用户信息

    /**
     * 获取简单的用户信息
     *
     * @param id 用户id
     * @return
     */
Reply<SimpleUserModel> findSimpleUserById(@PathVariable("id") String id)

8. 获取简单的用户信息（多个）

    /**
     * 获取简单的用户信息（多个）
     *
     * @param ids 用户id集合
     * @return
     */
Reply<List<SimpleUserModel>> findSimpleUserByIds(@RequestBody List<String> ids)

9. 根据用户id集合获取用户名

    /**
     * 根据用户id集合获取用户名
     * @param ids 用户id集合
     * @return
     */
Reply<Map<String, String>> getUsernames(@RequestBody List<String> ids)

10. 根据用户id集合获取用户昵称

   /**
     * 根据用户id集合获取用户昵称
     * @param ids 用户id集合
     * @return
     */
Reply<Map<String, String>> getNickNames(@RequestBody List<String> ids)

11. 获取用户信息 Map<String, UserEntity>

    /**
     * 获取用户信息 Map<String, UserEntity>
     * @param ids 用户id集合
     * @return
     */
Reply<Map<String, UserEntity>> getUserMapEntity(@RequestBody List<String> ids)

12.根据用户手机号获取用户简单的信息

    /**
     * 根据用户手机号获取用户简单的信息
     *
     * @param phone 手机号
     * @return
     */
Reply<UserEntity> findUserByPhone(@RequestParam("phone") String phone)

13.获取企业的用户的Id集合

    /**
     * 获取企业的用户的Id列表
     *
     * @param entId 企业id
     * @return
     */
Reply<List<String>> getUserIds(@RequestParam("entId") String entId);

14.根据企业id获取用户id集合(模糊查询)

    /**
     * 根据企业id获取用户id集合(模糊查询)
     *
     * @param entId  企业id
     * @param search 搜索条件(用户昵称)
     * @return
     */
Reply<List<String>> getUserIdsByEntId(@RequestParam("entId") String entId, @RequestParam(value = "search", required = false) String search)

15.根据用户昵称获取用户id集合(模糊查询)

    /**
     * 根据用户昵称获取用户id集合(模糊查询)
     *
     * @param nickName 用户昵称
     * @return
     */
Reply<List<String>> getUserIdsByNickName(@RequestParam("nickName") String nickName);

16.注册员工

    /**
     * 注册员工
     *
     * @param register 注册信息
     * @return
     */
Reply<StaffEntity> register(@RequestBody RegisterEntity register);

八、集团接口(IPaiGroupService)

目前拥有1个接口

1. 获取子公司列表

    /**
     * 获取子公司列表
     *
     * @return
     */
    Reply<List<EnterpriseEntity>> getSubsidiaryEntByUser();

2.获取子公司列表

    /**
     * 获取子公司列表
     * @param groupId 集团id
     * @return
     */
@ApiOperation("获取子公司列表")
Reply<List<EnterpriseEntity>> getSubsidiaryEnt(@RequestParam("groupId") String groupId);

3. 获取集团本部企业

    /**
     * 获取集团本部企业
     *
     * @return
     */
   Reply<EnterpriseEntity> getPart();

4. 获取集团组织树

    /**
     * 获取集团组织树
     * @param entId 当前企业id
     * @param type 1区域  0组织
     * @return
     */
   Reply<GroupTree> getTree(@RequestParam("entId") String entId,
                             @RequestParam(value = "type", defaultValue = "0") Integer type);

九、验证接口

目前拥有1个接口

接口描述

二次验证接口

API名称：二次验证接口
请求地址： https://pai.flyrise.cn/auth-api/oauth2/second/verify
请求类型：POST
请求参数：
请求格式：

# 名称 类型 是否必须 备注
1 code String true base64（密码）
2 type String true 密码 ：pwd

请求示例：

{
  "code": "MTIzNDU2",
  "type": "pwd"
}

回应结果：

{
  "code": "200",
  "data": {
    "success": true,
    "msg": null
  },
  "time": 1653534369871,
  "msg": "操作成功",
  "annex": null,
  "success": true
}

回应参数说明：

# 名称 类型 备注
1 success bool 成功、失败
2 msg String 错误会有信息
文档更新时间: 2023-05-20 23:32   作者：朱灿奕