Skip to content

getAssetLevelUserPreferences ​

Returns all ASSET-Level User preferences for an authenticated user. Can filter by appropriate key type.

Supported keys for V1 are: ALP-ABM Audio Bookmark ALP-AFV Aggregated Favourite ALP-BKM Bookmark ALP-CAT Category ALP-COM Comment ALP-EUN Email Unsubscribe ("true" mean unsubscribed) ALP-FAV Favourite ALP-FIL Filter ALP-NUN Notification Unsubscribe ("true" mean unsubscribed) ALP-SHS Search History ALP-TFV Team Favourite ALP-TOP Topic ALP-VBM Video Bookmark ALP-POP Push Notification Opt in/Opt out ALP-EOP Email Notification Opt in/Opt out

Request ​

http
GET /rest/user/preferences/asset/{assetId}

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

ParameterTypeRequiredDescription
assetIdNumberYesThe asset id of the user preferences to retrieve.
keyString(7)YesKey for the asset-level user preference. See keys above.

Response ​

200 OK ​

Sample call : http://localhost:8080/nextinteract-webapp/rest/user/preferences/asset/3134?key=ALP-FAV

RESPONSE:

json
[
    {
        "uPrefId": 1,
        "type": "ALP",
        "key": "ALP-FAV",
        "values": [
            {
                "uPrefValueId": 23,
                "value": "ASSET FAVORITE",
                "lastModified": 1567662973000
            }
        ]
    }
]

Errors ​

ExceptionDescription
WSInvalidAuthTokenExceptionSee Error Definitions
WSCacheServiceExceptionSee Error Definitions
WSInvalidParameterExceptionSee Error Definitions
WSBrochureNotFoundExceptionSee Error Definitions
WSUserPreferenceServiceExceptionSee Error Definitions