GetUserTaggedSimpleMovies - Revision history

Pcl245 at 16:58, 17 February 2016

2016-02-17T16:58:07Z

Pcl245 at 16:57, 17 February 2016

2016-02-17T16:57:00Z

Rcalvo: 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..."

2014-08-28T13:20:13Z

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..."

New page

{{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:'''

{
: "Offset": 0,
: "Limit": 100,
: "Count": 6,
: "List":
:: [ Array of [[SimpleMovie]] objects ]
}

|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=
}}

@@ Line 14: / Line 14: @@
 {{Api_Parameter|
 ParamName=tag
-|ParamType=TagType
+|ParamType=[[TagType]]
 |ParamRequired=optional
 |ParamDescription=Type of tag that wants to be filtered. The default value is Unknow.
@@ Line 23: / Line 23: @@
 |ParamRequired=optional
 |ParamDescription=The value of the tag.
 }}
 {{Api_Parameter|

@@ Line 47: / Line 47: @@
 |ParamRequired=optional
 |ParamDescription=MovieSortType enum to order the result required. The default sort type is Title.
 }}