Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

ru:d-sdk:4_units:3_get_units [2018/01/27 21:58] (текущий)
Строка 1: Строка 1:
 +====== Получение списка объектов ======
 +Запрос предназначен для получения списка объектов.
  
 +=== Пример запроса ===
 +<code php>&​svc=get_units&​params={
 +    "​id_group":​integer,​
 +    "​filtr_cf":​[{
 +        "​name":​string,​
 +        "​value":​string
 +    }]
 +}</​code>​
 +
 +=== Параметры ===
 +^ Параметр ​  ^ Значение ​  ^
 +| id_group | Уникальный идентификатор группы объектов |
 +| filtr_cf | JSON-объект,​ который имеет ключи name и value, для фильтрации объектов по custom-fields|
 +| name | Имя custom-field |
 +| value | Значение custom-field |
 +
 +=== Дополнительно ===
 +params={
 +    "​short_details":​1
 +} - Вернёт только данные из units
 +
 +svc = get_units вернёт все объекты доступные пользователю необязательный параметр id_group вернёт обекты входящие в эту группу необязательный параметр id_camera вернёт обект которому принадлежит камера (вместе с параметром id_group) вернёт объект,​ только если он входит в эту группу filtr_cf - при наличии параметра - вернёт объекты с custom fields если параметр пустой (filtr_cf:​«») вернёт все объекты со всеми custom_field
 +
 +=== Ответ сервера ===
 +== Результат запроса ==
 +<code php>{
 +    "​id":​ 66780, // Уникальный ID объекта
 +    "​hw_id":​ "​12412421",​ // ID оборудования объекта
 +    "​hw_type":​ "​32131241",​ // Тип оборудования объекта
 +    "​removed":​ 0, // Статус объекта (в корзине = 1, не в корзине = 0)
 +    "​is_free":​ 0, // Статус объекта (платный = 0, бесплатный = 1)
 +    "​creator":​ 24237, // Создатель объекта
 +    "​name":​ "​TestSDK",​ // Название объекта
 +    ...
 +}</​code>​