Difference between revisions of "GetChannelEditorialContents"
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
| − | Description=This method | + | Description=This method will return an ordered list of Editorial Contents managed by the OBs. The Editorial Contents is used to show some specific contents into a channel as a way to publish a promotional contents. |
| − | + | A block called Editorial Contents were added to the MIB component to allow a OB user to managed this section and the contents returned by this method. It will take into account the Start and End Date of the Content, to filter out everything | |
| − | + | A content is assigned in a channel by the “Site Management > Channel > Editorial Content” block. On the menu item before, the OB user can manage the relation between Channel’s and Editorial Contents. It includes the ordering that the content will be returned in the UNIAPI method GetChannelEditorialContents. | |
| + | Each Editorial Content con be assigned to an image and/or not to an DeviceType. If no one image is specified, the default image from the related content will be used as default image. The DeviceType can be assigned for each image assigned. If any DeviceType is specified, it means that all images will be available for all devices. In case of a Editorial Contents has more than one image, it will be returned as an Array of images in the Resizable Images parameter. | ||
| + | |||
| + | This method doesn’t required a logged user. It can be used by anonymous login. | ||
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). | 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). | ||
| + | Important: It won't filter by Adult property, as adult contents must only be linked to adult channels. | ||
| + | |||
|Parameters= | |Parameters= | ||
Revision as of 14:08, 23 March 2015
Description
This method will return an ordered list of Editorial Contents managed by the OBs. The Editorial Contents is used to show some specific contents into a channel as a way to publish a promotional contents.
A block called Editorial Contents were added to the MIB component to allow a OB user to managed this section and the contents returned by this method. It will take into account the Start and End Date of the Content, to filter out everything
A content is assigned in a channel by the “Site Management > Channel > Editorial Content” block. On the menu item before, the OB user can manage the relation between Channel’s and Editorial Contents. It includes the ordering that the content will be returned in the UNIAPI method GetChannelEditorialContents.
Each Editorial Content con be assigned to an image and/or not to an DeviceType. If no one image is specified, the default image from the related content will be used as default image. The DeviceType can be assigned for each image assigned. If any DeviceType is specified, it means that all images will be available for all devices. In case of a Editorial Contents has more than one image, it will be returned as an Array of images in the Resizable Images parameter.
This method doesn’t required a logged user. It can be used by anonymous login. 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). Important: It won't filter by Adult property, as adult contents must only be linked to adult channels.
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 |
