程序包 net.risesoft.api.platform.org

接口 OrganizationApi

  • @Validated
public interface OrganizationApi
    机构服务组件
    从以下版本开始:
    9.6.0
    作者:
    dingzhaojun, qinman, mengjuhua
    Date:
    2022/2/10

    • 方法概要

      所有方法 实例方法 抽象方法 
      修饰符和类型 方法 说明
      net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Organization> get​(@NotBlank String tenantId, @NotBlank String organizationId)
      根据id获得组织机构对象
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Organization>> list​(@NotBlank String tenantId)
      根据租户id获取组织机构列表（不包含禁用）
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listAllBureaus​(@NotBlank String tenantId, @NotBlank String organizationId)
      获取机构的委办局列表（不包含禁用）
      net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Organization>> listByType​(@NotBlank String tenantId, Boolean virtual)
      根据类型获取组织机构列表（不包含禁用）

    • 方法详细资料

      • get

        @GetMapping("/get")
net.risesoft.pojo.Y9Result<net.risesoft.model.platform.Organization> get​(@RequestParam("tenantId") @NotBlank
                                                                         @NotBlank String tenantId,
                                                                         @RequestParam("organizationId") @NotBlank
                                                                         @NotBlank String organizationId)
        根据id获得组织机构对象
        参数:
        tenantId - 租户id
        organizationId - 组织机构唯一标识
        返回:
        Y9Result<Organization> 通用请求返回对象 - data 是组织机构对象
        从以下版本开始:
        9.6.0

      • list

        @GetMapping("/list")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Organization>> list​(@RequestParam("tenantId") @NotBlank
                                                                                @NotBlank String tenantId)
        根据租户id获取组织机构列表（不包含禁用）
        参数:
        tenantId - 租户id
        返回:
        Y9Result<List<Organization>> 通用请求返回对象 - data 是组织机构对象集合
        从以下版本开始:
        9.6.0

      • listAllBureaus

        @GetMapping("/listAllBureaus")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Department>> listAllBureaus​(@RequestParam("tenantId") @NotBlank
                                                                                        @NotBlank String tenantId,
                                                                                        @RequestParam("organizationId") @NotBlank
                                                                                        @NotBlank String organizationId)
        获取机构的委办局列表（不包含禁用）
        参数:
        tenantId - 租户id
        organizationId - 组织机构id
        返回:
        Y9Result<List<Department>> 通用请求返回对象 - data 是部门对象集合
        从以下版本开始:
        9.6.0

      • listByType

        @GetMapping("/listByType")
net.risesoft.pojo.Y9Result<List<net.risesoft.model.platform.Organization>> listByType​(@RequestParam("tenantId") @NotBlank
                                                                                      @NotBlank String tenantId,
                                                                                      @RequestParam("virtual")
                                                                                      Boolean virtual)
        根据类型获取组织机构列表（不包含禁用）
        参数:
        tenantId - 租户id
        virtual - 是否虚拟组织
        返回:
        Y9Result<List<Organization>> 通用请求返回对象 - data 是组织机构对象集合
        从以下版本开始:
        9.6.0