Difference between revisions of "GetChannelSimpleProductsStb"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description= <span style="color:red">'''( CANDIDATE TO BE DEPRECATED -> Move to use GetChannelCatalogItem )'''<span> Returns the list of products inside a ...") |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2. Please use [[GetChannelCatalogItems]] instead}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description= | Description= | ||
| − | |||
| − | |||
Returns the list of products inside a channel. It can't be returned all product in all sub channel. | Returns the list of products inside a channel. It can't be returned all product in all sub channel. | ||
| − | |||
| − | |||
This method can be used by logged or anonymous login. | This method can be used by logged or anonymous login. | ||
| Line 18: | Line 16: | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=offset |
|ParamType=int | |ParamType=int | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=The offset number of the returned values for this request |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=limit |
| − | |ParamType= | + | |ParamType=int |
|ParamRequired=optional | |ParamRequired=optional | ||
| − | |ParamDescription= | + | |ParamDescription=The limit number of values for this request |
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| − | ParamName= | + | ParamName=channelId |
| − | |ParamType= | + | |ParamType=int |
| − | |ParamRequired= | + | |ParamRequired=required |
| − | |ParamDescription= | + | |ParamDescription=ID channel that wants the result. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}} | }} | ||
| + | |||
|Returns= | |Returns= | ||
| − | Returns a JSON object containing | + | Returns a JSON object containing an array of [[Product]]. |
'''Example:''' | '''Example:''' | ||
| Line 80: | Line 67: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- | ||
| + | ! 3.2 | ||
| + | {{!}} Method deprecated | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
| + | |||
|SeeAlso= | |SeeAlso= | ||
| + | * [[GetChannelCatalogItems]] | ||
}} | }} | ||
Latest revision as of 06:08, 21 August 2015
This method has been deprecated in GVP 3.2. Please use GetChannelCatalogItems instead
Description
Returns the list of products inside a channel. It can't be returned all product in all sub channel.
This method can be used by logged or anonymous login.
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
- channelId (int, required)
- ID channel that wants the result.
Returns
Returns a JSON object containing an array of Product.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 1,
- "List":
- [ Array of Product object ]
}
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 |
| 3.2 | Method deprecated | Francisco Milagro |
