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

Материал из WiKi - UserSide
Нет описания правки
 
(не показано 7 промежуточных версий 1 участника)
Строка 1: Строка 1:
[[API_tariff_EN|en]] | [[API_tariff|ru]]
Раздел '''[[API]]''' ERP "UserSide"
Раздел '''[[API]]''' ERP "UserSide"


Назначение: Действия с тарифами
Назначение: Тарифы


  Дополнительные параметры:
  Дополнительные параметры:
Строка 11: Строка 13:
  Описание: Добавление тарифа
  Описание: Добавление тарифа
  Обязательные параметры:
  Обязательные параметры:
   name - Наименование тарифа
   name - наименование тарифа
   billing_id - ID биллинга
   billing_id - id биллинга
   billing_tariff_id - ID тарифа в стороннем биллинге
   billing_tariff_id - id тарифа в стороннем биллинге
  Дополнительно возвращаемые данные:
 
   array(
==== add_group ====
  [Id] => ID добавленного тарифа в случае успеха
''Добавлено в: 3.14.67''
   )
Описание: Добавление группы тарифов
  Обязательные параметры:
   name - наименование
 
==== add_tariff_in_group ====
''Добавлено в: 3.14.67''
Описание: Добавление тарифа в группу тарифов
Обязательные параметры:
  tariff_id - id тарифа
  group_id - id группы тарифов
 
==== delete_group ====
''Добавлено в: 3.14.67''
Описание: Удаление группы тарифов
Обязательные параметры:
   id - id группы


==== edit ====
==== edit ====
  Описание: Редактирование тарифа
  Описание: Редактирование тарифа
  Обязательные параметры:
  Обязательные параметры:
   id - ID тарифа
   id - id тарифа
  Дополнительные параметры:
  Дополнительные параметры:
   is_in_billing - Флаг - есть ли тариф в стороннем биллинге
   is_in_billing - флаг - есть ли тариф в стороннем биллинге
   name - Наименование тарифа
   name - наименование тарифа
   payment - Размер абонплаты
   payment - размер абонплаты
   payment_interval - Интервал списания абонплаты ''(в днях)''
   payment_interval - интервал списания абонплаты ''(в днях)''
   speed_rx - Входящая скорость ''(в kbps)''
   speed_rx - входящая скорость ''(в kbps)''
   speed_tx - Исходящая скорость ''(в kbps)''
   speed_tx - исходящая скорость ''(в kbps)''
   traffic - Включенный трафик по тарифу ''(в MB)''
   traffic - включенный трафик по тарифу ''(в MB)''
 
==== edit_group ====
''Добавлено в: 3.14.67''
Описание: Редактирование группы тарифов
Обязательные параметры:
  id - id группы
  name - наименование


==== get ====
==== get ====
Строка 36: Строка 60:
  Описание: Список тарифов
  Описание: Список тарифов
  Дополнительные параметры:
  Дополнительные параметры:
   billing_id - Id биллинга
   billing_id - id биллинга
   name - Наименование тарифа
   name - наименование тарифа
 
==== get_group ====
''Добавлено в: 3.13.19''
Описание: Информация о группах тарифов
Дополнительные параметры:
  id - id группы (можно через запятую)
 
==== remove_tariff_from_group ====
''Добавлено в: 3.14.67''
Описание: Исключение тарифа из группы тарифов
Обязательные параметры:
  tariff_id - id тарифа
  group_id - id группы тарифов

Текущая версия от 15:00, 1 сентября 2023

en | ru

Раздел API ERP "UserSide"

Назначение: Тарифы

Дополнительные параметры:
action - подкатегория запроса (возможное значение: см.ниже)

Подкатегории

add

Описание: Добавление тарифа
Обязательные параметры:
 name - наименование тарифа
 billing_id - id биллинга
 billing_tariff_id - id тарифа в стороннем биллинге

add_group

Добавлено в: 3.14.67

Описание: Добавление группы тарифов
Обязательные параметры:
 name - наименование

add_tariff_in_group

Добавлено в: 3.14.67

Описание: Добавление тарифа в группу тарифов
Обязательные параметры:
 tariff_id - id тарифа
 group_id - id группы тарифов

delete_group

Добавлено в: 3.14.67

Описание: Удаление группы тарифов
Обязательные параметры:
 id - id группы

edit

Описание: Редактирование тарифа
Обязательные параметры:
 id - id тарифа
Дополнительные параметры:
 is_in_billing - флаг - есть ли тариф в стороннем биллинге
 name - наименование тарифа
 payment - размер абонплаты
 payment_interval - интервал списания абонплаты (в днях)
 speed_rx - входящая скорость (в kbps)
 speed_tx - исходящая скорость (в kbps)
 traffic - включенный трафик по тарифу (в MB)

edit_group

Добавлено в: 3.14.67

Описание: Редактирование группы тарифов
Обязательные параметры:
 id - id группы
 name - наименование

get

Добавлено в: 3.12.2

Описание: Список тарифов
Дополнительные параметры:
 billing_id - id биллинга
 name - наименование тарифа

get_group

Добавлено в: 3.13.19

Описание: Информация о группах тарифов
Дополнительные параметры:
 id - id группы (можно через запятую)

remove_tariff_from_group

Добавлено в: 3.14.67

Описание: Исключение тарифа из группы тарифов
Обязательные параметры:
 tariff_id - id тарифа
 group_id - id группы тарифов