API для работы с настройками пользователя

/api/UsersSettings/Set

Добавить пользовательскую настройку

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Пользовательская настройка

Название поля	Тип поля	Обязательное
value	string	нет
valueType	integer (int32)	нет
validity	string (date-time)	нет
key	string	нет
group	string	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
error	Error
typeInfo	TypeInfo
result	Status

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController Set(ASE.MD.Platform.Services.UsersSettingsService.Contracts.DataRequest)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:write

/components/securitySchemes/userssettingsservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:read, userssettingsservice:userssettings:write

/api/UsersSettings/GetGroup

Получить пользовательские настройки определённой группы

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Название группы настроек

Название поля	Тип поля	Описание	Обязательное	Возможные значения
group	string		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
error	Error
typeInfo	TypeInfo
result	Group

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController GetGroup(ASE.MD.Platform.Services.UsersSettingsService.Contracts.GetRequest)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:read

/components/securitySchemes/userssettingsservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:read, userssettingsservice:userssettings:write

/api/UsersSettings/Get

Получить пользовательскую настройку по ключу

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Ключ настройки

Название поля	Тип поля	Описание	Обязательное	Возможные значения
key	string		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
error	Error
typeInfo	TypeInfo
result	SettingsItem

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController Get(ASE.MD.Platform.Services.UsersSettingsService.Contracts.Request)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:read

/components/securitySchemes/userssettingsservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:read, userssettingsservice:userssettings:write

/api/UsersSettings/Delete

Удалить пользовательскую настройку

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Ключ настройки

Название поля	Тип поля	Описание	Обязательное	Возможные значения
key	string		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
error	Error
typeInfo	TypeInfo
result	Status

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController Delete(ASE.MD.Platform.Services.UsersSettingsService.Contracts.Request)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:write

/components/securitySchemes/userssettingsservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:read, userssettingsservice:userssettings:write

/api/UsersSettings/DeleteUserSettings

Удалить все пользовательские настройки конкретного пользователя

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Название поля	Тип поля	Описание	Обязательное	Возможные значения
userId	string		нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поля	Тип поля	Описание	Обязательное	Возможные значения
error	Error
typeInfo	TypeInfo
result	Response

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController DeleteUserSettings(ASE.MD.Platform.Services.UsersSettingsService.Contracts.UserRequest)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:write

/components/securitySchemes/userssettingsservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	userssettingsservice:userssettings:read, userssettingsservice:userssettings:write

/api/UsersSettings/Set​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/userssettingsservice public UsersSettingsController Set(ASE.MD.Platform.Services.UsersSettingsService.Contracts.DataRequest)​

/components/securitySchemes/userssettingsservice​

/api/UsersSettings/GetGroup​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/userssettingsservice public UsersSettingsController GetGroup(ASE.MD.Platform.Services.UsersSettingsService.Contracts.GetRequest)​

/components/securitySchemes/userssettingsservice​

/api/UsersSettings/Get​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/userssettingsservice public UsersSettingsController Get(ASE.MD.Platform.Services.UsersSettingsService.Contracts.Request)​

/components/securitySchemes/userssettingsservice​

/api/UsersSettings/Delete​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/userssettingsservice public UsersSettingsController Delete(ASE.MD.Platform.Services.UsersSettingsService.Contracts.Request)​

/components/securitySchemes/userssettingsservice​

/api/UsersSettings/DeleteUserSettings​

Отсылаемый запрос​

Возвращаемые результаты​

Код HTTP ответа: 200​

Код HTTP ответа: 401​

Код HTTP ответа: 403​

Схемы авторизации​

/components/securitySchemes/userssettingsservice public UsersSettingsController DeleteUserSettings(ASE.MD.Platform.Services.UsersSettingsService.Contracts.UserRequest)​

/components/securitySchemes/userssettingsservice​

/api/UsersSettings/Set

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController Set(ASE.MD.Platform.Services.UsersSettingsService.Contracts.DataRequest)

/components/securitySchemes/userssettingsservice

/api/UsersSettings/GetGroup

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController GetGroup(ASE.MD.Platform.Services.UsersSettingsService.Contracts.GetRequest)

/components/securitySchemes/userssettingsservice

/api/UsersSettings/Get

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController Get(ASE.MD.Platform.Services.UsersSettingsService.Contracts.Request)

/components/securitySchemes/userssettingsservice

/api/UsersSettings/Delete

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController Delete(ASE.MD.Platform.Services.UsersSettingsService.Contracts.Request)

/components/securitySchemes/userssettingsservice

/api/UsersSettings/DeleteUserSettings

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

Код HTTP ответа: 401

Код HTTP ответа: 403

Схемы авторизации

/components/securitySchemes/userssettingsservice public UsersSettingsController DeleteUserSettings(ASE.MD.Platform.Services.UsersSettingsService.Contracts.UserRequest)

/components/securitySchemes/userssettingsservice