editor
725
edits
Changes
Jump to navigation
Jump to search
GetDetailedChannelProductsTree (view source)
Revision as of 20:45, 14 July 2014
, 20:45, 14 July 2014Created page with "{{Api_Method_Spec| Description= <span style="color:red">'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''<span> Returns the list of Product object..."
{{Api_Method_Spec|
Description=
<span style="color:red">'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''<span>
Returns the list of [[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 is default ordered by the property ParentChannelID and after that by the Channel ordination and then by the ID.
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=parentChannelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Number of the channel wants the result.
}}
{{Api_Parameter|
ParamName=channelLevels
|ParamType=int
|ParamRequired=required
|ParamDescription=Set the quantity of levels in sub channels should be searched.
}}
{{Api_Parameter|
ParamName=productObjectsPerChannel
|ParamType=int
|ParamRequired=required
|ParamDescription=Set the quantity of products should be returned on the search.
}}
{{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.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=SortTypeId to order result by the chosen field.
}}
{{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 data info about the channel tree.
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>,
: <span style="color: #a11;">"List"</span>:
:: {
"Channel": {
"ID": 93,
"IsEnabled": true,
"Title": "Series",
"ParentChannelId": 86,
"Images": [],
"HasChildren": true,
"HasMovies": false,
"HasFeaturedMovies": false,
"RequiresPin": false,
"ProductSelectionId": 0,
"SubscriptionId": 0,
"BundleId": 0,
"HasNew": false,
"HasPopular": false,
"DisableNavigation": false,
"Ordination": 2,
"IsSpecialChannel": false,
"ResizableImages": [],
"Description": ""
},
"ProductCount": 0,
"MovieCount": 0,
"BundleCount": 0,
"SubscriptionCount": 0,
"PlaylistCount": 0,
"EpisodeCount": 0,
"SerieCount": 0,
"SeasonCount": 0,
"Products": [],
"Children": []
}</span>
}
|Exceptions=
* [[InvalidChannelException]]
|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 list of [[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 is default ordered by the property ParentChannelID and after that by the Channel ordination and then by the ID.
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=parentChannelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Number of the channel wants the result.
}}
{{Api_Parameter|
ParamName=channelLevels
|ParamType=int
|ParamRequired=required
|ParamDescription=Set the quantity of levels in sub channels should be searched.
}}
{{Api_Parameter|
ParamName=productObjectsPerChannel
|ParamType=int
|ParamRequired=required
|ParamDescription=Set the quantity of products should be returned on the search.
}}
{{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.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=SortTypeId to order result by the chosen field.
}}
{{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 data info about the channel tree.
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">14</span>,
: <span style="color: #a11;">"List"</span>:
:: {
"Channel": {
"ID": 93,
"IsEnabled": true,
"Title": "Series",
"ParentChannelId": 86,
"Images": [],
"HasChildren": true,
"HasMovies": false,
"HasFeaturedMovies": false,
"RequiresPin": false,
"ProductSelectionId": 0,
"SubscriptionId": 0,
"BundleId": 0,
"HasNew": false,
"HasPopular": false,
"DisableNavigation": false,
"Ordination": 2,
"IsSpecialChannel": false,
"ResizableImages": [],
"Description": ""
},
"ProductCount": 0,
"MovieCount": 0,
"BundleCount": 0,
"SubscriptionCount": 0,
"PlaylistCount": 0,
"EpisodeCount": 0,
"SerieCount": 0,
"SeasonCount": 0,
"Products": [],
"Children": []
}</span>
}
|Exceptions=
* [[InvalidChannelException]]
|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=
}}
