Difference between revisions of "GetUserTaggedProducts"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Get a list of Product tagged by the current user. The user should be logged to use this method. |Parameters= {{Api_Parameter| ParamName=t...") |
|||
| Line 56: | Line 56: | ||
{ | { | ||
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"List"</span>: |
| − | :: | + | :: [ <span style="color: #219;">Array of [[Product]] objects</span> ] |
} | } | ||
Revision as of 13:15, 28 August 2014
Description
Get a list of Product tagged by the current user.
The user should be logged to use this method.
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- tag (TagType, optional)
- Type of tag that wants to be filtered. The default value is Unknow.
- tagValue (String, optional)
- The value of the tag.
- productFilter (ProductType, optional)
- A type of product possible in the system. The default value is ProductType.Unknown
- typeFilter (int, optional)
- MovieType enum to filter the result required. A list of values separated by comma as allowed. The default value is 1 and 3 (Movies and Season).
- adultFilter (int, optional)
- AdultFilterType enum to filter the result required. The default value is NonAdultOnly.
- sort (int, optional)
- MovieSortType enum to order the result required. The default sort type is Title.
Returns
Returns a JSON object containing an Array of Product.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of Product objects ]
}
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 |
