GetChannelSimpleMovies
Jump to navigation
Jump to search
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 ID in the object Channel. 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.
- 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.
- 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 |