GET api/v1/widgets/efficacycouponsrankingwidget?organizationCode={organizationCode}&refresh={refresh}&number={number}

Request Information

URI Parameters

Name	Type	Additional information
organizationCode	string	Required
refresh	boolean	Default value is False
number	integer	Default value is 12

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfWidgetWithDataDtoOfICollectionOfTotalCouponsUseData

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

Response Formats

application/json, text/json

Sample:

{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "id": "8fafd348-9b18-47b6-8689-126760355873",
    "code": "sample string 2",
    "data": [
      {
        "title": "sample string 1",
        "promotionUrl": "sample string 2",
        "generated": 3,
        "used": 4
      },
      {
        "title": "sample string 1",
        "promotionUrl": "sample string 2",
        "generated": 3,
        "used": 4
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SingleResultResponseOfWidgetWithDataDtoOfArrayOfTotalCouponsUseDatadOvjT49_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:TotalCouponsUseData>
        <d2p1:Generated>3</d2p1:Generated>
        <d2p1:PromotionUrl>sample string 2</d2p1:PromotionUrl>
        <d2p1:Title>sample string 1</d2p1:Title>
        <d2p1:Used>4</d2p1:Used>
      </d2p1:TotalCouponsUseData>
      <d2p1:TotalCouponsUseData>
        <d2p1:Generated>3</d2p1:Generated>
        <d2p1:PromotionUrl>sample string 2</d2p1:PromotionUrl>
        <d2p1:Title>sample string 1</d2p1:Title>
        <d2p1:Used>4</d2p1:Used>
      </d2p1:TotalCouponsUseData>
    </d2p1:Data>
    <d2p1:Id>8fafd348-9b18-47b6-8689-126760355873</d2p1:Id>
  </Result>
</SingleResultResponseOfWidgetWithDataDtoOfArrayOfTotalCouponsUseDatadOvjT49_PdOvjT49_P>