Difference between revisions of "GetChannelTopHighlights"
Jump to navigation
Jump to search
Line 3: | Line 3: | ||
This method can be used by logged or anonymous login. | This method can be used by logged or anonymous login. | ||
The result is default ordered by the ID field. | The result is default ordered by the ID field. | ||
+ | |||
+ | The maximum number of result is 10 because until the present date the MIB tool has only 10 position to set the editorials content. | ||
|Parameters= | |Parameters= |
Revision as of 14:54, 14 July 2014
Description
Get the assigned contents of a channel in the specified position on the MIB tool. The content set in the MIB should be available for the device that request the content to be returned. This method can be used by logged or anonymous login. The result is default ordered by the ID field.
The maximum number of result is 10 because until the present date the MIB tool has only 10 position to set the editorials content.
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 of a channel that wants the result
Returns
Returns a JSON object containing an array of TopHighlight object.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 10,
- "List":
- [ Array of TopHighlight 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 |