Difference between revisions of "GetChannelSimpleMoviesCount"
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...") |
|||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Returns the total of movies | + | 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. | This method can be used by logged or anonymous login. | ||
| Line 39: | Line 39: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an array of [[ | + | Returns a JSON object containing an array of [[ChannelCount]]. |
'''Example:''' | '''Example:''' | ||
| Line 48: | Line 48: | ||
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>, | : <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>, | ||
: <span style="color: #a11;">"List"</span>: | : <span style="color: #a11;">"List"</span>: | ||
| − | :: [ <span style="color: #219;">Array of [[ | + | :: [ <span style="color: #219;">Array of [[ChannelCount]] objects</span> ] |
} | } | ||
Revision as of 20:58, 25 June 2014
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.
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.
- adultFilter (adultFilterType, optional)
- 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 ChannelCount.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 14,
- "List":
- [ Array of ChannelCount 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 |
