API - usm billing - get user list: различия между версиями
Admin (обсуждение | вклад) Нет описания правки |
Admin (обсуждение | вклад) Нет описания правки |
||
Строка 20: | Строка 20: | ||
[] => array( | [] => array( | ||
'id' => id | 'id' => id | ||
'login | 'login' => имя учетной записи | ||
'full_name | 'full_name' => полное ФИО/название | ||
' | 'flag_corporate' => флаг – юридическое лицо | ||
'tariff | 'tariff' => array( - тарифные планы ''(стандартные)'' | ||
' | 'current' => array( - текущие планы ''(действующие)'' | ||
[] => array( - вложенный массив | |||
'id' => id | |||
'date_finish' => дата окончания срока действия тарифа | |||
) | |||
[ | 'new' => array( - новые планы ''(заказанные)'' | ||
[] => array( - вложенный массив | |||
'id' => id | |||
'agreement | 'date_start' => дата начала срока действия тарифа | ||
[ | ) | ||
) | |||
'agreement' => array( - договора с клиентом | |||
' | [] => array( - вложенный массив | ||
' | 'number' => номер | ||
'date' => дата | |||
) | |||
) | |||
'account_number' => номер лицевого счета | |||
'group' => array(группы абонента | |||
[] => (в качестве индекса массива выступает идентификатор группы) | [] => (в качестве индекса массива выступает идентификатор группы) | ||
' | 'id' => id | ||
'comment’] => Заметки | 'comment’] => Заметки | ||
'balance’] => Остаток на счету | 'balance’] => Остаток на счету |
Версия от 14:23, 6 октября 2017
См.: Методы универсального API
Метод: get_user_list
Описание: Абоненты/клиенты
Добавлен в версии API: 1.0
Запрос: ?key=apikey&request=get_user_list Результат: http://demo.userside.eu/api.php?key=keyus&cat=module&request=get_user_list
Ответ идёт по всем абонентам кроме удалённых. Также есть возможность указать ID конкретного абонента
?key=apikey&request=get_user_list&customer_id=999
В качестве индекса массива выступает идентификатор абонента [] => array( 'id' => id 'login' => имя учетной записи 'full_name' => полное ФИО/название 'flag_corporate' => флаг – юридическое лицо 'tariff' => array( - тарифные планы (стандартные) 'current' => array( - текущие планы (действующие) [] => array( - вложенный массив 'id' => id 'date_finish' => дата окончания срока действия тарифа ) 'new' => array( - новые планы (заказанные) [] => array( - вложенный массив 'id' => id 'date_start' => дата начала срока действия тарифа ) ) 'agreement' => array( - договора с клиентом [] => array( - вложенный массив 'number' => номер 'date' => дата ) ) 'account_number' => номер лицевого счета 'group' => array(группы абонента
[] => (в качестве индекса массива выступает идентификатор группы)
'id' => id 'comment’] => Заметки 'balance’] => Остаток на счету 'credit’] => Кредит 'state_id’] => Идентификатор статуса работы. 'date_create’] => Дата создания 'date_connect’] => Дата начала работы абонента 'date_activity`] => Дата последней активности абонента (активность в интернете и т.п. деятельность внутри сети. Но не считая, например, вход в личный кабинет извне сети) 'traffic’] => Трафик по абоненту (bytes) 'month’] => За последние 30 дней 'up’] => Входящий 'down’] => Исходящий 'discount’] => Скидка по абоненту 'address’] => Адрес абонента
[‘…’] => (вложенный массив)
'full_name’] => Текстовый адрес (Не использовать, если будет указан идентификатор дома) 'type’] => Тип адреса (возможные значения: «connect» – точка подключения, «legal» – регистрация/прописка, «post» – для корреспонденции) 'house_id’] => Дом/Здание 'apartment’] => Квартира/Помещение 'id’] => Идентификатор 'full_name’] => Полное наименование 'number’] => Номер (цифровое. Если есть) 'block’] => Буква/наименование помещения (текстовое. Если есть) 'entrance’] => Номер подъезда (цифровое) 'floor’] => Номер этажа (цифровое) 'phone’] => Телефоны
[‘…’] => (вложенный массив)
'number’] => Номер (только цифры и символ «+») 'flag_main’] => Флаг – главный номер 1/0 'comment’] => Заметки к номеру 'email’] => Электронные почтовые адреса
[‘…’] => (вложенный массив)
'address’] => Адрес 'flag_main’] => Флаг – главная запись 1/0 'comment’] => Заметки 'ip_mac’] => IP/MAC-адреса (текущие. Под которыми разрешено работать или прямо сейчас работает абонент)
[] => (в качестве индекса массива выступает inet_aton(IP) или счетчик (для подсетей))
'ip’] => IP-адрес (единичный). В inet_aton-формате 'mac’] => MAC-адрес. В нижнем регистре. Без разделителей. 'ip_net’] => Подсеть IP-адресов (если используется) 'additional_data’] => Дополнительные данные по абоненту (в т.ч. настраиваемые поля)
[] => (в качестве индекса массива выступает идентификатор доп.поля)
'id’] => Идентификатор доп.поля 'value’] => Значение (в формате поля) 'account`] => Учетные записи
[] => (в качестве индекса массива выступает идентификатор уч.записи)
'id`] => Идентификатор учётной записи 'login`] => Наименование уч.записи
… используются прочие элементы, указанные для клиента в целом (например – заметки, баланс, состояние работы) – в случае если у учетных записей существуют такие параметры
'tag’] => Метки абонента
[] => (в качестве индекса массива выступает идентификатор метки)
'id`] => Идентификатор метки 'date_add`] => Дата установки метки 'service`] => Услуги
[]=> (в качестве индекса массива выступает идентификатор услуги) [`…`] => (вложенный массив)
'cost`] => Стоимость для абонента 'date_add’] => Дата добавления 'comment’] => Заметки 'mark’] => Метки абонента (булевые)
[] => (в качестве индекса массива выступает идентификатор метки)
'id`] => Идентификатор метки 'password’] => Пароль абонента
)