GetRespondents

Description

Returns a RespondentTransferResult containing the respondent data.

Signature
RespondentTransferResult GetRespondents(string key, RespondentDataTransferDefBase dataTransferDef, RespondentToken token)

Parameters

Name Data Type Description

key

string required

The authentication key

dataTransferDef

The transfer definition object.

token

RespondentToken optional

The transfer token.

Response

Data Type Description

Example

//***************************************************
//
// GetRespondents
//
//***************************************************

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

RespondentToken token = null;
RespondentTransferResult 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.GetRespondents(key, respondentDataTransferDef, token);
	token = result.Token;
	DataTable dataTable = result.Result.Tables["respondent"];
	// Here you would process the respondent data retrieved in dataTable
} while (!result.Token.LastDataSet);