GetDetailedChannelTree
Jump to navigation
Jump to search
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.
- movieObjectsPerChannel (int, required)
- Set the quantity of movies 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.
Returns
Returns a JSON object containing data info about the channel tree.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 14,
- "List":
- [ Array of Information ]
}
Exceptions
Caching
This method is cached.
Known issues
- None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |