WebServices Web Service

WebServices

Click here for a complete list of operations.

UploadDocumentsToBatch

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 /eStat_ImagingWS/WebServices.asmx HTTP/1.1
Host: estat.rbxinc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.tmwsystems.com/DataPump/UploadDocumentsToBatch"

<?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:Header>
    <AuthHeader xmlns="http://www.tmwsystems.com/DataPump/">
      <user>string</user>
      <pwd>string</pwd>
      <company>string</company>
      <employee>string</employee>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <UploadDocumentsToBatch xmlns="http://www.tmwsystems.com/DataPump/">
      <username>string</username>
      <pagename>string</pagename>
      <ImagingConfig>
        <FileUploadMethod>None or FILE or FTP or EMAIL or Direct</FileUploadMethod>
        <ImagingService>None or EBE or FileUploadOnly or Microdea or PaperWise or Pegasus or TMWImaging or TmwImagingCmis or MicrodeaSynergizeExplorerIntegration</ImagingService>
        <ImagingServiceName>string</ImagingServiceName>
        <DispatchSystem>string</DispatchSystem>
        <ImagingUserOverrideOptions>
          <TMWImagingUser>
            <UserName>string</UserName>
            <Password>string</Password>
          </TMWImagingUser>
          <TMWImagingUser>
            <UserName>string</UserName>
            <Password>string</Password>
          </TMWImagingUser>
        </ImagingUserOverrideOptions>
        <Settings>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </Settings>
      </ImagingConfig>
      <documentsToUpload>
        <DocumentDTO>
          <ObjectId>string</ObjectId>
          <ContentStreamMimeType>string</ContentStreamMimeType>
          <CreationDate>dateTime</CreationDate>
          <DocumentType>string</DocumentType>
          <PageCount>int</PageCount>
          <DocumentName>string</DocumentName>
          <ContentStream>base64Binary</ContentStream>
          <ContentStreamLength>long</ContentStreamLength>
          <StreamId>string</StreamId>
          <BatchId>int</BatchId>
          <FileExtension>string</FileExtension>
          <ContinuationFlag>boolean</ContinuationFlag>
        </DocumentDTO>
        <DocumentDTO>
          <ObjectId>string</ObjectId>
          <ContentStreamMimeType>string</ContentStreamMimeType>
          <CreationDate>dateTime</CreationDate>
          <DocumentType>string</DocumentType>
          <PageCount>int</PageCount>
          <DocumentName>string</DocumentName>
          <ContentStream>base64Binary</ContentStream>
          <ContentStreamLength>long</ContentStreamLength>
          <StreamId>string</StreamId>
          <BatchId>int</BatchId>
          <FileExtension>string</FileExtension>
          <ContinuationFlag>boolean</ContinuationFlag>
        </DocumentDTO>
      </documentsToUpload>
      <batch>
        <BillTo>string</BillTo>
        <Consignee>string</Consignee>
        <LegHeaderNumber>int</LegHeaderNumber>
        <MoveNumber>int</MoveNumber>
        <ShipDate>dateTime</ShipDate>
        <Shipper>string</Shipper>
        <BatchId>int</BatchId>
        <Division>string</Division>
        <OrderNumber>string</OrderNumber>
        <Description>string</Description>
        <ScanDate>dateTime</ScanDate>
      </batch>
    </UploadDocumentsToBatch>
  </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>
    <UploadDocumentsToBatchResponse xmlns="http://www.tmwsystems.com/DataPump/">
      <UploadDocumentsToBatchResult>boolean</UploadDocumentsToBatchResult>
    </UploadDocumentsToBatchResponse>
  </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 /eStat_ImagingWS/WebServices.asmx HTTP/1.1
Host: estat.rbxinc.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:Header>
    <AuthHeader xmlns="http://www.tmwsystems.com/DataPump/">
      <user>string</user>
      <pwd>string</pwd>
      <company>string</company>
      <employee>string</employee>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <UploadDocumentsToBatch xmlns="http://www.tmwsystems.com/DataPump/">
      <username>string</username>
      <pagename>string</pagename>
      <ImagingConfig>
        <FileUploadMethod>None or FILE or FTP or EMAIL or Direct</FileUploadMethod>
        <ImagingService>None or EBE or FileUploadOnly or Microdea or PaperWise or Pegasus or TMWImaging or TmwImagingCmis or MicrodeaSynergizeExplorerIntegration</ImagingService>
        <ImagingServiceName>string</ImagingServiceName>
        <DispatchSystem>string</DispatchSystem>
        <ImagingUserOverrideOptions>
          <TMWImagingUser>
            <UserName>string</UserName>
            <Password>string</Password>
          </TMWImagingUser>
          <TMWImagingUser>
            <UserName>string</UserName>
            <Password>string</Password>
          </TMWImagingUser>
        </ImagingUserOverrideOptions>
        <Settings>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </Settings>
      </ImagingConfig>
      <documentsToUpload>
        <DocumentDTO>
          <ObjectId>string</ObjectId>
          <ContentStreamMimeType>string</ContentStreamMimeType>
          <CreationDate>dateTime</CreationDate>
          <DocumentType>string</DocumentType>
          <PageCount>int</PageCount>
          <DocumentName>string</DocumentName>
          <ContentStream>base64Binary</ContentStream>
          <ContentStreamLength>long</ContentStreamLength>
          <StreamId>string</StreamId>
          <BatchId>int</BatchId>
          <FileExtension>string</FileExtension>
          <ContinuationFlag>boolean</ContinuationFlag>
        </DocumentDTO>
        <DocumentDTO>
          <ObjectId>string</ObjectId>
          <ContentStreamMimeType>string</ContentStreamMimeType>
          <CreationDate>dateTime</CreationDate>
          <DocumentType>string</DocumentType>
          <PageCount>int</PageCount>
          <DocumentName>string</DocumentName>
          <ContentStream>base64Binary</ContentStream>
          <ContentStreamLength>long</ContentStreamLength>
          <StreamId>string</StreamId>
          <BatchId>int</BatchId>
          <FileExtension>string</FileExtension>
          <ContinuationFlag>boolean</ContinuationFlag>
        </DocumentDTO>
      </documentsToUpload>
      <batch>
        <BillTo>string</BillTo>
        <Consignee>string</Consignee>
        <LegHeaderNumber>int</LegHeaderNumber>
        <MoveNumber>int</MoveNumber>
        <ShipDate>dateTime</ShipDate>
        <Shipper>string</Shipper>
        <BatchId>int</BatchId>
        <Division>string</Division>
        <OrderNumber>string</OrderNumber>
        <Description>string</Description>
        <ScanDate>dateTime</ScanDate>
      </batch>
    </UploadDocumentsToBatch>
  </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>
    <UploadDocumentsToBatchResponse xmlns="http://www.tmwsystems.com/DataPump/">
      <UploadDocumentsToBatchResult>boolean</UploadDocumentsToBatchResult>
    </UploadDocumentsToBatchResponse>
  </soap12:Body>
</soap12:Envelope>