GetChannelSimpleProductsCount

From Gvp-public
Revision as of 14:16, 14 July 2014 by Rcalvo (talk | contribs) (Created 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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Description

( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )

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

  • token (String, required)
A valid token for identifying the API session context. The token can be anonymous or logged.
  • channelIds (int, required)
List of channel ID that wants the result separated by comma.
  • 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. Default set to Movie and Season (1, 3).
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.
List of ProductType separated by comma to filter the result.


Returns

Returns a JSON object containing the ChannelCount for each channel.

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


See also