GenericDocumentQueue

Description

The GenericDocumentQueue method allows to retrieve a queue of inbound documents.

Note that this method is rate-limited, as defined under System Limitations

Formal Definition

https://ws.interfax.net/inbound.asmx?op=GenericDocumentQueue

Input

Name Type Comments
Username String The name of the user authenticating to the API
Password String The password for the user name
maxItems Integer The number of records to return. Default: 100
startFrom Integer The page number to start from

Output

Name Type Comments
GenericDocumentQueueResult
ResultCode Integer Returns 0 for success, otherwise an error code indicating what went wrong; see the Error Codes, below. All errors are listed in Appendix A
TotalCount Long Total number of records (this may exceed the number that was set in the MaxItems input parameter)
Data Array of Document Matches returned
Id Long The unique Document ID
OwnerUserId String The username that received this document
OwnerContactName String Contact name of the document owner
OwnerEmailAddress String Email address of the document owner
DocStatus Integer The document status: New (0), Archived (1), Deleted (2) or Purged (3)
Name String Document name
UniqueReference String Document’s unique reference
TimeStamp DateTime
Shared Boolean
LabelsNames ArrayOfString Document’s labels
DocumentProperties Array of DocumentProperty Each property that exists in the document
Name String The name of the property
Value String The value of the property
Type String The type of the property: String, Date or Integer
Read Integer Example: ‘true’, ‘false’
Permissions Integer View (1), Edit (2), Share (4), Owner (127) (Bit Flag)
Type Number  Inbound (0), Upload (1), InboundEmail (2), InternalUpload (3)
ExternalReference String
BoxedData Object

Error Codes

Value Description
-150 Internal System Error. An exception occurs at any point in the execution of the web service method.
-1003 Authentication error: the user cannot be authenticated when either the username or the password is incorrect OR any other last error occurred when authenticating the user.
-1011 Too many data requests (maximum frequency of polling for fax status defined under “System Limitations“) from the Username.