RetrievePortalTariffList - Вывести список тарифных планов для виртуального портала

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

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

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

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

webPortal

Имя Web портала

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

Текст до 32-х символов.

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

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

code

Код ответа

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

detail

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

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

response

Массив объектов NbiEntryDescr, где entry - код тарифного плана, а descr - этикетка для пользователей

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

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

102

Web портала с таким именем не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalTariffList>
            <xsd:webPortal>portald</xsd:webPortal>
        </xsd:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>102</ns:code>
                <ns:detail>No Web portal with name 'portald'</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

103

Некорректное имя Web портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:xsd="http://nbi.radius.eltex.org"
    xmlns:xsd1="http://response.object.nbi.radius.eltex.org/xsd">
    <soapenv:Header/>
    <soapenv:Body>
        <xsd:RetrievePortalTariffList>
            <xsd:webPortal></xsd:webPortal>
        </xsd:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>103</ns:code>
                <ns:detail>Incorrect field 'webPortal'.</ns:detail>
                <ns:response/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

118

У пользователя нет прав на просмотр данного портала
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalTariffList>
            <nbi:webPortal>test</nbi:webPortal>
        </nbi:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax23:NbiCodeEntryDescrResponse"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax23:code>118</ax23:code>
                <ax23:detail>User has no rights on portal 'test'</ax23:detail>
                <ax23:response xsi:type="ax23:NbiEntryDescrArray"/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

300

У пользователя нет прав на данную операцию
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalTariffList>
            <nbi:webPortal>default</nbi:webPortal>
        </nbi:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeEntryDescrResponse"
                xmlns:ax27="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax29="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>300</ax21:code>
                <ax21:detail>No rights on operation</ax21:detail>
                <ax21:response xsi:type="ax21:NbiEntryDescrArray"/>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </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:RetrievePortalTariffList>
            <xsd:webPortal>default</xsd:webPortal>
        </xsd:RetrievePortalTariffList>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalTariffListResponse
            xmlns:ns="http://org.eltex.radius.nbi/xsd">
            <ns:return>
                <ns:code>0</ns:code>
                <ns:detail/>
                <ns:response>
                    <ns:entry>
                        <ns:descr>Бесплатный тариф с ограничением трафика</ns:descr>
                        <ns:entry>white</ns:entry>
                    </ns:entry>
                    <ns:entry>
                        <ns:descr>Бесплатный тариф с ограничением скорости</ns:descr>
                        <ns:entry>black</ns:entry>
                    </ns:entry>
                </ns:response>
            </ns:return>
        </ns:RetrievePortalTariffListResponse>
    </soapenv:Body>
</soapenv:Envelope>

Вернуться к списку команд
Версия 1.23-2695
Дата публикации 02-09-2022 11:42:18