Difference between revisions of "GetUserPreference"

From Gvp-public
Jump to navigation Jump to search
 
Line 30: Line 30:
 
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
 
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
 
:    <span style="color: #a11;">"Content"</span>: "<span style="color: #219;">Value</span>"
 
:    <span style="color: #a11;">"Content"</span>: "<span style="color: #219;">Value</span>"
:    }
 
 
}
 
}
  

Latest revision as of 19:08, 18 September 2014

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


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


See also