Управление группами пользователей
Получение группы пользователей по идентификатору группы
Возвращает информацию о группе пользователей по ее идентификатору.
Запрос
Swagger
GET
/v2/groups/{groupId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
groupId * (path) | string | Идентификатор группы пользователей |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
groupId | string | uuid | Идентификатор группы пользователей |
name | string | Наименование группы | |
description | string | Описание группы | |
creationDate | string | date-time | Дата создания группы |
lastUpdateDate | string | date-time | Дата последнего редактирования информации о группе |
Перезапись группы пользователей
Перезаписывает группу пользователей.
Запрос
Swagger
PUT
/v2/groups/{groupId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
groupId * (path) | string |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Наименование группы пользователей |
description | string | Описание группы пользователей |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
groupId | string | uuid | Идентификатор группы пользователей |
name | string | Наименование группы | |
description | string | Описание группы | |
creationDate | string | date-time | Дата создания группы |
lastUpdateDate | string | date-time | Дата последнего редактирования информации о группе |
Получение всех групп по идентификатору или названию группы
Возвращает список групп по идентификатору или названию группы.
Запрос
Swagger
GET
/v2/groupsПараметры
| Параметр | Тип | Описание |
|---|---|---|
name (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 | GroupResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание группы пользователей
Создает группу пользователей.
Запрос
Swagger
POST
/v2/groupsТело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
name | string | Наименование группы пользователей | |
description | string | Описание группы пользователей | |
groupId | string | uuid | Идентификатор группы пользователей |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
groupId | string | uuid | Идентификатор группы пользователей |
name | string | Наименование группы | |
description | string | Описание группы | |
creationDate | string | date-time | Дата создания группы |
lastUpdateDate | string | date-time | Дата последнего редактирования информации о группе |
Удаление группы пользователей
Удаляет группу пользователей.
Запрос
Swagger
DELETE
/v2/groupsОтвет
string
Добавление пользователей в группу
Добавляет пользователей в группу.
Запрос
Swagger
POST
/v2/groups/{groupId}/usersПараметры
| Параметр | Тип | Описание |
|---|---|---|
groupId * (path) | string | Идентификатор группы пользователей |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
userId | string | uuid | Идентификатор пользователя |
profileId | string | Идентификатор профиля пользователя |
Удаление пользователей из группы
Удаляет пользователей из группы.
Запрос
Swagger
DELETE
/v2/groups/{groupId}/usersПараметры
| Параметр | Тип | Описание |
|---|---|---|
groupId * (path) | string | Идентификатор группы пользователей |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
userId | string | uuid | Идентификатор пользователя |
profileId | string | Идентификатор профиля пользователя |
Отмена удаления групп пользователей
Отменяет удаление групп пользователей.
Запрос
Swagger
POST
/v2/groups/cancel-deletionОтвет
string
Получение информации о составе группы по идентификатору группы
Возвращает информацию о составе группы по идентификатору группы.
Запрос
Swagger
GET
/v2/groups/{groupId}/infoПараметры
| Параметр | Тип | Описание |
|---|---|---|
groupId * (path) | string | Идентификатор группы пользователей |
name (query) | string | |
userId (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 | GroupParticipantInfoDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение групп пользователя по идентификатору пользователя
Возвращает группы пользователя по идентификатору пользователя.
Запрос
Swagger
GET
/v2/groups/user/{userId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
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 | GroupResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Модели
GroupResponseDto
ResponseError
GroupUpdateRequestDto
PageResponseGroupResponseDto
GroupRequestDto
ParticipantRequestDto
GroupParticipantInfoDto
PageResponseGroupParticipantInfoDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки