v2.1 Получение всех возможных типов событий

Объекты типов событий.

Запрос:

URL:

все типы - https://api.url/v2.1notifications/events

тип по id - https://api.url/v2.1/notifications/events/<type_id>

Доп. Заголовки:

If-Modified-Since - Если ранее уже запрашивался полный список зон, то при обновлении следует указывать заголовок If-Modified-Since с датой полученной заголовка ответа Last-Modified

Accept - Указание формата ответа. Должен быть "application/vnd.api+json", для совместимости принимается также "application/json".

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Доп. Параметры запроса:

Поле	Тип	Значение по умолчанию	Описание
page[offset]	int	0	Пропустить несколько первых записей
page[limit]	int	1000	Максимальное количество объектов в ответе
fields[notificationEvent]	string		Фильтрация полей объектов.
filter[notificationEvent]	string		Фильтрация результатов (см раздел "Фильтрация результатов")
sort	string		Сортировка результатов.

Параметр include (определённые в стандарте JSON API) в текущей версии api не поддерживаются. В случае их получения сервер будет возвращать ошибку 400.

Ответ:

Ответ присылается в формате JSON API.

Поле

Описание

links

Поле links содержит ссылки на ресурсы.

Минимально он должен содержать ссылку на текущий ресурс (self).

Если всех водителей не удалось поместить в одном ответе то также будет содержаться

next - следующая страница (если есть)

prev - предыдущая страница (если есть)

first - первая страница с результатами

last - последняя страница с результатами

data

Содержит объект с агрегированными данными в формате JSON API.

Описание объекта

Поле	Тип	Описание
id	string	идентификатор данных
type	string	тип объекта - всегда notificationEvent
attributes	object	объект с самими данными

Атрибуты:

Поле	Тип	Nullable	Описание
Name	string	нет	Название события (код). NotificationsEvents.Name и LogisticsEvent.Code
MessageText	string	нет	Текст по умолчению - xml. NotificationEvents.MessageText LogisticsNotificationSetting.Text
Level	int	нет	Важность события по умолчанию. NotificationEvents.Level LogisticsNotificationSetting.Level
EventType	string	нет	Тип/источник события: online report admin logistics .

Пример:

GET https://api.url/v2.1/notifications/events HTTP/1.1
Accept: application/vnd.api+json
Authorization: Bearer <auth token>
 
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
Allow: GET
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT

{
    "links": {
        "self": "http://api.url/v2.1/notifications/events"
    },
    "meta": {
        "total_count": 53
    },
    "data": [
        {
            "id": "log-1",
            "type": "notificationEvent",
            "attributes": {
                "Name": "ORDER_CREATE",
                "MessageText": "Появилась новая заявка в системе №<Order_Number/>, заявитель: <Order_Applicant/>.",
                "Level": 3,
                "EventType": "logistics"
            }
        },
        {
            "id": "base-1",
            "type": "notificationEvent",
            "attributes": {
                "Name": "Alarm",
                "MessageText": "Тревожная кнопка.<br/> ТС: <reg_number/>.<br/> Время: <time/>.<br/> Адрес: <address/>.",
                "Level": 8,
                "EventType": "online"
            }
        },
        ...
    ]
}

Page tree