POST posSupportAPI/promotion/flush

The Flush Cached Promotion method. The Flush Cached Promotion method is requested upon Offer Publishing. Flushes the cache for the given promotion id.

Request Information

URI Parameters

None.

Body Parameters

The Flush Cached Promotion request object.

FlushCachedPromotionRequest
NameDescriptionTypeAdditional information
promotion

The promotion details.

Promotion

Required

Request Formats

application/json, text/json

Sample:
{
  "promotion": {
    "id": 1
  }
}

application/xml, text/xml

Sample:
<FlushCachedPromotionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <Promotion>
    <Id>1</Id>
  </Promotion>
</FlushCachedPromotionRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FlushCachedPromotionRequest'.

Response Information

Resource Description

The Flush Cached Promotion response object.

FlushCachedPromotionResponse
NameDescriptionTypeAdditional information
result

The Result object.

Result

Required

Response Formats

application/json, text/json

Sample:
{
  "result": {
    "statusCode": 1,
    "description": "sample string 2",
    "exceptionTrackingMoniker": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<FlushCachedPromotionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OfferManagementPOSSupport.Models">
  <Result>
    <Description>sample string 2</Description>
    <ExceptionTrackingMoniker>sample string 3</ExceptionTrackingMoniker>
    <StatusCode>1</StatusCode>
  </Result>
</FlushCachedPromotionResponse>