editor
278
edits
Changes
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..."
{{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|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=Index of the initial result of the list, begins with 0
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=Quantity of results showed, with the maximum of 100
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=Defines a [[MovieType]] filter, to filter the results depending on the movie type value.
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName=sortType
|ParamType=int
|ParamRequired=optional
|ParamDescription=[[MovieSortFilterType]] enum to filter the result required. The default ordering will be by Tag Creation Date (Dateins)
}}
{{Api_Parameter|
ParamName=tag
|ParamType=TagType
|ParamRequired=optional
|ParamDescription=Type of tag that wants to be filtered. The default value is Unknown.
}}
{{Api_Parameter|
ParamName=tagType
|ParamType=Array of [[TagType]]
|ParamRequired=optional
|ParamDescription=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.
}}
{{Api_Parameter|
ParamName=tagValue
|ParamType=Array of int
|ParamRequired=optional
|ParamDescription=Allows to filter the results depending on the Movie IDs (Comma separated list).
}}
|Returns=
Returns a JSON object containing an Array of [[SimpleMovie]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[SimpleMovie]] objects</span> ]
}
|Exceptions=
* [[AuthenticationRequiredException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=Get a list of [[SimpleMovie]] tagged by the current user.
The user should be logged to use this method.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=Index of the initial result of the list, begins with 0
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=Quantity of results showed, with the maximum of 100
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=Defines a [[MovieType]] filter, to filter the results depending on the movie type value.
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName=sortType
|ParamType=int
|ParamRequired=optional
|ParamDescription=[[MovieSortFilterType]] enum to filter the result required. The default ordering will be by Tag Creation Date (Dateins)
}}
{{Api_Parameter|
ParamName=tag
|ParamType=TagType
|ParamRequired=optional
|ParamDescription=Type of tag that wants to be filtered. The default value is Unknown.
}}
{{Api_Parameter|
ParamName=tagType
|ParamType=Array of [[TagType]]
|ParamRequired=optional
|ParamDescription=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.
}}
{{Api_Parameter|
ParamName=tagValue
|ParamType=Array of int
|ParamRequired=optional
|ParamDescription=Allows to filter the results depending on the Movie IDs (Comma separated list).
}}
|Returns=
Returns a JSON object containing an Array of [[SimpleMovie]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;">Array of [[SimpleMovie]] objects</span> ]
}
|Exceptions=
* [[AuthenticationRequiredException]]
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
