Управление подписками на широковещательные рассылки
Получение списка широковещательных рассылок
Возвращает список всех широковещательных рассылок для клиента.
Запрос
Swagger
GET
/rn/{resourceName}/broadcastПараметры
Параметр | Тип | Описание |
---|---|---|
clientId * (query) | string | |
resourceName * (path) | string | Сокращенное имя ресурса уровня проекта |
* - обязательный параметр
Ответ
Массив значений вида:
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Подписка на широковещательную рассылку
Запрос на подписку на широковещательную рассылку.
Запрос
Swagger
POST
/rn/{resourceName}/broadcastПараметры
Параметр | Тип | Описание |
---|---|---|
resourceName * (path) | string | Сокращенное имя ресурса уровня проекта |
* - обязательный параметр
Тело запроса
Параметр | Тип | Описание |
---|---|---|
alias | string | |
broadcast | BIRTH_INFORMATION | DIVORCE_INFORMATION | FATAL_INFORMATION | MARRIAGE_INFORMATION | RENAME_INFORMATION | PATERNITY_INFORMATION | RESIDENCE_PERMIT_INFORMATION | RESIDENCE_PERMIT_TERMINATE_INFORMATION | TEMP_RESIDENCE_TERMINATE_INFORMATION | BIRTH_INFORMATION | DIVORCE_INFORMATION | FATAL_INFORMATION | MARRIAGE_INFORMATION | RENAME_INFORMATION | PATERNITY_INFORMATION | RESIDENCE_PERMIT_INFORMATION | RESIDENCE_PERMIT_TERMINATE_INFORMATION | TEMP_RESIDENCE_TERMINATE_INFORMATION |
Ответ
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Получение списка всех широковещательных рассылок для клиента
Запрос на получение списка широковещательных рассылок.
Запрос
Swagger
GET
/broadcastПараметры
Параметр | Тип | Описание |
---|---|---|
clientId * (query) | string |
* - обязательный параметр
Ответ
Массив значений вида:
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Подписка на широковещательную рассылку
Запрос на подписку на широковещательную рассылку.
Запрос
Swagger
POST
/broadcastТело запроса
Параметр | Тип | Описание |
---|---|---|
alias | string | |
broadcast | BIRTH_INFORMATION | DIVORCE_INFORMATION | FATAL_INFORMATION | MARRIAGE_INFORMATION | RENAME_INFORMATION | PATERNITY_INFORMATION | RESIDENCE_PERMIT_INFORMATION | RESIDENCE_PERMIT_TERMINATE_INFORMATION | TEMP_RESIDENCE_TERMINATE_INFORMATION | BIRTH_INFORMATION | DIVORCE_INFORMATION | FATAL_INFORMATION | MARRIAGE_INFORMATION | RENAME_INFORMATION | PATERNITY_INFORMATION | RESIDENCE_PERMIT_INFORMATION | RESIDENCE_PERMIT_TERMINATE_INFORMATION | TEMP_RESIDENCE_TERMINATE_INFORMATION |
Ответ
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Отписка от широковещательной рассылки
Запрос на отписку от широковещательной рассылки по id подписки.
Запрос
Swagger
DELETE
/rn/{resourceName}/broadcast/{id}Параметры
Параметр | Тип | Описание |
---|---|---|
id * (path) | string | Id подписки |
resourceName * (path) | string | Сокращенное имя ресурса уровня проекта |
* - обязательный параметр
Ответ
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Отписка от всех широковещательных рассылок
Запрос на отписку от всех широковещательных рассылок.
Запрос
Swagger
DELETE
/rn/{resourceName}/broadcast/allПараметры
Параметр | Тип | Описание |
---|---|---|
clientId * (query) | string | |
resourceName * (path) | string | Сокращенное имя ресурса уровня проекта |
* - обязательный параметр
Ответ
Массив значений вида:
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Отписка от широковещательной рассылки
Запрос на отписку от широковещательной рассылки по id подписки.
Запрос
Swagger
DELETE
/broadcast/{id}Параметры
Параметр | Тип | Описание |
---|---|---|
id * (path) | string | Id подписки |
* - обязательный параметр
Ответ
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Отписка от всех широковещательных рассылок
Запрос на отписку от всех широковещательных рассылок.
Запрос
Swagger
DELETE
/broadcast/allПараметры
Параметр | Тип | Описание |
---|---|---|
clientId * (query) | string |
* - обязательный параметр
Ответ
Массив значений вида:
Параметр | Тип | Формат | Описание |
---|---|---|---|
dataProviderId | string | ||
namespace | string | ||
rootElement | string | ||
registrationDate | string | date-time | |
schemaVersion | V1_2 | V1_3 | ||
clientId | string | ||
routing | FIXED | TABLE | BROADCAST | FIXED | TABLE | BROADCAST | ||
nameSved | string |
Модели
SmevDataProvider
RequestRejected
SmevFault
SmevFaultInfo
SmevSendingRequestStatus
SMEVErrorResult
BroadcastSubscribeDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
СМЭВ
Отправка тестовых запросов в СМЭВ с присвоением успешно отправленным запросам уникальных идентификаторов