POST api/HCS/GetOHSummary
Request Information
URI Parameters
None.
Body Parameters
HCSOHCriteriaName | Description | Type | Additional information |
---|---|---|---|
ReportMonth | string |
None. |
|
LineName | string |
None. |
|
ItemNmbr | string |
None. |
|
Overhead | string |
None. |
|
PagingStart | integer |
None. |
|
NumRecs | integer |
None. |
|
SortFieldName | string |
None. |
|
SortDirection | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "ReportMonth": "sample string 1", "LineName": "sample string 2", "ItemNmbr": "sample string 3", "Overhead": "sample string 4", "PagingStart": 1, "NumRecs": 1, "SortFieldName": "sample string 5", "SortDirection": "sample string 6" }
application/xml, text/xml
Sample:
<HCSOHCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs"> <ItemNmbr>sample string 3</ItemNmbr> <LineName>sample string 2</LineName> <NumRecs>1</NumRecs> <Overhead>sample string 4</Overhead> <PagingStart>1</PagingStart> <ReportMonth>sample string 1</ReportMonth> <SortDirection>sample string 6</SortDirection> <SortFieldName>sample string 5</SortFieldName> </HCSOHCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of HCSOHResultsName | Description | Type | Additional information |
---|---|---|---|
LineName | string |
None. |
|
ITEMNMBR | string |
None. |
|
ITEMDESC | string |
None. |
|
TotalTons | decimal number |
None. |
|
RawTotalDollars | decimal number |
None. |
|
OHTotalDollars | decimal number |
None. |
|
ShrinkTotalDollars | decimal number |
None. |
|
AVGOHRate | decimal number |
None. |
|
AVGShrinkRate | decimal number |
None. |
|
AVGRawCost | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[ { "LineName": "sample string 1", "ITEMNMBR": "sample string 2", "ITEMDESC": "sample string 3", "TotalTons": 4.1, "RawTotalDollars": 5.1, "OHTotalDollars": 6.1, "ShrinkTotalDollars": 7.1, "AVGOHRate": 1.49, "AVGShrinkRate": 139.22, "AVGRawCost": 1.24 }, { "LineName": "sample string 1", "ITEMNMBR": "sample string 2", "ITEMDESC": "sample string 3", "TotalTons": 4.1, "RawTotalDollars": 5.1, "OHTotalDollars": 6.1, "ShrinkTotalDollars": 7.1, "AVGOHRate": 1.49, "AVGShrinkRate": 139.22, "AVGRawCost": 1.24 } ]
application/xml, text/xml
Sample:
<ArrayOfHCSOHResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs"> <HCSOHResults> <AVGOHRate>1.49</AVGOHRate> <AVGRawCost>1.24</AVGRawCost> <AVGShrinkRate>139.22</AVGShrinkRate> <ITEMDESC>sample string 3</ITEMDESC> <ITEMNMBR>sample string 2</ITEMNMBR> <LineName>sample string 1</LineName> <OHTotalDollars>6.1</OHTotalDollars> <RawTotalDollars>5.1</RawTotalDollars> <ShrinkTotalDollars>7.1</ShrinkTotalDollars> <TotalTons>4.1</TotalTons> </HCSOHResults> <HCSOHResults> <AVGOHRate>1.49</AVGOHRate> <AVGRawCost>1.24</AVGRawCost> <AVGShrinkRate>139.22</AVGShrinkRate> <ITEMDESC>sample string 3</ITEMDESC> <ITEMNMBR>sample string 2</ITEMNMBR> <LineName>sample string 1</LineName> <OHTotalDollars>6.1</OHTotalDollars> <RawTotalDollars>5.1</RawTotalDollars> <ShrinkTotalDollars>7.1</ShrinkTotalDollars> <TotalTons>4.1</TotalTons> </HCSOHResults> </ArrayOfHCSOHResults>