Difference between revisions of "GetAllSimpleMovies"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of Simple Movie available in the instance. The result is default ordered by the title (MovieSort), default filtered by Movies ...") |
(No difference)
|
Revision as of 18:45, 16 June 2014
Description
Returns the list of Simple Movie available in the instance.
The result is default ordered by the title (MovieSort), default filtered by Movies and Season (MovieType) and default filtered by NonAdultOnly (AdultFilterType).
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
- typeFilter (String, optional)
- List of numbers separated by comma with the MovieType to filter the result.
- 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).
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 |