Appearance
updateUserPreferenceValue ​
Updates a single user preferences (APP-Level or ASSET-Level) given an authenticated user and existing user preference value id (uPrefValueId).
Request ​
http
PUT /rest/user/preferences/{uPrefId}/value/{uPrefValueId}Headers ​
| Header | Required | Description |
|---|---|---|
x-nextinteract-authtoken | Yes | Auth token returned from loginUser |
Parameters ​
| Parameter | Type | Required | Description |
|---|---|---|---|
uPrefId | Number | Yes | Path variable. The unique id of the user preferences to update. This is the id created during createXYZ API calls. |
uPrefValueId | Number | Yes | Path variable. The unique id of the user preferences 'value' to update. This is the id created during createXYZ API calls. |
value | String (max 100 length) | Yes | The value to be set for the given user preference. |
SAMPLE REQUEST: http://localhost:8080/nextinteract-webapp/rest/user/preferences/29/value/44
SAMPLE BODY:
json
{
"value" : "new value"
}Response ​
200 OK ​
Returns the updated record.
RESPONSE:
json
{
{
"uPrefValueId": 44,
"value": "new value",
"lastModified": 1567662973000
}
}Errors ​
| Exception | Description |
|---|---|
WSInvalidAuthTokenException | See Error Definitions |
WSCacheServiceException | See Error Definitions |
WSInvalidParameterException | See Error Definitions |
WSRecordNotFoundException | See Error Definitions |
WSUserPreferenceServiceException | See Error Definitions |