Outbound Web Service

Outbound

Click here for a complete list of operations.

QueryCompleted

Returns full information (multiple fields - see Reference) regarding a population determined by list of completed transactions.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /Outbound.asmx HTTP/1.1
Host: ws-sl.fax.tc
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "interfax.net/QueryCompleted"

<?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>
    <QueryCompleted xmlns="interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <TransactionList>string</TransactionList>
    </QueryCompleted>
  </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>
    <QueryCompletedResponse xmlns="interfax.net">
      <QueryCompletedResult>
        <ResultCode>int</ResultCode>
        <FaxItems>
          <FaxItem>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <DestinationFax>string</DestinationFax>
            <RemoteCSID>string</RemoteCSID>
            <PagesSent>short</PagesSent>
            <Status>int</Status>
            <Duration>int</Duration>
            <Subject>string</Subject>
            <PagesSubmitted>short</PagesSubmitted>
            <SenderCSID>string</SenderCSID>
            <Priority>short</Priority>
            <Units>decimal</Units>
            <CostPerUnit>decimal</CostPerUnit>
            <PageSize>string</PageSize>
            <PageOrientation>string</PageOrientation>
            <PageResolution>string</PageResolution>
            <RenderingQuality>string</RenderingQuality>
            <PageHeader>string</PageHeader>
            <RetriesToPerform>short</RetriesToPerform>
            <TrialsPerformed>short</TrialsPerformed>
            <LocaleID>int</LocaleID>
            <GMTBias>int</GMTBias>
            <RetriesInterval>int</RetriesInterval>
            <UserData>string</UserData>
            <DeleteAfterUsage>string</DeleteAfterUsage>
          </FaxItem>
          <FaxItem>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <DestinationFax>string</DestinationFax>
            <RemoteCSID>string</RemoteCSID>
            <PagesSent>short</PagesSent>
            <Status>int</Status>
            <Duration>int</Duration>
            <Subject>string</Subject>
            <PagesSubmitted>short</PagesSubmitted>
            <SenderCSID>string</SenderCSID>
            <Priority>short</Priority>
            <Units>decimal</Units>
            <CostPerUnit>decimal</CostPerUnit>
            <PageSize>string</PageSize>
            <PageOrientation>string</PageOrientation>
            <PageResolution>string</PageResolution>
            <RenderingQuality>string</RenderingQuality>
            <PageHeader>string</PageHeader>
            <RetriesToPerform>short</RetriesToPerform>
            <TrialsPerformed>short</TrialsPerformed>
            <LocaleID>int</LocaleID>
            <GMTBias>int</GMTBias>
            <RetriesInterval>int</RetriesInterval>
            <UserData>string</UserData>
            <DeleteAfterUsage>string</DeleteAfterUsage>
          </FaxItem>
        </FaxItems>
      </QueryCompletedResult>
    </QueryCompletedResponse>
  </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 /Outbound.asmx HTTP/1.1
Host: ws-sl.fax.tc
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>
    <QueryCompleted xmlns="interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <TransactionList>string</TransactionList>
    </QueryCompleted>
  </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>
    <QueryCompletedResponse xmlns="interfax.net">
      <QueryCompletedResult>
        <ResultCode>int</ResultCode>
        <FaxItems>
          <FaxItem>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <DestinationFax>string</DestinationFax>
            <RemoteCSID>string</RemoteCSID>
            <PagesSent>short</PagesSent>
            <Status>int</Status>
            <Duration>int</Duration>
            <Subject>string</Subject>
            <PagesSubmitted>short</PagesSubmitted>
            <SenderCSID>string</SenderCSID>
            <Priority>short</Priority>
            <Units>decimal</Units>
            <CostPerUnit>decimal</CostPerUnit>
            <PageSize>string</PageSize>
            <PageOrientation>string</PageOrientation>
            <PageResolution>string</PageResolution>
            <RenderingQuality>string</RenderingQuality>
            <PageHeader>string</PageHeader>
            <RetriesToPerform>short</RetriesToPerform>
            <TrialsPerformed>short</TrialsPerformed>
            <LocaleID>int</LocaleID>
            <GMTBias>int</GMTBias>
            <RetriesInterval>int</RetriesInterval>
            <UserData>string</UserData>
            <DeleteAfterUsage>string</DeleteAfterUsage>
          </FaxItem>
          <FaxItem>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <DestinationFax>string</DestinationFax>
            <RemoteCSID>string</RemoteCSID>
            <PagesSent>short</PagesSent>
            <Status>int</Status>
            <Duration>int</Duration>
            <Subject>string</Subject>
            <PagesSubmitted>short</PagesSubmitted>
            <SenderCSID>string</SenderCSID>
            <Priority>short</Priority>
            <Units>decimal</Units>
            <CostPerUnit>decimal</CostPerUnit>
            <PageSize>string</PageSize>
            <PageOrientation>string</PageOrientation>
            <PageResolution>string</PageResolution>
            <RenderingQuality>string</RenderingQuality>
            <PageHeader>string</PageHeader>
            <RetriesToPerform>short</RetriesToPerform>
            <TrialsPerformed>short</TrialsPerformed>
            <LocaleID>int</LocaleID>
            <GMTBias>int</GMTBias>
            <RetriesInterval>int</RetriesInterval>
            <UserData>string</UserData>
            <DeleteAfterUsage>string</DeleteAfterUsage>
          </FaxItem>
        </FaxItems>
      </QueryCompletedResult>
    </QueryCompletedResponse>
  </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 /Outbound.asmx/QueryCompleted?Username=string&Password=string&TransactionList=string HTTP/1.1
Host: ws-sl.fax.tc

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<QueryResult xmlns="interfax.net">
  <ResultCode>int</ResultCode>
  <FaxItems>
    <FaxItem>
      <TransactionID>long</TransactionID>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <UserID>string</UserID>
      <Contact>string</Contact>
      <DestinationFax>string</DestinationFax>
      <RemoteCSID>string</RemoteCSID>
      <PagesSent>short</PagesSent>
      <Status>int</Status>
      <Duration>int</Duration>
      <Subject>string</Subject>
      <PagesSubmitted>short</PagesSubmitted>
      <SenderCSID>string</SenderCSID>
      <Priority>short</Priority>
      <Units>decimal</Units>
      <CostPerUnit>decimal</CostPerUnit>
      <PageSize>string</PageSize>
      <PageOrientation>string</PageOrientation>
      <PageResolution>string</PageResolution>
      <RenderingQuality>string</RenderingQuality>
      <PageHeader>string</PageHeader>
      <RetriesToPerform>short</RetriesToPerform>
      <TrialsPerformed>short</TrialsPerformed>
      <LocaleID>int</LocaleID>
      <GMTBias>int</GMTBias>
      <RetriesInterval>int</RetriesInterval>
      <UserData>string</UserData>
      <DeleteAfterUsage>string</DeleteAfterUsage>
    </FaxItem>
    <FaxItem>
      <TransactionID>long</TransactionID>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <UserID>string</UserID>
      <Contact>string</Contact>
      <DestinationFax>string</DestinationFax>
      <RemoteCSID>string</RemoteCSID>
      <PagesSent>short</PagesSent>
      <Status>int</Status>
      <Duration>int</Duration>
      <Subject>string</Subject>
      <PagesSubmitted>short</PagesSubmitted>
      <SenderCSID>string</SenderCSID>
      <Priority>short</Priority>
      <Units>decimal</Units>
      <CostPerUnit>decimal</CostPerUnit>
      <PageSize>string</PageSize>
      <PageOrientation>string</PageOrientation>
      <PageResolution>string</PageResolution>
      <RenderingQuality>string</RenderingQuality>
      <PageHeader>string</PageHeader>
      <RetriesToPerform>short</RetriesToPerform>
      <TrialsPerformed>short</TrialsPerformed>
      <LocaleID>int</LocaleID>
      <GMTBias>int</GMTBias>
      <RetriesInterval>int</RetriesInterval>
      <UserData>string</UserData>
      <DeleteAfterUsage>string</DeleteAfterUsage>
    </FaxItem>
  </FaxItems>
</QueryResult>

HTTP POST

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

POST /Outbound.asmx/QueryCompleted HTTP/1.1
Host: ws-sl.fax.tc
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&TransactionList=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<QueryResult xmlns="interfax.net">
  <ResultCode>int</ResultCode>
  <FaxItems>
    <FaxItem>
      <TransactionID>long</TransactionID>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <UserID>string</UserID>
      <Contact>string</Contact>
      <DestinationFax>string</DestinationFax>
      <RemoteCSID>string</RemoteCSID>
      <PagesSent>short</PagesSent>
      <Status>int</Status>
      <Duration>int</Duration>
      <Subject>string</Subject>
      <PagesSubmitted>short</PagesSubmitted>
      <SenderCSID>string</SenderCSID>
      <Priority>short</Priority>
      <Units>decimal</Units>
      <CostPerUnit>decimal</CostPerUnit>
      <PageSize>string</PageSize>
      <PageOrientation>string</PageOrientation>
      <PageResolution>string</PageResolution>
      <RenderingQuality>string</RenderingQuality>
      <PageHeader>string</PageHeader>
      <RetriesToPerform>short</RetriesToPerform>
      <TrialsPerformed>short</TrialsPerformed>
      <LocaleID>int</LocaleID>
      <GMTBias>int</GMTBias>
      <RetriesInterval>int</RetriesInterval>
      <UserData>string</UserData>
      <DeleteAfterUsage>string</DeleteAfterUsage>
    </FaxItem>
    <FaxItem>
      <TransactionID>long</TransactionID>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <UserID>string</UserID>
      <Contact>string</Contact>
      <DestinationFax>string</DestinationFax>
      <RemoteCSID>string</RemoteCSID>
      <PagesSent>short</PagesSent>
      <Status>int</Status>
      <Duration>int</Duration>
      <Subject>string</Subject>
      <PagesSubmitted>short</PagesSubmitted>
      <SenderCSID>string</SenderCSID>
      <Priority>short</Priority>
      <Units>decimal</Units>
      <CostPerUnit>decimal</CostPerUnit>
      <PageSize>string</PageSize>
      <PageOrientation>string</PageOrientation>
      <PageResolution>string</PageResolution>
      <RenderingQuality>string</RenderingQuality>
      <PageHeader>string</PageHeader>
      <RetriesToPerform>short</RetriesToPerform>
      <TrialsPerformed>short</TrialsPerformed>
      <LocaleID>int</LocaleID>
      <GMTBias>int</GMTBias>
      <RetriesInterval>int</RetriesInterval>
      <UserData>string</UserData>
      <DeleteAfterUsage>string</DeleteAfterUsage>
    </FaxItem>
  </FaxItems>
</QueryResult>

Parameter	Value
Username:
Password:
TransactionList: