GetDetailedChannelProductsTree

Description

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

Returns the list of products objects available in the instance under an specific Channel including more than one of sub channels and/or a specific quantity of products.

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.

• parentChannelId (int, required)

Number of the channel wants the result.

• channelLevels (int, required)

Set the quantity of levels in sub channels should be searched.

• productObjectsPerChannel (int, required)

Set the quantity of products should be returned on the search.

• typeFilter (String, optional)

List of numbers separated by comma with the MovieType to filter the result. Default set to Movie and Season (1, 3).

• adultFilter (adultFilterType, optional)

Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both.

• sort (movieSortType, optional)

SortTypeId to order result by the chosen field.

• productTypeFilter (productType, optional)

List of ProductType separated by comma to filter the result.

Returns

Returns a JSON object containing data info about the channel tree.

Example:

{

"Offset": 0,

"Limit": 100,

"Count": 14,

"List":

{

       "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": []
     }

}

Exceptions

• InvalidChannelException

Caching

This method is cached.

Known issues

• None

Version history

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral