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

Материал из WiKi - UserSide
(Новая страница: «Раздел '''API''' ERP "UserSide" Назначение: Оборудование Дополнительные параметры: action - подка…»)
 
Нет описания правки
Строка 18: Строка 18:
     [data] = array(
     [data] = array(
       [address_city_id] => id населенного пункта
       [address_city_id] => id населенного пункта
       [name] => модель устройства (наименование)
       [name] => модель устройства ''(наименование)''
       [location] => размещение объекта (текстовое)
       [location] => размещение объекта ''(текстовое)''
       [host] => ip-адрес/имя хоста
       [host] => ip-адрес/имя хоста
       [house_id] => id дома установки
       [house_id] => id дома установки
Строка 28: Строка 28:
     )
     )
   )
   )
==== 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] => время последней активности
    )
  )
==== add_mark ====
Описание: Добавление метки
Обязательные параметры:
  object_type - Тип устройства [switch]
  object_id - id устройства
  mark_id - ID метки
==== delete_mark ====
Описание: Снятие метки
Обязательные параметры:
  object_type - Тип устройства [switch]
  object_id - id устройства
  mark_id - ID метки

Версия от 13:39, 1 июня 2016

Раздел API ERP "UserSide"

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

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

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

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] => время последней активности
   )
 )

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] => время последней активности
   )
 )

add_mark

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

delete_mark

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