POST api/Report/ROLAnalysis

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DBName	string	None.
BranchInternalCode	string	None.
UserInternalCode	string	None.
BranchCodeList	string	None.
StartDate	integer	None.
EndDate	integer	None.
ItemModelCode	string	None.
ReportBase	string	None.
ColumnsCodeList	string	None.
ColumnsDescList	string	None.
SalesDocumentType	string	None.
BrandCodeList	string	None.
ProductCodeList	string	None.
ProductCategoryCodeList	string	None.
ItemCategoryCodeList	string	None.
ItemClassificationType	string	None.
ItemClassificationList	string	None.
Group1Code	string	None.
Group2Code	string	None.
Group3Code	string	None.
Group1Name	string	None.
Group2Name	string	None.
Group3Name	string	None.
Price	string	None.
CalculateROLBasedOn	string	None.
ShowContributionbasedon	string	None.
NoofDays	integer	None.
AnalysisType	string	None.
Warehouse	string	None.
AddiReqStockMultiplier	string	None.
ShowBranchShortName	boolean	None.
ShowOnlyActivePurchaseOrders	boolean	None.
HidePOObsoletedItemModels	boolean	None.
ShowAvgStockandSalesinDecimals	boolean	None.
ConsiderCalculetedROLwhenitisGreaterthanthedefinedone	boolean	None.
ShowOnlyExcessStock	boolean	None.
ShowOnlyToBeOrderedAvailableItemModel	boolean	None.
ShowOnlyROLAvailableItemModel	boolean	None.
ShowOnlySalesAvailableItemModel	boolean	None.
ShowOnlyStockAvailableItemModel	boolean	None.
IncludeSalesReturn	boolean	None.
SalesReturnDocType	string	None.
DownloadReport	boolean	None.
RemoveColumns	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DBName": "sample string 1",
  "BranchInternalCode": "sample string 2",
  "UserInternalCode": "sample string 3",
  "BranchCodeList": "sample string 4",
  "StartDate": 5,
  "EndDate": 6,
  "ItemModelCode": "sample string 7",
  "ReportBase": "sample string 8",
  "ColumnsCodeList": "sample string 9",
  "ColumnsDescList": "sample string 10",
  "SalesDocumentType": "sample string 11",
  "BrandCodeList": "sample string 12",
  "ProductCodeList": "sample string 13",
  "ProductCategoryCodeList": "sample string 14",
  "ItemCategoryCodeList": "sample string 15",
  "ItemClassificationType": "sample string 16",
  "ItemClassificationList": "sample string 17",
  "Group1Code": "sample string 18",
  "Group2Code": "sample string 19",
  "Group3Code": "sample string 20",
  "Group1Name": "sample string 21",
  "Group2Name": "sample string 22",
  "Group3Name": "sample string 23",
  "Price": "sample string 24",
  "CalculateROLBasedOn": "sample string 25",
  "ShowContributionbasedon": "sample string 26",
  "NoofDays": 27,
  "AnalysisType": "sample string 28",
  "Warehouse": "sample string 29",
  "AddiReqStockMultiplier": "sample string 30",
  "ShowBranchShortName": true,
  "ShowOnlyActivePurchaseOrders": true,
  "HidePOObsoletedItemModels": true,
  "ShowAvgStockandSalesinDecimals": true,
  "ConsiderCalculetedROLwhenitisGreaterthanthedefinedone": true,
  "ShowOnlyExcessStock": true,
  "ShowOnlyToBeOrderedAvailableItemModel": true,
  "ShowOnlyROLAvailableItemModel": true,
  "ShowOnlySalesAvailableItemModel": true,
  "ShowOnlyStockAvailableItemModel": true,
  "IncludeSalesReturn": true,
  "SalesReturnDocType": "sample string 42",
  "DownloadReport": true,
  "RemoveColumns": "sample string 44"
}

application/xml, text/xml

Sample:

<ROLAnalysisInputs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APXWebLibDataProvider.Models.Reports">
  <AddiReqStockMultiplier>sample string 30</AddiReqStockMultiplier>
  <AnalysisType>sample string 28</AnalysisType>
  <BranchCodeList>sample string 4</BranchCodeList>
  <BranchInternalCode>sample string 2</BranchInternalCode>
  <BrandCodeList>sample string 12</BrandCodeList>
  <CalculateROLBasedOn>sample string 25</CalculateROLBasedOn>
  <ColumnsCodeList>sample string 9</ColumnsCodeList>
  <ColumnsDescList>sample string 10</ColumnsDescList>
  <ConsiderCalculetedROLwhenitisGreaterthanthedefinedone>true</ConsiderCalculetedROLwhenitisGreaterthanthedefinedone>
  <DBName>sample string 1</DBName>
  <DownloadReport>true</DownloadReport>
  <EndDate>6</EndDate>
  <Group1Code>sample string 18</Group1Code>
  <Group1Name>sample string 21</Group1Name>
  <Group2Code>sample string 19</Group2Code>
  <Group2Name>sample string 22</Group2Name>
  <Group3Code>sample string 20</Group3Code>
  <Group3Name>sample string 23</Group3Name>
  <HidePOObsoletedItemModels>true</HidePOObsoletedItemModels>
  <IncludeSalesReturn>true</IncludeSalesReturn>
  <ItemCategoryCodeList>sample string 15</ItemCategoryCodeList>
  <ItemClassificationList>sample string 17</ItemClassificationList>
  <ItemClassificationType>sample string 16</ItemClassificationType>
  <ItemModelCode>sample string 7</ItemModelCode>
  <NoofDays>27</NoofDays>
  <Price>sample string 24</Price>
  <ProductCategoryCodeList>sample string 14</ProductCategoryCodeList>
  <ProductCodeList>sample string 13</ProductCodeList>
  <RemoveColumns>sample string 44</RemoveColumns>
  <ReportBase>sample string 8</ReportBase>
  <SalesDocumentType>sample string 11</SalesDocumentType>
  <SalesReturnDocType>sample string 42</SalesReturnDocType>
  <ShowAvgStockandSalesinDecimals>true</ShowAvgStockandSalesinDecimals>
  <ShowBranchShortName>true</ShowBranchShortName>
  <ShowContributionbasedon>sample string 26</ShowContributionbasedon>
  <ShowOnlyActivePurchaseOrders>true</ShowOnlyActivePurchaseOrders>
  <ShowOnlyExcessStock>true</ShowOnlyExcessStock>
  <ShowOnlyROLAvailableItemModel>true</ShowOnlyROLAvailableItemModel>
  <ShowOnlySalesAvailableItemModel>true</ShowOnlySalesAvailableItemModel>
  <ShowOnlyStockAvailableItemModel>true</ShowOnlyStockAvailableItemModel>
  <ShowOnlyToBeOrderedAvailableItemModel>true</ShowOnlyToBeOrderedAvailableItemModel>
  <StartDate>5</StartDate>
  <UserInternalCode>sample string 3</UserInternalCode>
  <Warehouse>sample string 29</Warehouse>
</ROLAnalysisInputs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.