editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Get the preference previous registered for the user. This can be set using the setUserPreferences. This method only can be accessed by logg..."
{{Api_Method_Spec|
Description=Get the preference previous registered for the user. This can be set using the [[setUserPreferences]].
This method only can be accessed by logged user.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=name
|ParamType=String
|ParamRequired=required
|ParamDescription=The name of the property that wants to get.
}}
|Returns=
Returns a JSON object containing a value of the preference.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</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>"
: }
}
|Exceptions=
* [[AuthenticationRequiredException]]
* [[UserPreferenceNotRegisteredException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=Get the preference previous registered for the user. This can be set using the [[setUserPreferences]].
This method only can be accessed by logged user.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=name
|ParamType=String
|ParamRequired=required
|ParamDescription=The name of the property that wants to get.
}}
|Returns=
Returns a JSON object containing a value of the preference.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</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>"
: }
}
|Exceptions=
* [[AuthenticationRequiredException]]
* [[UserPreferenceNotRegisteredException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
