List documents

The ListDocuments method returns a list of documents in a specific folder.

The available folders to list can be obtained using GetDocumentFolders.

Parameters

username	string	This is the username from your API key. It is in the format of an email address and will look similar to apiuser‑908709770324@apiconnector.com	required
password	string	This is the password from your API key.	required
parentFolderId	int	The identifier for the folder you wish to list the documents of.	required

Return values

The response is an array of APIDocument objects each consisting of:

id	integer	The identifier for document.
name	string	The name of the document.
fileName	string	The filename for the document.
fileSize	int	The filesize of the document.
dateCreated	dateTime	The date and time the document was added to the system.
dateModified	dateTime	The date and time the document was last modified in the system.

Error responses

ERROR_APIUSAGE_EXCEEDED
ERROR_DOCUMENT_PARENTFOLDERDOESNOTEXIST
ERROR_INVALID_LOGIN
ERROR_SYSTEM_SERVICETEMPORARILYUNAVAILABLE
ERROR_UNKNOWN

Request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListDocuments"

Sample request

POST /API.asmx HTTP/1.1
Host: apiconnector.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://apiconnector.com/ListDocuments"
<?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>
    <ListDocuments xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <parentFolderId>int</parentFolderId>
    </ListDocuments>
  </soap:Body>
</soap:Envelope>

Sample response

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>
    <ListDocumentsResponse xmlns="http://apiconnector.com">
      <ListDocumentsResult>
        <APIDocument>
          <Id>int</Id>
          <Name>string</Name>
          <FileName>string</FileName>
          <FileSize>int</FileSize>
          <DateCreated>dateTime</DateCreated>
          <DateModified>dateTime</DateModified>
        </APIDocument>
        <APIDocument>
          <Id>int</Id>
          <Name>string</Name>
          <FileName>string</FileName>
          <FileSize>int</FileSize>
          <DateCreated>dateTime</DateCreated>
          <DateModified>dateTime</DateModified>
        </APIDocument>
      </ListDocumentsResult>
    </ListDocumentsResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

List documents

The ListDocuments method returns a list of documents in a specific folder.

Parameters

Return values

Error responses

Request

Sample request

Sample response

Get started with dotMailer: