Inbound Web Service

Inbound

Click here for a complete list of operations.

GenericDocumentQueryEx

Query on Documents

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

<?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>
    <GenericDocumentQueryEx xmlns="http://www.interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <QueryExpression>
        <IsCriteria>boolean</IsCriteria>
        <Simple>
          <CriteriaName>string</CriteriaName>
          <Verb>Equals or GreaterThan or GreaterOrEqual or LessThan or LessOrEqual or Like or IncludedIn or Between or NotEquals or Missing or Exists</Verb>
          <Data>string</Data>
          <IsProperty>boolean</IsProperty>
        </Simple>
        <Operator>AND or OR</Operator>
        <ExpressionList>
          <Expression>
            <IsCriteria>boolean</IsCriteria>
            <Simple xsi:nil="true" />
            <Operator>AND or OR</Operator>
            <ExpressionList xsi:nil="true" />
          </Expression>
          <Expression>
            <IsCriteria>boolean</IsCriteria>
            <Simple xsi:nil="true" />
            <Operator>AND or OR</Operator>
            <ExpressionList xsi:nil="true" />
          </Expression>
        </ExpressionList>
      </QueryExpression>
      <QueryControl>
        <MaxNumerOfRecords>int</MaxNumerOfRecords>
        <FirstRecordZeroBased>int</FirstRecordZeroBased>
        <OrderBy>DocumentID or TransactionID or ReceiveTime or ShareTime or ActualReceiveTime</OrderBy>
        <AscOrderDirection>boolean</AscOrderDirection>
        <ReturnItems>boolean</ReturnItems>
        <ReturnStats>boolean</ReturnStats>
        <AccessLevel>Any or Owner or SharedWith</AccessLevel>
        <UserList>string</UserList>
        <ExternalDocumentType>Inbound or Upload or InboundEmail or InternalUpload</ExternalDocumentType>
      </QueryControl>
    </GenericDocumentQueryEx>
  </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>
    <GenericDocumentQueryExResponse xmlns="http://www.interfax.net">
      <GenericDocumentQueryExResult>
        <ResultCode>int</ResultCode>
        <TotalCount>long</TotalCount>
        <Data>
          <DocumentEx>
            <BoxedDataProperties xsi:nil="true" />
          </DocumentEx>
          <DocumentEx>
            <BoxedDataProperties xsi:nil="true" />
          </DocumentEx>
        </Data>
      </GenericDocumentQueryExResult>
    </GenericDocumentQueryExResponse>
  </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 /Inbound.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>
    <GenericDocumentQueryEx xmlns="http://www.interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <QueryExpression>
        <IsCriteria>boolean</IsCriteria>
        <Simple>
          <CriteriaName>string</CriteriaName>
          <Verb>Equals or GreaterThan or GreaterOrEqual or LessThan or LessOrEqual or Like or IncludedIn or Between or NotEquals or Missing or Exists</Verb>
          <Data>string</Data>
          <IsProperty>boolean</IsProperty>
        </Simple>
        <Operator>AND or OR</Operator>
        <ExpressionList>
          <Expression>
            <IsCriteria>boolean</IsCriteria>
            <Simple xsi:nil="true" />
            <Operator>AND or OR</Operator>
            <ExpressionList xsi:nil="true" />
          </Expression>
          <Expression>
            <IsCriteria>boolean</IsCriteria>
            <Simple xsi:nil="true" />
            <Operator>AND or OR</Operator>
            <ExpressionList xsi:nil="true" />
          </Expression>
        </ExpressionList>
      </QueryExpression>
      <QueryControl>
        <MaxNumerOfRecords>int</MaxNumerOfRecords>
        <FirstRecordZeroBased>int</FirstRecordZeroBased>
        <OrderBy>DocumentID or TransactionID or ReceiveTime or ShareTime or ActualReceiveTime</OrderBy>
        <AscOrderDirection>boolean</AscOrderDirection>
        <ReturnItems>boolean</ReturnItems>
        <ReturnStats>boolean</ReturnStats>
        <AccessLevel>Any or Owner or SharedWith</AccessLevel>
        <UserList>string</UserList>
        <ExternalDocumentType>Inbound or Upload or InboundEmail or InternalUpload</ExternalDocumentType>
      </QueryControl>
    </GenericDocumentQueryEx>
  </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>
    <GenericDocumentQueryExResponse xmlns="http://www.interfax.net">
      <GenericDocumentQueryExResult>
        <ResultCode>int</ResultCode>
        <TotalCount>long</TotalCount>
        <Data>
          <DocumentEx>
            <BoxedDataProperties xsi:nil="true" />
          </DocumentEx>
          <DocumentEx>
            <BoxedDataProperties xsi:nil="true" />
          </DocumentEx>
        </Data>
      </GenericDocumentQueryExResult>
    </GenericDocumentQueryExResponse>
  </soap12:Body>
</soap12:Envelope>