API - usm billing - get user list: различия между версиями

Материал из WiKi - UserSide
(Новая страница: «См.: Методы универсального API Метод: '''get_user_group_l…»)
 
Нет описания правки
 
(не показано 7 промежуточных версий этого же участника)
Строка 1: Строка 1:
См.: [[Универсальное API#Поддерживаемые методы|Методы универсального API]]
См.: [[Универсальное API#Поддерживаемые методы|Методы универсального API]]


Метод: '''get_user_group_list'''
Метод: '''get_user_list'''


Описание: Абоненты/клиенты
Описание: Абоненты/клиенты
Строка 8: Строка 8:


  Запрос:
  Запрос:
  ?key=apikey&request=get_user_list
  ?key=apikey&cat=module&request=get_user_list
   
   
  Результат:
  Результат:
  http://demo.userside.eu/api.php?key=keyus&cat=module&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( - группы абонента
    [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор группы
      'id' => id
    )
  )
  'comment' => заметки
  'balance' => остаток на счету
  'credit' => кредит
  'state_id' => id статуса работы.
  'date_create' => дата создания
  'date_connect' => дата начала работы
  'date_activity' => дата последней активности абонента ''(активность в интернете и т.п. деятельность внутри сети. Но не считая, например, вход в личный кабинет извне сети)''
  'traffic' => array( - трафик по абоненту ''(bytes)''
    'month' => array( - за последние 30 дней
      'up' => входящий
      'down' => исходящий
    )
  )
  'discount' => скидка
  'address' => array( - адрес
    [] => array( - вложенный массив
      'full_name' => текстовый адрес ''(не использовать, если будет указан идентификатор дома)''
      'type' => тип адреса ''(возможные значения: "connect" – точка подключения, "legal" – регистрация/прописка, "post" – для корреспонденции)''
      'house_id' => id дома
      'apartment' => array( - квартира/Помещение
        'id' => id
        'full_name' => полное наименование
        'number' => номер ''(если есть)''
        'block' => буква/наименование помещения ''(если есть)''
      )
      'entrance' => номер подъезда
      'floor' => номер этажа
    )
  )
  'phone' => array( - телефоны
    [] => array( - вложенный массив
      'number' => номер ''(только цифры и символ "+")''
      'flag_main' => флаг – главный номер
      'comment' => заметки
    )
  )
  'email' => array( - электронные почтовые адреса
    [] => array( - вложенный массив
      'address' => адрес почты
      'flag_main' => флаг – главная запись
      'comment' => заметки
    )
  )
  'ip_mac' => array( - ip/mac-адреса ''(текущие. Под которыми разрешено работать или прямо сейчас работает абонент)''
    [] => array( - вложенный массив - в качестве индекса массива выступает inet_aton(ip) или счетчик ''(для подсетей)''
      'ip' => ip-адрес ''(единичный)''
      'mac' => mac-адрес
      'ip_net' => подсеть ip-адресов ''(если используется)''
    )
  )
  'additional_data' => array( - дополнительные данные по абоненту ''(в т.ч. настраиваемые поля)''
    [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор доп.поля
      'id' => id доп.поля
      'value' => значение ''(в формате поля)''
    )
  )
  'account' => array( - учетные записи
    [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор уч.записи
      'id' => id
      'login' => наименование уч.записи
      … используются прочие элементы, указанные для клиента в целом ''(например – заметки, баланс, состояние работы)'' – в случае если у учетных записей существуют такие параметры
    )
  )
  'tag' => array( - метки абонента
    [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор метки
      'id' => id
      'date_add' => дата установки метки
    )
  )
  'service' => array( - услуги
    [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор услуги
      [] => array( - вложенный массив ''(у абонента может быть сразу несколько услуг одного типа)''
        'cost' => стоимость
        'date_add' => дата добавления
        'comment' => заметки
      )
    )
  )
  'mark' => array( - метки абонента ''(булевые)''
    [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор метки
      'id' => id
    )
  )
  'password' => пароль
)

Текущая версия от 11:06, 4 мая 2018

См.: Методы универсального API

Метод: get_user_list

Описание: Абоненты/клиенты

Добавлен в версии API: 1.0

Запрос:
?key=apikey&cat=module&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( - группы абонента
   [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор группы
     'id' => id
   )
 )
 'comment' => заметки
 'balance' => остаток на счету
 'credit' => кредит
 'state_id' => id статуса работы. 
 'date_create' => дата создания
 'date_connect' => дата начала работы
 'date_activity' => дата последней активности абонента (активность в интернете и т.п. деятельность внутри сети. Но не считая, например, вход в личный кабинет извне сети)
 'traffic' => array( - трафик по абоненту (bytes)
   'month' => array( - за последние 30 дней
     'up' => входящий
     'down' => исходящий
   )
 )
 'discount' => скидка
 'address' => array( - адрес
   [] => array( - вложенный массив
     'full_name' => текстовый адрес (не использовать, если будет указан идентификатор дома)
     'type' => тип адреса (возможные значения: "connect" – точка подключения, "legal" – регистрация/прописка, "post" – для корреспонденции)
     'house_id' => id дома
     'apartment' => array( - квартира/Помещение
       'id' => id
       'full_name' => полное наименование
       'number' => номер (если есть)
       'block' => буква/наименование помещения (если есть)
     )
     'entrance' => номер подъезда
     'floor' => номер этажа
   )
 )
 'phone' => array( - телефоны
   [] => array( - вложенный массив
     'number' => номер (только цифры и символ "+")
     'flag_main' => флаг – главный номер
     'comment' => заметки
   )
 )
 'email' => array( - электронные почтовые адреса
   [] => array( - вложенный массив
     'address' => адрес почты
     'flag_main' => флаг – главная запись
     'comment' => заметки
   )
 )
 'ip_mac' => array( - ip/mac-адреса (текущие. Под которыми разрешено работать или прямо сейчас работает абонент)
   [] => array( - вложенный массив - в качестве индекса массива выступает inet_aton(ip) или счетчик (для подсетей)
     'ip' => ip-адрес (единичный)
     'mac' => mac-адрес
     'ip_net' => подсеть ip-адресов (если используется)
   )
 )
 'additional_data' => array( - дополнительные данные по абоненту (в т.ч. настраиваемые поля)
   [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор доп.поля
     'id' => id доп.поля
     'value' => значение (в формате поля)
    )
 )
 'account' => array( - учетные записи
   [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор уч.записи
     'id' => id
     'login' => наименование уч.записи
     … используются прочие элементы, указанные для клиента в целом (например – заметки, баланс, состояние работы) – в случае если у учетных записей существуют такие параметры
   )
 )
 'tag' => array( - метки абонента
   [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор метки
     'id' => id
     'date_add' => дата установки метки
   )
 )
 'service' => array( - услуги
   [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор услуги
     [] => array( - вложенный массив (у абонента может быть сразу несколько услуг одного типа)
       'cost' => стоимость
       'date_add' => дата добавления
       'comment' => заметки
     )
   )
 )
 'mark' => array( - метки абонента (булевые)
   [] => array( - вложенный массив - в качестве индекса массива выступает идентификатор метки
     'id' => id
   )
 )
 'password' => пароль
)