Difference between revisions of "GetAllSimpleMovies"
Jump to navigation
Jump to search
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[GetAllMoviesCatalogItems]] instead}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Returns the list of Movies in a SimpleMovie object available in the instance. | Description=Returns the list of Movies in a SimpleMovie object available in the instance. | ||
The result is default ordered by the title ([[MovieSortType]]), default filtered by Movies and Season ([[MovieType]]) and default filtered by NonAdultOnly ([[AdultFilterType]]). | The result is default ordered by the title ([[MovieSortType]]), default filtered by Movies and Season ([[MovieType]]) and default filtered by NonAdultOnly ([[AdultFilterType]]). | ||
| + | The method can be used logged or anonymous user. | ||
|Parameters= | |Parameters= | ||
| Line 76: | Line 79: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- | ||
| + | ! 3.2 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| + | |||
|SeeAlso= | |SeeAlso= | ||
| + | *[[GetAllMoviesCatalogItems]] | ||
}} | }} | ||
Latest revision as of 06:32, 21 August 2015
This method has been deprecated in GVP 3.2. Please use GetAllMoviesCatalogItems instead
Description
Returns the list of Movies in a SimpleMovie object available in the instance.
The result is default ordered by the title (MovieSortType), default filtered by Movies and Season (MovieType) and default filtered by NonAdultOnly (AdultFilterType). The method can be used 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
- 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 |
| 3.2 | Method deprecated | Francisco Milagro |
