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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
refresh

boolean

Default value is False

monthsBack

integer

Default value is 12

Body Parameters

None.

Response Information

Resource Description

SingleResultResponseOfWidgetWithDataDtoOfPurchasesByBestAndWorstTimesData
NameDescriptionTypeAdditional information
Meta

MetaSingleResult

None.

Notifications

None.

Response Formats

application/json, text/json

Sample:
{
  "meta": {},
  "notifications": [
    {},
    {}
  ],
  "result": {
    "id": "4c4b081e-2a87-479d-980c-59d35a087e46",
    "code": "sample string 2",
    "data": {
      "bestByDayOfWeek": {
        "dayOfWeek": 0,
        "total": 1.0
      },
      "worstByDayOfWeek": {
        "dayOfWeek": 0,
        "total": 1.0
      },
      "bestByMonth": {
        "month": 1,
        "total": 1.0
      },
      "worstByMonth": {
        "month": 1,
        "total": 1.0
      }
    }
  }
}

application/xml, text/xml

Sample:
<SingleResultResponseOfWidgetWithDataDtoOfPurchasesByBestAndWorstTimesDatadOvjT49_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:BestByDayOfWeek>
        <d2p1:DayOfWeek>Sunday</d2p1:DayOfWeek>
        <d2p1:Total>1</d2p1:Total>
      </d2p1:BestByDayOfWeek>
      <d2p1:BestByMonth>
        <d2p1:Month>1</d2p1:Month>
        <d2p1:Total>1</d2p1:Total>
      </d2p1:BestByMonth>
      <d2p1:WorstByDayOfWeek>
        <d2p1:DayOfWeek>Sunday</d2p1:DayOfWeek>
        <d2p1:Total>1</d2p1:Total>
      </d2p1:WorstByDayOfWeek>
      <d2p1:WorstByMonth>
        <d2p1:Month>1</d2p1:Month>
        <d2p1:Total>1</d2p1:Total>
      </d2p1:WorstByMonth>
    </d2p1:Data>
    <d2p1:Id>4c4b081e-2a87-479d-980c-59d35a087e46</d2p1:Id>
  </Result>
</SingleResultResponseOfWidgetWithDataDtoOfPurchasesByBestAndWorstTimesDatadOvjT49_PdOvjT49_P>