Управление пользовательскими параметрами
Редактирование пользовательских данных
Изменяет пользовательские данные.
Запрос
Swagger
PUT
/v2/user/{userId}/user-params/data/{id}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
id * (path) | string | Идентификатор записи |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
profileId | string | Идентификатор профиля пользоваля |
value | string | Значение пользовательского параметра |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор записи |
profileId | string | Идентификатор профиля пользоваля | |
profileName | string | Наименование профиля пользоваля | |
paramName | string | Наименование параметра | |
type | TEXT | INTEGER | DOUBLE | BOOLEAN | DATE | DATE_AND_TIME | RF_PASSPORT_SERIES | RF_PASSPORT_NUMBER | FR_PASSPORT_SERIES | FR_PASSPORT_NUMBER | FR_CITIZEN_PASSPORT | INN | SNILS | PHONE_NUMBER | EMAIL | MONEY | Тип данных | |
paramId | string | uuid | Идентификатор параметра шаблона |
value | string | Значение параметра шаблона для пользователя | |
creationDate | string | date-time | Дата создания пользовательского параметра шаблона |
lastUpdateDate | string | date-time | Дата последнего обновления пользовательского параметра шаблона |
Удаление одной записи пользовательских данных
Удаляет одну запись пользовательских данных.
Запрос
Swagger
DELETE
/v2/user/{userId}/user-params/data/{id}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
id * (path) | string | Идентификатор записи |
* - обязательный параметр
Ответ
string
Получение пользовательского параметра по идентификатору
Возвращает пользовательский параметр по идентификатору.
Запрос
Swagger
GET
/v2/user-params/{paramId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
paramId * (path) | string | Идентификатор параметра |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
paramId | string | uuid | Идентификатор параметра шаблона |
paramName | string | Наименование параметра шаблона | |
description | string | Описание параметра шаблона | |
dataType | TEXT | INTEGER | DOUBLE | BOOLEAN | DATE | DATE_AND_TIME | RF_PASSPORT_SERIES | RF_PASSPORT_NUMBER | FR_PASSPORT_SERIES | FR_PASSPORT_NUMBER | FR_CITIZEN_PASSPORT | INN | SNILS | PHONE_NUMBER | EMAIL | MONEY | Тип данных | |
creationDate | string | date-time | Дата создания параметра шаблона |
lastUpdateDate | string | date-time | Дата последнего обновления параметра шаблона |
Перезапись пользовательского параметра
Перезаписывает пользовательский параметр.
Запрос
Swagger
PUT
/v2/user-params/{paramId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
paramId * (path) | string | Идентификатор параметра |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
paramName | string | Наименование пользовательского параметра шаблонов |
paramDescription | string | Описание пользовательского параметра шаблонов |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
paramId | string | uuid | Идентификатор параметра шаблона |
paramName | string | Наименование параметра шаблона | |
description | string | Описание параметра шаблона | |
dataType | TEXT | INTEGER | DOUBLE | BOOLEAN | DATE | DATE_AND_TIME | RF_PASSPORT_SERIES | RF_PASSPORT_NUMBER | FR_PASSPORT_SERIES | FR_PASSPORT_NUMBER | FR_CITIZEN_PASSPORT | INN | SNILS | PHONE_NUMBER | EMAIL | MONEY | Тип данных | |
creationDate | string | date-time | Дата создания параметра шаблона |
lastUpdateDate | string | date-time | Дата последнего обновления параметра шаблона |
Удаление пользовательского параметра по идентификатору
Удаляет пользовательский параметр по идентификатору.
Запрос
Swagger
DELETE
/v2/user-params/{paramId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
paramId * (path) | string | Идентификатор параметра |
* - обязательный параметр
Ответ
string
Получение пользовательских данных по id (и профилю)
Возвращает пользовательские данные по id (и профилю).
Запрос
Swagger
GET
/v2/user/{userId}/user-params/dataПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
profileId (query) | string | Идентификатор профиля |
profileName (query) | string | |
paramValue (query) | string | |
paramName (query) | string | |
paramType (query) | string | |
paramId (query) | string | |
creationDate (query) | string | |
lastUpdateDate (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 | UserParamValueResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Добавление пользовательских данных
Добавляет пользовательские данные.
Запрос
Swagger
POST
/v2/user/{userId}/user-params/dataПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
profileId | string | Идентификатор профиля пользоваля |
paramName | string | Наименование пользовательского параметра |
value | string | Значение пользовательского параметра |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор записи |
profileId | string | Идентификатор профиля пользоваля | |
profileName | string | Наименование профиля пользоваля | |
paramName | string | Наименование параметра | |
type | TEXT | INTEGER | DOUBLE | BOOLEAN | DATE | DATE_AND_TIME | RF_PASSPORT_SERIES | RF_PASSPORT_NUMBER | FR_PASSPORT_SERIES | FR_PASSPORT_NUMBER | FR_CITIZEN_PASSPORT | INN | SNILS | PHONE_NUMBER | EMAIL | MONEY | Тип данных | |
paramId | string | uuid | Идентификатор параметра шаблона |
value | string | Значение параметра шаблона для пользователя | |
creationDate | string | date-time | Дата создания пользовательского параметра шаблона |
lastUpdateDate | string | date-time | Дата последнего обновления пользовательского параметра шаблона |
Удаление нескольких записей пользовательских данных
Удаляет несколько записей пользовательских данных.
Запрос
Swagger
DELETE
/v2/user/{userId}/user-params/dataПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
string
Отмена удаления пользовательских данных
Отменяет удаление пользовательских данных.
Запрос
Swagger
POST
/v2/user/{userId}/user-params/data/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Ответ
string
Получение всех пользовательских параметров по rn (имени параметра, типам данных)
Возвращает список всех пользовательских параметров по rn (имени параметра, типам данных).
Запрос
Swagger
GET
/v2/user-paramsПараметры
| Параметр | Тип | Описание |
|---|---|---|
name (query) | string | Имя параметра |
types (query) | array | Типы данных |
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 | UserParamResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание пользовательского параметра
Создает пользовательский параметр.
Запрос
Swagger
POST
/v2/user-paramsТело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
paramId | string | uuid | Идентификатор пользовательского параметра шаблонов |
paramName | string | Наименование пользовательского параметра шаблонов | |
paramDescription | string | Описание пользовательского параметра шаблонов | |
type | string | Тип параметра шаблона |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
paramId | string | uuid | Идентификатор параметра шаблона |
paramName | string | Наименование параметра шаблона | |
description | string | Описание параметра шаблона | |
dataType | TEXT | INTEGER | DOUBLE | BOOLEAN | DATE | DATE_AND_TIME | RF_PASSPORT_SERIES | RF_PASSPORT_NUMBER | FR_PASSPORT_SERIES | FR_PASSPORT_NUMBER | FR_CITIZEN_PASSPORT | INN | SNILS | PHONE_NUMBER | EMAIL | MONEY | Тип данных | |
creationDate | string | date-time | Дата создания параметра шаблона |
lastUpdateDate | string | date-time | Дата последнего обновления параметра шаблона |
Отмена удаления пользовательского параметра по идентификатору
Отменяет удаление пользовательского параметра по идентификатору.
Запрос
Swagger
POST
/v2/user-params/{paramId}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
paramId * (path) | string | Идентификатор параметра |
* - обязательный параметр
Ответ
string
Получение пользовательского параметра по названию
Возвращает пользовательский параметр по названию.
Запрос
Swagger
GET
/v2/user-params/name/{name}Параметры
| Параметр | Тип | Описание |
|---|---|---|
name * (path) | string | Имя параметра |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
paramId | string | uuid | Идентификатор параметра шаблона |
paramName | string | Наименование параметра шаблона | |
description | string | Описание параметра шаблона | |
dataType | TEXT | INTEGER | DOUBLE | BOOLEAN | DATE | DATE_AND_TIME | RF_PASSPORT_SERIES | RF_PASSPORT_NUMBER | FR_PASSPORT_SERIES | FR_PASSPORT_NUMBER | FR_CITIZEN_PASSPORT | INN | SNILS | PHONE_NUMBER | EMAIL | MONEY | Тип данных | |
creationDate | string | date-time | Дата создания параметра шаблона |
lastUpdateDate | string | date-time | Дата последнего обновления параметра шаблона |
Модели
UserParamValueUpdateRequestDto
UserParamValueResponseDto
ResponseError
UserParamResponseDto
UserParamUpdateRequestDto
PageResponseParamValueResponseDto
UserParamValueCreateRequestDto
PageResponseUserParamResponseDto
UserParamCreateRequestDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки