Difference between revisions of "GetUserTaggedSimpleMovies"
Jump to navigation
Jump to search
Line 14: | Line 14: | ||
{{Api_Parameter| | {{Api_Parameter| | ||
ParamName=tag | ParamName=tag | ||
− | |ParamType=TagType | + | |ParamType=[[TagType]] |
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Type of tag that wants to be filtered. The default value is Unknow. | |ParamDescription=Type of tag that wants to be filtered. The default value is Unknow. | ||
Line 23: | Line 23: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=The value of the tag. | |ParamDescription=The value of the tag. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| |
Latest revision as of 16:58, 17 February 2016
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.
- tag (TagType, optional)
- Type of tag that wants to be filtered. The default value is Unknow.
- tagValue (String, optional)
- The value of the tag.
- 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.
- limit (int, optional)
- Limit of items to return
- offset (int, optional)
- Offset to use when returning items
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 |