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

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

alibaba.mozi.vds.employees.page (根据租户ID分页查询租户下的所有人员)

根据租户ID分页查询租户下的所有人员

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
req PageEmployeesRequest 必须 入参
  • └ return_total_size
  • Boolean
  • 可选
  • true
  • 是否返回总条数
  • └ page_size
  • Number
  • 可选
  • 10
  • 每页大小
  • └ need_base_properties
  • Boolean
  • 可选
  • true
  • 是否查询基础属性值
  • └ page_no
  • Number
  • 可选
  • 1
  • 页码
  • └ tenant_id
  • Number
  • 必须
  • 10000035003
  • 租户id
  • └ status
  • String
  • 可选
  • A
  • 用户状态

响应参数

名称 类型 示例值 描述
result PageEmployeesResult 结果
  • └ total_size
  • Number
  • 总条数
  • data_list
  • Employee []
  • 数据
  • └ employee_code
  • String
  • 员工code
  • └ employee_name
  • String
  • employeeName
  • └ status
  • String
  • 状态
  • base_properties
  • EmployeeBaseProperties
  • 基本信息
  • └ avatar
  • String
  • 头像
  • └ employee_number
  • String
  • employeeNumber
  • └ nick_name
  • String
  • 昵称
  • └ email
  • String
  • 电子邮箱
  • └ cell_phone_area_code
  • String
  • 手机区号
  • └ cell_phone
  • String
  • 手机号
  • └ certificate_type
  • String
  • 证件类型
  • employee_type
  • Label
  • 员工类型
  • └ name
  • String
  • 类型name
  • └ code
  • String
  • 类型code
  • organization
  • Label
  • 组织
  • └ code
  • String
  • 组织code
  • └ name
  • String
  • 组织name
  • job
  • Label
  • 职业
  • └ code
  • String
  • 职业code
  • └ name
  • String
  • 职业name
  • job_level
  • Label
  • 职级
  • └ code
  • String
  • 职级code
  • └ name
  • String
  • 职级name
  • supervisor
  • Employee
  • 上级
  • └ employee_code
  • String
  • 员工code
  • └ employee_name
  • String
  • 员工name
  • └ enrollment_time
  • Date
  • 注册时间
  • └ resignation_time
  • Date
  • 辞职时间
  • └ effective_time
  • Date
  • 生效时间
  • └ invalid_time
  • Date
  • 失效时间
  • company
  • Label
  • 公司
  • └ code
  • String
  • 公司code
  • └ name
  • String
  • 公司name
  • └ source
  • String
  • 来源
  • └ 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);
AlibabaMoziVdsEmployeesPageRequest req = new AlibabaMoziVdsEmployeesPageRequest();
AlibabaMoziVdsEmployeesPageRequest.PageEmployeesRequest obj1 = new AlibabaMoziVdsEmployeesPageRequest.PageEmployeesRequest();
obj1.setReturnTotalSize(true);
obj1.setPageSize(10L);
obj1.setNeedBaseProperties(true);
obj1.setPageNo(1L);
obj1.setTenantId(10000035003L);
obj1.setStatus("A");
req.setReq(obj1);
AlibabaMoziVdsEmployeesPageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_mozi_vds_employees_page_response>
    <result>
        <total_size></total_size>
        <data_list>
            <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>
                    <certificate_type></certificate_type>
                    <employee_type>
                        <name></name>
                        <code></code>
                    </employee_type>
                    <organization>
                        <code></code>
                        <name></name>
                    </organization>
                    <job>
                        <code></code>
                        <name></name>
                    </job>
                    <job_level>
                        <code></code>
                        <name></name>
                    </job_level>
                    <supervisor>
                        <employee_code></employee_code>
                        <employee_name></employee_name>
                    </supervisor>
                    <enrollment_time></enrollment_time>
                    <resignation_time></resignation_time>
                    <effective_time></effective_time>
                    <invalid_time></invalid_time>
                    <company>
                        <code></code>
                        <name></name>
                    </company>
                </base_properties>
                <source></source>
            </employee>
        </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_employees_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

返回
顶部