GetChannelSimpleProductsStb - Revision history

Id02256 at 06:08, 21 August 2015

2015-08-21T06:08:31Z

Rcalvo at 14:37, 14 July 2014

2014-07-14T14:37:17Z

Rcalvo at 14:36, 14 July 2014

2014-07-14T14:36:44Z

Rcalvo at 14:35, 14 July 2014

2014-07-14T14:35:59Z

Rcalvo: Created page with "{{Api_Method_Spec| Description= '''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )''' Returns the list of products inside a ..."

2014-07-14T14:34:33Z

Created page with "{{Api_Method_Spec| Description= '''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )''' Returns the list of products inside a ..."

New page

{{Api_Method_Spec|
Description=
'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''

Returns the list of products inside a channel. It can't be returned all product in all 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:'''

{
: "Offset": 0,
: "Limit": 100,
: "Count": 1,
: "List":
:: [ Array of [[Product]] object ]
}

|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=
}}

@@ Line 1: / Line 1: @@
 {{Api_Method_Spec|
 Description=
 Returns the list of products inside a channel. It can't be returned all product in all sub channel.
@@ Line 67: / Line 67: @@
 {{!}} Initial method design
 {{!}} Harley Cabral
 {{!}}}
 |SeeAlso=
 }}

@@ Line 28: / Line 28: @@
 }}
 {{Api_Parameter|
-ParamName=channelIds
+ParamName=channelId
 |ParamType=int
 |ParamRequired=required
-|ParamDescription=List of channel ID that wants the result separated by comma.
+|ParamDescription=ID channel that wants the result.
 }}

@@ Line 36: / Line 36: @@
 |Returns=
-Returns a JSON object containing the [[ChannelCount]] for each channel.
+Returns a JSON object containing an array of [[Product]].
 '''Example:'''

@@ Line 4: / Line 4: @@
 Returns the list of products inside a channel. It can't be returned all product in all sub channel.
 This method can be used by logged or anonymous login.
@@ Line 18: / Line 16: @@
 }}
 {{Api_Parameter|
-ParamName=channelIds
+ParamName=offset
 |ParamType=int
 |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.
+|ParamDescription=The offset number of the returned values for this request
 }}
 {{Api_Parameter|
-ParamName=typeFilter
+ParamName=limit
-|ParamType=String
+|ParamType=int
 |ParamRequired=optional
-|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result. Default set to Movie and Season (1, 3).
+|ParamDescription=The limit number of values for this request
 }}
 {{Api_Parameter|
-ParamName= adultFilter
+ParamName=channelIds
-|ParamType= [[adultFilterType]]
+|ParamType=int
-|ParamRequired=optional
+|ParamRequired=required
-|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.
+|ParamDescription=List of channel ID that wants the result separated by comma.
 }}
 |Returns=