Inbound Web Service

Inbound

Click here for a complete list of operations.

GenericDocumentQueue

Get Documents queue

Test

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

Parameter	Value
Username:
Password:
maxItems:
startFrom:

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

<?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>
    <GenericDocumentQueue xmlns="http://www.interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <maxItems>int</maxItems>
      <startFrom>int</startFrom>
    </GenericDocumentQueue>
  </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>
    <GenericDocumentQueueResponse xmlns="http://www.interfax.net">
      <GenericDocumentQueueResult>
        <ResultCode>int</ResultCode>
        <TotalCount>long</TotalCount>
        <Data>
          <Document>
            <Id>long</Id>
            <OwnerUserId>string</OwnerUserId>
            <OwnerContactName>string</OwnerContactName>
            <OwnerEmailAddress>string</OwnerEmailAddress>
            <DocStatus>New or Archived or Deleted or Purged</DocStatus>
            <Name>string</Name>
            <UniqueReference>string</UniqueReference>
            <TimeStamp>dateTime</TimeStamp>
            <Shared>boolean</Shared>
            <LabelsNames xsi:nil="true" />
            <DocumentProperties xsi:nil="true" />
            <Read>int</Read>
            <Permissions>int</Permissions>
            <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
            <ExternalReference>string</ExternalReference>
            <BoxedData />
          </Document>
          <Document>
            <Id>long</Id>
            <OwnerUserId>string</OwnerUserId>
            <OwnerContactName>string</OwnerContactName>
            <OwnerEmailAddress>string</OwnerEmailAddress>
            <DocStatus>New or Archived or Deleted or Purged</DocStatus>
            <Name>string</Name>
            <UniqueReference>string</UniqueReference>
            <TimeStamp>dateTime</TimeStamp>
            <Shared>boolean</Shared>
            <LabelsNames xsi:nil="true" />
            <DocumentProperties xsi:nil="true" />
            <Read>int</Read>
            <Permissions>int</Permissions>
            <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
            <ExternalReference>string</ExternalReference>
            <BoxedData />
          </Document>
        </Data>
      </GenericDocumentQueueResult>
    </GenericDocumentQueueResponse>
  </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>
    <GenericDocumentQueue xmlns="http://www.interfax.net">
      <Username>string</Username>
      <Password>string</Password>
      <maxItems>int</maxItems>
      <startFrom>int</startFrom>
    </GenericDocumentQueue>
  </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>
    <GenericDocumentQueueResponse xmlns="http://www.interfax.net">
      <GenericDocumentQueueResult>
        <ResultCode>int</ResultCode>
        <TotalCount>long</TotalCount>
        <Data>
          <Document>
            <Id>long</Id>
            <OwnerUserId>string</OwnerUserId>
            <OwnerContactName>string</OwnerContactName>
            <OwnerEmailAddress>string</OwnerEmailAddress>
            <DocStatus>New or Archived or Deleted or Purged</DocStatus>
            <Name>string</Name>
            <UniqueReference>string</UniqueReference>
            <TimeStamp>dateTime</TimeStamp>
            <Shared>boolean</Shared>
            <LabelsNames xsi:nil="true" />
            <DocumentProperties xsi:nil="true" />
            <Read>int</Read>
            <Permissions>int</Permissions>
            <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
            <ExternalReference>string</ExternalReference>
            <BoxedData />
          </Document>
          <Document>
            <Id>long</Id>
            <OwnerUserId>string</OwnerUserId>
            <OwnerContactName>string</OwnerContactName>
            <OwnerEmailAddress>string</OwnerEmailAddress>
            <DocStatus>New or Archived or Deleted or Purged</DocStatus>
            <Name>string</Name>
            <UniqueReference>string</UniqueReference>
            <TimeStamp>dateTime</TimeStamp>
            <Shared>boolean</Shared>
            <LabelsNames xsi:nil="true" />
            <DocumentProperties xsi:nil="true" />
            <Read>int</Read>
            <Permissions>int</Permissions>
            <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
            <ExternalReference>string</ExternalReference>
            <BoxedData />
          </Document>
        </Data>
      </GenericDocumentQueueResult>
    </GenericDocumentQueueResponse>
  </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 /inbound.asmx/GenericDocumentQueue?Username=string&Password=string&maxItems=string&startFrom=string HTTP/1.1
Host: ws.interfax.net

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

<?xml version="1.0" encoding="utf-8"?>
<QueryResultOfArrayOfDocument xmlns="http://www.interfax.net">
  <ResultCode>int</ResultCode>
  <TotalCount>long</TotalCount>
  <Data>
    <Document>
      <Id>long</Id>
      <OwnerUserId>string</OwnerUserId>
      <OwnerContactName>string</OwnerContactName>
      <OwnerEmailAddress>string</OwnerEmailAddress>
      <DocStatus>New or Archived or Deleted or Purged</DocStatus>
      <Name>string</Name>
      <UniqueReference>string</UniqueReference>
      <TimeStamp>dateTime</TimeStamp>
      <Shared>boolean</Shared>
      <LabelsNames>
        <string>string</string>
        <string>string</string>
      </LabelsNames>
      <DocumentProperties>
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DocumentProperties>
      <Read>int</Read>
      <Permissions>int</Permissions>
      <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
      <ExternalReference>string</ExternalReference>
      <BoxedData />
    </Document>
    <Document>
      <Id>long</Id>
      <OwnerUserId>string</OwnerUserId>
      <OwnerContactName>string</OwnerContactName>
      <OwnerEmailAddress>string</OwnerEmailAddress>
      <DocStatus>New or Archived or Deleted or Purged</DocStatus>
      <Name>string</Name>
      <UniqueReference>string</UniqueReference>
      <TimeStamp>dateTime</TimeStamp>
      <Shared>boolean</Shared>
      <LabelsNames>
        <string>string</string>
        <string>string</string>
      </LabelsNames>
      <DocumentProperties>
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DocumentProperties>
      <Read>int</Read>
      <Permissions>int</Permissions>
      <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
      <ExternalReference>string</ExternalReference>
      <BoxedData />
    </Document>
  </Data>
</QueryResultOfArrayOfDocument>

HTTP POST

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

POST /inbound.asmx/GenericDocumentQueue HTTP/1.1
Host: ws.interfax.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&maxItems=string&startFrom=string

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

<?xml version="1.0" encoding="utf-8"?>
<QueryResultOfArrayOfDocument xmlns="http://www.interfax.net">
  <ResultCode>int</ResultCode>
  <TotalCount>long</TotalCount>
  <Data>
    <Document>
      <Id>long</Id>
      <OwnerUserId>string</OwnerUserId>
      <OwnerContactName>string</OwnerContactName>
      <OwnerEmailAddress>string</OwnerEmailAddress>
      <DocStatus>New or Archived or Deleted or Purged</DocStatus>
      <Name>string</Name>
      <UniqueReference>string</UniqueReference>
      <TimeStamp>dateTime</TimeStamp>
      <Shared>boolean</Shared>
      <LabelsNames>
        <string>string</string>
        <string>string</string>
      </LabelsNames>
      <DocumentProperties>
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DocumentProperties>
      <Read>int</Read>
      <Permissions>int</Permissions>
      <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
      <ExternalReference>string</ExternalReference>
      <BoxedData />
    </Document>
    <Document>
      <Id>long</Id>
      <OwnerUserId>string</OwnerUserId>
      <OwnerContactName>string</OwnerContactName>
      <OwnerEmailAddress>string</OwnerEmailAddress>
      <DocStatus>New or Archived or Deleted or Purged</DocStatus>
      <Name>string</Name>
      <UniqueReference>string</UniqueReference>
      <TimeStamp>dateTime</TimeStamp>
      <Shared>boolean</Shared>
      <LabelsNames>
        <string>string</string>
        <string>string</string>
      </LabelsNames>
      <DocumentProperties>
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <DocumentProperty d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </DocumentProperties>
      <Read>int</Read>
      <Permissions>int</Permissions>
      <Type>Inbound or Upload or InboundEmail or InternalUpload</Type>
      <ExternalReference>string</ExternalReference>
      <BoxedData />
    </Document>
  </Data>
</QueryResultOfArrayOfDocument>