FractusApi Web Service

FractusApi

Click here for a complete list of operations.

JobAddToQueue

Add a job to the queue

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/JobAddToQueue"

<?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>
    <JobAddToQueue xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <ClientName>string</ClientName>
      <Job>
        <JobLogID>int</JobLogID>
        <JobType>Unknown or OrderImport or DepricatedProcessOrders or ShippingInformationImportFromCarrier or PrintPackslips or TrackingNumberExport or OrderImportAndProcess or EODReport or ProcessOrders or ProcessBackorders or UpdateDeliveryInfo or MassMail or InventoryFulfillment</JobType>
        <JobStatus>Unknown or Queued or Processing or Finished or Archived or Failed or Starting</JobStatus>
        <JobProcessed>string</JobProcessed>
        <FileName>string</FileName>
        <JobParams>string</JobParams>
        <JobStartDate>dateTime</JobStartDate>
        <JobEndDate>dateTime</JobEndDate>
        <TotalRecs>int</TotalRecs>
        <ErrorRecs>int</ErrorRecs>
        <SuccessfulRecs>int</SuccessfulRecs>
        <RequestingUserID>int</RequestingUserID>
        <JobSteps>int</JobSteps>
        <JobStepPercent>int</JobStepPercent>
        <JobPercent>int</JobPercent>
        <JobStatusStr>string</JobStatusStr>
        <CurJobStep>int</CurJobStep>
        <FilePath>string</FilePath>
        <RecsProcessed>int</RecsProcessed>
        <StatusDescription>string</StatusDescription>
        <FileType>string</FileType>
        <SendEmailOnFinish>string</SendEmailOnFinish>
        <JobOrders>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
        </JobOrders>
      </Job>
    </JobAddToQueue>
  </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>
    <JobAddToQueueResponse xmlns="http://VisibleSCM.com/">
      <JobAddToQueueResult>
        <JobLogID>int</JobLogID>
        <JobType>Unknown or OrderImport or DepricatedProcessOrders or ShippingInformationImportFromCarrier or PrintPackslips or TrackingNumberExport or OrderImportAndProcess or EODReport or ProcessOrders or ProcessBackorders or UpdateDeliveryInfo or MassMail or InventoryFulfillment</JobType>
        <JobStatus>Unknown or Queued or Processing or Finished or Archived or Failed or Starting</JobStatus>
        <JobProcessed>string</JobProcessed>
        <FileName>string</FileName>
        <JobParams>string</JobParams>
        <JobStartDate>dateTime</JobStartDate>
        <JobEndDate>dateTime</JobEndDate>
        <TotalRecs>int</TotalRecs>
        <ErrorRecs>int</ErrorRecs>
        <SuccessfulRecs>int</SuccessfulRecs>
        <RequestingUserID>int</RequestingUserID>
        <JobSteps>int</JobSteps>
        <JobStepPercent>int</JobStepPercent>
        <JobPercent>int</JobPercent>
        <JobStatusStr>string</JobStatusStr>
        <CurJobStep>int</CurJobStep>
        <FilePath>string</FilePath>
        <RecsProcessed>int</RecsProcessed>
        <StatusDescription>string</StatusDescription>
        <FileType>string</FileType>
        <SendEmailOnFinish>string</SendEmailOnFinish>
        <JobOrders>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
        </JobOrders>
      </JobAddToQueueResult>
    </JobAddToQueueResponse>
  </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>
    <JobAddToQueue xmlns="http://VisibleSCM.com/">
      <SecurityToken>string</SecurityToken>
      <ClientName>string</ClientName>
      <Job>
        <JobLogID>int</JobLogID>
        <JobType>Unknown or OrderImport or DepricatedProcessOrders or ShippingInformationImportFromCarrier or PrintPackslips or TrackingNumberExport or OrderImportAndProcess or EODReport or ProcessOrders or ProcessBackorders or UpdateDeliveryInfo or MassMail or InventoryFulfillment</JobType>
        <JobStatus>Unknown or Queued or Processing or Finished or Archived or Failed or Starting</JobStatus>
        <JobProcessed>string</JobProcessed>
        <FileName>string</FileName>
        <JobParams>string</JobParams>
        <JobStartDate>dateTime</JobStartDate>
        <JobEndDate>dateTime</JobEndDate>
        <TotalRecs>int</TotalRecs>
        <ErrorRecs>int</ErrorRecs>
        <SuccessfulRecs>int</SuccessfulRecs>
        <RequestingUserID>int</RequestingUserID>
        <JobSteps>int</JobSteps>
        <JobStepPercent>int</JobStepPercent>
        <JobPercent>int</JobPercent>
        <JobStatusStr>string</JobStatusStr>
        <CurJobStep>int</CurJobStep>
        <FilePath>string</FilePath>
        <RecsProcessed>int</RecsProcessed>
        <StatusDescription>string</StatusDescription>
        <FileType>string</FileType>
        <SendEmailOnFinish>string</SendEmailOnFinish>
        <JobOrders>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
        </JobOrders>
      </Job>
    </JobAddToQueue>
  </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>
    <JobAddToQueueResponse xmlns="http://VisibleSCM.com/">
      <JobAddToQueueResult>
        <JobLogID>int</JobLogID>
        <JobType>Unknown or OrderImport or DepricatedProcessOrders or ShippingInformationImportFromCarrier or PrintPackslips or TrackingNumberExport or OrderImportAndProcess or EODReport or ProcessOrders or ProcessBackorders or UpdateDeliveryInfo or MassMail or InventoryFulfillment</JobType>
        <JobStatus>Unknown or Queued or Processing or Finished or Archived or Failed or Starting</JobStatus>
        <JobProcessed>string</JobProcessed>
        <FileName>string</FileName>
        <JobParams>string</JobParams>
        <JobStartDate>dateTime</JobStartDate>
        <JobEndDate>dateTime</JobEndDate>
        <TotalRecs>int</TotalRecs>
        <ErrorRecs>int</ErrorRecs>
        <SuccessfulRecs>int</SuccessfulRecs>
        <RequestingUserID>int</RequestingUserID>
        <JobSteps>int</JobSteps>
        <JobStepPercent>int</JobStepPercent>
        <JobPercent>int</JobPercent>
        <JobStatusStr>string</JobStatusStr>
        <CurJobStep>int</CurJobStep>
        <FilePath>string</FilePath>
        <RecsProcessed>int</RecsProcessed>
        <StatusDescription>string</StatusDescription>
        <FileType>string</FileType>
        <SendEmailOnFinish>string</SendEmailOnFinish>
        <JobOrders>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
          <JobOrder>
            <JobOrderID>int</JobOrderID>
            <JobID>int</JobID>
            <OrderID>int</OrderID>
            <Sequence>int</Sequence>
          </JobOrder>
        </JobOrders>
      </JobAddToQueueResult>
    </JobAddToQueueResponse>
  </soap12:Body>
</soap12:Envelope>