createAppLevelUserPreferences

Create a new APP-Level user preference for an authenticated users.

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

Request

POST /rest/user/preferences/app

Headers

Header	Required	Description
x-nextinteract-authtoken	Yes	Auth token returned from loginUser

Parameters

Parameter	Type	Required	Description
key	String(7)	Yes	Key for the app-level user preference. See keys above.
values	Array of Strings (max length 100)	Yes	The values to be set for the given app-level user preference. At least one required.

SAMPLE REQUEST:

{
    "key" : "APV-ORD",
    "values" : [
        "1,2,3,4"
    ]
}

Response

200 OK

Returns the newly created user preferences with valueIds that can be used for updates/deletes.

RESPONSE:

{
    "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

Exception	Description
WSInvalidParameterException	See Error Definitions
WSInvalidAuthTokenException	See Error Definitions
WSCacheServiceException	See Error Definitions
WSUserPreferenceServiceException	See Error Definitions
WSBrochureNotFoundException	See Error Definitions
WSInsufficientPrivilegesException	See Error Definitions
WSAuthorisationServiceException	See Error Definitions
WSAlreadyExistsException	See Error Definitions