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

Материал из WiKi - UserSide
(Новая страница: «en | ru Section '''API''' ERP "UserSide"»)
 
Нет описания правки
 
Строка 2: Строка 2:


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Purpose: Tariffs
Additional parameters:
action - request subcategory ''(possible value: see below)''
== Subcategories ==
==== add ====
Description: Adding a tariff
Obligatory parameters:
  name - name of tariff
  billing_id - billing id
  billing_tariff_id - id of tariff in third-party billing
==== add_group ====
''Added in: 3.14.67''
Description: Adding a group of tariffs
Obligatory parameters:
  name - name
==== add_tariff_in_group ====
''Added in: 3.14.67''
Description: Adding a tariff to a tariff group
Obligatory parameters:
  tariff_id - tariff id
  group_id - id of tariff group
==== delete_group ====
''Added in: 3.14.67''
Description: Deleting a group of tariffs
Obligatory parameters:
  id - id of the group
==== edit ====
Description: Edit tariff
Obligatory parameters:
  id - id of tariff
Optional parameters:
  is_in_billing - flag - whether the tariff is available in third party billing
  name - tariff name
  payment - amount of subscription fee
  payment_interval - subscription fee debiting interval ''(in days)''
  speed_rx - incoming speed ''(in kbps)''
  speed_tx - outgoing speed ''(in kbps)''
  traffic - included traffic by tariff ''(in MB)''
==== edit_group ====
''Added in: 3.14.67''
Description: Editing a group of tariffs
Obligatory parameters:
  id - id of the group
  name - name
==== get ====
''Added in: 3.12.2''
Description: List of tariffs
Additional parameters:
  billing_id - billing id
  name - name of tariff
==== get_group ====
''Added in: 3.13.19''
Description: Information about tariff groups
Additional parameters:
  id - id of the group (can be comma separated)
==== remove_tariff_from_group ====
''Added in: 3.14.67''
Description: Excluding a tariff from a tariff group
Obligatory parameters:
  tariff_id - id of tariff
  group_id - id of tariff group

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

en | ru

Section API ERP "UserSide"

Purpose: Tariffs

Additional parameters:
action - request subcategory (possible value: see below)

Subcategories

add

Description: Adding a tariff
Obligatory parameters:
 name - name of tariff
 billing_id - billing id
 billing_tariff_id - id of tariff in third-party billing

add_group

Added in: 3.14.67

Description: Adding a group of tariffs
Obligatory parameters:
 name - name

add_tariff_in_group

Added in: 3.14.67

Description: Adding a tariff to a tariff group
Obligatory parameters:
 tariff_id - tariff id
 group_id - id of tariff group

delete_group

Added in: 3.14.67

Description: Deleting a group of tariffs
Obligatory parameters:
 id - id of the group

edit

Description: Edit tariff
Obligatory parameters:
 id - id of tariff
Optional parameters:
 is_in_billing - flag - whether the tariff is available in third party billing
 name - tariff name
 payment - amount of subscription fee
 payment_interval - subscription fee debiting interval (in days)
 speed_rx - incoming speed (in kbps)
 speed_tx - outgoing speed (in kbps)
 traffic - included traffic by tariff (in MB)

edit_group

Added in: 3.14.67

Description: Editing a group of tariffs
Obligatory parameters:
 id - id of the group
 name - name

get

Added in: 3.12.2

Description: List of tariffs
Additional parameters:
 billing_id - billing id
 name - name of tariff

get_group

Added in: 3.13.19

Description: Information about tariff groups
Additional parameters:
 id - id of the group (can be comma separated)

remove_tariff_from_group

Added in: 3.14.67

Description: Excluding a tariff from a tariff group
Obligatory parameters:
 tariff_id - id of tariff
 group_id - id of tariff group