Questionnaire

The questionnaire object.

Parent class

Inherits from Array

Constructors

(int id "Id of questionnaire") - Fetch exists questionnaire by id
(string-guid guid "Id of questionnaire") - Fetch exists questionnaire by id
(string qualifiedName "Qualified name of questionnaire") - Fetch exists questionnaire by name
(string name "Questionnaire's name", int parentId "Resource parent's id", int layoutId "Questionnaire layout's id") - Create new questionnaire with new questionnaire template and use default resource template
(string name "Questionnaire's name", int parentId "Resource parent's id", int layoutId "Questionnaire layout's id", int templateId "Questionnaire template's id", int resourceTemplateId "Resource template's id of questionnaire. Set it's 0 to use default resource template") - Create new questionnaire with exist template

Methods

string GetLink() - Get the url to participate in answering the questionnaire
Empty RebuildSample() - Rebuild all sample rules in questionnaire
Empty Save() - Save questionnaire. It also save for new questionnaire template, sample rule, quota. For update, you should call save in specific object.
string ToString() - The string representation of the object.
object this[] { get; }(int index "Index") - Backward-compatible indexer
Empty this[] { get; }(int index "Index", object value "Value to set") - Backward-compatible indexer

Properties

DateTime AutomaticCloseDate { get; set; } - Automatic close date
DateTime AutomaticReleaseDate { get; set; } - Automatic release date
number Average { get; } - Average of the objects in the Array object. Can only use if all the elements are of type Number
string AverageInterviewSucceededTime { get; } - Average successful interview time
string CatiOutcomeSet { get; } - Name of the CATI outcome set (contact status type) assigned to this questionnaire
bool Completed { get; set; } - Questionnaire status completed or not
int CreatedByUserId { get; } - User created this questionnaire
DateTime CreatedDate { get; } - When this questionnaire created
string DefaultLanguage { get; } - ISO code of the questionnaire's default language
DateTime DevelopmentEndDate { get; set; } - Development end date
DateTime DevelopmentStartDate { get; set; } - Development start date
bool DisplayInMyQuestionnaire { get; set; } - Whether this questionnaire is shown in respondents' personal questionnaire list
string DisplayName { get; set; } - Questionnaire name shown to respondents in their point list
number EstimatedTotalTime { get; } - Estimated total time to run out questionnaire
int Id { get; } - Resource id of questionnaire
int ImpersonationUserId { get; set; } - Run questionnaire context with permission of specific user. Set its value is 0 to remove
Array of string Languages { get; } - ISO codes of all languages this questionnaire is available in
int LayoutId { get; set; } - Questionnaire layout's id
int ManHours { get; set; } - Estimated man-hours for this questionnaire
number Max { get; } - Largest of all the objects in the Array object. Can only use if all the elements are of type Number
number Min { get; } - Smallest of all the objects in the Array object. Can only use if all the elements are of type Number
int ModifiedByUserId { get; } - User last updated this questionnaire
DateTime ModifiedDate { get; } - Last time modify this questionnaire
string Name { get; set; } - Questionnaire name
int NumberOfActiveNotContacted { get; } - Number of not started answer sheets which are related to active sample rules
int NumberOfActiveSample { get; } - Number of answer sheets that are related to existing sample rules and where these sample rules are active (you can deactivate sample rules in the CATI)
int NumberOfAvailable { get; } - Number of answer sheets (both created via samples, from import, as well as through recurring links) that have not yet been answered.
int NumberOfAvailableActive { get; } - Number of answer sheets which are still active for answering. In other words the available answer sheets minus any sheets that have failed (user does not want to answer)
int NumberOfCompleted { get; } - Number of answer sheets which were completed
int NumberOfCompletedToday { get; } - Number of answer sheets which were completed on current date (server time-zone)
int NumberOfInterviewSucceeded { get; } - Number of interviews carried out through CATI that were successful.
int NumberOfInterviewSucceededToday { get; } - Number of interviews carried out through CATI that were successful on current date (server time-zone)
int NumberOfNotContacted { get; } - Number of answer sheets which have yet not been started
int NumberOfPartly { get; } - Specifies the number of sample respondents that have partly answered the questionnaire (means they have at least clicked the link to open their personal version of the questionnaire)
int NumberOfSample { get; } - Total number of answer sheets related to the questionnaire
int NumberOfTest { get; } - Number of test answer sheets
string ObjectTypeName { get; } - The name of the type of object.
int ParentId { get; set; } - Parent resource's id
string QualifiedName { get; } - Get qualified name of questionnaire
Array of Quota Quotas { get; } - All quotas associated with questionnaire
int ResourceTemplateId { get; set; } - Resource tempalte's id of questionnaire. Set it's 0 to use default resource template
Array of SampleRule SampleRules { get; } - All sample rules associated with questionnaire
QuestionnaireStatus constant Status { get; set; } - Questionnaire status. Use constant STATUS_xxx
number Sum { get; } - Sum of all the objects in the Array object. Can only use if all the elements are of type Number
int Target { get; set; } - Questionnaire target number
int TemplateId { get; } - Questionnaire template's id
int TimeEstimateId { get; set; } - Questionnaire time estimate's id. Set its value is 0 to remove
string TimeEstimateName { get; set; } - Questionnaire time estimate's name. Set its value is empty to remove
bool TimeRegistration { get; set; } - Whether time registration is enabled for this questionnaire
TypeInformation TypeInformation { get; } - Get information about this class.

Static Methods

Questionnaire Questionnaire_current() - Get Questionnaire in current QAS or Questionnaire context
Questionnaire Questionnaire_getByGuid(string-guid guid "Guid of questionnaire") - Fetch exists questionnaire by guid
Empty Questionnaire_save(Questionnaire questionnaire "The questionnaire object to save") - Persists changes to a questionnaire object. Use questionnaire.Save() instead.

Examples

//create new qnaire and also new qnaireTemplate under
string qnaireName = "test";
number parentId = 17148135;
number layoutId = 15735155;
Questionnaire qnaire = new Questionnaire (qnaireName, parentId, layoutId);
qnaire.ResourceTemplateId = 11088801;
qnaire.Save();

//create new qnaire using existing qnaireTemplate
string qnaireName = "test";
number parentId = 17148135;
number layoutId = 15735155;
number qnaireTemplateId = 17148298;
number resourceTemplateId = 11088801;// set 0 to use the default
Questionnaire qnaire = new Questionnaire (qnaireName, parentId, layoutId, qnaireTemplateId, resourceTemplateId);
qnaire.Save();