RetrievePortalList – Запрос списка виртуальных порталов

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

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

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

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

dummy

Не используется

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

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

code

Код ответа

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

detail

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

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

response

Массив объектов с именами порталов

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

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

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

999

Системная ошибка
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalList>
            <xsd:dummy></xsd:dummy>
        </xsd:RetrievePortalList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>999</ns:code>
                <ns:detail>Failed to read 'portals' from file system</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePortalListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalList>
            <xsd:dummy></xsd:dummy>
        </xsd:RetrievePortalList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:name>mcdonalds</ns:name>
                    <ns:name>eltex</ns:name>
                    <ns:name>default</ns:name>
                    <ns:name>dns</ns:name>
                </ns:response>
            </ns:return>
        </ns:RetrievePortalListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.19-79
Дата публикации 09-06-2021 14:30:17