GetFilteredQuestionnaire

Description

Get Questionnaire (Routing, PredefinedLists and Quotas). Allows caller to filter out unwanted information (Script nodes)

Signature
SurveySchema GetFilteredQuestionnaire(string key, string projectId, bool projectSpecific, PoetReadFilter filter)

Parameters

Name Data Type Description

key

string required

The authentication key

projectId

string required

ID of the project

projectSpecific

bool required

True means that the questionnaire should be linked to the project and can be updated, False means that the questionnaire should not be linked to the project and can be used to update other projects

filter

PoetReadFilter required

Filter specifying what information is to be filtered out

Response

Data Type Description

ObjectStructure containing the filtered Questionnaire

Example

// Create instance of the webservice
var authoring = new AuthoringSoapClient();

//***************************************************
//
// Get FilteredQuestionnaire. Only get question "s1".
//
//***************************************************

//Create a PoetReadFilter
PoetReadFilter filter = new PoetReadFilter();
filter.IncludeAllLanguages=true;
filter.IncludeChildren = true;
filter.IncludeText = true;
filter.IncludeAllNodeTypes = true;
filter.Forms = new string[1]{"s1"};

// Get the questionnaire
SurveySchema def = authoring.GetFilteredQuestionnaire(key,projectID,true,filter);