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

Материал из WiKi - UserSide
(Новая страница: «Раздел '''API''' ERP "UserSide" Назначение: ВОЛС Дополнительные параметры: action - подкатегория з…»)
 
Нет описания правки
 
(не показана 31 промежуточная версия 2 участников)
Строка 1: Строка 1:
[[API fiber EN|en]] | [[API fiber|ru]]
Раздел '''[[API]]''' ERP "UserSide"
Раздел '''[[API]]''' ERP "UserSide"


Назначение: ВОЛС
Назначение: Кабельные линии


  Дополнительные параметры:
  Дополнительные параметры:
Строка 7: Строка 9:


== Подкатегории ==
== Подкатегории ==
==== 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 ====
==== get_list ====
  Описание: Список объектов
''Доработано в: 3.16.19 (добавлен параметры cable_line_type_id)''
 
''Доработано в: 3.13.45 (добавлен параметры node_id)''
 
''Доработано в: 3.13.35 (добавлен параметры mark_id)''
 
  Описание: Список линий
  Обязательные параметры:
  Обязательные параметры:
   нет
   нет
  Дополнительно возвращаемые данные:
  Необязательные параметры:
   array(
   cable_line_type_id - id типа кабельной линии
  [Data] => Данные об объектах
  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

Текущая версия от 13:03, 11 октября 2024

en | ru

Раздел 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