注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > MOZI 租户

alibaba.mozi.vds.organization.pagebytype (根据组织属性获取组织列表)

根据组织属性获取组织列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
req PageOrganizationsByTypeRequest 必须 入参
  • └ return_total_size
  • Boolean
  • 可选
  • true
  • 是否返回总条数
  • └ page_size
  • Number
  • 可选
  • 10
  • 每页条数
  • └ need_base_properties
  • Boolean
  • 可选
  • true
  • 是否需要基本属性
  • └ need_supervisor
  • Boolean
  • 可选
  • true
  • 是否需要管理层信息
  • └ org_type
  • String
  • 必须
  • orgType
  • 组织类型
  • └ page_no
  • Number
  • 可选
  • 1
  • 页码
  • └ tenant_id
  • Number
  • 必须
  • 10000035003
  • 租户id
  • └ status
  • String
  • 可选
  • A
  • 组织状态

响应参数

名称 类型 示例值 描述
result PageOrganizationsByTypeResult 出参
  • └ total_size
  • Number
  • 总条数
  • data_list
  • Organization []
  • 组织列表
  • └ organization_code
  • String
  • 组织code
  • └ organization_name
  • String
  • 组织name
  • └ display_order
  • Number
  • 显示顺序
  • └ parent_code
  • String
  • 父code
  • └ default_type_code
  • String
  • 默认类型code
  • └ status
  • String
  • 状态
  • └ source
  • String
  • 来源
  • base_properties
  • OrganizationBaseProperties
  • 基本属性
  • └ full_name
  • String
  • 全名称
  • └ short_name
  • String
  • 短名称
  • └ alias
  • String
  • 别名
  • org_type
  • Label
  • 组织type
  • └ code
  • String
  • code
  • └ name
  • String
  • name
  • └ effective_time
  • Date
  • 生效时间
  • └ invalid_time
  • Date
  • 失效时间
  • supervisors
  • Employee []
  • 组织管理层员工列表
  • └ employee_code
  • String
  • 员工code
  • └ employee_name
  • String
  • 员工name
  • └ success
  • Boolean
  • 是否成功
  • └ request_id
  • String
  • 请求id
  • └ page_size
  • Number
  • 每页条数
  • └ current_page
  • Number
  • 当前页
  • └ response_message
  • String
  • 返回消息
  • └ response_code
  • String
  • 返回码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMoziVdsOrganizationPagebytypeRequest req = new AlibabaMoziVdsOrganizationPagebytypeRequest();
AlibabaMoziVdsOrganizationPagebytypeRequest.PageOrganizationsByTypeRequest obj1 = new AlibabaMoziVdsOrganizationPagebytypeRequest.PageOrganizationsByTypeRequest();
obj1.setReturnTotalSize(true);
obj1.setPageSize(10L);
obj1.setNeedBaseProperties(true);
obj1.setNeedSupervisor(true);
obj1.setOrgType("orgType");
obj1.setPageNo(1L);
obj1.setTenantId(10000035003L);
obj1.setStatus("A");
req.setReq(obj1);
AlibabaMoziVdsOrganizationPagebytypeResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mozi_vds_organization_pagebytype_response>
    <result>
        <total_size></total_size>
        <data_list>
            <organization>
                <organization_code></organization_code>
                <organization_name></organization_name>
                <display_order></display_order>
                <parent_code></parent_code>
                <default_type_code></default_type_code>
                <status></status>
                <source></source>
                <base_properties>
                    <full_name></full_name>
                    <short_name></short_name>
                    <alias></alias>
                    <org_type>
                        <code></code>
                        <name></name>
                    </org_type>
                    <effective_time></effective_time>
                    <invalid_time></invalid_time>
                </base_properties>
                <supervisors>
                    <employee>
                        <employee_code></employee_code>
                        <employee_name></employee_name>
                    </employee>
                </supervisors>
            </organization>
        </data_list>
        <success></success>
        <request_id></request_id>
        <page_size></page_size>
        <current_page></current_page>
        <response_message></response_message>
        <response_code></response_code>
    </result>
</alibaba_mozi_vds_organization_pagebytype_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部