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

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

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

分页搜索组

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
req PageSearchGroupRequest 必须 入参数
  • └ return_total_size
  • Boolean
  • 可选
  • true
  • 是否返回总条数
  • └ keywords
  • String
  • 可选
  • groupCode
  • 搜索关键字,支持组 Code、组名称
  • └ page_size
  • Number
  • 可选
  • 10
  • 每页大小
  • └ return_employee_count
  • Boolean
  • 可选
  • true
  • 是否返回员工总数
  • └ page_no
  • Number
  • 可选
  • 1
  • 页码
  • └ tenant_id
  • Number
  • 必须
  • 10000035003
  • 租户id

响应参数

名称 类型 示例值 描述
result PageSearchGroupResult 出参
  • └ total_size
  • Number
  • 总条数
  • data_list
  • Group []
  • 组列表
  • └ group_code
  • String
  • 组code
  • └ group_name
  • String
  • 组名称
  • └ group_description
  • String
  • 组描述
  • └ display_order
  • Number
  • 展示序号
  • └ parent_group_code
  • String
  • 父组code
  • └ employee_count
  • 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);
AlibabaMoziVdsGroupPageRequest req = new AlibabaMoziVdsGroupPageRequest();
AlibabaMoziVdsGroupPageRequest.PageSearchGroupRequest obj1 = new AlibabaMoziVdsGroupPageRequest.PageSearchGroupRequest();
obj1.setReturnTotalSize(true);
obj1.setKeywords("groupCode");
obj1.setPageSize(10L);
obj1.setReturnEmployeeCount(true);
obj1.setPageNo(1L);
obj1.setTenantId(10000035003L);
req.setReq(obj1);
AlibabaMoziVdsGroupPageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mozi_vds_group_page_response>
    <result>
        <total_size></total_size>
        <data_list>
            <group>
                <group_code></group_code>
                <group_name></group_name>
                <group_description></group_description>
                <display_order></display_order>
                <parent_group_code></parent_group_code>
                <employee_count></employee_count>
            </group>
        </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_group_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

返回
顶部