API abon: различия между версиями

Материал из WiKi - UserSide
(Новая страница: «Раздел '''API''' ERP "UserSide" Назначение: Действия с абонентами. Большинство действий актуаль…»)
 
(Перенаправление на API customer)
 
Строка 1: Строка 1:
Раздел '''[[API]]''' ERP "UserSide"
#REDIRECT [[API customer]]
 
Назначение: Действия с абонентами. Большинство действий актуально для [[Поддерживаемые биллинги|ручных биллингов]].
 
Дополнительные параметры:
subcat - подкатегория запроса ''(возможное значение: см.ниже)''
 
== Подкатегории ==
 
==== abon_add ====
Описание: Добавление абонента
Обязательные параметры:
  codeti - ID абонента по версии биллинга
  fio - ФИО абонента
Дополнительно возвращаемые данные:
  array(
  [Id] => ID нового абонента в случае успеха
  )
 
==== abon_hist ====
Описание: Вывод операций с абонентом (финансовые и прочие)
Обязательные параметры:
  usercode - ID абонента ''(tbl_base.CODE)''
Дополнительно возвращаемые данные:
  перечень тарифов
  array(
  [Id] - ID_ТИП операции
  [DateDo] - дата операции
  [OperID] - ID оператора (tbl_oper.CODE)
  [BalansBefore] - баланс абонента до операции
  [Amount] - сумма операции
  [PKO] - номер приходного кассового ордера
  [Comment] - описание операции
  [BillingDopData] - дополнительные данные по операции из биллинга (используется при импорте данных из сторонних биллингов)
  )
 
==== get_abon_id ====
Описание: Получение ID абонента по входящим данным
Обязательные параметры:
  data_typer - тип данных, которые проверяем (Возможные значения: codeti, dognumber, ip)
  data_value - значение
Дополнительно возвращаемые данные:
  array(
  [Id] => ID абонента в случае успеха
  )
 
==== input_msg ====
Описание: Запись сообщения от абонента
Обязательные параметры:
  usercode - ID абонента ''(tbl_base.CODE)''
  msgtext - текст сообщения
Дополнительно возвращаемые данные:
  array(
  [MsgId] => В случае успеха - ID сообщения (tbl_trouble.CODE)
  )
 
==== list_tarif_available ====
Описание: Список тарифов, доступных абоненту для смены
Обязательные параметры:
  usercode - ID абонента ''(tbl_base.CODE)''
Дополнительно возвращаемые данные:
  перечень тарифов
  array(
  [TarifList] => array(
    [Id] - ID тарифа (tbl_group.CODE)
    [Name] - Название тарифа
    [Price] - Стоимость тарифа
    [IsDayPrice] - Флаг - ежедневная ли стоимость
  )
  )
 
==== msg ====
Описание: Вывод переписки с абонентом
Обязательные параметры:
  usercode - ID абонента ''(tbl_base.CODE)''
Дополнительно возвращаемые данные:
  перечень тарифов
  array(
  [Id] - ID сообщения (tbl_trouble.CODE)
  [DateMsg] - дата сообщения
  [MsgTyper] - (OperMsg/UserMsg) - тип сообщения. Сообщения от абонента или от оператора
  [Text] - текст сообщения
  [Attach] = array( - массив с прикрепленными файлами
    [Id] - ID файла (tbl_attach.CODE)
    [FilePath] - URL к файлу
    [RealName] - изначальное имя файла
  )
  )
 
==== pass_change ====
Описание: Смена пароля на вход в ЛК
Обязательные параметры:
  usercode - ID абонента ''(tbl_base.CODE)''
  pass_old - текущий пароль
  pass_new - новый пароль
 
==== tarif_change ====
Описание: Смена тарифа абоненту
Обязательные параметры:
  usercode - ID абонента ''(tbl_base.CODE)''
  tarif - ID нового тарифа ''(tbl_group.CODE)''

Текущая версия от 20:34, 28 ноября 2015

Перенаправление на: