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

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


Строка 9: Строка 11:


==== add ====
==== add ====
  Описание: Получение массива коммутации
''Доработано в: 3.18.25 (в object_type добавлен вариант splitter, в object2_type добавлен вариант splitter)''
 
''Доработано в: 3.14.71 (в object_type добавлен вариант cross, в object2_type добавлен вариант cross)''
 
''Доработано в: 3.13.70 (в object_type добавлен вариант fiber, в object2_type добавлен вариант fiber, добавлены параметры object1_side и object2_side)''
 
''Доработано в: 3.12.59 (добавлен параметр object1_port, в object_type добавлен вариант switch)''
 
  Описание: Коммутация объектов
  Обязательные параметры:
  Обязательные параметры:
   object_type - Тип объекта [customer]
   object_type - тип объекта [customer|switch|fiber|cross|splitter]
   object_id - id объекта
   object_id - id объекта
   object2_type - Тип объекта 2 [switch]
  object1_side - сторона объекта 1 ''(для кабельных линий)''
  object1_port - порт объекта 1
   object2_type - тип объекта 2 [switch|fiber|cross|splitter]
   object2_id - id объекта 2
   object2_id - id объекта 2
  object2_side - сторона объекта 2 ''(для кабельных линий)''
   object2_port - порт объекта 2
   object2_port - порт объекта 2
Дополнительно возвращаемые данные:
  [id] = array(
      [object_type] => Тип объекта
      [object_id] => id объекта
      [direction] => Сторона коммутации ''(например для ВОЛС)''
      [interface] => Номер интерфейса
      [comment] => Заметки
      [connect_id] => id записи о коммутации
    )
  )


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


==== get_data ====
==== get_data ====
''Изменено в 3.14.12 (в object_type добавлен вариант splitter)''
''Изменено в 3.12.52 (в object_type добавлен вариант radio)''
  Описание: Получение массива коммутации
  Описание: Получение массива коммутации
Обязательные параметры:
  object_type - Тип объекта для выборки [customer|switch|radio|cross|fiber|splitter]
  Необязательные параметры:
  Необязательные параметры:
  object_type - Тип объекта для выборки [customer|switch|cross|fiber]
   object_id - id объекта для выборки
   object_id - id объекта для выборки
   is_finish_data - Флаг - выводить конечную точку коммутации
   is_finish_data - Флаг - выводить конечную точку коммутации
  Дополнительно возвращаемые данные:
  Дополнительно возвращаемые данные:
  [id] -
  array(
    [data] = array(
       [object_type] => Тип объекта
       [object_type] => Тип объекта
       [object_id] => id объекта
       [object_id] => id объекта
Строка 48: Строка 61:
       [connect_id] => id записи о коммутации
       [connect_id] => id записи о коммутации
     )
     )
  )

Текущая версия от 13:52, 26 октября 2023

en | ru

Раздел API ERP "UserSide"

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

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

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

add

Доработано в: 3.18.25 (в object_type добавлен вариант splitter, в object2_type добавлен вариант splitter)

Доработано в: 3.14.71 (в object_type добавлен вариант cross, в object2_type добавлен вариант cross)

Доработано в: 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|cross|splitter]
 object_id - id объекта
 object1_side - сторона объекта 1 (для кабельных линий)
 object1_port - порт объекта 1
 object2_type - тип объекта 2 [switch|fiber|cross|splitter]
 object2_id - id объекта 2
 object2_side - сторона объекта 2 (для кабельных линий)
 object2_port - порт объекта 2

delete

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

Описание: Очистка коммутации
Обязательные параметры:
 object_type - Тип объекта [customer|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 записи о коммутации
   )