Questionnaire class - Revision history

Antester@voxmeter.dk at 04:56, 31 March 2026

2026-03-31T04:56:20Z

← Older revision		Revision as of 04:56, 31 March 2026
Line 5:		Line 5:
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Id of questionnaire</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Id of questionnaire</nowiki>}}
			\|Description=<nowiki>Fetch exists questionnaire by id</nowiki>}}
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=string-guid\|Name=<nowiki>guid</nowiki>\|Description=<nowiki>Id of questionnaire</nowiki>}}
	\|Description=<nowiki>Fetch exists questionnaire by id</nowiki>}}		\|Description=<nowiki>Fetch exists questionnaire by id</nowiki>}}
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
Line 31:		Line 34:
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>DisplayName</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Questionnaire name shown to respondents in their point list</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>DisplayName</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Questionnaire name shown to respondents in their point list</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>EstimatedTotalTime</nowiki>\|HasGetter=1\|Description=<nowiki>Estimated total time to run out questionnaire</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>EstimatedTotalTime</nowiki>\|HasGetter=1\|Description=<nowiki>Estimated total time to run out questionnaire</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>~~Reosurce~~ id of questionnaire</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Resource id of questionnaire</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonationUserId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Run questionnaire context with permission of specific user. Set its value is 0 to remove</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ImpersonationUserId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Run questionnaire context with permission of specific user. Set its value is 0 to remove</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>LayoutId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Questionnaire layout's id</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>LayoutId</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Questionnaire layout's id</nowiki>}}
Line 63:		Line 66:
	\|StaticMethods=		\|StaticMethods=
	{{CGscriptMethods_Template\|ReturnType=Questionnaire\|Name=<nowiki>Questionnaire_current</nowiki>\|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Questionnaire\|Name=<nowiki>Questionnaire_current</nowiki>\|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Questionnaire\|Name=<nowiki>Questionnaire_getByGuid</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=string-guid\|Name=<nowiki>guid</nowiki>\|Description=<nowiki>Guid of questionnaire</nowiki>}}
			\|Description=<nowiki>Fetch exists questionnaire by guid</nowiki>}}
	}}		}}

Nguyenduyan at 08:40, 14 August 2025

2025-08-14T08:40:12Z

← Older revision		Revision as of 08:40, 14 August 2025
Line 29:		Line 29:
	{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DevelopmentEndDate</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Development end date</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DevelopmentEndDate</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Development end date</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DevelopmentStartDate</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Development start date</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DevelopmentStartDate</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Development start date</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>DisplayName</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Questionnaire name shown to respondents in their point list</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>EstimatedTotalTime</nowiki>\|HasGetter=1\|Description=<nowiki>Estimated total time to run out questionnaire</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>EstimatedTotalTime</nowiki>\|HasGetter=1\|Description=<nowiki>Estimated total time to run out questionnaire</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Reosurce id of questionnaire</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Reosurce id of questionnaire</nowiki>}}
Line 63:		Line 64:
	{{CGscriptMethods_Template\|ReturnType=Questionnaire\|Name=<nowiki>Questionnaire_current</nowiki>\|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Questionnaire\|Name=<nowiki>Questionnaire_current</nowiki>\|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}
	}}		}}


	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===
	<source lang="javascript">		<source lang="javascript">

Administrator at 02:40, 11 May 2022

2022-05-11T02:40:21Z

← Older revision		Revision as of 02:40, 11 May 2022
Line 63:		Line 63:
	{{CGscriptMethods_Template\|ReturnType=Questionnaire\|Name=<nowiki>Questionnaire_current</nowiki>\|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Questionnaire\|Name=<nowiki>Questionnaire_current</nowiki>\|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}
	}}		}}
			=== <span style="color:#DF8621">'''Examples'''</span> ===
			<source lang="javascript">
			//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();
			</source>
			<source lang="javascript">
			//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();
			</source>

Administrator: Created page with "{{CGscriptClass_Template |Name=Questionnaire |Description=The questionnaire object. |InheritsFrom=object|Constructors= {{CGscriptConstructors..."

2022-04-25T09:31:38Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>Questionnaire</nowiki> |Description=<nowiki>The questionnaire object.</nowiki> |InheritsFrom=object|Constructors= {{CGscriptConstructors..."

New page

{{CGscriptClass_Template
|Name=<nowiki>Questionnaire</nowiki>
|Description=<nowiki>The questionnaire object.</nowiki>
|InheritsFrom=object|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>id</nowiki>|Description=<nowiki>Id of questionnaire</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire by id</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>qualifiedName</nowiki>|Description=<nowiki>Qualified name of questionnaire</nowiki>}}
|Description=<nowiki>Fetch exists questionnaire by name</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Questionnaire's name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Resource parent's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>layoutId</nowiki>|Description=<nowiki>Questionnaire layout's id</nowiki>}}
|Description=<nowiki>Create new questionnaire with new questionnaire template and use default resource template</nowiki>}}
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Questionnaire's name</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>parentId</nowiki>|Description=<nowiki>Resource parent's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>layoutId</nowiki>|Description=<nowiki>Questionnaire layout's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>templateId</nowiki>|Description=<nowiki>Questionnaire template's id</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>resourceTemplateId</nowiki>|Description=<nowiki>Resource tempalte's id of questionnaire. Set it's 0 to use default resource template</nowiki>}}
|Description=<nowiki>Create new questionnaire with exist template</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>GetLink</nowiki>|Description=<nowiki>Get the url to participate in answering the questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RebuildSample</nowiki>|Description=<nowiki>Rebuild all sample rules in questionnaire</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save questionnaire. It also save for new questionnaire template, sample rule, quota. For update, you should call save in specific object.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>AutomaticCloseDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Automatic close date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>AutomaticReleaseDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Automatic release date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AverageInterviewSucceededTime</nowiki>|HasGetter=1|Description=<nowiki>Average successful interview time</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Completed</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire status completed or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>CreatedByUserId</nowiki>|HasGetter=1|Description=<nowiki>User created this questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>CreatedDate</nowiki>|HasGetter=1|Description=<nowiki>When this questionnaire created</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DevelopmentEndDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Development end date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DevelopmentStartDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Development start date</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>EstimatedTotalTime</nowiki>|HasGetter=1|Description=<nowiki>Estimated total time to run out questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Id</nowiki>|HasGetter=1|Description=<nowiki>Reosurce id of questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ImpersonationUserId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Run questionnaire context with permission of specific user. Set its value is 0 to remove</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>LayoutId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire layout's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ModifiedByUserId</nowiki>|HasGetter=1|Description=<nowiki>User last updated this questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>ModifiedDate</nowiki>|HasGetter=1|Description=<nowiki>Last time modify this questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire name</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfActiveNotContacted</nowiki>|HasGetter=1|Description=<nowiki>Number of not started answer sheets which are related to active sample rules</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfActiveSample</nowiki>|HasGetter=1|Description=<nowiki>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)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfAvailable</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets (both created via samples, from import, as well as through recurring links) that have not yet been answered.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfAvailableActive</nowiki>|HasGetter=1|Description=<nowiki>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)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfCompleted</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets which were completed</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfCompletedToday</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets which were completed on current date (server time-zone)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceeded</nowiki>|HasGetter=1|Description=<nowiki>Number of interviews carried out through CATI that were successful.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfInterviewSucceededToday</nowiki>|HasGetter=1|Description=<nowiki>Number of interviews carried out through CATI that were successful on current date (server time-zone)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfNotContacted</nowiki>|HasGetter=1|Description=<nowiki>Number of answer sheets which have yet not been started</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfPartly</nowiki>|HasGetter=1|Description=<nowiki>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)</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfSample</nowiki>|HasGetter=1|Description=<nowiki>Total number of answer sheets related to the questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfTest</nowiki>|HasGetter=1|Description=<nowiki>Number of test answer sheets</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ParentId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Parent resource's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>QualifiedName</nowiki>|HasGetter=1|Description=<nowiki>Get qualified name of questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of Quota|Name=<nowiki>Quotas</nowiki>|HasGetter=1|Description=<nowiki>All quotas associated with questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ResourceTemplateId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Resource tempalte's id of questionnaire. Set it's 0 to use default resource template</nowiki>}}
{{CGscriptProperties_Template|ReturnType=Array of SampleRule|Name=<nowiki>SampleRules</nowiki>|HasGetter=1|Description=<nowiki>All sample rules associated with questionnaire</nowiki>}}
{{CGscriptProperties_Template|ReturnType=QuestionnaireStatus constant|Name=<nowiki>Status</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire status. Use constant QUESTIONNAIRE_STATUS_xxx</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Target</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire target number</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TemplateId</nowiki>|HasGetter=1|Description=<nowiki>Questionnaire template's id</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>TimeEstimateId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire time estimate's id. Set its value is 0 to remove</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>TimeEstimateName</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire time estimate's name. Set its value is empty to remove</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
|StaticMethods=
{{CGscriptMethods_Template|ReturnType=Questionnaire|Name=<nowiki>Questionnaire_current</nowiki>|Description=<nowiki>Get questionnaire in current QAS or PQ context</nowiki>}}
}}