Difference between revisions of "EditorialContent"
Jump to navigation
Jump to search
(Created page with "{{Api_DataType_Spec |Description= |Members= {{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10" {{!}}- style="background:#88ccff;font-size:110%" ! Fie...") |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_DataType_Spec | {{Api_DataType_Spec | ||
| − | |Description= | + | |Description= Editorial Content is an object that represents all editorial information that were retrieve from a Channel, unifying all functionality. |
| − | |||
|Members= | |Members= | ||
| Line 13: | Line 12: | ||
! ID | ! ID | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} Editorial content id |
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! Name | ||
| + | {{!}} String | ||
| + | {{!}} The name of the editorial content | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! Url | ||
| + | {{!}} String | ||
| + | {{!}} Taken from URL column in the Editorial Content info | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! Description | ||
| + | {{!}} String | ||
| + | {{!}} Taken from Description column in the Editorial Content info | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| − | ! | + | ! Keywords |
{{!}} String | {{!}} String | ||
| − | {{!}} | + | {{!}} Taken from Keywords column in the Editorial Content info |
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! CatalogItemType | ||
| + | {{!}} int of [[CatalogItemType]] | ||
| + | {{!}} Property taken from object linked to the Editorial Content (0 if there is no catalog item related to the editorial content, just a banner) | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! CatalogItemId | ||
| + | {{!}} int | ||
| + | {{!}} Property taken from object linked to the Editorial Content (0 if there is no catalog item related to the editorial content, just a banner) | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! ResizableImages | ||
| + | {{!}} Array of [[Image]] | ||
| + | {{!}} It will only return the image matching the request deviceType, else it will use the default one (if exists). Thumbbox will not be used. | ||
| + | {{!}}- valign="top" | ||
| + | |||
| + | ! EventStartDate | ||
| + | {{!}} Long | ||
| + | {{!}} Timestamp that represents a date of event start. | ||
{{!}}- valign="top" | {{!}}- valign="top" | ||
| Line 27: | Line 61: | ||
{ | { | ||
| − | : "ID": | + | : "ID": 64, |
| − | : " | + | : "Name": "RecomendadoUX1", |
| − | : " | + | : "Url": "", |
| − | : " | + | : "Description": "", |
| − | : " | + | : "Keywords": "", |
| − | + | : "CatalogItemType": 1, | |
| − | : " | + | : "CatalogItemId": 565, |
| − | : " | + | : "ResizableImages": [ |
| − | : " | + | :: { |
| − | : | + | ::: Array of [[Image]] |
| − | :: | + | :: } |
| − | : ] | + | : ], |
| − | : " | + | : "EventStartDate": 0 |
} | } | ||
| Line 61: | Line 95: | ||
|SeeAlso= | |SeeAlso= | ||
| − | |||
}} | }} | ||
Latest revision as of 03:16, 20 March 2015
Editorial Content is an object that represents all editorial information that were retrieve from a Channel, unifying all functionality.
Members
| Field | Data Type | Description |
|---|---|---|
| ID | int | Editorial content id |
| Name | String | The name of the editorial content |
| Url | String | Taken from URL column in the Editorial Content info |
| Description | String | Taken from Description column in the Editorial Content info |
| Keywords | String | Taken from Keywords column in the Editorial Content info |
| CatalogItemType | int of CatalogItemType | Property taken from object linked to the Editorial Content (0 if there is no catalog item related to the editorial content, just a banner) |
| CatalogItemId | int | Property taken from object linked to the Editorial Content (0 if there is no catalog item related to the editorial content, just a banner) |
| ResizableImages | Array of Image | It will only return the image matching the request deviceType, else it will use the default one (if exists). Thumbbox will not be used. |
| EventStartDate | Long | Timestamp that represents a date of event start. |
Example
{
- "ID": 64,
- "Name": "RecomendadoUX1",
- "Url": "",
- "Description": "",
- "Keywords": "",
- "CatalogItemType": 1,
- "CatalogItemId": 565,
- "ResizableImages": [
- {
- Array of Image
- }
- {
- ],
- "EventStartDate": 0
}
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 3.0 | Initial data type implementation | Ricardo Calvo |
