Get contact import progress

The GetContactImportProgress method determines the import status of a previously started contact import. Returns either Finished, NotFinished, RejectedByWatchdog or InvalidFileFormat. There is the possibility of an "Unknown" status if something went wrong internally in dotMailer.

To be used in conjunction with AddContactsToAddressBookWithProgress.

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
progressID	guid	This is a GUID which is returned to you when you call AddContactsToAddressBookWithProgress.	required

Return values

result

Finished or NotFinished or RejectedByWatchdog or InvalidFileFormat or Unknown

Error responses

ERROR_IMPORT_NOT_FOUND
ERROR_IMPORT_TOOMANYACTIVEIMPORTS
ERROR_APIUSAGE_EXCEEDED
ERROR_INVALID_LOGIN
ERROR_PARAMETER_INVALID
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/GetContactImportProgress"

Example of use in C# .NET

/// <summary>
/// Determines the import status of a previously started contact import 
/// </summary>
public void GetContactImportProgress()
{
    /* 
     * See AddContactsToAddressBookWithProgress for example of how to use
     * this function call
     */
}

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/GetContactImportProgress"
<?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>
    <GetContactImportProgress xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <progressID>guid</progressID>
    </GetContactImportProgress>
  </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>
    <GetContactImportProgressResponse xmlns="http://apiconnector.com">
      <GetContactImportProgressResult>Finished or NotFinished or RejectedByWatchdog or InvalidFileFormat or Unknown</GetContactImportProgressResult>
    </GetContactImportProgressResponse>
  </soap:Body>
</soap:Envelope>

About the API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Get contact import progress

The GetContactImportProgress method determines the import status of a previously started contact import. Returns either Finished, NotFinished, RejectedByWatchdog or InvalidFileFormat. There is the possibility of an "Unknown" status if something went wrong internally in dotMailer.

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: