Web API: Usersettings: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The ''' | The '''usersettings''' operation saves user specific settings to server. The PUT version is used to store an individual setting and the POST version to store multiple settings. | ||
HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session. | HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session. | ||
== PUT /api/usersettings/{key}/{value} == | == PUT /api/usersettings/{key}/{value} == | ||
Stores individual setting to the server. | Stores individual setting to the server. | ||
<pre> | <pre> | ||
Url: PUT /api/usersettings/{key}/{value} | Url: PUT /api/usersettings/{key}/{value} | ||
| Line 15: | Line 15: | ||
== POST /api/usersettings/ == | == POST /api/usersettings/ == | ||
Stores multiple settings to the server. Settings that are not mentioned, are not removed. | |||
<pre> | <pre> | ||
Url: POST /api/usersettings/ | Url: POST /api/usersettings/ | ||
Revision as of 14:12, 20 September 2021
The usersettings operation saves user specific settings to server. The PUT version is used to store an individual setting and the POST version to store multiple settings.
HTTP request header Authorization with value Bearer <access token> needs to be in place to identify the session.
PUT /api/usersettings/{key}/{value}
Stores individual setting to the server.
Url: PUT /api/usersettings/{key}/{value}
The key is the setting name and value is the setting value.
Returns HTTP code 204 (No content).
POST /api/usersettings/
Stores multiple settings to the server. Settings that are not mentioned, are not removed.
Url: POST /api/usersettings/
The request body contains an object that has properties for all the stored settings.
Returns HTTP code 204 (No content).