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

Материал из WiKi - UserSide
Нет описания правки
Строка 21: Строка 21:
     )
     )
   )
   )
==== add_field ====
Описание: Добавление доп.поля
Обязательные параметры:
  cat_id - категория доп.поля
  name - наименование доп.поля
  object_id - id объекта
  value - значение
Дополнительно возвращаемые данные:
  id - id записи в таблице доп.данных ''(в случае успеха)''


==== change_value ====
==== change_value ====

Версия от 13:26, 26 ноября 2017

Раздел API ERP "UserSide"

Назначение: Действие с дополнительными полями/данными

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

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

get_list

Описание: Получение списка полей
Обязательные параметры:
 section - Категория дополнительных полей [house|node|task|switch]
Дополнительно возвращаемые данные:
 array(
   [data] = array(
     [id] => id поля
     [name] => наименование поля
     [type] => тип поля
     [available_value] => перечень возможных значений для поля со списком
   )
 )

add_field

Описание: Добавление доп.поля 
Обязательные параметры:
 cat_id - категория доп.поля 
 name - наименование доп.поля
 object_id - id объекта
 value - значение
Дополнительно возвращаемые данные:
 id - id записи в таблице доп.данных (в случае успеха)

change_value

Описание: Изменение значения доп.поля 
В случае отсутствия такого доп.поля у объекта - оно будет создано.
Обязательные параметры:
 field_id - id дополнительного поля
 object_id - id объекта
 value - значение
Дополнительно возвращаемые данные:
 id - id записи в таблице доп.данных (в случае успеха)