Описание: Список персон

Метод:  GET

Ресурс: person


Параметры:

• filter — список фильтрации:

  • change_date[from] — от даты последнего изменения в формате UNIX-timestamp (можно использовать отдельно от change_date[to])
  • change_date[to] — до даты последнего изменения в формате UNIX-timestamp (можно использовать отдельно от change_date[from])
  • create_date[from] — от даты создания в формате UNIX-timestamp (можно использовать отдельно от create_date[to])
  • create_date[to] — до даты создания в формате UNIX-timestamp (можно использовать отдельно от create_date[from]
  • is_deleted — флаг 1 или 0. Если параметр указан, то будут выдавать сущности с указанным значением
  • disabled — флаг 1 или 0, признак активности. Если выставлен, то сущность неактивна (признак берется из LDAP)

   

  • contact_type[] — фильтрация по типу контакта (можно передать несколько, например: /xapi/person?filter[contact_type][]=webaccount&filter[contact_type][]=icq)
  • contact_value[] — фильтрация по значению контакта (можно передавать несколько, например: /xapi/person?filter[contact_value ][]=user@ad&filter[contact_value ][]=login@example.com )
  • group_id[] — фильтрация по группам (можно передать несколько, например: /xapi/person?filter[group_id][]=webaccount&filter[group_id][]=icq)
• with[] — список дополнительных сущностей, которые должны быть добавлены к объекту:
  • contacts — контакты персоны
  • p2g — связь персоны с группами
  • status — статусы персоны
• sort — параметр для сортировки
  • change_date — сортировать по дате изменения asc или desc (например: /xapi/person?sort[change_date]=asc)  может замедлить выдачу

• start — с какой позиции начать отдавать элементы, по-умолчанию 0
• limit — сколько элементов отдавать, по-умолчанию 100, не может быть больше 1000

Ответ    : Список персон, описанный следующей JSON-Schema:

JSON схема отдачи списка персон 

Пример:

Запрос

Ответ