FractusApi Web Service

FractusApi

Click here for a complete list of operations.

InventoryGetAll

Get all inventory

Test

The test form is only available for requests from the local machine.

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 /FractusApi.asmx HTTP/1.1
Host: fractusapi-vscm.azurewebsites.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://VisibleSCM.com/InventoryGetAll"

<?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>
    <InventoryGetAll xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <ClientName>string</ClientName>
      <pagingParameter>
        <Warehouse>string</Warehouse>
        <ExcludeEmpty>boolean</ExcludeEmpty>
        <Filter>string</Filter>
      </pagingParameter>
    </InventoryGetAll>
  </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>
    <InventoryGetAllResponse xmlns="http://VisibleSCM.com/">
      <InventoryGetAllResult>
        <ClientName>string</ClientName>
        <ObjectList>
          <ItemAvailability>
            <ItemAvailID>int</ItemAvailID>
            <ItemID>int</ItemID>
            <WarehouseID>int</WarehouseID>
            <ItemStatusID>int</ItemStatusID>
            <Balance>int</Balance>
            <AlarmBalance>int</AlarmBalance>
            <MSessionID>int</MSessionID>
            <CommittedBalance>int</CommittedBalance>
            <BufferBalance>decimal</BufferBalance>
            <BinLocation>string</BinLocation>
            <Lot>string</Lot>
            <AdjustmentReasonID>Unknown or InvReceive or CycleCount or Allocation or Shipped or ReleaseAllocated or ReturnReceive or Transfer or Damaged or ExpectedAdjustment or ExternallyShipped or Internal or DamagedInternally or DamagedMfg or ReworkToProd or Conversion or CycleCountNegative or TransferNegative or ExpectedAdjustmentNegative or InternalNegative or ConversionNegative or DamagedNegative or DamagedInternallyNegative or DamagedMfgNegative or ReworkToProdNegative or Quarantined or UnQuarantined or ConsumeItem or UnConsumeItem or BuildItem or UnBuildItem or Reserved or UnReserved or Expired</AdjustmentReasonID>
            <LotBalance>int</LotBalance>
            <LotCommitted>int</LotCommitted>
            <AlarmSent>boolean</AlarmSent>
            <DateOutofStock>dateTime</DateOutofStock>
            <AdjustmentNote>string</AdjustmentNote>
            <MasterBalance>int</MasterBalance>
            <QuarantinedBalance>int</QuarantinedBalance>
            <ReservedBalance>int</ReservedBalance>
            <Item xsi:nil="true" />
          </ItemAvailability>
          <ItemAvailability>
            <ItemAvailID>int</ItemAvailID>
            <ItemID>int</ItemID>
            <WarehouseID>int</WarehouseID>
            <ItemStatusID>int</ItemStatusID>
            <Balance>int</Balance>
            <AlarmBalance>int</AlarmBalance>
            <MSessionID>int</MSessionID>
            <CommittedBalance>int</CommittedBalance>
            <BufferBalance>decimal</BufferBalance>
            <BinLocation>string</BinLocation>
            <Lot>string</Lot>
            <AdjustmentReasonID>Unknown or InvReceive or CycleCount or Allocation or Shipped or ReleaseAllocated or ReturnReceive or Transfer or Damaged or ExpectedAdjustment or ExternallyShipped or Internal or DamagedInternally or DamagedMfg or ReworkToProd or Conversion or CycleCountNegative or TransferNegative or ExpectedAdjustmentNegative or InternalNegative or ConversionNegative or DamagedNegative or DamagedInternallyNegative or DamagedMfgNegative or ReworkToProdNegative or Quarantined or UnQuarantined or ConsumeItem or UnConsumeItem or BuildItem or UnBuildItem or Reserved or UnReserved or Expired</AdjustmentReasonID>
            <LotBalance>int</LotBalance>
            <LotCommitted>int</LotCommitted>
            <AlarmSent>boolean</AlarmSent>
            <DateOutofStock>dateTime</DateOutofStock>
            <AdjustmentNote>string</AdjustmentNote>
            <MasterBalance>int</MasterBalance>
            <QuarantinedBalance>int</QuarantinedBalance>
            <ReservedBalance>int</ReservedBalance>
            <Item xsi:nil="true" />
          </ItemAvailability>
        </ObjectList>
        <TotalCount>int</TotalCount>
        <CurrentPage>int</CurrentPage>
        <TotalPages>int</TotalPages>
        <PageSize>int</PageSize>
        <ExecutionTime>long</ExecutionTime>
        <ErrorMessage>string</ErrorMessage>
        <ResultCode>string</ResultCode>
      </InventoryGetAllResult>
    </InventoryGetAllResponse>
  </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 /FractusApi.asmx HTTP/1.1
Host: fractusapi-vscm.azurewebsites.net
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>
    <InventoryGetAll xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <ClientName>string</ClientName>
      <pagingParameter>
        <Warehouse>string</Warehouse>
        <ExcludeEmpty>boolean</ExcludeEmpty>
        <Filter>string</Filter>
      </pagingParameter>
    </InventoryGetAll>
  </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>
    <InventoryGetAllResponse xmlns="http://VisibleSCM.com/">
      <InventoryGetAllResult>
        <ClientName>string</ClientName>
        <ObjectList>
          <ItemAvailability>
            <ItemAvailID>int</ItemAvailID>
            <ItemID>int</ItemID>
            <WarehouseID>int</WarehouseID>
            <ItemStatusID>int</ItemStatusID>
            <Balance>int</Balance>
            <AlarmBalance>int</AlarmBalance>
            <MSessionID>int</MSessionID>
            <CommittedBalance>int</CommittedBalance>
            <BufferBalance>decimal</BufferBalance>
            <BinLocation>string</BinLocation>
            <Lot>string</Lot>
            <AdjustmentReasonID>Unknown or InvReceive or CycleCount or Allocation or Shipped or ReleaseAllocated or ReturnReceive or Transfer or Damaged or ExpectedAdjustment or ExternallyShipped or Internal or DamagedInternally or DamagedMfg or ReworkToProd or Conversion or CycleCountNegative or TransferNegative or ExpectedAdjustmentNegative or InternalNegative or ConversionNegative or DamagedNegative or DamagedInternallyNegative or DamagedMfgNegative or ReworkToProdNegative or Quarantined or UnQuarantined or ConsumeItem or UnConsumeItem or BuildItem or UnBuildItem or Reserved or UnReserved or Expired</AdjustmentReasonID>
            <LotBalance>int</LotBalance>
            <LotCommitted>int</LotCommitted>
            <AlarmSent>boolean</AlarmSent>
            <DateOutofStock>dateTime</DateOutofStock>
            <AdjustmentNote>string</AdjustmentNote>
            <MasterBalance>int</MasterBalance>
            <QuarantinedBalance>int</QuarantinedBalance>
            <ReservedBalance>int</ReservedBalance>
            <Item xsi:nil="true" />
          </ItemAvailability>
          <ItemAvailability>
            <ItemAvailID>int</ItemAvailID>
            <ItemID>int</ItemID>
            <WarehouseID>int</WarehouseID>
            <ItemStatusID>int</ItemStatusID>
            <Balance>int</Balance>
            <AlarmBalance>int</AlarmBalance>
            <MSessionID>int</MSessionID>
            <CommittedBalance>int</CommittedBalance>
            <BufferBalance>decimal</BufferBalance>
            <BinLocation>string</BinLocation>
            <Lot>string</Lot>
            <AdjustmentReasonID>Unknown or InvReceive or CycleCount or Allocation or Shipped or ReleaseAllocated or ReturnReceive or Transfer or Damaged or ExpectedAdjustment or ExternallyShipped or Internal or DamagedInternally or DamagedMfg or ReworkToProd or Conversion or CycleCountNegative or TransferNegative or ExpectedAdjustmentNegative or InternalNegative or ConversionNegative or DamagedNegative or DamagedInternallyNegative or DamagedMfgNegative or ReworkToProdNegative or Quarantined or UnQuarantined or ConsumeItem or UnConsumeItem or BuildItem or UnBuildItem or Reserved or UnReserved or Expired</AdjustmentReasonID>
            <LotBalance>int</LotBalance>
            <LotCommitted>int</LotCommitted>
            <AlarmSent>boolean</AlarmSent>
            <DateOutofStock>dateTime</DateOutofStock>
            <AdjustmentNote>string</AdjustmentNote>
            <MasterBalance>int</MasterBalance>
            <QuarantinedBalance>int</QuarantinedBalance>
            <ReservedBalance>int</ReservedBalance>
            <Item xsi:nil="true" />
          </ItemAvailability>
        </ObjectList>
        <TotalCount>int</TotalCount>
        <CurrentPage>int</CurrentPage>
        <TotalPages>int</TotalPages>
        <PageSize>int</PageSize>
        <ExecutionTime>long</ExecutionTime>
        <ErrorMessage>string</ErrorMessage>
        <ResultCode>string</ResultCode>
      </InventoryGetAllResult>
    </InventoryGetAllResponse>
  </soap12:Body>
</soap12:Envelope>