InterFax Web Service

InterFax

Click here for a complete list of operations.

FaxQuery4

Returns full information (27 fields - see Reference) regarding a population determined by query form.

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 /dfs.asmx HTTP/1.1
Host: ws.interfax.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.interfax.cc/FaxQuery4"

<?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>
    <FaxQuery4 xmlns="http://www.interfax.cc">
      <Username>string</Username>
      <Password>string</Password>
      <QueryForm>
        <DateFrom>dateTime</DateFrom>
        <DateTo>dateTime</DateTo>
        <ShowHiddenTransactions>boolean</ShowHiddenTransactions>
        <Conditions>
          <QueryConditionEx>
            <Field>string</Field>
            <Verb>Equals or GreaterThan or GreaterOrEqual or LessThan or LessOrEqual or Like or IncludedIn or Between or NotEquals or Missing or Exists</Verb>
            <VerbData>string</VerbData>
          </QueryConditionEx>
          <QueryConditionEx>
            <Field>string</Field>
            <Verb>Equals or GreaterThan or GreaterOrEqual or LessThan or LessOrEqual or Like or IncludedIn or Between or NotEquals or Missing or Exists</Verb>
            <VerbData>string</VerbData>
          </QueryConditionEx>
        </Conditions>
      </QueryForm>
      <QueryControl>
        <OnlyParents>boolean</OnlyParents>
        <NumOfResults>int</NumOfResults>
        <StartingRecord>long</StartingRecord>
        <OrderBy>TransactionID or SubmitTime or CompletionTime or Status or DestinationFax or Subject or PagesSent or UserID or ReplyEmail or Contact</OrderBy>
        <AscOrderDirection>boolean</AscOrderDirection>
        <ReturnItems>boolean</ReturnItems>
        <ReturnStats>boolean</ReturnStats>
        <UseMainQueue>boolean</UseMainQueue>
      </QueryControl>
    </FaxQuery4>
  </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>
    <FaxQuery4Response xmlns="http://www.interfax.cc">
      <FaxQuery4Result>
        <ResultCode>int</ResultCode>
        <FaxItems>
          <FaxItemEx3>
            <ParentTransactionID>long</ParentTransactionID>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <PostponeTime>dateTime</PostponeTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <JobID>string</JobID>
            <DestinationFax>string</DestinationFax>
            <ReplyEmail>string</ReplyEmail>
            <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>
            <Mode>string</Mode>
            <NumOfTransactions>int</NumOfTransactions>
            <MessageID>string</MessageID>
          </FaxItemEx3>
          <FaxItemEx3>
            <ParentTransactionID>long</ParentTransactionID>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <PostponeTime>dateTime</PostponeTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <JobID>string</JobID>
            <DestinationFax>string</DestinationFax>
            <ReplyEmail>string</ReplyEmail>
            <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>
            <Mode>string</Mode>
            <NumOfTransactions>int</NumOfTransactions>
            <MessageID>string</MessageID>
          </FaxItemEx3>
        </FaxItems>
        <Stats>
          <StatusCount>
            <Status>int</Status>
            <Count>int</Count>
          </StatusCount>
          <StatusCount>
            <Status>int</Status>
            <Count>int</Count>
          </StatusCount>
        </Stats>
        <ErrorsDescriptionHTMLFormat>string</ErrorsDescriptionHTMLFormat>
        <TotalTransactionsNum>int</TotalTransactionsNum>
      </FaxQuery4Result>
    </FaxQuery4Response>
  </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 /dfs.asmx HTTP/1.1
Host: ws.interfax.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>
    <FaxQuery4 xmlns="http://www.interfax.cc">
      <Username>string</Username>
      <Password>string</Password>
      <QueryForm>
        <DateFrom>dateTime</DateFrom>
        <DateTo>dateTime</DateTo>
        <ShowHiddenTransactions>boolean</ShowHiddenTransactions>
        <Conditions>
          <QueryConditionEx>
            <Field>string</Field>
            <Verb>Equals or GreaterThan or GreaterOrEqual or LessThan or LessOrEqual or Like or IncludedIn or Between or NotEquals or Missing or Exists</Verb>
            <VerbData>string</VerbData>
          </QueryConditionEx>
          <QueryConditionEx>
            <Field>string</Field>
            <Verb>Equals or GreaterThan or GreaterOrEqual or LessThan or LessOrEqual or Like or IncludedIn or Between or NotEquals or Missing or Exists</Verb>
            <VerbData>string</VerbData>
          </QueryConditionEx>
        </Conditions>
      </QueryForm>
      <QueryControl>
        <OnlyParents>boolean</OnlyParents>
        <NumOfResults>int</NumOfResults>
        <StartingRecord>long</StartingRecord>
        <OrderBy>TransactionID or SubmitTime or CompletionTime or Status or DestinationFax or Subject or PagesSent or UserID or ReplyEmail or Contact</OrderBy>
        <AscOrderDirection>boolean</AscOrderDirection>
        <ReturnItems>boolean</ReturnItems>
        <ReturnStats>boolean</ReturnStats>
        <UseMainQueue>boolean</UseMainQueue>
      </QueryControl>
    </FaxQuery4>
  </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>
    <FaxQuery4Response xmlns="http://www.interfax.cc">
      <FaxQuery4Result>
        <ResultCode>int</ResultCode>
        <FaxItems>
          <FaxItemEx3>
            <ParentTransactionID>long</ParentTransactionID>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <PostponeTime>dateTime</PostponeTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <JobID>string</JobID>
            <DestinationFax>string</DestinationFax>
            <ReplyEmail>string</ReplyEmail>
            <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>
            <Mode>string</Mode>
            <NumOfTransactions>int</NumOfTransactions>
            <MessageID>string</MessageID>
          </FaxItemEx3>
          <FaxItemEx3>
            <ParentTransactionID>long</ParentTransactionID>
            <TransactionID>long</TransactionID>
            <SubmitTime>dateTime</SubmitTime>
            <PostponeTime>dateTime</PostponeTime>
            <CompletionTime>dateTime</CompletionTime>
            <UserID>string</UserID>
            <Contact>string</Contact>
            <JobID>string</JobID>
            <DestinationFax>string</DestinationFax>
            <ReplyEmail>string</ReplyEmail>
            <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>
            <Mode>string</Mode>
            <NumOfTransactions>int</NumOfTransactions>
            <MessageID>string</MessageID>
          </FaxItemEx3>
        </FaxItems>
        <Stats>
          <StatusCount>
            <Status>int</Status>
            <Count>int</Count>
          </StatusCount>
          <StatusCount>
            <Status>int</Status>
            <Count>int</Count>
          </StatusCount>
        </Stats>
        <ErrorsDescriptionHTMLFormat>string</ErrorsDescriptionHTMLFormat>
        <TotalTransactionsNum>int</TotalTransactionsNum>
      </FaxQuery4Result>
    </FaxQuery4Response>
  </soap12:Body>
</soap12:Envelope>