Difference between revisions of "SearchContent"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequired=required |ParamDescription=A valid token for identifying the A...") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description= | + | Description=The method used to get a list of CatalogItem from the GVP using a term, filterBy and searchFields. The result is an array of [[CatalogItem]] that contains all movies that respect the term and field filled. |
| + | |||
| + | The result is default ordered by the Unknow sort, it means that the result is returned by the registered order in the data base. | ||
| + | |||
| + | The method can be used by logged or anonymous user. | ||
|Parameters= | |Parameters= | ||
| Line 35: | Line 39: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName= sortOrder |
|ParamType=bool | |ParamType=bool | ||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription=Default value is false | + | |ParamDescription=Default value is false (ascending) |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 64: | Line 68: | ||
|ParamDescription=Default value is 0 (zero) | |ParamDescription=Default value is 0 (zero) | ||
}} | }} | ||
| − | + | {{Api_Parameter| | |
| + | ParamName= offset | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=offset to use when returning data | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName= limit | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=number of results to return | ||
| + | }} | ||
|Returns= | |Returns= | ||
Latest revision as of 16:21, 16 February 2016
Description
The method used to get a list of CatalogItem from the GVP using a term, filterBy and searchFields. The result is an array of CatalogItem that contains all movies that respect the term and field filled.
The result is default ordered by the Unknow sort, it means that the result is returned by the registered order in the data base.
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.
- term (String, required)
- A term that wants to request.
- filterBy (CatalogItemType, required)
- searchFields (SearchFieldType, required)
- sortBy (SearchFieldType, optional)
- Default value is SearchFieldType.Unknown
- sortOrder (bool, optional)
- Default value is false (ascending)
- includeAdult (bool, optional)
- Default value is false
- imageType (ImageType, optional)
- Default value is ImageType.Unknown
- width (int, optional)
- Default value is 0 (zero)
- height (int, optional)
- Default value is 0 (zero)
- offset (int, optional)
- offset to use when returning data
- limit (int, optional)
- number of results to return
Returns
Returns a JSON object containing an array of CatalogItem object.
Example:
{
- Content: [
- Array of CatalogItem
- ]
}
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 |
