POST api/tonnage/GetTonnageReportData
Request Information
URI Parameters
None.
Body Parameters
TonnageCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| State | string |
None. |
|
| BeginDate | date |
None. |
|
| EndDate | date |
None. |
|
| IncludeSalesGT | decimal number |
None. |
|
| ItemClassCodes | Collection of string |
None. |
|
| Categories | Collection of string |
None. |
|
| SearchStr | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"State": "sample string 1",
"BeginDate": "2026-11-21T05:35:41.6438178+00:00",
"EndDate": "2026-11-21T05:35:41.6438178+00:00",
"IncludeSalesGT": 4.1,
"ItemClassCodes": [
"sample string 1",
"sample string 2"
],
"Categories": [
"sample string 1",
"sample string 2"
],
"SearchStr": "sample string 5"
}
application/xml, text/xml
Sample:
<TonnageReportingModels.TonnageCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
<BeginDate>2026-11-21T05:35:41.6438178+00:00</BeginDate>
<Categories xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Categories>
<EndDate>2026-11-21T05:35:41.6438178+00:00</EndDate>
<IncludeSalesGT>4.1</IncludeSalesGT>
<ItemClassCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ItemClassCodes>
<SearchStr>sample string 5</SearchStr>
<State>sample string 1</State>
</TonnageReportingModels.TonnageCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
TonnageReportWrapper| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseStatus | string |
None. |
|
| ValidationMessages | Collection of string |
None. |
|
| Warnings | Collection of string |
None. |
|
| BusinessRuleViolations | Collection of string |
None. |
|
| ErrorWrappers | Collection of ErrorWrapper |
None. |
|
| GridSummary | string |
None. |
|
| AdditionalData | Object |
None. |
|
| Data | Collection of TonnageData |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseStatus": "sample string 1",
"ValidationMessages": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
],
"BusinessRuleViolations": [
"sample string 1",
"sample string 2"
],
"ErrorWrappers": [
{
"ErrorMessage": "sample string 1",
"ErrorCode": "sample string 2",
"AdditionalInformation": "sample string 3"
},
{
"ErrorMessage": "sample string 1",
"ErrorCode": "sample string 2",
"AdditionalInformation": "sample string 3"
}
],
"GridSummary": "sample string 2",
"AdditionalData": {},
"Data": [
{
"State": "sample string 1",
"County": "sample string 2",
"CountyNmbr": "sample string 3",
"MatCode": "sample string 4",
"Analysis": "sample string 5",
"DocDate": "2026-11-21T05:35:41.663939+00:00",
"DocNmbr": "sample string 7",
"ItemNmbr": "sample string 8",
"ItemDesc": "sample string 9",
"Qty": 10.1,
"UofM": "sample string 11",
"QtyTons": 12.1,
"NonConvertible": true,
"ItemClass": "sample string 14",
"Category": "sample string 15",
"Bulk": true,
"Bag": true,
"Liquid": true,
"UseCode": "sample string 19",
"CustNmbr": "sample string 20",
"CustName": "sample string 21",
"CustCSZ": "sample string 22",
"Ca": 23.1,
"Mg": 24.1,
"S": 25.1,
"Fe": 26.1,
"Mn": 27.1,
"Si": 28.1,
"B": 29.1,
"Zn": 30.1,
"Cu": 31.1,
"Mo": 32.1,
"SpargeType": "sample string 33",
"EpaNumber": "sample string 34",
"EPADesc": "sample string 35"
},
{
"State": "sample string 1",
"County": "sample string 2",
"CountyNmbr": "sample string 3",
"MatCode": "sample string 4",
"Analysis": "sample string 5",
"DocDate": "2026-11-21T05:35:41.663939+00:00",
"DocNmbr": "sample string 7",
"ItemNmbr": "sample string 8",
"ItemDesc": "sample string 9",
"Qty": 10.1,
"UofM": "sample string 11",
"QtyTons": 12.1,
"NonConvertible": true,
"ItemClass": "sample string 14",
"Category": "sample string 15",
"Bulk": true,
"Bag": true,
"Liquid": true,
"UseCode": "sample string 19",
"CustNmbr": "sample string 20",
"CustName": "sample string 21",
"CustCSZ": "sample string 22",
"Ca": 23.1,
"Mg": 24.1,
"S": 25.1,
"Fe": 26.1,
"Mn": 27.1,
"Si": 28.1,
"B": 29.1,
"Zn": 30.1,
"Cu": 31.1,
"Mo": 32.1,
"SpargeType": "sample string 33",
"EpaNumber": "sample string 34",
"EPADesc": "sample string 35"
}
]
}
application/xml, text/xml
Sample:
<TonnageReportingModels.TonnageReportWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
<AdditionalData />
<BusinessRuleViolations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</BusinessRuleViolations>
<Data>
<TonnageReportingModels.TonnageData>
<Analysis>sample string 5</Analysis>
<B>29.1</B>
<Bag>true</Bag>
<Bulk>true</Bulk>
<Ca>23.1</Ca>
<Category>sample string 15</Category>
<County>sample string 2</County>
<CountyNmbr>sample string 3</CountyNmbr>
<Cu>31.1</Cu>
<CustCSZ>sample string 22</CustCSZ>
<CustName>sample string 21</CustName>
<CustNmbr>sample string 20</CustNmbr>
<DocDate>2026-11-21T05:35:41.663939+00:00</DocDate>
<DocNmbr>sample string 7</DocNmbr>
<EPADesc>sample string 35</EPADesc>
<EpaNumber>sample string 34</EpaNumber>
<Fe>26.1</Fe>
<ItemClass>sample string 14</ItemClass>
<ItemDesc>sample string 9</ItemDesc>
<ItemNmbr>sample string 8</ItemNmbr>
<Liquid>true</Liquid>
<MatCode>sample string 4</MatCode>
<Mg>24.1</Mg>
<Mn>27.1</Mn>
<Mo>32.1</Mo>
<NonConvertible>true</NonConvertible>
<Qty>10.1</Qty>
<QtyTons>12.1</QtyTons>
<S>25.1</S>
<Si>28.1</Si>
<SpargeType>sample string 33</SpargeType>
<State>sample string 1</State>
<UofM>sample string 11</UofM>
<UseCode>sample string 19</UseCode>
<Zn>30.1</Zn>
</TonnageReportingModels.TonnageData>
<TonnageReportingModels.TonnageData>
<Analysis>sample string 5</Analysis>
<B>29.1</B>
<Bag>true</Bag>
<Bulk>true</Bulk>
<Ca>23.1</Ca>
<Category>sample string 15</Category>
<County>sample string 2</County>
<CountyNmbr>sample string 3</CountyNmbr>
<Cu>31.1</Cu>
<CustCSZ>sample string 22</CustCSZ>
<CustName>sample string 21</CustName>
<CustNmbr>sample string 20</CustNmbr>
<DocDate>2026-11-21T05:35:41.663939+00:00</DocDate>
<DocNmbr>sample string 7</DocNmbr>
<EPADesc>sample string 35</EPADesc>
<EpaNumber>sample string 34</EpaNumber>
<Fe>26.1</Fe>
<ItemClass>sample string 14</ItemClass>
<ItemDesc>sample string 9</ItemDesc>
<ItemNmbr>sample string 8</ItemNmbr>
<Liquid>true</Liquid>
<MatCode>sample string 4</MatCode>
<Mg>24.1</Mg>
<Mn>27.1</Mn>
<Mo>32.1</Mo>
<NonConvertible>true</NonConvertible>
<Qty>10.1</Qty>
<QtyTons>12.1</QtyTons>
<S>25.1</S>
<Si>28.1</Si>
<SpargeType>sample string 33</SpargeType>
<State>sample string 1</State>
<UofM>sample string 11</UofM>
<UseCode>sample string 19</UseCode>
<Zn>30.1</Zn>
</TonnageReportingModels.TonnageData>
</Data>
<ErrorWrappers>
<ErrorWrapper>
<AdditionalInformation>sample string 3</AdditionalInformation>
<ErrorCode>sample string 2</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</ErrorWrapper>
<ErrorWrapper>
<AdditionalInformation>sample string 3</AdditionalInformation>
<ErrorCode>sample string 2</ErrorCode>
<ErrorMessage>sample string 1</ErrorMessage>
</ErrorWrapper>
</ErrorWrappers>
<GridSummary>sample string 2</GridSummary>
<ResponseStatus>sample string 1</ResponseStatus>
<ValidationMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ValidationMessages>
<Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Warnings>
</TonnageReportingModels.TonnageReportWrapper>