Appearance
deleteUserPreferenceValue ​
Deletes a single user preference value
Intended usage is when a user preference has multiple values of "A", "B", "C", "D". but user only wants to deletea single value "A"
Request ​
http
DELETE /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 delete. 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. |
SAMPLE REQUEST: http://localhost:8080/rest/user/preferences/29/value/1
Response ​
200 OK ​
RESPONSE:
json
{
"errorCode" : 0,
"errorMsg" : "OK"
}Errors ​
| Exception | Description |
|---|---|
WSInvalidAuthTokenException | See Error Definitions |
WSCacheServiceException | See Error Definitions |
WSInvalidParameterException | See Error Definitions |
WSUserPreferenceServiceException | See Error Definitions |