Difference between revisions of "GetUserTags"
Jump to navigation
Jump to search
| Line 38: | Line 38: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=sortType | ParamName=sortType | ||
| − | |ParamType=[[ | + | |ParamType=[[MovieSortType]] (int) |
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=[[ | + | |ParamDescription=[[MovieSortType]] enum to filter the result required. The default ordering will be by Tag Creation Date (Dateins) |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 62: | Line 62: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an | + | Returns a JSON object containing an array of [[UserTags]] |
'''Example:''' | '''Example:''' | ||
| Line 71: | Line 71: | ||
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>, | : <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>, | ||
: <span style="color: #a11;">"List"</span>: | : <span style="color: #a11;">"List"</span>: | ||
| − | :: [ <span style="color: #219;">Array of [[ | + | :: [ <span style="color: #219;">Array of [[UserTags]] objects</span> ] |
} | } | ||
| Line 92: | Line 92: | ||
! Changes author | ! Changes author | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | ! | + | ! 3.0 |
{{!}} Initial method design | {{!}} Initial method design | ||
| − | {{!}} | + | {{!}} Jose A. Jiménez |
{{!}}} | {{!}}} | ||
|SeeAlso= | |SeeAlso= | ||
}} | }} | ||
Revision as of 14:30, 3 February 2015
Description
Get a list of SimpleMovie 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.
- offset (int, optional)
- Index of the initial result of the list, begins with 0
- limit (int, optional)
- Quantity of results showed, with the maximum of 100
- typeFilter (MovieType (int), optional)
- Defines a MovieType filter, to filter the results depending on the movie type value.
- adultFilter (AdultFilterType (int), optional)
- AdultFilterType enum to filter the result required. The default value is NonAdultOnly.
- sortType (MovieSortType (int), optional)
- MovieSortType enum to filter the result required. The default ordering will be by Tag Creation Date (Dateins)
- tag (TagType (int), optional)
- Type of tag that wants to be filtered. The default value is Unknown.
- tagType (Array of TagType, optional)
- Allows to filter the tag results depending on the TagType. The operator is able to introduce a comma separated list of TagTypes. Contents having ANY (OR operator) of the tags will be included in results.
- tagValue (Array of int, optional)
- Allows to filter the results depending on the Movie IDs (Comma separated list).
Returns
Returns a JSON object containing an array of UserTags
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of UserTags objects ]
}
Exceptions
Caching
This method is not cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 3.0 | Initial method design | Jose A. Jiménez |
