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

Материал из WiKi - UserSide
(Add Ukrainian API docs and trilingual API links)
(Add Ukrainian API docs and trilingual API links)
Строка 12: Строка 12:
==== add ====
==== add ====


''Доопрацьовано у: 3.19.53 (додано параметры customer_b_id)''
''Доопрацьовано у: 3.19.53 (додано параметри customer_b_id)''


''Доопрацьовано у: 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 - Дата прокладки
Строка 26: Строка 26:
   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 - Маркировка линии на стороне Б
Строка 40: Строка 40:
==== 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 ====
Строка 56: Строка 56:
==== 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 ====
Строка 71: Строка 71:
==== 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 мітки


==== edit ====
==== edit ====


''Доопрацьовано у: 3.19.50 (додано параметры cable_line_type_id)''
''Доопрацьовано у: 3.19.50 (додано параметри cable_line_type_id)''


  Опис: Редагування линии
  Опис: Редагування линии
Строка 102: Строка 102:
   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 - маркировка линии на стороне А
Строка 111: Строка 111:


==== get_fiber ====
==== get_fiber ====
''Доопрацьовано у: 3.14beta5 (додано параметры fiber_id)''
''Доопрацьовано у: 3.14beta5 (додано параметри fiber_id)''


''Додано у 3.12.94''
''Додано у 3.12.94''
  Опис: Список волокон
  Опис: Список волокон
  Обов'язкові параметри:
  Обов'язкові параметри:
   нет
   немає
  Додаткові параметри:
  Додаткові параметри:
   fiber_id - id кабельної лінії ''(можна через кому)''
   fiber_id - id кабельної лінії ''(можна через кому)''
Строка 123: Строка 123:
==== get_geo_length ====
==== get_geo_length ====
''Додано у 3.13.14''
''Додано у 3.13.14''
  Опис: Расчёт длины линии согласно географических координат конечных точек ''(приблизительный расчёт)''
  Опис: Розрахунок довжини линии согласно географических координат кінцевих точек ''(приблизний розрахунок)''
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id линии
   id - id линии


==== get_list ====
==== get_list ====
''Доопрацьовано у: 3.16.19 (додано параметры cable_line_type_id)''
''Доопрацьовано у: 3.16.19 (додано параметри cable_line_type_id)''


''Доопрацьовано у: 3.13.45 (додано параметры node_id)''
''Доопрацьовано у: 3.13.45 (додано параметри node_id)''


''Доопрацьовано у: 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 конкретной линии
Строка 149: Строка 149:
==== remove_route_object ====
==== remove_route_object ====
''Додано у 3.13.14''
''Додано у 3.13.14''
  Опис: Исключение об'єктів на маршруте линии
  Опис: Виключення об'єктів на маршруте линии
  Обов'язкові параметри:
  Обов'язкові параметри:
   id - id линии
   id - id линии
Строка 171: Строка 171:
   pigtail_type - тип пигтейла
   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 - вийшов из строя

Версия от 10:29, 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 - вийшов из строя