RetrieveRadiusUsersWithFieldFilters - Получить список пользователей wi-fi с фильтром по таблице radstat

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

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

  2. Команда позволяет получить список пользователей Wi-Fi с фильтрами по таблице radstat.

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

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

domain

Домен

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

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

count

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

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

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

startIndex

Смещение от начала таблицы (0 - выдать всё с начала)

^[0-9]*$

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

orderBy

Поле, определяющее, по какому элементу сортировать выдаваемые данные

String

Название поля таблицы radstat

orderType

Тип сортировки (По умолчанию ASC)

^(ASC|DESC)$

ASC или DESC

fieldFilters

Список фильтров по конкретному полю таблицы

Фильтры поиска

NbiParameterArray

categories

Категории пользователей в системе SoftWLC

String

enterprise, equipment, hotspot, voucher, bras, service, voucher_bras

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

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

response

Объект NbiRadiusUsersFlatArray, содержащий массив пользователей wi-fi

NbiRadiusUsersFlatArray

code

Код ответа

int

detail

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

String

Фильтры поиска

Название Описание Формат значения

username

Логин пользователя

String

userdomain

Домен пользователя

String

create_date_start

Начало интервала 'Дата создания'

yyyy-MM-dd

create_date_end

Конец интервала 'Дата создания'

yyyy-MM-dd

user_update_date_start

Начало интервала 'Дата обновления'

yyyy-MM-dd

user_update_date_end

Конец интервала 'Дата обновления'

yyyy-MM-dd

dev_type

Тип устройства пользователя

0 - телефон, 1 - планшет, 2 - ПК

dev_os

ОС устройства пользователя

Название ОС (Windows, Linux, Mac OS, iOS, Android)

dev_browser

Браузер пользователя

Название браузера (Chrome, Edge, Internet Explorer, Opera, Firefox, Safari)

dev_vendor

Производитель устройства пользователя

String

ssid

Имя SSID’а

String

phone

Телефон пользователя

String

deactivated

Блокировка

true/false

advertising

Согласие на рекламу

true/false

search_string

Гибкий фильтр, позволяющий искать по полям username, userdomain и family таблицы radstat

String

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

Код Описание

0

Успешно
Запрос
<nbi:RetrieveRadiusUsersWithFieldFilters>
    <nbi:domain>.root</nbi:domain>
    <nbi:count>1</nbi:count>
    <nbi:startIndex>0</nbi:startIndex>
    <nbi:orderBy>username</nbi:orderBy>
    <nbi:orderType>asc</nbi:orderType>
    <nbi:fieldFilters>
        <xsd:parameter>
            <xsd:name>username</xsd:name>
            <xsd:value>test</xsd:value>
        </xsd:parameter>
        <xsd:parameter>
            <xsd:name>create_date_start</xsd:name>
            <xsd:value>2022-03-27</xsd:value>
        </xsd:parameter>
    </nbi:fieldFilters>
    <nbi:categories>hotspot</nbi:categories>
    <nbi:categories>bras</nbi:categories>
</nbi:RetrieveRadiusUsersWithFieldFilters>
Ответ
<ns:RetrieveRadiusUsersWithFieldFiltersResponse>
    <ns:return xsi:type="ax2124:NbiRadiusUsersFlatResponse">
        <ax21:code>0</ax21:code>
        <ax21:detail>Success</ax21:detail>
        <ax2124:response xsi:type="ax2124:NbiRadiusUsersFlatArray">
            <ax2124:items xsi:type="ax2124:NbiRadiusUserFlat">
                <ax2124:advertisingPermitted>false</ax2124:advertisingPermitted>
                <ax2124:category>hotspot</ax2124:category>
                <ax2124:clientFamily xsi:nil="true"/>
                <ax2124:clientName xsi:nil="true"/>
                <ax2124:clientPhone xsi:nil="true"/>
                <ax2124:country/>
                <ax2124:createDate>Mar 27, 2022 6:12:17 PM</ax2124:createDate>
                <ax2124:deactivated>false</ax2124:deactivated>
                <ax2124:deactivationUntil xsi:nil="true"/>
                <ax2124:deviceBrowser/>
                <ax2124:deviceOs/>
                <ax2124:deviceType>0</ax2124:deviceType>
                <ax2124:deviceVendor/>
                <ax2124:devision xsi:nil="true"/>
                <ax2124:email xsi:nil="true"/>
                <ax2124:family xsi:nil="true"/>
                <ax2124:hotspotInactive>false</ax2124:hotspotInactive>
                <ax2124:legalId xsi:nil="true"/>
                <ax2124:location/>
                <ax2124:mac xsi:nil="true"/>
                <ax2124:macsList xsi:type="axis2ns2004:anyType">
                    <empty xmlns="http://www.w3.org/2001/XMLSchema">true</empty>
                </ax2124:macsList>
                <ax2124:name xsi:nil="true"/>
                <ax2124:organization/>
                <ax2124:phone xsi:nil="true"/>
                <ax2124:position xsi:nil="true"/>
                <ax2124:ssid xsi:nil="true"/>
                <ax2124:state/>
                <ax2124:tariff_name>test</ax2124:tariff_name>
                <ax2124:userDomain>root</ax2124:userDomain>
                <ax2124:userName>testuser</ax2124:userName>
                <ax2124:userUpdateDate>Jan 1, 1971 7:00:01 AM</ax2124:userUpdateDate>
                <ax2124:validUntil>Mar 27, 2022 7:52:17 PM</ax2124:validUntil>
                <ax2124:validity_period>100</ax2124:validity_period>
            </ax2124:items>
            <ax2124:totalCount>42519</ax2124:totalCount>
        </ax2124:response>
        <ax2124:totalCount>42519</ax2124:totalCount>
    </ns:return>
</ns:RetrieveRadiusUsersWithFieldFiltersResponse>
Код Описание ошибки

2

Ошибка обращения к БД MySQL

112

Запрашиваемое число записей (count) должно быть больше нуля

114

Указанная колонка сортировки (orderBy) не существует

131

Стартовый индекс (startIndex) должен быть больше или равен нулю

См. также

Вернуться к списку команд
Версия 1.24-2811
Дата публикации 14-11-2022 06:12:39