RetrieveTariffListV3 – Запрос списка тарифных планов(c пагинацией)

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

Команда актуальна, начиная с версии 1.5
Команда подгружает число пользователей, к которым тариф привязан, из таблицы MySQL radius.radusergroup.

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

Параметр	Значение	Формат значения	Расшифровка формата	Ссылка
tariffName	Название тарифного плана, если установлен, то выдается список тарифов, название которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).	^.{1,64}$	Текст до 64-х символов.
tariffCode	Код тарифного плана, если установлен, то выдается список тарифов, код которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).	^.{1,64}$	Текст до 64-х символов.
tariffDomain	Домен клиента, может быть пустым. Если установлен, то выдается список тарифов с данным доменом.	(?=^.{1,235}$)(^((?!-\|_\|.(__\|--).)[a-zA-Z0-9_\-]{1,63}\.)((?!-\|_\|.(__\|--).*)[a-zA-Z0-9_\-]{1,63})$)	Текст длиной до 235 символов, удовлетворяющий правилам FQDN.	Domain
count	Кол-во выводимых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
page	Номер страницы, порции выдаваемых элементов, обязательно.	^[1-9][0-9]*$	Целое положительное число
tariffAttr	0 или более объектов NbiAttr для указания, что данные атрибуты должны быть у результирующего списка. Обязательным параметром атрибута должно быть имя, оператор и значение не обязательны.

Параметр

Значение

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

Расшифровка формата

Ссылка

tariffName

Название тарифного плана, если установлен, то выдается список тарифов, название которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

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

tariffCode

Код тарифного плана, если установлен, то выдается список тарифов, код которых содержит значение данного поля. Используйте специальные символы ? (один символ) и % (неограниченное кол-во символов).

^.{1,64}$

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

tariffDomain

Домен клиента, может быть пустым. Если установлен, то выдается список тарифов с данным доменом.

(?=^.{1,235}$)(^((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63}\.)*((?!-|_|.*(__|--).*)[a-zA-Z0-9_\-]{1,63})$)

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

Domain

count

Кол-во выводимых элементов, обязательно.

^[1-9][0-9]*$

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

page

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

^[1-9][0-9]*$

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

tariffAttr

0 или более объектов NbiAttr для указания, что данные атрибуты должны быть у результирующего списка. Обязательным параметром атрибута должно быть имя, оператор и значение не обязательны.

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

Параметр	Значение	Формат значения
code	Код ответа	Целое неотрицательное число.
detail	Пояснение к ответу. При успешном выполнении команды содержит суммарное количество тарифных планов, которые удовлетворяют условиям выборки	Текст английскими буквами с пробелами и спецсимволами.
response	Массив объектов NbiSingleTariff.

Параметр

Значение

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

code

Код ответа

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

detail

Пояснение к ответу. При успешном выполнении команды содержит суммарное количество тарифных планов, которые удовлетворяют условиям выборки

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

response

Массив объектов NbiSingleTariff.

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

Код	Описание ошибки
8	Домен не удовлетворяет правилам FQDN

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>,?</nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>15</nbi:page>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>8</ax21:code>
                <ax21:detail>Domain ',?' does not conform to the rules FQDN</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
10	Домен роли не имеет прав на домен тарифного плана

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>root</nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>15</nbi:page>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>10</ax21:code>
                <ax21:detail>Role have no rights on domain 'root'</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
62	Данный домен не зарегистрирован в системе SoftWLC

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain>wifi.root</nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>15</nbi:page>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>62</ax21:code>
                <ax21:detail>Such domain 'wifi.root' is not registered in ELTEX_EMS.DOMAINS</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
112	Значение 'Count' должно быть целым и положительным

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count>0</nbi:count>
            <nbi:page>5</nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://statistic.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>112</ax21:code>
                <ax21:detail>Count must be positive integer</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
113	Значение 'Page' должно быть целым и положительным

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>0</nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://statistic.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>113</ax21:code>
                <ax21:detail>Page must be positive integer</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

Код	Описание ошибки
112	Не установлен параметр в поле count

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count></nbi:count>
            <nbi:page></nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax27="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://statistic.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>112</ax21:code>
                <ax21:detail>In request by key 'count' value can not be null</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray"/>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

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

Код

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

Успешно

Запрос

<soap:Envelope
    xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
    xmlns:nbi="http://nbi.radius.eltex.org"
    xmlns:xsd="http://response.object.nbi.radius.eltex.org/xsd">
    <soap:Header/>
    <soap:Body>
        <nbi:RetrieveTariffListV3>
            <nbi:tariffName></nbi:tariffName>
            <nbi:tariffCode></nbi:tariffCode>
            <nbi:tariffDomain></nbi:tariffDomain>
            <nbi:count>1</nbi:count>
            <nbi:page>5</nbi:page>
            <nbi:tariffAttr>
                <xsd:name>Eltex-Tariff-Bras</xsd:name>
                <xsd:oper>=</xsd:oper>
                <xsd:value>true</xsd:value>
            </nbi:tariffAttr>
        </nbi:RetrieveTariffListV3>
    </soap:Body>
</soap:Envelope>

Ответ

<soapenv:Envelope
    xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <soapenv:Body>
        <ns:RetrieveTariffListV3Response
            xmlns:ns="http://nbi.radius.eltex.org">
            <ns:return xsi:type="ax21:NbiCodeTariffResponse"
                xmlns:ax225="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax28="http://request.object.nbi.radius.eltex.org/xsd"
                xmlns:ax213="http://statistic.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax210="http://authService.object.nbi.radius.eltex.org/xsd"
                xmlns:ax222="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax23="http://object.nbi.radius.eltex.org/xsd"
                xmlns:ax26="http://tariff.object.nbi.radius.eltex.org/xsd"
                xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax219="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
                xmlns:ax216="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <ax21:code>0</ax21:code>
                <ax21:detail>15</ax21:detail>
                <ax21:response xsi:type="ax21:NbiTariffArray">
                    <ax21:item xsi:type="ax21:NbiSingleTariff">
                        <ax21:createDate>2016-10-05T09:49:42.000+07:00</ax21:createDate>
                        <ax21:deactivated>false</ax21:deactivated>
                        <ax21:tariffCode>bt1</ax21:tariffCode>
                        <ax21:tariffDescr/>
                        <ax21:tariffDomain>root</ax21:tariffDomain>
                        <ax21:tariffName>bt1</ax21:tariffName>
                        <ax21:users>10</ax21:users>
                        <ax21:check xsi:type="ax21:NbiAttrArray"/>
                        <ax21:groupcheck xsi:type="ax21:NbiAttrArray"/>
                        <ax21:groupreply xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Cisco-Account-Info</ax21:name>
                                <ax21:oper>+=</ax21:oper>
                                <ax21:value>Abt1</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Cisco-Account-Info</ax21:name>
                                <ax21:oper>+=</ax21:oper>
                                <ax21:value>Nserv5</ax21:value>
                            </ax21:attr>
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-User-Create-Date</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>2016-10-05 09:49:42</ax21:value>
                            </ax21:attr>
                        </ax21:groupreply>
                        <ax21:portal xsi:type="ax21:NbiAttrArray">
                            <ax21:attr xsi:type="ax21:NbiAttr">
                                <ax21:name>Eltex-Tariff-Portal-Only</ax21:name>
                                <ax21:oper>=</ax21:oper>
                                <ax21:value>false</ax21:value>
                            </ax21:attr>
                        </ax21:portal>
                        <ax21:reply xsi:type="ax21:NbiAttrArray"/>
                    </ax21:item>
                </ax21:response>
            </ns:return>
        </ns:RetrieveTariffListV3Response>
    </soapenv:Body>
</soapenv:Envelope>

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