GetUserPreference

Description

Get the preference previous registered for the user. This can be set using the setUserPreference.

This method only can be accessed by logged user.

Parameters

• token (String, required)

A valid token for identifying the API session context. The token can be anonymous or logged.

• name (String, required)

The name of the property that wants to get.

Returns

Returns a JSON object containing a value of the preference.

Example:

{

"StatusCode": 0,

"Severity": 1,

"StatusMessage": "OK",

"Content": "Value"

}

Exceptions

• AuthenticationRequiredException
• UserPreferenceNotRegisteredException

Caching

This method is not cached.

Known issues

• None

Version history

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral