RetrieveUserLocationHistory - Запрос статистики пользователя по перемещению между ТД
Общая информация
-
Команда актуальна, начиная с версии 1.8.
-
До версии 1.17 при обработке запроса данные ТД получались из EMS. NBI обращался в EMS-NBI по URL 'getAPListExtended'.
-
Начиная с версии 1.17 от этого отказались, и данные NBI получает сам из MySQL eltex_ems.ELTEX_OBJ_GEO. Поведение аналогично обработке команды GetGeoObjectsList
Входные параметры
| Параметр | Значение | Формат значения | Расшифровка формата | Ссылка |
|---|---|---|---|---|
usernаme |
Логин клиента, обязательно |
^.{1,64}$ |
Текст до 64-х символов. |
Wi-Fi пользователь |
domain |
Фильтр по домену. Если домен начинается с символа '.' , то статистика будет по всем ТД для данного домена и его поддоменов. |
.* |
Любой текст |
Domain |
timeStart |
Поле для поиска по времени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время окончания сессии не может быть раньше этого параметра. Может быть пустым. |
.* |
Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00" |
|
timeEnd |
Поле для поиска повремени активности в формате «yyyy-MM-ddTHH:mm:ss±HH:MM». Время начала сессии не может быть позже этого параметра. Может быть пустым. |
.* |
Время по стандарту "ISO 8601" в формате «yyyy-MM-ddTHH:mm:ss±HH:MM», например "2008-11-15T22:52:58+03:00" |
|
count |
Кол-во выводимых элементов, обязательно. |
^[1-9][0-9]*$ |
Целое положительное число |
|
offset |
Сдвиг от начала списка, обязательно. |
^[1-9][0-9]*$ |
Целое положительное число |
|
orderBy |
Поле, определяющее, по какому элементу сортировать выдаваемые данные. |
.* |
Имя поля, по которому будет выполняться сортировка |
|
orderType |
Поле определяющее тип сортировки. (По умолчанию ASC) |
^(ASC|DESC)$ |
ASC или DESC |
Выходные параметры
| Параметр | Значение | Формат значения |
|---|---|---|
code |
Код ответа |
Целое неотрицательное число. |
detail |
Пояснение к ответу |
Текст английскими буквами с пробелами и спецсимволами. |
total |
Общее число объектов |
Целое неотрицательное число |
response |
Массив объектов NbiLocationArrayItem |
Примеры команд и кодов
| Код | Описание |
|---|---|
0 |
Успешно |
Запрос
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:nbi="http://nbi.radius.eltex.org">
<soapenv:Header/>
<soapenv:Body>
<nbi:RetrieveUserLocationHistory>
<nbi:username>test.user</nbi:username>
<nbi:APDomain>.root</nbi:APDomain>
<nbi:startTime>2017-05-01T00:00:00Z</nbi:startTime>
<nbi:endTime>2017-06-01T00:00:00Z</nbi:endTime>
<nbi:count>10</nbi:count>
<nbi:offset>0</nbi:offset>
<nbi:orderBy>acctStartTime</nbi:orderBy>
<nbi:orderType>ASC</nbi:orderType>
</nbi:RetrieveUserLocationHistory>
</soapenv:Body>
</soapenv:Envelope>Ответ
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns:RetrieveUserLocationHistoryResponse xmlns:ns="http://nbi.radius.eltex.org">
<ns:return xsi:type="ax217:NbiLocationHistoryResponse"
xmlns:ax227="http://radiusUser.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax217="http://locationHistory.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax239="http://urlFilters.pcrf.response.object.nbi.radius.eltex.org/xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ax214="http://apList.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax225="http://object.nbi.radius.eltex.org/xsd"
xmlns:ax236="http://subnets.pcrf.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax223="http://request.object.nbi.radius.eltex.org/xsd"
xmlns:ax245="http://userLists.pcrf.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax29="http://statistics.object.nbi.radius.eltex.org/xsd"
xmlns:ax211="http://ssidstats.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax23="http://authService.object.nbi.radius.eltex.org/xsd"
xmlns:ax233="http://shaper.pcrf.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax26="http://statistic.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax220="http://service.pcrf.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax231="http://tariff.object.nbi.radius.eltex.org/xsd"
xmlns:ax242="http://domains.response.object.nbi.radius.eltex.org/xsd"
xmlns:ax21="http://response.object.nbi.radius.eltex.org/xsd">
<ax21:code>0</ax21:code>
<ax21:detail/>
<ax217:array xsi:type="ax217:NbiLocationArray">
<ax217:items xsi:type="ax217:NbiLocationArrayItem">
<ax217:acct xsi:type="ax217:NbiLocationAcct">
<ax217:SSID>Eltex-Local</ax217:SSID>
<ax217:apDomain>Floor-4.hotspot.root</ax217:apDomain>
<ax217:clientDomain>enterprise.root</ax217:clientDomain>
<ax217:clientMAC>10-2A-B3-C5-D4-EB</ax217:clientMAC>
<ax217:nasIP>192.168.40.41</ax217:nasIP>
<ax217:nasMAC>A8-F9-4B-B6-01-C0</ax217:nasMAC>
<ax217:startTime>2017-05-18T10:26:53Z</ax217:startTime>
<ax217:stopTime>2017-05-18T10:27:00Z</ax217:stopTime>
<ax217:summarySessionTime>PT7S</ax217:summarySessionTime>
</ax217:acct>
<ax217:ap xsi:type="ax217:NbiLocationAp">
<ax217:building>1</ax217:building>
<ax217:city>Тестоград</ax217:city>
<ax217:domain>root</ax217:domain>
<ax217:floor>2</ax217:floor>
<ax217:house>42</ax217:house>
<ax217:ip>192.168.40.41</ax217:ip>
<ax217:mac>a8:f9:4b:b6:01:c0</ax217:mac>
<ax217:name>WEP-2ac-192.168.40.41</ax217:name>
<ax217:office>123</ax217:office>
<ax217:street>Тестовая</ax217:street>
<ax217:type>WEP-2ac</ax217:type>
</ax217:ap>
</ax217:items>
</ax217:array>
<ax217:total>1</ax217:total>
</ns:return>
</ns:RetrieveUserLocationHistoryResponse>
</soapenv:Body>
</soapenv:Envelope>| Код | Описание ошибки |
|---|---|
436 |
Не указан обязательный параметр |
437 |
Неверный тип сортировки |
438 |
Некорректный тип объекта для показа истории перемещения ''{0}'' |
439 |
Некорректный формат длительности промежутков между сессиями ''{0}'' |
Пример использования
См. также
Вернуться к списку команд
Версия 1.19-78
Дата публикации 04-06-2021 16:40:20