This class provides RESTful services to retrieve spot details.
com.ibm.commerce.rest.marketing.handler.SpotHandler
HTTP Method | Path | Description |
---|---|---|
GET | /store/{storeId}/spot?q={q} | Find spots in a store. |
GET | /store/{storeId}/spot/{spotId} | Find a spot in a store using its unique identifier. |
Find spots in a store.
findSpotsByQuery
true
false
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 |
qType | Type of the e-spot. For instance : qType=MARKETING. Required for search by type. | query | string | false | false |
qName | Name of the e-spot used to find all spots with at least a partial match in the name or description. Required for search by name. | query | string | false | false |
catalogId | The catalog identifier. If none is specified, the store default catalog shall be used. | query | string | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | string | false | false |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | string | false | false |
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. |
Find a spot in a store using its unique identifier.
findSpotByID
true
false
Name | Description | Parameter Type | Data Type | Required | Allow Multiple |
---|---|---|---|---|---|
storeId | The store identifier. | path | string | true | N/A |
spotId | E-Spot identifier. | path | integer | true | N/A |
pageNumber | Page number, starting at 1. Valid values include positive integers of 1 and above. The "pageSize" must be specified for paging to work. | query | integer | false | false |
pageSize | Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The "pageNumber" must be specified for paging to work. | query | integer | false | false |
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. |
GET /wcs/resources/store/10001/spot/10589
200
{ "MarketingSpot": [ { "description": "Display the main ad on About Dress Designer page", "spotId": "10589", "spotName": "AboutDressDesignerPageMainAd", "type": "MARKETING", "uiDisplayable": 1 } ], "recordSetComplete": true, "recordSetCount": 1, "recordSetStartNumber": 0, "recordSetTotal": 1, "resourceId": "https:\/\/localhost:443\/wcs\/resources\/store\/10001\/spot\/10589", "resourceName": "spot" }
Name | Data Type | Required |
---|---|---|
recordSetTotal | string | false |
MarketingSpot | spot-spot_item array | false |
recordSetStartNumber | string | false |
recordSetComplete | string | false |
recordSetCount | string | false |
Name | Data Type | Required |
---|---|---|
userDataField | spot-spot_item.userDataField array | false |
uiDisplayable | string | false |
type | string | false |
description | string | false |
spotName | string | false |
spotId | string | false |
Name | Data Type | Required |
---|---|---|
value | string | false |
key | string | true |