Difference between revisions of "GetChannelEditorialContents"
Jump to navigation
Jump to search
| Line 14: | Line 14: | ||
|ParamRequired=required | |ParamRequired=required | ||
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged. | |ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged. | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=channelId | ||
| + | |ParamType=int | ||
| + | |ParamRequired=required | ||
| + | |ParamDescription=The channel id that want to return the editorial content registered inside then. | ||
}} | }} | ||
{{Api_Parameter| | {{Api_Parameter| | ||
| Line 27: | Line 33: | ||
|ParamDescription=The limit number of values for this request | |ParamDescription=The limit number of values for this request | ||
}} | }} | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 03:37, 20 March 2015
Description
This method has to return an ordered list of EditorialContent.
This method will take into account the Start and End Date of the Content, to filter out everything. Also will take into account the ordering of the elements defined in the MIB Channel Editorial Contents block.
Important: It won't filter by Adult property, as adult contents must only be linked to adult channels.
It will return ALL the EditorialContents (either they have catalog item associated or not; or either the editorial content has an image linked or not).
Parameters
- token (String, required)
- A valid token for identifying the API session context. The token can be anonymous or logged.
- channelId (int, required)
- The channel id that want to return the editorial content registered inside then.
- offset (int, optional)
- The offset number of the returned values for this request
- limit (int, optional)
- The limit number of values for this request
Returns
Returns a JSON object containing an array of EditorialContent.
Example:
{
- "Offset": 0,
- "Limit": 100,
- "Count": 6,
- "List":
- [ Array of EditorialContent List ]
}
Exceptions
None
Caching
This method is cached.
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 3.0 | Initial method design | Ricardo Calvo |
