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
getUserInfoJSON

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
getResultListConfigurationJSON

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
saveResultListConfigurationHTTP 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,
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
saveGlobalSettingsHTTP 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
getGeneralSettingsJSON

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
saveGeneralSettingsHTTP 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
getSettingsJSON

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
saveSettingsHTTP 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
getUsersJSON

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
whoAmIJSON

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

/api-web/api/users/whoami

...