DCLWebService


Click here for a complete list of operations.

GetInventoryOverview

Returns the Inventory Overview.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionID:
Key:
ShortItems:
LessThanMinimum:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/dclwebservice.asmx HTTP/1.1
Host: www.efactory.dclcorp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://dclcorp.com/GetInventoryOverview"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetInventoryOverview xmlns="http://dclcorp.com/">
      <SessionID>string</SessionID>
      <Key>boolean</Key>
      <ShortItems>boolean</ShortItems>
      <LessThanMinimum>boolean</LessThanMinimum>
    </GetInventoryOverview>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetInventoryOverviewResponse xmlns="http://dclcorp.com/">
      <GetInventoryOverviewResult>
        <ResultStatus>
          <Error>int</Error>
          <ErrorStr>string</ErrorStr>
          <SessionID>string</SessionID>
        </ResultStatus>
        <ItemArray>
          <ItemOverviewObject>
            <ItemNumber>string</ItemNumber>
            <Description>string</Description>
            <OpenWO>string</OpenWO>
            <OpenPO>string</OpenPO>
            <OpenRMA>string</OpenRMA>
            <OnDemand>string</OnDemand>
            <OnHand>string</OnHand>
            <OnHold>string</OnHold>
            <Committed>string</Committed>
            <Available>string</Available>
            <InProcess>string</InProcess>
            <NetAvailable>string</NetAvailable>
            <MinimumQuantity>string</MinimumQuantity>
            <DCLQuantity>string</DCLQuantity>
            <Key>boolean</Key>
            <ShortItem>boolean</ShortItem>
            <LessThanMinimum>boolean</LessThanMinimum>
          </ItemOverviewObject>
          <ItemOverviewObject>
            <ItemNumber>string</ItemNumber>
            <Description>string</Description>
            <OpenWO>string</OpenWO>
            <OpenPO>string</OpenPO>
            <OpenRMA>string</OpenRMA>
            <OnDemand>string</OnDemand>
            <OnHand>string</OnHand>
            <OnHold>string</OnHold>
            <Committed>string</Committed>
            <Available>string</Available>
            <InProcess>string</InProcess>
            <NetAvailable>string</NetAvailable>
            <MinimumQuantity>string</MinimumQuantity>
            <DCLQuantity>string</DCLQuantity>
            <Key>boolean</Key>
            <ShortItem>boolean</ShortItem>
            <LessThanMinimum>boolean</LessThanMinimum>
          </ItemOverviewObject>
        </ItemArray>
      </GetInventoryOverviewResult>
    </GetInventoryOverviewResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/dclwebservice.asmx HTTP/1.1
Host: www.efactory.dclcorp.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetInventoryOverview xmlns="http://dclcorp.com/">
      <SessionID>string</SessionID>
      <Key>boolean</Key>
      <ShortItems>boolean</ShortItems>
      <LessThanMinimum>boolean</LessThanMinimum>
    </GetInventoryOverview>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetInventoryOverviewResponse xmlns="http://dclcorp.com/">
      <GetInventoryOverviewResult>
        <ResultStatus>
          <Error>int</Error>
          <ErrorStr>string</ErrorStr>
          <SessionID>string</SessionID>
        </ResultStatus>
        <ItemArray>
          <ItemOverviewObject>
            <ItemNumber>string</ItemNumber>
            <Description>string</Description>
            <OpenWO>string</OpenWO>
            <OpenPO>string</OpenPO>
            <OpenRMA>string</OpenRMA>
            <OnDemand>string</OnDemand>
            <OnHand>string</OnHand>
            <OnHold>string</OnHold>
            <Committed>string</Committed>
            <Available>string</Available>
            <InProcess>string</InProcess>
            <NetAvailable>string</NetAvailable>
            <MinimumQuantity>string</MinimumQuantity>
            <DCLQuantity>string</DCLQuantity>
            <Key>boolean</Key>
            <ShortItem>boolean</ShortItem>
            <LessThanMinimum>boolean</LessThanMinimum>
          </ItemOverviewObject>
          <ItemOverviewObject>
            <ItemNumber>string</ItemNumber>
            <Description>string</Description>
            <OpenWO>string</OpenWO>
            <OpenPO>string</OpenPO>
            <OpenRMA>string</OpenRMA>
            <OnDemand>string</OnDemand>
            <OnHand>string</OnHand>
            <OnHold>string</OnHold>
            <Committed>string</Committed>
            <Available>string</Available>
            <InProcess>string</InProcess>
            <NetAvailable>string</NetAvailable>
            <MinimumQuantity>string</MinimumQuantity>
            <DCLQuantity>string</DCLQuantity>
            <Key>boolean</Key>
            <ShortItem>boolean</ShortItem>
            <LessThanMinimum>boolean</LessThanMinimum>
          </ItemOverviewObject>
        </ItemArray>
      </GetInventoryOverviewResult>
    </GetInventoryOverviewResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /webservices/dclwebservice.asmx/GetInventoryOverview?SessionID=string&Key=string&ShortItems=string&LessThanMinimum=string HTTP/1.1
Host: www.efactory.dclcorp.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<InventoryOverviewObject xmlns="http://dclcorp.com/">
  <ResultStatus>
    <Error>int</Error>
    <ErrorStr>string</ErrorStr>
    <SessionID>string</SessionID>
  </ResultStatus>
  <ItemArray>
    <ItemOverviewObject>
      <ItemNumber>string</ItemNumber>
      <Description>string</Description>
      <OpenWO>string</OpenWO>
      <OpenPO>string</OpenPO>
      <OpenRMA>string</OpenRMA>
      <OnDemand>string</OnDemand>
      <OnHand>string</OnHand>
      <OnHold>string</OnHold>
      <Committed>string</Committed>
      <Available>string</Available>
      <InProcess>string</InProcess>
      <NetAvailable>string</NetAvailable>
      <MinimumQuantity>string</MinimumQuantity>
      <DCLQuantity>string</DCLQuantity>
      <Key>boolean</Key>
      <ShortItem>boolean</ShortItem>
      <LessThanMinimum>boolean</LessThanMinimum>
    </ItemOverviewObject>
    <ItemOverviewObject>
      <ItemNumber>string</ItemNumber>
      <Description>string</Description>
      <OpenWO>string</OpenWO>
      <OpenPO>string</OpenPO>
      <OpenRMA>string</OpenRMA>
      <OnDemand>string</OnDemand>
      <OnHand>string</OnHand>
      <OnHold>string</OnHold>
      <Committed>string</Committed>
      <Available>string</Available>
      <InProcess>string</InProcess>
      <NetAvailable>string</NetAvailable>
      <MinimumQuantity>string</MinimumQuantity>
      <DCLQuantity>string</DCLQuantity>
      <Key>boolean</Key>
      <ShortItem>boolean</ShortItem>
      <LessThanMinimum>boolean</LessThanMinimum>
    </ItemOverviewObject>
  </ItemArray>
</InventoryOverviewObject>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/dclwebservice.asmx/GetInventoryOverview HTTP/1.1
Host: www.efactory.dclcorp.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionID=string&Key=string&ShortItems=string&LessThanMinimum=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<InventoryOverviewObject xmlns="http://dclcorp.com/">
  <ResultStatus>
    <Error>int</Error>
    <ErrorStr>string</ErrorStr>
    <SessionID>string</SessionID>
  </ResultStatus>
  <ItemArray>
    <ItemOverviewObject>
      <ItemNumber>string</ItemNumber>
      <Description>string</Description>
      <OpenWO>string</OpenWO>
      <OpenPO>string</OpenPO>
      <OpenRMA>string</OpenRMA>
      <OnDemand>string</OnDemand>
      <OnHand>string</OnHand>
      <OnHold>string</OnHold>
      <Committed>string</Committed>
      <Available>string</Available>
      <InProcess>string</InProcess>
      <NetAvailable>string</NetAvailable>
      <MinimumQuantity>string</MinimumQuantity>
      <DCLQuantity>string</DCLQuantity>
      <Key>boolean</Key>
      <ShortItem>boolean</ShortItem>
      <LessThanMinimum>boolean</LessThanMinimum>
    </ItemOverviewObject>
    <ItemOverviewObject>
      <ItemNumber>string</ItemNumber>
      <Description>string</Description>
      <OpenWO>string</OpenWO>
      <OpenPO>string</OpenPO>
      <OpenRMA>string</OpenRMA>
      <OnDemand>string</OnDemand>
      <OnHand>string</OnHand>
      <OnHold>string</OnHold>
      <Committed>string</Committed>
      <Available>string</Available>
      <InProcess>string</InProcess>
      <NetAvailable>string</NetAvailable>
      <MinimumQuantity>string</MinimumQuantity>
      <DCLQuantity>string</DCLQuantity>
      <Key>boolean</Key>
      <ShortItem>boolean</ShortItem>
      <LessThanMinimum>boolean</LessThanMinimum>
    </ItemOverviewObject>
  </ItemArray>
</InventoryOverviewObject>