智慧服务,成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 企业管理员管理 分页查询企业管理员

入门使用

分页查询企业管理员

更新时间:2019-11-20

描述

通过该接口分页查询企业管理员。

接口原型

表1 接口原型

请求方法

POST

请求地址

/rest/usg/datacenter/v1/corp/admin/search

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

String

Header

授权令牌。将执行鉴权响应的accessToken进行Base64转码操作

样例:Basic Base64(accessToken)

condition

String

Body

查询条件。

长度:0-255。

sortField

String

Body

排序字段。用于根据特定字段对搜索结果排序。

当前支持按照用户通讯录排序等级排序。

长度:0-255。

isAsc

Boolean

Body

排序方式是否为升序排序。

默认值:true

pageIndex

Integer

Body

页面起始页。

默认值:1

pageSize

Integer

Body

页面大小。

默认值:10

范围:1-1000。

响应参数

表3 参数说明

参数

类型

描述

returnCode

String

业务返回码。

returnDesc

String

返回描述。

achievementTime

String

响应产生时间。

requestId

String

请求唯一标识。

data

QueryAdminPage

分页查询企业管理员信息。

表4 QueryAdminPage参数说明

参数

类型

描述

pageIndex

Integer

页面起始页。

pageSize

Integer

页面大小。

totalCount

Integer

总数量。

data

QueryAdminResultDTO[0..*]

查询企业管理员返回的结果。

表5 QueryAdminResultDTO参数说明

参数

类型

描述

id

String

页面起始页。

account

String

页面大小。

name

String

总数量。

adminType

Integer

管理员类型。

0:默认管理员

1:普通管理员

3:运营管理员

4:运维管理员,只有上级才能创建默认管理员。

email

String

邮箱。

phone

String

手机号。

country

String

手机号所属的国家

menuTemplateId

String

菜单模板id(预留接口)。

menuTemplateName

String

菜单模板名称(预留接口)。

dept

DeptBasicDTO

部门基本信息。

表6 DeptBasicDTO参数说明

参数

类型

描述

deptCode

String

部门编码。

corpId

String

企业ID。

deptName

String

部门名称。

deptNamePath

String

部门名称路径。

parentDeptCode

String

父部门编码。

请求消息示例

POST /rest/usg/datacenter/v1/corp/admin/search
Connection: keep-alive
Authorization: Basic dVZ5cDdBZG5xdzNlOWRqVUo1ckMyZFptaDZDSzhPYWlQ
content-type: application/json
user-agent: WeLink-desktop
Content-Length: 40
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "pageIndex": 1,
    "pageSize": 5
}
 

响应消息示例

HTTP/1.1 200 
Date: Fri, 12 Apr 2019 07:09:51 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: efd3e53b2d9fa554d11267d5d66ca0bf

{
    "returnCode": "000000000",
    "returnMessage": "Success",
    "achievementTime": "2019-04-12 07:09:51.673",
    "requestId": "bddf2f51e75986ad2ab6d9650ff108aa",
    "data": {
        "pageIndex": 1,
        "totalCount": 2,
        "pageSize": 5,
        "data": [{
            "id": "ff80808169e79714016a0f59faf30088",
            "account": "user001",
            "name": "user001",
            "adminType": 1,
            "email": "user001@huawei.com",
            "phone": "+86133********",
            "country": "chinaPR",
            "menuTemplateId": "2",
            "menuTemplateName": "2",
            "dept": {
                "deptCode": "1",
                "corpId": "30574",
                "deptName": "test001",
                "deptNamePath": "test001",
                "parentDeptCode": null
            }
        },
        {
            "id": "ff80808169e79714016a0b6bf0d9005d",
            "account": "test002@corpnew",
            "name": "test002",
            "adminType": 0,
            "email": "test002@huawei.com",
            "phone": "+86133********",
            "country": "chinaPR",
            "menuTemplateId": null,
            "menuTemplateName": null,
            "dept": {
                "deptCode": "1",
                "corpId": "30574",
                "deptName": "test001",
                "deptNamePath": "test001",
                "parentDeptCode": null
            }
        }]
    }
}
 

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'Authorization: Basic VUVwVU82SWFISU0ySWlKaEdoRllRUXk0MUZnbk00Mkpk' -d '{"pageIndex": 1,"pageSize": 5}' https://api.meeting.huaweicloud.com/rest/usg/datacenter/v1/corp/admin/search