Difference between revisions of "GetDetailedChannelTree"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= <span style="color:red">'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''<span> Returns the list of products objects a...") |
|||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[GetAllChannels]] instead}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description= | Description= | ||
| − | |||
| − | |||
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. | 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. | ||
| Line 84: | Line 84: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| + | |||
|SeeAlso= | |SeeAlso= | ||
| + | * [[GetAllChannels]] | ||
| + | * [[GetChannelCatalogItems]] | ||
| + | }} | ||
}} | }} | ||
Latest revision as of 06:11, 21 August 2015
This method has been deprecated in GVP 3.2. Please use GetAllChannels instead
Description
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 |
| 3.2 | Method deprecated | Francisco Milagro |
See also
}}
