Объекты уведомления¶

Получить уведомление ¶

GET /(company_code)/v2/aol/notice/(notice_uuid)¶

Прочитать уведомление

Получить данные уведомления, включая текст сообщения. Если вызвано получателем уведомления, также помечает уведомление как прочитанное.

Заголовки запроса:
	Authorization – `Bearer <сессионный_токен>`, либо `Signature <подпись>`
Параметры:	notice_uuid – Код UUID уведомления для прочтения
JSON-объект ответа:
	status (string) – `success` или `error` data (object) – Объект данных уведомления. Включаемые поля зависят от роли авторизованного пользователя. unread_count (integer) – Количество непрочитанных уведомлений для профиля получателя error_code (string) – (Необязательно) Если `status` содержит `error`: один из перечисленных ниже кодов ошибки

Поля данных уведомления

Объект ответа data содержит следующие поля:

Имя поля	Тип	Описание
uuid	string	Код UUID уведомления
recipient	string	Мнемокод профиля получателя
timestamp	string	Дата и время уведомления в формате ISO: YYYY-MM-DDTHH:MM:SS.mmm
category	string	Код категории согласно таблице подстановки
read_flag	boolean	Было ли уведомление прочитано получателем
subject	string	Текст темы уведомления
content_type	string	Код типа содержимого сообщения согласно таблице подстановки
body	string	Тело сообщения уведомления

Используемые коды ошибки

Подробнее см. Коды ошибок.

POST /(company_code)/v2/aol/notice/read¶

Отметить уведомления как прочитанные

Отмеченными как прочитанные могут быть только уведомления, отправленные авторизованному пользователю.

Заголовки запроса:
	Authorization – `Bearer <сессионный_токен>`, либо `Signature <подпись>`
JSON-объект запроса:
	notice_uuids (array) – Коды UUID уведомлений для отметки как прочитанные
JSON-объект ответа:
	status (string) – `success` или `error` data (array) – Объекты результата операции unread_count (integer) – Количество непрочитанных уведомлений для профиля получателя error_code (string) – (Необязательно) Если `status` содержит `error`: один из перечисленных ниже кодов ошибки

Поля результата операции

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля	Тип	Описание
uuid	string	Код UUID уведомления из запроса
status	string	Статус операции, `success` или `error`
error_code	string	(Необязательно) Если `status` содержит `error`: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

Подробнее см. Коды ошибок.