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

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

alibaba.mozi.vds.organization.page (分页搜索组织)

分页搜索组织

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
req PageSearchOrganizationRequest 必须 入参
  • └ return_total_size
  • Boolean
  • 可选
  • true
  • 是否返回总条数
  • └ ancestor_organization_codes
  • String []
  • 可选
  • []
  • 没有设置则在租户内全局搜索
  • └ keywords
  • String
  • 可选
  • node11
  • 搜索关键字,包括组织code、名称等
  • └ page_size
  • Number
  • 可选
  • 10
  • 每页条数
  • └ need_base_properties
  • Boolean
  • 可选
  • true
  • 是否显示基本属性
  • └ need_supervisor
  • Boolean
  • 可选
  • true
  • 是否显示高级管理层
  • └ page_no
  • Number
  • 可选
  • 1
  • 页码
  • └ tenant_id
  • Number
  • 必须
  • 10000035003
  • 租户id
  • └ status
  • String
  • 可选
  • A
  • 组织状态

响应参数

名称 类型 示例值 描述
result PageSearchOrganizationResult 出参
  • └ total_size
  • Number
  • 总条数
  • data_list
  • Organization []
  • 组织列表
  • └ organization_code
  • String
  • 组织code
  • └ organization_name
  • String
  • 组织name
  • └ source
  • String
  • 组织来源
  • └ status
  • String
  • 状态
  • base_properties
  • OrganizationBaseProperties
  • 基本属性
  • └ full_name
  • String
  • 全路径
  • └ short_name
  • String
  • 简称
  • └ alias
  • String
  • 别名
  • org_type
  • Label
  • 组织类型
  • └ code
  • String
  • 类型code
  • └ name
  • String
  • 类型name
  • └ effective_time
  • Date
  • 生效时间
  • └ invalid_time
  • Date
  • 失效时间
  • supervisors
  • Employee []
  • 高级管理人员
  • └ employee_code
  • String
  • 员工code
  • └ employee_name
  • String
  • 员工name
  • └ status
  • String
  • 状态
  • base_properties
  • EmployeeBaseProperties
  • 基本属性
  • └ avatar
  • String
  • 头像
  • └ employee_number
  • String
  • employeeNumber
  • └ nick_name
  • String
  • 昵称
  • └ email
  • String
  • 邮件
  • └ cell_phone_area_code
  • String
  • 手机区号
  • └ cell_phone
  • String
  • 手机号码
  • employee_type
  • Label
  • 员工类型
  • └ code
  • String
  • 类型code
  • └ name
  • String
  • 类型name
  • organization
  • Label
  • 组织
  • └ code
  • String
  • 组织code
  • └ name
  • String
  • 组织name
  • job
  • Label
  • 职业
  • └ name
  • String
  • 职业name
  • └ code
  • String
  • 职业code
  • job_level
  • Label
  • 职业级别
  • └ code
  • String
  • 级别code
  • └ name
  • String
  • 级别name
  • └ enrollment_time
  • Date
  • 注册时间
  • └ resignation_time
  • Date
  • 离职时间
  • └ certificate_type
  • String
  • 证件类型
  • └ certificate_code
  • String
  • 证件code
  • company
  • Label
  • 公司
  • └ code
  • String
  • 公司code
  • └ name
  • String
  • 公司name
  • └ effective_time
  • Date
  • 生效时间
  • └ invalid_time
  • Date
  • 失效时间
  • └ source
  • String
  • 来源
  • └ default_type_code
  • String
  • 默认类型code
  • └ parent_code
  • String
  • 父组织code
  • └ display_order
  • Number
  • 展示序号
  • └ 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);
AlibabaMoziVdsOrganizationPageRequest req = new AlibabaMoziVdsOrganizationPageRequest();
AlibabaMoziVdsOrganizationPageRequest.PageSearchOrganizationRequest obj1 = new AlibabaMoziVdsOrganizationPageRequest.PageSearchOrganizationRequest();
obj1.setReturnTotalSize(true);
obj1.setAncestorOrganizationCodes("");
obj1.setKeywords("node11");
obj1.setPageSize(10L);
obj1.setNeedBaseProperties(true);
obj1.setNeedSupervisor(true);
obj1.setPageNo(1L);
obj1.setTenantId(10000035003L);
obj1.setStatus("A");
req.setReq(obj1);
AlibabaMoziVdsOrganizationPageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mozi_vds_organization_page_response>
    <result>
        <total_size></total_size>
        <data_list>
            <organization>
                <organization_code></organization_code>
                <organization_name></organization_name>
                <source></source>
                <status></status>
                <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>
                        <status></status>
                        <base_properties>
                            <avatar></avatar>
                            <employee_number></employee_number>
                            <nick_name></nick_name>
                            <email></email>
                            <cell_phone_area_code></cell_phone_area_code>
                            <cell_phone></cell_phone>
                            <employee_type>
                                <code></code>
                                <name></name>
                            </employee_type>
                            <organization>
                                <code></code>
                                <name></name>
                            </organization>
                            <job>
                                <name></name>
                                <code></code>
                            </job>
                            <job_level>
                                <code></code>
                                <name></name>
                            </job_level>
                            <enrollment_time></enrollment_time>
                            <resignation_time></resignation_time>
                            <certificate_type></certificate_type>
                            <certificate_code></certificate_code>
                            <company>
                                <code></code>
                                <name></name>
                            </company>
                            <effective_time></effective_time>
                            <invalid_time></invalid_time>
                        </base_properties>
                        <source></source>
                    </employee>
                </supervisors>
                <default_type_code></default_type_code>
                <parent_code></parent_code>
                <display_order></display_order>
            </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_page_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

返回
顶部