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

Текущая версия от 11:19, 10 мая 2026

en | uk | ru

Розділ API ERP "UserSide"

Призначення: Об'єкти інфраструктури (вузли зв'язку, муфти, опори, колодязі)

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

ID типів об'єктів інфраструктури:

0 - вузол зв'язку (до 3.14.21)
1 - муфта
2 - опора
3 - колодязь
4 - вузол зв'язку (з 3.14.21)

Підкатегорії

add

Доопрацьовано у: 3.16.22 (додано параметр level_id)

Доопрацьовано у: 3.16dev9 (додано параметр level)

Опис: Додавання об'єкта
Обов'язкові параметри:
 type - Тип об'єкта
Додаткові параметри:
 city_id - ID населеного пункту розміщення об'єкта
 custom_icon_id - ID індивідуальної іконки на карті
 comment - нотатки
 date_add - дата додавання
 entrance - номер під'їзду
 house_id - ID будинку розміщення об'єкта
 inventory_number - інв. номер об'єкта
 is_planned - Прапорець - об'єкт тільки запланований
 level - номер поверху
 level_id - ID поверху/рівня (зі структури будівлі)
 location - розміщення об'єкта (текстове)
 node_parent_id - ID батьківського об'єкта
 number - номер об'єкта
 owner_id - ID власника
 map_id - ID карти (для версії 3.12 і раніше)
 coordinates - координати в текстовому вигляді через кому (приклад: 47.839628,35.140553)

add_mark

Опис: Додавання мітки
Обов'язкові параметри:
 node_id - id об'єкта
 mark_id - id мітки

change_custom_icon

Опис: Зміна власної іконки на карті
Обов'язкові параметри:
 id - id об'єкта
 custom_icon_id - id значка

delete

Додано у: 3.16dev8

Опис: Видалення об'єкта інфраструктури
Обов'язкові параметри:
 id - id об'єкта

delete_mark

Опис: Зняття мітки
Обов'язкові параметри:
 node_id - id об'єкта
 mark_id - id мітки

edit

Доопрацьовано у: 3.16.22 (додано параметр level_id)

Доопрацьовано у: 3.16dev9 (додано параметр level)

Опис: Редагування об'єкта
Обов'язкові параметри:
 id - ID об'єкта
Необов'язкові параметри:
 city_id - ID населеного пункту розміщення об'єкта
 custom_icon_id - ID індивідуальної іконки на карті
 comment - нотатки
 coordinates - координати в текстовому вигляді через кому (приклад: 47.839628,35.140553)
 date_add - дата додавання
 entrance - номер під'їзду
 house_id - ID будинку розміщення об'єкта
 inventory_number - інв. номер об'єкта
 is_planned - Прапорець - об'єкт тільки запланований
 level - номер поверху
 level_id - ID поверху/рівня (зі структури будівлі)
 location - розміщення об'єкта (текстове)
 node_parent_id - ID батьківського об'єкта
 number - номер об'єкта
 owner_id - ID власника

get

Доопрацьовано у: 3.17beta1 (додано параметр entrance_number)

Доопрацьовано у: 3.13.35 (додано параметр mark_id)

Доопрацьовано у: 3.13.14 (додано параметр parent_id)

Доопрацьовано у: 3.13alpha1 (додано параметр address_id, прибрані параметри city_id, street_id, house_id)

Доопрацьовано у: 3.12.74 (додано параметри city_id, street_id, house_id)

Опис: Список об'єктів
Обов'язкові параметри:
 немає
Необов'язкові параметри:
 address_id - id адресної одиниці (можна через кому) (з версії 3.13)
 city_id - id населеного пункту (можна через кому) (до версії 3.13)
 entrance_number - номер під'їзду
 house_id - id будинку (можна через кому) (до версії 3.13)
 id - id об'єктів (можна через кому)
 mark_id - id мітки
 object_type - тип об'єкта
 parent_id - id батьківського об'єкта (можна через кому)
 street_id - id вулиці (можна через кому) (до версії 3.13)

get_icon_list

Опис: Список власних значків для об'єктів
Необов'язкові параметри:
 id - перелік ID об'єктів (через кому)

get_id

Доопрацьовано у: 3.14.46 (додано параметр type_id)

Доопрацьовано у: 3.12.72 (додано можливе значення comment, додано параметр is_entry)

Доопрацьовано у: 3.12.71 (додано можливе значення additional_dataX)

Опис: Отримання ID об'єкта за вхідними даними
Обов'язкові параметри:
 data_type - тип даних, які перевіряємо (можливі значення: comment, number, additional_dataX (замість X - id додаткового поля))
 data_value - значення
Необов'язкові параметри:
 is_entry - прапорець - чи перевіряти зокрема збіг за частиною входження в рядок
 type_id - тип об'єкта

get_id_by_coord

Додано у: 3.12beta30

Опис: Отримання ID найближчого об'єкта за вказаними координатами
Обов'язкові параметри:
 lat - широта
 lon - довгота
Необов'язкові параметри:
 type - тип об'єкта
 range - радіус у метрах, у межах якого відобразити об'єкти

get_redevelopment_scheme

Додано у: 3.16dev3

Опис: Список схем перепланування для об'єкта інфраструктури
Обов'язкові параметри:
 id - id об'єкта інфраструктури

get_relation_customers

Додано у: 3.19.45

Опис: Отримання інформації про залежних абонентів
Обов'язкові параметри:
 id - id об'єкта інфраструктури

get_scheme

Додано у: 3.15.15

Опис: Отримання схеми комутації
Обов'язкові параметри:
 id - id об'єкта інфраструктури

get_type_list

Додано у: 3.16dev3

Опис: Отримання списку типів об'єктів інфраструктури

@@ Строка 1: / Строка 1: @@
 [[API_node_EN|en]] | '''uk''' | [[API node|ru]]
-Розділ '''[[API]]''' ERP "UserSide"
+Розділ '''[[API_UK|API]]''' ERP "UserSide"
 Призначення: Об'єкти інфраструктури ''(вузли зв'язку, муфти, опори, колодязі)''
@@ Строка 13: / Строка 13: @@
 - опора
 - колодязь
-- вузол зв'язку ''(с 3.14.21)''
+- вузол зв'язку ''(з 3.14.21)''
 == Підкатегорії ==
@@ Строка 31: / Строка 31: @@
    comment - нотатки
    date_add - дата додавання
-   entrance - номер під'їзда
+   entrance - номер під'їзду
-   house_id - ID будинока розміщення об'єкта
+   house_id - ID будинку розміщення об'єкта
    inventory_number - інв. номер об'єкта
-   is_planned - Флаг - об'єкт только запланирован
+   is_planned - Прапорець - об'єкт тільки запланований
-   level - номер поверха
+   level - номер поверху
-   level_id - ID поверха/уровня ''(из структуры здания)''
+   level_id - ID поверху/рівня ''(зі структури будівлі)''
-   location - розміщення об'єкта (текстовое)
+   location - розміщення об'єкта (текстове)
    node_parent_id - ID батьківського об'єкта
    number - номер об'єкта
    owner_id - ID власника
-   map_id - ID карты ''(для версії 3.12 і раніше)''
+   map_id - ID карти ''(для версії 3.12 і раніше)''
-   coordinates - координати в текстовом виде через кому ''(пример: 47.839628,35.140553)''
+   coordinates - координати в текстовому вигляді через кому ''(приклад: 47.839628,35.140553)''
 ==== add_mark ====
-  Опис: Додавання метки
+  Опис: Додавання мітки
   Обов'язкові параметри:
    node_id - id об'єкта
-   mark_id - id метки
+   mark_id - id мітки
 ==== change_custom_icon====
-  Опис: Зміна собственного значка на карте
+  Опис: Зміна власної іконки на карті
   Обов'язкові параметри:
    id - id об'єкта
@@ Строка 58: / Строка 58: @@
 ==== delete ====
 ''Додано у: 3.16dev8''
-  Опис: Видалення об'єкти інфраструктури
+  Опис: Видалення об'єкта інфраструктури
   Обов'язкові параметри:
    id - id об'єкта
 ==== delete_mark ====
-  Опис: Снятие метки
+  Опис: Зняття мітки
   Обов'язкові параметри:
    node_id - id об'єкта
-   mark_id - id метки
+   mark_id - id мітки
 ==== edit ====
@@ Строка 81: / Строка 81: @@
    custom_icon_id - ID індивідуальної іконки на карті
    comment - нотатки
-   coordinates - координати в текстовом виде через кому ''(пример: 47.839628,35.140553)''
+   coordinates - координати в текстовому вигляді через кому ''(приклад: 47.839628,35.140553)''
    date_add - дата додавання
-   entrance - номер під'їзда
+   entrance - номер під'їзду
-   house_id - ID будинока розміщення об'єкта
+   house_id - ID будинку розміщення об'єкта
    inventory_number - інв. номер об'єкта
-   is_planned - Флаг - об'єкт только запланирован
+   is_planned - Прапорець - об'єкт тільки запланований
-   level - номер поверха
+   level - номер поверху
-   level_id - ID поверха/уровня ''(из структуры здания)''
+   level_id - ID поверху/рівня ''(зі структури будівлі)''
-   location - розміщення об'єкта ''(текстовое)''
+   location - розміщення об'єкта ''(текстове)''
    node_parent_id - ID батьківського об'єкта
    number - номер об'єкта
@@ Строка 101: / Строка 101: @@
 ''Доопрацьовано у: 3.13.14 (додано параметр parent_id)''
-''Доопрацьовано у: 3.13alpha1 (додано параметр address_id, убраны параметры city_id, street_id, house_id)''
+''Доопрацьовано у: 3.13alpha1 (додано параметр address_id, прибрані параметри city_id, street_id, house_id)''
 ''Доопрацьовано у: 3.12.74 (додано параметри city_id, street_id, house_id)''
@@ Строка 107: / Строка 107: @@
   Опис: Список об'єктів
   Обов'язкові параметри:
-   нет
+   немає
   Необов'язкові параметри:
-   address_id - id адресної одиниці ''(можна через кому)'' ''(с версії 3.13)''
+   address_id - id адресної одиниці ''(можна через кому)'' ''(з версії 3.13)''
    city_id - id населеного пункту ''(можна через кому)'' ''(до версії 3.13)''
-   entrance_number - номер під'їзда
+   entrance_number - номер під'їзду
-   house_id - id будинока ''(можна через кому)'' ''(до версії 3.13)''
+   house_id - id будинку ''(можна через кому)'' ''(до версії 3.13)''
    id - id об'єктів ''(можна через кому)''
-   mark_id - id метки
+   mark_id - id мітки
    object_type - тип об'єкта
    parent_id - id батьківського об'єкта ''(можна через кому)''
-   street_id - id улицы ''(можна через кому)'' ''(до версії 3.13)''
+   street_id - id вулиці ''(можна через кому)'' ''(до версії 3.13)''
 ==== get_icon_list ====
-  Опис: Список собственных значков для об'єктів
+  Опис: Список власних значків для об'єктів
   Необов'язкові параметри:
-   id - перечень ID об'єктів ''(через кому)''
+   id - перелік ID об'єктів ''(через кому)''
 ==== get_id ====
 ''Доопрацьовано у: 3.14.46 (додано параметр type_id)''
-''Доопрацьовано у: 3.12.72 (добавлено возможное значення comment, додано параметр is_entry)''
+''Доопрацьовано у: 3.12.72 (додано можливе значення comment, додано параметр is_entry)''
-''Доопрацьовано у: 3.12.71 (добавлено возможное значення additional_dataX)''
+''Доопрацьовано у: 3.12.71 (додано можливе значення additional_dataX)''
-  Опис: Отримання ID об'єкта по входящим данным
+  Опис: Отримання ID об'єкта за вхідними даними
   Обов'язкові параметри:
-   data_type - тип данных, которые проверяем ''(возможные значення: comment, number, additional_dataX (вместо X - id додаткового поля))''
+   data_type - тип даних, які перевіряємо ''(можливі значення: comment, number, additional_dataX (замість X - id додаткового поля))''
    data_value - значення
   Необов'язкові параметри:
-   is_entry - прапорець - проверять ли в т.ч. совпадение по части вхождения в строку
+   is_entry - прапорець - чи перевіряти зокрема збіг за частиною входження в рядок
    type_id - тип об'єкта
 ==== get_id_by_coord ====
 ''Додано у: 3.12beta30''
-  Опис: Отримання ID ближайшего об'єкта по указанным координатам
+  Опис: Отримання ID найближчого об'єкта за вказаними координатами
   Обов'язкові параметри:
    lat - широта
@@ Строка 147: / Строка 147: @@
   Необов'язкові параметри:
    type - тип об'єкта
-   range - радіус в метрах, в пределах которого отобразить об'єкты
+   range - радіус у метрах, у межах якого відобразити об'єкти
 ==== get_redevelopment_scheme ====
 ''Додано у: 3.16dev3''
-  Опис: Список схем перепланировки для об'єкти інфраструктури
+  Опис: Список схем перепланування для об'єкта інфраструктури
   Обов'язкові параметри:
-   id - id об'єкти інфраструктури
+   id - id об'єкта інфраструктури
 ==== get_relation_customers ====
 ''Додано у: 3.19.45''
-  Опис: Отримання информации о зависимых абонентах
+  Опис: Отримання інформації про залежних абонентів
   Обов'язкові параметри:
-   id - id об'єкти інфраструктури
+   id - id об'єкта інфраструктури
 ==== get_scheme ====
 ''Додано у: 3.15.15''
-  Опис: Отримання схемы коммутации
+  Опис: Отримання схеми комутації
   Обов'язкові параметри:
-   id - id об'єкти інфраструктури
+   id - id об'єкта інфраструктури
 ==== get_type_list ====
 ''Додано у: 3.16dev3''
-  Опис: Отримання список типов об'єкти інфраструктури
+  Опис: Отримання списку типів об'єктів інфраструктури