GET api/Dashboard/GetLowStockReport?FacilityIDs={FacilityIDs}&DepartmentIDs={DepartmentIDs}&StockStatus={StockStatus}&PageSize={PageSize}&PageNumber={PageNumber}

Request Information

URI Parameters

Name	Type	Additional information
FacilityIDs	string	None.
DepartmentIDs	string	None.
StockStatus	string	None.
PageSize	integer	None.
PageNumber	integer	None.

Body Parameters

None.

Response Information

Resource Description

LowStockReportResponseModel

Name	Type	Additional information
Summary	LowStockSummaryDataModel	None.
Rows	Collection of LowStockRowDataModel	None.
Facilities	Collection of FilterOptionDataModel	None.
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "summary": {
    "totalParts": 1,
    "criticalCount": 2,
    "lowCount": 3,
    "overstockedCount": 4,
    "okCount": 5
  },
  "rows": [
    {
      "partsName": "sample string 1",
      "partsCode": "sample string 2",
      "facilityName": "sample string 3",
      "unitOfMeasure": "sample string 4",
      "minStock": 5.0,
      "maxStock": 6.0,
      "qtyOnHand": 7.0,
      "stockStatus": "sample string 8"
    },
    {
      "partsName": "sample string 1",
      "partsCode": "sample string 2",
      "facilityName": "sample string 3",
      "unitOfMeasure": "sample string 4",
      "minStock": 5.0,
      "maxStock": 6.0,
      "qtyOnHand": 7.0,
      "stockStatus": "sample string 8"
    }
  ],
  "facilities": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<LowStockReportResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.DataModel.Dashboard">
  <Code xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">4</Code>
  <Message xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">sample string 2</Message>
  <ReturnID xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">1</ReturnID>
  <Successful xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">true</Successful>
  <TotalRecord xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">5</TotalRecord>
  <Facilities>
    <FilterOptionDataModel>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </FilterOptionDataModel>
    <FilterOptionDataModel>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </FilterOptionDataModel>
  </Facilities>
  <Rows>
    <LowStockRowDataModel>
      <FacilityName>sample string 3</FacilityName>
      <MaxStock>6</MaxStock>
      <MinStock>5</MinStock>
      <PartsCode>sample string 2</PartsCode>
      <PartsName>sample string 1</PartsName>
      <QtyOnHand>7</QtyOnHand>
      <StockStatus>sample string 8</StockStatus>
      <UnitOfMeasure>sample string 4</UnitOfMeasure>
    </LowStockRowDataModel>
    <LowStockRowDataModel>
      <FacilityName>sample string 3</FacilityName>
      <MaxStock>6</MaxStock>
      <MinStock>5</MinStock>
      <PartsCode>sample string 2</PartsCode>
      <PartsName>sample string 1</PartsName>
      <QtyOnHand>7</QtyOnHand>
      <StockStatus>sample string 8</StockStatus>
      <UnitOfMeasure>sample string 4</UnitOfMeasure>
    </LowStockRowDataModel>
  </Rows>
  <Summary>
    <CriticalCount>2</CriticalCount>
    <LowCount>3</LowCount>
    <OkCount>5</OkCount>
    <OverstockedCount>4</OverstockedCount>
    <TotalParts>1</TotalParts>
  </Summary>
</LowStockReportResponseModel>

multipart/form-data

Sample:

<LowStockReportResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ArrowCMMS.Core.DataModel.Dashboard"><Code xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">4</Code><Message xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">sample string 2</Message><ReturnID xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">1</ReturnID><Successful xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">true</Successful><TotalRecord xmlns="http://schemas.datacontract.org/2004/07/Arrow.Core.DataModel">5</TotalRecord><Facilities><FilterOptionDataModel><Id>1</Id><Name>sample string 2</Name></FilterOptionDataModel><FilterOptionDataModel><Id>1</Id><Name>sample string 2</Name></FilterOptionDataModel></Facilities><Rows><LowStockRowDataModel><FacilityName>sample string 3</FacilityName><MaxStock>6</MaxStock><MinStock>5</MinStock><PartsCode>sample string 2</PartsCode><PartsName>sample string 1</PartsName><QtyOnHand>7</QtyOnHand><StockStatus>sample string 8</StockStatus><UnitOfMeasure>sample string 4</UnitOfMeasure></LowStockRowDataModel><LowStockRowDataModel><FacilityName>sample string 3</FacilityName><MaxStock>6</MaxStock><MinStock>5</MinStock><PartsCode>sample string 2</PartsCode><PartsName>sample string 1</PartsName><QtyOnHand>7</QtyOnHand><StockStatus>sample string 8</StockStatus><UnitOfMeasure>sample string 4</UnitOfMeasure></LowStockRowDataModel></Rows><Summary><CriticalCount>2</CriticalCount><LowCount>3</LowCount><OkCount>5</OkCount><OverstockedCount>4</OverstockedCount><TotalParts>1</TotalParts></Summary></LowStockReportResponseModel>