editor
725
edits
Changes
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..."
{{Api_Method_Spec|
Description=
|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=term
|ParamType=String
|ParamRequired=required
|ParamDescription=A term that wants to request.
}}
{{Api_Parameter|
ParamName=filterBy
|ParamType=[[CatalogItemType]]
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=searchFields
|ParamType=[[SearchFieldType]]
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= sortBy
|ParamType=[[SearchFieldType]]
|ParamRequired=optional
|ParamDescription=Default value is SearchFieldType.Unknown
}}
{{Api_Parameter|
ParamName= descending
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Default value is false
}}
{{Api_Parameter|
ParamName=includeAdult
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Default value is false
}}
{{Api_Parameter|
ParamName= imageType
|ParamType=[[ImageType]]
|ParamRequired=optional
|ParamDescription=Default value is ImageType.Unknown
}}
{{Api_Parameter|
ParamName= width
|ParamType=int
|ParamRequired=optional
|ParamDescription=Default value is 0 (zero)
}}
{{Api_Parameter|
ParamName= height
|ParamType=int
|ParamRequired=optional
|ParamDescription=Default value is 0 (zero)
}}
|Returns=
Returns a JSON object containing an array of [[CatalogItem]] object.
'''Example:'''
{
: Content: [
:: Array of [[CatalogItem]]
: ]
}
|Exceptions=
None
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=
|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=term
|ParamType=String
|ParamRequired=required
|ParamDescription=A term that wants to request.
}}
{{Api_Parameter|
ParamName=filterBy
|ParamType=[[CatalogItemType]]
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName=searchFields
|ParamType=[[SearchFieldType]]
|ParamRequired=required
|ParamDescription=
}}
{{Api_Parameter|
ParamName= sortBy
|ParamType=[[SearchFieldType]]
|ParamRequired=optional
|ParamDescription=Default value is SearchFieldType.Unknown
}}
{{Api_Parameter|
ParamName= descending
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Default value is false
}}
{{Api_Parameter|
ParamName=includeAdult
|ParamType=bool
|ParamRequired=optional
|ParamDescription=Default value is false
}}
{{Api_Parameter|
ParamName= imageType
|ParamType=[[ImageType]]
|ParamRequired=optional
|ParamDescription=Default value is ImageType.Unknown
}}
{{Api_Parameter|
ParamName= width
|ParamType=int
|ParamRequired=optional
|ParamDescription=Default value is 0 (zero)
}}
{{Api_Parameter|
ParamName= height
|ParamType=int
|ParamRequired=optional
|ParamDescription=Default value is 0 (zero)
}}
|Returns=
Returns a JSON object containing an array of [[CatalogItem]] object.
'''Example:'''
{
: Content: [
:: Array of [[CatalogItem]]
: ]
}
|Exceptions=
None
|Cache=
This method is cached.
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
