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

Материал из WiKi - UserSide
(Add Ukrainian API docs and trilingual API links)
(Fix Ukrainian API localization)
 
(не показана 1 промежуточная версия этого же участника)
Строка 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"


Призначення: Кабельні лінії
Призначення: Кабельні лінії
Строка 16: Строка 16:
''Доопрацьовано у: 3.15.23 (додано параметри cableline_type_id)''
''Доопрацьовано у: 3.15.23 (додано параметри cableline_type_id)''


  Опис: Додавання линии
  Опис: Додавання лінії
  Обов'язкові параметри:
  Обов'язкові параметри:
   object_a_id - ID начального об'єкта
   object_a_id - ID початкового об'єкта
   object_b_id - ID конечного об'єкта (або house_b_id - ID конечного будівлі або customer_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 ====
Строка 42: Строка 42:
  Опис: Додавання мітки
  Опис: Додавання мітки
  Обов'язкові параметри:
  Обов'язкові параметри:
   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 ====
Строка 81: Строка 81:
==== delete_mark ====
==== delete_mark ====
''Додано у 3.13.35''
''Додано у 3.13.35''
  Опис: Снятие мітки
  Опис: Зняття мітки
  Обов'язкові параметри:
  Обов'язкові параметри:
   fiber_id - id линии
   fiber_id - id лінії
   mark_id - id мітки
   mark_id - id мітки


Строка 90: Строка 90:
''Доопрацьовано у: 3.19.50 (додано параметри cable_line_type_id)''
''Доопрацьовано у: 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 ====
Строка 123: Строка 123:
==== get_geo_length ====
==== get_geo_length ====
''Додано у 3.13.14''
''Додано у 3.13.14''
  Опис: Розрахунок довжини линии согласно географических координат кінцевих точек ''(приблизний розрахунок)''
  Опис: Розрахунок довжини лінії за географічними координатами кінцевих точок ''(приблизний розрахунок)''
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id линии
   id - id лінії


==== get_list ====
==== get_list ====
Строка 134: Строка 134:
''Доопрацьовано у: 3.13.35 (додано параметри mark_id)''
''Доопрацьовано у: 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 ====
Строка 149: Строка 149:
==== 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 - массив географических точек ''(lat,lon)'' маршрута линии в формате json
   route - масив географічних точок ''(lat,lon)'' маршруту лінії у форматі json


==== set_pigtail_type ====
==== set_pigtail_type ====
''Додано у 3.19.35''
''Додано у 3.19.35''
  Опис: Установка типа пигтейла для волокна/проводника линии
  Опис: Встановлення типу пігтейла для волокна/провідника лінії
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id линии
   id - id лінії
   side - сторона линии [1|2]
   side - сторона лінії [1|2]
   number - номер волокна/проводника
   number - номер волокна/проводника
   pigtail_type - тип пигтейла
   pigtail_type - тип пігтейла


Варіанти pigtail_type:
Варіанти pigtail_type:
Строка 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

en | uk | ru

Розділ 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 - вийшов з ладу