Difference between revisions of "ManageUserInterests"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the AP...")
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=
+
Description=This method updates the user interest list. The new interests IDs array is sended to the server. If sent empty it unsuscribe from all interests.
  
 
|Parameters=
 
|Parameters=
Line 10: Line 10:
 
}}
 
}}
 
{{Api_Parameter|
 
{{Api_Parameter|
ParamName=instanceId
+
ParamName=interestsIds
|ParamType=int
+
|ParamType=array
|ParamRequired=required
+
|ParamRequired=optional
|ParamDescription=The id of the instance (OB) for the current environment. This ID might vary depending on the environment.
+
|ParamDescription=Current user interests list.
 
}}
 
}}
  
 
|Returns=
 
|Returns=
Returns a JSON object with the list of objects.
+
<span style="color: #a11;">TO BE COMPLETED</span>
 
 
'''Example:'''
 
{
 
  "StatusCode": 0,
 
  "Severity": 1,
 
  "StatusMessage": "OK",
 
  "Content": [
 
    {
 
      "ID": 12,
 
      "Description": "Int_3_0_10 d",
 
      "Name": "Int_3_0_10",
 
      "ResizableImages": [
 
        {
 
          "ID": 0,
 
          "Url": "",
 
          "Width": 0,
 
          "Height": 0,
 
          "Type": 0,
 
          "Ext": ""
 
        }
 
      ]
 
    }
 
    { ... }
 
}
 
  
  
Line 48: Line 24:
  
 
|Cache=
 
|Cache=
 
+
This method is not cached.
  
 
|KnownIssues=
 
|KnownIssues=
Line 57: Line 33:
  
 
|SeeAlso=
 
|SeeAlso=
 
+
* [[UNIAPI_Specification#Interest_Service| InterestService]] methods
 
}}
 
}}

Latest revision as of 12:03, 22 September 2015

Description

This method updates the user interest list. The new interests IDs array is sended to the server. If sent empty it unsuscribe from all interests.

Parameters

  • token (String, required)
A valid token for identifying the API session context and logged user.
  • interestsIds (array, optional)
Current user interests list.


Returns

TO BE COMPLETED


Exceptions

TO BE COMPLETED


Caching

This method is not cached.


Known issues

None


Version history

TO BE COMPLETED


See also