RetrieveTariffListV4 - Запрос списка тарифных планов и привязанных к ним порталов

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

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

  2. Команда подгружает число пользователей, к которым тариф привязан, из таблицы 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 для указания, что данные атрибуты должны быть у результирующего списка. Обязательным параметром атрибута должно быть имя, оператор и значение не обязательны.

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

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

response

Объект NbiSingleTariffWithPortals.

code

Код ответа

int

detail

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

Код Описание

0

Успешно
Запрос
      <nbi:RetrieveTariffListV4>
         <nbi:tariffName></nbi:tariffName>
         <nbi:tariffCode></nbi:tariffCode>
         <nbi:tariffDomain></nbi:tariffDomain>
         <nbi:count>2</nbi:count>
         <nbi:page>1</nbi:page>
                <nbi:tariffAttr>
            <xsd:name>Eltex-Tariff-Portal-Only</xsd:name>
            <xsd:oper>=</xsd:oper>
            <xsd:value>true</xsd:value>
         </nbi:tariffAttr>
      </nbi:RetrieveTariffListV4>
Ответ
      <ns:RetrieveTariffListV4Response
         <ns:return xsi:type="ax23:NbiCodeTariffResponse2">
            <ax23:code>0</ax23:code>
            <ax23:detail>1</ax23:detail>
            <ax23:response xsi:type="ax23:NbiTariffArray2">
               <ax23:item xsi:type="ax23:NbiSingleTariffWithPortalList">
                  <ax23:createDate>2017-05-23T15:37:51.000+07:00</ax23:createDate>
                  <ax23:deactivated>false</ax23:deactivated>
                  <ax23:tariffCode>hot</ax23:tariffCode>
                  <ax23:tariffDescr/>
                  <ax23:tariffDomain>root</ax23:tariffDomain>
                  <ax23:tariffName>hotspotTar</ax23:tariffName>
                  <ax23:users>10</ax23:users>
                  <ax23:check xsi:type="ax23:NbiAttrArray"/>
                  <ax23:groupcheck xsi:type="ax23:NbiAttrArray"/>
                  <ax23:groupreply xsi:type="ax23:NbiAttrArray">
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-User-Create-Date</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>2017-05-23 15:37:51</ax23:value>
                     </ax23:attr>
                  </ax23:groupreply>
                  <ax23:portal xsi:type="ax23:NbiAttrArray">
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-Tariff-Portal-Only</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>true</ax23:value>
                     </ax23:attr>
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-Tariff-Price</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>1</ax23:value>
                     </ax23:attr>
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-State-On-1</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>true</ax23:value>
                     </ax23:attr>
                     <ax23:attr xsi:type="ax23:NbiAttr">
                        <ax23:name>Eltex-State-Start-Session-Before-Redirect-1</ax23:name>
                        <ax23:oper>=</ax23:oper>
                        <ax23:value>false</ax23:value>
                     </ax23:attr>
                  </ax23:portal>
                  <ax23:reply xsi:type="ax23:NbiAttrArray"/>
                  <ax23:portals xsi:type="ax23:NbiNameArray">
                     <ax23:name>portalName</ax23:name>
                     <ax23:name>bras</ax23:name>
                  </ax23:portals>
               </ax23:item>
            </ax23:response>
         </ns:return>
      </ns:RetrieveTariffListV4Response>
Код Описание ошибки

8

Неверное задание фильтра по домену

10

Домен роли не имеет прав на домен тарифного плана

62

Данный домен не зарегистрирован в системе SoftWLC

112

Значение 'Count' должно быть целым и положительным

113

Значение 'Page' должно быть целым и положительным

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12