editor
725
edits
Changes
Jump to navigation
Jump to search
GetChannelSimpleProductsCount (view source)
Revision as of 14:16, 14 July 2014
, 14:16, 14 July 2014Created page with "{{Api_Method_Spec| Description= <span style="color:red">'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''<span> Returns the count of total Product..."
{{Api_Method_Spec|
Description=
<span style="color:red">'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''<span>
Returns the count of total [[Product]] objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel.
The result consider that the result is default filtered by [[AdultFilterType]].NonAdultOnly and [[MovieType]].(Movie and Season).
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=List of channel ID that wants the result separated by comma.
}}
{{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. Default set to Movie and Season (1, 3).
}}
{{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.
}}
{{Api_Parameter|
ParamName= productTypeFilter
|ParamType= [[productType]]
|ParamRequired=optional
|ParamDescription=List of [[ProductType]] separated by comma to filter the result.
}}
|Returns=
Returns a JSON object containing the [[ChannelCount]] for each channel.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: [
:: [ <span style="color: #219;">Array of [[ChannelCount]] objects</span> ]
: <span style="color: #a11;">]</span>
}
|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=
}}
Description=
<span style="color:red">'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''<span>
Returns the count of total [[Product]] objects available in the instance under an specific Channel. It can include all sub channels (any levels) or just the first level of sub channel.
The result consider that the result is default filtered by [[AdultFilterType]].NonAdultOnly and [[MovieType]].(Movie and Season).
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=List of channel ID that wants the result separated by comma.
}}
{{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. Default set to Movie and Season (1, 3).
}}
{{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.
}}
{{Api_Parameter|
ParamName= productTypeFilter
|ParamType= [[productType]]
|ParamRequired=optional
|ParamDescription=List of [[ProductType]] separated by comma to filter the result.
}}
|Returns=
Returns a JSON object containing the [[ChannelCount]] for each channel.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: [
:: [ <span style="color: #219;">Array of [[ChannelCount]] objects</span> ]
: <span style="color: #a11;">]</span>
}
|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=
}}
