Сообщения
Прикрепленные файлы:
Путь к фотографиям новости: /department_files/photos
Название: photo_{department_id}_{newsId}_{num}.{ext};
Путь к видео новости: /department_files/video
Название: video_{department_id}_{newsId}_{num}.flv;
Путь к звуковым файлам новости: /department_files/sounds
Название: sounds_{department_id}_{newsId}_{num}.{ext};
Путь к файлам новости: /department_files/dif_files
Название: files_{department_id}_{newsId}_{num}.{ext};
Добавление сообщения
POST /news/
Пример запроса:
{
"action": "put",
"values": {
"news_date": "21.05.2012",
"news_hour": "13",
"news_minute": "41",
"title": "Заголовок",
"text": "Текст",
"news_type_id": 1,
"category": 1,
"department_id": ,
"system_data": "версия: 1.1.1",
"photo_main": 0,
"custom_fields": "{\"транслит поля\": {\"field_id\": id поля}}"
},
"point": [55.56,46.67],
"photos": ["dN2k9B9r42YbfDyz.jpg",
"tAFEAB5Aftt8ybta.png"],
"photos_name": ["1313410929241.jpg",
"131341095.png"],
"photos_desc": ["описание1",
"описание2"],
"video": ,
"video_name": ,
"video_desc": ,
"files": ["dN2k9B9r42YbfDxrg.txt"],
"files_name": ["files.txt"],
"files_desc": ["описание"],
"sounds": ["{}"],
"sounds_name": ["{}"],
"sounds_desc": ["{}"]
}Формат ответа:
{
"res": 1,
"newsId": ""
}Получение списка доступных сообщений
GET /news/listAfterId/{newsAfterId}/{limit}/{confirmedType}?withAssigned=&withClosed=&withArchive=&onlyMy=&onlyStatus
newsAfterId — id сообщения, после которой надо получить список сообщений, либо 0
limit — количество сообщений в запросе, если 0 — то используется значение по умолчанию
confirmedType — если параметр опущен, иначе 0 — не просмотренные, 1 — утвержденные, 2 -не утвержденные
Необязательные query — параметры:
withAssigned — если true, в список добавляются сообщения, назначенные пользователю, либо его ведомству (если он админ)
withClosed — если true, в список добавляются сообщения со статусом выполнено, назначенные пользователю, либо его ведомству (если он админ)
withArchive — если true, в список добавляются сообщения, которые в архиве (по умолчанию берутся текущие)
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=95,121,39
hasPoint — отдаются новости, у которых есть точка, например:
http://server.name/rest/news/listAfterId/123/10?hasPoint=true
hasPhoto — отдаются новости, у которых есть прикрепленные фотографии, например:
http://server.name/rest/news/listAfterId/123/10?hasPhoto=true
hasVideo — отдаются новости, у которых есть прикрепленные видео, например:
http://server.name/rest/news/listAfterId/123/10?hasVideo=true
hasFile — отдаются новости, у которых есть прикрепленные файлы, например:
http://server.name/rest/news/listAfterId/123/10?hasFile=true
hasAudio — отдаются новости, у которых есть прикрепленные аудио файлы, например:
http://server.name/rest/news/listAfterId/123/10?hasAudio=true
gtUpdateDate — список новостей, дата обновления которых больше текущей даты, например:
http://server.name/rest/news/listAfterId/123/10?gtUpdateDate=06.11.2014 13:00
ltUpdateDate — список новостей, дата обновления которых меньше текущей даты, например:
http://server.name/rest/news/listAfterId/123/10?ltUpdateDate=06.11.2014 13:00
sortBy — поле, по которому осуществляется сортировка. По умолчанию — news_date. Варианты: news_date|update_date|id|user_id|news_type_id|category_id
sortDirection — направление сортировки. По умолчанию — desc. Варианты: asc|desc
Пример запросов:
http://server.name/rest/news/listAfterId/123/10?onlyMy=true
http://server.name/rest/news/listAfterId/123/10?onlyStatus=2,3
http://server.name/rest/news/listAfterId/123/10?withAssigned=true&withClosed=true&withArchive=true
Пример ответа:
{
"res": 1,
"resText": "",
"news_list": [{
"id": "18069",
"department_id": "1",
"department_logo": "logo_1.jpg",
"news_date": "2012-05-22 15:44:00+04",
"confirmed": "0",
"title": "Заголовок",
"text": "Текст",
"news_type_id": "1",
"category_id": "1",
"assigned_to": null,
"assigned_department_name": null,
"assigned_status": "1",
"status_name": "новое",
"assigned_to_user": null,
"assigned_user_fio": null,
"assigned_change_date": "2013-07-16 12:11:57.224137+04",
"restricted": "t",
"notice": "1",
"news_type_icon": "icon3d_1.png",
"news_type_name": "происшествие",
"num_main_photo": null,
"archive": "f",
"category_name": "информационная",
"system_data": "это системная дата",
"lon": "49.1061401367188",
"lat": "55.7958774456641",
"zoom": "10",
"custom_fields": "{транслит поля: {"field_id": id поля}}",
"department_title": ,
"user_id": ,
"user_fio":
}],
"count_news":"5426"
}
// id сообщения
// id ведомства
// логотип ведомства
// дата сообщения
// 0 - не просмотрена, 1 - утверждена, 2 - не утверждена
// заголовок
// текст
// id типа сообщения
// id категории
// id ведомства, на которое назначена сообщение, иначе null
// название ведомства, на которое назначена сообщение, иначе null
// номер статуса | 1 - новое, 2 -назначено, 3 - обратная связь, 4 - выполнено
// название статуса
// id пользователя, на которого назначена сообщение, иначе null
// ФИО пользователя, на которого назначена сообщение, иначе null
// дата последнего обновления статуса
// ограниченный доступ к сообщения или же нет | t или f
// 1 - уведомлять на E-mail, 2 - уведомлять на E-mail и по почте
// название иконки типа сообщения
// название типа сообщения
// порядковый номер фотографии, которая является заголовком, иначе null
// в архиве сообщение или нет | t или f
// название категории
// системные данные
// долгота точки, null-если точки нет
// широта точки, null-если точки нет
// уровень масштаба, на котором поставлена точка
// json - строка со списком дополнительных полей и их значений
// заголовок ведомства
// id пользователя
// ФИО пользователя
//количество сообщений, которое доступно пользователю
Количество сообщений, которое доступно пользователю
GET /news/count
Параметры фильтрации:
date_from — дата начала, начиная с которой необходимо отфильтровать новости. Формат timestamp, например date_from=1212121212
date_till — дата, до которой необходимо отфильтровать новости. Формат timestamp, например date_till=1212656565
category_id — фильтр по категориям новостей. id категорий передаются через запятую. Например, category_id=1,2
type_id — фильтр по типам новостей. id типов передаются через запятую. Например, type_id=1,2
status_id — фильтр по статусам новостей. id статусов передаются через запятую. Например, status_id=1,2
department_id — фильтр по организациям, в которых были созданы новости. id организаций передаются через запятую. Например, department_id=1,2
assigned_department_id — фильтр по организациям, которые были назначены на новости. id организаций передаются через запятую. Например, assigned_department_id=1,2
Формат ответа:
{
"res": 1,
"resText": "",
"countNews": 16578,
"statuses": [{
"status_id": 1,
"count": 535
},...]
}Прикрепленные файлы
Путь к иконкам категории: /department_files/news_category
Список дополнительных полей и их возможных типов
GET /news/custom_fields
Формат ответа:
{
"res": ,
"custom_fields": [{
"id": ,
"name": ,
"translit": ,
"format": ,
"group_name": ,
"possible_values": ,
"regexp": ,
"min_length": ,
"max_length": ,
"is_required": ,
"default_value": ,
"visible": ,
"is_for_all": ,
"order": ,
"news_type_ids":
}],
"fields_types": [{
"name": ,
"rusname":
}
}
// id поля
// русское название
// транслит русского названия
// формат: английское название типа поля
// название группы полей
// возможные значения
// регулярное выражение для типов string и text
// минимальная длина строки/текста
// максимальная длина строки/текста
// является ли поле обязательным (t или f)
// значение по умолчанию
// является ли поле видимым (t или f)
// доступно ли поле всем типам сообщений
// порядковый номер поля в общем списке
// массив id типов сообщений, для которых поле доступно
// английское название
// русское название
Список состояний сообщения
GET /news/states
Формат ответа:
{
"res": ,
"states": [{
"id": ,
"name": ,
"field": ,
"value": ,
"sign": ,
"field_from_session":
}]
}
// id состояния
// название
// поле, по которому осуществляется проверка
// значение, которое поле должно принимать
// знак для сравнения
// поле в сессии, если нужно сравнивать с ним
Список действий, которые можно осуществлять с сообщениями
GET /news/capabilities
Формат ответа:
{
"res": ,
"capabilities": [{
"id": ,
"name":
}
}
// id действия
// название
Список правил с состояниями, в которых должно находиться сообщение для предоставления доступа текущему пользователю
GET /news/allowed
Если для роли не прописано какое-то действие, то оно не будет для нее доступно. Если в поле состояний стоит null, действие доступно роли при любых состояниях
Формат ответа:
{
"res": 1,
"resText": "",
"allowed": [{
"id": ,
"capability_id": ,
"states":
}]
}
// id правила
// id действия
// массив id состояний, либо null
Количество новостей с группировкой по статусам, категориям, типам, организациям
GET /news/stats
Параметры фильтрации:
date_from — дата, начиная с которой необходимо отфильтровать сообщения. Формат timestamp, например date_from=1212121212
date_till — дата, до которой необходимо отфильтровать сообщения. Формат timestamp, например date_till=1212656565
Формат ответа:
{
"res": 1,
"resText": "",
"statuses": [
{"status_id": 10, "count": 20},
{"status_id": 11, "count": 20},
{"status_id": 12, "count": 20}
],
"categories": [
{
"category_id": 10
"statuses": [
{"status_id": 10, "count": 20},
{"status_id": 11, "count": 20},
{"status_id": 12, "count": 20}
]
}
],
"types": [
{
"type_id": 10
"statuses": [
{"status_id": 10, "count": 20},
{"status_id": 11, "count": 20},
{"status_id": 12, "count": 20}
]
}
],
"departments": [
{
"department_id": 10
"statuses": [
{"status_id": 10, "count": 20},
{"status_id": 11, "count": 20},
{"status_id": 12, "count": 20}
]
}
],
"assignedDepartments": [
{
"assigned_department_id": 10
"statuses": [
{"status_id": 10, "count": 20},
{"status_id": 11, "count": 20},
{"status_id": 12, "count": 20}
]
}
]
}Список категорий сообщений
GET /category
Формат ответа:
{
"res": 1,
"category": [{
"id": ,
"name": ,
"icon " : ,
"order_important" :
}]
}
// id категории
// название категории
// название иконки
// степень значимости категории
Список типов сообщений
GET /newstype
Формат ответа:
{
"res": 1,
"newstype": [{
"news_type_id": ,
"name": ,
"icon": ,
"icon3d": ,
"map_icon": ,
"map_icon_highlight": ,
"default_type": ,
"period_of_review":
}]
}
// id типа
// название типа
// название двухмерной иконки
// название трехмерной иконки
// название иконки для карты
// название увеличенной иконки для карты
// является ли типом по умолчанию
// период исполнения сообщения данного типа
Список статусов сообщений
GET /status
Формат ответа:
{
"res": 1,
"status": [{
"id": ,
"name": ,
"visible" :
}]
}
// id статуса
// название статуса
// виден ли пользователям в списке статусов, 't' или 'f'