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

Материал из WiKi - UserSide
Строка 27: Строка 27:


==== delete ====
==== delete ====
''Изменено в 3.14.56 (в object_type добавлен вариант device, добавлен параметр object_port)''
  Описание: Очистка коммутации
  Описание: Очистка коммутации
  Обязательные параметры:
  Обязательные параметры:
   object_type - Тип объекта [customer]
   object_type - Тип объекта [customer|device]
  object_port - Номер порта (для device)
   object_id - id объекта
   object_id - id объекта
Небязательные параметры:
  object_port - Номер порта ''(для device)''


==== get_data ====
==== get_data ====

Версия от 10:14, 26 апреля 2020

Раздел API ERP "UserSide"

Назначение: Коммутация объектов

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

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

add

Изменено в 3.13.70 (в object_type добавлен вариант fiber, в object2_type добавлен вариант fiber, добавлены параметры object1_side и object2_side)

Изменено в 3.12.59 (добавлен параметр object1_port, в object_type добавлен вариант switch)

Описание: Коммутация объектов
Обязательные параметры:
 object_type - Тип объекта [customer|switch|fiber]
 object_id - id объекта
 object1_side - сторона объекта 1 (для ВОЛС)
 object1_port - порт объекта 1
 object2_type - Тип объекта 2 [switch|fiber]
 object2_id - id объекта 2
 object2_side - сторона объекта 2 (для ВОЛС)
 object2_port - порт объекта 2
Дополнительно возвращаемые данные:
 [id] => id записи о коммутации

delete

Изменено в 3.14.56 (в object_type добавлен вариант device, добавлен параметр object_port)

Описание: Очистка коммутации
Обязательные параметры:
 object_type - Тип объекта [customer|device]
 object_port - Номер порта (для device)
 object_id - id объекта
Небязательные параметры:
 object_port - Номер порта (для device)

get_data

Изменено в 3.14.12 (в object_type добавлен вариант splitter)

Изменено в 3.12.52 (в object_type добавлен вариант radio)

Описание: Получение массива коммутации
Обязательные параметры:
 object_type - Тип объекта для выборки [customer|switch|radio|cross|fiber|splitter]
Необязательные параметры:
 object_id - id объекта для выборки
 is_finish_data - Флаг - выводить конечную точку коммутации
Дополнительно возвращаемые данные:
 array(
   [data] = array(
     [object_type] => Тип объекта
     [object_id] => id объекта
     [direction] => Сторона коммутации (например для ВОЛС)
     [interface] => Номер интерфейса
     [comment] => Заметки
     [connect_id] => id записи о коммутации
   )