API fiber: различия между версиями
Admin (обсуждение | вклад) |
Нет описания правки |
||
(не показано 13 промежуточных версий 2 участников) | |||
Строка 1: | Строка 1: | ||
[[API fiber EN|en]] | [[API fiber|ru]] | |||
Раздел '''[[API]]''' ERP "UserSide" | Раздел '''[[API]]''' ERP "UserSide" | ||
Назначение: | Назначение: Кабельные линии | ||
Дополнительные параметры: | Дополнительные параметры: | ||
Строка 9: | Строка 11: | ||
==== add ==== | ==== add ==== | ||
Описание: Добавление | |||
''Доработано в: 3.15.23 (добавлен параметры cableline_type_id)'' | |||
Описание: Добавление линии | |||
Обязательные параметры: | Обязательные параметры: | ||
object_a_id - ID начального объекта | object_a_id - ID начального объекта | ||
Строка 16: | Строка 21: | ||
building_date - Дата прокладки | building_date - Дата прокладки | ||
building_length - строительная длина | building_length - строительная длина | ||
cableline_type_id - ID типа кабельной линии | |||
cabletype_id - ID типа кабеля | cabletype_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 - Маркировка линии на стороне Б | ||
object_a_id - ID начального объекта | object_a_id - ID начального объекта | ||
object_b_id - ID конечного объекта | object_b_id - ID конечного объекта | ||
Строка 32: | Строка 38: | ||
Описание: Добавление метки | Описание: Добавление метки | ||
Обязательные параметры: | Обязательные параметры: | ||
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 ==== | |||
''Добавлено в 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 ==== | ==== delete_mark ==== | ||
Строка 55: | Строка 79: | ||
Описание: Снятие метки | Описание: Снятие метки | ||
Обязательные параметры: | Обязательные параметры: | ||
fiber_id - id | fiber_id - id линии | ||
mark_id - id метки | mark_id - id метки | ||
==== edit ==== | ==== edit ==== | ||
Описание: Редактирование | Описание: Редактирование линии | ||
Обязательные параметры: | Обязательные параметры: | ||
id - id | id - id линии | ||
Необязательные параметры: | Необязательные параметры: | ||
object_a_id - id начального объекта | object_a_id - id начального объекта | ||
Строка 70: | Строка 94: | ||
cabletype_id - id типа кабеля | cabletype_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 (добавлен параметры fiber_id)'' | |||
''Добавлено в 3.12.94'' | ''Добавлено в 3.12.94'' | ||
Описание: Список волокон | Описание: Список волокон | ||
Строка 84: | Строка 110: | ||
нет | нет | ||
Дополнительные параметры: | Дополнительные параметры: | ||
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 (добавлен параметры 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 типа кабельной линии | |||
mark_id - id метки | mark_id - id метки | ||
node_id - id объекта размещения ''(можно через запятую)'' | node_id - id объекта размещения ''(можно через запятую)'' | ||
object_id - id конкретной линии | |||
==== map_color_get ==== | |||
''Добавлено в 3.16dev8'' | |||
Описание: Цвета кабелей на карте | |||
==== remove_route_object ==== | ==== remove_route_object ==== | ||
''Добавлено в 3.13.14'' | ''Добавлено в 3.13.14'' | ||
Описание: Исключение объектов на маршруте | Описание: Исключение объектов на маршруте линии | ||
Обязательные параметры: | Обязательные параметры: | ||
id - id | id - id линии | ||
Необязательные параметры: | Необязательные параметры: | ||
object_id - id объекта | object_id - id объекта | ||
==== set_geo_route ==== | |||
''Добавлено в 3.13.45'' | |||
Описание: Установка географического маршрута линии | |||
Обязательные параметры: | |||
id - id линии | |||
route - массив географических точек ''(lat,lon)'' маршрута линии в формате json |
Текущая версия от 13:03, 11 октября 2024
Раздел API ERP "UserSide"
Назначение: Кабельные линии
Дополнительные параметры: action - подкатегория запроса (возможное значение: см.ниже)
Подкатегории
add
Доработано в: 3.15.23 (добавлен параметры cableline_type_id)
Описание: Добавление линии Обязательные параметры: object_a_id - ID начального объекта object_b_id - ID конечного объекта (либо house_b_id - ID конечного дома) Дополнительные параметры: building_date - Дата прокладки building_length - строительная длина cableline_type_id - ID типа кабельной линии 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 - запас кабеля (в метрах)
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
Описание: Редактирование линии Обязательные параметры: 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.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