GetUrlFilterList - Получение списков URL

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

  1. Команда на получение списка URL фильтров.
    При отсутствии домена - возвращает список всех фильтров соответствующие роли.
    Если указан домен - возвращает фильтры для указанного домена.
    Если домен начинается с точки - возвращает фильтры для указанного и дочерних доменов.

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

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

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

domain

Домен списка.

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

count

Кол-во выводимых элементов.

Целое положительное число

page

Номер страницы, порции выдаваемых элементов.

Целое положительное число

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные.

name, domain или type (По умолчанию name)

orderType

Поле определяющее тип сортировки.

ASC или DESC (По умолчанию ASC)

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

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

code

Код ответа

Целое неотрицательное число.

detail

Размер списка без учета фильтров или описание ошибки

Целое неотрицательное число или текст английскими буквами с пробелами и спецсимволами.

response

Массив объектов NbiUrlFilterSimple

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

Код Описание ошибки

0

Успешно

10

Роль не имеет прав на указанный домен

62

Домен не зарегистрирован
Запрос
<soapenv:Envelope>
   <soapenv:Header/>
   <soapenv:Body>
      <nbi:GetUrlFilterList>
         <nbi:domain>root</nbi:domain>
         <nbi:count>10</nbi:count>
         <nbi:page>1</nbi:page>
         <nbi:orderBy>name</nbi:orderBy>
         <nbi:orderType>DESC</nbi:orderType>
      </nbi:GetUrlFilterList>
   </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope>
   <soapenv:Body>
      <ns:GetUrlFilterListResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail/>
            <ax233:profiles>
               <ax233:domain>my.root</ax233:domain>
               <ax233:listSize>1</ax233:listSize>
               <ax233:name>white</ax233:name>
               <ax233:type>WHITE</ax233:type>
            </ax233:profiles>
            <ax233:profiles>
               <ax233:domain>root</ax233:domain>
               <ax233:listSize>2</ax233:listSize>
               <ax233:name>black</ax233:name>
               <ax233:type>BLACK</ax233:type>
            </ax233:profiles>
         </ns:return>
      </ns:GetUrlFilterListResponse>
   </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.21-2274
Дата публикации 03-12-2021 11:20:22