RetrieveHotspotDefAccessLists - Получить списки пользователей с учетом фильтрации("гибкий фильтр") и пагинации
Общая информация
-
Команда актуальна, начиная с версии 1.10.
Входные параметры
| Параметр | Значение | Формат значения | Расшифровка формата | Ссылка |
|---|---|---|---|---|
filter |
текст фильтра |
String |
||
domain |
домен для фильтрации |
String |
||
count |
количество возвращаемых записей |
Integer |
||
page |
номер страницы (пачки записей) |
Integer |
||
orderBy |
сортировать по этому полю |
String |
||
orderType |
тип сортировки (ASC|DESC) |
String |
Выходные параметры
| Параметр | Значение | Формат значения |
|---|---|---|
usersListArray |
Массив объектов NbiHotspotAccessList со списками |
|
code |
Код ответа |
int |
detail |
Пояснение к ответу |
String |
Примеры команд и кодов
| Код | Описание |
|---|---|
0 |
Успешно |
Запрос
<soap:Envelope>
<soap:Header/>
<soap:Body>
<nbi:RetrieveHotspotDefAccessLists>
<nbi:filter>1</nbi:filter>
<nbi:domain>root</nbi:domain>
<nbi:count>10</nbi:count>
<nbi:page>1</nbi:page>
<nbi:orderBy>list_type</nbi:orderBy>
<nbi:orderType></nbi:orderType>
</nbi:RetrieveHotspotDefAccessLists>
</soap:Body>
</soap:Envelope>
Ответ
<ns:RetrieveHotspotDefAccessListsResponse>
<ax21:code>0</ax21:code>
<ax21:detail>7</ax21:detail>
<ax251:profiles><ax251:profiles>
<ax251:domain>root</ax251:domain>
<ax251:idList>
<ax248:str>79101234567</ax248:str>
</ax251:idList>
<ax251:listType>WHITE</ax251:listType>
<ax251:name></ax251:name>
</ax251:profiles>
<ax251:profiles>
<ax251:domain>root</ax251:domain>
<ax251:idList>
<ax248:str>79101234567</ax248:str>
<ax248:str>79101234568</ax248:str>
</ax251:idList>
<ax251:listType>BLACK</ax251:listType>
<ax251:name>test_1</ax251:name>
</ax251:profiles>
<ax251:profiles>
<ax251:domain>root</ax251:domain>
<ax251:idList>
<ax248:str>79101234567</ax248:str>
<ax248:str>79101234562</ax248:str>
</ax251:idList><ax251:listType>WHITE</ax251:listType>
<ax251:name>test2</ax251:name>
</ax251:profiles>
</ax251:profiles>
</ns:return>
</ns:RetrieveHotspotDefAccessListsResponse>
| Код | Описание ошибки |
|---|---|
112 |
Значение поля count должно быть целым и положительным числом |
113 |
Значение поля page должно быть целым и положительным числом |
427 |
Списка с таким именем и доменом не существует |
10 |
У роли нет прав создавать список с указанным доменом |
См. также
Вернуться к списку команд
Версия 1.19-48
Дата публикации 15-03-2021 16:55:34