DatStat Illume 4.5 SDK Class Reference

WebServiceContext.ImportParticipants Method

This method will import and add new participants to a participant list from a file stream.

Overload List

Any collisions that occur using this overload will be returned in the ref parameter collisions.

public SDK_Participant[] ImportParticipants(SDK_ParticipantList,Stream,Boolean,Boolean,Boolean,ref SDK_Participant[]&);

The update parameter dictates what happens if a collision is found for this overload method.

public SDK_Participant[] ImportParticipants(SDK_ParticipantList,Stream,Boolean,Boolean,Boolean,ref SDK_Participant[]&,Boolean);

Remarks

The file is assumed to be a tab-delimited. The tab-delimited participant list file format is specific and may include a number of fields for each participant. The column names “FIRSTNAME”, “LASTNAME”, “EMAIL”, and “CUSTOMID” are reserved for the standard data fields and indicate those important attributes of the participant.

Any column that is not one of the standard data fields will be considered a custom field (User Data) and added to the participant data as custom data. To create test users in your participant list, create a column with the header TESTDATA. In this column, enter “1”, “Yes”, or “True” (without the quotation marks) to mark the participant as a test participant. Illume will mark any data submitted by these users as test data.

The boolean parameters lastFirstNameUnique, emailUnique, and customIdUnique tell the system which of the given system participant values (i.e. email, lastName/firstName, customId) shoud be verified unique.

If successful, this method will return one or more instances of SDK_Participant for the new or updated participants. Note that the participants returned will contain the IDs of the participants for future use.

If there is an error during the operation, an exception will be thrown with an appropriate error message.

See Also

WebServiceContext Class | DatStat.SDK.WebServiceWrappers Namespace