Difference between revisions of "GetChannelSimpleMoviesCount"

From Gvp-public
Jump to navigation Jump to search
(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...")
(No difference)

Revision as of 20:55, 25 June 2014

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

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • channelIds (int, required)
Id of a channel that wants the result
  • includeChildMovies (bool, optional)
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.
  • typeFilter (String, optional)
List of numbers separated by comma with the MovieType to filter the result.
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


Caching

This method is cached.


Known issues

  • None


Version history

API Version Number Change description Changes author
1.0 Initial method design Harley Cabral


See also