Взаимодействие с заглушками ЦУ
Получение уведомлений по их идентификаторам и типу
Возвращает уведомления по их идентификаторам и типу.
Запрос
Swagger
GET
/v1/type/{type}/ids/{ids}Параметры
| Параметр | Тип | Описание |
|---|---|---|
type * (path) | string | Тип уведомления |
ids * (path) | array | Идентификатор уведомления |
status (query) | string | Статус уведомления |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | StubNotificationResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Изменение статуса уведомления
Изменяет статус уведомления.
Запрос
Swagger
PUT
/v1/type/{type}/ids/{ids}Параметры
| Параметр | Тип | Описание |
|---|---|---|
type * (path) | string | Тип уведомления |
ids * (path) | array | Идентификаторы уведомлений |
status * (query) | string | Статус уведомления |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | StubNotificationResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение вложения уведомления
Возвращает вложения уведомления.
Запрос
Swagger
GET
/v1/type/{type}/id/{id}/attachmentsПараметры
| Параметр | Тип | Описание |
|---|---|---|
type * (path) | string | Тип уведомления |
id * (path) | string | Идентификатор уведомления |
attachmentIds (query) | array | Идентификаторы вложений уведомлений |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | |
attachmentId | string | uuid | |
filename | string | ||
data | string[] |
Получение списка уведомлений по их типу
Возвращает список уведомлений по их типу.
Запрос
Swagger
GET
/v1/type/{type}Параметры
| Параметр | Тип | Описание |
|---|---|---|
type * (path) | string | Тип уведомления |
status (query) | string | Статус уведомления |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | StubNotificationResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение уведомлений по incoming id и типу
Возвращает уведомления по incoming id и типу.
Запрос
Swagger
GET
/v1/systems/{systemId}/type/{type}/incomingId/{incomingId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
type * (path) | string | Тип уведомления |
incomingId * (path) | string | Внутренний идентификатор уведомления |
status (query) | string | Статус уведомления |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | StubNotificationResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение уведомлений по external ids и типу
Возвращает уведомления по external id и типу.
Запрос
Swagger
GET
/v1/systems/{systemId}/type/{type}/externalIds/{externalIds}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
type * (path) | string | Тип уведомления |
externalIds * (path) | array | Внутренний идентификатор уведомления |
status (query) | string | Статус уведомления |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | StubNotificationResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Модели
StubNotificationResponseDto
PageResponseStubNotificationDto
ResponseError
StubAttachmentDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки