Reference for https://rest.interfax.net/documents/search?Index={INDEX}&Count={COUNT}&Status={STATUS}

Url: https://rest.interfax.net/documents/search?Index={INDEX}&Count={COUNT}&Status={STATUS}

HTTP Method: GET

Message direction Format Body
Request N/A The Request body is empty.
Response Xml Example,Schema
Response Json Example

The following is an example response Xml body:

<QueryResultOfArrayOfDocument>
  <TotalCount>9223372036854775807</TotalCount>
  <Data>
    <Document>
      <Id>9223372036854775807</Id>
      <OwnerUserId>String content</OwnerUserId>
      <OwnerEmailAddress>String content</OwnerEmailAddress>
      <DocStatus>New</DocStatus>
      <Name>String content</Name>
      <UniqueReference>String content</UniqueReference>
      <ReceivedTime>1999-05-31T11:20:00</ReceivedTime>
      <Type>InboundFax</Type>
      <TimeStamp>1999-05-31T11:20:00</TimeStamp>
      <ReceivedOn>1999-05-31T11:20:00</ReceivedOn>
      <DisplayTimeStamp>String content</DisplayTimeStamp>
      <DisplayFullDateTime>String content</DisplayFullDateTime>
      <DisplaySharedTime>String content</DisplaySharedTime>
      <DisplayFullSharedTime>String content</DisplayFullSharedTime>
      <Shared>true</Shared>
      <LabelsNames>
        <string>String content</string>
        <string>String content</string>
      </LabelsNames>
      <DocumentProperties>
        <DocumentProperty>
          <Name>String content</Name>
          <Value>String content</Value>
          <Type>String content</Type>
        </DocumentProperty>
        <DocumentProperty>
          <Name>String content</Name>
          <Value>String content</Value>
          <Type>String content</Type>
        </DocumentProperty>
      </DocumentProperties>
      <Read>2147483647</Read>
      <Permissions>2147483647</Permissions>
      <ExternalReference>String content</ExternalReference>
      <Files>
        <DocumentFile>
          <Name>String content</Name>
          <DownloadUrl>String content</DownloadUrl>
          <Size>2147483647</Size>
        </DocumentFile>
        <DocumentFile>
          <Name>String content</Name>
          <DownloadUrl>String content</DownloadUrl>
          <Size>2147483647</Size>
        </DocumentFile>
      </Files>
      <!--Valid elements of type: QueryResultOfArrayOfDocument-->
      <BoxedData i:type="QueryResultOfArrayOfDocument" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <TotalCount>9223372036854775807</TotalCount>
        <Data>
          <Document>
            <Id>9223372036854775807</Id>
            <OwnerUserId>String content</OwnerUserId>
            <OwnerEmailAddress>String content</OwnerEmailAddress>
            <DocStatus>New</DocStatus>
            <Name>String content</Name>
            <UniqueReference>String content</UniqueReference>
            <ReceivedTime>1999-05-31T11:20:00</ReceivedTime>
            <Type>InboundFax</Type>
            <TimeStamp>1999-05-31T11:20:00</TimeStamp>
            <ReceivedOn>1999-05-31T11:20:00</ReceivedOn>
            <DisplayTimeStamp>String content</DisplayTimeStamp>
            <DisplayFullDateTime>String content</DisplayFullDateTime>
            <DisplaySharedTime>String content</DisplaySharedTime>
            <DisplayFullSharedTime>String content</DisplayFullSharedTime>
            <Shared>true</Shared>
            <LabelsNames>
              <string>String content</string>
              <string>String content</string>
            </LabelsNames>
            <DocumentProperties>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
            </DocumentProperties>
            <Read>2147483647</Read>
            <Permissions>2147483647</Permissions>
            <ExternalReference>String content</ExternalReference>
            <Files>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
            </Files>
            <!--Valid elements of type: QueryResultOfArrayOfDocument-->
            <BoxedData i:type="QueryResultOfArrayOfDocument">
              <TotalCount>9223372036854775807</TotalCount>
              <Data i:nil="true" />
            </BoxedData>
          </Document>
          <Document>
            <Id>9223372036854775807</Id>
            <OwnerUserId>String content</OwnerUserId>
            <OwnerEmailAddress>String content</OwnerEmailAddress>
            <DocStatus>New</DocStatus>
            <Name>String content</Name>
            <UniqueReference>String content</UniqueReference>
            <ReceivedTime>1999-05-31T11:20:00</ReceivedTime>
            <Type>InboundFax</Type>
            <TimeStamp>1999-05-31T11:20:00</TimeStamp>
            <ReceivedOn>1999-05-31T11:20:00</ReceivedOn>
            <DisplayTimeStamp>String content</DisplayTimeStamp>
            <DisplayFullDateTime>String content</DisplayFullDateTime>
            <DisplaySharedTime>String content</DisplaySharedTime>
            <DisplayFullSharedTime>String content</DisplayFullSharedTime>
            <Shared>true</Shared>
            <LabelsNames>
              <string>String content</string>
              <string>String content</string>
            </LabelsNames>
            <DocumentProperties>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
            </DocumentProperties>
            <Read>2147483647</Read>
            <Permissions>2147483647</Permissions>
            <ExternalReference>String content</ExternalReference>
            <Files>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
            </Files>
            <!--Valid elements of type: QueryResultOfArrayOfDocument-->
            <BoxedData i:type="QueryResultOfArrayOfDocument">
              <TotalCount>9223372036854775807</TotalCount>
              <Data i:nil="true" />
            </BoxedData>
          </Document>
        </Data>
      </BoxedData>
    </Document>
    <Document>
      <Id>9223372036854775807</Id>
      <OwnerUserId>String content</OwnerUserId>
      <OwnerEmailAddress>String content</OwnerEmailAddress>
      <DocStatus>New</DocStatus>
      <Name>String content</Name>
      <UniqueReference>String content</UniqueReference>
      <ReceivedTime>1999-05-31T11:20:00</ReceivedTime>
      <Type>InboundFax</Type>
      <TimeStamp>1999-05-31T11:20:00</TimeStamp>
      <ReceivedOn>1999-05-31T11:20:00</ReceivedOn>
      <DisplayTimeStamp>String content</DisplayTimeStamp>
      <DisplayFullDateTime>String content</DisplayFullDateTime>
      <DisplaySharedTime>String content</DisplaySharedTime>
      <DisplayFullSharedTime>String content</DisplayFullSharedTime>
      <Shared>true</Shared>
      <LabelsNames>
        <string>String content</string>
        <string>String content</string>
      </LabelsNames>
      <DocumentProperties>
        <DocumentProperty>
          <Name>String content</Name>
          <Value>String content</Value>
          <Type>String content</Type>
        </DocumentProperty>
        <DocumentProperty>
          <Name>String content</Name>
          <Value>String content</Value>
          <Type>String content</Type>
        </DocumentProperty>
      </DocumentProperties>
      <Read>2147483647</Read>
      <Permissions>2147483647</Permissions>
      <ExternalReference>String content</ExternalReference>
      <Files>
        <DocumentFile>
          <Name>String content</Name>
          <DownloadUrl>String content</DownloadUrl>
          <Size>2147483647</Size>
        </DocumentFile>
        <DocumentFile>
          <Name>String content</Name>
          <DownloadUrl>String content</DownloadUrl>
          <Size>2147483647</Size>
        </DocumentFile>
      </Files>
      <!--Valid elements of type: QueryResultOfArrayOfDocument-->
      <BoxedData i:type="QueryResultOfArrayOfDocument" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <TotalCount>9223372036854775807</TotalCount>
        <Data>
          <Document>
            <Id>9223372036854775807</Id>
            <OwnerUserId>String content</OwnerUserId>
            <OwnerEmailAddress>String content</OwnerEmailAddress>
            <DocStatus>New</DocStatus>
            <Name>String content</Name>
            <UniqueReference>String content</UniqueReference>
            <ReceivedTime>1999-05-31T11:20:00</ReceivedTime>
            <Type>InboundFax</Type>
            <TimeStamp>1999-05-31T11:20:00</TimeStamp>
            <ReceivedOn>1999-05-31T11:20:00</ReceivedOn>
            <DisplayTimeStamp>String content</DisplayTimeStamp>
            <DisplayFullDateTime>String content</DisplayFullDateTime>
            <DisplaySharedTime>String content</DisplaySharedTime>
            <DisplayFullSharedTime>String content</DisplayFullSharedTime>
            <Shared>true</Shared>
            <LabelsNames>
              <string>String content</string>
              <string>String content</string>
            </LabelsNames>
            <DocumentProperties>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
            </DocumentProperties>
            <Read>2147483647</Read>
            <Permissions>2147483647</Permissions>
            <ExternalReference>String content</ExternalReference>
            <Files>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
            </Files>
            <!--Valid elements of type: QueryResultOfArrayOfDocument-->
            <BoxedData i:type="QueryResultOfArrayOfDocument">
              <TotalCount>9223372036854775807</TotalCount>
              <Data i:nil="true" />
            </BoxedData>
          </Document>
          <Document>
            <Id>9223372036854775807</Id>
            <OwnerUserId>String content</OwnerUserId>
            <OwnerEmailAddress>String content</OwnerEmailAddress>
            <DocStatus>New</DocStatus>
            <Name>String content</Name>
            <UniqueReference>String content</UniqueReference>
            <ReceivedTime>1999-05-31T11:20:00</ReceivedTime>
            <Type>InboundFax</Type>
            <TimeStamp>1999-05-31T11:20:00</TimeStamp>
            <ReceivedOn>1999-05-31T11:20:00</ReceivedOn>
            <DisplayTimeStamp>String content</DisplayTimeStamp>
            <DisplayFullDateTime>String content</DisplayFullDateTime>
            <DisplaySharedTime>String content</DisplaySharedTime>
            <DisplayFullSharedTime>String content</DisplayFullSharedTime>
            <Shared>true</Shared>
            <LabelsNames>
              <string>String content</string>
              <string>String content</string>
            </LabelsNames>
            <DocumentProperties>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
              <DocumentProperty>
                <Name>String content</Name>
                <Value>String content</Value>
                <Type>String content</Type>
              </DocumentProperty>
            </DocumentProperties>
            <Read>2147483647</Read>
            <Permissions>2147483647</Permissions>
            <ExternalReference>String content</ExternalReference>
            <Files>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
              <DocumentFile>
                <Name>String content</Name>
                <DownloadUrl>String content</DownloadUrl>
                <Size>2147483647</Size>
              </DocumentFile>
            </Files>
            <!--Valid elements of type: QueryResultOfArrayOfDocument-->
            <BoxedData i:type="QueryResultOfArrayOfDocument">
              <TotalCount>9223372036854775807</TotalCount>
              <Data i:nil="true" />
            </BoxedData>
          </Document>
        </Data>
      </BoxedData>
    </Document>
  </Data>
</QueryResultOfArrayOfDocument>

The following is an example response Json body:

{
	"TotalCount":9223372036854775807,
	"Data":[{
		"Id":9223372036854775807,
		"OwnerUserId":"String content",
		"OwnerEmailAddress":"String content",
		"DocStatus":0,
		"Name":"String content",
		"UniqueReference":"String content",
		"ReceivedTime":"\/Date(928149600000+0000)\/",
		"Type":0,
		"TimeStamp":"\/Date(928149600000+0000)\/",
		"ReceivedOn":"\/Date(928149600000+0000)\/",
		"DisplayTimeStamp":"String content",
		"DisplayFullDateTime":"String content",
		"DisplaySharedTime":"String content",
		"DisplayFullSharedTime":"String content",
		"Shared":true,
		"LabelsNames":["String content"],
		"DocumentProperties":[{
			"Name":"String content",
			"Value":"String content",
			"Type":"String content"
		}],
		"Read":2147483647,
		"Permissions":2147483647,
		"ExternalReference":"String content",
		"Files":[{
			"Name":"String content",
			"DownloadUrl":"String content",
			"Size":2147483647
		}],
		"BoxedData":{
			"TotalCount":9223372036854775807,
			"Data":[{
				"Id":9223372036854775807,
				"OwnerUserId":"String content",
				"OwnerEmailAddress":"String content",
				"DocStatus":0,
				"Name":"String content",
				"UniqueReference":"String content",
				"ReceivedTime":"\/Date(928149600000+0000)\/",
				"Type":0,
				"TimeStamp":"\/Date(928149600000+0000)\/",
				"ReceivedOn":"\/Date(928149600000+0000)\/",
				"DisplayTimeStamp":"String content",
				"DisplayFullDateTime":"String content",
				"DisplaySharedTime":"String content",
				"DisplayFullSharedTime":"String content",
				"Shared":true,
				"LabelsNames":["String content"],
				"DocumentProperties":[{
					"Name":"String content",
					"Value":"String content",
					"Type":"String content"
				}],
				"Read":2147483647,
				"Permissions":2147483647,
				"ExternalReference":"String content",
				"Files":[{
					"Name":"String content",
					"DownloadUrl":"String content",
					"Size":2147483647
				}],
				"BoxedData":{
					"TotalCount":9223372036854775807,
					"Data":null
				}
			}]
		}
	}]
}

The following is the response Xml Schema:

<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="QueryResultOfArrayOfDocument" nillable="true" type="QueryResultOfArrayOfDocument" />
  <xs:complexType name="QueryResultOfArrayOfDocument">
    <xs:sequence>
      <xs:element minOccurs="1" maxOccurs="1" name="TotalCount" type="xs:long" />
      <xs:element minOccurs="0" maxOccurs="1" name="Data" type="ArrayOfDocument" />
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="ArrayOfDocument">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="Document" nillable="true" type="Document" />
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="Document">
    <xs:sequence>
      <xs:element minOccurs="1" maxOccurs="1" name="Id" type="xs:long" />
      <xs:element minOccurs="0" maxOccurs="1" name="OwnerUserId" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="OwnerEmailAddress" type="xs:string" />
      <xs:element minOccurs="1" maxOccurs="1" name="DocStatus" type="DocumentStatus" />
      <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="UniqueReference" type="xs:string" />
      <xs:element minOccurs="1" maxOccurs="1" name="ReceivedTime" type="xs:dateTime" />
      <xs:element minOccurs="1" maxOccurs="1" name="Type" type="DocumentType" />
      <xs:element minOccurs="1" maxOccurs="1" name="TimeStamp" type="xs:dateTime" />
      <xs:element minOccurs="1" maxOccurs="1" name="ReceivedOn" type="xs:dateTime" />
      <xs:element minOccurs="0" maxOccurs="1" name="DisplayTimeStamp" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="DisplayFullDateTime" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="DisplaySharedTime" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="DisplayFullSharedTime" type="xs:string" />
      <xs:element minOccurs="1" maxOccurs="1" name="Shared" type="xs:boolean" />
      <xs:element minOccurs="0" maxOccurs="1" name="LabelsNames" type="ArrayOfString" />
      <xs:element minOccurs="0" maxOccurs="1" name="DocumentProperties" type="ArrayOfDocumentProperty" />
      <xs:element minOccurs="1" maxOccurs="1" name="Read" type="xs:int" />
      <xs:element minOccurs="1" maxOccurs="1" name="Permissions" type="xs:int" />
      <xs:element minOccurs="0" maxOccurs="1" name="ExternalReference" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="Files" type="ArrayOfDocumentFile" />
      <xs:element minOccurs="0" maxOccurs="1" name="BoxedData" />
    </xs:sequence>
  </xs:complexType>
  <xs:simpleType name="DocumentStatus">
    <xs:restriction base="xs:string">
      <xs:enumeration value="New" />
      <xs:enumeration value="Archived" />
      <xs:enumeration value="Deleted" />
      <xs:enumeration value="Purged" />
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="DocumentType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="InboundFax" />
      <xs:enumeration value="Upload" />
      <xs:enumeration value="InboundEmail" />
      <xs:enumeration value="InternalUpload" />
    </xs:restriction>
  </xs:simpleType>
  <xs:complexType name="ArrayOfString">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="ArrayOfDocumentProperty">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="DocumentProperty" type="DocumentProperty" />
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="DocumentProperty">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="Value" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="Type" type="xs:string" />
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="ArrayOfDocumentFile">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="unbounded" name="DocumentFile" type="DocumentFile" />
    </xs:sequence>
  </xs:complexType>
  <xs:complexType name="DocumentFile">
    <xs:sequence>
      <xs:element minOccurs="0" maxOccurs="1" name="Name" type="xs:string" />
      <xs:element minOccurs="0" maxOccurs="1" name="DownloadUrl" type="xs:string" />
      <xs:element minOccurs="1" maxOccurs="1" name="Size" type="xs:int" />
    </xs:sequence>
  </xs:complexType>
</xs:schema>