RetrievePortalParams - Получить параметры виртуального портала

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

  1. Команда добавлена в версии 1.5

  2. Начиная с версии 1.18 не поддерживается, вместо нее нужно использовать GetPortalParams

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

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

webPortal

Имя Web портала

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

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

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

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

code

Код ответа

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

detail

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

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

response

Объект NbiParameterArray

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

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

103

Некорректное значение поля 'webPortal'
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalParams>
            <nbi:webPortal></nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>103</ax21:code>
                <ax21:detail>Incorrect field 'webPortal'.</ax21:detail>
                <ax21:response xsi:type="ax21:NbiParameterArray"/>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

102

Портала с таким именем не существует
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalParams>
            <nbi:webPortal>notexists</nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>102</ax21:code>
                <ax21:detail>No Web portal with name 'notexists'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiParameterArray"/>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </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:RetrievePortalParams>
            <nbi:webPortal>test</nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>118</ax21:code>
                <ax21:detail>User has no rights on portal test</ax21:detail>
                <ax21:response xsi:type="ax21:NbiParameterArray"/>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>
Код Описание ошибки

0

Успешно
Запрос
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:nbi="http://nbi.radius.eltex.org">
    <soapenv:Header/>
    <soapenv:Body>
        <nbi:RetrievePortalParams>
            <nbi:webPortal>test</nbi:webPortal>
        </nbi:RetrievePortalParams>
    </soapenv:Body>
</soapenv:Envelope>
Ответ
<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <soapenv:Body>
        <ns:RetrievePortalParamsResponse
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeParameterListResponse"
                xmlns:ax214="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax226="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax220="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax25="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax217="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail/>
                <ax21:response xsi:type="ax21:NbiParameterArray">
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.title.kk</ax21:name>
                        <ax21:value>Біздің сайта Wi-Fi Ростелеком тіркелу</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>advertising.host.en</ax21:name>
                        <ax21:value>http://dev.wififix.ru/index.php</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.invalid.message.kk</ax21:name>
                        <ax21:value>Телефон нөмірін енгізгеннен Қате, қайтадан көріңіз</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>advertising.host.kk</ax21:name>
                        <ax21:value>http://dev.wififix.ru/index.php</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.title.en</ax21:name>
                        <ax21:value>Registration on Wi-Fi Rostelecom portal</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.descr.en</ax21:name>
                        <ax21:value>© 2015 OJSC 'Rostelecom'. All rights reserved.</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.success.message.en</ax21:name>
                        <ax21:value>Congratulations, you have successfully connected to the Internet!</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.msg.template.kk</ax21:name>
                        <ax21:value>қол '%ssid%'. кіру: %phone%. пароль : %password%</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.redirect.en</ax21:name>
                        <ax21:value>http://www.rostelecom.ru/</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.redirect.kk</ax21:name>
                        <ax21:value>http://www.rostelecom.ru/</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.descr.kk</ax21:name>
                        <ax21:value>© 2015 ААҚ «Ростелеком». Барлық құқықтар сақталған.</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.invalid.message.en</ax21:name>
                        <ax21:value>Phone number entered is incorrect, please try again</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.success.message.kk</ax21:name>
                        <ax21:value>Құттықтаймыз, сіз табысты Интернетке қосылған жоқ!</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.msg.template.en</ax21:name>
                        <ax21:value>Access to'%ssid%'. Login: %phone%. Pwd: %password%</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.captcha</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>default.locale</ax21:name>
                        <ax21:value>ru</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>deny.self.registration</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.placeholder</ax21:name>
                        <ax21:value>4841250</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>phone.regexp</ax21:name>
                        <ax21:value>^7913\d{7}$</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.additional.auth.params</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>site.restrict.sms</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.cut.ssid</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>sms.gate</ax21:name>
                        <ax21:value>none</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>wifi.password.length</ax21:name>
                        <ax21:value>4</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>tune.payment.service</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>demo.payment</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.yapurse</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.webmoney</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.terminal</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.sber</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.qiwi</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.promsvyazbank</ax21:name>
                        <ax21:value>true</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.mobile</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.masterpass</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.cards</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payment.aclick</ax21:name>
                        <ax21:value>false</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.scid</ax21:name>
                        <ax21:value>1234</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.phonePaymentsSupport</ax21:name>
                        <ax21:value>1234</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.secret</ax21:name>
                        <ax21:value>1265</ax21:value>
                    </ax21:parameter>
                    <ax21:parameter xsi:type="ax21:NbiParameter">
                        <ax21:name>payments.shopId</ax21:name>
                        <ax21:value>1234</ax21:value>
                    </ax21:parameter>
                </ax21:response>
            </ns:return>
        </ns:RetrievePortalParamsResponse>
    </soapenv:Body>
</soapenv:Envelope>

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