Skip to content

getAppLevelUserPreferences ​

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

Supported keys for V1 are: APP-FAV - Favourite APP-ORD - Connection Order APP-SHS - Search History

Request ​

http
GET /rest/user/preferences/app

Headers ​

HeaderRequiredDescription
x-nextinteract-authtokenYesAuth token returned from loginUser

Parameters ​

key (string[7], optional) - allows filtering of user preferences by key. See keys above.

Response ​

200 OK ​

Sample call: Sample call : http://localhost:8080/nextinteract-webapp/rest/user/preferences/app?key=APP-FAV

RESPONSE:

json
[
    {
        "uPrefId": 29,
        "type": "APP",
        "key": "APP-FAV",
        "values": [
            {
                "uPrefValueId": 31,
                "value": "1",
                "lastModified": 1567662973000
            },
            {
                "uPrefValueId": 29,
                "value": "2",
                "lastModified": 1567662973000
            },
            {
                "uPrefValueId": 30,
                "value": "3",
                "lastModified": 1567662973000
            },
            {
                "uPrefValueId": 32,
                "value": "4",
                "lastModified": 1567662973000
            }
        ]
    }
]

Errors ​

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