POST api/Dashboard/Overview

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
StockistId	string	None.
DistributorId	string	None.
Month	string	None.
Year	string	None.
Week	string	None.
FromDate	string	None.
ToDate	string	None.
UserId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "StockistId": "sample string 1",
  "DistributorId": "sample string 2",
  "Month": "sample string 3",
  "Year": "sample string 4",
  "Week": "sample string 5",
  "FromDate": "sample string 6",
  "ToDate": "sample string 7",
  "UserId": "sample string 8"
}

application/xml, text/xml

Sample:

<DashboardFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SNKR_APP_MODAL.EmployeeModal">
  <DistributorId>sample string 2</DistributorId>
  <FromDate>sample string 6</FromDate>
  <Month>sample string 3</Month>
  <StockistId>sample string 1</StockistId>
  <ToDate>sample string 7</ToDate>
  <UserId>sample string 8</UserId>
  <Week>sample string 5</Week>
  <Year>sample string 4</Year>
</DashboardFilter>

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 'DashboardFilter'.

Response Information

Resource Description

DashboardOverviewResponse

Name	Type	Additional information
StatusCode	integer	None.
status	string	None.
statusText	string	None.
CDS	DashboardOverview	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusCode": 1,
  "status": "sample string 2",
  "statusText": "sample string 3",
  "CDS": {
    "FromDate": "sample string 1",
    "ToDate": "sample string 2",
    "Summary": {
      "TotalSaleAmount": "sample string 1",
      "DSRAmount": "sample string 2",
      "OrganicAmount": "sample string 3",
      "OrganicPercent": "sample string 4",
      "DistributorDueAmount": "sample string 5",
      "CompanyPendingAmount": "sample string 6",
      "CurrentStockAmount": "sample string 7"
    },
    "DailySales": [
      {
        "Date": "sample string 1",
        "Label": "sample string 2",
        "Amount": "sample string 3"
      },
      {
        "Date": "sample string 1",
        "Label": "sample string 2",
        "Amount": "sample string 3"
      }
    ],
    "SaleMix": [
      {
        "ItemCode": "sample string 1",
        "AvailableStock": "sample string 2"
      },
      {
        "ItemCode": "sample string 1",
        "AvailableStock": "sample string 2"
      }
    ],
    "PeriodSales": [
      {
        "DateRange": "sample string 1",
        "TotalSale": "sample string 2",
        "DSR": "sample string 3",
        "Organic": "sample string 4"
      },
      {
        "DateRange": "sample string 1",
        "TotalSale": "sample string 2",
        "DSR": "sample string 3",
        "Organic": "sample string 4"
      }
    ],
    "TopDistributors": [
      {
        "DistributorId": "sample string 1",
        "DistributorName": "sample string 2",
        "DistributorCode": "sample string 3",
        "StockistCode": "sample string 4",
        "StockistName": "sample string 5",
        "SAName": "sample string 6",
        "AreaName": "sample string 7",
        "TotalSaleAmount": "sample string 8",
        "DSRAmount": "sample string 9",
        "OrganicAmount": "sample string 10",
        "OrganicPercent": "sample string 11",
        "CurrentStockAmount": "sample string 12",
        "CoverDays": "sample string 13"
      },
      {
        "DistributorId": "sample string 1",
        "DistributorName": "sample string 2",
        "DistributorCode": "sample string 3",
        "StockistCode": "sample string 4",
        "StockistName": "sample string 5",
        "SAName": "sample string 6",
        "AreaName": "sample string 7",
        "TotalSaleAmount": "sample string 8",
        "DSRAmount": "sample string 9",
        "OrganicAmount": "sample string 10",
        "OrganicPercent": "sample string 11",
        "CurrentStockAmount": "sample string 12",
        "CoverDays": "sample string 13"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<DashboardOverviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SNKR_APP_MODAL.EmployeeModal">
  <CDS>
    <DailySales>
      <DashboardDailySale>
        <Amount>sample string 3</Amount>
        <Date>sample string 1</Date>
        <Label>sample string 2</Label>
      </DashboardDailySale>
      <DashboardDailySale>
        <Amount>sample string 3</Amount>
        <Date>sample string 1</Date>
        <Label>sample string 2</Label>
      </DashboardDailySale>
    </DailySales>
    <FromDate>sample string 1</FromDate>
    <PeriodSales>
      <DashboardPeriodSale>
        <DSR>sample string 3</DSR>
        <DateRange>sample string 1</DateRange>
        <Organic>sample string 4</Organic>
        <TotalSale>sample string 2</TotalSale>
      </DashboardPeriodSale>
      <DashboardPeriodSale>
        <DSR>sample string 3</DSR>
        <DateRange>sample string 1</DateRange>
        <Organic>sample string 4</Organic>
        <TotalSale>sample string 2</TotalSale>
      </DashboardPeriodSale>
    </PeriodSales>
    <SaleMix>
      <DashboardStockMix>
        <AvailableStock>sample string 2</AvailableStock>
        <ItemCode>sample string 1</ItemCode>
      </DashboardStockMix>
      <DashboardStockMix>
        <AvailableStock>sample string 2</AvailableStock>
        <ItemCode>sample string 1</ItemCode>
      </DashboardStockMix>
    </SaleMix>
    <Summary>
      <CompanyPendingAmount>sample string 6</CompanyPendingAmount>
      <CurrentStockAmount>sample string 7</CurrentStockAmount>
      <DSRAmount>sample string 2</DSRAmount>
      <DistributorDueAmount>sample string 5</DistributorDueAmount>
      <OrganicAmount>sample string 3</OrganicAmount>
      <OrganicPercent>sample string 4</OrganicPercent>
      <TotalSaleAmount>sample string 1</TotalSaleAmount>
    </Summary>
    <ToDate>sample string 2</ToDate>
    <TopDistributors>
      <DashboardDistributorRow>
        <AreaName>sample string 7</AreaName>
        <CoverDays>sample string 13</CoverDays>
        <CurrentStockAmount>sample string 12</CurrentStockAmount>
        <DSRAmount>sample string 9</DSRAmount>
        <DistributorCode>sample string 3</DistributorCode>
        <DistributorId>sample string 1</DistributorId>
        <DistributorName>sample string 2</DistributorName>
        <OrganicAmount>sample string 10</OrganicAmount>
        <OrganicPercent>sample string 11</OrganicPercent>
        <SAName>sample string 6</SAName>
        <StockistCode>sample string 4</StockistCode>
        <StockistName>sample string 5</StockistName>
        <TotalSaleAmount>sample string 8</TotalSaleAmount>
      </DashboardDistributorRow>
      <DashboardDistributorRow>
        <AreaName>sample string 7</AreaName>
        <CoverDays>sample string 13</CoverDays>
        <CurrentStockAmount>sample string 12</CurrentStockAmount>
        <DSRAmount>sample string 9</DSRAmount>
        <DistributorCode>sample string 3</DistributorCode>
        <DistributorId>sample string 1</DistributorId>
        <DistributorName>sample string 2</DistributorName>
        <OrganicAmount>sample string 10</OrganicAmount>
        <OrganicPercent>sample string 11</OrganicPercent>
        <SAName>sample string 6</SAName>
        <StockistCode>sample string 4</StockistCode>
        <StockistName>sample string 5</StockistName>
        <TotalSaleAmount>sample string 8</TotalSaleAmount>
      </DashboardDistributorRow>
    </TopDistributors>
  </CDS>
  <StatusCode>1</StatusCode>
  <status>sample string 2</status>
  <statusText>sample string 3</statusText>
</DashboardOverviewResponse>