Skip to content

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 ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

ParameterTypeRequiredDescription
uPrefIdNumberYesPath variable. The unique id of the user preferences to update. This is the id created during createXYZ API calls.
uPrefValueIdNumberYesPath variable. The unique id of the user preferences 'value' to update. This is the id created during createXYZ API calls.
valueString (max 100 length)YesThe 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 ​

ExceptionDescription
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSRecordNotFoundExceptionSee Error Definitions
WSUserPreferenceServiceExceptionSee Error Definitions