Сервис пользовательских настроек

Сервис пользовательских настроек предназначен для хранения настроек пользователей.
Сервис пользовательских настроек используется сервисами бизнес-логики, а также другими сервисами, в том числе и внешним интерфейсом.
Настройки хранятся в формате ключ-значение. Настройки могут храниться и после выхода пользователя из системы при установке времени хранения. Для доступа к настройкам конкретного польователя используется его идентификация по токену.

Модель данных сервиса

Параметр	Формат параметра	Значение параметра
Key	string	Ключ настройки
UserId	guid	Уникальный идентификатор пользователя
GroupKey	string	Ключ/имя для группировки параметров
Value	string	Значение
Validity	DateTime	Дата актуальности данных (после данные считаются устаревшими и не валидны)
ValueType	UserSettingValueType	Тип данных настройки. Может принимать значения от 0 до 4, где 0 – любое значение, 1 – string, 2 – number, 3 – bool, 4 – datetime
ModifyDate	DateTime	Дата изменения настройки

Методы сервиса

Пользователь может использовать методы API, отправляя запросы с требуемыми параметрами, например, для получения настроек пользователя

Метод получения значения настроек пользователя

Метод получения значения настроек пользователя по ключу POST /UserSetting/Get

Запрос

{
  "key": "string"
}

Ответ:

{
  "error": {
    "id": "string",
    "code": "string",
    "type": "string",
    "isError": true,
    "extra": "string",
    "message": "string"
  },
  "typeInfo": {
    "name": "string"
  },
  "result": {
    "key": "string",
    "value": "string"
  }
}

или для изменения настроек пользователя.
Метод работает в конкурентной среде и позволяет изменять и добавлять настройки пользователя. Если настройки для пользователя уже есть, сервис обновляет настройки, если настроек пользователя еще нет, сервис создает и назначает значение, переданное параметром. Результирующими значениями настроек будут пришедшие (сохраненные сервисом) последними.

Метод Добавления/Изменения значения настроек пользователя

Метод Добавления/Изменения значения настроек пользователя POST /UserSetting/Set

Запрос

{
  "value": "string",
  "valueType": 0,
  "validity": "2020-07-24T11:33:53.283Z",
  "key": "string",
  "group": "string",
  "userId": guid
}

Ответ:

{
 {
  "error": {
    "id": "string",
    "code": "string",
    "type": "string",
    "isError": true,
    "extra": "string",
    "message": "string"
  },
  "typeInfo": {
    "name": "string"
  },
  "result": {
    "operation": "string",
    "currentStatus": "string"
  }
}