Извещение

Извещение - это текстовые сообщение адресованные пользователю системы.

API

POST /api/v1/notice/set

Добавляет или меняет извещение.

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

Имя	Тип	Значение	Описание
id	UUID		Обязательный только для действия Изменить. Идентификатор извещения.
userid	UUID		Обязательный. Идентификатор учётной записи пользователя.
object	UUID		Идентификатор объекта.
text	STRING		Обязательный. Текст извещения.
category	STRING		Рекомендуемый. Категория извещения. По умолчанию `notice`.
status	INTEGER	0, 1, 2, 3, 4	Рекомендуемый. Статус извещения: 0 - создано; 1 - доставлено; 2 - прочитано; 3 - принято; 4 - отказано. По умолчанию - 0.
data	JSON		Данные в произвольном формате.

ВНИМАНИЕ: Если значение ключа id не указано или равно null, то действие считается как Добавить, иначе как Изменить.

ВНИМАНИЕ: Значения не указанных ключей считаются как null.

ВНИМАНИЕ: Для действия Изменить не нужно передавать значения всех ключей, достаточно передать только те, которые требуется поменять.

ВНИМАНИЕ: Ответом на запрос будут данные действия Получить.

POST /api/v1/notice/get

Возвращает извещение.

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

Имя	Тип	Значение	Описание
id	UUID		Обязательный. Идентификатор извещения.

Формат ответа:

Поле	Тип	Описание
id	UUID	`*` Идентификатор извещения.
userid	UUID	`*` Идентификатор учётной записи пользователя.
object	UUID	Идентификатор объекта.
entity	UUID	Идентификатор сущности.
entitycode	STRING	Код сущности.
entityname	STRING	Наименование сущности.
class	UUID	Идентификатор класса.
classcode	STRING	Код класса.
classlabel	STRING	Метка класса.
type	UUID	Идентификатор типа.
typecode	STRING	Код типа.
typename	STRING	Наименование типа.
typedescription	STRING	Описание типа.
label	STRING	Метка объекта.
text	STRING	`*` Текст извещения.
category	STRING	`*` Категория извещения.
status	INTEGER	`*` Статус извещения.
statuscode	STRING	`*` Код статуса извещения.
created	TIMESTAMP	`*` Дата и время создания извещения.
updated	TIMESTAMP	`*` Дата и время обновления извещения.
data	JSON	Данные в произвольном формате.

* - Не может быть пустым.

POST /api/v1/notice/count

Количество извещений с возможностью указания фильтра отбора данных.

Параметры запроса: Общие параметры запроса для списка

POST /api/v1/notice/list

Возвращает извещения в виде списка.

Параметры запроса: Общие параметры запроса для списка

Введение

Общее

API