GetRespondentEmailLogByUniqueKeyGeneral
Description
Gets the email log entries, that are logged during a respondent emailing task, based on a user defined unique key.
| Only entries that are logged for the authenticated user will be returned. In addition to the fields specified by the "fieldName" input parameter, two standard fields will be in the data set: * TimeStamp The time when the entry was logged. * TaskId The task id of the email task that logged the entry. |
Signature
ConfirmitData GetRespondentEmailLogByUniqueKeyGeneral(string key, string projectId, string[] fieldNames, string keyName, string[] keyValues)Parameters
| Name | Data Type | Description |
|---|---|---|
key |
string required |
The authentication key |
projectId |
string required |
The project ID |
fieldNames |
string[ ] required |
The respondent field names that should be in the returned result. |
keyName |
string required |
The name of the unique key. |
keyValues |
string[ ] required |
The key values that identifies the respondents to delete. |
Example
//***************************************************
//
// Get the respondent email log by date
//
// Before this method has any use, email must
// been sent to respondents with the logging option
// activated. This can be achieved through the
// "SendEmails" method on the "SurveyDeployer" web
// service.
//
//***************************************************
// Initiate webservice
SurveyDataSoapClient sd = new SurveyDataSoapClient();
//We assume that a field called "CustomKey" is one
//of the respondent fields. It has a unique value for
//each respondent, like 1,2,3 etc.
sd.SetRespondentUniqueKey(key,projectID,"CustomKey");
//Specifies the respondent-fields that we will have
//returned in the result.
string[] fields = new string[]{"email"};
// Get the email log.
DataSet result = sd.GetRespondentEmailLogByUniqueKey(key,
projectID,fields,"CustomKey",new string[2]{"1","2"});
//Do something with the result.