Управление профилями пользователя, к профилям закрепляются настройки
Получение профиля
Возвращает профиль пользователя.
Запрос
Swagger
GET
/v2/user/{userId}/profile/{profileId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
profileId * (path) | string | Идентификатор профиля |
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
profileId | string | ||
rn | string | ||
userId | string | uuid | |
name | string | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time | |
isDefault | boolean | ||
source | DEFAULT | JWT | ||
notificationTypes | object | ||
enabled | boolean |
Перезапись профиля
Перезаписывает профиль.
Запрос
Swagger
PUT
/v2/user/{userId}/profile/{profileId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
profileId * (path) | string |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Название профиля |
isDefault | boolean | Установление профиля дефолтным |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
profileId | string | ||
rn | string | ||
userId | string | uuid | |
name | string | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time | |
isDefault | boolean | ||
source | DEFAULT | JWT | ||
notificationTypes | object | ||
enabled | boolean |
Удаление профиля
Удаляет профиль.
Запрос
Swagger
DELETE
/v2/user/{userId}/profile/{profileId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
profileId * (path) | string | Идентификатор профиля |
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
string
Получение профилей пользователя
Возвращает профили пользователя.
Запрос
Swagger
GET
/v2/user/{userId}/profileПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | 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 | ProfileWithNotificationTypesDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание профиля
Создает профиль.
Запрос
Swagger
POST
/v2/user/{userId}/profileПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
profileId | string | Идентификатор из мастер-системы |
name | string | Название профиля |
isDefault | boolean | Установление профиля дефолтным |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
profileId | string | ||
rn | string | ||
userId | string | uuid | |
name | string | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time | |
isDefault | boolean | ||
source | DEFAULT | JWT | ||
notificationTypes | object | ||
enabled | boolean |
Отмена удаления профиля
Отменяет удаление профиля.
Запрос
Swagger
POST
/v2/user/{userId}/profile/{profileId}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
profileId * (path) | string | Идентификатор профиля |
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
string
Получение списка профилей
Возвращает список профилей.
Запрос
Swagger
GET
/v2/profileПараметры
| Параметр | Тип | Описание |
|---|---|---|
profileName.contains (query) | string | |
userId.contains (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 | ProfileWithNotificationTypesDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Модели
ProfileWithNotificationTypesDto
ResponseError
ProfilePutRequestDto
PageResponseProfileWithNotificationTypesDto
ProfilePostRequest
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки