Difference between revisions of "GetAllMoviesCatalogItems"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Return a list of CatalogueItem of Movie available in the instance. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequi...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=Return a list of | + | Description=Return a list of [[CatalogItem]] available in the instance. This method can be used logged or anonymous user. |
|Parameters= | |Parameters= | ||
| Line 42: | Line 42: | ||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing an array of [[ | + | Returns a JSON object containing an array of [[CatalogItem]]. |
'''Example:''' | '''Example:''' | ||
| Line 51: | Line 51: | ||
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>, | : <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>, | ||
: <span style="color: #a11;">"List"</span>: | : <span style="color: #a11;">"List"</span>: | ||
| − | :: [ <span style="color: #219;">Array of [[ | + | :: [ <span style="color: #219;">Array of [[CatalogItem]] objects</span> ] |
} | } | ||
| Line 58: | Line 58: | ||
|Cache= | |Cache= | ||
| − | This method is | + | This method is cached. |
|KnownIssues= | |KnownIssues= | ||
Latest revision as of 19:49, 16 June 2014
Description
Return a list of CatalogItem available in the instance. This 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 CatalogItem.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of CatalogItem 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 |
