editor
725
edits
Changes
Jump to navigation
Jump to search
GetUserTaggedSimpleMovies (view source)
Revision as of 13:20, 28 August 2014
, 13:20, 28 August 2014Created 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=tag
|ParamType=TagType
|ParamRequired=optional
|ParamDescription=Type of tag that wants to be filtered. The default value is Unknow.
}}
{{Api_Parameter|
ParamName=tagValue
|ParamType=String
|ParamRequired=optional
|ParamDescription=The value of the tag.
}}
{{Api_Parameter|
ParamName=productFilter
|ParamType= ProductType
|ParamRequired=optional
|ParamDescription=A type of product possible in the system. The default value is ProductType.Unknown
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=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).
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=AdultFilterType enum to filter the result required. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName=sort
|ParamType=int
|ParamRequired=optional
|ParamDescription=MovieSortType enum to order the result required. The default sort type is Title.
}}
|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=tag
|ParamType=TagType
|ParamRequired=optional
|ParamDescription=Type of tag that wants to be filtered. The default value is Unknow.
}}
{{Api_Parameter|
ParamName=tagValue
|ParamType=String
|ParamRequired=optional
|ParamDescription=The value of the tag.
}}
{{Api_Parameter|
ParamName=productFilter
|ParamType= ProductType
|ParamRequired=optional
|ParamDescription=A type of product possible in the system. The default value is ProductType.Unknown
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=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).
}}
{{Api_Parameter|
ParamName=adultFilter
|ParamType=int
|ParamRequired=optional
|ParamDescription=AdultFilterType enum to filter the result required. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName=sort
|ParamType=int
|ParamRequired=optional
|ParamDescription=MovieSortType enum to order the result required. The default sort type is Title.
}}
|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=
}}
