espot

This class provides RESTful services to get e-Marketing Spot data. It uses the MarketingSpotData noun.

Handler Class:

com.ibm.commerce.rest.marketing.handler.ESpotDataHandler

Method Summary

HTTP Method	Path	Description
GET	/store/{storeId}/espot?q={q}	Retrieve a list of all search terms that have search rules.
GET	/store/{storeId}/espot/{name}	Gets an e-Marketing Spot by name.
GET	/store/{storeId}/espot/{name}/category/{categoryId}	Deprecated: Gets an e-Marketing Spot at a specific category level. For example, Furniture. Alternatively, this can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?categoryId=&DM_ReqCmd=CategoryDisplay.
GET	/store/{storeId}/espot/{name}/product/{productId}	Deprecated: Gets an e-Marketing Spot for a specific product. Alternatively, this can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?productId=&DM_ReqCmd=ProductDisplay.
GET	/store/{storeId}/espot/{name}/type/{type}	Gets e-Marketing Spot data.

Method Details

GET /store/{storeId}/espot?q={q}

Retrieve a list of all search terms that have search rules.

Handler Method:

findAllSearchTerms

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
q	The query name.	query	string	true	false

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$SearchTermsContainer

GET /store/{storeId}/espot/{name}

Gets an e-Marketing Spot by name.

Handler Method:

findByName

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	false	false

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

espot-espot

Example

Request:

GET /wcs/resources/store/10001/espot/HomeBottomRight_Content?DM_marketingSpotBehavior=&deleteIfEmpty=*&orderId=14029&toOrderId=.&page=&DM_ReqCmd=TopCategoriesDisplay&calculationUsageId=-1&DM_SubstitutionValue1=Aurora&catalogId=10052&createIfEmpty=1&DM_SubstitutionValue2=http%3A%2F%2Flocalhost%2Fwebapp%2Fwcs%2Fstores%2Fservlet%2Fen%2Faurora&DM_SubstitutionValue3=en_US&DM_SubstitutionValue4=&DM_SubstitutionValue5=&DM_SubstitutionValue6=_8_-2000_1469&storeId=10001&DM_EmsName=HomeBottomRight_Content&continue=1&langId=-1&DM_imagePath=%2Fwcsstore%2FAurora%2F&deleteCartCookie=true&pageGroup=Content&updatePrices=0&DM_SubstitutionName1=%5BstoreName%5D&DM_SubstitutionName2=%5BfullPathHomeURL%5D&DM_SubstitutionName3=%5Blanglocale%5D&DM_SubstitutionName4=%5BproductTotalCount%5D&DM_SubstitutionName5=%5BcontentTotalCount%5D&DM_SubstitutionName6=%5BwidgetSuffix%5D&pageName=HomePage&DM_contextPath=%2Fwebapp%2Fwcs%2Fstores%2Fservlet&fromOrderId=*&responseFormat=json

HTTP Status Code:

200

Response:

{
	"MarketingSpotData": [
		{
			"baseMarketingSpotActivityData": [
				{
					"MarketingContentDescription": [
						{
						}
					],
					"activityIdentifierID": "0",
					"activityPriority": "1",
					"baseMarketingSpotActivityID": "10065",
					"baseMarketingSpotActivityName": "HomeKidsApparelAdContent",
					"baseMarketingSpotDataType": "MarketingContent",
					"contentClickAction": "None",
					"contentFormatId": "2",
					"contentFormatName": "Text",
					"contentId": "10065",
					"contentName": "HomeKidsApparelAdContent",
					"contentStoreId": "10001",
					"marketingContentDescription": [
						{
							"language": "-1",
							"marketingText": "<link rel=\"stylesheet\" href=\"\/wcsstore\/Aurora\/rwdWebAssets\/homePageEspot_Right\/styles.css\" \/> <div class=\"col4\" id=\"homePageEspot_Right\" role=\"region\" aria-label=\"home page Espot kids\">    <div class=\"homeESpotContainer\" id=\"homePageEspot_Right_Slot\">       <div class=\"textContainer\">          <div class=\"title\">                       Kids' Stuff                      <\/div>          <div class=\"bodyText\">             Summer style is all about fun prints, bright colors, comfort, and durability. Stock up on our easy-to-wear and affordable fashions for kids. Spend $100* or more, and earn a $25 gift certificate.                                    <div class=\"finePrint\">                         *Before taxes. Gift certificates are redeemable on your next visit.                       <\/div>          <\/div>          <div class=\"button\"><a alt=\"\" role=\"link\" aria-label=\"Shop now girls category\" href=\"http:\/\/localhost\/webapp\/wcs\/stores\/servlet\/en\/aurora\/apparel\/girls\">shop now<\/a><\/div>       <\/div>       <div class=\"imageContainer\">                     <img alt=\"\" id=\"kids1\" src=\"\/wcsstore\/Aurora\/rwdWebAssets\/homePageEspot_Right\/kids1.jpg\">                     <img alt=\"\" id=\"kids2\" src=\"\/wcsstore\/Aurora\/rwdWebAssets\/homePageEspot_Right\/kids2.png\">                   <\/div>    <\/div> <\/div>"
						}
					],
					"properties": [
						{
							"baseMarketingKey": "mktActivityDescription"
						},
						{
							"baseMarketingKey": "displaySequence",
							"baseMarketingValue": "1.0"
						}
					]
				}
			],
			"behavior": "0",
			"defaultContentDisplaySequence": [
				{
					"displaySequence": "1.0",
					"resultFormat": "MarketingContent",
					"resultId": "10065"
				}
			],
			"eSpotName": "HomeBottomRight_Content",
			"marketingSpotIdentifier": "10562",
			"nextTimeLimit": "-1"
		}
	],
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/espot\/HomeBottomRight_Content?DM_marketingSpotBehavior=&deleteIfEmpty=*&orderId=14029&toOrderId=.&page=&DM_ReqCmd=TopCategoriesDisplay&calculationUsageId=-1&DM_SubstitutionValue1=Aurora&catalogId=10052&createIfEmpty=1&DM_SubstitutionValue2=http%3A%2F%2Flocalhost%2Fwebapp%2Fwcs%2Fstores%2Fservlet%2Fen%2Faurora&DM_SubstitutionValue3=en_US&DM_SubstitutionValue4=&DM_SubstitutionValue5=&DM_SubstitutionValue6=_8_-2000_1469&storeId=10001&DM_EmsName=HomeBottomRight_Content&continue=1&langId=-1&DM_imagePath=%2Fwcsstore%2FAurora%2F&deleteCartCookie=true&pageGroup=Content&updatePrices=0&DM_SubstitutionName1=%5BstoreName%5D&DM_SubstitutionName2=%5BfullPathHomeURL%5D&DM_SubstitutionName3=%5Blanglocale%5D&DM_SubstitutionName4=%5BproductTotalCount%5D&DM_SubstitutionName5=%5BcontentTotalCount%5D&DM_SubstitutionName6=%5BwidgetSuffix%5D&pageName=HomePage&DM_contextPath=%2Fwebapp%2Fwcs%2Fstores%2Fservlet&fromOrderId=*&responseFormat=json",
	"resourceName": "espot"
}

GET /store/{storeId}/espot/{name}/category/{categoryId}

Deprecated: Gets an e-Marketing Spot at a specific category level. For example, Furniture. Alternatively, this can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?categoryId=&DM_ReqCmd=CategoryDisplay.

Handler Method:

findByNameWithCategory

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
categoryId	The category identifier.	path	string	true	N/A
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	false	false

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

espot-espot

Example

Request:

GET /wcs/resources/store/10001/espot/ESpotDataHandlerESpotName/category/10044?numberProductsToDisplay=2&DM_ReqCmd=CategoryDisplay2

HTTP Status Code:

200

Response:

{
	"MarketingSpotData": [
		{
			"behavior": "0",
			"eSpotName": "ESpotDataHandlerESpotName",
			"marketingSpotIdentifier": "15560",
			"nextTimeLimit": "-1"
		}
	],
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/espot\/ESpotDataHandlerESpotName\/category\/10044?numberProductsToDisplay=2&DM_ReqCmd=CategoryDisplay2",
	"resourceName": "espot"
}

GET /store/{storeId}/espot/{name}/product/{productId}

Deprecated: Gets an e-Marketing Spot for a specific product. Alternatively, this can be implemented using the findByName method with the following URL: store/{storeId}/espot/{name}?productId=&DM_ReqCmd=ProductDisplay.

Handler Method:

findByNameWithProduct

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
productId	The product identifier.	path	string	true	N/A
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	false	false

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

espot-espot

Example

Request:

GET /wcs/resources/store/10001/espot/ESpotDataHandlerESpotName/product/12973?numberContentToDisplay=1&DM_ReqCmd=ProductDisplay2

HTTP Status Code:

200

Response:

{
	"MarketingSpotData": [
		{
			"behavior": "0",
			"eSpotName": "ESpotDataHandlerESpotName",
			"marketingSpotIdentifier": "15562",
			"nextTimeLimit": "-1"
		}
	],
	"resourceId": "http:\/\/localhost:80\/wcs\/resources\/store\/10001\/espot\/ESpotDataHandlerESpotName\/product\/12973?numberContentToDisplay=1&DM_ReqCmd=ProductDisplay2",
	"resourceName": "espot"
}

GET /store/{storeId}/espot/{name}/type/{type}

Gets e-Marketing Spot data.

Handler Method:

findESpotData

Secure Call Mandatory:

false

Partial Authentication Allowed:

true

Parameters:

Name	Description	Parameter Type	Data Type	Required	Allow Multiple
storeId	The store identifier.	path	string	true	N/A
type	E-Spot type. Sample value : SEARCH	path	string	true	N/A
catalogId	The catalog identifier. If none is specified, the store default catalog shall be used.	query	string	false	false

HTTP Status Codes:

HTTP Status Code	Description
200	The requested completed successfully.
400	Bad request. Some of the inputs provided to the request aren't valid.
401	Not authenticated. The user session isn't valid.
403	The user isn't authorized to perform the specified request.
404	The specified resource couldn't be found.
500	Internal server error. Additional details will be contained on the server logs.

Response Data Type:

espot-espot

Data Type Details

com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType

Properties:

Name	Data Type	Required
shortDescription	string	false
longDescription	string	false
userData	com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData	false
language	string	false
name	string	false

com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData

Properties:

Name	Data Type	Required
userDataField	com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData.userDataField array	false

com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType.userData.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType

Properties:

Name	Data Type	Required
nameIdentifier	string	false
ownerID	string	false

com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType

Properties:

Name	Data Type	Required
externalIdentifier	com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier	false
uniqueID	string	false

com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType.externalIdentifier

Properties:

Name	Data Type	Required
nameIdentifier	string	false
ownerID	string	false

com.ibm.commerce.marketing.facade.datatypes.AreaType

Properties:

Name	Data Type	Required
shape	string	false
target	string	false
displaySequence	string	false
userData	com.ibm.commerce.marketing.facade.datatypes.AreaType.userData	false
alternateText	string	false
title	string	false
coordinates	string	false
uniqueID	string	false
url	string	false

com.ibm.commerce.marketing.facade.datatypes.AreaType.userData

Properties:

Name	Data Type	Required
userDataField	com.ibm.commerce.marketing.facade.datatypes.AreaType.userData.userDataField array	false

com.ibm.commerce.marketing.facade.datatypes.AreaType.userData.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

com.ibm.commerce.rest.marketing.handler.ESpotDataHandler$SearchTermsContainer

Structure containing multiple search terms.

Properties:

Name	Data Type	Required
searchTerms	string	true

espot-ActivityExternalIdentifier

Properties:

Name	Data Type	Required
activityIdentifierName	string	false
activityIdentifierStoreId	com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType	false

espot-ActivityIdentifier

Properties:

Name	Data Type	Required
activityExternalIdentifier	string	false
activityIdentifierID	string	false

espot-Attachment

Properties:

Name	Data Type	Required
attachmentDisplaySequence	string	false
attachmentReferenceId	string	false
attachmentReferenceDescription	espot-AttachmentReferenceDescription array	false
AttachmentReferenceDescription	espot-Attachment.AttachmentReferenceDescription array	false
userDataField	espot-Attachment.userDataField array	false
attachmentDescription	espot-AttachmentDescription array	false
AttachmentDescription	espot-Attachment.AttachmentDescription array	false
attachmentIdentifier	string	false
attachmentAsset	espot-AttachmentAsset array	false
attachmentUsage	string	false

espot-Attachment.AttachmentDescription

Properties:

Name	Data Type	Required
userDataField	espot-Attachment.AttachmentDescription.userDataField array	false

espot-Attachment.AttachmentDescription.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-Attachment.AttachmentReferenceDescription

Properties:

Name	Data Type	Required
userDataField	espot-Attachment.AttachmentReferenceDescription.userDataField array	false

espot-Attachment.AttachmentReferenceDescription.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-Attachment.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-AttachmentAsset

Properties:

Name	Data Type	Required
attachmentAssetPath	string	true
attachmentAssetLanguage	string array	false
attachmentAssetDirectoryPath	string	false
userDataField	espot-AttachmentAsset.userDataField array	false
attachmentLocalAsset	string	false
attachmentAssetId	string	false
attachmentAssetStoreExternalId	com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType	false
attachmentAssetMimeType	string	false
attachmentAssetRootDirectory	string	false
attachmentAssetStoreId	string	false

espot-AttachmentAsset.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-AttachmentDescription

Properties:

Name	Data Type	Required
attachmentShortDescription	string	false
attachmentLanguage	string	false
attachmentLongDescription	string	false
attachmentName	string	false

espot-AttachmentExternalIdentifier

Properties:

Name	Data Type	Required
attachementOwnerId	string	false
attachementExternalId	string	true
attachementStoreExternalId	com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType	false
attachementStoreId	string	false

espot-AttachmentIdentifier

Properties:

Name	Data Type	Required
attachmentExternalIdentifier	string	false
attachementId	string	false

espot-AttachmentReferenceDescription

Properties:

Name	Data Type	Required
attachmentShortDescription	string	false
attachmentLanguage	string	false
attachmentLongDescription	string	false
attachmentName	string	false

espot-AttachmentUsage

Properties:

Name	Data Type	Required
attachmentDisplaySequence	string	false
attachmentImage	string	false
attachmentUsageName	string	true
attachmentUsageDescription	com.ibm.commerce.foundation.common.datatypes.AttachmentDescriptionType	false

espot-BaseMarketingSpotActivityData

Properties:

Name	Data Type	Required
baseMarketingSpotActivityID	string	true
baseMarketingSpotActivityName	string	true
baseMarketingSpotCampaignName	string	false
activityPriority	string	false
properties	espot-BaseMarketingSpotActivityData.properties array	false
userDataField	espot-BaseMarketingSpotActivityData.userDataField array	false
activityFormat	string	false
activityIdentifier	string	false
experimentResult	espot-ExperimentResult array	false
baseMarketingSpotDataType	string	true

espot-BaseMarketingSpotActivityData.properties

Properties:

Name	Data Type	Required
baseMarketingKey	string	true
baseMarketingValue	string	false

espot-BaseMarketingSpotActivityData.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-DefaultContentDisplaySequence

Properties:

Name	Data Type	Required
displaySequence	string	false
resultFormat	string	false
resultId	string	false

espot-espot

Properties:

Name	Data Type	Required
MarketingSpotData	espot-espot_item array	false

espot-espot_item

Properties:

Name	Data Type	Required
baseMarketingSpotActivityData	espot-BaseMarketingSpotActivityData array	false
marketingSpotIdentifier	string	false
behavior	string	false
filteredResult	espot-espot_item.filteredResult array	false
marketingSpotDataTitle	espot-MarketingSpotDataTitle array	false
nextTimeLimit	string	false
defaultContentDisplaySequence	espot-DefaultContentDisplaySequence array	false
previewReport	string array	false

espot-espot_item.filteredResult

Properties:

Name	Data Type	Required
filteredResultFormat	string	false
filteredResultId	string	false

espot-Experiment

Properties:

Name	Data Type	Required
experimentResultName	string	false
experimentResultId	string	true

espot-ExperimentResult

Properties:

Name	Data Type	Required
testElement	string	false
experiment	string	false
controlElement	string	false

espot-MarketingContent

Properties:

Name	Data Type	Required
attachment	string	false
marketingContentImageMap	espot-MarketingContentImageMap array	false
contentClickAction	string	false
userDataField	espot-MarketingContent.userDataField array	false
contentInputOption	string	false
contentUrl	string	false
contentMimeType	string	false
marketingContentDescription	espot-MarketingContentDescription array	false
MarketingContentDescription	espot-MarketingContent.MarketingContentDescription array	false
contentFormatName	string	false
contentFormatId	string	false
marketingContentIdentifier	string	false

espot-MarketingContent.MarketingContentDescription

Properties:

Name	Data Type	Required
userDataField	espot-MarketingContent.MarketingContentDescription.userDataField array	false

espot-MarketingContent.MarketingContentDescription.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-MarketingContent.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-MarketingContentDescription

Properties:

Name	Data Type	Required
marketingText	string	false
language	string	false
contentLocation	string	false

espot-MarketingContentExternalIdentifier

Properties:

Name	Data Type	Required
contentStoreId	string	false
contentName	string	false
contentStoreExternalId	com.ibm.commerce.foundation.common.datatypes.StoreExternalIdentifierType	false

espot-MarketingContentIdentifier

Properties:

Name	Data Type	Required
contentId	string	false
marketingContentExternalIdentifier	string	false

espot-MarketingContentImageMap

Properties:

Name	Data Type	Required
userDataField	espot-MarketingContentImageMap.userDataField array	false
source	string	false
name	string	false
area	com.ibm.commerce.marketing.facade.datatypes.AreaType array	false

espot-MarketingContentImageMap.userDataField

Properties:

Name	Data Type	Required
value	string	false
key	string	true

espot-MarketingSpotDataTitle

Properties:

Name	Data Type	Required
marketingSpotDataTitleActivityID	string	false
marketingSpotDataTitleId	string	true
marketingSpotDataTitleName	string	true
marketingContent	string	true
experimentResult	espot-ExperimentResult array	false
marketingSpotDataTitleDataType	string	true

espot-MarketingSpotExternalIdentifier

Properties:

Name	Data Type	Required
eSpotName	string	false
eSpotStoreId	com.ibm.commerce.foundation.common.datatypes.StoreIdentifierType	false

espot-MarketingSpotIdentifier

Properties:

Name	Data Type	Required
marketingSpotIdentifier	string	false
marketingSpotExternalIdentifier	string	false

espot-TestElement

Properties:

Name	Data Type	Required
experimentResultTestElementName	string	false
experimentResultTestElementId	string	true