UpdateRespondentsWithCatiScheduling

Description

Updates the respondents. Missing respondents will be added.

If 'merge' is set to true and the respondents have existing 'key'-values, existing rows will be updated. If set to false, existing rows will not be updated. In both cases, rows will be added if 'key'-values are not found. If "inTransaction" is set to true, the update will be performed in a transaction. If an error occurs, a rollback for the whole update will be executed. The "transactionKey" parameter must be specified if "inTransaction" is set to true. Since the operation will perform a rollback if an error occurs, the return value will not have any function when the a transaction is used.
Signature
ErrorMessage[] UpdateRespondentsWithCatiScheduling(string key,string projectId, DataSet ds, bool validate, bool merge, string uniqueKey,bool inTransaction, int transactionKey, CatiScheduling schedulingMode)

Parameters

Name Data Type Description

key

string required

The authentication key

projectId

string required

The project ID

ds

DataSet

DataSet containing the respondent rows to be updated.

validate

bool required

Validation of the content of the respondents.

merge

bool required

Update existing rows when possible.

uniqueKey

string optional

The name of the unique key to use when updating the respondents. If set to null or an empry string, the internal id (respid) for respondents will be used.

inTransaction

bool

True runs the update in a transaction, False does not.

transactionKey

int

A key, defined by the user to be able to track if the transaction succeded or not (cannot be a negative number). See GetTransactionStatus.

schedulingMode

Respondent data being loaded into a CATI enabled project will use the specified scheduling mode

Response

Data Type Description

Example