GET api/v1/widgets/topcommunicationscouponswgtd?refresh={refresh}&number={number}&monthsBack={monthsBack}

Request Information

URI Parameters

Name	Type	Additional information
refresh	boolean	Default value is False
number	integer	Default value is 5
monthsBack	integer	Default value is 12

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfWidgetWithDataDtoOfICollectionOfCommunicationsByCoupon

Name	Description	Type	Additional information
Meta		MetaSingleResult	None.
Notifications			None.

Response Formats

application/json, text/json

Sample:

{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "id": "c14d972a-74bd-44db-80c1-00466c0451b3",
    "code": "sample string 2",
    "data": [
      {
        "numCommunications": 1,
        "numEmailCommunications": 2,
        "numSmsCommunications": 3,
        "promotionCode": "sample string 4",
        "promotionTitle": "sample string 5",
        "urlImage": "sample string 6"
      },
      {
        "numCommunications": 1,
        "numEmailCommunications": 2,
        "numSmsCommunications": 3,
        "promotionCode": "sample string 4",
        "promotionTitle": "sample string 5",
        "urlImage": "sample string 6"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SingleResultResponseOfWidgetWithDataDtoOfArrayOfCommunicationsByCoupondOvjT49_PdOvjT49_P xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Presentation.WebApi.Dtos.Response">
  <Meta />
  <Notifications>
    <Notification />
    <Notification />
  </Notifications>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Services.Dtos">
    <d2p1:Code>sample string 2</d2p1:Code>
    <d2p1:Data>
      <d2p1:CommunicationsByCoupon>
        <d2p1:NumCommunications>1</d2p1:NumCommunications>
        <d2p1:NumEmailCommunications>2</d2p1:NumEmailCommunications>
        <d2p1:NumSmsCommunications>3</d2p1:NumSmsCommunications>
        <d2p1:PromotionCode>sample string 4</d2p1:PromotionCode>
        <d2p1:PromotionTitle>sample string 5</d2p1:PromotionTitle>
        <d2p1:UrlImage>sample string 6</d2p1:UrlImage>
      </d2p1:CommunicationsByCoupon>
      <d2p1:CommunicationsByCoupon>
        <d2p1:NumCommunications>1</d2p1:NumCommunications>
        <d2p1:NumEmailCommunications>2</d2p1:NumEmailCommunications>
        <d2p1:NumSmsCommunications>3</d2p1:NumSmsCommunications>
        <d2p1:PromotionCode>sample string 4</d2p1:PromotionCode>
        <d2p1:PromotionTitle>sample string 5</d2p1:PromotionTitle>
        <d2p1:UrlImage>sample string 6</d2p1:UrlImage>
      </d2p1:CommunicationsByCoupon>
    </d2p1:Data>
    <d2p1:Id>c14d972a-74bd-44db-80c1-00466c0451b3</d2p1:Id>
  </Result>
</SingleResultResponseOfWidgetWithDataDtoOfArrayOfCommunicationsByCoupondOvjT49_PdOvjT49_P>