Retrieve Blue response data in XML
The following information in these topics is intended to provide an example of how you can utilize Blue web service APIs to retrieve an XML version of the response data from Blue:
| Blue web service API | Description | |
|---|---|---|
| 1 | GetProjectDetails() | Allows you to pull all the existing projects, along with basic information and status |
| 2 | GetSubjectList() | Allows you to pull a list of all the subjects (i.e. courses) within a specified project |
| 3 | GetResponse2() | Allows you to pull all the responses for a certain context/project combination. The results will be in XML format |
| 4 | GetProjectInfo() | Allows you to pull the questionnaire structure |
Procedure to pull response data from Blue:
- Call GetProjectDetails() to retrieve a list of projects with basic information.
- Call GetSubjectList() to retrieve a list of course IDs within a project.
- Call GetResponse2() to get responses.
- Call GetProjectInfo() to obtain questionnaire object and use it to find the position of each question response within the returned responses.
GetResponse2
GetResponse2(string ProjectID, string SubjectID, string ContextID, Boolean showDeleted, string multiMode, Boolean ShowPrimarySubjectDetail, Boolean ShowSecondarySubjectDetail)
Parameters:
- showDeleted decides if deleted responses should be included in the returned values.
- multiMode takes value like “join”, “subject” and “context.”
- ProjectID tells this function where to get responses
- SubjectID or ContextID is only used to return responses for a specific course. When SubjectID and ContextID are empty strings, this function returns all responses from a project.
- The last two parameters can be used to obtain course information or instructor information along with each response.
When a project is multi-subject or multi-secondary subject:
- multimode = “join”, GetResponse2() returns responses for all questions that are joined from a subject response table and a secondary response table based on column “MapRespKey”
- multimode = “subject”, GetResponse2() only returns responses for primary subject questions
- multimode = “context”, GetResponse2() only returns responses for secondary subject questions
The default multimode value for a multi-subject project is “join.”
When a project is not multi-subject or multi-secondary subject, the parameter of multimode is irrelevant.
Blue question objects
Understanding Blue Question objects, and how to obtain necessary information from them, is helpful for anyone who wishes to import Blue response data into their data warehouse.
All question types are inherited from the Base Question.
Type_Rating, Type_Multiple_Selection, and Type_Comments_Box are derived from the Base Question.
Type_Rating is the base for Single Selection Question and Single Selection Table.
Type_Multiple_Selection is the base for Multiple Selection Question and Multiple Selection Table.