Difference between revisions of "QuestionnaireStatistics class"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=<nowiki>QuestionnaireStatistics</nowiki>
+
|Name=QuestionnaireStatistics
|Description=<nowiki>The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.</nowiki>
+
|Description=The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.
 
|Constructors=
 
|Constructors=
 
{{CGscriptConstructors_Template|Parameters=
 
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=array|Name=<nowiki>qids</nowiki>|Description=<nowiki>An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.</nowiki>}}
+
{{CGscriptParameters_Template|Type=array|Name=qids|Description=An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.}}
|Description=<nowiki>Constructor to take many questionnaires</nowiki>}}
+
|Description=Constructor to take many questionnaires}}
 
|Methods=
 
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>AverageInterviewSucceededTime</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=string|Name=AverageInterviewSucceededTime|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of AverageInterviewSucceededTime</nowiki>}}
+
|Description=Get count of AverageInterviewSucceededTime}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTime</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=EstimatedTime|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of EstimatedTime</nowiki>}}
+
|Description=Get count of EstimatedTime}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>EstimatedTotalTime</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=EstimatedTotalTime|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of EstimatedTotalTime</nowiki>}}
+
|Description=Get count of EstimatedTotalTime}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NonSampleRules</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NonSampleRules|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NonSampleRules</nowiki>}}
+
|Description=Get count of NonSampleRules}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NonSampleRulesWithData</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NonSampleRulesWithData|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NonSampleRulesWithData</nowiki>}}
+
|Description=Get count of NonSampleRulesWithData}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NonSampleRulesWithoutData</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NonSampleRulesWithoutData|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NonSampleRulesWithoutData</nowiki>}}
+
|Description=Get count of NonSampleRulesWithoutData}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfActiveNotContactedRpq</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfActiveNotContactedRpq|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfActiveNotContactedRpq</nowiki>}}
+
|Description=Get count of NumberOfActiveNotContactedRpq}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfActiveSample</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfActiveSample|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfActiveSample</nowiki>}}
+
|Description=Get count of NumberOfActiveSample}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfAvailable</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfAvailable|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfAvailable</nowiki>}}
+
|Description=Get count of NumberOfAvailable}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfAvailableActive</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfAvailableActive|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfAvailableActive</nowiki>}}
+
|Description=Get count of NumberOfAvailableActive}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfCompleted</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfCompleted|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfCompleted</nowiki>}}
+
|Description=Get count of NumberOfCompleted}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfCompletedToday</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfCompletedToday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfCompletedToday</nowiki>}}
+
|Description=Get count of NumberOfCompletedToday}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfCompletedYesterday</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfCompletedYesterday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfCompletedYesterday</nowiki>}}
+
|Description=Get count of NumberOfCompletedYesterday}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfInterviewSucceeded</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfInterviewSucceeded|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfInterviewSucceeded</nowiki>}}
+
|Description=Get count of NumberOfInterviewSucceeded}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfInterviewSucceededToday</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfInterviewSucceededToday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfInterviewSucceededToday</nowiki>}}
+
|Description=Get count of NumberOfInterviewSucceededToday}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfInterviewSucceededYesterday</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfInterviewSucceededYesterday|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfInterviewSucceededYesterday</nowiki>}}
+
|Description=Get count of NumberOfInterviewSucceededYesterday}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfNotContactedRpq</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfNotContactedRpq|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfNotContactedRpq</nowiki>}}
+
|Description=Get count of NumberOfNotContactedRpq}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfPartly</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfPartly|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfPartly</nowiki>}}
+
|Description=Get count of NumberOfPartly}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfSample</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfSample|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfSample</nowiki>}}
+
|Description=Get count of NumberOfSample}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>NumberOfTestLink</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfTestLink|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of NumberOfTestLink</nowiki>}}
+
|Description=Get count of NumberOfTestLink}}
{{CGscriptMethods_Template|ReturnType=number|Name=<nowiki>TargetReachedCount</nowiki>|Parameters=
+
{{CGscriptMethods_Template|ReturnType=number|Name=TargetReachedCount|Parameters=
{{CGscriptParameters_Template|Type=number|Name=<nowiki>QuestionnaireResourceId</nowiki>|Description=<nowiki>The Id to get the info from</nowiki>}}
+
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
|Description=<nowiki>Get count of TargetReachedCount</nowiki>}}
+
|Description=Get count of TargetReachedCount}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
+
{{CGscriptMethods_Template|ReturnType=DateTime|Name=FirstInterview|Parameters=
 +
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
 +
|Description=Get start date of the first interview}}
 +
{{CGscriptMethods_Template|ReturnType=DateTime|Name=LatestInterview|Parameters=
 +
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
 +
|Description=Get end date of the latest interview}}
 +
{{CGscriptMethods_Template|ReturnType=number|Name=NumberOfEmails|Parameters=
 +
{{CGscriptParameters_Template|Type=number|Name=QuestionnaireResourceId|Description=The Id to get the info from}}
 +
|Description=Get number of emails was send out}}
 +
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
 
|Properties=
 
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
 
}}
 
}}

Revision as of 09:59, 31 October 2016

QuestionnaireStatistics



The questionnaire statistics collection. To view information like how big a sample is used, how large is the active samples etc.

Constructors

  • (array qids "An array of questionnaire resource ids. Invalid ids are ignored. Deleted ids are ok. Must have Read permission.") - Constructor to take many questionnaires

Methods

  • string AverageInterviewSucceededTime(number QuestionnaireResourceId "The Id to get the info from") - Get count of AverageInterviewSucceededTime
  • number EstimatedTime(number QuestionnaireResourceId "The Id to get the info from") - Get count of EstimatedTime
  • number EstimatedTotalTime(number QuestionnaireResourceId "The Id to get the info from") - Get count of EstimatedTotalTime
  • number NonSampleRules(number QuestionnaireResourceId "The Id to get the info from") - Get count of NonSampleRules
  • number NonSampleRulesWithData(number QuestionnaireResourceId "The Id to get the info from") - Get count of NonSampleRulesWithData
  • number NonSampleRulesWithoutData(number QuestionnaireResourceId "The Id to get the info from") - Get count of NonSampleRulesWithoutData
  • number NumberOfActiveNotContactedRpq(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfActiveNotContactedRpq
  • number NumberOfActiveSample(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfActiveSample
  • number NumberOfAvailable(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfAvailable
  • number NumberOfAvailableActive(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfAvailableActive
  • number NumberOfCompleted(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfCompleted
  • number NumberOfCompletedToday(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfCompletedToday
  • number NumberOfCompletedYesterday(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfCompletedYesterday
  • number NumberOfInterviewSucceeded(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfInterviewSucceeded
  • number NumberOfInterviewSucceededToday(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfInterviewSucceededToday
  • number NumberOfInterviewSucceededYesterday(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfInterviewSucceededYesterday
  • number NumberOfNotContactedRpq(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfNotContactedRpq
  • number NumberOfPartly(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfPartly
  • number NumberOfSample(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfSample
  • number NumberOfTestLink(number QuestionnaireResourceId "The Id to get the info from") - Get count of NumberOfTestLink
  • number TargetReachedCount(number QuestionnaireResourceId "The Id to get the info from") - Get count of TargetReachedCount
  • DateTime FirstInterview(number QuestionnaireResourceId "The Id to get the info from") - Get start date of the first interview
  • DateTime LatestInterview(number QuestionnaireResourceId "The Id to get the info from") - Get end date of the latest interview
  • number NumberOfEmails(number QuestionnaireResourceId "The Id to get the info from") - Get number of emails was send out
  • string ToString() - The string representation of the object.

Properties

  • string ObjectTypeName { get; } - The name of the type of object.
  • TypeInformation TypeInformation { get; } - Get information about this class.