GetRespondentsGeneral

Description

Returns a RespondentTransferResult containing the respondent data.

Signature
RespondentConfirmitDataResult GetRespondentsGeneral(string key, RespondentDataTransferDefBase dataTransferDef, RespondentToken token)

Parameters

Name Data Type Description

key

string required

The authentication key

dataTransferDef

RespondentDataTransferDefBase required

The transfer definition object.

token

RespondentToken optional

The transfer token.

Response

Data Type Description

RespondentConfirmitDataResult

Example

//***************************************************
//
// GetRespondentsGeneral
//
//***************************************************

// New instance of the DataTransfer webservice
DataTransferSoapClient dataTransfer = new DataTransferSoapClient();

RespondentToken token = null;
RespondentConfirmitDataResult result;

// Create a RespondentDataTransferDef object to get all respondents from the given project.
RespondentDataTransferDef respondentDataTransferDef = new RespondentDataTransferDef
	{
		ProjectId = projectId,
		Expression = ""
	};

// Get the respondents. Run in loop while there is more data to get.
do
{
	result = dataTransfer.GetRespondentsGeneral(key, respondentDataTransferDef, token);
	token = result.Token;
	DataLevel dataLevel = result.Result.DataLevels[0];

	// Here you would process the respondent data retrieved in dataLevel

} while (!result.Token.LastDataSet);