WiKi - UserSide - Вклад [ru]

API node EN

2026-05-10T07:46:13Z

IronBot: Use Splice closure term in EN API docs

[[API_node|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Infrastructure facilities ''(Communication nodes, Splice closures, Poles, Manholes)''

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

IDs of infrastructure object types:
0 - Communication node ''(up to 3.14.21)''
1 - Splice closure
2 - Pole
3 - Manhole
4 - Communication node ''(from 3.14.21)''

== Subcategories ==

==== add ====

''Modified in: 3.16.22 (added level_id parameter)''

''Modified in: 3.16dev9 (added level parameter)''

Description: Adding an object
Obligatory parameters:
type - Type of object
Optional parameters:
city_id - ID of the locality where the object is located
custom_icon_id - ID of custom icon on the map
comment - notes
date_add - date added
entrance - entrance number
house_id - ID of the object location house
inventory_number - inventory number of the object
is_planned - Flag - object is only planned
level - floor number
level_id - floor/level ID ''(from building structure)''
location - object location (text)
node_parent_id - ID of parent object
number - object number
owner_id - owner ID
map_id - map ID ''(for version 3.12 and earlier)''
coordinates - coordinates in text form separated by commas ''(example: 47.839628,35.140553)''

==== add_mark ====
Description: Adding a mark
Obligatory parameters:
node_id - object id
mark_id - mark id

==== change_custom_icon====
Description: Change custom icon on the map
Obligatory parameters:
id - object id
custom_icon_id - icon id

==== delete ====
''Added in: 3.16dev8''
Description: Deletion of a communication facility
Mandatory parameters:
id - object id

==== delete_mark ====
Description: Deleting a mark
Obligatory parameters:
node_id - object id
mark_id - mark id

==== edit ====

''Modified in: 3.16.22 (added level_id parameter)''

''Modified in: 3.16dev9 (added level parameter)''

Description: Edit object
Obligatory parameters:
id - object ID
Optional parameters:
city_id - ID of the locality where the object is located
custom_icon_id - ID of custom icon on the map
comment - notes
coordinates - coordinates in text form with comma ''(example: 47.839628,35.140553)''
date_add - date added
entrance - entrance number
house_id - ID of the house where the object is located
inventory_number - inventory number of the object
is_planned - Flag - object is only planned
level - floor number
level_id - floor/level ID ''(from the building structure)''
location - object location ''(text)''
node_parent_id - ID of parent object
number - object number
owner_id - owner ID

==== get ====
''Modified in: 3.17beta1 (added entrance_number parameter)''

''Modified in: 3.13.35 (added mark_id parameter)''

''Modified at: 3.13.14 (added parent_id parameter)''

''Modified in: 3.13alpha1 (added address_id parameter, removed city_id, street_id, house_id parameters)''

''Modified in: 3.12.74 (added city_id, street_id, house_id parameters)''

Description: List of objects
Obligatory parameters:
None
Optional parameters:
address_id - address unit id ''(can be comma separated)'' ''(since version 3.13)''
city_id - id of the settlement ''(can be comma separated)'' ''(before version 3.13)''
entrance_number - entrance number
house_id - house id ''(can be comma separated)'' ''(before version 3.13)''
id - object id ''(can be comma separated)''
mark_id - mark id
object_type - object type
parent_id - id of parent object ''(can be comma separated)''
street_id - street id ''(can be comma separated)'' ''(before version 3.13)''

==== get_icon_list ====
Description: List of custom icons for objects
Optional parameters:
id - list of object IDs ''(can be comma separated)''

==== get_id ====
''Modified in: 3.14.46 (added type_id parameter)''

''Modified in: 3.12.72 (added possible comment value, added is_entry parameter)''

''Modified in: 3.12.71 (added possible value of additional_dataX)''

Description: Obtain object ID from incoming data
Obligatory parameters:
data_type - type of data we are checking ''(possible values: comment, number, additional_dataX (instead of X - id of additional field))''
data_value - value
Optional parameters:
is_entry - flag - whether to check for a match in part of string occurrence
type_id - object type

==== get_id_by_coord ====
''Added in: 3.12beta30''
Description: Get ID of the nearest object by specified coordinates
Obligatory parameters:
lat - latitude
lon - longitude
Optional parameters:
type - type of object
range - radius in metres within which to display objects

==== get_redevelopment_scheme ====
''Added in: 3.16dev3''
Description: List of redevelopment schemes for a communication facility
Obligatory parameters:
id - id of communication facility

==== get_scheme ====
''Added in: 3.15.15''
Description: Obtaining a switching scheme
Obligatory parameters:
id - id of communication facility

==== get_type_list ====
''Added in: 3.16dev3''
Description: Get the list of communication facility types

==== get_relation_customers ====
''Added in: 3.19.45''

Description: Retrieve information about dependent customers
Required parameters:
id - communication facility id

API EN

2026-05-10T07:46:10Z

IronBot: Use Splice closure term in EN API docs

[[API|ru]] | '''en'''

This section describes the possibilities of using the inbuilt API in ERP "UserSide", which allows you to use the integrated functionality in your own projects.

The API does not cover all functionality at the moment and is gradually being developed, so this page will have frequent changes and additions.

== Operating principle ==

The /api.php file is responsible for interaction.

Both GET and POST requests can be used.

Incoming Parameters:
Mandatory:
key - API key
cat - category of the request
Optional:
skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
Other additional parameters, depending on the category ''(see below in the relevant categories)''.
For example:
customer_id - user id of the customer
is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

Example request:
api.php?key=apikey&cat=abon&action=msg&usercode=1

Returned data:
If the query involves some action or information return, information will be returned in JSON format:
array(
[Result] => OK / ERROR
[ErrorText] => In case of an error, the error text
)

It is also reasonable to check the HTTP code of the response. In case of errors/incorrect requests - HTTP code will be different from 200

== Basic setting ==

Configure the [[UserSide_API_Key_EN|API Key]].

== Categories ==
* [[API_address_EN|address]] - Addresses
* [[API_attach_EN|attach]] - Attachments
* [[API_additional_data_EN|additional_data]] - Additional fields/data for objects
* [[API_advertising_EN|advertising]] - Advertising campaigns
* [[API_billing_EN|billing]] - Billing
* [[API_cable_route_EN|cable_route]] - Cable routes and channels
* [[API_call_EN|call]] - Calls
* [[API_chapter_EN|chapter]] - Custom sections/pages/links
* [[API_commutation_EN|commutation]] - Commutation of objects
* [[API_cross_EN|cross]] - Distribution frames
* [[API_customer_EN|customer]] - Customers. Most actions are relevant for [[Supported_billings|manual billing]]
* [[API_cwdm_EN|cwdm]] - CWDM
* [[API_device_EN|device]] - Equipment
* [[API_employee_EN|employee]] - Employees ''(since 3.16dev2)''
* [[API_fiber_EN|fiber]] - Cable lines
* [[API_gps_EN|gps]] - GPS trackers
* [[API_inventory_EN|inventory]] - Warehouse
* [[API_key_EN|key]] - Keys
* [[API_map_EN|map]] - Coverage maps
* [[API_module_EN|module]] - External requests from modules
* [[API_newin_EN|newin]] - Connection request ''(before 3.18)''
* [[API_node_EN|node]] - Infrastructure facilities ''(communication nodes, splice closures, poles, manholes)''
* [[API_notepad_EN|notepad]] - Notepad
* [[API_operator_EN|operator]] - System operators ''(before 3.16dev2)''
* [[API_owner_EN|owner]] - Owners
* [[API_redirect_EN|redirect]] - Redirects to an object card based on some attribute
* [[API_service_EN|service]] - Additional services
* [[API_setting_EN|setting]] - Settings
* [[API_sms_EN|sms]] - SMS messages
* [[API_splitter_EN|splitter]] - Splitters
* [[API_staff_EN|staff]] - Staff ''(up to 3.16dev2)''
* [[API_system_EN|system]] - System information and operations
* [[API_tariff_EN|tariff]] - Tariffs
* [[API_task_EN|task]] - Tasks
* [[API_trader_EN|trader]] - Vendors
* [[API_vehicle_EN|vehicle]] - Vehicles
* [[API_vlan_EN|vlan]] - VLAN

API additional data EN

2026-05-10T07:39:34Z

IronBot: Normalize splitter terminology in RU and EN API docs

[[API_additional_data|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Action with additional fields/data

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

Additional fields have categories (cat_id)

1 - Employees ''(up to 3.16dev2)''
2 - Cable lines
4 - Users ''(all. Up to 3.14)''
5 - Users ''(legal entities. Up to 3.14)''
6 - Radio equipment
7 - Buildings
8 - Switches
9 - Media converters
10 - System devices
11 - Operators ''(up to 3.16dev2)''.
12 - Rates (manual billing only)
13 - Additional Services (manual billing only)
14 - Communication installations
15 - Distribution frames
16 - VLAN
17 - Tasks
18 - Vehicles
19 - Advertising campaigns
20 - Custom devices
21 - Suppliers
22 - Potential users ''(up to 3.14)''
23 - Splitters
24 - Owners
25 - INVENTORIES
26 - Cable ducts
27 - Cable routes ''(of cable lines)''
28 - Users ''(all. From 3.14)''
29 - Keys
30 - Names of inventory items ''(from 3.14.5)''
40 - Address units ''(from 3.14.14)''
48 - Warehouses ''(from 3.14.12)''
999 - Employees ''(since 3.16dev2)''

Additional fields have a field type (type)

1 - Text
2 - Number
3 - Flag
4 - Selection from list
5 - Text field
6 - Selection from list (including your own variant)
7 - Date
8 - Selection from list (several values)

== Subcategories ==

==== get_list ====
''Modified in: 3.14.22 (numeric values can be used in section parameter)''
Description: Retrieve a list of fields
Obligatory parameters:
section - Category of optional fields [house|node|task|switch|inventory|...numeric values from the catalogue above...]

==== add_field ====
Description: Adding an additional field
Obligatory parameters:
cat_id - category (see above directory)
name - name
Optional parameters
type - field type (see above guide)
size - field size
max_size - maximum size of the field
is_active - flag - field is enabled
position - field position among others
is_require - flag - required to be filled in

==== edit_field ====
''Modified in: 3.13.14 (added value_list parameter)''
Description: Edit additional field
Obligatory parameters:
cat_id - category (see above directory)
id - field id
Optional parameters
See from add_field method
value_list - possible values for the field type "Select from list" ''(separator - vertical line "|")''

==== delete_field ====
Description: Deletion of additional field (deleted only if there are no records with this additional field)
Obligatory parameters:
cat_id - category (see above directory)
id - field id

==== get_value ====
''Modified in: 3.19.16 (added cat_id parameter)''

''Added from:'' 3.12.80''
Description: Retrieve field values
Obligatory parameters:
field_id - field id
Optional parameters:
cat_id - category ''(see the reference above)''
object_id - id of object ''(by which field value)''
value - field value

==== change_value ====

''Modified in: 3.18.27 (cat_id parameter made obligatory)''

Description: Changing the value of an additional field
If the object does not have such an additional field, it will be created.
Obligatory parameters:
field_id - id of additional field
object_id - object id
value - value
cat_id - category ''(see above guide)''

==== change_value_mass ====

''Added in: 3.19beta1''

Description: Mass change of value of an additional field for a set of objects
In case of absence of such additional field for an object - it will be created.
Obligatory parameters:
cat_id - category ''(see above guide)''
field_id - id of additional field
data[] - object id|value
data[] - object id|value
data[] - object id|value
...

API additional data

2026-05-10T07:39:31Z

IronBot: Normalize splitter terminology in RU and EN API docs

'''ru''' | [[API_additional_data_EN|en]]

Раздел '''[[API]]''' ERP "UserSide"

Назначение: Действие с дополнительными полями/данными

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

Дополнительные поля имеют категории (cat_id)

1 - Сотрудники ''(до 3.16dev2)''
2 - Кабельные линии
4 - Абоненты ''(все. До 3.14)''
5 - Абоненты ''(юр.лица. До 3.14)''
6 - Радиооборудование
7 - Здания
8 - Коммутаторы
9 - Медиаконвертеры
10 - Системные устройства
11 - Операторы ''(до 3.16dev2)''
12 - Тарифы (только для ручных биллингов)
13 - Дополнительные услуги (только для ручных биллингов)
14 - Сооружения связи
15 - Кроссы/ODF
16 - VLAN
17 - Задания
18 - Автотранспорт
19 - Рекламные кампании
20 - Произвольные устройства
21 - Поставщики
22 - Потенциальные абоненты ''(до 3.14)''
23 - Сплиттеры
24 - Собственники
25 - ТМЦ
26 - Кабельные каналы
27 - Кабельные трассы ''(кабельных линий)''
28 - Абоненты ''(все. С 3.14)''
29 - Ключи
30 - Наименования ТМЦ ''(с 3.14.5)''
40 - Адресные единицы ''(с 3.14.14)''
48 - Склады ''(с 3.14.12)''
102 - Объекты на карте ''(с 3.19.31)''
999 - Сотрудники ''(с 3.16dev2)''

Дополнительные поля имеют тип поля (type)

1 - Текст
2 - Число
3 - Флаг
4 - Выбор из списка
5 - Текстовое поле
6 - Выбор из списка (в т.ч. свой вариант)
7 - Дата
8 - Выбор из списка (несколько значений)

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

==== get_list ====
''Доработано в: 3.14.22 (в параметре section можно использовать числовые значения)''
Описание: Получение списка полей
Обязательные параметры:
section - Категория дополнительных полей [house|node|task|switch|inventory|...числовые значения из каталога выше...]

==== add_field ====
Описание: Добавление доп.поля
Обязательные параметры:
cat_id - категория (см.выше справочник)
name - наименование
Необязательные параметры
type - тип поля (см.выше справочник)
size - размер поля
max_size - максимальный размер поля
is_active - флаг - поле включено
position - позиция поля среди остальных
is_require - флаг - обязательное к заполнению

==== edit_field ====
''Доработано в: 3.13.14 (добавлен параметр value_list)''
Описание: Редактирование доп.поля
Обязательные параметры:
cat_id - категория (см.выше справочник)
id - id поля
Необязательные параметры
См. из метода add_field
value_list - возможные значения для типа поля "Выбор из списка" ''(разделитель - вертикальная черта "|")''

==== delete_field ====
Описание: Удаление доп.поля (удаляется только если нет записей с этим доп.полем)
Обязательные параметры:
cat_id - категория (см.выше справочник)
id - id поля

==== get_value ====
''Доработано в: 3.19.16 (добавлен параметр cat_id)''

''Добавлено с: 3.12.80''

Описание: Получение значений полей
Обязательные параметры:
field_id - id поля
Необязательные параметры:
cat_id - категория ''(см.выше справочник)''
object_id - id объекта ''(по которому значение поля)''
value - значение поля

==== change_value ====

''Доработано в: 3.18.27 (параметр cat_id сделан обязательным)''

Описание: Изменение значения доп.поля
В случае отсутствия такого доп.поля у объекта - оно будет создано.
Обязательные параметры:
field_id - id дополнительного поля
object_id - id объекта
value - значение
cat_id - категория ''(см.выше справочник)''

==== change_value_mass ====

''Добавлено в: 3.19beta1''

Описание: Массовое изменение значения доп.поля для множества объектов
В случае отсутствия такого доп.поля у объекта - оно будет создано.
Обязательные параметры:
cat_id - категория ''(см.выше справочник)''
field_id - id дополнительного поля
data[] - id объекта|значение
data[] - id объекта|значение
data[] - id объекта|значение
...

API splitter EN

2026-05-10T07:39:25Z

IronBot: Normalize splitter terminology in RU and EN API docs

[[API_splitter|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Splitters

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

== Subcategories ==

==== get ====
''Added in: 3.14beta5''
Description: List of objects
Obligatory parameters:
None
Optional parameters:
id - id of objects ''(can be comma separated)''

==== add ====
''Added in: 3.14beta5''
Description: add object
Obligatory parameters:
node_id - id of the placement object
port_count_in - number of incoming ports
port_count_out - number of outgoing ports
Optional parameters:
description - notes
is_planned - flag - object is only planned

==== edit ====
''Added in: 3.14beta5''
Description: Edit object
Obligatory parameters:
id - id of the object
Optional parameters:
description - notes
is_planned - flag - object is only planned

==== delete====
''Added in: 3.14beta5''
Description: Deleting an object
Obligatory parameters:
id - object id

API splitter

2026-05-10T07:39:18Z

IronBot: Normalize splitter terminology in RU and EN API docs

'''ru''' | [[API_splitter_EN|en]]

Раздел '''[[API]]''' ERP "UserSide"

Назначение: Сплиттеры

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

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

==== get ====
''Добавлено с: 3.14beta5''
Описание: Список объектов
Обязательные параметры:
нет
Дополнительные параметры:
id - id объектов ''(можно через запятую)''

==== add ====
''Добавлено с: 3.14beta5''
Описание: Добавление объекта
Обязательные параметры:
node_id - id объекта размещения
port_count_in - количество входящих портов
port_count_out - количество исходящих портов
Дополнительные параметры:
description - заметки
is_planned - флаг - объект только запланирован

==== edit ====
''Добавлено с: 3.14beta5''
Описание: Редактирование объекта
Обязательные параметры:
id - id объекта
Дополнительные параметры:
description - заметки
is_planned - флаг - объект только запланирован

==== delete====
''Добавлено с: 3.14beta5''
Описание: Удаление объекта
Обязательные параметры:
id - id объекта

API EN

2026-05-10T07:39:14Z

IronBot: Normalize splitter terminology in RU and EN API docs

[[API|ru]] | '''en'''

This section describes the possibilities of using the inbuilt API in ERP "UserSide", which allows you to use the integrated functionality in your own projects.

The API does not cover all functionality at the moment and is gradually being developed, so this page will have frequent changes and additions.

== Operating principle ==

The /api.php file is responsible for interaction.

Both GET and POST requests can be used.

Incoming Parameters:
Mandatory:
key - API key
cat - category of the request
Optional:
skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
Other additional parameters, depending on the category ''(see below in the relevant categories)''.
For example:
customer_id - user id of the customer
is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

Example request:
api.php?key=apikey&cat=abon&action=msg&usercode=1

Returned data:
If the query involves some action or information return, information will be returned in JSON format:
array(
[Result] => OK / ERROR
[ErrorText] => In case of an error, the error text
)

It is also reasonable to check the HTTP code of the response. In case of errors/incorrect requests - HTTP code will be different from 200

== Basic setting ==

Configure the [[UserSide_API_Key_EN|API Key]].

== Categories ==
* [[API_address_EN|address]] - Addresses
* [[API_attach_EN|attach]] - Attachments
* [[API_additional_data_EN|additional_data]] - Additional fields/data for objects
* [[API_advertising_EN|advertising]] - Advertising campaigns
* [[API_billing_EN|billing]] - Billing
* [[API_cable_route_EN|cable_route]] - Cable routes and channels
* [[API_call_EN|call]] - Calls
* [[API_chapter_EN|chapter]] - Custom sections/pages/links
* [[API_commutation_EN|commutation]] - Commutation of objects
* [[API_cross_EN|cross]] - Distribution frames
* [[API_customer_EN|customer]] - Customers. Most actions are relevant for [[Supported_billings|manual billing]]
* [[API_cwdm_EN|cwdm]] - CWDM
* [[API_device_EN|device]] - Equipment
* [[API_employee_EN|employee]] - Employees ''(since 3.16dev2)''
* [[API_fiber_EN|fiber]] - Cable lines
* [[API_gps_EN|gps]] - GPS trackers
* [[API_inventory_EN|inventory]] - Warehouse
* [[API_key_EN|key]] - Keys
* [[API_map_EN|map]] - Coverage maps
* [[API_module_EN|module]] - External requests from modules
* [[API_newin_EN|newin]] - Connection request ''(before 3.18)''
* [[API_node_EN|node]] - Infrastructure facilities ''(communication nodes, fiber optic splice closures, poles, manholes)''
* [[API_notepad_EN|notepad]] - Notepad
* [[API_operator_EN|operator]] - System operators ''(before 3.16dev2)''
* [[API_owner_EN|owner]] - Owners
* [[API_redirect_EN|redirect]] - Redirects to an object card based on some attribute
* [[API_service_EN|service]] - Additional services
* [[API_setting_EN|setting]] - Settings
* [[API_sms_EN|sms]] - SMS messages
* [[API_splitter_EN|splitter]] - Splitters
* [[API_staff_EN|staff]] - Staff ''(up to 3.16dev2)''
* [[API_system_EN|system]] - System information and operations
* [[API_tariff_EN|tariff]] - Tariffs
* [[API_task_EN|task]] - Tasks
* [[API_trader_EN|trader]] - Vendors
* [[API_vehicle_EN|vehicle]] - Vehicles
* [[API_vlan_EN|vlan]] - VLAN

API

2026-05-10T07:39:11Z

IronBot: Normalize splitter terminology in RU and EN API docs

'''ru''' | [[API_EN|en]]

Этот раздел описывает возможности использования встроенного API в ERP "UserSide", что позволяет использовать встроенный функционал в собственных проектах.

API охватывает на данный момент не весь функционал и постепенно дорабатывается, так что данная страница будет иметь частые изменения и дополнения.

== Принцип работы ==

За взаимодействие отвечает файл /api.php

Можно использовать и GET и POST запросы.

Входящие параметры:
Обязательные:
key - ключ API
cat - категория запроса
Необязательные:
skip_internal_api - флаг - не включать внутренние триггеры системы ''(разумно использовать, когда ваш метод API и есть реакция на какой-то триггер и в итоге при обычной работе он же сам и зацикливает свою работу)''
Прочие дополнительные параметры, в зависимости от категории ''(см. ниже в соответствующих категориях)''. Например:
customer_id - id абонента
is_potential - флаг. Может принимать значение 1 или 0. Большинство флагов имеют префикс '''is'''.
lang - язык на котором возвращать ответ ''(в объектах, где поддерживается локализация. По-умолчанию: en)''

Пример запроса:
api.php?key=apikey&cat=abon&action=msg&usercode=1

Возвращаемые данные:
Если запрос предполагает какое-то действие или возврат информации, то в формате JSON будет возвращена информация:
array(
[Result] => OK / ERROR
[ErrorText] => В случае ошибки - текст ошибки
)

Также разумно проверять HTTP-код ответа. В случае возникновения ошибок/некорректных запросов - HTTP-код будет отличаться от 200

== Основная настройка ==

Настройте [[UserSide API Key|API-ключ]].

== Категории ==
* [[API address|address]] - Адреса
* [[API attach|attach]] - Прикрепляемые файлы
* [[API additional_data|additional_data]] - Дополнительные поля/данные для объектов
* [[API advertising|advertising]] - Рекламные кампании
* [[API billing|billing]] - Биллинги
* [[API cable_route|cable_route]] - Кабельные трассы и каналы
* [[API call|call]] - Звонки
* [[API chapter|chapter]] - Собственные разделы/страницы/ссылки
* [[API commutation|commutation]] - Коммутация объектов
* [[API cross|cross]] - ODF/Кроссы
* [[API customer|customer]] - Абоненты. Большинство действий актуально для [[Поддерживаемые биллинги|ручных биллингов]]
* [[API cwdm|cwdm]] - CWDM
* [[API device|device]] - Оборудование
* [[API employee|employee]] - Сотрудники ''(с 3.16dev2)''
* [[API fiber|fiber]] - Кабельные линии
* [[API gps|gps]] - GPS-трекеры
* [[API inventory|inventory]] - Склад
* [[API key|key]] - Ключи
* [[API map|map]] - Карты покрытия
* [[API module|module]] - Внешние запросы от модулей
* [[API newin|newin]] - Заявка на подключение ''(до 3.18)''
* [[API node|node]] - Сооружения связи ''(узлы связи, муфты, опоры, колодцы)''
* [[API notepad|notepad]] - Блокнот
* [[API operator|operator]] - Операторы системы ''(до 3.16dev2)''
* [[API owner|owner]] - Собственники объектов
* [[API redirect|redirect]] - Переадресация на карточку объекта по какому-то признаку
* [[API service|service]] - Дополнительные услуги
* [[API setting|setting]] - Настройка
* [[API sms|sms]] - SMS-сообщения
* [[API splitter|splitter]] - Сплиттеры
* [[API staff|staff]] - Сотрудники ''(до 3.16dev2)''
* [[API system|system]] - Системная информация и операции
* [[API tariff|tariff]] - Тарифы
* [[API task|task]] - Задания
* [[API trader|trader]] - Поставщики
* [[API vehicle|vehicle]] - Автотранспорт
* [[API vlan|vlan]] - Vlan

API additional data EN

2026-05-10T07:33:24Z

IronBot: Use Distribution frame term in EN API docs

[[API_additional_data|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Action with additional fields/data

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

Additional fields have categories (cat_id)

1 - Employees ''(up to 3.16dev2)''
2 - Cable lines
4 - Users ''(all. Up to 3.14)''
5 - Users ''(legal entities. Up to 3.14)''
6 - Radio equipment
7 - Buildings
8 - Switches
9 - Media converters
10 - System devices
11 - Operators ''(up to 3.16dev2)''.
12 - Rates (manual billing only)
13 - Additional Services (manual billing only)
14 - Communication installations
15 - Distribution frames
16 - VLAN
17 - Tasks
18 - Vehicles
19 - Advertising campaigns
20 - Custom devices
21 - Suppliers
22 - Potential users ''(up to 3.14)''
23 - Dividers/ Splitters
24 - Owners
25 - INVENTORIES
26 - Cable ducts
27 - Cable routes ''(of cable lines)''
28 - Users ''(all. From 3.14)''
29 - Keys
30 - Names of inventory items ''(from 3.14.5)''
40 - Address units ''(from 3.14.14)''
48 - Warehouses ''(from 3.14.12)''
999 - Employees ''(since 3.16dev2)''

Additional fields have a field type (type)

1 - Text
2 - Number
3 - Flag
4 - Selection from list
5 - Text field
6 - Selection from list (including your own variant)
7 - Date
8 - Selection from list (several values)

== Subcategories ==

==== get_list ====
''Modified in: 3.14.22 (numeric values can be used in section parameter)''
Description: Retrieve a list of fields
Obligatory parameters:
section - Category of optional fields [house|node|task|switch|inventory|...numeric values from the catalogue above...]

==== add_field ====
Description: Adding an additional field
Obligatory parameters:
cat_id - category (see above directory)
name - name
Optional parameters
type - field type (see above guide)
size - field size
max_size - maximum size of the field
is_active - flag - field is enabled
position - field position among others
is_require - flag - required to be filled in

==== edit_field ====
''Modified in: 3.13.14 (added value_list parameter)''
Description: Edit additional field
Obligatory parameters:
cat_id - category (see above directory)
id - field id
Optional parameters
See from add_field method
value_list - possible values for the field type "Select from list" ''(separator - vertical line "|")''

==== delete_field ====
Description: Deletion of additional field (deleted only if there are no records with this additional field)
Obligatory parameters:
cat_id - category (see above directory)
id - field id

==== get_value ====
''Modified in: 3.19.16 (added cat_id parameter)''

''Added from:'' 3.12.80''
Description: Retrieve field values
Obligatory parameters:
field_id - field id
Optional parameters:
cat_id - category ''(see the reference above)''
object_id - id of object ''(by which field value)''
value - field value

==== change_value ====

''Modified in: 3.18.27 (cat_id parameter made obligatory)''

Description: Changing the value of an additional field
If the object does not have such an additional field, it will be created.
Obligatory parameters:
field_id - id of additional field
object_id - object id
value - value
cat_id - category ''(see above guide)''

==== change_value_mass ====

''Added in: 3.19beta1''

Description: Mass change of value of an additional field for a set of objects
In case of absence of such additional field for an object - it will be created.
Obligatory parameters:
cat_id - category ''(see above guide)''
field_id - id of additional field
data[] - object id|value
data[] - object id|value
data[] - object id|value
...

API cross EN

2026-05-10T07:33:20Z

IronBot: Use Distribution frame term in EN API docs

[[API_cross|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Distribution frames

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

== Subcategories ==

==== add ====
''Added in: 3.14.1''
Description: Addition
Obligatory parameters:
node_id - id of the location object
port_count - number of ports/adapters
Optional parameters:
description - notes
is_planned - flag - planned object

==== get_list ====
''Modified in: 3.14.70 (added node_id parameter)''

''Added from: 3.12.82''
Description: Distribution frame list
Obligatory parameters:
None
Optional parameters:
id - id of objects ''(can be comma separated)''
node_id - id of placement objects ''(comma separated)''

==== edit_adapter ====

''Added from: 3.20.4''

Description: Change adapter properties
Required parameters:
id - object id
side - side [1|2]
number - adapter number
Additional parameters:
signature - signature text

API EN

2026-05-10T07:33:15Z

IronBot: Use Distribution frame term in EN API docs

[[API|ru]] | '''en'''

This section describes the possibilities of using the inbuilt API in ERP "UserSide", which allows you to use the integrated functionality in your own projects.

The API does not cover all functionality at the moment and is gradually being developed, so this page will have frequent changes and additions.

== Operating principle ==

The /api.php file is responsible for interaction.

Both GET and POST requests can be used.

Incoming Parameters:
Mandatory:
key - API key
cat - category of the request
Optional:
skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
Other additional parameters, depending on the category ''(see below in the relevant categories)''.
For example:
customer_id - user id of the customer
is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

Example request:
api.php?key=apikey&cat=abon&action=msg&usercode=1

Returned data:
If the query involves some action or information return, information will be returned in JSON format:
array(
[Result] => OK / ERROR
[ErrorText] => In case of an error, the error text
)

It is also reasonable to check the HTTP code of the response. In case of errors/incorrect requests - HTTP code will be different from 200

== Basic setting ==

Configure the [[UserSide_API_Key_EN|API Key]].

== Categories ==
* [[API_address_EN|address]] - Addresses
* [[API_attach_EN|attach]] - Attachments
* [[API_additional_data_EN|additional_data]] - Additional fields/data for objects
* [[API_advertising_EN|advertising]] - Advertising campaigns
* [[API_billing_EN|billing]] - Billing
* [[API_cable_route_EN|cable_route]] - Cable routes and channels
* [[API_call_EN|call]] - Calls
* [[API_chapter_EN|chapter]] - Custom sections/pages/links
* [[API_commutation_EN|commutation]] - Commutation of objects
* [[API_cross_EN|cross]] - Distribution frames
* [[API_customer_EN|customer]] - Customers. Most actions are relevant for [[Supported_billings|manual billing]]
* [[API_cwdm_EN|cwdm]] - CWDM
* [[API_device_EN|device]] - Equipment
* [[API_employee_EN|employee]] - Employees ''(since 3.16dev2)''
* [[API_fiber_EN|fiber]] - Cable lines
* [[API_gps_EN|gps]] - GPS trackers
* [[API_inventory_EN|inventory]] - Warehouse
* [[API_key_EN|key]] - Keys
* [[API_map_EN|map]] - Coverage maps
* [[API_module_EN|module]] - External requests from modules
* [[API_newin_EN|newin]] - Connection request ''(before 3.18)''
* [[API_node_EN|node]] - Infrastructure facilities ''(communication nodes, fiber optic splice closures, poles, manholes)''
* [[API_notepad_EN|notepad]] - Notepad
* [[API_operator_EN|operator]] - System operators ''(before 3.16dev2)''
* [[API_owner_EN|owner]] - Owners
* [[API_redirect_EN|redirect]] - Redirects to an object card based on some attribute
* [[API_service_EN|service]] - Additional services
* [[API_setting_EN|setting]] - Settings
* [[API_sms_EN|sms]] - SMS messages
* [[API_splitter_EN|splitter]] - Splitters/compactors
* [[API_staff_EN|staff]] - Staff ''(up to 3.16dev2)''
* [[API_system_EN|system]] - System information and operations
* [[API_tariff_EN|tariff]] - Tariffs
* [[API_task_EN|task]] - Tasks
* [[API_trader_EN|trader]] - Vendors
* [[API_vehicle_EN|vehicle]] - Vehicles
* [[API_vlan_EN|vlan]] - VLAN

API vlan EN

2026-05-10T06:57:26Z

IronBot: Align EN API terminology with project localization

[[API_vlan|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: VLAN

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

== Subcategories ==

==== add ====
''Added in: 3.17dev1''

Description: Add vlan
Obligatory parameters:
vid - VLAN ID
name - name
Optional parameters:
comment - notes

==== delete ====
''Added in: 3.17dev1''

Description: Delete vlan
Required parameters:
vid - VLAN ID

==== edit ====
''Added in: 3.17dev1''

Description: Edit vlan
Obligatory parameters:
vid - VLAN ID
Optional parameters:
name - name
comment - notes

==== get_list ====

''Modified in: 3.18beta1 (added vid parameter)''

''Added in: 3.17dev1''

Description: Get vlan list
Obligatory parameters:
No
Optional parameters:
vid - VLAN ID ''(this will list devices and ports with this VLAN)''

==== customer_add_to_vlan ====
''Added in: 3.19.49''

Description: Add a customer to vlan

Required parameters:
vid - VLAN ID
customer_id - customer id

==== customer_remove_from_vlan ====
''Added in: 3.19.49''

Description: Remove a customer from vlan

Required parameters:
vid - VLAN ID
customer_id - customer id

API splitter EN

2026-05-10T06:57:22Z

IronBot: Align EN API terminology with project localization

[[API_splitter|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Splitters/compactors

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

== Subcategories ==

==== get ====
''Added in: 3.14beta5''
Description: List of objects
Obligatory parameters:
None
Optional parameters:
id - id of objects ''(can be comma separated)''

==== add ====
''Added in: 3.14beta5''
Description: add object
Obligatory parameters:
node_id - id of the placement object
port_count_in - number of incoming ports
port_count_out - number of outgoing ports
Optional parameters:
description - notes
is_planned - flag - object is only planned

==== edit ====
''Added in: 3.14beta5''
Description: Edit object
Obligatory parameters:
id - id of the object
Optional parameters:
description - notes
is_planned - flag - object is only planned

==== delete====
''Added in: 3.14beta5''
Description: Deleting an object
Obligatory parameters:
id - object id

API setting EN

2026-05-10T06:57:18Z

IronBot: Align EN API terminology with project localization

[[API_setting|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Settings

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

== Subcategories ==

==== get ====
''Added in: 3.12.13''
Description: Get values of settings parameters
Obligatory parameters:
id - ID of setting parameters ''(can be comma separated)''

==== mark_show ====

''Modified in: 3.17dev1 (added object_type parameter)''

Description: Output a list of marks/layers for objects
Optional parameters:
object_type - type of objects [customer]

==== mark_add ====
Description: Add mark/layer for equipment/objects
Obligatory parameters:
name - name
Optional parameters:
color - color
line_type - line type
is_on_map_by_default - default flag of displaying on the map
type_array - array with object types for labels

==== mark_edit ====
Description: Edit mark
Obligatory parameters:
id - ID of the mark
Optional parameters:
name - name
+ all listed in mark_add

==== mark_delete ====
Description: Delete mark
Obligatory parameters:
id - ID of the mark

API owner EN

2026-05-10T06:57:14Z

IronBot: Align EN API terminology with project localization

[[API_owner|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Actions with owners

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

== Subcategories ==

==== add ====
''Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)''

''Added in: 3.13.26''
Description: Addition
Obligatory parameters:
name - name
Optional parameters:
comment - notes
cost - amount of payment to the owner

==== bind_building ====
''Added in: 3.13.15''
Description: Specifies the owner for the building
Obligatory parameters:
owner_id - owner id
building_id - building id

==== bind_fiber ====
''Added in: 3.13.35''
Description: Specifies the owner for the FOCL
Obligatory parameters:
owner_id - owner id
fiber_id - id of FOCL

==== bind_node ====
''Added in: 3.13.35''
Description: Specifies the owner for the infrastructure object
Obligatory parameters:
owner_id - owner id
node_id - id of infrastructure object

==== delete ====
''Added in: 3.13.26''
Description: Delete object
Obligatory parameters:
id - id of the object

==== edit ====
''Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)''

''Added in: 3.13.26''
Description: Edit object
Obligatory parameters:
id - id of the object
Optional parameters:
name - name
comment - notes
cost - amount of payment to the owner

==== get ====
''Added in: 3.12.10''
Description: List of objects
Optional parameters:
id - list of object id ''(can be comma separated)''

==== unbind_building ====
''Added in: 3.13.15''
Description: Exclude the owner of a building
Obligatory parameters:
owner_id - owner id
building_id - building id

==== unbind_fiber ====
''Added in: 3.13.35''
Description: Unbind ownership of a FOCL
Obligatory parameters:
fiber_id - id of the FOCL

==== unbind_node ====
''Added in: 3.13.35''
Description: Exclusion of the owner of the infrastructure object
Obligatory parameters:
node_id - id of the infrastructure object

API node EN

2026-05-10T06:57:12Z

IronBot: Align EN API terminology with project localization

[[API_node|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Infrastructure facilities ''(Communication nodes, Fiber optic splice closures, Poles, Manholes)''

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

IDs of infrastructure object types:
0 - Communication node ''(up to 3.14.21)''
1 - Fiber optic splice closure
2 - Pole
3 - Manhole
4 - Communication node ''(from 3.14.21)''

== Subcategories ==

==== add ====

''Modified in: 3.16.22 (added level_id parameter)''

''Modified in: 3.16dev9 (added level parameter)''

Description: Adding an object
Obligatory parameters:
type - Type of object
Optional parameters:
city_id - ID of the locality where the object is located
custom_icon_id - ID of custom icon on the map
comment - notes
date_add - date added
entrance - entrance number
house_id - ID of the object location house
inventory_number - inventory number of the object
is_planned - Flag - object is only planned
level - floor number
level_id - floor/level ID ''(from building structure)''
location - object location (text)
node_parent_id - ID of parent object
number - object number
owner_id - owner ID
map_id - map ID ''(for version 3.12 and earlier)''
coordinates - coordinates in text form separated by commas ''(example: 47.839628,35.140553)''

==== add_mark ====
Description: Adding a mark
Obligatory parameters:
node_id - object id
mark_id - mark id

==== change_custom_icon====
Description: Change custom icon on the map
Obligatory parameters:
id - object id
custom_icon_id - icon id

==== delete ====
''Added in: 3.16dev8''
Description: Deletion of a communication facility
Mandatory parameters:
id - object id

==== delete_mark ====
Description: Deleting a mark
Obligatory parameters:
node_id - object id
mark_id - mark id

==== edit ====

''Modified in: 3.16.22 (added level_id parameter)''

''Modified in: 3.16dev9 (added level parameter)''

Description: Edit object
Obligatory parameters:
id - object ID
Optional parameters:
city_id - ID of the locality where the object is located
custom_icon_id - ID of custom icon on the map
comment - notes
coordinates - coordinates in text form with comma ''(example: 47.839628,35.140553)''
date_add - date added
entrance - entrance number
house_id - ID of the house where the object is located
inventory_number - inventory number of the object
is_planned - Flag - object is only planned
level - floor number
level_id - floor/level ID ''(from the building structure)''
location - object location ''(text)''
node_parent_id - ID of parent object
number - object number
owner_id - owner ID

==== get ====
''Modified in: 3.17beta1 (added entrance_number parameter)''

''Modified in: 3.13.35 (added mark_id parameter)''

''Modified at: 3.13.14 (added parent_id parameter)''

''Modified in: 3.13alpha1 (added address_id parameter, removed city_id, street_id, house_id parameters)''

''Modified in: 3.12.74 (added city_id, street_id, house_id parameters)''

Description: List of objects
Obligatory parameters:
None
Optional parameters:
address_id - address unit id ''(can be comma separated)'' ''(since version 3.13)''
city_id - id of the settlement ''(can be comma separated)'' ''(before version 3.13)''
entrance_number - entrance number
house_id - house id ''(can be comma separated)'' ''(before version 3.13)''
id - object id ''(can be comma separated)''
mark_id - mark id
object_type - object type
parent_id - id of parent object ''(can be comma separated)''
street_id - street id ''(can be comma separated)'' ''(before version 3.13)''

==== get_icon_list ====
Description: List of custom icons for objects
Optional parameters:
id - list of object IDs ''(can be comma separated)''

==== get_id ====
''Modified in: 3.14.46 (added type_id parameter)''

''Modified in: 3.12.72 (added possible comment value, added is_entry parameter)''

''Modified in: 3.12.71 (added possible value of additional_dataX)''

Description: Obtain object ID from incoming data
Obligatory parameters:
data_type - type of data we are checking ''(possible values: comment, number, additional_dataX (instead of X - id of additional field))''
data_value - value
Optional parameters:
is_entry - flag - whether to check for a match in part of string occurrence
type_id - object type

==== get_id_by_coord ====
''Added in: 3.12beta30''
Description: Get ID of the nearest object by specified coordinates
Obligatory parameters:
lat - latitude
lon - longitude
Optional parameters:
type - type of object
range - radius in metres within which to display objects

==== get_redevelopment_scheme ====
''Added in: 3.16dev3''
Description: List of redevelopment schemes for a communication facility
Obligatory parameters:
id - id of communication facility

==== get_scheme ====
''Added in: 3.15.15''
Description: Obtaining a switching scheme
Obligatory parameters:
id - id of communication facility

==== get_type_list ====
''Added in: 3.16dev3''
Description: Get the list of communication facility types

==== get_relation_customers ====
''Added in: 3.19.45''

Description: Retrieve information about dependent customers
Required parameters:
id - communication facility id

API customer EN

2026-05-10T06:57:09Z

IronBot: Align EN API terminology with project localization

[[API_customer|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Actions with customers. Most actions are relevant for [[Supported_billings|manual billing]].

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

== Subcategories ==

==== add ====
''Modified in: 3.13.25 (added is_corporate parameter)''
Description: Adding a customer
Optional parameters:
fio - name of the customer
codeti - customer id in the billing system
is_potential - flag - potential customer
is_corporate - flag - legal entity
billing_id - billing id
billing_customer_id - customer id in billing ''(required if this is not a potential customer)''

==== abon_hist ====
''Modified in: 3.17dev1 (excluded usercode parameter, added customer_id parameter)''

Description: Display transactions with user (financial and other)
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID

==== change_balance ====
''Modified in: 3.16dev2 (removed operator_id parameter, added employee_id parameter)''

''Modified in: 3.13.22 (added operator_id parameter)''
Description: Balance change (income/expense operation)
Obligatory parameters:
customer_id - customer ID
amount - Amount
comment - operation notes
Optional parameters:
employee_id - employee ID
operator_id - operator ID ''(before version 3.16dev2)''

==== change_billing ====
''Modified in: 3.16.23 (added billing_user_id parameter)''

''Added in: 3.12.48''

Description: Billing modification
Obligatory parameters:
customer_id - customer id
billing_id - billing id
Optional parameters:
billing_user_id - customer id in billing

==== change_date_connect ====
''Added in: 3.12.80''

Description: Change the connection date
Obligatory parameters:
customer_id - customer ID
value - date

==== delete ====
''Added in: 3.14.21''
Description: Deleting a customer
Obligatory parameters:
id - customer ID

==== edit ====
''Modified in: 3.20.10 (added coordinates parameter)''

''Modified in: 3.16dev3 (added group_id parameter)''

''Modified in: 3.13.56 (added manager_id parameter)''

''Added in: 3.12rc2''

Description: Editing a customer
Obligatory parameters:
id - customer ID
Optional parameters:
account_number - personal account number
agreement_date - agreement date
agreement_number - agreement number
apartment_number - flat number
comment - notes
coordinates - coordinates as text separated by comma ''(example: 47.839628,35.140553)''
date_activity - date of network activity
date_activity_inet - date of internet activity
date_connect - date of connection
email - email address
entrance - entrance number
flag_corporate - flag - legal entity
floor - floor
group_id - group id
house_id - house id
is_potential - flag - potential customer
login - login
manager_id - id of manager employee
name - name of customer
parent_id - id of parent customer ''(for the child customer)''
phone0 - mobile phone number
phone1 - home phone number
phone2 - additional phone number 1
phone3 - additional phone number 2
phone4 - additional phone number 3

==== get_activity_counter ====
''Added in: 3.12.81''
Description: Retrieve the counter of active customers
Obligatory parameters:
type - counter type ''(Possible values: net, internet, personal_area)''

==== get_abon_id ====
''Modified in: 3.14.34 (added possible account value for data_typer parameter)''
Description: Retrieving of customer ID from incoming data
Obligatory parameters:
data_typer - type of data we are checking ''(possible values: account, billing_uid, codeti, dognumber, ip, login, mac, mail, phone)''
data_value - value
Optional parameters:
is_skip_old - flag - do not search among former customers

==== get_customer_group ====

''Added in: 3.19beta1''

Description: Get list of customer groups
Obligatory parameters:
None
Optional parameters:
None

==== get_customers_id ====
''Modified in: 3.18.10 (added is_corporate parameter)''

''Modified in: 3.16dev3 (added parameters name, limit, is_like)''

''Modified in: 3.15.26 (added is_ex parameter)''

''Modified in: 3.14.71 (added dependence_device_id parameter)''

''Modified in: 3.14.58 (added balance_from, balance_to, state_id parameters)''

''Modified in: 3.14.41 (added date_connect_from and date_connect_to parameters)''

''Modified in: 3.14.5 (added address_unit_id parameter)''

''Modified in: 3.13.48 (added tariff_id parameter)''

''Modified in: 3.13.35 (added mark_id parameter)''

''Added in: 3.12.8''
Description: Retrieve list of customer IDs by incoming conditions
Obligatory parameters:
None
Optional parameters ''(but at least one condition must be specified)'':
account_number - personal account number
address_unit_id - address unit id
appartment - number of the flat
balance_from - balance ''(from)''
balance_to - balance ''(to)''
billing_id - billing number id
billing_uuid - customer id in billing
date_connect_from - date of connection ''(from)''
date_connect_to - date of connection ''(to)''
dependence_device_id - id of the device the customers depend on
house_id - house id
is_corporate - flag - a legal entity
is_ex - flag - former customers
manager_id - manager id ''(0 to search without manager)''
mark_id - mark id
name - name/title of customer
state_id - status id
tariff_id - tariff id
limit - maximum number of records to return in the response
is_like - flag - use substring comparison where possible ''(not a full match)''

==== get_data ====
Description: Receiving customer information
Obligatory parameters:
customer_id - customer ID
or
account_number - customer's personal account number
+
billing_id - billing ID

==== get_ip_port_device_commutation ====

''Added in: 3.12beta35''
Description: Obtain IP,MAC-addresses of customers with binding to switches ''(including for work with DHCP)''

==== get_last_ip ====
Description: Get the last used IP address for customers

==== get_mac_history ====

''Added to: 3.16dev8''

Description: Get MAC address change history by customer
Obligatory parameters:
customer_id - customer ID

==== get_max_agreement_number ====

''Added in: 3.12.3''
Description: Get the maximum occupied contract number ''(numeric)''
Optional parameters:
billing_id - billing id of customers among which to perform the selection

==== ip_add ====
''Modified in: 3.17.36 (added mac parameter)''

''Added in: 3.12.83''

Description: Add IP address
Obligatory parameters:
customer_id - customer ID
value - IP
Optional parameters:
mac - MAC of the customer

==== ip_delete ====
''Modified in: 3.19beta1 (added possible value all to the value parameter)''

''Added in: 3.12.83''

Description: Delete IP address
Obligatory parameters:
customer_id - customer ID
value - ip or "-1" for entries with no IP address ''(MAC address only)'' or "all" for all addresses

==== ip_subnet_add ====

''Added in: 3.14.71''

Description: Adds a subnet of IP addresses for a customer
Obligatory parameters:
customer_id - customer ID
ip - initial ip address
subnet - subnet mask/VLSM ''(for example: 24)''

==== ip_subnet_delete ====

''Added to: 3.14.71''

Description: Deletes a subnet of IP addresses from a customer
Obligatory parameters:
customer_id - customer ID
ip - initial ip address

==== list_tarif_available ====

''Excluded in: 3.13''

Description: List of tariffs available to the customer to change tariffs
Obligatory parameters:
usercode - customer ID

==== mark_add ====
''Added in: 3.12.82''
Description: Adds a label on a customer
Obligatory parameters:
customer_id - customer ID
mark_id - mark id

==== mark_delete ====
''Added in: 3.12.82''
Description: Deletes a tag from a customer
Obligatory parameters:
customer_id - customer ID
mark_id - mark id

==== msg ====
''Modified in: 3.17dev1 (usercode parameter removed, customer_id parameter added)''

''Modified in: 3.16dev3 (made usercode parameter optional)''

''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

''Modified in: 3.14.53 (added date_add_from, date_add_to, operator_id parameters)''

Description: Display correspondence with a customer
Optional parameters ''(but must be one)'':
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
date_add_from - date of message (from)
date_add_to - date of message (to)
is_answer - whether the message has an answer ''(1 - answered, 0 - not answered)''
is_archive - whether the message is archived
employee_id - id of the employee who authored the message
operator_id - id of the operator who authored the message ''(before version 3.16dev2)''

==== msg_add ====
''Added in: 3.13.25''
Description: Adds a message from a customer
Obligatory parameters:
customer_id - customer ID
text - Message text
Optional parameters:
is_arc - flag - put the message into the archive

==== pass_change ====
''Modified in: 3.17dev1 (usercode parameter removed, customer_id parameter added)''

''Modified in: 3.15.23 (pass_old parameter became optional)''

Description: Change password for logging in to the Personal Cabinet
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
pass_new - new password
Additional parameters:
pass_old - current password

==== service_add ====

''Added in: 3.18beta1''

Description: Add additional service
Obligatory parameters:
customer_id - customer ID
service_id - id of additional service
Optional parameters:
price - individual price
comment - notes

==== service_remove ====

''Added in: 3.18beta1''

Description: Remove additional service
Obligatory parameters:
customer_id - customer ID
service_id - id of additional service

==== set_mac_by_ip ====

''Added in: 3.12beta35''
Description: specifies the MAC address for the customer's IP address
Obligatory parameters:
ip - IP address of the customer (for example: 192.168.0.1)
mac - MAC address of the customer (for example: 00:11:22:33:44:55)

==== state_change ====

''Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)''

''Added in: 3.12.8''

Description: change the job status of a customer
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
state_id - customer status ID (0 - stop, 1 - paused, 2 - active)

==== tarif_change ====

''Modified in: 3.17dev1 (excluded usercode parameter, added customer_id parameter)''

Description: change of tariff for a customer
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
tarif - new tariff ID

==== to_ex ====
''Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)''

''Added in: 3.12.69''

Description: transfer a customer to the ''Former customers'' category
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID

==== to_normal ====
''Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)''

''Added in: 3.12.90''

Description: switch customer to normal status (from "Former customers")
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID

==== merge ====
''Added in: 3.19.33''

Description: Merge customers
Required parameters:
dst_id - main customer id
src_id - secondary customer id ''(whose information is moved to the main customer)''

==== msg_add_to_customer ====
''Added in: 3.19.45''

Description: Add a message from an employee to a customer
Required parameters:
employee_id - employee id
customer_id - customer id
text - Message text
Optional parameters:
is_arc - flag - put the message into the archive

API cross EN

2026-05-10T06:57:06Z

IronBot: Align EN API terminology with project localization

[[API_cross|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Cross connects/ODF

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

== Subcategories ==

==== add ====
''Added in: 3.14.1''
Description: Addition
Obligatory parameters:
node_id - id of the location object
port_count - number of ports/adapters
Optional parameters:
description - notes
is_planned - flag - planned object

==== get_list ====
''Modified in: 3.14.70 (added node_id parameter)''

''Added from: 3.12.82''
Description: ODF/cross list
Obligatory parameters:
None
Optional parameters:
id - id of objects ''(can be comma separated)''
node_id - id of placement objects ''(comma separated)''

==== edit_adapter ====

''Added from: 3.20.4''

Description: Change adapter properties
Required parameters:
id - object id
side - side [1|2]
number - adapter number
Additional parameters:
signature - signature text

API EN

2026-05-10T06:57:04Z

IronBot: Align EN API terminology with project localization

[[API|ru]] | '''en'''

This section describes the possibilities of using the inbuilt API in ERP "UserSide", which allows you to use the integrated functionality in your own projects.

The API does not cover all functionality at the moment and is gradually being developed, so this page will have frequent changes and additions.

== Operating principle ==

The /api.php file is responsible for interaction.

Both GET and POST requests can be used.

Incoming Parameters:
Mandatory:
key - API key
cat - category of the request
Optional:
skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
Other additional parameters, depending on the category ''(see below in the relevant categories)''.
For example:
customer_id - user id of the customer
is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

Example request:
api.php?key=apikey&cat=abon&action=msg&usercode=1

Returned data:
If the query involves some action or information return, information will be returned in JSON format:
array(
[Result] => OK / ERROR
[ErrorText] => In case of an error, the error text
)

It is also reasonable to check the HTTP code of the response. In case of errors/incorrect requests - HTTP code will be different from 200

== Basic setting ==

Configure the [[UserSide_API_Key_EN|API Key]].

== Categories ==
* [[API_address_EN|address]] - Addresses
* [[API_attach_EN|attach]] - Attachments
* [[API_additional_data_EN|additional_data]] - Additional fields/data for objects
* [[API_advertising_EN|advertising]] - Advertising campaigns
* [[API_billing_EN|billing]] - Billing
* [[API_cable_route_EN|cable_route]] - Cable routes and channels
* [[API_call_EN|call]] - Calls
* [[API_chapter_EN|chapter]] - Custom sections/pages/links
* [[API_commutation_EN|commutation]] - Commutation of objects
* [[API_cross_EN|cross]] - Cross connects/ODF
* [[API_customer_EN|customer]] - Customers. Most actions are relevant for [[Supported_billings|manual billing]]
* [[API_cwdm_EN|cwdm]] - CWDM
* [[API_device_EN|device]] - Equipment
* [[API_employee_EN|employee]] - Employees ''(since 3.16dev2)''
* [[API_fiber_EN|fiber]] - Cable lines
* [[API_gps_EN|gps]] - GPS trackers
* [[API_inventory_EN|inventory]] - Warehouse
* [[API_key_EN|key]] - Keys
* [[API_map_EN|map]] - Coverage maps
* [[API_module_EN|module]] - External requests from modules
* [[API_newin_EN|newin]] - Connection request ''(before 3.18)''
* [[API_node_EN|node]] - Infrastructure facilities ''(communication nodes, fiber optic splice closures, poles, manholes)''
* [[API_notepad_EN|notepad]] - Notepad
* [[API_operator_EN|operator]] - System operators ''(before 3.16dev2)''
* [[API_owner_EN|owner]] - Owners
* [[API_redirect_EN|redirect]] - Redirects to an object card based on some attribute
* [[API_service_EN|service]] - Additional services
* [[API_setting_EN|setting]] - Settings
* [[API_sms_EN|sms]] - SMS messages
* [[API_splitter_EN|splitter]] - Splitters/compactors
* [[API_staff_EN|staff]] - Staff ''(up to 3.16dev2)''
* [[API_system_EN|system]] - System information and operations
* [[API_tariff_EN|tariff]] - Tariffs
* [[API_task_EN|task]] - Tasks
* [[API_trader_EN|trader]] - Vendors
* [[API_vehicle_EN|vehicle]] - Vehicles
* [[API_vlan_EN|vlan]] - VLAN

API task EN

2026-05-10T06:28:36Z

IronBot: Fix EN API localization terminology and wiki markup

[[API_task|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Working with tasks

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

== Subcategories ==

==== add ====
''Modified in: 3.18.29 (added deadline_hour parameter)''

''Modified in: 3.17dev1 (removed usercode, uzelcode parameters and added customer_id, node_id parameters)''

''Modified in: 3.16dev2 (removed unit_id, author_operator_id parameters and added employee_id, author_employee_id parameters)''

''Modified in: 3.12.84 (added parent_task_id parameter)''

''Modified in: 3.12.38 (added unit_id, division_id parameters)''

''Modified in: 3.12.26 (added work_amount parameter)''

''Modified in: 3.12beta31 (added author_operator_id parameter)''

Description: Task creation

Obligatory parameters:
work_typer - task TYPE ID

Optional parameters:
apart - flat number
address_id - ''(for version 3.13 and later)'' address unit id
author_employee_id - ID of the employee author of the task
author_operator_id - task author operator ID ''(before version 3.16dev2)''
citycode - ''(for version 3.12 and earlier)'' the id of the location. If not specified, it is taken from the housecode data.
customer_id - ''(for version 3.17 and later)'' user ID
deadline_hour - time to complete the task ''(from the date of acceptance. In hours)''
device_id - equipment ID
division_id - division ID ''(multiple values separated by commas are allowed)''
dopf_N - value of additional field for field ID N
employee_id - employee ID ''(several values separated by commas are allowed)''
fio - client's full name ''(meaning that 'client' is not yet a user)''
housecode - ''(for version 3.12 and earlier)'' the building id. If not specified, it is taken from the user data - customer_id, or from the communication facility data - node_id
is_high_priority - flag - high priority
node_id - ''(for version 3.17 and later)'' communication facility ID
opis - task notes
parent_task_id - ID of parent task
unit_id - ID of executor ''(multiple values separated by commas are allowed) (up to version 3.16dev2)''
usercode - ''(for version 3.16 and earlier)'' user ID
uzelcode - ''(for version 3.16 and earlier)'' ID of communication facility
work_amount - scope of work
work_datedo - date on which the task is scheduled to run

==== add_customer_to_task ====
''Added in: 3.13.70''

Description: Add a user to a task

Required parameters:
task_id - task id
customer_id - id of customer

==== add_device_to_task ====
''Added in: 3.19beta1''

Description: Add equipment to a task

Obligatory parameters:
task_id - task id
device_id - equipment id

==== add_node_to_task ====
''Added in: 3.20.17''

Description: Adding a communication facility to a task

Obligatory parameters:
task_id - task ID
node_id - communication facility ID

==== change_date_work ====
''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

''Added in: 3.12.83''

Description: Change the date and time of the task ''(date on which the work is scheduled)''

Obligatory parameters:
id - id of the task
value - date
Optional parameters:
employee_id - id of the initiating employee ''(to be recorded in the task history)''
operator_id - id of the initiator operator ''(to be recorded in the task history) (before version 3.16dev2)''

==== change_state ====
''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

Description: Changing the state (status) of a task

Obligatory parameters:
id - id of the task
state_id - task state id
Optional parameters:
employee_id - id of the employee on whose behalf to change the state
operator_id - id of the operator on whose behalf to change the state ''(before version 3.16dev2)''
date_hold - date/time until which to postpone the task ''(when moving to a state with the role Postponed)''

==== check_verify_code ====
Description: Checks the verification code to perform the request

Obligatory parameters:
id - task ID
verify_code - verification code

==== checklist_item_check ====
''Added in: 3.17dev1''

Description: Marks a checklist item in a task

Obligatory parameters:
id - id of checklist item
task_id - task id
employee_id - id of the employee on whose behalf the item is marked

==== checklist_item_uncheck ====
''Added in: 3.17dev1''

Description: Uncheck a checklist item in a task

Required parameters:
id - id of checklist item
task_id - task id

==== comment_add ====
''Modified in: 3.17dev1 (added dateadd parameter)''

''Modified in: 3.16.19 (added reply_comment_id parameter)''

''Modified in: 3.16dev2 (removed operator_id parameter, added employee_id parameter)''

''Modified in: 3.12.89 (added author_operator_id parameter)''

Description: Add comment

Obligatory parameters:
id - task ID
comment - text
Optional parameters:
dateadd - date-time of the comment
employee_id - id of the employee on whose behalf the comment is made
operator_id - id of the operator on whose behalf the comment is ''(before version 3.16dev2)''
reply_comment_id - id of the comment we are replying to

==== comment_edit ====

''Added in: 3.18beta1''

Description: Edit comment

Obligatory parameters:
id - comment ID
task_id - task ID
body - text

==== delete ====
''Added in: 3.14.35''

Description: Deleting a task

Obligatory parameters:
id - id of the task

==== division_add ====
''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

''Added in: 3.13.36''

Description: Adding a division

Mandatory parameters:
id - task id
division_id - id of division
Optional parameters:
employee_id - id of the initiating employee ''(to be recorded in the history by the task)''
operator_id - id of the initiator operator ''(to be recorded in the task history)'' (before version 3.16dev2)''

==== division_delete ====
''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

''Added in: 3.13.36''

Description: Exclusion of division

Obligatory parameters:
id - task id
division_id - id of division
Optional parameters:
employee_id - id of the initiating employee ''(to be recorded in the task history)''
operator_id - id of the initiator operator ''(to be recorded in the task history)'' (before version 3.16dev2)''

==== edit ====
''Modified in: 3.18.30 (added deadline_hour parameter)''

''Modified in: 3.18beta1 (added address_id parameter)''

''Modified in: 3.16dev3 (added type_id parameter)''

''Modified in: 3.15.12 (added parent_task_id parameter)''

''Added in: 3.13.18''
Description: Task modification

Obligatory parameters:
id - task id
Optional parameters:
address_id - id of the address unit
apartment - apartment number
author_employee_id - id of the employee who authored the task
customer_name - arbitrary customer name/title ''(without binding to a customer)''
body - text of the task ''(descriptive part)''
deadline_hour - time to complete the task ''(from the date of acceptance. In hours)''
is_high_priority - flag - high priority
job_time_hour - time to complete the task ''(from the start of work. In hours)''
parent_task_id - id of parent task
type_id - id of the task type

==== employee_add ====
''Added in: 3.16dev2''
Description: Adding an employee

Obligatory parameters:
id - task id
employee_id - employee id
Optional parameters:
author_employee_id - id of the initiating employee ''(to commit to history by task)''

==== employee_delete ====
''Added in: 3.16dev2''
Description: Exclude employee

Obligatory parameters:
id - task id
employee_id - employee id
Optional parameters:
author_employee_id - id of the initiating employee ''(to commit to the history by task)''

==== get_allow_staff ====
''Added in: 3.15.23''
Description: List of performers and divisions that are available for assignment to a task ''(according to settings)''

Obligatory parameters:
id - task id

==== get_catalog_type ====
''Added in: 3.12.22''
Description: Task types

Optional parameters:
id - job type id ''(can be comma separated)''

==== get_catalog_type_group ====
''Added in: 3.16dev3''
Description: Task type groups

==== get_catalog_state ====
''Added in: 3.12.22''
Description: Task state classifier

Optional parameters:
type_id - task type id
state_id - state id ''(can be comma separated)''

==== get_comment ====
''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

''Modified in: 3.14.67 (added id parameter)''

''Modified in: 3.14.53 (added operator_id parameter)''

''Modified in: 3.13.50 (added date_add_from and date_add_to parameters)''

''Added in: 3.12.75''
Description: Comments

Optional parameters ''(but there must be at least one)'':
id - id of comment ''(can be comma separated)''
task_id - id of tasks ''(can be comma separated)''
date_add_from - date of adding comment ''(from)''
date_add_to - date of adding a comment ''(to)''
employee_id - id of the employee-author of the comment
operator_id - id of operator-author of the comment ''(before version 3.16dev2)''

==== get_list ====
''Modified in: 3.18.30 (added parameters change_operation_type, change_employee_id)''

''Modified in: 3.18beta1 (added address_id parameter)''

''Modified in: 3.16dev3 (added task_position, task_position_radius parameters, excluded possible customer_id and house_id values from order_by parameter)''

''Modified in: 3.16dev2 (removed parameters closer_operator_id, staff_id, author_id, watcher_id, added parameters closer_employee_id, employee_id, author_employee_id, watcher_employee_id)''

''Modified in: 3.15.23 (added is_expired parameter)''

''Modified in: 3.14.71 (added node_id parameter)''

''Modified in: 3.14.62 (added closer_operator_id parameter)''

''Modified in: 3.14.56 (added division_id_with_staff parameter)''

''Modified in: 3.14.41 (added possible value -1 to staff_id parameter)''

''Modified in: 3.13.29 (added date_change_from, date_change_to parameters)''

''Modified in: 3.13.28 (added date_change to order_by parameter)''

''Modified in: 3.12.91 (added watcher_id parameter)''

''Modified at: 3.12.83 (added author_id parameter)''

''Modified at: 3.12.78 (added order_by, limit, offset parameters)''

''Modified at: 3.12.62 (added customer_id parameter)''

''Modified in: 3.12.24 (added date_do_from, date_do_to parameters)''

''Modified in: 3.12beta29 (added house_id parameter)''
Description: List of tasks (identifiers)

Optional parameters (sampling conditions):
address_id - ID of the address object ''(can be comma separated)''
apart - apartment/premises number
author_id - ID of operator - task author ''(comma separated) (up to version 3.16dev2)''
author_employee_id - ID of the employee - author of the task ''(can be comma separated)''
change_employee_id - ID of the employee - author of the task changes
change_operation_type - type of actions to change the task ''(possible values: add_comment, change_state)''
closer_employee_id - ID of the employee who closed ''(completed)'' the task ''(can be comma separated)''
closer_operator_id - ID of the operator who closed the ''(completed)'' task ''(can be comma separated) (before version 3.16dev2)''
customer_id - ID of the user ''(can be comma separated)''
date_add_from - task creation date (from)
date_add_to - task creation date (to)
date_change_from - task update date (from)
date_change_to - task update date (to)
date_do_from - date on which the task is scheduled to be executed (from)
date_do_to - date on which the task is scheduled to be executed (to)
date_finish_from - date on which the task is executed (from)
date_finish_to - date on which the task is executed (to)
device_id - equipment ID ''(can be comma separated)''
division_id - division ID ''(can be comma separated)''
division_id_with_staff - division ID ''(including tasks of employees of this division) (can be comma separated)''
employee_id - employee ID ''(can be comma separated, use -1 to get tasks without employees)''
house_id - ID of the work house
is_expired - flag - output only expired tasks
node_id - ID of the location object
staff_id - ID of executor ''(can be comma separated, use -1 to get tasks without executors) (up to version 3.16dev2)''
state_id - task status ID ''(can be comma separated)''
task_position - task coordinates ''(where possible. In lat,lng format. e.g. 40.245218,52.333384)''
task_position_radius - radius from task_position ''(in meters)''
type_id - task type ID ''(can be comma separated)''
watcher_id - task observer operator ID ''(comma separated) (up to version 3.16dev2)''
watcher_employee_id - ID of the task observer employee ''(comma separated)''
order_by - sorting field ''(possible variants: date_add, date_change, date_do, date_finish, state_id, type_id)''
limit - record sampling limit
offset - sampling offset

==== get_related_task_id====
Description: List of related tasks to the current task (identifiers)

Obligatory parameters:
id - task ID

==== get_typical_comments ====
''Added in: 3.14.70''

Description: Get list of typical comments

==== remove_customer_from_task ====
''Added in: 3.15.23''

Description: Excludes a user from a task

Obligatory parameters:
task_id - task id
customer_id - id of user

==== remove_node_from_task ====
''Added in: 3.20.17''

Description: Remove a communication facility from a task

Obligatory parameters:
task_id - task ID
node_id - communication facility ID

==== set_rate ====
''Added in: 3.12.63''
Description: Specifies the individual rate ''(for employees)'' for the task

Obligatory parameters:
task_id - task ID
rate - rate

==== show ====
''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

''Modified in: 3.13.29 (the id parameter can be a comma separated list)''

''Modified in: 3.13.25 (added is_without_comments parameter)''

''Modified in: 3.12.64 (added operator_id parameter)''

Description: Information about the task

Obligatory parameters:
id - task id ''(can be comma separated)''
Optional parameters:
employee_id - id of the employee who is viewing this task ''(to be recorded in the history by task)''
is_without_comments - flag - do not display comments in the task information
operator_id - id of the operator who is viewing this task ''(to be recorded in the task history) (before version 3.16dev2)''

==== (*) staff_add ====
''Deprecated in: 3.16dev2 (use API->task->[[API_task_EN#employee_add|employee_add]])''

''Added in: 3.12.83''

Description: Adding an executor

Obligatory parameters:
id - task id
staff_id - id of the executor
Optional parameters:
operator_id - id of the initiating operator ''(to be recorded in the history by the task)''

==== (*) staff_delete ====
''Deprecated in: 3.16dev2 (use API->task->[[API_task_EN#employee_delete|employee_delete]])''

''Added in: 3.12.83''

Description: Exclude an executor

Obligatory parameters:
id - task id
staff_id - id of the executor
Optional parameters:
operator_id - id of the initiating operator ''(to be recorded in the job history)''

==== watcher_add ====
''Modified in: 3.16dev2 (removed staff_id, operator_id parameters, added employee_id, author_employee_id parameters)''

''Added in: 3.14.21''

Description: Add observer

Obligatory parameters:
id - task id
employee_id - id of observer
staff_id - observer id ''(before 3.16dev2)''
Optional parameters:
author_employee_id - id of the initiating employee ''(to be recorded in the job history)''
operator_id - id of the initiating operator ''(to be recorded in the job history) (before version 3.16dev2)''

==== watcher_delete ====
''Modified in: 3.16dev2 (removed staff_id, operator_id parameters, added employee_id, author_employee_id parameters)''

''Added in: 3.14.21''

Description: Exclusion of observer

Obligatory parameters:
id - task id
employee_id - id of observer
staff_id - observer id ''(before 3.16dev2)''
Optional parameters:
author_employee_id - id of the initiating employee ''(to be recorded in the job history)''
operator_id - id of the initiating operator ''(to be recorded in the job history) (before version 3.16dev2)''

==== add_cable_line_to_task ====
''Added in: 3.20.2''

Description: Add a cable line to a task

Required parameters:
task_id - task id
cable_line_id - cable line id

==== add_owner_to_task ====
''Added in: 3.19.19''

Description: Add an owner to a task

Required parameters:
task_id - task id
owner_id - owner id

==== mark_add ====
''Added in: 3.19.24''
Description: Add a mark to a task
Required parameters:
task_id - task id
mark_id - mark id

==== mark_delete ====
''Added in: 3.19.24''
Description: Delete a mark from a task
Required parameters:
task_id - task id
mark_id - mark id

==== overview_task ====
''Added in: 3.19.7''

Description: Record that an employee has viewed a task

Required parameters:
task_id - task id
employee_id - employee id

==== remove_cable_line_from_task ====
''Added in: 3.20.2''

Description: Remove a cable line from a task

Required parameters:
task_id - task id
cable_line_id - cable line id

==== remove_owner_from_task ====
''Added in: 3.19.19''

Description: Remove an owner from a task

Required parameters:
task_id - task id
owner_id - owner id

API address EN

2026-05-10T06:28:33Z

IronBot: Fix EN API localization terminology and wiki markup

[[API_address|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Action with addresses

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

Also see: [[Address System]]

=== Types of address units ===

==== add_locality_type ====
''Added in 3.13.64''
Description: Adds the type of address unit
Obligatory parameters:
name - name
token - token

==== edit_locality_type ====
''Added in 3.13.64''
Description: Editing the type of the address unit
Obligatory parameters:
id - id
Optional parameters:
name - name
token - token

==== get_locality_type ====
''Added in 3.13.9''
Description: Information about the types of address units
Optional parameters:
token - token

==== get_alias ====
''Added in 3.15.7''
Description: Information about aliases

=== Address units ===

==== add_address ====
''Added in 3.13.64''
Description: Adds an address unit
Obligatory parameters:
locality_type_id - address unit type id
name - name
Optional parameters:
parent_id - id of parent address unit

==== get ====
''Changed in 3.14.69 (added is_disable_hidden input parameter)''

''Added in 3.13.9''

Description: Information about address units
Obligatory parameters ''(must be at least one)'':
id - id of objects ''(can be separated by commas)''
locality_type_id - type of objects ''(can be separated by commas)''
parent_id - id of parent object ''(can be separated by commas)''
is_disable_hidden - flag - do not display hidden address units

==== edit_address ====
''Modified in 3.20.4 (added parent_id parameter)''

''Added in 3.13.60''
Description: Edit address unit
Obligatory parameters:
id - id of the object
Optional parameters:
map_color - HTML color of the polygon on the map
parent_id - parent address unit id

=== Province ===

==== add_province ====
Description: Adding of the province
Obligatory parameters:
name - Name
Optional returned data:
array(
[Id] => ID of added province in case of success
)

==== edit_province ====
Description: Editing of the province
Obligatory parameters:
id - ID of the province
Optional parameters:
The parameter list is used similarly to the add_province method

==== del_province ====
Description: Deletion of the province
Obligatory parameters:
id - ID of the province

==== get_province ====
''Changed in 3.12.17 (added incoming id parameter)''
Description: List of the province
Optional parameters:
id - ID of the province (can be comma separated)
Optional returned data:
array(
[data] => Object data
)

=== District ===

==== add_district ====
''Added in 3.13.46''
Description: Adding a district
Obligatory parameters:
name - name

==== edit_district ====
''Added in 3.13.46''
Description: Edit_district
Obligatory parameters:
id - id of the district
Optional parameters:
The parameter list is used similarly to the add_province method

==== del_district ====
''Added in 3.13.46''
Description: Deletion of a district
Obligatory parameters:
id - id of the district

==== get_district ====
''Added in 3.13.46''
Description: List of districts
Optional parameters:
id - id of districts ''(can be comma separated)''

=== City ===

==== add_city ====
Description: Adding a city
Obligatory parameters:
name - Name of the city
Optional parameters:
province_id - ID of the province
district_id - ID of the district in the region
Optional returned data:
array(
[Id] => ID of added city in case of success
)

==== get_city ====
''Modified 3.14.69 (added incoming parameter is_disable_hidden)''

''Modified 3.13.46 (added district_id input parameter)''

''Modified 3.12.17 (added incoming id parameter)''

Description: List of the cities
Optional parameters:
id - id of the city ''(can be comma separated)''
district_id - id of the district ''(comma separated)''
province_id - province id ''(comma separated)''
is_disable_hidden - flag - do not display hidden cities

==== edit_city ====
Description: Editing a city
Obligatory parameters:
id - ID of the city
Optional parameters:
The list of parameters is used similarly to the add_city method

==== del_city ====
Description: Deletion of a city
Obligatory parameters:
id - ID of the city

=== Area in the city ===

==== add_area ====
Description: Adding an area in a city
Obligatory parameters:
city_id - ID of the city
name - Name
Additionally returned data:
array(
[Id] => ID of added area in case of success
)

==== get_area ====
''Changed in 3.14.69 (added incoming parameter is_disable_hidden)''

''Modified 3.12.17 (added id parameter)''

Description: List of areas of the cities
Optional parameters:
id - ID of areas (can be comma separated)
city_id - ID of cities (can be separated by commas)
is_disable_hidden - flag - do not display hidden areas

==== edit_area ====
Description: Edit the area of the city
Obligatory parameters:
id - ID of the city`s area
Optional parameters:
The list of parameters is used similarly to the add_area method

==== del_area ====
Description: Removal of the city`s area
Obligatory parameters:
id - ID of the city`s area

=== Street ===

==== add_street ====
Description: Add street
Obligatory parameters:
city_id - ID of the city
name - Name
Optional parameters:
area_id - ID of the area of the city
Optional returned data:
array(
[Id] => ID of added street in case of success
)

==== get_street ====
''Modified 3.14.69 (added is_disable_hidden input parameter)''

''Modified 3.12.17 (added id parameter)''
Description: List of streets
Optional parameters:
id - ID of streets ''(can be comma separated)''
city_id - ID of city ''(can be comma separated)''
area_id - ID of the city`s area ''(can be comma separated)''
is_disable_hidden - flag - do not display hidden streets

==== edit_street ====
Description: Edit street
Obligatory parameters:
id - street id
Optional parameters:
The parameter list is used similarly to the add_street method

==== del_street ====
Description: Delete street
Obligatory parameters:
id - street ID

=== Building ===

==== add_house ====
''Modified 3.16.19 (added type_id parameter)''

''Modified 3.13.57 (added comment parameter, task_comment)''

''Modified in 3.13.15 (added parameter apart_count, level_count, entrance_count)''

Description: Adding a building
Obligatory parameters:
city_id - id of city
street_id - street id
number - building number
block - building block/corpus ''(for version 3.12 and below)''
custom_name - Arbitrary ''(full)'' building name ''(for version 3.12 and below)''
Optional parameters:
area_id - the id of the city`s area
apart_count - number of households in the building
comment - notes
entrance_count - number of entrances/entrances in the building
level_count - number of floors in the building
task_comment - task note for the building
type_id - building type id

==== add_house_mark ====
Description: Add a mark on the house
Obligatory parameters:
house_id - house ID
mark_id - ID of mark

==== del_house ====
Description: Removal of the house
Obligatory parameters:
id - ID of the house

==== delete_house_mark ====
Description: Remove house mark
Obligatory parameters:
house_id - house ID
mark_id - mark ID

==== edit_building_coord ====
''Added in 3.13.14''
Description: Change the geographical coordinates of a building/construction
Obligatory parameters:
id - building id
coord - coordinates of the building polygon vertices

==== get_building_structure ====
''Added in 3.16dev3''

Description: View building structure
Obligatory parameters:
id - building id

==== edit_building_structure ====
''Added in 3.15.20''

Description: Edit building structure
Obligatory parameters:
id - id of the building
Optional parameters:
level_list - comma separated list of level types ''(floors)''

==== edit_house ====

''Changed in 3.18beta1 (added task_interval parameter)''

''Changed in 3.16.20 (added type_id, is_not_connected)''

''Modified 3.13.57 (added comment parameter, task_comment)''

''Modified 3.13.15 (added parameter apart_count, level_count, entrance_count)''

Description: Edit building
Obligatory parameters:
id - id of building ''(for version 3.12 and below)''/id of address unit ''(for version 3.13 and above)''
or
building_id - building id ''(for version 3.13 and above)''
Optional parameters:
area_id - the id of the city`s area
apart_count - number of households in the building
block - block/corpus of the building ''(for version 3.12 and below)''
city_id - id of the city
comment - notes
custom_name - Arbitrary ''(full)'' building name ''(for version 3.12 and below)''
entrance_count - number of entrances/entrances in the building
is_not_connected - flag - building is not connected
level_count - number of floors in the building
number - building number
street_id - street id
task_comment - work note on the building
task_interval - possible time intervals for work ''(for example: {"day":[[0,23],[0,23],[0,23],[0,23],[0,23],[0,23],[0,23],[0,23]]})'')
type_id - building type id

==== get_house ====
''Refined in: 3.16dev3 (added parameters name, limit, is_like)''

''Refined in: 3.13.35 (added mark_id parameters)''

''Refined in 3.13.19 (added building_id parameter)''

Description: List of houses
Obligatory parameters:
None
Optional parameters:
id - building id ''(for version 3.12. Can be comma separated)'', address unit id ''(for version 3.13+. Can be comma separated)''
building_id - building id ''(for version 3.13+. Can be separated by commas)''
city_id - ID of the city ''(comma separated)''
area_id - ID of the city`s area ''(comma separated)''
street_id - ID of the streets ''(comma separated)''
is_disable_hidden - flag - do not display hidden houses
mark_id - mark id
name - full address of the building ''(according to the template)''
limit - maximum number of records to return in the response
is_like - flag - use substring comparison where possible ''(not a full match)''

==== get_level ====
''Added in 3.15.20''

Description: Directory of levels (floors) types
Obligatory parameters:
None

==== move_child_object ====
''Added in 3.16dev8''

Description: Move child objects from a building to another building
Obligatory parameters:
src_building_id - id of the source building
dst_building_id - id of the destination building

==== owner_remove ====
Description: Removing owner from a building
See API->owner->[[API owner#unbind_building|unbind_building]]

==== (*) add_house_to_map ====
''Added in 3.12.40''

''Removed in 3.13''

Description: Adds a house to the map
Obligatory parameters:
house_id - house ID
map_id - map ID
coord - coordinates of vertices of the house polygon

==== (*) remove_house_from_map ====
''Added in 3.12.40''

''Removed in 3.13''

Description: Removing a house from the map
Obligatory parameters:
house_id - house ID
map_id - map ID

==== get_building_type ====
''Added in 3.20.5''

Description: Building type reference
Required parameters:
none

API additional data EN

2026-05-10T06:28:31Z

IronBot: Fix EN API localization terminology and wiki markup

[[API_additional_data|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Action with additional fields/data

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

Additional fields have categories (cat_id)

1 - Employees ''(up to 3.16dev2)''
2 - Cable lines
4 - Users ''(all. Up to 3.14)''
5 - Users ''(legal entities. Up to 3.14)''
6 - Radio equipment
7 - Buildings
8 - Switches
9 - Media converters
10 - System devices
11 - Operators ''(up to 3.16dev2)''.
12 - Rates (manual billing only)
13 - Additional Services (manual billing only)
14 - Communication installations
15 - Crosses/ODFs
16 - VLAN
17 - Tasks
18 - Vehicles
19 - Advertising campaigns
20 - Custom devices
21 - Suppliers
22 - Potential users ''(up to 3.14)''
23 - Dividers/ Splitters
24 - Owners
25 - INVENTORIES
26 - Cable ducts
27 - Cable routes ''(of cable lines)''
28 - Users ''(all. From 3.14)''
29 - Keys
30 - Names of inventory items ''(from 3.14.5)''
40 - Address units ''(from 3.14.14)''
48 - Warehouses ''(from 3.14.12)''
999 - Employees ''(since 3.16dev2)''

Additional fields have a field type (type)

1 - Text
2 - Number
3 - Flag
4 - Selection from list
5 - Text field
6 - Selection from list (including your own variant)
7 - Date
8 - Selection from list (several values)

== Subcategories ==

==== get_list ====
''Modified in: 3.14.22 (numeric values can be used in section parameter)''
Description: Retrieve a list of fields
Obligatory parameters:
section - Category of optional fields [house|node|task|switch|inventory|...numeric values from the catalogue above...]

==== add_field ====
Description: Adding an additional field
Obligatory parameters:
cat_id - category (see above directory)
name - name
Optional parameters
type - field type (see above guide)
size - field size
max_size - maximum size of the field
is_active - flag - field is enabled
position - field position among others
is_require - flag - required to be filled in

==== edit_field ====
''Modified in: 3.13.14 (added value_list parameter)''
Description: Edit additional field
Obligatory parameters:
cat_id - category (see above directory)
id - field id
Optional parameters
See from add_field method
value_list - possible values for the field type "Select from list" ''(separator - vertical line "|")''

==== delete_field ====
Description: Deletion of additional field (deleted only if there are no records with this additional field)
Obligatory parameters:
cat_id - category (see above directory)
id - field id

==== get_value ====
''Modified in: 3.19.16 (added cat_id parameter)''

''Added from:'' 3.12.80''
Description: Retrieve field values
Obligatory parameters:
field_id - field id
Optional parameters:
cat_id - category ''(see the reference above)''
object_id - id of object ''(by which field value)''
value - field value

==== change_value ====

''Modified in: 3.18.27 (cat_id parameter made obligatory)''

Description: Changing the value of an additional field
If the object does not have such an additional field, it will be created.
Obligatory parameters:
field_id - id of additional field
object_id - object id
value - value
cat_id - category ''(see above guide)''

==== change_value_mass ====

''Added in: 3.19beta1''

Description: Mass change of value of an additional field for a set of objects
In case of absence of such additional field for an object - it will be created.
Obligatory parameters:
cat_id - category ''(see above guide)''
field_id - id of additional field
data[] - object id|value
data[] - object id|value
data[] - object id|value
...

API owner EN

2026-05-10T06:28:28Z

IronBot: Fix EN API localization terminology and wiki markup

[[API_owner|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Actions with object owners

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

== Subcategories ==

==== add ====
''Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)''

''Added in: 3.13.26''
Description: Addition
Obligatory parameters:
name - name
Optional parameters:
comment - notes
cost - amount of payment to the owner

==== bind_building ====
''Added in: 3.13.15''
Description: Specifies the owner for the building
Obligatory parameters:
owner_id - owner id
building_id - building id

==== bind_fiber ====
''Added in: 3.13.35''
Description: Specifies the owner for the FOCL
Obligatory parameters:
owner_id - owner id
fiber_id - id of FOCL

==== bind_node ====
''Added in: 3.13.35''
Description: Specifies the owner for the infrastructure object
Obligatory parameters:
owner_id - owner id
node_id - id of infrastructure object

==== delete ====
''Added in: 3.13.26''
Description: Delete object
Obligatory parameters:
id - id of the object

==== edit ====
''Modified in: 3.16.1 (added parameters address, ceo_name, phone, agreement_number, agreement_date, requisites, comment, cost)''

''Added in: 3.13.26''
Description: Edit object
Obligatory parameters:
id - id of the object
Optional parameters:
name - name
comment - notes
cost - amount of payment to the owner

==== get ====
''Added in: 3.12.10''
Description: List of objects
Optional parameters:
id - list of object id ''(can be comma separated)''

==== unbind_building ====
''Added in: 3.13.15''
Description: Exclude the owner of a building
Obligatory parameters:
owner_id - owner id
building_id - building id

==== unbind_fiber ====
''Added in: 3.13.35''
Description: Unbind ownership of a FOCL
Obligatory parameters:
fiber_id - id of the FOCL

==== unbind_node ====
''Added in: 3.13.35''
Description: Exclusion of the owner of the infrastructure object
Obligatory parameters:
node_id - id of the infrastructure object

API splitter EN

2026-05-10T06:28:26Z

IronBot: Fix EN API localization terminology and wiki markup

[[API_splitter|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Dividers/splitters

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

== Subcategories ==

==== get ====
''Added in: 3.14beta5''
Description: List of objects
Obligatory parameters:
None
Optional parameters:
id - id of objects ''(can be comma separated)''

==== add ====
''Added in: 3.14beta5''
Description: add object
Obligatory parameters:
node_id - id of the placement object
port_count_in - number of incoming ports
port_count_out - number of outgoing ports
Optional parameters:
description - notes
is_planned - flag - object is only planned

==== edit ====
''Added in: 3.14beta5''
Description: Edit object
Obligatory parameters:
id - id of the object
Optional parameters:
description - notes
is_planned - flag - object is only planned

==== delete====
''Added in: 3.14beta5''
Description: Deleting an object
Obligatory parameters:
id - object id

API customer EN

2026-05-10T06:28:23Z

IronBot: Fix EN API localization terminology and wiki markup

[[API_customer|ru]] | '''en'''

Section '''[[API_EN|API]]''' ERP "UserSide"

Purpose: Actions with subscribers. Most actions are relevant for [[Supported_billings|manual billing]].

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

== Subcategories ==

==== add ====
''Modified in: 3.13.25 (added is_corporate parameter)''
Description: Adding a customer
Optional parameters:
fio - name of the customer
codeti - customer id in the billing system
is_potential - flag - potential customer
is_corporate - flag - legal entity
billing_id - billing id
billing_customer_id - customer id in billing ''(required if this is not a potential customer)''

==== abon_hist ====
''Modified in: 3.17dev1 (excluded usercode parameter, added customer_id parameter)''

Description: Display transactions with user (financial and other)
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' subscriber ID
customer_id - ''(for version 3.17 and later)'' customer ID

==== change_balance ====
''Modified in: 3.16dev2 (removed operator_id parameter, added employee_id parameter)''

''Modified in: 3.13.22 (added operator_id parameter)''
Description: Balance change (income/expense operation)
Obligatory parameters:
customer_id - customer ID
amount - Amount
comment - operation notes
Optional parameters:
employee_id - employee ID
operator_id - operator ID ''(before version 3.16dev2)''

==== change_billing ====
''Modified in: 3.16.23 (added billing_user_id parameter)''

''Added in: 3.12.48''

Description: Billing modification
Obligatory parameters:
customer_id - customer id
billing_id - billing id
Optional parameters:
billing_user_id - customer id in billing

==== change_date_connect ====
''Added in: 3.12.80''

Description: Change the connection date
Obligatory parameters:
customer_id - customer ID
value - date

==== delete ====
''Added in: 3.14.21''
Description: Deleting a customer
Obligatory parameters:
id - customer ID

==== edit ====
''Modified in: 3.20.10 (added coordinates parameter)''

''Modified in: 3.16dev3 (added group_id parameter)''

''Modified in: 3.13.56 (added manager_id parameter)''

''Added in: 3.12rc2''

Description: Editing a customer
Obligatory parameters:
id - customer ID
Optional parameters:
account_number - personal account number
agreement_date - agreement date
agreement_number - agreement number
apartment_number - flat number
comment - notes
coordinates - coordinates as text separated by comma ''(example: 47.839628,35.140553)''
date_activity - date of network activity
date_activity_inet - date of internet activity
date_connect - date of connection
email - email address
entrance - entrance number
flag_corporate - flag - legal entity
floor - floor
group_id - group id
house_id - house id
is_potential - flag - potential customer
login - login
manager_id - id of manager employee
name - name of customer
parent_id - id of parent customer ''(for the child customer)''
phone0 - mobile phone number
phone1 - home phone number
phone2 - additional phone number 1
phone3 - additional phone number 2
phone4 - additional phone number 3

==== get_activity_counter ====
''Added in: 3.12.81''
Description: Retrieve the counter of active customers
Obligatory parameters:
type - counter type ''(Possible values: net, internet, personal_area)''

==== get_abon_id ====
''Modified in: 3.14.34 (added possible account value for data_typer parameter)''
Description: Retrieving of customer ID from incoming data
Obligatory parameters:
data_typer - type of data we are checking ''(possible values: account, billing_uid, codeti, dognumber, ip, login, mac, mail, phone)''
data_value - value
Optional parameters:
is_skip_old - flag - do not search among former customers

==== get_customer_group ====

''Added in: 3.19beta1''

Description: Get list of customer groups
Obligatory parameters:
None
Optional parameters:
None

==== get_customers_id ====
''Modified in: 3.18.10 (added is_corporate parameter)''

''Modified in: 3.16dev3 (added parameters name, limit, is_like)''

''Modified in: 3.15.26 (added is_ex parameter)''

''Modified in: 3.14.71 (added dependence_device_id parameter)''

''Modified in: 3.14.58 (added balance_from, balance_to, state_id parameters)''

''Modified in: 3.14.41 (added date_connect_from and date_connect_to parameters)''

''Modified in: 3.14.5 (added address_unit_id parameter)''

''Modified in: 3.13.48 (added tariff_id parameter)''

''Modified in: 3.13.35 (added mark_id parameter)''

''Added in: 3.12.8''
Description: Retrieve list of customer IDs by incoming conditions
Obligatory parameters:
None
Optional parameters ''(but at least one condition must be specified)'':
account_number - personal account number
address_unit_id - address unit id
appartment - number of the flat
balance_from - balance ''(from)''
balance_to - balance ''(to)''
billing_id - billing number id
billing_uuid - customer id in billing
date_connect_from - date of connection ''(from)''
date_connect_to - date of connection ''(to)''
dependence_device_id - id of the device the customers depend on
house_id - house id
is_corporate - flag - a legal entity
is_ex - flag - former customers
manager_id - manager id ''(0 to search without manager)''
mark_id - mark id
name - name/title of customer
state_id - status id
tariff_id - tariff id
limit - maximum number of records to return in the response
is_like - flag - use substring comparison where possible ''(not a full match)''

==== get_data ====
Description: Receiving customer information
Obligatory parameters:
customer_id - customer ID
or
account_number - customer's personal account number
+
billing_id - billing ID

==== get_ip_port_device_commutation ====

''Added in: 3.12beta35''
Description: Obtain IP,MAC-addresses of customers with binding to switches ''(including for work with DHCP)''

==== get_last_ip ====
Description: Get the last used IP address for customers

==== get_mac_history ====

''Added to: 3.16dev8''

Description: Get MAC address change history by customer
Obligatory parameters:
customer_id - customer ID

==== get_max_agreement_number ====

''Added in: 3.12.3''
Description: Get the maximum occupied contract number ''(numeric)''
Optional parameters:
billing_id - billing id of customers among which to perform the selection

==== ip_add ====
''Modified in: 3.17.36 (added mac parameter)''

''Added in: 3.12.83''

Description: Add IP address
Obligatory parameters:
customer_id - customer ID
value - IP
Optional parameters:
mac - MAC of the customer

==== ip_delete ====
''Modified in: 3.19beta1 (added possible value all to the value parameter)''

''Added in: 3.12.83''

Description: Delete IP address
Obligatory parameters:
customer_id - customer ID
value - ip or "-1" for entries with no IP address ''(MAC address only)'' or "all" for all addresses

==== ip_subnet_add ====

''Added in: 3.14.71''

Description: Adds a subnet of IP addresses for a customer
Obligatory parameters:
customer_id - customer ID
ip - initial ip address
subnet - subnet mask/VLSM ''(for example: 24)''

==== ip_subnet_delete ====

''Added to: 3.14.71''

Description: Deletes a subnet of IP addresses from a customer
Obligatory parameters:
customer_id - customer ID
ip - initial ip address

==== list_tarif_available ====

''Excluded in: 3.13''

Description: List of tariffs available to the customer to change tariffs
Obligatory parameters:
usercode - customer ID

==== mark_add ====
''Added in: 3.12.82''
Description: Adds a label on a customer
Obligatory parameters:
customer_id - customer ID
mark_id - mark id

==== mark_delete ====
''Added in: 3.12.82''
Description: Deletes a tag from a customer
Obligatory parameters:
customer_id - customer ID
mark_id - mark id

==== msg ====
''Modified in: 3.17dev1 (usercode parameter removed, customer_id parameter added)''

''Modified in: 3.16dev3 (made usercode parameter optional)''

''Modified in: 3.16dev2 (excluded operator_id parameter, added employee_id parameter)''

''Modified in: 3.14.53 (added date_add_from, date_add_to, operator_id parameters)''

Description: Display correspondence with a customer
Optional parameters ''(but must be one)'':
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
date_add_from - date of message (from)
date_add_to - date of message (to)
is_answer - whether the message has an answer ''(1 - answered, 0 - not answered)''
is_archive - whether the message is archived
employee_id - id of the employee who authored the message
operator_id - id of the operator who authored the message ''(before version 3.16dev2)''

==== msg_add ====
''Added in: 3.13.25''
Description: Adds a message from a customer
Obligatory parameters:
customer_id - customer ID
text - Message text
Optional parameters:
is_arc - flag - put the message into the archive

==== pass_change ====
''Modified in: 3.17dev1 (usercode parameter removed, customer_id parameter added)''

''Modified in: 3.15.23 (pass_old parameter became optional)''

Description: Change password for logging in to the Personal Cabinet
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
pass_new - new password
Additional parameters:
pass_old - current password

==== service_add ====

''Added in: 3.18beta1''

Description: Add additional service
Obligatory parameters:
customer_id - customer ID
service_id - id of additional service
Optional parameters:
price - individual price
comment - notes

==== service_remove ====

''Added in: 3.18beta1''

Description: Remove additional service
Obligatory parameters:
customer_id - customer ID
service_id - id of additional service

==== set_mac_by_ip ====

''Added in: 3.12beta35''
Description: specifies the MAC address for the customer's IP address
Obligatory parameters:
ip - IP address of the customer (for example: 192.168.0.1)
mac - MAC address of the customer (for example: 00:11:22:33:44:55)

==== state_change ====

''Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)''

''Added in: 3.12.8''

Description: change the job status of a customer
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
state_id - customer status ID (0 - stop, 1 - paused, 2 - active)

==== tarif_change ====

''Modified in: 3.17dev1 (excluded usercode parameter, added customer_id parameter)''

Description: change of tariff for a customer
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID
tarif - new tariff ID

==== to_ex ====
''Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)''

''Added in: 3.12.69''

Description: transfer a customer to the ''Former customers'' category
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID

==== to_normal ====
''Modified in: 3.17dev1 (removed usercode parameter, added customer_id parameter)''

''Added in: 3.12.90''

Description: switch customer to normal status (from "Former customers")
Obligatory parameters:
usercode - ''(for version 3.16 and earlier)'' customer ID
customer_id - ''(for version 3.17 and later)'' customer ID

==== merge ====
''Added in: 3.19.33''

Description: Merge customers
Required parameters:
dst_id - main customer id
src_id - secondary customer id ''(whose information is moved to the main customer)''

==== msg_add_to_customer ====
''Added in: 3.19.45''

Description: Add a message from an employee to a customer
Required parameters:
employee_id - employee id
customer_id - customer id
text - Message text
Optional parameters:
is_arc - flag - put the message into the archive

API EN

2026-05-10T06:28:20Z

IronBot: Fix EN API localization terminology and wiki markup

[[API|ru]] | '''en'''

This section describes the possibilities of using the inbuilt API in ERP "UserSide", which allows you to use the integrated functionality in your own projects.

The API does not cover all functionality at the moment and is gradually being developed, so this page will have frequent changes and additions.

== Operating principle ==

The /api.php file is responsible for interaction.

Both GET and POST requests can be used.

Incoming Parameters:
Mandatory:
key - API key
cat - category of the request
Optional:
skip_internal_api - flag - do not include internal system triggers ''(reasonable to use when your API method is a reaction to some trigger and it ends up looping itself during normal operation)''
Other additional parameters, depending on the category ''(see below in the relevant categories)''.
For example:
customer_id - user id of the customer
is_potential - flag. It can take the value 1 or 0. Most flags have the prefix '''is'''.

Example request:
api.php?key=apikey&cat=abon&action=msg&usercode=1

Returned data:
If the query involves some action or information return, information will be returned in JSON format:
array(
[Result] => OK / ERROR
[ErrorText] => In case of an error, the error text
)

It is also reasonable to check the HTTP code of the response. In case of errors/incorrect requests - HTTP code will be different from 200

== Basic setting ==

Configure the [[UserSide_API_Key_EN|API Key]].

== Categories ==
* [[API_address_EN|address]] - Addresses
* [[API_attach_EN|attach]] - Attachments
* [[API_additional_data_EN|additional_data]] - Additional fields/data for objects
* [[API_advertising_EN|advertising]] - Advertising campaigns
* [[API_billing_EN|billing]] - Billing
* [[API_cable_route_EN|cable_route]] - Cable routes and channels
* [[API_call_EN|call]] - Calls
* [[API_chapter_EN|chapter]] - Custom sections/pages/links
* [[API_commutation_EN|commutation]] - Commutation of objects
* [[API_cross_EN|cross]] - ODF/Crosses
* [[API_customer_EN|customer]] - Subscribers. Most actions are relevant for [[Supported_billings|manual billing]]
* [[API_cwdm_EN|cwdm]] - CWDM
* [[API_device_EN|device]] - Equipment
* [[API_employee_EN|employee]] - Employees ''(since 3.16dev2)''
* [[API_fiber_EN|fiber]] - Cable lines
* [[API_gps_EN|gps]] - GPS trackers
* [[API_inventory_EN|inventory]] - Warehouse
* [[API_key_EN|key]] - Keys
* [[API_map_EN|map]] - Coverage maps
* [[API_module_EN|module]] - External requests from modules
* [[API_newin_EN|newin]] - Connection request ''(before 3.18)''
* [[API_node_EN|node]] - Communication facilities ''(communication nodes, fiber optical junction boxes, poles, manholes)''
* [[API_notepad_EN|notepad]] - Notepad
* [[API_operator_EN|operator]] - System operators ''(before 3.16dev2)''
* [[API_owner_EN|owner]] - Object owners
* [[API_redirect_EN|redirect]] - Redirects to an object card based on some attribute
* [[API_service_EN|service]] - Additional services
* [[API_setting_EN|setting]] - Setting
* [[API_sms_EN|sms]] - SMS messages
* [[API_splitter_EN|splitter]] - Dividers/splitters
* [[API_staff_EN|staff]] - Staff ''(up to 3.16dev2)''
* [[API_system_EN|system]] - System information and operations
* [[API_tariff_EN|tariff]] - Tariffs
* [[API_task_EN|task]] - Tasks
* [[API_trader_EN|trader]] - Vendors
* [[API_vehicle_EN|vehicle]] - Vehicles
* [[API_vlan_EN|vlan]] - Vlan

API vlan EN

2026-05-09T19:48:35Z