GetChannelSimpleMoviesCount - Revision history

Pcl245 at 15:44, 9 February 2016

2016-02-09T15:44:01Z

Rcalvo at 20:59, 25 June 2014

2014-06-25T20:59:40Z

Rcalvo at 20:58, 25 June 2014

2014-06-25T20:58:53Z

Rcalvo: Created page with "{{Api_Method_Spec| Description=Returns the total of movies can be found in a specific list of channelIds available in the instance. It can include all sub channels (any levels..."

2014-06-25T20:55:22Z

Created page with "{{Api_Method_Spec| Description=Returns the total of movies can be found in a specific list of channelIds available in the instance. It can include all sub channels (any levels..."

New page

{{Api_Method_Spec|
Description=Returns the total of movies can be found in a specific list of channelIds available in the instance. It can include all sub channels (any levels) or just the first level of sub channel.

This method can be used by logged or anonymous login.

|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=channelIds
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of a channel that wants the result
}}
{{Api_Parameter|
ParamName=includeChildMovies
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Flag to set if the result should be contain all Movies in all sub channels from the specified in the channelId parameter. The default value is false.
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result.
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType= [[adultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both. The default value is NonAdultOnly.
}}

|Returns=
Returns a JSON object containing an array of [[SimpleMovie]].

'''Example:'''

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

|Exceptions=
* None

|Cache=
This method is 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 44: / Line 44: @@
+{
-:    <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
+:    <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
-:    <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
+:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
-:    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>,
+:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
-:    <span style="color: #a11;">"List"</span>:
+:    <span style="color: #a11;">"Content"</span>:
 ::     [ <span style="color: #219;">Array of [[ChannelCount]] objects</span> ]
+}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
-Description=Returns the total of movies can be found in a specific list of channelIds available in the instance. It can include all sub channels (any levels) or just the first level of sub channel.
+Description=Returns the total of movies found in a specific list of channelIds available in the instance in an Array of [[ChannelCount]] objects. It can include all sub channels (any levels) or just the first level of sub channel.
 This method can be used by logged or anonymous login.
@@ Line 39: / Line 39: @@
 |Returns=
-Returns a JSON object containing an array of [[SimpleMovie]].
+Returns a JSON object containing an array of [[ChannelCount]].
 '''Example:'''
@@ Line 48: / Line 48: @@
 :    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>,
 :    <span style="color: #a11;">"List"</span>:
-::     [ <span style="color: #219;">Array of [[SimpleMovie]] objects</span> ]
+::     [ <span style="color: #219;">Array of [[ChannelCount]] objects</span> ]
+}

@@ Line 16: / Line 16: @@
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=Id of a channel that wants the result
+|ParamDescription=Comma-separated Ids of channels that to get results from
 }}
 {{Api_Parameter|