API device

Раздел API ERP "UserSide"

Назначение: Оборудование

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

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

get_device_id

Описание: Получение ID устройства по входящим данным
Обязательные параметры:
 object_type - Тип устройства [switch]
 data_typer - тип данных, которые проверяем (возможные значения: ip, inventory_number, additional_field_XXX)
 data_value - значение
Дополнительно возвращаемые данные:
 array(
  [id] => id устройства в случае успеха
 )

get_data

Описание: Получение информации об устройствах
Обязательные параметры:
 object_type - Тип устройства [switch]
Необязательные параметры:
 object_id - id объекта для выборки
Дополнительно возвращаемые данные:
 array(
   [data] = array(
     [address_city_id] => id населенного пункта
     [name] => модель устройства (наименование)
     [location] => размещение объекта (текстовое)
     [host] => ip-адрес/имя хоста
     [house_id] => id дома установки
     [node_id] => id узла установки
     [interfaces] => количество интерфейсов
     [entrance] => номер подъезда
     [activity_time] => время последней активности
     [mark] => метки
     [additional_data] => доп.поля
   )
 )

add_mark

Описание: Добавление метки
Обязательные параметры:
 object_type - Тип устройства [switch]
 object_id - id устройства
 mark_id - ID метки

delete_mark

Описание: Снятие метки
Обязательные параметры:
 object_type - Тип устройства [switch]
 object_id - id устройства
 mark_id - ID метки

set_data

Описание: Изменение информации об устройстве
Обязательные параметры:
 object_type - Тип устройства [switch]
 object_id - id устройства
 param - тип параметра для изменения [ip|mac]
 value - данные (может быть пустым)