user-controller Endpoints
Endpoints of the Web-API gateway for user settings management, accessible for any authenticated user.
The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. They internally call the USERSERVICE.
| HTTP Method as of product version | Purpose | Response Format | Description |
|---|---|---|---|
| GET as of 2020 Autumn, deprecateted as of 2023 Spring | getUserInfo | JSON | Retrieves user-specific data for the user specified by |
| GET as of 2020 Autumn | getResultListConfiguration | JSON | Returns a result list configuration by type. |
| POST as of 2020 Autumn | saveResultListConfiguration | HTTP status code | Saves a result list configuration for the user by type. |
GET | getGlobalSettings | JSON | This request retrieves the global settings with the section name. |
| POST as of 2020 Autumn, deprecateted as of 2021 Winter | saveGlobalSettings | HTTP status code | Saves a global settings by a section. |
| GET as of 2020 Autumn | getGeneralSettings | JSON | This request retrieves the general settings of the requested user. |
| POST as of 2020 Autumn | saveGeneralSettings | HTTP status code | Saves a general settings for the user. |
| GET as of 2020 Autumn | getSettings | JSON | This request retrieves the settings of the requested user in user matching the section name. |
| POST as of 2020 Autumn | saveSettings | HTTP status code | Saves a settings for the user by a section. |
| GET as of 2020 Autumn, deprecateted as of 2023 Spring | getUsers | JSON | Retrieves a list of all users. The result list can be filtered by applying conditions that have to be matched. |
| GET as of 2020 Autumn, deprecateted as of 2023 Spring | whoAmI | JSON | This request retrieves the user information of the current logged in user. |