RetrieveHotspotAccessListsWithPortals - Получить списки доступа со списком привязанных порталов с учетом фильтрации("гибкий фильтр") и пагинации

Общая информация

  1. Команда актуальна, начиная с версии 1.25.

  2. Команда возвращает списки доступа по MAC

Входные параметры

Параметр Значение Формат значения Расшифровка формата Значение по умолчанию

filter

Текст фильтра

String

Гибкий фильтр. Возможна фильтрация по имени и типу списка(BLACK или WHITE), а также по полному mac из списка.

domain

Домен для фильтрации

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

Текст длиной до 235 символов, удовлетворяющий правилам FQDN

Если параметр не указан, то для фильтра будут использованы домены роли пользователя

count

Количество возвращаемых записей

Integer

Положительное целое число больше нуля

10

page

Номер страницы возвращаемых записей

Integer

Положительное целое число больше нуля

1

orderBy

Поле, по которому выполняется сортировка

String

Возможные значения полей для сортировки: id(идентификатор в базе данных),name(имя списка),domain(домен списка),list_type(тип списка)

id

orderType

Направление сортировки (ASC|DESC)

String

ASC

Выходные параметры

Параметр Значение Формат значения

accessListWithPortals

NbiHotspotAccessListWithPortalsArray

accessListsCount

Количество списков доступа

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно

8

Домен не удовлетворяет правилам FQDN

10

У роли нет прав на домен

62

Домен не зарегистрирован в системе

112

Значение поля count должно быть целым и положительным числом

113

Значение поля page должно быть целым и положительным числом

280

Работа с MongoDB отключена в конфигурации

441

Не настроен Elvis

494

Ошибка авторизации

506

Ошибка DOORS-NBI

507

Ошибка ELVIS-NBI

999

Системная ошибка
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:RetrieveHotspotAccessListsWithPortals>
         <nbi:filter>0a:82:f2:e7:7b:80</nbi:filter>
         <nbi:domain>root</nbi:domain>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>domain</nbi:orderBy>
         <nbi:orderType>ASC</nbi:orderType>
      </nbi:RetrieveHotspotAccessListsWithPortals>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:RetrieveHotspotAccessListsWithPortalsResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax266:accessListWithPortals>
               <ax266:nbiHotspotAccessListWithPortals>
                  <ax266:domain>root</ax266:domain>
                  <ax266:idList>
                     <ax27:str>0a:82:f2:e7:7b:80</ax27:str>
                     <ax27:str>7e:cb:f7:33:24:1e</ax27:str>
                  </ax266:idList>
                  <ax266:listType>WHITE</ax266:listType>
                  <ax266:name>White</ax266:name>
                  <ax266:portals>
                     <ax27:str>default</ax27:str>
                     <ax27:str>testerportal</ax27:str>
                  </ax266:portals>
                  <ax266:portals>default</ax266:portals>
                  <ax266:portals>portal_test</ax266:portals>
               </ax266:nbiHotspotAccessListWithPortals>
            </ax266:accessListWithPortals>
            <ax266:accessListsCount>1</ax266:accessListsCount>
         </ns:return>
      </ns:RetrieveHotspotAccessListsWithPortalsResponse>
   </soapenv:Body>
</soapenv:Envelope>

См. также

Вернуться к списку команд
Версия 1.26-3099
Дата публикации 18-05-2023 06:44:06