API fiber UK: различия между версиями
IronBot (обсуждение | вклад) (Add Ukrainian API docs and trilingual API links) |
IronBot (обсуждение | вклад) (Fix Ukrainian API localization) |
||
| (не показаны 4 промежуточные версии этого же участника) | |||
| Строка 1: | Строка 1: | ||
[[API_fiber_EN|en]] | '''uk''' | [[API fiber|ru]] | [[API_fiber_EN|en]] | '''uk''' | [[API fiber|ru]] | ||
Розділ '''[[API]]''' ERP "UserSide" | Розділ '''[[API_UK|API]]''' ERP "UserSide" | ||
Призначення: Кабельні лінії | Призначення: Кабельні лінії | ||
| Строка 12: | Строка 12: | ||
==== add ==== | ==== add ==== | ||
''Доопрацьовано у: 3.19.53 (додано | ''Доопрацьовано у: 3.19.53 (додано параметри customer_b_id)'' | ||
''Доопрацьовано у: 3.15.23 (додано | ''Доопрацьовано у: 3.15.23 (додано параметри cableline_type_id)'' | ||
Опис: Додавання | Опис: Додавання лінії | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
object_a_id - ID | object_a_id - ID початкового об'єкта | ||
object_b_id - ID | object_b_id - ID кінцевого об'єкта (або house_b_id - ID кінцевої будівлі або customer_b_id - ID кінцевого абонента) | ||
Додаткові параметри: | Додаткові параметри: | ||
building_date - | building_date - дата прокладання | ||
building_length - | building_length - будівельна довжина | ||
cableline_type_id - ID | cableline_type_id - ID типу кабельної лінії | ||
cabletype_id - ID | cabletype_id - ID типу кабелю | ||
comment - Нотатки | comment - Нотатки | ||
custom_color - | custom_color - власний колір для лінії | ||
customer_b_id - ID | customer_b_id - ID кінцевого абонента | ||
fibers_count - | fibers_count - кількість ОВ | ||
house_b_id - ID | house_b_id - ID кінцевої будівлі | ||
is_planned - | is_planned - Прапорець - об'єкт тільки запланований | ||
is_change_color_by_cabletype - | is_change_color_by_cabletype - прапорець - змінити кольори ОВ відповідно до властивостей типу кабелю | ||
marking_a - | marking_a - маркування лінії на стороні А | ||
marking_b - | marking_b - маркування лінії на стороні Б | ||
object_a_id - ID | object_a_id - ID початкового об'єкта | ||
object_b_id - ID | object_b_id - ID кінцевого об'єкта | ||
optical_length - | optical_length - оптична довжина | ||
==== add_mark ==== | ==== add_mark ==== | ||
''Додано у 3.13.35'' | ''Додано у 3.13.35'' | ||
Опис: Додавання | Опис: Додавання мітки | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
fiber_id - id | fiber_id - id лінії | ||
mark_id - id | mark_id - id мітки | ||
==== add_route_object ==== | ==== add_route_object ==== | ||
''Додано у 3.13.14'' | ''Додано у 3.13.14'' | ||
Опис: Додавання об'єкта на маршрут | Опис: Додавання об'єкта на маршрут лінії | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
id - id | id - id лінії | ||
object_id - id об'єкта | object_id - id об'єкта | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
reserve - запас | reserve - запас кабелю ''(у метрах)'' | ||
==== catalog_cables_add ==== | ==== catalog_cables_add ==== | ||
''Додано у 3.17dev1'' | ''Додано у 3.17dev1'' | ||
Опис: Додавання | Опис: Додавання запису в каталог кабелів | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
cable_line_type_id - id | cable_line_type_id - id типу кабельної лінії | ||
brand - найменування | brand - найменування виробника | ||
name - марка | name - марка кабелю | ||
core_count - | core_count - кількість провідників ''(волокон/жил)'' | ||
==== catalog_cables_get ==== | ==== catalog_cables_get ==== | ||
''Додано у 3.15.12'' | ''Додано у 3.15.12'' | ||
Опис: Каталог | Опис: Каталог кабелів | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
cable_line_type_id - id | cable_line_type_id - id типу кабельної лінії | ||
==== catalog_types_get ==== | ==== catalog_types_get ==== | ||
''Додано у 3.15.12'' | ''Додано у 3.15.12'' | ||
Опис: Каталог | Опис: Каталог типів кабельних ліній | ||
==== delete ==== | ==== delete ==== | ||
''Додано у: 3.16dev8'' | ''Додано у: 3.16dev8'' | ||
Опис: Видалення | Опис: Видалення кабельної лінії | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
id - id об'єкта | id - id об'єкта | ||
| Строка 81: | Строка 81: | ||
==== delete_mark ==== | ==== delete_mark ==== | ||
''Додано у 3.13.35'' | ''Додано у 3.13.35'' | ||
Опис: | Опис: Зняття мітки | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
fiber_id - id | fiber_id - id лінії | ||
mark_id - id | mark_id - id мітки | ||
==== edit ==== | ==== edit ==== | ||
''Доопрацьовано у: 3.19.50 (додано | ''Доопрацьовано у: 3.19.50 (додано параметри cable_line_type_id)'' | ||
Опис: Редагування | Опис: Редагування лінії | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
id - id | id - id лінії | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
object_a_id - id | object_a_id - id початкового об'єкта | ||
object_b_id - id | object_b_id - id кінцевого об'єкта | ||
house_b_id - id | house_b_id - id кінцевого будинку | ||
building_date - дата | building_date - дата прокладання | ||
building_length - | building_length - будівельна довжина | ||
cabletype_id - id | cabletype_id - id типу кабелю | ||
cable_line_type_id - id | cable_line_type_id - id типу кабельної лінії | ||
comment - нотатки | comment - нотатки | ||
custom_color - | custom_color - власний колір для лінії | ||
fibers_count - | fibers_count - кількість ОВ | ||
is_planned - прапорець - об'єкт | is_planned - прапорець - об'єкт тільки запланований | ||
is_change_color_by_cabletype - прапорець - | is_change_color_by_cabletype - прапорець - змінити кольори ОВ відповідно до властивостей типу кабелю | ||
marking_a - | marking_a - маркування лінії на стороні А | ||
marking_b - | marking_b - маркування лінії на стороні Б | ||
optical_length - | optical_length - оптична довжина | ||
==== get_fiber ==== | ==== get_fiber ==== | ||
''Доопрацьовано у: 3.14beta5 (додано | ''Доопрацьовано у: 3.14beta5 (додано параметри fiber_id)'' | ||
''Додано у 3.12.94'' | ''Додано у 3.12.94'' | ||
Опис: Список волокон | Опис: Список волокон | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
немає | |||
Додаткові параметри: | Додаткові параметри: | ||
fiber_id - id | fiber_id - id кабельної лінії ''(можна через кому)'' | ||
id - id волокна ''(можна через кому)'' | id - id волокна ''(можна через кому)'' | ||
==== get_geo_length ==== | ==== get_geo_length ==== | ||
''Додано у 3.13.14'' | ''Додано у 3.13.14'' | ||
Опис: | Опис: Розрахунок довжини лінії за географічними координатами кінцевих точок ''(приблизний розрахунок)'' | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
id - id | id - id лінії | ||
==== get_list ==== | ==== get_list ==== | ||
''Доопрацьовано у: 3.16.19 (додано | ''Доопрацьовано у: 3.16.19 (додано параметри cable_line_type_id)'' | ||
''Доопрацьовано у: 3.13.45 (додано | ''Доопрацьовано у: 3.13.45 (додано параметри node_id)'' | ||
''Доопрацьовано у: 3.13.35 (додано | ''Доопрацьовано у: 3.13.35 (додано параметри mark_id)'' | ||
Опис: Список | Опис: Список ліній | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
немає | |||
Необов'язкові параметри: | Необов'язкові параметри: | ||
cable_line_type_id - id | cable_line_type_id - id типу кабельної лінії | ||
mark_id - id | mark_id - id мітки | ||
node_id - id об'єкта | node_id - id об'єкта розміщення ''(можна через кому)'' | ||
object_id - id | object_id - id конкретної лінії | ||
==== map_color_get ==== | ==== map_color_get ==== | ||
''Додано у 3.16dev8'' | ''Додано у 3.16dev8'' | ||
Опис: | Опис: Кольори кабелів на карті | ||
==== remove_route_object ==== | ==== remove_route_object ==== | ||
''Додано у 3.13.14'' | ''Додано у 3.13.14'' | ||
Опис: | Опис: Вилучення об'єктів на маршруті лінії | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
id - id | id - id лінії | ||
Необов'язкові параметри: | Необов'язкові параметри: | ||
object_id - id об'єкта | object_id - id об'єкта | ||
| Строка 157: | Строка 157: | ||
==== set_geo_route ==== | ==== set_geo_route ==== | ||
''Додано у 3.13.45'' | ''Додано у 3.13.45'' | ||
Опис: | Опис: Встановлення географічного маршруту лінії | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
id - id | id - id лінії | ||
route - | route - масив географічних точок ''(lat,lon)'' маршруту лінії у форматі json | ||
==== set_pigtail_type ==== | ==== set_pigtail_type ==== | ||
''Додано у 3.19.35'' | ''Додано у 3.19.35'' | ||
Опис: | Опис: Встановлення типу пігтейла для волокна/провідника лінії | ||
Обов'язкові параметри: | Обов'язкові параметри: | ||
id - id | id - id лінії | ||
side - сторона | side - сторона лінії [1|2] | ||
number - номер волокна/проводника | number - номер волокна/проводника | ||
pigtail_type - тип | pigtail_type - тип пігтейла | ||
Варіанти pigtail_type: | |||
1001 - SC UPC | 1001 - SC UPC | ||
1002 - LC UPC | 1002 - LC UPC | ||
| Строка 184: | Строка 184: | ||
10010 - SC UPC Female | 10010 - SC UPC Female | ||
10011 - SC APC Female | 10011 - SC APC Female | ||
1100 - | 1100 - немає пігтейла | ||
5000 - | 5000 - вийшов з ладу | ||
Текущая версия от 11:19, 10 мая 2026
Розділ API ERP "UserSide"
Призначення: Кабельні лінії
Додаткові параметри: action - підкатегорія запиту (можливе значення: див. нижче)
Підкатегорії
add
Доопрацьовано у: 3.19.53 (додано параметри customer_b_id)
Доопрацьовано у: 3.15.23 (додано параметри cableline_type_id)
Опис: Додавання лінії Обов'язкові параметри: object_a_id - ID початкового об'єкта object_b_id - ID кінцевого об'єкта (або house_b_id - ID кінцевої будівлі або customer_b_id - ID кінцевого абонента) Додаткові параметри: building_date - дата прокладання building_length - будівельна довжина cableline_type_id - ID типу кабельної лінії cabletype_id - ID типу кабелю comment - Нотатки custom_color - власний колір для лінії customer_b_id - ID кінцевого абонента fibers_count - кількість ОВ house_b_id - ID кінцевої будівлі is_planned - Прапорець - об'єкт тільки запланований is_change_color_by_cabletype - прапорець - змінити кольори ОВ відповідно до властивостей типу кабелю marking_a - маркування лінії на стороні А marking_b - маркування лінії на стороні Б object_a_id - ID початкового об'єкта object_b_id - ID кінцевого об'єкта optical_length - оптична довжина
add_mark
Додано у 3.13.35
Опис: Додавання мітки Обов'язкові параметри: fiber_id - id лінії mark_id - id мітки
add_route_object
Додано у 3.13.14
Опис: Додавання об'єкта на маршрут лінії Обов'язкові параметри: id - id лінії object_id - id об'єкта Необов'язкові параметри: reserve - запас кабелю (у метрах)
catalog_cables_add
Додано у 3.17dev1
Опис: Додавання запису в каталог кабелів Обов'язкові параметри: cable_line_type_id - id типу кабельної лінії brand - найменування виробника name - марка кабелю core_count - кількість провідників (волокон/жил)
catalog_cables_get
Додано у 3.15.12
Опис: Каталог кабелів Необов'язкові параметри: cable_line_type_id - id типу кабельної лінії
catalog_types_get
Додано у 3.15.12
Опис: Каталог типів кабельних ліній
delete
Додано у: 3.16dev8
Опис: Видалення кабельної лінії Обов'язкові параметри: id - id об'єкта
delete_mark
Додано у 3.13.35
Опис: Зняття мітки Обов'язкові параметри: fiber_id - id лінії mark_id - id мітки
edit
Доопрацьовано у: 3.19.50 (додано параметри cable_line_type_id)
Опис: Редагування лінії Обов'язкові параметри: id - id лінії Необов'язкові параметри: object_a_id - id початкового об'єкта object_b_id - id кінцевого об'єкта house_b_id - id кінцевого будинку building_date - дата прокладання building_length - будівельна довжина cabletype_id - id типу кабелю cable_line_type_id - id типу кабельної лінії comment - нотатки custom_color - власний колір для лінії fibers_count - кількість ОВ is_planned - прапорець - об'єкт тільки запланований is_change_color_by_cabletype - прапорець - змінити кольори ОВ відповідно до властивостей типу кабелю marking_a - маркування лінії на стороні А marking_b - маркування лінії на стороні Б optical_length - оптична довжина
get_fiber
Доопрацьовано у: 3.14beta5 (додано параметри fiber_id)
Додано у 3.12.94
Опис: Список волокон Обов'язкові параметри: немає Додаткові параметри: fiber_id - id кабельної лінії (можна через кому) id - id волокна (можна через кому)
get_geo_length
Додано у 3.13.14
Опис: Розрахунок довжини лінії за географічними координатами кінцевих точок (приблизний розрахунок) Обов'язкові параметри: id - id лінії
get_list
Доопрацьовано у: 3.16.19 (додано параметри cable_line_type_id)
Доопрацьовано у: 3.13.45 (додано параметри node_id)
Доопрацьовано у: 3.13.35 (додано параметри mark_id)
Опис: Список ліній Обов'язкові параметри: немає Необов'язкові параметри: cable_line_type_id - id типу кабельної лінії mark_id - id мітки node_id - id об'єкта розміщення (можна через кому) object_id - id конкретної лінії
map_color_get
Додано у 3.16dev8
Опис: Кольори кабелів на карті
remove_route_object
Додано у 3.13.14
Опис: Вилучення об'єктів на маршруті лінії Обов'язкові параметри: id - id лінії Необов'язкові параметри: object_id - id об'єкта
set_geo_route
Додано у 3.13.45
Опис: Встановлення географічного маршруту лінії Обов'язкові параметри: id - id лінії route - масив географічних точок (lat,lon) маршруту лінії у форматі json
set_pigtail_type
Додано у 3.19.35
Опис: Встановлення типу пігтейла для волокна/провідника лінії Обов'язкові параметри: id - id лінії side - сторона лінії [1|2] number - номер волокна/проводника pigtail_type - тип пігтейла
Варіанти pigtail_type:
1001 - SC UPC 1002 - LC UPC 1003 - FC UPC 1004 - ST UPC 1005 - E2000 UPC 1011 - SC APC 1012 - LC APC 1013 - FC APC 1014 - ST APC 1015 - E2000 APC 10010 - SC UPC Female 10011 - SC APC Female 1100 - немає пігтейла 5000 - вийшов з ладу