You are here: Home / 2015 / Январь / 20 / Automap — rest — Notification

Automap — rest — Notification

20 января 2015 admin
назад
Automap GS / Руководство разработчика REST / Оповещения

GET /notifies

Структура запроса:


GET /notifies?token=gtr543lpas87

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

[{
	"id": 1,
	"name": "Название",
	"timeFrom": 0,
	"timeTill": 86340000,
	"message": "",
	"expired": null,
	"eventId": 18,
	"carIds": [1887,2067,3152,3154],
	"userIds": [1908]
},…]

// id оповещения, целое число
// название оповещения, строка
// время начала оповещения, целое число
// время окончания оповещения, целое число
// текст сообщения, строка
// время, когда рассылка оповещений завершается, целое число
// id события, целое число
// id ТС, целое число
// id пользователя, целое число

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

GET /notifies/{id}

Структура запроса:


GET /notifies/1?token=gtr543lpas87

id: id оповещения

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 1,
	"name": "Название",
	"timeFrom": 0,
	"timeTill": 86340000,
	"message": "",
	"expired": null,
	"eventId": 18,
	"carIds": [1887,2067,3152,3154],
	"userIds": [1908]
}

// id оповещения, целое число
// название оповещения, строка
// время начала оповещения, целое число
// время окончания оповещения, целое число
// текст сообщения, строка
// время, когда рассылка оповещений завершается, целое число
// id события, целое число
// id ТС, целое число
// id пользователя, целое число

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

POST /notifies

Структура запроса:


POST /notifies?token=gtr543lpas87

token: ключ доступа

Пример запроса:

{
	"carIds": [1232],
	"eventId": 6,
	"expired": 1422434434000,
	"message": "ТС car.carInfo.carNo : event.info в date_from",
	"name": "Новое оповещение",
	"timeFrom": 36000000,
	"timeTill": 86340000,
	"userIds": [262, 3]
}

// id ТС, массив
// id события, целое число
// дата истечения отправки оповещений, timestamp
// текст сообщения, строка
// название оповещения, строка
// начало оповещения, timestamp
// конец оповещения, timestamp
// id пользователей, массив

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 381,
	"name": "Новое оповещение",
	"timeFrom": 36000000,
	"timeTill": 86340000,
	"message": "ТС car.carInfo.carNo : event.info в date_from",
	"expired": 1422434434000,
	"eventId": 6,
	"carIds": [123211],
	"userIds": [262, 3]
}

// id оповещения, целое число
// название оповещения, строка
// время начала оповещения, целое число
// время окончания оповещения, целое число
// текст сообщения, строка
// время, когда рассылка оповещений завершается, целое число
// id события, целое число
// id ТС, целое число
// id пользователя, целое число

Примечание:

При создании или редактировании оповещений в поле «message» появляются шаблонные варианты уведомлений, которые будут приходить определенным пользователям в виде электронных писем или SMS (в зависимости от настроек сервера). Текст этого шаблона зависит от типа выбранного события.

Кроме того, пользователю с правами администрирования доступно редактирование готовых шаблонов. Для этого он может воспользоваться следующими атрибутами:

  • car.carInfo.carNo — государственный номер транспортного средства;
  • date_from — дата начала события;
  • date_to — дата окончания события;
  • event.info — информация о событии;
  • car.carInfo.model — модель транспортного средства;
  • car.carInfo.mark — марка транспортного средства;
  • notify.time_from — время начала оповещения;
  • notify.time_till — время окончания оповещения;
  • event.data_from — дата начала события;
  • event.data_till — дата окончания события.

Статус: 400 — ошибка в запросе

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

PUT /notifies/{id}

Структура запроса:


PUT /notifies/28?token=gtr543lpas87

id: id оповещения

token: ключ доступа

Формат: json

{
	"carIds": [123211],
	"eventId": "9",
	"expired": 1422434434000,
	"id": 28,
	"message": "На ТС car.carInfo.carNo : event.info в date_from",
	"name": "Новое название",
	"timeFrom": 43200000,
	"timeTill": 86340000,
	"userIds": [262]
}

// id ТС, массив
// id события, целое число
// дата истечения отправки оповещений, timestamp
// id оповещения, целое число
// текст сообщения, строка
// название оповещения, строка
// начало оповещения, timestamp
// конец оповещения, timestamp
// id пользователей, массив

Ответ:

Статус: 200 — успешное выполнение

Формат: json

{
	"id": 28,
	"name": "Новое название",
	"timeFrom": 43200000,
	"timeTill": 86340000,
	"message": "На ТС car.carInfo.carNo : event.info в date_from",
	"expired": 1422434434000,
	"eventId": 9,
	"carIds": [123211],
	"userIds": [262]
}

// id оповещения, целое число
// название оповещения, строка
// время начала оповещения, целое число
// время окончания оповещения, целое число
// текст сообщения, строка
// время, когда рассылка оповещений завершается, целое число
// id события, целое число
// id ТС, целое число
// id пользователя, целое число

Статус: 400 — ошибка в запросе

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

DELETE /notifies/{id}

Структура запроса:


DELETE /notifies/33?token=gtr543lpas87

id: id оповещения

token: ключ доступа

Ответ:

Статус: 200 — успешное выполнение

Статус: 404 — объект не найден

Формат: text/plain

Содержит описание ошибки

Статус: 500 — ошибка на сервере

Формат: text/plain

Содержит описание ошибки

Posted in