DatStat Illume 4.5 SDK Class Reference

DatStat.SDK.WebServiceWrappers Namespace

Namespace hierarchy

Classes

Class Description
MakeSubmissionOptions The MakeSubmissionOptions class defines a set of properties that control how different options and behaviors of the MakeSubmission method.
SDK_DailyCount Used to represent the number of submissions made to a survey on a specific date.
SDK_DataDictionary Read only representation of a Survey Data Dictionary.
SDK_DictionaryEntry Read only represenation of a data dictionary entry.
SDK_EmailJob Wrapper for an Illume email job.
SDK_EmailSendLogEntry Wrapper for an email send log entry. Provides details about the address an email was sent to, the date the email was sent and if Illume received an error when sending the email.
SDK_Participant Wrapper for Illume participant. Provides methods to add and remove custom participant data.
SDK_ParticipantList Read only wrapper for Illume participant list.
SDK_Query An Illume SDK Query.

SDK_Query objects are not instantiated via a constructor. Rather they are created by calling the CreateQuery method. SDK Queries are executed by calling the appropriate ExecuteQuery method.

SDK_ScaleValue Provides read-only details about a specific scale value for a survey variable.
SDK_Section Read only representation of a data dictionary section.
SDK_SurveyActionSummary Provides a summary of the number of participants that have submitted, partially completed and not started a survey for a specific time period.
SDK_SurveyDetail Provides a high level overview of a survey. Includes properties like name, description and publish dates etc. for a survey. Also provides several methods to retrieve specific objects related to the survey such as participant lists, email jobs and the data dictionary.
SDK_SurveyQuery Wrapper for an Illume survey query. Gives the name, description, owner and LCID (if specified) for a query.
SDK_SurveySession Gives details for a specific survey session. Includes information such as the participant id, the survey name, survey id, and submission status for this session.
SDK_TimePeriod Wrapper for an Illume time period.
SDK_User Provides details about a specific Illume user account such as name, address, email address etc.
WebServiceContext The WebServiceContext is used to connect to and request services from the Illume DesignerService. Once a WebServiceContext is instantiated, it's methods and properties expose SDK functionality via properties and methods.

Enumerations

Enumeration Description
ParticipantQueryOperator Operations available for retrieving participants using the QueryParticipants method.
SDK_DataFormat Indicates if results should be presented in summary or raw foramt.
SDK_DataType Indicates the data type of a survey variable.
SDK_DisplayType Indicates the runtime display type of a survey variable.
SDK_ParticipantSurveyStatus Indicates the status for a particular participant with respect to a survey.
SDK_QueryFilterType Indicates how to group filter expressions when more than one filter is declared for a query.
SDK_QueryOperator Operators available when creating query filters.
SDK_QueryResultType Designates the type of results that should be returned from an SDK_Query when calling the ExecuteQuery method.
SDK_ResultsType Indicates what format a result set should have when streamed to an output TextWriter stream.
SDK_SortDirection Indicates the sort direction that will be used when returning query results.