RetrieveSSIDListByWebPortal – Запрос списка SSID, на которые установлен Web-портал

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

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

  2. Команда RetrieveSSIDListByWebPortal2 актуальная с версии 1.10. Команда имеет идентичное API. Отличие ее в том, что факт отсутствия SSID с указанным именем портала не считает ошибкой.

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

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

webPortal

Имя Web портала

^[ \w-]{1,32}$

Текст английскими буквами разного регистра с символами пробела, тире и нижними подчеркиваниями длиной до 32-х символов.

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

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

code

Код ответа

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

detail

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

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

response

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

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

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

0

Успешно
Запрос
        <xsd:RetrieveSSIDListByWebPortal>
            <xsd:webPortal>default</xsd:webPortal>
        </xsd:RetrieveSSIDListByWebPortal>
Ответ
        <ns:RetrieveSSIDListByWebPortalResponse>
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:item>
                        <ns:domain>test.root</ns:domain>
                        <ns:name>local2</ns:name>
                    </ns:item>
                </ns:response>
            </ns:return>
        </ns:RetrieveSSIDListByWebPortalResponse>
Код Описание ошибки

33

Имя Web-портала отсутствует или не удовлетворяет формату

55

Web-портал не найден в настройках SSID`ов (только для RetrieveSSIDListByWebPortal)

Вернуться к списку команд
Версия 1.20-2055
Дата публикации 13-08-2021 02:44:15