Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

Endpoints of the Web-API gateway for user settings management, accessible for any authenticated user.


>> >> API-WEB Service

The endpoints are used by the CLIENT Service that provides yuuvis® client as reference implementation. They internally call the the USERSERVICE.

HTTP Method
as of product version
PurposeResponse FormatDescription
GET
as of 2020 Autumn,
getUserInfo - retrieves the user information by userId
deprecateted as of 2023 SpringgetUserInfoJSON

Insert excerpt
GET /api-web/api/users/{userId}
GET /api-web/api/users/{userId}
nopaneltrue

/api-web/api/users/{userId}

GET
as of 2020 Autumn
getResultListConfiguration
- retrieves result list configuration
JSON

Insert excerpt
GET /api-web/api/users/config/result/{type}
GET /api-web/api/users/config/result/{type}
nopaneltrue

/api-web/api/users/config/result/{type}

POST
as of 2020 Autumn
saveResultListConfiguration
- saves a result list configuration for a user
HTTP status code

Insert excerpt
POST /api-web/api/users/config/result/{type}
POST /api-web/api/users/config/result/{type}
nopaneltrue

/api-web/api/users/config/result/{type}

GET
as of 2020 Autumn,

getGlobalSettings - retrieves the global settings by section name

deprecateted as of 2021 Winter

getGlobalSettingsJSON

Insert excerpt
GET /api-web/api/users/globalsettings/{section}
GET /api-web/api/users/globalsettings/{section}
nopaneltrue

/api-web/api/users/globalsettings/{section}

POST
as of 2020 Autumn,
deprecateted as of 2021 Winter
saveGlobalSettings
- saves global setting for a section
HTTP status code

Insert excerpt
POST /api-web/api/users/globalsettings/{section}
POST /api-web/api/users/globalsettings/{section}
nopaneltrue

/api-web/api/users/globalsettings/{section}

GET
as of 2020 Autumn
getGeneralSettings
- retrieves the general settings of the user
JSON

Insert excerpt
GET /api-web/api/users/settings
GET /api-web/api/users/settings
nopaneltrue

/api-web/api/users/settings

POST
as of 2020 Autumn
saveGeneralSettings
- saves the general setting for the user
HTTP status code

Insert excerpt
POST /api-web/api/users/settings
POST /api-web/api/users/settings
nopaneltrue

/api-web/api/users/settings

GET
as of 2020 Autumn
getSettings
- retrieves the settings of requested user
JSON

Insert excerpt
GET /api-web/api/users/settings/{section}
GET /api-web/api/users/settings/{section}
nopaneltrue

/api-web/api/users/settings/{section}

POST
as of 2020 Autumn
saveSettings
- saves user setting by section
HTTP status code

Insert excerpt
POST /api-web/api/users/settings/{section}
POST /api-web/api/users/settings/{section}
nopaneltrue

/api-web/api/users/settings/{section}

GET
as of 2020 Autumn,
deprecateted as of 2023 Spring
getUsers
- retrieves user matching the search string
JSON

Insert excerpt
GET /api-web/api/users/users
GET /api-web/api/users/users
nopaneltrue

/api-web/api/users/users

GET
as of 2020 Autumn,
deprecateted as of 2023 Spring
whoAmI
- retrieves current user's info
JSON

Insert excerpt
GET /api-web/api/users/whoami
GET /api-web/api/users/whoami
nopaneltrue

/api-web/api/users/whoami