GetUserTags
Revision as of 14:27, 3 February 2015 by Id01213 (talk | contribs) (Created page with "{{Api_Method_Spec| Description=Get a list of SimpleMovie tagged by the current user. The user should be logged to use this method. |Parameters= {{Api_Parameter| ParamNa...")
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 (int, optional)
- Defines a MovieType filter, to filter the results depending on the movie type value.
- adultFilter (int, optional)
- AdultFilterType enum to filter the result required. The default value is NonAdultOnly.
- sortType (int, optional)
- MovieSortFilterType enum to filter the result required. The default ordering will be by Tag Creation Date (Dateins)
- tag (TagType, 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 SimpleMovie.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of SimpleMovie 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 |