This API endpoint is used to save or get user settings for the users.
Supported HTTP methods: GET, PATCH, HEAD, OPTIONS
GET /api/v1/userSettings
Gets the saved settings in data base if not Backend should retrun default values with setting keys.
Parameters: none
Expected Payload: none.
Replied Payload: The list of stored and default settings as an array of UISettings data objects.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a JSON document. |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
PATCH /api/v1/userSettings
Save user setting in the Database.
Parameters: NONE
Expected Payload: The UISettings data object to store.
Replied Payload: The list of stored and default settings as an array of UISettings data objects.
Return Codes:
| Code | Description |
|---|---|
| 201 | OK, returns a JSON document with all user settings. |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |
DELETE /api/v1/userSettings/{id}
Deletes the user settings with the given id.
Parameters:
| Parameter | Description |
|---|---|
| id | The id of the settings to delete |
Expected Payload: none.
Replied Payload: none.
Return Codes:
| Code | Description |
|---|---|
| 202 | ACCEPTED, Return Object of UISettings. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
| 404 | No user setting with this username exists . In this case an ApiError document is returned, describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |
DELETE /api/v1/userSettings
Deletes the user settings with username. Username is take from token by the backend.
Parameters: none
Expected Payload: none.
Replied Payload: none.
Return Codes:
| Code | Description |
|---|---|
| 202 | ACCEPTED, Return list of UISettings array list. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
| 404 | No user setting with this username exists . In this case an ApiError document is returned, describing details of the error. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |