Контроллер для отправки уведомлений.

/api/Notification/Send

Отправляет уведомление.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Модель сообщения.

Название поля	Тип поля	Обязательное
mandatory	boolean	нет
saveHistory	boolean	нет
sourceID	string	нет
sourceType	Type
targetID	string	нет
targetType	Type
type	Type
data	object	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поля	Тип поля	Описание	Обязательное
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController Send(ASE.MD.Platform.Infrastructure.WebNotification.Models.Message.Info)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:execute

/components/securitySchemes/webnotificationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:execute, webnotification:notification:read, webnotification:notification:write

/api/Notification/GetUsersOnline

Возвращает перечень пользователей в сети (онлайн).

Тип HTTP запроса: post

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
userToken	string	Токен пользователя (не используется).	query	нет

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController GetUsersOnline(System.String)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:read

/components/securitySchemes/webnotificationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:execute, webnotification:notification:read, webnotification:notification:write

/api/Notification/GetHistory

Возвращает историю сообщений.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Фильтре для отбора сообщений.

Название поля	Тип поля	Обязательное
userID	string	нет
startDate	string (date-time)	нет
endDate	string (date-time)	нет
countItem	integer (int32)	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
items	Item[]		нет
error	Info

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController GetHistory(ASE.MD.Platform.Infrastructure.WebNotification.Models.History.Filter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:read

/components/securitySchemes/webnotificationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:execute, webnotification:notification:read, webnotification:notification:write

/api/Notification/Test

Отправляет тестовое сообщение.

Тип HTTP запроса: get

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поля	Тип поля	Описание	Обязательное
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поля	Тип поля	Описание	Обязательное
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController Test()

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:execute

/components/securitySchemes/webnotificationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:execute, webnotification:notification:read, webnotification:notification:write

/api/Notification/DeleteMessage

Удаляет сообщение с указанным идентификатором.

Тип HTTP запроса: get

Параметры

Название	Тип	Описание	Передаётся в	Обязательное
messageId	integer (int32)	Идентификтаор сообщения.	query	нет

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поля	Тип поля	Описание	Обязательное
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Код HTTP ответа: 200

MIME-тип HTTP ответа: text/plain

Success

Название поля	Тип поля	Описание	Обязательное
message	string	Сообщение ошибки.	да
exceptionType	string	Тип исключения.	да
code	string	Код ошибки.	да
source	string	Имя источника.	да
inners	InnerInfo[]	Элементы исключений.	да
extra	string	Трейс стека.	да
isError	boolean	Флаг ошибки.	да
id	string	Идентификатор ошибки.	да
type	ErrorTypes		да

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController DeleteMessage(System.Int32)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:write

/components/securitySchemes/webnotificationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	webnotification:notification:execute, webnotification:notification:read, webnotification:notification:write

/api/Notification/Send​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/webnotificationservice public NotificationController Send(ASE.MD.Platform.Infrastructure.WebNotification.Models.Message.Info)​

/components/securitySchemes/webnotificationservice​

/api/Notification/GetUsersOnline​

Параметры​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/webnotificationservice public NotificationController GetUsersOnline(System.String)​

/components/securitySchemes/webnotificationservice​

/api/Notification/GetHistory​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/webnotificationservice public NotificationController GetHistory(ASE.MD.Platform.Infrastructure.WebNotification.Models.History.Filter)​

/components/securitySchemes/webnotificationservice​

/api/Notification/Test​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/webnotificationservice public NotificationController Test()​

/components/securitySchemes/webnotificationservice​

/api/Notification/DeleteMessage​

Параметры​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/webnotificationservice public NotificationController DeleteMessage(System.Int32)​

/components/securitySchemes/webnotificationservice​

/api/Notification/Send

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController Send(ASE.MD.Platform.Infrastructure.WebNotification.Models.Message.Info)

/components/securitySchemes/webnotificationservice

/api/Notification/GetUsersOnline

Параметры

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController GetUsersOnline(System.String)

/components/securitySchemes/webnotificationservice

/api/Notification/GetHistory

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController GetHistory(ASE.MD.Platform.Infrastructure.WebNotification.Models.History.Filter)

/components/securitySchemes/webnotificationservice

/api/Notification/Test

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController Test()

/components/securitySchemes/webnotificationservice

/api/Notification/DeleteMessage

Параметры

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/webnotificationservice public NotificationController DeleteMessage(System.Int32)

/components/securitySchemes/webnotificationservice