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

Материал из WiKi - UserSide
Нет описания правки
 
(не показано 35 промежуточных версий 2 участников)
Строка 1: Строка 1:
[[API fiber EN|en]] | [[API fiber|ru]]
Раздел '''[[API]]''' ERP "UserSide"
Раздел '''[[API]]''' ERP "UserSide"


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


  Дополнительные параметры:
  Дополнительные параметры:
Строка 8: Строка 10:
== Подкатегории ==
== Подкатегории ==


==== get_list ====
==== add ====
Описание: Список ВОЛС
 
Обязательные параметры:
''Доработано в: 3.19.53 (добавлен параметры customer_b_id)''
  нет
 
Дополнительно возвращаемые данные:
''Доработано в: 3.15.23 (добавлен параметры cableline_type_id)''
  array(
  [Data] => Данные об объектах
  )


==== add ====
  Описание: Добавление линии
  Описание: Добавление ВОЛС
  Обязательные параметры:
  Обязательные параметры:
   object_a_id - ID начального объекта
   object_a_id - ID начального объекта
   object_b_id - ID конечного объекта (либо house_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 типа кабельной линии
   cabletype_id - ID типа кабеля
   cabletype_id - ID типа кабеля
   comment - Заметки
   comment - Заметки
   custom_color - Собственный цвет для ВОЛС
   custom_color - Собственный цвет для линии
  customer_b_id - ID конечного абонента
   fibers_count - количество ОВ
   fibers_count - количество ОВ
  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 - оптическая длина
  Дополнительно возвращаемые данные:
 
   array(
==== add_mark ====
  [id] => ID добавленной ВОЛС в случае успеха
''Добавлено в 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 ====
==== edit ====
  Описание: Редактирование ВОЛС
 
''Доработано в: 3.19.50 (добавлен параметры cable_line_type_id)''
 
  Описание: Редактирование линии
  Обязательные параметры:
  Обязательные параметры:
   id - 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''
Описание: Установка типа пигтейла для волокна/проводника линии
  Обязательные параметры:
  Обязательные параметры:
   city_id - ID населенного пункта размещения объекта
   id - id линии
   custom_icon_id - ID индивидуального значка на карте
   side - сторона линии [1|2]
   comment - заметки
   number - номер волокна/проводника
   date_add - дата добавления
   pigtail_type - тип пигтейла
   entrance - номер подъезда
 
   house_id - ID дома размещения объекта
Варианты pigtail_type:
   inventory_number - инв.номер объекта
  1001 - SC UPC
   is_planned - Флаг - объект только запланирован
   1002 - LC UPC
   location - размещение объекта (текстовое)
   1003 - FC UPC
   node_parent_id - ID родительского объекта
   1004 - ST UPC
   number - номер объекта
   1005 - E2000 UPC 
   owner_id - ID собственника
  1011 - SC APC
Дополнительно возвращаемые данные:
   1012 - LC APC
   array(
   1013 - FC APC
  [id] => ID объекта в случае успеха
   1014 - ST APC
   )
   1015 - E2000 APC
  10010 - SC UPC Female
   10011 - SC APC Female
  1100 - нет пигтейла
   5000 - вышел из строя

Текущая версия от 08:10, 18 июня 2025

en | 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 - вышел из строя