DatStat Illume 4.5 SDK Class Reference

WebServiceContext.QueryParticipants Method 

This method will retrieve one or more participants from a participant list which meet the optional criteria for lastName, firstName, email, and customId.

public SDK_Participant[] QueryParticipants(
   SDK_ParticipantList list,
   ParticipantQueryOperator participantOp,
   String participantId,
   ParticipantQueryOperator lastNameOp,
   String lastName,
   ParticipantQueryOperator firstNameOp,
   String firstName,
   ParticipantQueryOperator emailOp,
   String email,
   ParticipantQueryOperator customIdOp,
   String customId
);

Parameters

list
The SDK_ParticipantList to query for participants.
participantOp
ParticipantQueryOperator indicating what kind of comparison to do on the participantId
participantId
The id of the participant to lookup. To ignore this parameter pass ParticpantQueryOperator.None for participantOp and a null value for participantId
lastNameOp
ParticipantQueryOperator indicating what kind of comparison to do on the lastName
lastName
The last name of the participant to lookup. To ignore this parameter pass ParticipantQueryOperator.None for lastNameOp and a null value for lastName.
firstNameOp
ParticipantQueryOperator indicating what kind of comparison to do on the firstName
firstName
The first name of the participant to lookup. To ignore this parameter pass ParticipantQueryOperator.None for firstNameOp and a null value for firstName.
emailOp
ParticipantQueryOperator indicating what kind of comparison to do on the email
email
The email address of the participant to lookup. To ignore this parameter pass ParticipantQueryOperator.None for emailOp and a null value for email.
customIdOp
ParticipantQueryOperator indicating what kind of comparison to do on the customId
customId
The custom id of the participant to lookup. To ignore this parameter pass ParticipantQueryOperator.None for customIdOp and a null value for customId.

Return Value

SDK_Participant[]

Remarks

The criteria are passed in using operator/value pairs. See the ParticipantQueryOperator Enumeration for all possible operators. If you do not wish to limit by a particular value simply use ParticipantQueryOperator.None and a value of null.

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

See Also

WebServiceContext Class | DatStat.SDK.WebServiceWrappers Namespace | ParticipantQueryOperator