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...") |
|||
| (2 intermediate revisions by one other user not shown) | |||
| 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 16: | Line 16: | ||
|ParamType=int | |ParamType=int | ||
|ParamRequired=required | |ParamRequired=required | ||
| − | |ParamDescription= | + | |ParamDescription=Comma-separated Ids of channels that to get results from |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| 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:''' | ||
{ | { | ||
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>, |
| − | : <span style="color: #a11;">" | + | : <span style="color: #a11;">"Content"</span>: |
| − | :: [ <span style="color: #219;">Array of [[ | + | :: [ <span style="color: #219;">Array of [[ChannelCount]] objects</span> ] |
} | } | ||
Latest revision as of 15:44, 9 February 2016
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)
- Comma-separated Ids of channels that to get results from
- 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:
{
- "StatusCode": 0,
- "Severity": 1,
- "StatusMessage": "OK",
- "Content":
- [ 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 |
