Руководство разработчика для интеграции с

ООО «Сетевые решения», 2011
__________________________________________________________________
Руководство разработчика для
интеграции с
LANBillingSuperviseServer.
Описание API.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 2 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Информация для контактов:
Адрес в интернет: http://www.lanbilling.ru
Техническая поддержка: support@lanbilling.ru
Телефоны: +7 (495) 780-4420, +7 (495) 795-0677
с 10-оо до 19-оо
Дата печати: 13.02.2012
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 3 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 4 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Оглавление
РУКОВОДСТВО РАЗРАБОТЧИКА ДЛЯ ИНТЕГРАЦИИ С
LANBILLINGSUPERVISESERVER. ОПИСАНИЕ API. .................................................. 1
ОГЛАВЛЕНИЕ .......................................................................................................... 4
ДОПОЛНИТЕЛЬНАЯ ИНФОРМАЦИЯ, СПОСОБСТВУЮЩАЯ ПОНИМАНИЮ
ТЕХНОЛОГИИ SOAP ................................................................................................ 6
WSDL – ОПИСАНИЕ СЕРВИСА И ЕГО ПРОГРАММНОГО ИНТЕРФЕЙСА .............. 7
ОБЩАЯ ИНФОРМАЦИЯ .......................................................................................................................... 7
ОБРАБОТКА ОШИБОК. ........................................................................................................................... 7
ТИПОВЫЕ ОБЪЕКТЫ SOAP API ............................................................................................................... 7
Объект soapFilter ....................................................................................................................... 7
Объект soapAddressFilter ......................................................................................................... 11
ПРИКЛАДНЫЕ ФУНКЦИИ ...................................................................................................................... 12
Функция login ........................................................................................................................... 12
Функция logout......................................................................................................................... 13
Функция getStat ....................................................................................................................... 14
Функция getAccount................................................................................................................. 19
Функция insupdAccount ........................................................................................................... 25
Функция getPayments .............................................................................................................. 26
Функция getTarifsHistory.......................................................................................................... 29
Функция insupdTarifsRasp ........................................................................................................ 31
Функция getCurrencies ............................................................................................................. 33
Функция getPayClasses............................................................................................................. 34
Функция Payment..................................................................................................................... 35
Функция getVgroup .................................................................................................................. 36
Функция insupdVgroup............................................................................................................. 41
Функция getAgreements .......................................................................................................... 42
Функция getAgents ................................................................................................................... 43
Функция blkVgroup .................................................................................................................. 45
Функция getAccounts ............................................................................................................... 45
Функция getVgroups................................................................................................................. 50
Функция getTarifsExt ................................................................................................................ 53
Функция Count ......................................................................................................................... 56
Функция getTarifsRasp ............................................................................................................. 56
Функция getOptions ................................................................................................................. 57
Функция getAutoAgreementNumber ....................................................................................... 58
Функция getSessionsRadius ...................................................................................................... 59
Функция stopSessionsRadius .................................................................................................... 61
Функция insupdUsboxService ................................................................................................... 62
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 5 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Функция getUsboxServices ....................................................................................................... 63
Функция delUsboxService......................................................................................................... 66
Функция getTarCategories ........................................................................................................ 66
Функция getAddressCountries .................................................................................................. 68
Функция getAddressRegions .................................................................................................... 69
Функция getAddressAreas ........................................................................................................ 71
Функция getAddressCities ........................................................................................................ 72
Функция getAddressSettles ...................................................................................................... 74
Функция getAddressStreets ...................................................................................................... 75
Функция getAddressFlats.......................................................................................................... 77
Функция getAddressMeanings ................................................................................................. 78
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 6 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Введение. Для кого предназначен этот документ
Основная цель данного документа – предоставить внешним разработчикам
возможность реализации и интеграции с LANBilling Supervise Server с собственными
АСР.
В основе API лежит сокетный сервер АСР, который реализует в себе алгоритм
обслуживания запросов от программных клиентов на основе технологии SOAP
(SimpleObjectsAccessProtocol).
Данный документ
постоянно дополняется по мере расширения
функционального базиса API и содержит описания используемых для работы с API
библиотек.
Дополнительная информация, способствующая
пониманию технологии SOAP
В основе использованной в API SOAP технологии обмена XML сообщениями
между клиентом и сервером лежит спецификация на XML (ExtensibleMarkupLanguage
– расширяемый язык разметки), найти которую можно по ссылке:
http://www.w3.org/TR/2000/REC-xml-20001006 и которая определяет общую структуру
данных, обмен которыми происходит в рамках SOAP.Специфика управления
сервисами, реализованными согласно API, описана при помощи стандартного
формата описания Web сервисов WSDL (WebServicesDescriptionLanguage), для
понимания
сути
которого
имеет
смысл
обратиться
к
ресурсам:
http://www.itpedia.ru/index.php/WSDL и http://www.w3.org/TR/wsdl. Последний
окажет неоценимую помощь в продвижении к цели написания приложений к АСР
LANBilling, начинающим использовать SOAP разработчикам.
Кроме вышеприведенных источников мы рекомендуем ознакомиться с
ресурсами, на которых приводятся практические примеры и советы по
использованию SOAP и WSDL:

http://webservices.xml.com/pub/a/ws/2003/05/27/wsdl.html
(перевод
на
русский язык: (http://xmlhack.ru/texts/03/wsdl.tales/wsdlintralook1.html)

http://webservices.xml.com/pub/a/ws/2003/06/24/wsdl.html
(перевод
на
русский язык: (http://xmlhack.ru/texts/03/wsdl.tales/wsdlintralook2.html)

http://www.citforum.ru/database/cache/web-services/
Кроме этих источников и еще массы ресурсов, которые можно найти при
помощи известных поисковых сервисов, крайне полезным для разработчиков на
PHP5 будет ресурс: http://phpclub.ru/detail/article/soap на котором детально
рассмотрен пример написания первого SOAP приложения.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 7 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
WSDL – описание сервиса и его программного
интерфейса
Общая информация
В данном разделе приведено описание функций SOAPAPI, которые требуется
реализовать, безотносительно средств доступа к ним (под средствами доступа
понимается в данном контексте средства библиотеки). Прикладные функции API
могут быть использованы из любой среды разработки, который предполагает
наличие SOAP клиента.
Структура описания функции содержит:
 раздел описания входных и выходных параметров;
 раздел описания определения функции.
Большая часть функции в качестве входных параметров принимает
стандартные объекты API, которые описаны вне связи с конкретной функцией. Эти
объекты описаны в разделе «Типовые объекты SOAPAPI».
Обработка ошибок.
В случае если менеджер не авторизован в системе, или сессия истекла, то
методы API должны возвращать значение, отличное от “SOAP_OK”. А поле SOAP
faultstring должно быть установлено в “error_auth”.
Типовые объекты SOAP API
Объект soapFilter
Объект используется как входной параметр для функций получения списков
объектов. Все его поля являются необязательными, назначение тех или иных полей
будет дано при описании функций, использующих soapFilter.
<complexType name="soapFilter">
<sequence>
<element name="activated" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="addresstype" type="xsd:long" minOccurs="0" maxOccurs="1" default="1"/>
// по агенту
<element name="agentid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по договору
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по «запись удалена (флаг)» 1-запись удалена
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 8 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="appid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="asnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по текущему состоянию блокировки учетной записи
<element name="blocked" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="catid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="category" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
// по идентификатору валюты
<element name="curid" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
<element name="common" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="defaultonly" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="deviceid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по направлению звонка (0 - входящий, 1 - исходящий)
<element name="direction" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="docid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="durfrom" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="durto" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="groupid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="groups" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по признаку «Запись является шаблоном»
<element name="istemplate" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="mgrid" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
<element name="needcalc" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="notgroups" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="onfly" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по идентификатору оператора, который зарегистрировал платёж
<element name="operid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по исправленному идентификатору оплачиваемого счёта
<element name="orderid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="ordernum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="payed" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
<element name="parentid" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
<element name="personid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="pgnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="pgsize" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="port" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="postmanid" type="xsd:unsignedLong" minOccurs="0" maxOccurs="1" default="0"/>
<element name="proto" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по идентификатору записи
<element name="recordid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="repdetail" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 9 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="repnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="setid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="shape" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="showdefault" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по идентификатору тарифа
<element name="tarid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по идентификатоу родительского тарифа, если это субтариф. Иначе 0
<element name="parenttarid" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
<element name="taridprev" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по тарифицируемому трафикк для кабельных агентов: 1-вх., 2-исх., 3-сумма, 4превалирующий
<element name="tartype" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по типу тарифа: 0-кабельный агент, 1-RADIUS по объему, 2-RADIUS по времени, 3-Классическая
телефония, 4-VoIP, 5-Периодические и разовые услуги
<element name="type" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по группе пользователей
<element name="ugroups" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="unavail" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
// фильтр по userid
<element name="userid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по идентификатору учетной записи
<element name="vgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="payhistory" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="hasregistry" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
<element name="amountfrom" type="xsd:double" minOccurs="0" maxOccurs="1"
default="0.000000"/>
<element name="amountto" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
// по адресу
<element name="address" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="addresscode" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по номеру договора
<element name="agrmnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="ani" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="cardkey" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по коду оплаты
<element name="code" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="descr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="dstip" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="dtcreated" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="dtactivated" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// начиная с даты
<element name="dtfrom" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// заканчивая датой
<element name="dtto" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по email
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 10 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="email" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по ИНН
<element name="inn" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по IP-адресу
<element name="ip" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="login" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по имени
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="namesound" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="numfrom" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="numto" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по номеру телефона
<element name="phone" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// фильтр по идентификатору платежа/номера платежного поручения (строгое соответствие)
<element name="receipt" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="responsible" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="serno" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="status" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="tardescr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="telstaff" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="telnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// логин учетной записи
<element name="vglogin" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по идентификатору пользователя для интеграции с внешними системами
<element name="uuid" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="searchtempl" type="lbapi:soapSearchTemplate" minOccurs="0"
maxOccurs="unbounded"/>
</sequence>
</complexType>
В тех функциях, в которых реализован постраничный вывод, алгоритм
обработки элементов реализован так, как показано ниже:
if(pgnum)
{
if (!pgsize) pgsize = 50;
get *pgsize* records for page *pgnum*;
}
else
{
get all records;
}
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 11 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Объект soapAddressFilter
Объект используется как входной параметр для функций получения списков
объектов относящихся к адресам. Все его поля являются необязательными,
назначение тех или иных полей будет дано при описании функций, использующих
soapAddressFilter.
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор района
<element name="area" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор города
<element name="city" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор населенного пункта
<element name="settl" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор улицы
<element name="street" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор дома/корпуса
<element name="building" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор квартиры/офиса
<element name="flat" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор сокращения из address_meaning
<element name="level" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Размер страницы
<element name="pgsize" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Номер страницы
<element name="pgnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Текстовое представление
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="timefrom" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 12 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Прикладные функции
Функция login
Вход в систему, создание сессии. Сервис должен в ответе передать куки,
которые клиентское приложение должно сохранить и использовать при
последующих запросов вплоть до вызова метода logout.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapManagerFull
Объект представляет информацию о менеджере (пользователе системы).
<complexType name="soapManagerFull">
<sequence>
<element name="manager" type="lbapi:soapManager" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapManager
Объект представляет информацию о менеджере.
<complexType name="soapManager">
<sequence>
// Идентификатор менеджера
<element name="personid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Логин
<element name="login" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Определение функции
Вход в систему, создание сессии. На входе имя пользователя и пароль. На
выходе принимается объект soapManagerFull или exception (исключение).
<!-- operation request element -->
<element name="login">
<complexType>
<sequence>
<element name="login" type="xsd:string" minOccurs="1" maxOccurs="1"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 13 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="pass" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="loginResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapManagerFull" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.login.req.xml, api3.login.res.xml:
Функция logout
Выход, удаление сесии
Определение функции
Выход из системы, удаление сессии. На входе и выходе ничего нет.
<!-- operation request element -->
<element name="logout">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="logoutResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.logout.req.xml, api3.logout.res.xml
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 14 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Функция getStat
Получение статистики использования тарифицируемых услуг.
Обязательным параметром фильтра является поле<repnum>, которое
определяет имя процедур и таблиц, используемых при получении статистики. Кроме
того, возможно получить только данные о размерности результата и названиях
полей, установив параметр фильтра<nodata> в 1.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Входной параметр ord содержит массив структур:
soapOrderby
{
std::string
long
}
name;
ascdesc;
// имя поля
// направление сортировки, 0 — asc, 1 — desc
Согласно этому набору выполняется окончательная сортировка массива
записей перед выдачей его клиенту.
Выходной параметр ret содержит структуру
soapStat
{
long rows;
long cols;
long total;
// кол-во строк в таблице
// кол-во столбцов в таблице
// общее количество записей (без учета pgsize и
pgnum)
soapVectorString
names;
// вектор названий столбцов
vector<soapVectorString>data; // матрица результата
}
Где
soapVectorString
{
vector<string> val;
}
размерности cols.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 15 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Подробное описание поля<repnum> в фильтре:
Активные сессии. flt.repnum = 8:
Входные параметры:
flt.agentid — идентификатор пользователя;
flt.vgid – идентификатор учетной записи;
Выходные строки (порядок важен):
assignedip - Присвоенный IP адрес в целочисленном представлении
start_time - Время начала сессии (время получения Accounting Start)
nas - IP адрес сервера доступа в целочисленном представлении
sess_ani – Значение атрибута Calling-Station-Id, либо Tunnel-Client-End (для
vpdn)
sess_dnis - Значение атрибута Called-Station-Id, либо Tunnel-Server-End (для
vpdn)
shape - Значение ограничения полосы пропускания на момент авторизации
sessionid - Идентификатор радиус сессии
stopreq - Административный запрос на разрыв сессии (флаг)
vgid — идентификатор учетной записи;
История балансов. flt.repnum = 11:
Входные параметры:
flt.userid — идентификатор пользователя;
flt.dtfrom — дата начала;
flt.dtto — дата конца;
flt.vgid – идентификатор учетной записи;
flt.agrmid — идентификатор договора;
flt.Login — логин;
flt.pgsize — размер страницы;
flt.pgnum — номер страницы;
Выходные строки (порядок важен):
dt – дата
agrmid — идентификатор договора;
uid — идентификатор пользователя;
vgid — идентификатор учетной записи;
currid — идентификатор валюты;
сurrsymbol — символ валюты;
vglogin — логин учетной записи;
agrmnum — номер договора;
username — имя пользователя;
balance — баланс;
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 16 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
История блокировок. flt.repnum = 12:
Входные параметры:
flt.userid — идентификатор пользователя;
flt.dtfrom — дата начала;
flt.dtto — дата конца;
flt.vgid – идентификатор учетной записи;
flt.agrmid — идентификатор договора;
flt.login – логин;
Выходные строки (порядок важен):
timefrom — время начала (YYYY-MM-DD HH24:MI:SS);
timeto — время конца (YYYY-MM-DD HH24:MI:SS);
blocktype — тип блокировки;
agrmid — идентификатор договора;
uid — идентификатор пользователя;
vgid — идентификатор учетной записи;
curid — идентификатор валюты;
currsymbol — символ валюты;
vglogin — логин учетной записи;
agrmnum — номер договора;
username — имя пользователя;
Инкрементальное обновление пользователей. flt.repnum = 18:
Входные параметры:
flt.dtfrom — дата начала;
Выходные строки (порядок важен):
uid — идентификатор пользователя;
login - логин для входа на страничку клиента;
name - имя пользователя: ФИО/Название компании;
email - адрес электронной почты;
phone - номер телефона;
type - тип пользователя: 1-юр. лицо, 2-физ. лицо;
category - Категория пользователя: 0-Абонент, 1-Оператор, 2-Дилер, 3Правообладатель, 4-Рекламодатель, 5-Партнер;
passsernum - серия паспорта;
passno - № паспорта;
address – адрес;
inn – ИНН;
bik – БИК;
gendiru - ген. Директор;
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 17 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
glbuhgu - главный бухгалтер;
kpp – КПП;
kontperson - контактное лицо;
corr - корр. счет;
bankname - наименование банка;
ogrn – ОГРН;
okved – ОКВЕД;
okpo – ОКПО;
settl - расчетный счет;
fax - номер факса;
birthdate - дата рождения;
birthplace - место рождения;
passissuedate - дата выдачи паспорта;
passissuedep - кем выдан паспорт;
Инкрементальное обновление договоров. flt.repnum = 19:
Входные параметры:
flt.dtfrom — дата начала;
Выходные строки (порядок важен):
agrmid - идентификатор договора;
uid — идентификатор пользователя;
operid - идентификатор оператора, с которым заключен договор
number - Номер договора
lastmoddate – дата последнего изменения;
date – текущая дата;
balance - Текущий баланс лицевого счета;
Инкрементальное обновление учетных записей. flt.repnum = 20:
Входные параметры:
flt.dtfrom — дата начала;
Выходные строки (порядок важен):
vgid – идентификатор учетной записи;
uid — идентификатор пользователя;
agrmid - идентификатор договора;
tarid – идентификатор тарифного плана;
login - логин для доступа к услуге;
blocked - текущее состояние блокировки: 0-уч. запись активна, 1заблокирована по балансу, 2-пользователем, 3-администратором, 4-по
балансу (активная блокировка), 5-лимит трафика, 10-уч. запись отключена;
Журнал авторизаций. flt.repnum = 21:
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 18 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Входные параметры:
flt.dtfrom — дата начала;
flt.vgid – Идентификатор учетной записи.
Выходные строки (порядок важен):
dt – дата;
vglogin – логин учетной записи;
resuilt – результат авторизации. 0 – если успешно, иначе код ошибки
RADIUS.
comment – комментарий;
Списания абонентской платы. flt.repnum = 22:
Входные параметры:
flt.userid — идентификатор пользователя;
flt.dtfrom — дата начала;
flt.dtto — дата конца;
flt.vgid – идентификатор учетной записи;
flt.agrmid — идентификатор договора;
flt.login — логин;
flt.pgsize – размер страницы;
flt.pgnum – номер страницы;
Выходные строки (порядок важен):
dt – дата ( в формате YYYY-MM-DD HH24:MI:SS);
agrmid — идентификатор договора;
ammount – сумма;
type - тип услуги: 1-объемная, 2-временная, 3-разовая, 4–периодическая, 0 –
для абон. платы.
agrmnum — номер договора;
currsymbol — символ валюты;
Процедура для вывода списка счетов указанного пользователя (по его
идентификатору). flt.repnum = 23
Входные параметры:
flt.userid — идентификатор пользователя;
flt.dtfrom — дата начала;
flt.dtto — дата конца;
flt.pgsize – размер страницы;
flt.pgnum – номер страницы;
Выходные строки (порядок важен):
agrmid — идентификатор договора;
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 19 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
agrmnumber — номер договора;
creationdate — дата выставления счёта ( в формате YYYY-MM-DD );
period — период, за который выставлен счет ( в формате YYYY-MM-DD );
currsumm — сумма счёта;
currsymbol — символ валюты;
Определение функции
Используется для получения статистики (матрицы текстовых значений) от
сервера используются функция, определенная как
<!-- operation request element -->
<element name="getStat">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
<element name="ord" type="lbapi:soapOrderby" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getStatResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapStat" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции в приведено в следующих документах, являющихся
приложением данного руководства: api3.getStat.req.xml, api3.getStat.res.xml
Функция getAccount
Получение полной информации об одном пользователе.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 20 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объекты soapAddressBrief и soapUsergroupFull документированы в описании
функции getAccounts.
Объект soapAccount
Объект представляет информацию о пользователе (абоненте).
<complexType name="soapAccount">
<sequence>
//id пользователя
<element name="uid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Категория пользователя: 0-Абонент, 1-Оператор, 2-Дилер, 3-Правообладатель, 4Рекламодатель, 5-Партнер
<element name="category" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Тип пользователя: 1-юр. лицо, 2-физ. лицо
<element name="type" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Логин для входа на страничку клиента
<element name="login" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Пароль для входа на страничку клиента
<element name="pass" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Комментарий
<element name="descr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Имяпользователя: ФИО/Названиекомпании
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Номертелефона
<element name="phone" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Номер факса
<element name="fax" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Адресэлектроннойпочты
<element name="email" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Наименованиебанка
<element name="bankname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//БИК
<element name="bik" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Расчетныйсчет
<element name="settl" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Корр. счет
<element name="corr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//КПП
<element name="kpp" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//ИНН
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 21 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="inn" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//ОГРН
<element name="ogrn" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//ОКПО
<element name="okpo" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//ОКВЕД
<element name="okved" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Ген. Директор
<element name="gendiru" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Главный бухгалтер
<element name="glbuhgu" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Контактное лицо
<element name="kontperson" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Действует на основании
<element name="actonwhat" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Серия паспорта
<element name="passsernum" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//№ паспорта
<element name="passno" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Дата выдачи паспорта
<element name="passissuedate" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Кем выдан паспорт
<element name="passissuedep" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Место выдачи паспорта
<element name="passissueplace" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Дата рождения
<element name="birthdate" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Месторождения
<element name="birthplace" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Метка времени последней модификации записи (только чтение)
<element name="lastmoddate" type="xsd:string" minOccurs="0" maxOccurs="1"/>
//Дата блокировки возможности активации карт оплаты (только чтение)
<element name="wrongdate" type="xsd:string" minOccurs="0" maxOccurs="1"/>
//ОКАТО
<element name="okato" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Доступ на страничку клиента только с ip адресов, указанных в учетных записях (флаг)
<element name="ipaccess" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Способ доставки счета: 0-курьер, 1-почтой, 2-самостоятельно, 3-другой, 4-email
<element name="billdelivery" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Код страны абонента по ОКСМ
<element name="oksm" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Запись является шаблоном пользователя (флаг)
<element name="templ" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Запись удалена (флаг)
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 22 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
// Имя абонента
<element name="abonentname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Фамилия абонента
<element name="abonentsurname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Отчество абонента
<element name="abonentpatronymic" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Форма собственности предприятия: 0 - не указано, 1 - ООО, 2 - ОАО, 3 - ЗАО
<element name="ownership" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
Объект soapAgreement
Объект представляет собой договор (лицевой счет) пользователя с
оператором. Используется при получении, изменении, добавлении одного
пользователя.
<complexType name="soapAgreement">
<sequence>
//id договора
<element name="agrmid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//id пользователя
<element name="uid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//id оператора, с которым заключен договор
<element name="operid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//id валюты договора
<element name="curid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Уведомлять обалансе
<element name="bnotify" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Договор удален
<element name="archive" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Количество у.з. на договоре, только чтение
<element name="vgroups" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//Текущий баланс лицевого счета
<element name="balance" type="xsd:double" minOccurs="1" maxOccurs="1"
//Размеркредита
<element name="credit" type="xsd:double" minOccurs="1" maxOccurs="1"/>
//Пороговое значение баланса для уведомления
<element name="blimit" type="xsd:double" minOccurs="1" maxOccurs="1"/>
// Статус договора по балансу
<element name="balancestatus" type="xsd:unsignedLong" minOccurs="0" maxOccurs="1"
default="0"/>
// Дата перехода через порог порога
<element name="balancelimitexceeded" type="xsd:string" minOccurs="0" maxOccurs="1"/>
//Номер договора
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 23 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="number" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Код оплаты для внешней системы
<element name="code" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Дата договора, в формате YYYY-MM-DD
<element name="date" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Дата расторжения договора
<element name="closedon" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
//Дата последней отправки уведомления о состоянии баланса
<element name="bcheck" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Начислять ли пеню?
<element name="penaltymethod" type="xsd:unsignedLong" minOccurs="0" maxOccurs="1"
default="0"/>
//Символ валюты договора
<element name="symbol" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>//
Дополнительная информация по договору
<element name="addons" type="lbapi:soapAgreementAddon" minOccurs="0"
maxOccurs="unbounded"/></sequence>
</complexType>
Объект soapAgreementAddon
Объект представляет собой дополнительную информацию по договору.
<complexType name="soapAgreement">
<sequence>
// Идентификатор договора
<element name="agrmid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Тип поля: 0 - текстовое, 1 - список значений
<element name="type" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Внутренний номер записи
<element name="idx" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Уникальное имя поля. Допустимые символы: a-zA-Z0-9-_
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Описание
<element name="descr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// значение доп.поля
<element name="strvalue" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence> </complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
ООО «Сетевые решения», 2011
__________________________________________________________________
Объект soapAccountFull
Объект предоставляет полную информацию о пользователе АСР, включая
списки договоров, адресов и групп пользователей. Используется при получении,
добавлении и изменении одного объекта.
<complexType name="soapAccountFull">
<sequence>
//Пользователь
<element name="account" type="lbapi:soapAccount" minOccurs="1" maxOccurs="1"/>
//Списокадресов
<element name="addresses" type="lbapi:soapAddressBrief" minOccurs="0"
maxOccurs="unbounded"/>
//Списокдоговоров
<element name="agreements" type="lbapi:soapAgreement" minOccurs="0"
maxOccurs="unbounded"/>
</sequence>
</complexType>
Объект soapAddressBrief
Объект предоставляет краткую информацию об адресе.
<complexType name="soapAddressBrief">
<sequence>
// Тип адреса: 0-Юр.адрес/адрес прописки, 1-Физ.адрес/адрес проживания, 2-Адрес доставки
счета
<element name="type" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Через запятую без пробелов идентификаторы страны, региона, района, города, нас. пункта,
улицы, дома, квартиры.
<element name="code" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Строковое представление, напр. «Россия,Респ Карелия,р-н Кондопожский,г Кондопога,,ул
Весенняя,дом 1,кв. 1» (заполняется автоматически на основании индексов КЛАДР)
<element name="address" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType
Определение функции
Получение одного пользователя. На вход подается id пользователя, на
выходе принимается объект soapAccountFull или exception (исключение).
<!-- operation request element -->
<element name="getAccount">
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 25 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<complexType>
<sequence>
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAccountResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAccountFull" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.getAccount.req.xml, api3.getAccount.res.xml
Функция insupdAccount
Добавление или изменение информации о пользователе.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAccountFull
Объект soapAccountFull документирован в описании функции getAccount.
Определение функции
Добавление нового или изменение существующего пользователя. На вход
подается флаг isInsert, (1 – добавление, 0 – изменение) и объект soapAccountFull, на
выходе принимается id записи в таблице accounts (uid) или exception. В списке
договоров пользователя должны приходить все текущие договора, причем
soapAgreement.agrmid должен быть нулевым для вновь добавленного договора и
ненулевым для измененного. Договора, которых нет в пришедшем списке,
помечаются как архивные.
Списки предыдущих адресов пользователя и групп, в которые он входит, удаляются
из БД, затем записываются новые значения.
<!-- operation request element →
<element name="insupdAccount">
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 26 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<complexType>
<sequence>
<element name="isInsert" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="val" type="lbapi:soapAccountFull" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="insupdAccountResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства api3.insupdAccount.req.xml
api3.insupdAccount.res.xml
Функция getPayments
Получение списка платежей
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapFilter
<complexType name="soapFilter">
<sequence>
// фильтр по договору
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="pgnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="pgsize" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// фильтр по userid
<element name="userid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// фильтр с даты
<element name="dtfrom" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// фильтр по дату
<element name="dtto" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
фильтр по идентификатору платежа/номера платежного поручения (строгое соответствие)
<element name="receipt" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 27 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</complexType>
Объект soapPayment
Объект представляет информацию о платеже.
<complexType name="soapPayment">
<sequence>
//Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1" default="0"/>
//Идентификатор лицевого счета, на который поступил платеж
<element name="agrmid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Идентификатор менеджера, проводившего платеж
<element name="modperson" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Идентификатор валюты платежа
<element name="currid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Идентификатор счета в `orders`, если проводилась оплата счета
<element name="orderid" type="xsd:long" minOccurs="1" maxOccurs="1" default="0"/>
//Статус платежа: 0-проведен, 1-проведен и подтвержден сверкой (при загрузке фала сверки),
//2-платежаннулирован
<element name="status" type="xsd:long" minOccurs="1" maxOccurs="1" default="0"/>
//Величина платежа в валюте лицевого счета
<element name="amount" type="xsd:double" minOccurs="1" maxOccurs="1"/>
//Дата платежа ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="paydate" type="xsd:string" minOccurs="1" maxOccurs="1" default=""/>
//Дата фактического проведения платежа по часам АСР ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="localdate" type="xsd:string" minOccurs="1" maxOccurs="1" default=""/>
//Дата аннулирования платежа (только для status=2) ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="canceldate" type="xsd:string" minOccurs="1" maxOccurs="1" default=""/>
//Идентификатор платежа/номер платежного поручения
<element name="receipt" type="xsd:string" minOccurs="1" maxOccurs="1" default=""/>
//Комментарий к платежу
<element name="comment" type="xsd:string" minOccurs="1" maxOccurs="1" default=""/>
// Идентификатор категории платежа
<element name="classid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор лицевого счёта
<element name="fromagrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Текущий номер ревизии платежа ( = 0 )
<element name="revno" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Количество ревизий
<element name="revisions" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Наименование класса платежа
<element name="classname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 28 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</complexType>
Объект soapPaymentFull
Объект представляет расширенную информацию о платеже.
<complexType name="soapPaymentFull">
<sequence>
//Запись из таблицы Payments
<element name="pay" type="lbapi:soapPayment" minOccurs="1" maxOccurs="1"/>
//Сумма платежа в валюте
<element name="amountcurr" type="xsd:double" minOccurs="1" maxOccurs="1"/>
//Номер счета, если это оплата счета
<element name="ordernum" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID пользователя
<element name="uid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID оператора
<element name="operid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Символ валюты
<element name="currsymb" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Имя пользователя
<element name="uname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Номер договора
<element name="agrm" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Имя менеджера
<element name="mgr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Имя оператора
<element name="opername" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Определение функции
Получение списка платежей. На вход подается фильтр, на выходе
принимается вектор объектов soapPaymentFull или exception (исключение).
В фильтре проверяются следующие поля:
if (flt.agrmid)
if (flt.userid)
if (!flt.receipt.empty())
if (!flt.dtfrom.empty())
if (!flt.dtto.empty())
//ID договора
//ID пользователя
//Идентификатор платежа, в данном случае проверяется
// также flt.agrmid
//Дата платежа больше или равна заданной
//Дата платежа меньше заданной
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 29 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<!-- operation request element -->
<element name="getPayments">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getPaymentsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapPaymentFull" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.getPayments.req.xml
api3.getPayments.res.xml
Функция getTarifsHistory
Получение истории смены тарифных планов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект TarifsHistory
Объект представляет информацию истории смены тарифного плана.
<complexType name="soapTarifsHistory">
<sequence>
<element name="recordid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// идентификатор учетной записи
<element name="vgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// идентификатор договора
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// идентификатор пользователя
<element name="uid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//ID агента
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 30 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="id" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// идентификатор нового ТП
<element name="taridnew" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// идентификатор старого ТП
<element name="taridold" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор менеджера, запросившего смену тарифа, или NULL, если смена была заказана
абонентом
<element name="requestby" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Запланированное время смены тарифа ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="rasptime" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Фактическое время смены тарифа ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="changed" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// логин учетной записи
<element name="vglogin" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// номер договора
<element name="agrmnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// код оплаты договора
<element name="code" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// имя пользователя
<element name="accname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Имя агента
<element name="agentname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Название нового ТП
<element name="tarnewname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Название старого ТП
<element name="taroldname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// менеджер, запланировавший смену (фио)
<element name="mgrname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// менеджер, запланировавший смену (описание)
<element name="mgrdescr" type="xsd:string" minOccurs="0" maxOccurs="1"
default=""/></sequence>
</complexType>
Определение функции
Получение истории смен тарифных планов.На вход подается soapFilter, на
выходе принимается вектор объектов soapTarifsHistory или exception (исключение).
В фильтре проверяются следующие поля:
flt.userid // Идентификатор пользователя
flt.dtfrom // Дата больше или равна заданной
flt.dtto // Дата меньше
flt.pgsize // Размер страницы
flt.pgnum // Номер страницы
<!-- operation request element -->
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 31 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="getTarifsHistory">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getTarifsHistoryResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapTarifsHistory" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением
данного
руководства:
api3.getTarifsHistory.req.xml,
api3.getTarifsHistory.res.xml
Функция insupdTarifsRasp
Добавление или изменение записи в расписание смены тарифов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapTarifsRasp
Объект представляет информацию о запланированной смене тарифа (запись
из таблицы Tarifs_rasp а так же необязательная текстовая информация о валюте,
названии тарифа и т.д.).
<complexType name="soapTarifsRasp">
<sequence>
//ID записи в таблице
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID учетной записи, для которой запланирована смена тарифа
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID договора
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//ID объединения, для которого запланирована смена тарифа. На текущий момент не
используется, ставим =0
<element name="groupid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 32 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
//ID агента
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID нового тарифа
<element name="taridnew" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID объединения по тарифу, для которого запланирована смена тарифа
<element name="taridold" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Запланированное время смены тарифа ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="changetime" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Идентификатор менеджера, создавшего правило смены, или NULL, если смена тарифа
заказана абонентом
<element name="requestby" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Определение функции
Добавление или изменение записи о запланированной смене тарифа. На
вход подается флаг isInsert, (1 – добавление, 0 – изменение) и объект soapTarifsRasp,
на выходе принимается id записи в таблице tarifs_rasp (doc_id) или exception. При
вызове необходимо указать val.id (ID агента) а также (опционально) один из
параметров val.vgid, val.groupid, val.taridold соответственно для назначения смены
тарифа по учетной записи, объединению учетных записей или объединению по
тарифу. В случае, если опциональные параметры не заданы, смена тарифа будет
назначена для всех учетных записей агента.
<!-- operation request element -->
<element name="insupdTarifsRasp">
<complexType>
<sequence>
<element name="isInsert" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="val" type="lbapi:soapTarifsRasp" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="insupdTarifsRaspResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 33 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.insupdTarifsRasp.req.xml
api3.insupdTarifsRasp.res.xml
Функция getCurrencies
Получение списка валют.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapCurrency
Объект представляет информацию о валюте.
<complexType name="soapCurrency">
<sequence>
//ID записи
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Флаг «Валюта по умолчанию»
<element name="def" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Символ валюты
<element name="symbol" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Наименование валюты
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Определение функции
Получение списка валют. На выходе принимается вектор объектов
soapCurrency или exception (исключение).
<!-- operation request element -->
<element name="getCurrencies">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getCurrenciesResponse">
<complexType>
<sequence>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 34 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="ret" type="lbapi:soapCurrency" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.getCurrencies.req.xml,
api3.getCurrencies.res.xml
Функция getPayClasses
Получение списка категорий платежей.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapPayClass
Объект представляет информацию о категории платежа.
<complexType name="soapPayClass">
<sequence>
// Идентификатор категории
<element name="classid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Название категории
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Описание категории
<element name="descr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Код для связки с внешней системой
<element name="externcode" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
Определение функции
Получение списка категорий платежей. На выходе принимается вектор
объектов soapCurrency или exception (исключение).
<complexType name="soapPayClass"> <!-- operation request element -->
<element name="getPayClasses">
<complexType>
<sequence>
</sequence>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 35 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</element>
<!-- operation response element -->
<element name="getPayClassesResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapPayClass" minOccurs="1" maxOccurs="unbounded"/>
</sequence> </complexType>
</element>
</complexType>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.getCurrencies.req.xml,
api3.getCurrencies.res.xml
Функция Payment
Проведение платежа
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapPayment
Объект описан в документации на функцию getPayments.
Определение функции
Проведение платежа (вызов функции `PAYMENT`). Используются
следующие поля объекта soapPayment:
Receipt
Paydate – если пустая, то используем текущую
Ordered
Agrmid
Modperson
Amount
Comment
fromagrmid
На выходе принимается 1 в случае успеха или exception.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 36 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<!-- operation request element -->
<element name="Payment">
<complexType>
<sequence>
<element name="val" type="lbapi:soapPayment" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="PaymentResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Пример использования функции в приведено в следующих документах, являющихся
приложением данного руководства: api3.Payment.req.xml, api3.Payment.res.xml
Функция getVgroup
Получение учетной записи
Описание объектов, поступающих в качестве параметров и
возвращаемых функцией
Объект soapVgroup
Объект предоставляет информацию об учетной записи (услуге).
<complexType name="soapVgroup">
<sequence>
//id записи
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор записи для связи с внешними системами
<element name="cuid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//id тарифа
<element name="tarid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//id договора
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 37 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
//id агента
<element name="id" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// id пользователя
<element name="uid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Ограничение полосы пропускания Кбит/с
<element name="shape" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Текущее значение полосы пропускания
<element name="currentshape" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Максимальное количество одновременных RADIUS сессий
<element name="maxsessions" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Запрос установления блокировки (см. blocked)
<element name="blkreq" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//блокировка
<element name="blocked" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//признаки изменения
<element name="changed" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//шаблон
<element name="templ" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Детализировать трафик по ресурсам (флаг)
<element name="ipdet" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Детализировать трафик по сервисам (флаг)
<element name="portdet" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Учетная запись удалена (флаг)
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="usercategory" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="checkduplicate" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Актуальность списаний по периодическим услугам или аренде (флаг)
<element name="dirty" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="connectedfrom" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Счетчик потребленной услуги для реализации граничения трафика за период
<element name="dlimit" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Величина общих списаний в текущем отчетном периоде в валюте тарифа
<element name="amount" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
<element name="accondatefirst" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Метка времени создания учетной записи
<element name="creationdate" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Время запланированного подключения уч. записи ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="accondate" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
//Время запланированного отключения уч. записи ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="accoffdate" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
//Описание учетной записи
<element name="descr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
//Логин для доступа к услуге
<element name="login" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
//Пароль для доступа к услуге
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 38 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="pass" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
Объект soapTarifsRasp
Объект предоставляет информацию о запланированной смене тарифа (запись
из таблицы tarifs_rasp).
<complexType name="soapTarifsRasp">
<sequence>
//ID записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID учетной записи, длякоторой запланирована смена тарифа (опционально)
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID договора
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
+
//ID объединения, для которого запланирована смена тарифа (опционально)
<element name="groupid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID учетной записи
<element name="uid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//ID агента, для учетных записей которого запланирована смена тарифа (обязательный параметр)
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID Новый тариф
<element name="taridnew" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID объединения по тарифу, для которого запланирована смена тарифа (опционально)
<element name="taridold" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID менеджера, создавшего правило смены, или NULL, если смена тарифа заказана абонентом
<element name="requestby" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Запланированное время смены тарифа ( в формате YYYY-MM-DD HH24:MI:SS)
<element name="changetime" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapIPMask
Объект предоставляет пару IP/mask, определяющую сетевой сегмент.
<complexType name="soapIPMask">
<sequence>
<element name="ip" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//IP
<element name="mask" type="xsd:unsignedInt" minOccurs="1" maxOccurs="1"/> //маска (1..32)
</sequence>
Объект soapStaff
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 39 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Объект предоставляет cетевой сегмент, назначенный учетной записи (запись
из таблицы staff)
<complexType name="soapStaff">
<sequence>
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID записи
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID учетнойзаписи
<element name="type" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Типсегмента: 0-IP подсеть,
1-номер AS, 2-номерпорта
<element name="ipmask" type="lbapi:soapIPMask" minOccurs="1" maxOccurs="1"/>
//Подсеть
</sequence>
</complexType>
Объект soapTelStaff
Объект предоставляет телефон/транк, назначенный учетной записи (запись из
таблицы tel_staff)
<complexType name="soapTelStaff">
<sequence>
//ID записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID учетнойзаписи
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Тип устройства: 0-телефон, 1-МТА, 2-транк
<element name="device" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Выход на МГ/МН направления (флаг)
<element name="ldservice" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Шаблон телефонного номера/транка
<element name="phonenumber" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Комментарий
<element name="comment" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapMacStaff
Объект предоставляет транспортный адрес, назначенный учетной записи (запись из
таблицы mac_staff)
<complexType name="soapMacStaff">
<sequence>
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//ID записи
//ID учетнойзаписи
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 40 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="segment" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
//Сегмент
<element name="mac" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Транспортныйадрес
</sequence>
</complexType>
Объект soapVgroupFull
Объект предоставляет полную информацию об учетной записи, включая
расписание смены тарифов, списки сегментов, телефонов и транспортных адресов.
Используется при получении, добавлении и изменении одного объекта.
<complexType name="soapVgroupFull">
<sequence>
//учетная запись
<element name="vgroup" type="lbapi:soapVgroup" minOccurs="1" maxOccurs="1"/>
//расписание смены тарифов
<element name="tarrasp" type="lbapi:soapTarifsRasp" minOccurs="0" maxOccurs="unbounded"/>
//сетевые сегменты
<element name="staff" type="lbapi:soapStaff" minOccurs="0" maxOccurs="unbounded"/>
//номера / транки
<element name="telstaff" type="lbapi:soapTelStaff" minOccurs="0" maxOccurs="unbounded"/>
//транспортные адреса
<element name="macstaff" type="lbapi:soapMacStaff" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
Определение функции
Получение одной учетной записи. На вход подается id, на выходе принимается
объект soapVgroupFull или exception (исключение).
<!-- operation request element -->
<element name="getVgroup">
<complexType>
<sequence>
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getVgroupResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapVgroupFull" minOccurs="1" maxOccurs="unbounded"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 41 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</sequence>
</complexType>
</element>
Пример использования функции в приведено в следующих документах, являющихся
приложением данного руководства:
Функция insupdVgroup
Добавление или изменение информации об учетной записи.
Описание объектов, поступающих в качестве параметров
и возвращаемых функцией
Объект soapVgroupFull
Объект soapVgroupFull документирован в описании функции getVgroup.
Определение функции
Добавление новой или изменение существующей учетной записи. На вход
подается флаг isInsert, (1 – добавление, 0 – изменение) и объект
soapVgroupFull, на выходе принимается id записи в таблице vgroups (vg_id)
или exception.
При добавлении новой учётной записи ее тариф должен быть занесен в
расписание (список tarrasp).
Список дополнительных полей у.з. удаляется из БД и заполняется новыми
значениями из addons.
Из списков расписаний смен тарифа (tarrasp), сегментов (staff), MAC-адресов
(macstaff)и телефонных номеров (telstaff), обновляются записи, у которых
определен recordid, добавляются записи с recordid=0, остальные удаляются из
соответствующих таблиц (tariffs_rasp, staff, mac_staff, tel_staff).
<!-- operation request element -->
<element name="insupdVgroup">
<complexType>
<sequence>
<element name="isInsert" type="xsd:long" minOccurs="1" maxOccurs="1"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 42 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="val" type="lbapi:soapVgroupFull" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="insupdVgroupResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Пример использования функции в приведено в следующих документах, являющихся
приложением данного руководства:
Функция getAgreements
Получение списка договоров.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapFilter
Объект используется как входной параметр для функций получения списков
объектов.
<complexType name="soapFilter">
<sequence>
// по «запись удалена (флаг)» 1-запись удалена
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по идентификатору договора
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по userid
<element name="userid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по номеру договора
<element name="agrmnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по коду оплаты
<element name="code" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 43 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Объект soapOrderby.
Объект soapOrderbyдокументирован в описании функции getStat.
Объект soapAgreement
Объект представляет информацию о договоре (запись из таблицы
Agreements). Описан выше.
Определение функции
Получение списка договоров. На вход подается soapFilter, на выходе
принимается вектор объектов soapAgreement или exception (исключение).
<!-- operation request element -->
<element name="getAgreements">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
<element name="ord" type="lbapi:soapOrderby" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAgreementsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAgreement" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением
данного
руководства:
api3.getAgreements.req.xml,api3.getAgreements.res.xml
Функция getAgents
Получение списка агентов. Агентом является сервис, который занимается
сбором статистики. Напр. Телефония, Интернет. http://www.lanbilling.ru/lbagents.html
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 44 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapIdName.
Объект представляет информацию об агенте (программе, которая занимается
тарификацией, сбором статистики, блокировкой учётных записей и прочим).
<complexType name="soapIdName">
<sequence>
// Идентификатор агента
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Имя агента
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Тип агента, может иметь следующие значения: 1-Eth/PCAP, 2-Eth/ULOG, 3-Eth/tee, 4-Netflow, 5SFlow, 6-RADIUS/DialUP, 7-PCDR, 8-PABX/RS232, 9-PABX/FIFO, 10-PABX/TCPclient, 11-PABX/TCPserver,
12-RADIUS/VoIP, 13-USBox, 14-SNMP
<element name="data" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
Определение функции
Получение списка агентов. На выходе принимается вектор объектов
soapIdName или exception (исключение).
<!-- operation request element -->
<element name="getAgents">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAgentsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapIdName" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства,: api3.getAgents.req.xml, api3.getAgents.res.xml
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 45 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Функция blkVgroup
Запрос на блокировку учетной записи.
Определение функции
Запрос на блокировку учетной записи. На вход подается идентификатор
учетной записи, тип блокировки, символьное значение «on/off»для указания
включить/выключить блокировку, на выходе принимается 1 в случае успеха или
exception (исключение).
<!-- operation request element -->
<element name="blkVgroup">
<complexType>
<sequence>
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Текущее состояние блокировки: 0-уч. запись активна, 1-заблокирована по балансу, 2пользователем, 3-администратором, 4-по балансу(активная блокировка), 5-лимит трафика, 10уч. запись отключена
<element name="blk" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="state" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="blkVgroupResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Пример использования функции приведено в следующих документах, являющихся
приложением данного руководства: api3.getOrders.req.xml, api3.getOrders.res.xml
Функция getAccounts
Получение списка абонентов.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 46 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Определение функции
Получение списка абонентов. На вход подаются объекты soapFilter и
soapOrderby, на выходе принимается вектор объектов soapAccount или exception
(исключение).
Объект soapFilter
Объект используется как входной параметр для функций получения списков
объектов. Все его поля являются необязательными, назначение тех или иных полей
будет дано при описании функций, использующих soapFilter.
<complexType name="soapFilter">
<sequence>
// по договору
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по «запись удалена (флаг)» 1-запись удалена
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по признаку «Запись является шаблоном»
<element name="istemplate" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
//Категория пользователя: 0-Абонент, 1-Оператор, 2-Дилер, 3-Правообладатель, 4Рекламодатель, 5-Партнер
<element name="category" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// по группе пользователей
<element name="ugroups" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по номеру договора
<element name="agrmnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по коду оплаты
<element name="code" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по email
<element name="email" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по ИНН
<element name="inn" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="login" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по имени
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по созвучным именам
<element name="namesound" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по номеру телефона
<element name="phone" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// логин учетной записи
<element name="vglogin" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 47 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</sequence>
</complexType>

nodata – при ненулевом значении объекты результата не заполняются
значениями, важно лишь их общее количество.
<element name="getAccounts">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
<element name="ord" type="lbapi:soapOrderby" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAccountsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAccountsListItem" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Объект soapAccountsListItem.
Объект представляет список абонентов.
<complexType name="soapAccountsListItem">
<sequence>
<element name="account" type="lbapi:soapAccountBrief" minOccurs="1" maxOccurs="1"/>
<element name="usergroups" type="lbapi:soapUsergroupFull" minOccurs="0"
maxOccurs="unbounded"/>
<element name="agreements" type="lbapi:soapAgreementBrief" minOccurs="0"
maxOccurs="unbounded"/>
<element name="addresses" type="lbapi:soapAddressBrief" minOccurs="0"
maxOccurs="unbounded"/>
</sequence>
</complexType>
Объект soapAccountBrief.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 48 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Объект представляет краткую информацию об абоненте.
<complexType name="soapAccountBrief">
<sequence>
// Идентификатор пользователя
<element name="uid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Кол-во учетных записей
<element name="vgcnt" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// //Тип пользователя: 1-юр. лицо, 2-физ. лицо
<element name="type" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Категория пользователя: 0-Абонент, 1-Оператор, 2-Дилер, 3-Правообладатель, 4Рекламодатель, 5-Партнер
<element name="category" type="xsd:long" minOccurs="1" maxOccurs="1"/>
//Признак того, что это оператор по умолчанию.
<element name="def" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// login
<element name="login" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Имя пользователя: ФИО/Название компании
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
//Комментарий
<element name="descr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// email
<element name="email" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// phone
<element name="phone" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapUsergroupFull.
Объект расширенного описания объединения учетных записей.
<complexType name="soapUsergroupFull">
<sequence>
// Идентификатор объединения
<element name="usergroup" type="lbapi:soapUsergroup" minOccurs="1" maxOccurs="1"/>
<element name="uids" type="lbapi:soapLong" minOccurs="0" maxOccurs="unbounded"/>
<element name="usercnt" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="fread" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="fwrite" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 49 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Объект soapUsergroup.
Объект описывает объединения учетных записей.
<complexType name="soapUsergroup">
<sequence>
// Идентификатор группы
<element name="groupid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Разрешить обещанный платеж для группы пользователей
<element name="promiseallow" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Приравнять максимальную сумму платежа к АП (флаг)
<element name="promiserent" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Срок погашения платежа с момента заказа (дни)
<element name="promisetill" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="curid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Максимальная сумма платежа (р.е)
<element name="promisemax" type="xsd:double" minOccurs="0" maxOccurs="1"
default="0.000000"/>
// Минимальная сумма платежа (р.е)
<element name="promisemin" type="xsd:double" minOccurs="0" maxOccurs="1"
default="0.000000"/>
// Количество одновременных платежей
<element name="promiselimit" type="xsd:double" minOccurs="0" maxOccurs="1"
default="0.000000"/>
// Сумма срабатывания критерия
<element name="blockamount" type="xsd:double" minOccurs="0" maxOccurs="1" default="1.000000"/>
// Время срабатывания критерия для признания задолженности по договору (дни)
<element name="blockdurationdebtor" type="xsd:unsignedLong" minOccurs="0" maxOccurs="1"
default="0"/>
// Время срабатывания критерия для признания договора на расторжении (дни)
<element name="blockdurationdenouncement" type="xsd:unsignedLong" minOccurs="0"
maxOccurs="1" default="0"/>
// Имя
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Описание
<element name="description" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
Объект soapAgreementBrief.
Объект представляет краткую информацию об лицевом счете.
<complexType name="soapAgreementBrief">
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 50 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<sequence>
// Идентификатор договора
<element name="agrmid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="defcurr" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="isauto" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Текущий баланс лицевого счета
<element name="balance" type="xsd:double" minOccurs="1" maxOccurs="1"/>
<element name="ppdebt" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
// Номер договора
<element name="number" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Символ валюты
<element name="symbol" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Код оплаты
<element name="code" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<element name="opername" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressBrief.
Объект
<complexType name="soapAddressBrief">
<sequence>
// Тип адреса: 0-Юр.адрес/адрес прописки, 1-Физ.адрес/адрес проживания, 2-Адрес доставки
счета
<element name="type" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификаторы адреса (Страна, регион, город, улица)
<element name="code" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Адрес в текстовом представлении (заполняется автоматически на основании индексов КЛАДР)
<element name="address" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Функция getVgroups
Получение списка учётных записей.
Определение функции
Получение списка учётных записей. На вход подаются объекты soapFilter и
soapOrderby, на выходе принимается вектор объектов soapVgroupBrief или exception
(исключение).
Должны поддерживаться следующие параметры soapFilter:
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 51 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Объект soapFilter
Объект используется как входной параметр для функций получения списков
объектов. Все его поля являются необязательными, назначение тех или иных полей
будет дано при описании функций, использующих soapFilter.
<complexType name="soapFilter">
<sequence>
// номер страницы вывода
<element name="pgnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// размер страницы вывода (в строках)
<element name="pgsize" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по договору
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по «запись удалена (флаг)» 1-запись удалена
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по признаку «Запись является шаблоном»
<element name="istemplate" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по группе пользователей
<element name="ugroups" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по номеру договора
<element name="agrmnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по коду оплаты
<element name="code" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по email
<element name="email" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по ИНН
<element name="inn" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="login" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по имени
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по созвучным именам
<element name="namesound" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// по номеру телефона
<element name="phone" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
//
<element name="vglogin" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
Объект soapVgroupBrief
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 52 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<complexType name="soapVgroupBrief">
<sequence>
// Идентификатор учетной записи
<element name="vgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="parentvgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор агента, которому принадлежит учетная запись
<element name="id" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор тарифа
<element name="tarid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор лицевого счета, средства которого расходуются при оказании услуги
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Запрос установления блокировки (см. blocked)
<element name="blkreq" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Текущее состояние блокировки: 0-уч. запись активна, 1-заблокирована по балансу, 2пользователем, 3-администратором, 4-по балансу(активная блокировка), 5-лимит трафика, 10уч. запись отключена
<element name="blocked" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="canmodify" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор пользователя, которому принадлежит учетная запись (индекс)
<element name="uid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Тип агента
<element name="agenttype" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="usercategory" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор записи для связи с внешними системами
<element name="cuid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Актуальность списаний по периодическим услугам или аренде
<element name="dirty" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Баланс
<element name="balance" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
<element name="ppdebt" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
// Счетчик потребленной услуги для реализации граничения трафика за период
<element name="dlimit" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Дата последнего обнуления счетчика d_limit ( в формате YYYY-MM-DD)
<element name="dclear" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Логин для доступа к услуге
<element name="login" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Описание учетной записи
<element name="descr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Номер договора
<element name="agrmnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="code" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="username" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Дата создания
<element name="creationdate" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Время запланированного подключения уч. записи
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 53 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="accondate" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Время запланированного отключения уч. записи
<element name="accoffdate" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Дата последнего изменения состояния блокировки
<element name="blockdate" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Описание агента
<element name="agentdescr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Описание тарифа
<element name="tarifdescr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Символ валюты
<element name="symbol" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="parentvglogin" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Адрес
<element name="address" type="lbapi:soapAddressBrief" minOccurs="0"
maxOccurs="unbounded"/>
</sequence>
</complexType>
Функция getTarifsExt
Получение списка тарифов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapTarifs.
Объект представляет информацию о тарифе.
<complexType name="soapTarif">
<sequence>
// Идентификатор тарифа
<element name="tarid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Актуальный идентификатор тарифа
<element name="actualtarid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор родительского тарифа, если это субтариф. Если это не субтариф - то 0
<element name="parentid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Ограничение полосы пропускания Кбит/с
<element name="shape" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Ограничение потребления трафика за период в Мб для type=0,1 или Мин для type=2 (0-нет
ограничений)
<element name="trafflimit" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Период в днях, на который установлено ограничение traff_limit (0-календарный месяц)
<element name="trafflimitper" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Тип тарифа: 0-кабельный агент, 1-RADIUS по объему, 2-RADIUS по времени, 3-Классическая
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 54 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
телефония, 4-VoIP, 5-Периодические и разовые услуги
<element name="type" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Применять автоматическую блокировку услуги: 0-нет, 1-да, 2-применять активную блокировку
<element name="actblock" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// 1 – тариф удалён
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Денежный план: 0-служебный, 1-население, 2-хозрасчет, 3-бюджет (информационное поле)
<element name="priceplan" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Тарифицируемый трафик для кабельных агентов: 1-вх., 2-исх., 3-сумма, 4-превалирующий
<element name="trafftype" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Списывать аренду равномерно каждый день (флаг). По умолчанию - разовое списание в
начале месяца
<element name="dailyrent" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Алгоритм расчёта арендной платы
<element name="dynamicrent" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Приоритет правил изменения пропускной способности: 0-min значение, 1-по объему, 2-по
времени, 3-max значение
<element name="shapeprior" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Тариф не доступен для назначения учетным записям (флаг)
<element name="unavaliable" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Для телефонии: списывать абон. плату пропорционально количеству присвоенных номеров
(флаг)
<element name="rentmultiply" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Тарифицировать входящие звонки: 0-нет, 1-по номеру А, 2-по номеру Б
<element name="chargeincoming" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор валюты тарифа
<element name="curid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Тариф был назначен учетной записи (флаг)
<element name="used" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Блокировать направления, не найденные в каталоге
<element name="voipblocklocal" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Динамическая маршрутизация VoIP звонков: 0-не использовать, 1-LCR, 2-MWR
<element name="dynroute" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Время автоматического отключения заблокированных учётных записей в сутках
<element name="blockrentduration" type="xsd:unsignedLong" minOccurs="0" maxOccurs="1"
default="0"/>
// Величина аренды в валюте тарифа
<element name="rent" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
// Величина аренды при блокировке (адм. или по балансу) в валюте тарифа
<element name="blockrent" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
// Коэффициент нижней границы стоимости
<element name="coeflow" type="xsd:double" minOccurs="0" maxOccurs="1" default="1.000000"/>
// Коэффициент верхней границы стоимости
<element name="coefhigh" type="xsd:double" minOccurs="0" maxOccurs="1" default="1.000000"/>
// Минимальная сумма списания для тарифа
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 55 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="minsum" type="xsd:double" minOccurs="0" maxOccurs="1" default="0.000000"/>
<element name="catnumbers" type="lbapi:soapLong" minOccurs="0" maxOccurs="unbounded"/>
// Описание тарифа
<element name="descr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Строковое представление валюты
<element name="symbol" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
Объект soapTarifsExt.
Объект представляет информацию о тарифе.
<complexType name="soapTarifExt">
<sequence>
// Информация о тарифе
<element name="tarif" type="lbapi:soapTarif" minOccurs="1" maxOccurs="1"/>
// Количество учётных записей, использующих этот тариф
<element name="vgroups" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Определение функции
Получение списка тарифов. На вход подаются параметры archive (1 –
возвращать удалённые тарифы), unavail (при значении, отличном от -1, возвращает
тарифы, недоступные для назначения учётной записи), formanager (при ненулевом
значении возвращает тарифы для менеджера с этим идентификатором), на выходе
принимается вектор объектов soapTarifExt или exception (исключение).
<!-- operation request element -->
<element name="getTarifsExt">
<complexType>
<sequence>
// Тариф удален (флаг)
<element name="archive" type="xsd:long" minOccurs="1" maxOccurs="1" default="0"/>
// Тариф не доступен для назначения учетным записям (флаг)
<element name="unavail" type="xsd:long" minOccurs="1" maxOccurs="1" default="-1"/>
<element name="formanager" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getTarifsExtResponse">
<complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 56 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<sequence>
<element name="ret" type="lbapi:soapTarifExt" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция Count
Получение количества результатов выполнения функции procname с
заданными параметрами фильтра flt.
Определение функции
Получение количества результатов выполнения функции procname с
заданными параметрами фильтра flt. На вход подаются procname (например,
«getAccounts») и объект soapFilter, на выходе принимается количество результатов
выполнения функции или exception (исключение).
<!-- operation request element -->
<element name="Count">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
<element name="procname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="CountResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Функция getTarifsRasp
Получение расписания смены тарифных планов.
Объект soapFilter
<complexType name="soapFilter">
<sequence>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 57 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
// по агенту
<element name="agentid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// по идентификатору записи
<element name="vgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
Определение функции
Получение расписания смены тарифных планов. На вход подаётся объект
soapFilter, в котором проверяются поля agentid и vgid. Если значения этих полей
равны нулю или присутствуют значения других полей, функция должна вернуть SOAP
LOGIC_ERROR. Иначе на выходе принимается список объектов soapTarifsRasp или
exception (исключение).
<!-- operation request element -->
<element name="getTarifsRasp">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getTarifsRaspResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapTarifsRasp" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getOptions
Получение различного рода опций.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapOption.
Объект представляет информацию об опции.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 58 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<complexType name="soapOption">
<sequence>
// Название опции
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Описание опции
<element name="descr" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Значение опции
<element name="value" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Определение функции
Получение различного рода опций. Функция используется в том числе для
получения шаблонов нумерации договоров. Имена таких опций начинаются с
«agrmnum_template_». На выходе принимается список объектов soapOption или
exception (исключение).
<!-- operationrequestelement -->
<elementname="getOptions">
<complexType>
<sequence>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getOptionsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapOption" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAutoAgreementNumber
Получение номера договора согласно указанному шаблону номеров
договора.
Определение функции
Получение номера договора согласно указанному шаблону номеров
договора. На вход принимается шаблон номера договора, на выходе принимается
новый номер договора или exception (исключение).
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 59 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<!-- operation request element -->
<element name="getAutoAgreementNumber">
<complexType>
<sequence>
<element name="templ" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAutoAgreementNumberResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Функция getSessionsRadius
Получение списка сессий заданной учётной записи абонента.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapFilter
<complexType name="soapFilter">
<sequence>
// Идентификатор агента
<element name="agentid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Номер страницы
<element name="pgnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Размер страницы
<element name="pgsize" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор учетной записи
<element name="vgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
Объект soapSessionRadius.
Объект представляет информацию о сессий.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 60 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<complexType name="soapSessionRadius">
<sequence>
// Идентификатор агента
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор учетной записи
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Административный запрос на разрыв сессии (флаг)
<element name="stopreq" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Направление звонка: 0-вх., 1-исх. (для VoIP), признак гостевой сети (DialUp)
<element name="direction" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// IP адрес сервера доступа в целочисленном представлении
<element name="nas" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Значение ограничения полосы пропускания на момент авторизации
<element name="shape" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Присвоенный IP адрес в целочисленном представлении
<element name="assignedip" type="xsd:unsignedLong" minOccurs="1" maxOccurs="1"/>
// Время начала сессии (время получения Accounting Start)
<element name="starttime" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Идентификатор радиус сессии
<element name="sessionid" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Значение атрибута Calling-Station-Id, либо Tunnel-Client-End (для vpdn)
<element name="sessani" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Значение атрибута Called-Station-Id, либо Tunnel-Server-End (для vpdn)
<element name="sessdnis" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Время последней успешной аутентификации
<element name="authmoment" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Время последнего Accounting Update пакета (для VoIP)
<element name="updatetime" type="xsd:string" minOccurs="1" maxOccurs="1"/> </sequence>
</complexType>
Определение функции
Получение списка сессий заданной учётной записи абонента. На вход
принимается идентификатор агента, идентификатор учетной записи, размера
страницы и номера страницы, на выходе возвращается данные о сессиях или
exception (исключение).
<!-- operation request element -->
<element name="getSessionsRadius">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="1" maxOccurs="1"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 61 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getSessionsRadiusResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapSessionRadius" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция stopSessionsRadius
Принудительное завершение текущей сессий учётной записи абонента.
Определение функции
Принудительное завершение текущей сессий учётной записи абонента. На
вход принимается идентификатор агента или идентификатор сессии, на выходе
результат или exception (исключение).
<!-- operation request element -->
<element name="stopSessionsRadius">
<complexType>
<sequence>
// Идентификатор агента
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор сессии.
<element name="sessionid" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="stopSessionsRadiusResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 62 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Функция insupdUsboxService
Назначить / изменить периодическую или разовую услугу.
Определение функции
Назначение / изменение услуги. На вход подается объект UsboxService. Если isInsert =
1, то создаются новая запись, иначе изменяется существующая, на выходе
принимается 1 в случае успеха или exception (исключение).
Объект soapUsboxService
Объект представляет информацию о разовой / периодической услуге..
<complexType name="soapUsboxService">
<sequence>
// Идентификатор записи
<element name="servid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор учетной записи
<element name="vgid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор тарифа USBox типа
<element name="tarid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор категории тарифа (услуги)
<element name="catidx" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Необходимость тарификации записи (флаг): 1-тарифицировать запись, 0-не тарифицировать, 1-удалить запись и аннулировать списания
<element name="needcalc" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Запрет повторного назначения услуги
<element name="noduplicate" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// В каком количестве оказана услуга (множитель для стоимости услуги из тарифа)
<element name="mul" type="xsd:double" minOccurs="1" maxOccurs="1"/>
//Идентификатор менеджера, назначившего услугу. NULL - услуга назначена самим абонентом.
<element name="personid" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Комментарий
<element name="comment" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Дата назначения услуги (создания записи) в формате YYYY-MM-DD HH24:MI:SS
<element name="created" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Дата начала оказания услуги в формате YYYY-MM-DD HH24:MI:SS
<element name="timefrom" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Дата завершения оказания услуг в формате YYYY-MM-DD HH24:MI:SS
<element name="timeto" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Для хранения абстрактных данных внешних приложений
<element name="externaldata" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 63 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<!-- operation request element -->
<element name="insupdUsboxService">
<complexType>
<sequence>
<element name="isInsert" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="val" type="lbapi:soapUsboxService" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="insupdUsboxServiceResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Функция getUsboxServices
Получение списка сессий заданной учётной записи абонента.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapFilter
<complexType name="soapFilter">
<sequence>
// Идентификатор договора
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор категори тарифа (уникален в рамках тарифа)
<element name="category" type="xsd:long" minOccurs="0" maxOccurs="1" default="-1"/>
// Тип услуги: 0-разовая,1-переодич. с ежемесяч. списанием,2-ежеднев.,3-ежеднев. равными
долями
<element name="common" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Номер страницы
<element name="pgnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Размер страницы
<element name="pgsize" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор записи
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 64 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="recordid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор тарифа
<element name="tarid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор пользователя
<element name="userid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор учетной записи
<element name="vgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Номер договора
<element name="agrmnum" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Дата начала оказания услуги (в формате YYYY-MM-DD HH24:MI:SS)
<element name="dtfrom" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Дата завершения оказания услуги (в формате YYYY-MM-DD HH24:MI:SS)
<element name="dtto" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Логин для доступа к услуге
<element name="login" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Описание
<element name="descr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
Объект soapUsboxServiceFull.
Объект представляет информацию периодической / разовой услуге.
<complexType name="soapUsboxServiceFull">
<sequence>
// Идентификатор записи
<element name="service" type="lbapi:soapUsboxService" minOccurs="1" maxOccurs="1"/>
<element name="used" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор договора
<element name="agrmid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор пользователя
<element name="uid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Тип услуги: 0-разовая,1-переодич. с ежемесяч. списанием,2-ежеднев.,3-ежеднев. равными
долями
<element name="common" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Стоимость услуги в данной категории (в валюте тарифа)
<element name="catabove" type="xsd:double" minOccurs="0" maxOccurs="1"
default="0.000000"/>
// Номер договора
<element name="agrmnumber" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Имя пользователя
<element name="username" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Логин для доступа к услуге
<element name="vglogin" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 65 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
// Описание тарифа
<element name="tardescr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Описание категории
<element name="catdescr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Имя менеджера, назначившего услугу. NULL - услуга назначена самим абонентом.
<element name="personname" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
</sequence>
</complexType>
Объект soapUsboxService.
Объект представляет информацию периодической / разовой услуге.
Описание приведено в описании функции getUsboxServices.
Определение функции
Получение списка периодических и разовых услуг. На вход принимается
soapFilter, на выходе возвращается данные об услугах или exception (исключение).
<!-- operation request element -->
<element name="getUsboxServices">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
<element name="ord" type="lbapi:soapOrderby" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getUsboxServicesResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapUsboxServiceFull" minOccurs="1"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 66 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Функция delUsboxService
Удаление периодической / разовой услуги.
Определение функции
Удаление периодической / разовой услуги. На вход принимается
идентификатор услуги, на выходе результат или exception (исключение).
<!-- operation request element -->
<element name="delUsboxService">
<complexType>
<sequence>
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="delUsboxServiceResponse">
<complexType>
<sequence>
<element name="ret" type="xsd:long" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
Функция getTarCategories
Получение списка тарифных категорий.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapFilter
<complexType name="soapFilter">
<sequence>
// Идентификатор тарифа
<element name="tarid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор учетной записи
<element name="vgid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Номер страницы
<element name="pgnum" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 67 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
// Размер страницы
<element name="pgsize" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
Объект soapTarCategory.
Объект представляет информацию о тарифной категории.
<complexType name="soapTarCategory">
<sequence>
// Идентификатор тарифа
<element name="tarid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="catid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор категори тарифа (уникален в рамках тарифа)
<element name="catidx" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="catidxmaster" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Величина услуги, включенной в абон. плату (Мб или мин)
<element name="includes" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Трафик по категории включен в "общий счетчик" (флаг). Для USBox - тип услуги: 0-разовая,1переодич. с ежемесяч. списанием, 2-ежеднев., 3-ежеднев. равными долями
<element name="common" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Приоритет применения скидок: 0-min стоимость, 1-по объему, 2-по времени, 3-max стоимость
<element name="disprior" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Категория удалена (флаг)
<element name="archive" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор оператора
<element name="operid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Порог нетарифицируемого звонка (сек)
<element name="freeseconds" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Минимальная длительность звонка после округления (сек)
<element name="minchargedur" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Округлять с точностью до... (сек)
<element name="roundseconds" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Сервис, описываемый категорией, включен в подписку по умолчанию
<element name="enabled" type="xsd:long" minOccurs="0" maxOccurs="1" default="1"/>
// Возможность назначать/отменять подписку на сервис из клиентского интерфейса
<element name="available" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
<element name="permabove" type="xsd:double" minOccurs="0" maxOccurs="1"
default="0.000000"/>
<element name="above" type="xsd:double" minOccurs="1" maxOccurs="1"/>
// Описание категории
<element name="descr" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Код для связки с внешней системой
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 68 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="uuid" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Скрипт, выполняемый при назначении услуги (cmd:scriptname или mysql:scriptname), на вход
скрипта подается serv_id
<element name="script" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
<element name="saledictionaryid" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence> </complexType>
Определение функции
Получение списка тарифных категорий. На вход принимается id –
идентификатор тарифа, soapFilter, на выходе возвращается данные о тарифных
категориях или exception (исключение).
<!-- operation request element -->
<element name="getTarCategories">
<complexType>
<sequence>
<element name="id" type="xsd:long" minOccurs="1" maxOccurs="1"/>
<element name="flt" type="lbapi:soapFilter" minOccurs="0" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getTarCategoriesResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapTarCategory" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAddressCountries
Получение списка стран из справочника адресов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект AddressCountry
<complexType name="soapAddressCountry">
<sequence>
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 69 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</sequence>
</complexType>
Определение функции
Получение списка стран. На входе soapAddressFilter На выходе принимается
вектор объектов soapAddressCountry или exception (исключение).
<!-- operation request element -->
<element name="getAddressCountries">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAddressCountriesResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAddressCountry" minOccurs="1"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAddressRegions
Получение списка регионов из справочника адресов.
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 70 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAddressRegion
<complexType name="soapAddressRegion">
<sequence>
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Название
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Сокращенное название
<element name="shortname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Текстовое представление
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</complexType>
Определение функции
Получение списка регионов. На входе soapAddressFilter. На выходе
принимается вектор объектов soapAddressRegion или exception (исключение).
<!-- operation request element -->
<element name="getAddressRegions">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 71 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="getAddressRegionsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAddressRegion" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAddressAreas
Получение списка районов из справочника адресов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAddressArea
<complexType name="soapAddressArea">
<sequence>
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор района
<element name="region" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Название
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Сокращенное название
<element name="shortname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Текстовое представление
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 72 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Определение функции
Получение списка районов. На входе soapAddressFilter. На выходе
принимается вектор объектов soapAddressArea или exception (исключение).
<!-- operation request element -->
<element name="getAddressAreas">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAddressAreasResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAddressArea" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAddressCities
Получение списка городов из справочника адресов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAddressCity
<complexType name="soapAddressCity">
<sequence>
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор района
<element name="area" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Название
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Сокращенное название
<element name="shortname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 73 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор района
<element name="area" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Текстовое представление
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</complexType>
Определение функции
Получение списка городов. На входе soapAddressFilter. На выходе
принимается вектор объектов soapAddressCity или exception (исключение).
<!-- operation request element -->
<element name="getAddressCities">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAddressCitiesResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAddressCity" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 74 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Функция getAddressSettles
Получение списка населенных пунктов из справочника адресов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAddressSettle
<complexType name="soapAddressSettle">
<sequence>
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор района
<element name="area" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор города
<element name="city" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Название
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Сокращенное название
<element name="shortname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор района
<element name="area" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор города
<element name="city" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Текстовое представление
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 75 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
Определение функции
Получение списка населенных пунктов. На входе soapAddressFilter. На
выходе принимается вектор объектов soapAddressSettle или exception
(исключение).
<!-- operation request element -->
<element name="getAddressSettles">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAddressSettlesResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAddressSettle" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAddressStreets
Получение списка улиц из справочника адресов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAddressStreet
<complexType name="soapAddressStreet">
<sequence>
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор города
<element name="city" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор населенного пункта
<element name="settl" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Почтовый индекс
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 76 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="idx" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Название
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Сокращенное название
<element name="shortname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор района
<element name="area" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор города
<element name="city" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор населенного пункта
<element name="settl" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Текстовое представление
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</complexType>
Определение функции
Получение списка улиц. На входе soapAddressFilter. На выходе принимается
вектор объектов soapAddressStreet или exception (исключение).
<element name="getAddressStreets">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAddressStreetsResponse">
<complexType>
<sequence>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 77 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<element name="ret" type="lbapi:soapAddressStreet" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAddressFlats
Получение списка квартир из справочника адресов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAddressFlat
<complexType name="soapAddressFlat">
<sequence>
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор дома
<element name="building" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Принятое сокращение из справочника сокращений `address_meaning`
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Сокращенное название
<element name="shortname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Номер корпуса
<element name="block" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор страны
<element name="country" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор региона
<element name="region" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// Идентификатор района
<element name="area" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор города
<element name="city" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор населенного пункта
<element name="settl" type="xsd:long" minOccurs="1" maxOccurs="1"/>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 78 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
// Идентификатор улицы
<element name="street" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Идентификатор дома
<element name="building" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Текстовое представление
<element name="name" type="xsd:string" minOccurs="0" maxOccurs="1" default=""/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</complexType>
Определение функции
Получение списка квартир. На входе soapAddressFilter. На выходе
принимается вектор объектов soapAddressFlat или exception (исключение).
<element name="getAddressFlats">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
</element>
<!-- operation response element -->
<element name="getAddressFlatsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAddressFlat" minOccurs="1" maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
Функция getAddressMeanings
Получение списка сокращений из справочника адресов.
Описание объектов, поступающих в качестве параметров и возвращаемых
функцией
Объект soapAddressMeaning
<complexType name="soapAddressMeaning">
<sequence>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 79 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
// Идентификатор записи
<element name="recordid" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Сокращение для региона (флаг)
<element name="level1" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Сокращение для района (флаг)
<element name="level2" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Сокращение для города (флаг)
<element name="level3" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Сокращение для населенного пункта (флаг)
<element name="level4" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Сокращение для улицы (флаг)
<element name="level5" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Сокращение для дома (флаг)
<element name="level6" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Сокращение для квартиры (флаг)
<element name="level7" type="xsd:long" minOccurs="1" maxOccurs="1"/>
// Полное название
<element name="name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
// Сокращение
<element name="shortname" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
Объект soapAddressFilter
<complexType name="soapAddressFilter">
<sequence>
// Идентификатор сокращения
<element name="level" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
// при ненулевом значении объекты результата не заполняются значениями, важно лишь их
общее количество
<element name="nodata" type="xsd:long" minOccurs="0" maxOccurs="1" default="0"/>
</complexType>
Определение функции
Получение списка сокращений. На входе soapAddressFilter. На выходе
принимается вектор объектов soapAddressFlat или exception (исключение).
<element name="getAddressMeanings">
<complexType>
<sequence>
<element name="flt" type="lbapi:soapAddressFilter" minOccurs="1" maxOccurs="1"/>
</sequence>
</complexType>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 80 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</element>
<!-- operation response element -->
<element name="getAddressMeaningsResponse">
<complexType>
<sequence>
<element name="ret" type="lbapi:soapAddressMeaning" minOccurs="1"
maxOccurs="unbounded"/>
</sequence>
</complexType>
</element>
ПРИЛОЖЕНИЕ №1
Примеры использования функций API
В примерах описаний функцийAPI ПРИЛОЖЕНИЯ №1, дано содержание
тэга<SOAP-ENV:Body>, который входит в стандартный для всех функций тэг <SOAPENV:Envelope>, так как это представлено ниже:
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:lbapi="urn:api3">
<SOAP-ENV:Body>
…
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
lbapi.blkVgroup.req.xml
<SOAP-ENV:Body>
<lbapi:blkVgroup>
<id>0</id>
<blk>0</blk>
<state></state>
</lbapi:blkVgroup>
</SOAP-ENV:Body>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 81 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
lbapi.blkVgroup.res.xml
<SOAP-ENV:Body>
<lbapi:blkVgroupResponse>
<ret>0</ret>
</lbapi:blkVgroupResponse>
</SOAP-ENV:Body>
lbapi.Count.req.xml
<SOAP-ENV:Body>
<lbapi:Count>
<flt>
<activated>0</activated>
<addresstype>1</addresstype>
<agentid>0</agentid>
<agrmid>0</agrmid>
<archive>0</archive>
<appid>0</appid>
<asnum>0</asnum>
<blocked>0</blocked>
<catid>0</catid>
<category>-1</category>
<curid>-1</curid>
<common>0</common>
<defaultonly>0</defaultonly>
<deviceid>0</deviceid>
<direction>0</direction>
<docid>0</docid>
<durfrom>0</durfrom>
<durto>0</durto>
<groupid>0</groupid>
<groups>0</groups>
<istemplate>0</istemplate>
<mgrid>-1</mgrid>
<needcalc>-1</needcalc>
<nodata>0</nodata>
<notgroups>0</notgroups>
<onfly>0</onfly>
<operid>0</operid>
<orderid>0</orderid>
<ordernum>0</ordernum>
<payed>-1</payed>
<parentid>-1</parentid>
<personid>0</personid>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 82 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<pgnum>0</pgnum>
<pgsize>0</pgsize>
<port>0</port>
<postmanid>0</postmanid>
<proto>0</proto>
<recordid>0</recordid>
<repdetail>0</repdetail>
<repnum>0</repnum>
<setid>0</setid>
<shape>0</shape>
<showdefault>0</showdefault>
<tarid>0</tarid>
<parenttarid>-1</parenttarid>
<taridprev>0</taridprev>
<tartype>0</tartype>
<type>0</type>
<ugroups>0</ugroups>
<unavail>-1</unavail>
<userid>0</userid>
<vgid>0</vgid>
<payhistory>0</payhistory>
<hasregistry>-1</hasregistry>
<amountfrom>0.000000</amountfrom>
<amountto>0.000000</amountto>
<address></address>
<addresscode></addresscode>
<agrmnum></agrmnum>
<ani></ani>
<cardkey></cardkey>
<code></code>
<descr></descr>
<dstip></dstip>
<dtcreated></dtcreated>
<dtactivated></dtactivated>
<dtfrom></dtfrom>
<dtto></dtto>
<email></email>
<inn></inn>
<ip></ip>
<login></login>
<name></name>
<namesound></namesound>
<numfrom></numfrom>
<numto></numto>
<phone></phone>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 83 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<receipt></receipt>
<responsible></responsible>
<serno></serno>
<status></status>
<tardescr></tardescr>
<telstaff></telstaff>
<telnum></telnum>
<vglogin></vglogin>
<uuid></uuid>
<searchtempl></searchtempl>
</flt>
<procname></procname>
</lbapi:Count>
</SOAP-ENV:Body>
lbapi.Count.res.xml
<SOAP-ENV:Body>
<lbapi:CountResponse>
<ret>0</ret>
</lbapi:CountResponse></SOAP-ENV:Body>
lbapi.getAccount.req.xml
<SOAP-ENV:Body>
<lbapi:getAccount>
<id>0</id>
</lbapi:getAccount>
</SOAP-ENV:Body>
lbapi.getAccount.res.xml
<SOAP-ENV:Body>
<lbapi:getAccountResponse>
<ret>
<account>
<uid>0</uid>
<ipaccess>0</ipaccess>
<billdelivery>0</billdelivery>
<category>0</category>
<type>0</type>
<oksm>0</oksm>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 84 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<templ>0</templ>
<archive>0</archive>
<login></login>
<pass></pass>
<descr></descr>
<name></name>
<phone></phone>
<fax></fax>
<email></email>
<bankname></bankname>
<bik></bik>
<settl></settl>
<corr></corr>
<kpp></kpp>
<inn></inn>
<ogrn></ogrn>
<okpo></okpo>
<okved></okved>
<gendiru></gendiru>
<glbuhgu></glbuhgu>
<kontperson></kontperson>
<actonwhat></actonwhat>
<passsernum></passsernum>
<passno></passno>
<passissuedate></passissuedate>
<passissuedep></passissuedep>
<passissueplace></passissueplace>
<birthdate></birthdate>
<birthplace></birthplace>
<lastmoddate></lastmoddate>
<okato></okato>
</account>
<addresses>
<type>0</type>
<code></code>
<address></address>
</addresses>
<agreements>
<agrmid>0</agrmid>
<uid>0</uid>
<operid>0</operid>
<curid>0</curid>
<bnotify>0</bnotify>
<archive>0</archive>
<vgroups>0</vgroups>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 85 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<penaltymethod>0</penaltymethod>
<balance>0.000000</balance>
<credit>0.000000</credit>
<blimit>0.000000</blimit>
<balancestatus>0</balancestatus>
<balancelimitexceeded>(null)</balancelimitexceeded>
<number></number>
<code></code>
<date></date>
<bcheck></bcheck>
<symbol></symbol>
<addons></addons>
</agreements>
<addons>
<uid>0</uid>
<type>0</type>
<idx>0</idx>
<name></name>
<descr></descr>
<strvalue></strvalue>
</addons>
</ret>
</lbapi:getAccountResponse></SOAP-ENV:Body>
lbapi.getAgents.req.xml
<SOAP-ENV:Body>
<lbapi:getAgents>
</lbapi:getAgents>
</SOAP-ENV:Body>
lbapi.getAgents.res.xml
<SOAP-ENV:Body>
<lbapi:getAgentsResponse>
<ret>
<id>0</id>
<name></name>
<data>0</data>
</ret>
</lbapi:getAgentsResponse>
</SOAP-ENV:Body>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 86 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
lbapi.getAgreements.req.xml
<SOAP-ENV:Body>
<lbapi:getAgreements>
<flt>
<activated>0</activated>
<addresstype>1</addresstype>
<agentid>0</agentid>
<agrmid>0</agrmid>
<archive>0</archive>
<appid>0</appid>
<asnum>0</asnum>
<blocked>0</blocked>
<catid>0</catid>
<category>-1</category>
<curid>-1</curid>
<common>0</common>
<defaultonly>0</defaultonly>
<deviceid>0</deviceid>
<direction>0</direction>
<docid>0</docid>
<durfrom>0</durfrom>
<durto>0</durto>
<groupid>0</groupid>
<groups>0</groups>
<istemplate>0</istemplate>
<mgrid>-1</mgrid>
<needcalc>-1</needcalc>
<nodata>0</nodata>
<notgroups>0</notgroups>
<onfly>0</onfly>
<operid>0</operid>
<orderid>0</orderid>
<ordernum>0</ordernum>
<payed>-1</payed>
<parentid>-1</parentid>
<personid>0</personid>
<pgnum>0</pgnum>
<pgsize>0</pgsize>
<port>0</port>
<postmanid>0</postmanid>
<proto>0</proto>
<recordid>0</recordid>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 87 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<repdetail>0</repdetail>
<repnum>0</repnum>
<setid>0</setid>
<shape>0</shape>
<showdefault>0</showdefault>
<tarid>0</tarid>
<parenttarid>-1</parenttarid>
<taridprev>0</taridprev>
<tartype>0</tartype>
<type>0</type>
<ugroups>0</ugroups>
<unavail>-1</unavail>
<userid>0</userid>
<vgid>0</vgid>
<payhistory>0</payhistory>
<hasregistry>-1</hasregistry>
<amountfrom>0.000000</amountfrom>
<amountto>0.000000</amountto>
<address></address>
<addresscode></addresscode>
<agrmnum></agrmnum>
<ani></ani>
<cardkey></cardkey>
<code></code>
<descr></descr>
<dstip></dstip>
<dtcreated></dtcreated>
<dtactivated></dtactivated>
<dtfrom></dtfrom>
<dtto></dtto>
<email></email>
<inn></inn>
<ip></ip>
<login></login>
<name></name>
<namesound></namesound>
<numfrom></numfrom>
<numto></numto>
<phone></phone>
<receipt></receipt>
<responsible></responsible>
<serno></serno>
<status></status>
<tardescr></tardescr>
<telstaff></telstaff>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 88 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<telnum></telnum>
<vglogin></vglogin>
<uuid></uuid>
<searchtempl></searchtempl>
</flt>
<ord>
<name></name>
<ascdesc>0</ascdesc>
</ord>
</lbapi:getAgreements></SOAP-ENV:Body>
lbapi.getAgreements.res.xml
<SOAP-ENV:Body>
<lbapi:getAgreementsResponse>
<ret>
<agrmid>0</agrmid>
<uid>0</uid>
<operid>0</operid>
<curid>0</curid>
<bnotify>0</bnotify>
<archive>0</archive>
<vgroups>0</vgroups>
<penaltymethod>0</penaltymethod>
<balance>0.000000</balance>
<credit>0.000000</credit>
<blimit>0.000000</blimit>
<balancestatus>0</balancestatus>
<balancelimitexceeded>(null)</balancelimitexceeded>
<number></number>
<code></code>
<date></date>
<bcheck></bcheck>
<symbol></symbol>
<addons></addons>
</ret>
</lbapi:getAgreementsResponse>
</SOAP-ENV:Body>
lbapi.getCurrencies.req.xml
<SOAP-ENV:Body>
<lbapi:getCurrencies>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 89 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
</lbapi:getCurrencies></SOAP-ENV:Body>
lbapi.getCurrencies.res.xml
<SOAP-ENV:Body>
<lbapi:getCurrenciesResponse>
<ret>
<id>0</id>
<def>0</def>
<symbol></symbol>
<name></name>
</ret>
</lbapi:getCurrenciesResponse>
</SOAP-ENV:Body>
lbapi.getOrders.req.xml
<SOAP-ENV:Body>
<lbapi:getOrders>
<flt>
<activated>0</activated>
<addresstype>1</addresstype>
<agentid>0</agentid>
<agrmid>0</agrmid>
<archive>0</archive>
<appid>0</appid>
<asnum>0</asnum>
<blocked>0</blocked>
<catid>0</catid>
<category>-1</category>
<curid>-1</curid>
<common>0</common>
<defaultonly>0</defaultonly>
<deviceid>0</deviceid>
<direction>0</direction>
<docid>0</docid>
<durfrom>0</durfrom>
<durto>0</durto>
<groupid>0</groupid>
<groups>0</groups>
<istemplate>0</istemplate>
<mgrid>-1</mgrid>
<needcalc>-1</needcalc>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 90 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<nodata>0</nodata>
<notgroups>0</notgroups>
<onfly>0</onfly>
<operid>0</operid>
<orderid>0</orderid>
<ordernum>0</ordernum>
<payed>-1</payed>
<parentid>-1</parentid>
<personid>0</personid>
<pgnum>0</pgnum>
<pgsize>0</pgsize>
<port>0</port>
<postmanid>0</postmanid>
<proto>0</proto>
<recordid>0</recordid>
<repdetail>0</repdetail>
<repnum>0</repnum>
<setid>0</setid>
<shape>0</shape>
<showdefault>0</showdefault>
<tarid>0</tarid>
<parenttarid>-1</parenttarid>
<taridprev>0</taridprev>
<tartype>0</tartype>
<type>0</type>
<ugroups>0</ugroups>
<unavail>-1</unavail>
<userid>0</userid>
<vgid>0</vgid>
<payhistory>0</payhistory>
<hasregistry>-1</hasregistry>
<amountfrom>0.000000</amountfrom>
<amountto>0.000000</amountto>
<address></address>
<addresscode></addresscode>
<agrmnum></agrmnum>
<ani></ani>
<cardkey></cardkey>
<code></code>
<descr></descr>
<dstip></dstip>
<dtcreated></dtcreated>
<dtactivated></dtactivated>
<dtfrom></dtfrom>
<dtto></dtto>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 91 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<email></email>
<inn></inn>
<ip></ip>
<login></login>
<name></name>
<namesound></namesound>
<numfrom></numfrom>
<numto></numto>
<phone></phone>
<receipt></receipt>
<responsible></responsible>
<serno></serno>
<status></status>
<tardescr></tardescr>
<telstaff></telstaff>
<telnum></telnum>
<vglogin></vglogin>
<uuid></uuid>
<searchtempl></searchtempl>
</flt>
<ord>
<name></name>
<ascdesc>0</ascdesc>
</ord>
</lbapi:getOrders>
</SOAP-ENV:Body>
lbapi.getOrders.res.xml
<SOAP-ENV:Body>
<lbapi:getOrdersResponse>
<ret>
<orderid>0</orderid>
<agrmid>0</agrmid>
<operid>0</operid>
<docid>0</docid>
<ordernum>0</ordernum>
<resumm>0.0</resumm>
<currsumm>0.0</currsumm>
<taxsumm>0.0</taxsumm>
<uid>0</uid>
<docpayable>0</docpayable>
<period></period>
<orderdate></orderdate>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 92 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<creationdate></creationdate>
<paydate></paydate>
<filename></filename>
<docname></docname>
<docsavepath></docsavepath>
<doctemplate></doctemplate>
<docuploadext></docuploadext>
<opername></opername>
<agrmnum></agrmnum>
<username></username>
<payreceipt></payreceipt>
<currsymbol></currsymbol>
</ret>
</lbapi:getOrdersResponse>
</SOAP-ENV:Body>
lbapi.getPayments.req.xml
<SOAP-ENV:Body>
<lbapi:getPayments>
<flt>
<activated>0</activated>
<addresstype>1</addresstype>
<agentid>0</agentid>
<agrmid>0</agrmid>
<archive>0</archive>
<appid>0</appid>
<asnum>0</asnum>
<blocked>0</blocked>
<catid>0</catid>
<category>-1</category>
<curid>-1</curid>
<common>0</common>
<defaultonly>0</defaultonly>
<deviceid>0</deviceid>
<direction>0</direction>
<docid>0</docid>
<durfrom>0</durfrom>
<durto>0</durto>
<groupid>0</groupid>
<groups>0</groups>
<istemplate>0</istemplate>
<mgrid>-1</mgrid>
<needcalc>-1</needcalc>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 93 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<nodata>0</nodata>
<notgroups>0</notgroups>
<onfly>0</onfly>
<operid>0</operid>
<orderid>0</orderid>
<ordernum>0</ordernum>
<payed>-1</payed>
<parentid>-1</parentid>
<personid>0</personid>
<pgnum>0</pgnum>
<pgsize>0</pgsize>
<port>0</port>
<postmanid>0</postmanid>
<proto>0</proto>
<recordid>0</recordid>
<repdetail>0</repdetail>
<repnum>0</repnum>
<setid>0</setid>
<shape>0</shape>
<showdefault>0</showdefault>
<tarid>0</tarid>
<parenttarid>-1</parenttarid>
<taridprev>0</taridprev>
<tartype>0</tartype>
<type>0</type>
<ugroups>0</ugroups>
<unavail>-1</unavail>
<userid>0</userid>
<vgid>0</vgid>
<payhistory>0</payhistory>
<hasregistry>-1</hasregistry>
<amountfrom>0.000000</amountfrom>
<amountto>0.000000</amountto>
<address></address>
<addresscode></addresscode>
<agrmnum></agrmnum>
<ani></ani>
<cardkey></cardkey>
<code></code>
<descr></descr>
<dstip></dstip>
<dtcreated></dtcreated>
<dtactivated></dtactivated>
<dtfrom></dtfrom>
<dtto></dtto>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 94 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<email></email>
<inn></inn>
<ip></ip>
<login></login>
<name></name>
<namesound></namesound>
<numfrom></numfrom>
<numto></numto>
<phone></phone>
<receipt></receipt>
<responsible></responsible>
<serno></serno>
<status></status>
<tardescr></tardescr>
<telstaff></telstaff>
<telnum></telnum>
<vglogin></vglogin>
<uuid></uuid>
<searchtempl></searchtempl>
</flt>
</lbapi:getPayments>
</SOAP-ENV:Body>
lbapi.getPayments.res.xml
<SOAP-ENV:Body>
<lbapi:getPaymentsResponse>
<ret>
<pay>
<recordid>0</recordid>
<agrmid>0</agrmid>
<modperson>0</modperson>
<currid>0</currid>
<orderid>0</orderid>
<status>0</status>
<amount>0.0</amount>
<paydate></paydate>
<localdate></localdate>
<canceldate></canceldate>
<receipt></receipt>
<comment></comment>
</pay>
<amountcurr>0.0</amountcurr>
<ordernum>0</ordernum>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 95 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<uid>0</uid>
<operid>0</operid>
<currsymb></currsymb>
<uname></uname>
<agrm></agrm>
<mgr></mgr>
<opername></opername>
</ret>
</lbapi:getPaymentsResponse>
</SOAP-ENV:Body>
lbapi.getStat.req.xml
<SOAP-ENV:Body>
<lbapi:getStat>
<flt>
<activated>0</activated>
<addresstype>1</addresstype>
<agentid>0</agentid>
<agrmid>0</agrmid>
<archive>0</archive>
<appid>0</appid>
<asnum>0</asnum>
<blocked>0</blocked>
<catid>0</catid>
<category>-1</category>
<curid>-1</curid>
<common>0</common>
<defaultonly>0</defaultonly>
<deviceid>0</deviceid>
<direction>0</direction>
<docid>0</docid>
<durfrom>0</durfrom>
<durto>0</durto>
<groupid>0</groupid>
<groups>0</groups>
<istemplate>0</istemplate>
<mgrid>-1</mgrid>
<needcalc>-1</needcalc>
<nodata>0</nodata>
<notgroups>0</notgroups>
<onfly>0</onfly>
<operid>0</operid>
<orderid>0</orderid>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 96 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<ordernum>0</ordernum>
<payed>-1</payed>
<parentid>-1</parentid>
<personid>0</personid>
<pgnum>0</pgnum>
<pgsize>0</pgsize>
<port>0</port>
<postmanid>0</postmanid>
<proto>0</proto>
<recordid>0</recordid>
<repdetail>0</repdetail>
<repnum>0</repnum>
<setid>0</setid>
<shape>0</shape>
<showdefault>0</showdefault>
<tarid>0</tarid>
<parenttarid>-1</parenttarid>
<taridprev>0</taridprev>
<tartype>0</tartype>
<type>0</type>
<ugroups>0</ugroups>
<unavail>-1</unavail>
<userid>0</userid>
<vgid>0</vgid>
<payhistory>0</payhistory>
<hasregistry>-1</hasregistry>
<amountfrom>0.000000</amountfrom>
<amountto>0.000000</amountto>
<address></address>
<addresscode></addresscode>
<agrmnum></agrmnum>
<ani></ani>
<cardkey></cardkey>
<code></code>
<descr></descr>
<dstip></dstip>
<dtcreated></dtcreated>
<dtactivated></dtactivated>
<dtfrom></dtfrom>
<dtto></dtto>
<email></email>
<inn></inn>
<ip></ip>
<login></login>
<name></name>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 97 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<namesound></namesound>
<numfrom></numfrom>
<numto></numto>
<phone></phone>
<receipt></receipt>
<responsible></responsible>
<serno></serno>
<status></status>
<tardescr></tardescr>
<telstaff></telstaff>
<telnum></telnum>
<vglogin></vglogin>
<uuid></uuid>
<searchtempl></searchtempl>
</flt>
<ord>
<name></name>
<ascdesc>0</ascdesc>
</ord>
</lbapi:getStat>
</SOAP-ENV:Body>
lbapi.getStat.res.xml
<SOAP-ENV:Body>
<lbapi:getStatResponse>
<ret>
<rows>0</rows>
<cols>0</cols>
<total>0</total>
<names>
<val></val>
</names>
<datasumm>
<val></val>
</datasumm>
<data>
<val></val>
</data>
</ret>
</lbapi:getStatResponse>
</SOAP-ENV:Body>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 98 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
lbapi.getTarifsHistory.req.xml
<SOAP-ENV:Body>
<lbapi:getTarifsHistory>
<flt>
<activated>0</activated>
<addresstype>1</addresstype>
<agentid>0</agentid>
<agrmid>0</agrmid>
<archive>0</archive>
<appid>0</appid>
<asnum>0</asnum>
<blocked>0</blocked>
<catid>0</catid>
<category>-1</category>
<curid>-1</curid>
<common>0</common>
<defaultonly>0</defaultonly>
<deviceid>0</deviceid>
<direction>0</direction>
<docid>0</docid>
<durfrom>0</durfrom>
<durto>0</durto>
<groupid>0</groupid>
<groups>0</groups>
<istemplate>0</istemplate>
<mgrid>-1</mgrid>
<needcalc>-1</needcalc>
<nodata>0</nodata>
<notgroups>0</notgroups>
<onfly>0</onfly>
<operid>0</operid>
<orderid>0</orderid>
<ordernum>0</ordernum>
<payed>-1</payed>
<parentid>-1</parentid>
<personid>0</personid>
<pgnum>0</pgnum>
<pgsize>0</pgsize>
<port>0</port>
<postmanid>0</postmanid>
<proto>0</proto>
<recordid>0</recordid>
<repdetail>0</repdetail>
<repnum>0</repnum>
<setid>0</setid>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 99 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<shape>0</shape>
<showdefault>0</showdefault>
<tarid>0</tarid>
<parenttarid>-1</parenttarid>
<taridprev>0</taridprev>
<tartype>0</tartype>
<type>0</type>
<ugroups>0</ugroups>
<unavail>-1</unavail>
<userid>0</userid>
<vgid>0</vgid>
<payhistory>0</payhistory>
<hasregistry>-1</hasregistry>
<amountfrom>0.000000</amountfrom>
<amountto>0.000000</amountto>
<address></address>
<addresscode></addresscode>
<agrmnum></agrmnum>
<ani></ani>
<cardkey></cardkey>
<code></code>
<descr></descr>
<dstip></dstip>
<dtcreated></dtcreated>
<dtactivated></dtactivated>
<dtfrom></dtfrom>
<dtto></dtto>
<email></email>
<inn></inn>
<ip></ip>
<login></login>
<name></name>
<namesound></namesound>
<numfrom></numfrom>
<numto></numto>
<phone></phone>
<receipt></receipt>
<responsible></responsible>
<serno></serno>
<status></status>
<tardescr></tardescr>
<telstaff></telstaff>
<telnum></telnum>
<vglogin></vglogin>
<uuid></uuid>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 100 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<searchtempl></searchtempl>
</flt>
</lbapi:getTarifsHistory>
</SOAP-ENV:Body>
lbapi.getTarifsHistory.res.xml
<SOAP-ENV:Body>
<lbapi:getTarifsHistoryResponse>
<ret>
<recordid>0</recordid>
<vgid>0</vgid>
<agrmid>0</agrmid>
<uid>0</uid>
<id>0</id>
<taridnew>0</taridnew>
<taridold>0</taridold>
<requestby></requestby>
<rasptime></rasptime>
<changed></changed>
<vglogin></vglogin>
<agrmnum></agrmnum>
<code></code>
<accname></accname>
<agentname></agentname>
<tarnewname></tarnewname>
<taroldname></taroldname>
<mgrname></mgrname>
<mgrdescr></mgrdescr>
</ret>
</lbapi:getTarifsHistoryResponse>
</SOAP-ENV:Body>
lbapi.getTarifsRasp.req.xml
<SOAP-ENV:Body>
<lbapi:getTarifsRasp>
<flt>
<activated>0</activated>
<addresstype>1</addresstype>
<agentid>0</agentid>
<agrmid>0</agrmid>
<archive>0</archive>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 101 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<appid>0</appid>
<asnum>0</asnum>
<blocked>0</blocked>
<catid>0</catid>
<category>-1</category>
<curid>-1</curid>
<common>0</common>
<defaultonly>0</defaultonly>
<deviceid>0</deviceid>
<direction>0</direction>
<docid>0</docid>
<durfrom>0</durfrom>
<durto>0</durto>
<groupid>0</groupid>
<groups>0</groups>
<istemplate>0</istemplate>
<mgrid>-1</mgrid>
<needcalc>-1</needcalc>
<nodata>0</nodata>
<notgroups>0</notgroups>
<onfly>0</onfly>
<operid>0</operid>
<orderid>0</orderid>
<ordernum>0</ordernum>
<payed>-1</payed>
<parentid>-1</parentid>
<personid>0</personid>
<pgnum>0</pgnum>
<pgsize>0</pgsize>
<port>0</port>
<postmanid>0</postmanid>
<proto>0</proto>
<recordid>0</recordid>
<repdetail>0</repdetail>
<repnum>0</repnum>
<setid>0</setid>
<shape>0</shape>
<showdefault>0</showdefault>
<tarid>0</tarid>
<parenttarid>-1</parenttarid>
<taridprev>0</taridprev>
<tartype>0</tartype>
<type>0</type>
<ugroups>0</ugroups>
<unavail>-1</unavail>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 102 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<userid>0</userid>
<vgid>0</vgid>
<payhistory>0</payhistory>
<hasregistry>-1</hasregistry>
<amountfrom>0.000000</amountfrom>
<amountto>0.000000</amountto>
<address></address>
<addresscode></addresscode>
<agrmnum></agrmnum>
<ani></ani>
<cardkey></cardkey>
<code></code>
<descr></descr>
<dstip></dstip>
<dtcreated></dtcreated>
<dtactivated></dtactivated>
<dtfrom></dtfrom>
<dtto></dtto>
<email></email>
<inn></inn>
<ip></ip>
<login></login>
<name></name>
<namesound></namesound>
<numfrom></numfrom>
<numto></numto>
<phone></phone>
<receipt></receipt>
<responsible></responsible>
<serno></serno>
<status></status>
<tardescr></tardescr>
<telstaff></telstaff>
<telnum></telnum>
<vglogin></vglogin>
<uuid></uuid>
<searchtempl></searchtempl>
</flt>
</lbapi:getTarifsRasp>
</SOAP-ENV:Body>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 103 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
lbapi.getTarifsRasp.res.xml
<SOAP-ENV:Body>
<lbapi:getTarifsRaspResponse>
<ret>
<recordid>0</recordid>
<vgid>0</vgid>
<agrmid>0</agrmid>
<groupid>0</groupid>
<uid>0</uid>
<id>0</id>
<taridnew>0</taridnew>
<taridold>0</taridold>
<requestby></requestby>
<changetime></changetime>
</ret>
</lbapi:getTarifsRaspResponse>
</SOAP-ENV:Body>
lbapi.getVgroup.req.xml
<SOAP-ENV:Body>
<lbapi:getVgroup>
<id>0</id>
</lbapi:getVgroup>
</SOAP-ENV:Body>
lbapi.getVgroup.res.xml
<SOAP-ENV:Body>
<lbapi:getVgroupResponse>
<ret>
<vgroup>
<vgid>0</vgid>
<cuid>0</cuid>
<tarid>0</tarid>
<agrmid>0</agrmid>
<id>0</id>
<uid>0</uid>
<shape>0</shape>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 104 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<currentshape>0</currentshape>
<maxsessions>0</maxsessions>
<blkreq>0</blkreq>
<blocked>0</blocked>
<changed>0</changed>
<templ>0</templ>
<ipdet>0</ipdet>
<portdet>0</portdet>
<archive>0</archive>
<usercategory>0</usercategory>
<checkduplicate>0</checkduplicate>
<dirty>0</dirty>
<connectedfrom>0</connectedfrom>
<dlimit>0</dlimit>
<amount>0.000000</amount>
<accondatefirst></accondatefirst>
<creationdate></creationdate>
<accondate></accondate>
<accoffdate></accoffdate>
<blockdate></blockdate>
<cdate></cdate>
<dclear></dclear>
<descr></descr>
<login></login>
<pass></pass>
</vgroup>
<tarrasp>
<recordid>0</recordid>
<vgid>0</vgid>
<agrmid>0</agrmid>
<groupid>0</groupid>
<uid>0</uid>
<id>0</id>
<taridnew>0</taridnew>
<taridold>0</taridold>
<requestby></requestby>
<changetime></changetime>
</tarrasp>
<staff>
<recordid>0</recordid>
<vgid>0</vgid>
<type>0</type>
<as>0</as>
<ipmask>
<ip></ip>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 105 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<mask>0</mask>
</ipmask>
</staff>
<telstaff>
<recordid>0</recordid>
<vgid>0</vgid>
<device>0</device>
<ldservice>1</ldservice>
<phonenumber></phonenumber>
<comment></comment>
</telstaff>
<macstaff>
</macstaff>
<addons>
<vgid>0</vgid>
<type>0</type>
<agentid>0</agentid>
<idx>0</idx>
<name></name>
<descr></descr>
<strvalue></strvalue>
</addons>
<services></services>
<addresses>
<type>0</type>
<code></code>
<address></address>
</addresses>
</ret>
</lbapi:getVgroupResponse>
</SOAP-ENV:Body>
lbapi.insupdAccount.req.xml
<SOAP-ENV:Body>
<lbapi:insupdAccount>
<isInsert>0</isInsert>
<val>
<account>
<uid>0</uid>
<ipaccess>0</ipaccess>
<billdelivery>0</billdelivery>
<category>0</category>
<type>0</type>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 106 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<oksm>0</oksm>
<templ>0</templ>
<archive>0</archive>
<login></login>
<pass></pass>
<descr></descr>
<name></name>
<phone></phone>
<fax></fax>
<email></email>
<bankname></bankname>
<bik></bik>
<settl></settl>
<corr></corr>
<kpp></kpp>
<inn></inn>
<ogrn></ogrn>
<okpo></okpo>
<okved></okved>
<gendiru></gendiru>
<glbuhgu></glbuhgu>
<kontperson></kontperson>
<actonwhat></actonwhat>
<passsernum></passsernum>
<passno></passno>
<passissuedate></passissuedate>
<passissuedep></passissuedep>
<passissueplace></passissueplace>
<birthdate></birthdate>
<birthplace></birthplace>
<lastmoddate></lastmoddate>
<okato></okato>
</account>
<addresses>
<type>0</type>
<code></code>
<address></address>
</addresses>
<agreements>
<agrmid>0</agrmid>
<uid>0</uid>
<operid>0</operid>
<curid>0</curid>
<bnotify>0</bnotify>
<archive>0</archive>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 107 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<vgroups>0</vgroups>
<penaltymethod>0</penaltymethod>
<balance>0.000000</balance>
<credit>0.000000</credit>
<blimit>0.000000</blimit>
<balancestatus>0</balancestatus>
<balancelimitexceeded>(null)</balancelimitexceeded>
<number></number>
<code></code>
<date></date>
<bcheck></bcheck>
<symbol></symbol>
<addons></addons>
</agreements>
<addons>
<uid>0</uid>
<type>0</type>
<idx>0</idx>
<name></name>
<descr></descr>
<strvalue></strvalue>
</addons>
</val>
</lbapi:insupdAccount>
</SOAP-ENV:Body>
lbapi.insupdAccount.res.xml
<SOAP-ENV:Body>
<lbapi:insupdAccountResponse>
<ret>0</ret>
</lbapi:insupdAccountResponse>
</SOAP-ENV:Body>
lbapi.insupdVgroup.req.xml
<SOAP-ENV:Body>
<lbapi:insupdVgroup>
<isInsert>0</isInsert>
<val>
<vgroup>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 108 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<vgid>0</vgid>
<cuid>0</cuid>
<tarid>0</tarid>
<agrmid>0</agrmid>
<id>0</id>
<uid>0</uid>
<shape>0</shape>
<currentshape>0</currentshape>
<maxsessions>0</maxsessions>
<blkreq>0</blkreq>
<blocked>0</blocked>
<changed>0</changed>
<templ>0</templ>
<ipdet>0</ipdet>
<portdet>0</portdet>
<archive>0</archive>
<usercategory>0</usercategory>
<checkduplicate>0</checkduplicate>
<dirty>0</dirty>
<connectedfrom>0</connectedfrom>
<dlimit>0</dlimit>
<amount>0.000000</amount>
<accondatefirst></accondatefirst>
<creationdate></creationdate>
<accondate></accondate>
<accoffdate></accoffdate>
<blockdate></blockdate>
<cdate></cdate>
<dclear></dclear>
<descr></descr>
<login></login>
<pass></pass>
</vgroup>
<tarrasp>
<recordid>0</recordid>
<vgid>0</vgid>
<agrmid>0</agrmid>
<groupid>0</groupid>
<uid>0</uid>
<id>0</id>
<taridnew>0</taridnew>
<taridold>0</taridold>
<requestby></requestby>
<changetime></changetime>
</tarrasp>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 109 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<staff>
<recordid>0</recordid>
<vgid>0</vgid>
<type>0</type>
<as>0</as>
<ipmask>
<ip></ip>
<mask>0</mask>
</ipmask>
</staff>
<telstaff>
<recordid>0</recordid>
<vgid>0</vgid>
<device>0</device>
<ldservice>1</ldservice>
<phonenumber></phonenumber>
<comment></comment>
</telstaff>
<macstaff>
</macstaff>
<addons>
<vgid>0</vgid>
<type>0</type>
<agentid>0</agentid>
<idx>0</idx>
<name></name>
<descr></descr>
<strvalue></strvalue>
</addons>
<services></services>
<addresses>
<type>0</type>
<code></code>
<address></address>
</addresses>
</val>
</lbapi:insupdVgroup>
</SOAP-ENV:Body>
lbapi.insupdVgroup.res.xml
<SOAP-ENV:Body>
<lbapi:insupdVgroupResponse>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 110 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
<ret>0</ret>
</lbapi:insupdVgroupResponse>
</SOAP-ENV:Body>
lbapi.login.req.xml
<SOAP-ENV:Body>
<lbapi:login>
<login></login>
<pass></pass>
</lbapi:login>
</SOAP-ENV:Body>
lbapi.login.res.xml
<SOAP-ENV:Body>
<lbapi:loginResponse>
<ret>
<manager>
<personid>0</personid>
<login></login>
</manager>
</ret>
</lbapi:loginResponse>
</SOAP-ENV:Body>
lbapi.logout.req.xml
<SOAP-ENV:Body>
<lbapi:logout>
</lbapi:logout>
</SOAP-ENV:Body>
lbapi.logout.res.xml
<SOAP-ENV:Body>
<lbapi:logoutResponse>
<ret>0</ret>
</lbapi:logoutResponse>
</SOAP-ENV:Body>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer
Страница 111 из 111
ООО «Сетевые решения», 2011
__________________________________________________________________
lbapi.Payment.req.xml
<SOAP-ENV:Body>
<lbapi:Payment>
<val>
<recordid>0</recordid>
<agrmid>0</agrmid>
<modperson>0</modperson>
<currid>0</currid>
<orderid>0</orderid>
<status>0</status>
<classid>0</classid>
<amount>0.0</amount>
<fromagrmid>0</fromagrmid>
<revno>0</revno>
<revisions>0</revisions>
<classname></classname>
<paydate></paydate>
<localdate></localdate>
<canceldate></canceldate>
<receipt></receipt>
<comment></comment>
</val>
</lbapi:Payment></SOAP-ENV:Body>
lbapi.Payment.res.xml
<SOAP-ENV:Body>
<lbapi:PaymentResponse>
<ret>0</ret>
</lbapi:PaymentResponse>
</SOAP-ENV:Body>
__________________________________________________________________
Руководство разработчика для интеграции с LANBillingSuperviseServer