APIGetBillProp

Эта функция возвращает информацию о тарифах и также может использоваться для получения списка пользователей и групп.

Data = APIGetBillProp(ObjType, ObjID)

Аргументы

ObjType

Числовое обозначение типа объекта, по которому запрашиваются данные. Может принимать значения:

1	Выводятся общие настройки по умолчанию для клиентов и групп.
2	Выводятся настройки для групп.
3	Выводятся настройки для клиентов.

ObjID

Строковое выражение, определяющее идентификатор объекта. Может быть пустой строкой (""), отображаемым именем или GUID объекта.

Если ObjType = 1, то этот параметр игнорируется.

Если ObjType = 2, и ObjID пустая строка(""), то выводится список групп,

иначе выводятся параметры для конкретной группы.

Если ObjType = 3, и ObjID пустая строка, то выводится список всех клиентов,

иначе если ObjID задает группу, то выводится список клиентов этой группы,

а если ObjID задает клиента, то выводятся параметры этого клиента.

Возвращаемое значение

Data - возвращаемые данные в виде одномерного массива для одиночного объекта или в виде двумерного массива (таблицы) для списка объектов.

Формат выводимых данных:

0	Отображаемое имя клиента или группы.
1	GUID объекта (клиента или группы).
2	Если объект клиент, то здесь выводится GUID его группы.
3	Если объект клиент или группа, то тут выводится значение типа Boolean. true* - у этого объекта настройки тарификации применяются по умолчанию, иначе false.
4	Способ тарификации трафика. См. функцию APIBillTraffTypeAsString.
5	Цена за трафик.
6	Предоплаченный трафик, Мбайт.
7	Цена за время (абонентская плата).
8	Кредитный лимит.

* Если значение параметра 3 = true, то следующие параметры (4..8) берутся из общих настроек или настроек группы клиента.

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

Set Srv = CreateObject("TrafInsp.TrafInspAdmin")

APIPass = "123456" 'Пароль для доступа через API

Srv.APILogon(APIPass)

GroupID1 = "{2ACAB0DD-925C-4F49-90B6-A5E27E6DDD75}" ' GUID группы

GroupID2 = "Tarif Pirogi" ' Отображаемое имя группы

UserID = "Vasilii Petrov" ' Отображаемое имя клиента

BillData1 = Srv.ApiGetBillProp(1, "") ' Возвращает общие настройки по умолчанию

BillData2 = Srv.ApiGetBillProp(2, "") ' Возвращает массив настроек для групп

BillData3 = Srv.ApiGetBillProp(2, GroupID1) ' Возвращает настройки для группы c GUID {2ACAB0DD-925C-4F49-90B6-A5E27E6DDD75}

BillData4 = Srv.ApiGetBillProp(3, "") ' Возвращает массив настроек для клиентов

BillData5 = Srv.ApiGetBillProp(3, GroupID2) ' Возвращает массив настроек для клиентов группы Tarif Pirogi

BillData6 = Srv.ApiGetBillProp(3, UserID) ' Возвращает настройки для клиента Vasilii Petrov