Difference between revisions of "GetUserTags"
Jump to navigation
Jump to search
(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...") |
|||
| Line 26: | Line 26: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=typeFilter | ParamName=typeFilter | ||
| − | |ParamType=int | + | |ParamType=[[MovieType]] (int) |
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Defines a [[MovieType]] filter, to filter the results depending on the movie type value. | |ParamDescription=Defines a [[MovieType]] filter, to filter the results depending on the movie type value. | ||
| Line 32: | Line 32: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=adultFilter | ParamName=adultFilter | ||
| − | |ParamType=int | + | |ParamType=[[AdultFilterType]] (int) |
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value is NonAdultOnly. | |ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value is NonAdultOnly. | ||
| Line 38: | Line 38: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=sortType | ParamName=sortType | ||
| − | |ParamType=int | + | |ParamType=[[MovieSortFilter]] (int) |
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=[[ | + | |ParamDescription=[[MovieSortFilter]] enum to filter the result required. The default ordering will be by Tag Creation Date (Dateins) |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=tag | ParamName=tag | ||
| − | |ParamType=TagType | + | |ParamType=TagType (int) |
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Type of tag that wants to be filtered. The default value is Unknown. | |ParamDescription=Type of tag that wants to be filtered. The default value is Unknown. | ||
Revision as of 14:28, 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 (MovieSortFilter (int), optional)
- MovieSortFilter 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 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 |
