Get contact import report faults

The GetContactImportReportFaults method gets all records that were not successfully imported in your contact report. The data are returned in a base64 encoded CSV file, which is UTF-8 encoded.

This can be used in conjunction with AddContactsToAddressBookWithProgress and GetContactImportProgress.

Guidance Notes

This data will only be available for approximately one week after import.

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

base64Binary

int

A base64 encoded CSV file, which is UTF-8 encoded containing all records not successfully imported.

Error responses

ERROR_IMPORT_NOT_FOUND
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/GetContactImportReportFaults"

Example of use in C# .NET

/// <summary>
/// This method gets all records that were not successfully imported in your 
/// contact report. The data are returned in a base64 encoded CSV file, which is UTF-8 encoded. 
/// </summary>
public void GetContactImportReportFaults()
{
    const string username = "apiuser-XXXXXXXXXXXX@apiconnector.com";
    const string password = "password";
 
    Guid importGuid = Guid.NewGuid();       // replace with actual import guid
 
    Console.WriteLine("GetContactImportReportFaults");
    Console.WriteLine("----------------------------");
 
    // Get an instance to the web reference
    com.apiconnector.API api = new com.apiconnector.API();
 
    try
    {
        // get the report from the web service
        byte[] base64EncodedData = api.GetContactImportReportFaults(username, password, importGuid);
 
        if (base64EncodedData != null)
        {
            // we need to decode the data we received from the web service
            byte[] csvData = Convert.FromBase64String(Encoding.UTF8.GetString(base64EncodedData));
 
            // now we need to write out the decoded data to a file
            using (
                BinaryWriter bw =
                    new BinaryWriter(File.Open("faults.csv", FileMode.Create, FileAccess.Write)))
            {
                bw.Write(csvData);
                bw.Close();
            }
        }
        else
        {
            Console.WriteLine("Import report not found.");
        }
    }
    catch (SoapException ex)  // catch any soap issues/errors from the web service
    {
        Console.WriteLine("Error -> {0}", ex.Message);                
    }
 
    Console.WriteLine();
}

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/GetContactImportReportFaults"
<?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>
    <GetContactImportReportFaults xmlns="http://apiconnector.com">
      <username>string</username>
      <password>string</password>
      <progressID>guid</progressID>
    </GetContactImportReportFaults>
  </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>
    <GetContactImportReportFaultsResponse xmlns="http://apiconnector.com">
      <GetContactImportReportFaultsResult>base64Binary</GetContactImportReportFaultsResult>
    </GetContactImportReportFaultsResponse>
  </soap:Body>
</soap:Envelope>

Prebuilt integrations

More about API

Address books

Contacts

Campaigns

Reporting

SMS

Account

Images

Documents

Templates

Get contact import report faults

The GetContactImportReportFaults method gets all records that were not successfully imported in your contact report. The data are returned in a base64 encoded CSV file, which is UTF-8 encoded.

Guidance Notes

Parameters

Return values

Error responses

Request

Example of use in C# .NET

Sample request

Sample response

Get started with dotMailer: