Cerebellum / Руководство разработчика REST / Быстрый запрос для получения задач и точек /news/points
Быстрый запрос для получения задач и точек /news/points
Выгружаемые поля
В ответе к запросу /news/points будут выгружаться следующие поля:
"id", // id задачи
"title", // заголовок задачи
"assigned_status", // id параметра assigned_status
"lon", // longitude (долгота точки, привязанной к задаче)
"lat" // latitude (широта точки, привязанной к задаче)
Пример запроса (с параметрами limit, page):
/news/points?limit=3&page=1
Формат ответа:
{
"res": 1,
"resText": "",
"news_list": [
{
"id": "788975",
"title": "Тест",
"assigned_status": "1",
"lon": "61.2374578267761",
"lat": "55.6351020633081"
},
{
"id": "788974",
"title": "Тест",
"assigned_status": "1",
"lon": "49.0868144141876",
"lat": "55.8458252690369"
},
{
"id": "788953",
"title": "Задание",
"assigned_status": "4",
"lon": null,
"lat": null
}
],
"count_news": "43"
}
Параметры limit, page
В запросе /news/points могут быть указаны количественные параметры:
- limit — количество задач, отображаемых на одной странице (по умолчанию, limit=25),
- page — номер отображаемой страницы (по умолчанию, page=1)
Пример запроса:
/news/points?limit=5&page=4
Ответ:
{
"res": 1,
"resText": "",
"news_list": [
{
"id": "788662",
"title": "Тестовая задача",
"assigned_status": "3",
"lon": "55.56",
"lat": "46.67"
},
{
"id": "788653",
"title": "Test photo preview del",
"assigned_status": "2",
"lon": "49.1966755662001",
"lat": "55.8087218268519"
},
{
"id": "788627",
"title": "Тест загрузки файлов",
"assigned_status": "1",
"lon": "49.0868144141876",
"lat": "55.7591952658046"
},
{
"id": "788626",
"title": "Тест загрузки файлов",
"assigned_status": "1",
"lon": "49.1087866445901",
"lat": "55.7839664493374"
},
{
"id": "788625",
"title": "Тест загрузки файлов",
"assigned_status": "1",
"lon": "49.0648421837851",
"lat": "55.8334614039231"
}
],
"count_news": "43"
}
Фильтры
Для запроса /news/points доступны следующие параметры фильтрации:
- withAssigned — при значении withAssigned=true в список добавляются не новые и не закрытые новости, назначенные пользователю, либо его ведомству (если он админ) новости
- withClosed — при значении withClosed=true в список добавляются новости со статусом выполнено, назначенные пользователю, либо его ведомству (если он админ)
- withArchive — при значении withArchive=true, в список добавляются новости, которые в архиве (по умолчанию берутся текущие)
- onlyMy — при значении onlyMy=true, в списке отображаются только новости, созданные пользователем. Параметры withAssigned, withClosed, onlyStatus при этом игнорируются
- onlyStatus — отображаются новости с соответствующими статусами. Id статусов передаются через запятую. Например, onlyStatus=2,3
- onlyStates — отображаются новости, которые находятся в соответствующих состояниях. Id статусов передаются через запятую. Например, onlyStates=6,11
- onlyAssigned — при значении onlyAssigned=true отображаются новости, которые не новые и не выполнены, но назначены.
- category_id — фильтр по категориям новостей. Id категорий передаются через запятую. Например, category_id=1,2
- type_id — фильтр по типам новостей. Id типов передаются через запятую. Например, Например, type_id=3,4,5
- gtUpdateDate — отображаются новости, дата обновления которых больше указанной даты (дата указывается в Timestamp, например, gtUpdateDate=1440835402).
- ltUpdateDate — отображаются новости, дата обновления которых меньше указанной даты (дата указывается в Timestamp, например, ltUpdateDate=1440835402).
- gtCreateDate — отображаются новости, дата создания которых больше указанной даты (дата указывается в Timestamp, например, gtCreateDate=1440835402).
- ltCreateDate — отображаются новости, дата создания которых меньше указанной даты (дата указывается в Timestamp, например, ltCreateDate=1440835402).
- gtDeadline — отображаются новости, параметр deadline которых больше указанной даты (дата указывается в Timestamp, например, gtDeadline =1440835402).
- ltDeadline — отображаются новости, параметр deadline которых меньше указанной даты (дата указывается в Timestamp, например, ltDeadline =1440835402).
- assigned_organization_id — отображаются новости, которые назначены на указанные организации. Id организаций передаются через запятую. Например, assigned_organization_id=1,2,292
- assigned_user_id — отображаются новости, которые назначены на указанных пользователей. Id пользователей передаются через запятую. Например, assigned_user_id=616,618
- user_id — отображаются новости, созданные указанными пользователями. Id пользователей передаются через запятую. Например, user_id=616,618
- confirmed — отображаются новости, которые имеют указанное значение параметра confirmed. Например, confirmed=1
- search — отображаются новости, удовлетворяющие текстовому поиску указанного значения по значениям параметров id, text, title. Например, search=7891
- customFields — отображаются новости, отфильтрованные по значениям кастомных полей. Например, customFields=[{«name»:»Dop_pole_dlya_testov»,»op»:»EQ»,»value»:»12345″},{«name»:»Telefon__int__88432000555__»,»op»:»NOT NULL»}].
Более подробно фильтрация по кастомным полям описана в разделе Фильтрация задач по custom-полям - expired — при значении expired=true отображаются непросроченные новости (значение параметра deadline меньше текущей даты и параметр confirmed=1), при значении expired=false отображаются просроченные новости (значение параметра deadline больше текущей даты или значение параметра confirmed отлично от 1)
Примеры:
/news/points?limit=10&page=1&withAssigned=true&withArchive=true&onlyStatus=2,3&onlyStates=6,11&category_id=1,2
/news/points?limit=10&page=1>UpdateDate=1440835402<UpdateDate=1443513802>CreateDate=1438157002<CreateDate=1443513802&expired=false
/news/points?limit=10&page=1&assigned_organization_id=2,292&assigned_user_id=618,625&user_id=6&confirmed=1
/news/points?limit=10&page=1&search=тест&customFields=[{"name":"Dop_pole_dlya_testov","op":"EQ","value":"12345"},{"name":"Telefon__int__88432000555__","op":"NOT NULL"}]
Сортировки запроса
Для запроса /news/points можно задать следующие параметры для сортировки списка заданий:
- sortBy — поле, по которому осуществляется сортировка. По умолчанию сортировка ведется по полю news_date.
Допустимые для сортировки поля:
- id,
- news_date,
- update_date,
- create_date,
- deadline,
- assigned_organization_id,
- assigned_user_id,
- user_id,
- news_type_id,
- category_id,
- confirmed
- sortDirection — направление сортировки. По умолчанию — DESC.
Допустимые варианты: ASC, DESC
Пример:
/news/points?limit=5&page=1&sortBy=create_date&sortDirection=ASC