Difference between revisions of "GetSeasonEpisodeSimpleMovies"
Jump to navigation
Jump to search
| Line 41: | Line 41: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Id of a [[MovieSortType]] to order the result. The default is 2 (title). | |ParamDescription=Id of a [[MovieSortType]] to order the result. The default is 2 (title). | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName= playType | ||
| + | |ParamType=[[PlayType]] | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=PlayType of the media associated with the movie. | ||
}} | }} | ||
| Line 78: | Line 84: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Added playType | ||
| + | {{!}} Pedro Caamaño | ||
{{!}}} | {{!}}} | ||
|SeeAlso= | |SeeAlso= | ||
}} | }} | ||
Latest revision as of 16:44, 10 February 2016
Description
Returns the list of SimpleMovie object with all episode in the season searched. Used to show, on the device client, a list of all episodes available in a season.
The result is default ordered by the Title field and default filtered by NonAdultOnly. The method can be used by logged or anonymous user.
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
- movieId (int, required)
- The id of the Season that wants to retrieve the list of episodes.
- adultFilter (int, optional)
- String separated by comma with the AdultFilterType to filter the result.
- sort (int, optional)
- Id of a MovieSortType to order the result. The default is 2 (title).
- playType (PlayType, optional)
- PlayType of the media associated with the movie.
Returns
Returns a JSON object containing an array of SimpleMovie.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of SimpleMovie objects ]
}
Exceptions
None
Caching
This method is not cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial method design | Harley Cabral |
| 3.2 | Added playType | Pedro Caamaño |
