API fiber

Материал из WiKi - UserSide
Перейти к навигации Перейти к поиску

Раздел API ERP "UserSide"

Назначение: ВОЛС

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

Подкатегории

add

Описание: Добавление ВОЛС
Обязательные параметры:
 object_a_id - ID начального объекта
 object_b_id - ID конечного объекта (либо house_b_id - ID конечного дома)
Дополнительные параметры:
 building_date - Дата прокладки
 building_length - строительная длина
 cabletype_id - ID типа кабеля
 comment - Заметки
 custom_color - Собственный цвет для ВОЛС
 fibers_count - количество ОВ
 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 - запас кабеля (в метрах)

delete_mark

Добавлено в 3.13.35

Описание: Снятие метки
Обязательные параметры:
 fiber_id - id ВОЛС
 mark_id - id метки

edit

Описание: Редактирование ВОЛС 
Обязательные параметры:
 id - id ВОЛС
Необязательные параметры:
 object_a_id - id начального объекта
 object_b_id - id конечного объекта 
 house_b_id - id конечного дома
 building_date - дата прокладки
 building_length - строительная длина
 cabletype_id - id типа кабеля
 comment - заметки
 custom_color - собственный цвет для ВОЛС
 fibers_count - количество ОВ
 is_planned - флаг - объект только запланирован
 is_change_color_by_cabletype - флаг - Изменить цвета ОВ согласно свойств типа кабеля
 marking_a - маркировка ВОЛС на стороне А
 marking_b - маркировка ВОЛС на стороне Б
 optical_length - оптическая длина

get_fiber

Добавлено в 3.12.94

Описание: Список волокон
Обязательные параметры:
 нет
Дополнительные параметры:
 id - id волокна (можно через запятую)

get_geo_length

Добавлено в 3.13.14

Описание: Расчёт длины ВОЛС согласно географических координат конечных точек (приблизительный расчёт)
Обязательные параметры:
 id - id ВОЛС

get_list

Доработано в: 3.13.45 (добавлен параметры node_id)

Доработано в: 3.13.35 (добавлен параметры mark_id)

Описание: Список ВОЛС
Обязательные параметры:
 нет
Необязательные параметры:
 object_id - id конкретной ВОЛС
 mark_id - id метки
 node_id - id объекта размещения (можно через запятую)

remove_route_object

Добавлено в 3.13.14

Описание: Исключение объектов на маршруте ВОЛС
Обязательные параметры:
 id - id ВОЛС
Необязательные параметры:
 object_id - id объекта

set_geo_route

Добавлено в 3.13.45

Описание: Установка географического маршрута ВОЛС
Обязательные параметры:
 id - id ВОЛС
 route - массив географических точек (lat,lon) маршрута ВОЛС в формате json