GET api/audResidential/summary/{GroupBy}?fromDate={fromDate}&toDate={toDate}&WarehouseID={WarehouseID}

Returns residential data for a group by and date range

Request Information

URI Parameters

Name	Description	Type	Additional information
GroupBy	The grouping desired for the return set	string	Required
fromDate	The beginning of the date range to view	date	Required
toDate	The end of the date range to view	date	Required
WarehouseID	The ID of the warehouse to restrict data; -1 for ALL warehouses	integer	Default value is -1

Body Parameters

None.

Response Information

Resource Description

Collection of audResidentialSummary

Name	Type	Additional information
GroupBy	string	None.
GroupByType	string	None.
GroupByID	string	None.
ShipRes	integer	None.
AuditRes	integer	None.
TotalPackages	integer	None.
FactorPercent	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "GroupBy": "sample string 1",
    "GroupByType": "sample string 2",
    "GroupByID": "sample string 3",
    "ShipRes": 4,
    "AuditRes": 5,
    "TotalPackages": 6,
    "FactorPercent": 7.0
  },
  {
    "GroupBy": "sample string 1",
    "GroupByType": "sample string 2",
    "GroupByID": "sample string 3",
    "ShipRes": 4,
    "AuditRes": 5,
    "TotalPackages": 6,
    "FactorPercent": 7.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfaudResidentialSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <audResidentialSummary>
    <AuditRes>5</AuditRes>
    <FactorPercent>7</FactorPercent>
    <GroupBy>sample string 1</GroupBy>
    <GroupByID>sample string 3</GroupByID>
    <GroupByType>sample string 2</GroupByType>
    <ShipRes>4</ShipRes>
    <TotalPackages>6</TotalPackages>
  </audResidentialSummary>
  <audResidentialSummary>
    <AuditRes>5</AuditRes>
    <FactorPercent>7</FactorPercent>
    <GroupBy>sample string 1</GroupBy>
    <GroupByID>sample string 3</GroupByID>
    <GroupByType>sample string 2</GroupByType>
    <ShipRes>4</ShipRes>
    <TotalPackages>6</TotalPackages>
  </audResidentialSummary>
</ArrayOfaudResidentialSummary>