GET API/V40/CMS/Content/Homepage?SessionToken={SessionToken}
Retrieve homepage content
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken |
The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ResponseContainerModel| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken |
The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller. |
string | |
| ResponsesIncluded |
A list of response messages names contained in this composite message, for easy pre-parsing. |
string | |
| Responses |
A list of response messages contained in this composite message. |
Collection of Object | |
| Status |
The success status the composite message. |
CompositeStatus |
Response Formats
application/json, text/json
Sample:
{
"sessionToken": "I2wKwj7-3IgKAAAAAAAAAAAAAAA.XEhqNlxK38GHTMx8EnayatwgNrmzkZf3bYT2ip_8W2w",
"responsesIncluded": "getHomepageResponse",
"responses": [
{
"getHomepageResponse": {
"content": {
"quicklaunches": [
{
"type": "sample string 1",
"imageCode": "sample string 2",
"actionType": "sample string 3",
"actionParameter": "sample string 4",
"name": "sample string 5",
"sectionType": "sample string 6",
"outletCode": "sample string 7",
"sectionCode": "df801b1d-e01a-4e2f-9e4a-9d3d51863480",
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
},
{
"type": "sample string 1",
"imageCode": "sample string 2",
"actionType": "sample string 3",
"actionParameter": "sample string 4",
"name": "sample string 5",
"sectionType": "sample string 6",
"outletCode": "sample string 7",
"sectionCode": "df801b1d-e01a-4e2f-9e4a-9d3d51863480",
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
}
],
"widgets": [
{
"name": "sample string 1",
"displayName": "sample string 2",
"size": 3,
"code": "sample string 4",
"widgetType": "sample string 5",
"banners": [
{
"bannerCode": "sample string 1",
"name": "sample string 2",
"html": "sample string 3",
"bannerActionType": "sample string 4",
"actionParameter": "sample string 5",
"hasImage": true,
"imageSrc": "sample string 7",
"imageAmazonSrc": "sample string 8",
"backgroundColor": "sample string 9",
"adTag": "sample string 10",
"title": "sample string 11",
"bannerType": "sample string 12",
"bannerSourceType": "sample string 13",
"showAdvertisingLabel": true,
"actionUrlParameter": "sample string 15",
"sectionType": "sample string 16",
"outletCode": "sample string 17",
"startDate": "2024-11-06T08:41:07.6658211+00:00",
"endDate": "2024-11-06T08:41:07.6658211+00:00",
"sectionCode": "11b06e12-c4a6-4c48-8145-e15f61bc3428",
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
},
{
"bannerCode": "sample string 1",
"name": "sample string 2",
"html": "sample string 3",
"bannerActionType": "sample string 4",
"actionParameter": "sample string 5",
"hasImage": true,
"imageSrc": "sample string 7",
"imageAmazonSrc": "sample string 8",
"backgroundColor": "sample string 9",
"adTag": "sample string 10",
"title": "sample string 11",
"bannerType": "sample string 12",
"bannerSourceType": "sample string 13",
"showAdvertisingLabel": true,
"actionUrlParameter": "sample string 15",
"sectionType": "sample string 16",
"outletCode": "sample string 17",
"startDate": "2024-11-06T08:41:07.6658211+00:00",
"endDate": "2024-11-06T08:41:07.6658211+00:00",
"sectionCode": "11b06e12-c4a6-4c48-8145-e15f61bc3428",
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
}
],
"body": "sample string 6",
"linkText": "sample string 7",
"icon": "sample string 8",
"url": "sample string 9",
"actionType": "sample string 10",
"actionParameter": "sample string 11",
"actionUrlParameter": "sample string 12",
"sectionType": "sample string 13",
"outletCode": "sample string 14",
"sectionCode": "d66d16e4-07b3-40f1-829b-65ee7de52cde",
"posX": 15,
"posY": 16,
"width": 17,
"height": 18,
"autoPosition": true,
"sortOrder": 20,
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
},
{
"name": "sample string 1",
"displayName": "sample string 2",
"size": 3,
"code": "sample string 4",
"widgetType": "sample string 5",
"banners": [
{
"bannerCode": "sample string 1",
"name": "sample string 2",
"html": "sample string 3",
"bannerActionType": "sample string 4",
"actionParameter": "sample string 5",
"hasImage": true,
"imageSrc": "sample string 7",
"imageAmazonSrc": "sample string 8",
"backgroundColor": "sample string 9",
"adTag": "sample string 10",
"title": "sample string 11",
"bannerType": "sample string 12",
"bannerSourceType": "sample string 13",
"showAdvertisingLabel": true,
"actionUrlParameter": "sample string 15",
"sectionType": "sample string 16",
"outletCode": "sample string 17",
"startDate": "2024-11-06T08:41:07.6658211+00:00",
"endDate": "2024-11-06T08:41:07.6658211+00:00",
"sectionCode": "11b06e12-c4a6-4c48-8145-e15f61bc3428",
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
},
{
"bannerCode": "sample string 1",
"name": "sample string 2",
"html": "sample string 3",
"bannerActionType": "sample string 4",
"actionParameter": "sample string 5",
"hasImage": true,
"imageSrc": "sample string 7",
"imageAmazonSrc": "sample string 8",
"backgroundColor": "sample string 9",
"adTag": "sample string 10",
"title": "sample string 11",
"bannerType": "sample string 12",
"bannerSourceType": "sample string 13",
"showAdvertisingLabel": true,
"actionUrlParameter": "sample string 15",
"sectionType": "sample string 16",
"outletCode": "sample string 17",
"startDate": "2024-11-06T08:41:07.6658211+00:00",
"endDate": "2024-11-06T08:41:07.6658211+00:00",
"sectionCode": "11b06e12-c4a6-4c48-8145-e15f61bc3428",
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
}
],
"body": "sample string 6",
"linkText": "sample string 7",
"icon": "sample string 8",
"url": "sample string 9",
"actionType": "sample string 10",
"actionParameter": "sample string 11",
"actionUrlParameter": "sample string 12",
"sectionType": "sample string 13",
"outletCode": "sample string 14",
"sectionCode": "d66d16e4-07b3-40f1-829b-65ee7de52cde",
"posX": 15,
"posY": 16,
"width": 17,
"height": 18,
"autoPosition": true,
"sortOrder": 20,
"isItemActionType": false,
"isCategoryActionType": false,
"isSectionActionType": false
}
],
"backgroundImages": [
"sample string 1",
"sample string 2"
],
"timedBackgroundImages": [
{
"url": "sample string 1",
"startTime": 2.1,
"endTime": 3.1
},
{
"url": "sample string 1",
"startTime": 2.1,
"endTime": 3.1
}
],
"backgroundImageSlideshowInterval": 1
},
"succeeded": true
}
}
],
"status": "Success"
}