GetChannelEditorialContents
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
Note that the time recorded in the DataBase is in UTC format and the time showed is in GMT format. It means that in a place with "-3 GMT", e.g. 10am, will record 7am in the database.
A content can be created in:
- “Site Management > Channel > Editorial Content”
All contents cam be assigned to a channel in:
- “Site Management > Channel block”.
The last one, include the ordering that the content will be returned in the UNIAPI method GetChannelEditorialContents.
The contents will be displayed with or without associated images or DeviceTypes associated to each images. It means that the user can add or not images for the content. (If an image is added to the content without an specific DeviceType, it will be considered the default image).
All images will return 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.
Must be: All images assigned to an Editorial Content should be of Banner type. In case not, the image will no be exposed in the UNIAPI method getChannelEditorialContents.
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 |
