The WebService SDK exposes a collection of SDK wrapper objects that represent the underlying Illume system objects. Table 1 lists these objects and gives a brief explaination of their use:
| SDK Wrapper Class | Description |
|---|---|
| SDK_DailyCount | Used to represent the number of submissions to a survey for a given date. |
| SDK_DataDictionary | Represents all data dictionary entries for a survey. |
| SDK_DictionaryEntry | A specific data dictionary entry. Includes information such as data type, display type and scale values. |
| SDK_EmailJob | Represents an Illume email job. Includes information such as the name of the email job, what participant list it uses, the number of emails that have been sent, etc. |
| SDK_EmailSendLogEntry | Represents an email send log entry. Indicates who an email was sent to, when the email was sent, what job sent the email and if Illume received an error while sending the email. |
| SDK_Participant | Represents an Illume participant. Includes information like the participant id, their name, email address and any custom participant data associated with this participant. |
| SDK_ParticipantList | Represents an Illume participant list. Includes the number of participants that belong to the list, the name of the list and what project the list belongs to. |
| SDK_Query | Represents an Illume survey query. SDK_Query objects are created by the web service context for a specific survey and list of variables in that survey. Using this object, the SDK programmer can formulate complex queries and request the retrieval of raw data, summary statistics, or both. |
| SDK_ScaleValue | Represents a scale value from a response scale defined in a survey question. |
| SDK_Section | Represents a collection of data dictionary entries grouped into a section. |
| SDK_SurveyActionSummary | Represents a summary of the number of participants that have submitted, partially completed and not-started a survey for a given time period. Also contains a collection of SDK_DailyCount objects to give a more detailed daily representation of survey activity during the time period. |
| SDK_SurveyDetail | Gives a high level summary of a survey such as the name, description, and publish dates etc. of the survey. Also provides methods to access specific objects related to a survey such as email jobs, participant lists or survey queries. |
| SDK_SurveyQuery | Represents a survey query and gives the name, description, owner and Lcid used to create the 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 | Represents an Illume time period. Gives details such as the time period name, the total number of submissions for the time period, and what version of the survey was running during the time period. |
| SDK_User | Gives details about a specific Illume user account such as name, address, email address etc. |
Next: WebService SDK Setup