Difference between revisions of "SearchProducts"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the... The method can be used by logged or anonymous user. |Parameters= {{Api_Parameter| ParamName=token |ParamType=String |ParamRequ...")
 
Line 1: Line 1:
 
{{Api_Method_Spec|
 
{{Api_Method_Spec|
Description=Returns the...
+
Description=DEPRECATED
 
 
The method can be used by logged or anonymous user.
 
  
 
|Parameters=
 
|Parameters=
 
{{Api_Parameter|
 
ParamName=token
 
|ParamType=String
 
|ParamRequired=required
 
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
 
}}
 
{{Api_Parameter|
 
ParamName=offset
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The offset number of the returned values for this request
 
}}
 
{{Api_Parameter|
 
ParamName=limit
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=The limit number of values for this request
 
}}
 
 
{{Api_Parameter|
 
ParamName=channelId
 
|ParamType=int
 
|ParamRequired=required
 
|ParamDescription=
 
}}
 
{{Api_Parameter|
 
ParamName=includeChildMovies
 
|ParamType=bool
 
|ParamRequired=optional
 
|ParamDescription=
 
}}
 
 
 
 
{{Api_Parameter|
 
ParamName=filter
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=
 
}}
 
{{Api_Parameter|
 
ParamName=productType
 
|ParamType=
 
|ParamRequired=optional
 
|ParamDescription=
 
}}
 
 
 
{{Api_Parameter|
 
ParamName=typeFilter
 
|ParamType=String
 
|ParamRequired=optional
 
|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result.
 
}}
 
{{Api_Parameter|
 
ParamName=adultFilter
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=String separated by comma with the [[AdultFilterType]] to filter the result.
 
}}
 
{{Api_Parameter|
 
ParamName=sort
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=Id of a [[MovieSortType]] to order the result. The default is 2 (title).
 
}}
 
 
 
 
 
 
  
 
|Returns=
 
|Returns=
Returns a JSON object containing a [[SubtitleJSON]] in JSON format.
 
 
'''Example:'''
 
 
{
 
:    <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
 
:    <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
 
:    <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
 
:    <span style="color: #a11;">"Content"</span>:
 
::    { <span style="color: #219;">[[SubtitleJSON]] objects</span> }
 
}
 
  
 
|Exceptions=
 
|Exceptions=

Revision as of 20:28, 18 June 2014

Description

DEPRECATED

Parameters

Returns

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


See also