GET api/audDashboard/residential/{GroupBy}?FromDate={FromDate}&ToDate={ToDate}

Request Information

URI Parameters

Name	Type	Additional information
GroupBy	string	Required
FromDate	date	Required
ToDate	date	Required

Body Parameters

None.

Response Information

Resource Description

audPackageDb

Name	Type	Additional information
PackageID	integer	None.
ShipPackageID	integer	None.
WorldLinkPackageID	integer	None.
WorldLinkShipmentID	integer	None.
ImportPackageID	integer	Required
ImportBatchID	integer	Required
AuditCarrierID	integer	Required
AuditServiceCode1	string	Max length: 50
AuditServiceCode2	string	Max length: 50
TrackingNumber	string	Required Max length: 50
OldTrackingNumber	string	Max length: 50
ReferenceNumber	string	Max length: 50
ReferenceNumber2	string	Max length: 50
ReferenceNumber3	string	Max length: 50
CarrierName	string	Max length: 50
DateShipped	date	None.
DateDelivered	date	None.
TimeDelivered	integer	None.
DateAttemptedDelivery	date	None.
TimeAttemptedDelivery	integer	None.
ScheduledDeliveryDate	date	None.
DaysInTransit	integer	None.
ShipperName	string	Max length: 50
ShipperCompany	string	Max length: 50
ShipperAddress1	string	Max length: 50
ShipperAddress2	string	Max length: 50
ShipperCity	string	Max length: 50
ShipperStateProvince	string	Max length: 50
ShipperPostalCode	string	Max length: 50
ShipperCountry	string	Max length: 50
ConsigneeName	string	Max length: 50
ConsigneeCompany	string	Max length: 50
ConsigneeAddress1	string	Max length: 50
ConsigneeAddress2	string	Max length: 50
ConsigneeCity	string	Max length: 50
ConsigneeStateProvince	string	Max length: 50
ConsigneePostalCode	string	Max length: 50
ConsigneeCountry	string	Max length: 50
OriginalConsigneeAddress1	string	Max length: 50
OriginalConsigneeAddress2	string	Max length: 50
OriginalConsigneeCity	string	Max length: 50
OriginalConsigneeStateProvince	string	Max length: 50
OriginalConsigneePostalCode	string	Max length: 50
ServiceDescription	string	Max length: 50
PaymentType	string	Max length: 20
Zone	string	Max length: 10
PackageNumber	integer	None.
PackageCount	integer	None.
BilledWeight	decimal number	None.
ActualWeight	decimal number	None.
ShippedWeight	decimal number	None.
Length	integer	None.
Width	integer	None.
Height	integer	None.
DimFactor	integer	None.
NetCharges	decimal number	None.
BaseFreight	decimal number	None.
AccessorialFreight	decimal number	None.
TotalFreight	decimal number	None.
PublishedFreight	decimal number	None.
DeclaredValue	decimal number	None.
BillingType	string	Max length: 10
SignedBy	string	Max length: 50
BillToAccount	string	Max length: 50
FuelPercent	decimal number	None.
ShipRES	boolean	None.
AuditRES	boolean	None.
CreatedBy	integer	None.
CreatedDate	date	None.
UpdatedBy	integer	None.
UpdatedDate	date	None.
AuditWeightDimFlag	integer	None.
AuditVASFlag	integer	None.
AuditMarginPct	decimal number	None.
ShippingServiceCode	string	None.
ShipClientID	integer	None.
ShipClientShortName	string	None.
ShipWarehouseID	integer	None.
ShipOrderID	integer	None.
ShipWarehouseCode	string	None.
CarrierNameShip	string	None.
Manifestor	string	None.
ChargedClient	decimal number	None.
BilledByCarrier	decimal number	None.
ShipState	string	None.
results	Collection of ValidationResult	None.

Response Formats

application/json, text/json

Sample:

{
  "results": null,
  "PackageID": 1,
  "ShipPackageID": 1,
  "WorldLinkPackageID": 1,
  "WorldLinkShipmentID": 1,
  "ImportPackageID": 2,
  "ImportBatchID": 3,
  "AuditCarrierID": 4,
  "AuditServiceCode1": "sample string 5",
  "AuditServiceCode2": "sample string 6",
  "TrackingNumber": "sample string 7",
  "OldTrackingNumber": "sample string 8",
  "ReferenceNumber": "sample string 9",
  "ReferenceNumber2": "sample string 10",
  "ReferenceNumber3": "sample string 11",
  "CarrierName": "sample string 12",
  "DateShipped": "2026-04-03T21:38:41.6703194-07:00",
  "DateDelivered": "2026-04-03T21:38:41.6703194-07:00",
  "TimeDelivered": 1,
  "DateAttemptedDelivery": "2026-04-03T21:38:41.6703194-07:00",
  "TimeAttemptedDelivery": 1,
  "ScheduledDeliveryDate": "2026-04-03T21:38:41.6703194-07:00",
  "DaysInTransit": 1,
  "ShipperName": "sample string 13",
  "ShipperCompany": "sample string 14",
  "ShipperAddress1": "sample string 15",
  "ShipperAddress2": "sample string 16",
  "ShipperCity": "sample string 17",
  "ShipperStateProvince": "sample string 18",
  "ShipperPostalCode": "sample string 19",
  "ShipperCountry": "sample string 20",
  "ConsigneeName": "sample string 21",
  "ConsigneeCompany": "sample string 22",
  "ConsigneeAddress1": "sample string 23",
  "ConsigneeAddress2": "sample string 24",
  "ConsigneeCity": "sample string 25",
  "ConsigneeStateProvince": "sample string 26",
  "ConsigneePostalCode": "sample string 27",
  "ConsigneeCountry": "sample string 28",
  "OriginalConsigneeAddress1": "sample string 29",
  "OriginalConsigneeAddress2": "sample string 30",
  "OriginalConsigneeCity": "sample string 31",
  "OriginalConsigneeStateProvince": "sample string 32",
  "OriginalConsigneePostalCode": "sample string 33",
  "ServiceDescription": "sample string 34",
  "PaymentType": "sample string 35",
  "Zone": "sample string 36",
  "PackageNumber": 1,
  "PackageCount": 1,
  "BilledWeight": 1.0,
  "ActualWeight": 1.0,
  "ShippedWeight": 1.0,
  "Length": 1,
  "Width": 1,
  "Height": 1,
  "DimFactor": 1,
  "NetCharges": 1.0,
  "BaseFreight": 1.0,
  "AccessorialFreight": 1.0,
  "TotalFreight": 1.0,
  "PublishedFreight": 1.0,
  "DeclaredValue": 1.0,
  "BillingType": "sample string 37",
  "SignedBy": "sample string 38",
  "BillToAccount": "sample string 39",
  "FuelPercent": 1.0,
  "ShipRES": true,
  "AuditRES": true,
  "CreatedBy": 40,
  "CreatedDate": "2026-04-03T21:38:41.6703194-07:00",
  "UpdatedBy": 42,
  "UpdatedDate": "2026-04-03T21:38:41.6703194-07:00",
  "AuditWeightDimFlag": 44,
  "AuditVASFlag": 45,
  "AuditMarginPct": 46.0,
  "ShippingServiceCode": "sample string 47",
  "ShipClientID": 1,
  "ShipClientShortName": "sample string 48",
  "ShipWarehouseID": 49,
  "ShipOrderID": 50,
  "ShipWarehouseCode": "sample string 51",
  "CarrierNameShip": "sample string 52",
  "Manifestor": "sample string 53",
  "ChargedClient": 54.0,
  "BilledByCarrier": 55.0,
  "ShipState": "sample string 56"
}

application/xml, text/xml

Sample:

<audPackageDb xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <AccessorialFreight>1</AccessorialFreight>
  <ActualWeight>1</ActualWeight>
  <AuditCarrierID>4</AuditCarrierID>
  <AuditMarginPct>46</AuditMarginPct>
  <AuditRES>true</AuditRES>
  <AuditServiceCode1>sample string 5</AuditServiceCode1>
  <AuditServiceCode2>sample string 6</AuditServiceCode2>
  <AuditVASFlag>45</AuditVASFlag>
  <AuditWeightDimFlag>44</AuditWeightDimFlag>
  <BaseFreight>1</BaseFreight>
  <BillToAccount>sample string 39</BillToAccount>
  <BilledByCarrier>55</BilledByCarrier>
  <BilledWeight>1</BilledWeight>
  <BillingType>sample string 37</BillingType>
  <CarrierName>sample string 12</CarrierName>
  <CarrierNameShip>sample string 52</CarrierNameShip>
  <ChargedClient>54</ChargedClient>
  <ConsigneeAddress1>sample string 23</ConsigneeAddress1>
  <ConsigneeAddress2>sample string 24</ConsigneeAddress2>
  <ConsigneeCity>sample string 25</ConsigneeCity>
  <ConsigneeCompany>sample string 22</ConsigneeCompany>
  <ConsigneeCountry>sample string 28</ConsigneeCountry>
  <ConsigneeName>sample string 21</ConsigneeName>
  <ConsigneePostalCode>sample string 27</ConsigneePostalCode>
  <ConsigneeStateProvince>sample string 26</ConsigneeStateProvince>
  <CreatedBy>40</CreatedBy>
  <CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:38:41.6703194Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </CreatedDate>
  <DateAttemptedDelivery>2026-04-03T21:38:41.6703194-07:00</DateAttemptedDelivery>
  <DateDelivered>2026-04-03T21:38:41.6703194-07:00</DateDelivered>
  <DateShipped>2026-04-03T21:38:41.6703194-07:00</DateShipped>
  <DaysInTransit>1</DaysInTransit>
  <DeclaredValue>1</DeclaredValue>
  <DimFactor>1</DimFactor>
  <FuelPercent>1</FuelPercent>
  <Height>1</Height>
  <ImportBatchID>3</ImportBatchID>
  <ImportPackageID>2</ImportPackageID>
  <Length>1</Length>
  <Manifestor>sample string 53</Manifestor>
  <NetCharges>1</NetCharges>
  <OldTrackingNumber>sample string 8</OldTrackingNumber>
  <OriginalConsigneeAddress1>sample string 29</OriginalConsigneeAddress1>
  <OriginalConsigneeAddress2>sample string 30</OriginalConsigneeAddress2>
  <OriginalConsigneeCity>sample string 31</OriginalConsigneeCity>
  <OriginalConsigneePostalCode>sample string 33</OriginalConsigneePostalCode>
  <OriginalConsigneeStateProvince>sample string 32</OriginalConsigneeStateProvince>
  <PackageCount>1</PackageCount>
  <PackageID>1</PackageID>
  <PackageNumber>1</PackageNumber>
  <PaymentType>sample string 35</PaymentType>
  <PublishedFreight>1</PublishedFreight>
  <ReferenceNumber>sample string 9</ReferenceNumber>
  <ReferenceNumber2>sample string 10</ReferenceNumber2>
  <ReferenceNumber3>sample string 11</ReferenceNumber3>
  <ScheduledDeliveryDate>2026-04-03T21:38:41.6703194-07:00</ScheduledDeliveryDate>
  <ServiceDescription>sample string 34</ServiceDescription>
  <ShipClientID>1</ShipClientID>
  <ShipClientShortName>sample string 48</ShipClientShortName>
  <ShipOrderID>50</ShipOrderID>
  <ShipPackageID>1</ShipPackageID>
  <ShipRES>true</ShipRES>
  <ShipState>sample string 56</ShipState>
  <ShipWarehouseCode>sample string 51</ShipWarehouseCode>
  <ShipWarehouseID>49</ShipWarehouseID>
  <ShippedWeight>1</ShippedWeight>
  <ShipperAddress1>sample string 15</ShipperAddress1>
  <ShipperAddress2>sample string 16</ShipperAddress2>
  <ShipperCity>sample string 17</ShipperCity>
  <ShipperCompany>sample string 14</ShipperCompany>
  <ShipperCountry>sample string 20</ShipperCountry>
  <ShipperName>sample string 13</ShipperName>
  <ShipperPostalCode>sample string 19</ShipperPostalCode>
  <ShipperStateProvince>sample string 18</ShipperStateProvince>
  <ShippingServiceCode>sample string 47</ShippingServiceCode>
  <SignedBy>sample string 38</SignedBy>
  <TimeAttemptedDelivery>1</TimeAttemptedDelivery>
  <TimeDelivered>1</TimeDelivered>
  <TotalFreight>1</TotalFreight>
  <TrackingNumber>sample string 7</TrackingNumber>
  <UpdatedBy>42</UpdatedBy>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-04-04T04:38:41.6703194Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-420</d2p1:OffsetMinutes>
  </UpdatedDate>
  <Width>1</Width>
  <WorldLinkPackageID>1</WorldLinkPackageID>
  <WorldLinkShipmentID>1</WorldLinkShipmentID>
  <Zone>sample string 36</Zone>
</audPackageDb>