API node UK: различия между версиями
IronBot (обсуждение | вклад) (Add Ukrainian API docs and trilingual API links) |
IronBot (обсуждение | вклад) (Add Ukrainian API docs and trilingual API links) |
||
| Строка 3: | Строка 3: | ||
Розділ '''[[API]]''' ERP "UserSide" | Розділ '''[[API]]''' ERP "UserSide" | ||
Призначення: Об' | Призначення: Об'єкти інфраструктури ''(вузли зв'язку, муфти, опори, колодязі)'' | ||
Додаткові параметри: | Додаткові параметри: | ||
action - підкатегорія запиту ''(можливе значення: див. нижче)'' | action - підкатегорія запиту ''(можливе значення: див. нижче)'' | ||
ID | ID типів об'єктів інфраструктури: | ||
0 - вузол зв'язку ''(до 3.14.21)'' | 0 - вузол зв'язку ''(до 3.14.21)'' | ||
1 - муфта | 1 - муфта | ||
| Строка 27: | Строка 27: | ||
type - Тип об'єкта | type - Тип об'єкта | ||
Додаткові параметри: | Додаткові параметри: | ||
city_id - ID | city_id - ID населеного пункту розміщення об'єкта | ||
custom_icon_id - ID | custom_icon_id - ID індивідуальної іконки на карті | ||
comment - нотатки | comment - нотатки | ||
date_add - дата | date_add - дата додавання | ||
entrance - номер під'їзда | entrance - номер під'їзда | ||
house_id - ID будинока | house_id - ID будинока розміщення об'єкта | ||
inventory_number - | inventory_number - інв. номер об'єкта | ||
is_planned - Флаг - об'єкт только запланирован | is_planned - Флаг - об'єкт только запланирован | ||
level - номер поверха | level - номер поверха | ||
level_id - ID поверха/уровня ''(из структуры здания)'' | level_id - ID поверха/уровня ''(из структуры здания)'' | ||
location - | location - розміщення об'єкта (текстовое) | ||
node_parent_id - ID | node_parent_id - ID батьківського об'єкта | ||
number - номер об'єкта | number - номер об'єкта | ||
owner_id - ID власника | owner_id - ID власника | ||
map_id - ID карты ''(для | map_id - ID карты ''(для версії 3.12 і раніше)'' | ||
coordinates - координати в текстовом виде через кому ''(пример: 47.839628,35.140553)'' | coordinates - координати в текстовом виде через кому ''(пример: 47.839628,35.140553)'' | ||
| Строка 78: | Строка 78: | ||
id - ID об'єкта | id - ID об'єкта | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
city_id - ID | city_id - ID населеного пункту розміщення об'єкта | ||
custom_icon_id - ID | custom_icon_id - ID індивідуальної іконки на карті | ||
comment - нотатки | comment - нотатки | ||
coordinates - координати в текстовом виде через кому ''(пример: 47.839628,35.140553)'' | coordinates - координати в текстовом виде через кому ''(пример: 47.839628,35.140553)'' | ||
date_add - дата | date_add - дата додавання | ||
entrance - номер під'їзда | entrance - номер під'їзда | ||
house_id - ID будинока | house_id - ID будинока розміщення об'єкта | ||
inventory_number - | inventory_number - інв. номер об'єкта | ||
is_planned - Флаг - об'єкт только запланирован | is_planned - Флаг - об'єкт только запланирован | ||
level - номер поверха | level - номер поверха | ||
level_id - ID поверха/уровня ''(из структуры здания)'' | level_id - ID поверха/уровня ''(из структуры здания)'' | ||
location - | location - розміщення об'єкта ''(текстовое)'' | ||
node_parent_id - ID | node_parent_id - ID батьківського об'єкта | ||
number - номер об'єкта | number - номер об'єкта | ||
owner_id - ID власника | owner_id - ID власника | ||
| Строка 109: | Строка 109: | ||
нет | нет | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
address_id - id | address_id - id адресної одиниці ''(можна через кому)'' ''(с версії 3.13)'' | ||
city_id - id | city_id - id населеного пункту ''(можна через кому)'' ''(до версії 3.13)'' | ||
entrance_number - номер під'їзда | entrance_number - номер під'їзда | ||
house_id - id будинока ''(можна через кому)'' ''(до | house_id - id будинока ''(можна через кому)'' ''(до версії 3.13)'' | ||
id - id об'єктів ''(можна через кому)'' | id - id об'єктів ''(можна через кому)'' | ||
mark_id - id метки | mark_id - id метки | ||
object_type - тип об'єкта | object_type - тип об'єкта | ||
parent_id - id | parent_id - id батьківського об'єкта ''(можна через кому)'' | ||
street_id - id улицы ''(можна через кому)'' ''(до | street_id - id улицы ''(можна через кому)'' ''(до версії 3.13)'' | ||
==== get_icon_list ==== | ==== get_icon_list ==== | ||
| Строка 133: | Строка 133: | ||
Опис: Отримання ID об'єкта по входящим данным | Опис: Отримання ID об'єкта по входящим данным | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
data_type - тип данных, которые проверяем ''(возможные значення: comment, number, additional_dataX (вместо X - id | data_type - тип данных, которые проверяем ''(возможные значення: comment, number, additional_dataX (вместо X - id додаткового поля))'' | ||
data_value - значення | data_value - значення | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
Версия от 08:36, 10 мая 2026
Розділ 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
Опис: Отримання список типов об'єкти інфраструктури