Difference between revisions of "GetChannelSimpleMovies"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of Channel objects available in the instance under an specific Channel. It can include all sub channels (any levels) or jus...") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[GetChannelCatalogItems]] instead}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Returns the list of [[Channel]] 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. | Description=Returns the list of [[Channel]] 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 | + | The result is default ordered by the property Title in the object [[SimpleMovie]]. This method can be used by logged or anonymous login. |
|Parameters= | |Parameters= | ||
| Line 34: | Line 36: | ||
|ParamType=bool | |ParamType=bool | ||
|ParamRequired=optional | |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. | + | |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| | {{Api_Parameter| | ||
| Line 46: | Line 48: | ||
|ParamType= [[adultFilterType]] | |ParamType= [[adultFilterType]] | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both. | + | |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| | {{Api_Parameter| | ||
Latest revision as of 09:18, 9 February 2016
This method has been deprecated in GVP 3.2. Please use GetChannelCatalogItems instead
Description
Returns the list of Channel 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 Title in the object SimpleMovie. 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.
- offset (int, optional)
- The offset number of the returned values for this request
- limit (int, optional)
- The limit number of values for this request
- channelId (int, required)
- Id of a channel that wants the result
- includeChildMovies (bool, optional)
- 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.
- typeFilter (String, optional)
- List of numbers separated by comma with the MovieType to filter the result.
- adultFilter (adultFilterType, optional)
- 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.
- sort (movieSortType, optional)
- SortTypeId to order result by the chosen field
Returns
Returns a JSON object containing an array of SimpleMovie.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 14,
- "List":
- [ Array of SimpleMovie objects ]
}
Exceptions
- None
Caching
This method is cached.
Known issues
- None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
