FieldWorkManagement class - Revision history

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

2026-03-31T04:44:03Z

← Older revision		Revision as of 04:44, 31 March 2026
Line 5:		Line 5:
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of the questionnaire</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>interviewerResourceId</nowiki>\|Description=<nowiki>Resource id of the user that is interviewing. 0 to use current user</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of the questionnaire</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>interviewerResourceId</nowiki>\|Description=<nowiki>Resource id of the user that is interviewing. 0 to use current user</nowiki>}}
			\|Description=<nowiki>Manage the given questionnaire and interviewer.</nowiki>}}
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=string-guid\|Name=<nowiki>questionnaireGuid</nowiki>\|Description=<nowiki>Guid of the questionnaire</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=string-guid?\|Name=<nowiki>interviewerGuid</nowiki>\|Description=<nowiki>Guid of the user that is interviewing. empty to use current user</nowiki>}}
	\|Description=<nowiki>Manage the given questionnaire and interviewer.</nowiki>}}		\|Description=<nowiki>Manage the given questionnaire and interviewer.</nowiki>}}
	\|Methods=		\|Methods=
Line 19:		Line 22:
	{{CGscriptParameters_Template\|Type=CatiListType constant\|Name=<nowiki>catiList</nowiki>\|Description=<nowiki>Which list to return</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}		{{CGscriptParameters_Template\|Type=CatiListType constant\|Name=<nowiki>catiList</nowiki>\|Description=<nowiki>Which list to return</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}		\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=CatiQasSearchQuery\|Name=<nowiki>SearchQuery</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=CatiListType constant\|Name=<nowiki>catiList</nowiki>\|Description=<nowiki>Which list to return</nowiki>}}
			\|Description=<nowiki>Get list of qas on the given list, using the interviewers sample settings.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=

Administrator at 03:50, 6 July 2021

2021-07-06T03:50:43Z

← Older revision		Revision as of 03:50, 6 July 2021
Line 23:		Line 23:
	{{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=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Inherited=object\|Description=<nowiki>Get information about this class.</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=Dictionary\|Name=<nowiki>FieldWorkManagement_listOfCurrentInterviewersAllProjects</nowiki>\|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records currently active (+-2hours) grouped by questionnaire resource id.</nowiki>}}
	}}		}}

Administrator at 07:08, 2 July 2020

2020-07-02T07:08:45Z

Administrator at 08:09, 12 February 2019

2019-02-12T08:09:24Z

← Older revision		Revision as of 08:09, 12 February 2019
Line 10:		Line 10:
	{{CGscriptParameters_Template\|Type=SampleRule\|Name=<nowiki>sr</nowiki>\|Description=<nowiki>Samplerule to restrict to.</nowiki>}}		{{CGscriptParameters_Template\|Type=SampleRule\|Name=<nowiki>sr</nowiki>\|Description=<nowiki>Samplerule to restrict to.</nowiki>}}
	\|Description=<nowiki>Restrict interviewer to only allow access to a specific sample. Return false if already restricted.</nowiki>}}		\|Description=<nowiki>Restrict interviewer to only allow access to a specific sample. Return false if already restricted.</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=Array of QAS\|Name=<nowiki>AppointmentList</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>pageSize</nowiki>\|Description=<nowiki>How many items to fetch</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>page</nowiki>\|Description=<nowiki>Which page to fetch records for</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>AppointmentListCount</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get count of qas on the given list.</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>EnsureEmployeeAssignmentRecord</nowiki>\|Description=<nowiki>Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>EnsureEmployeeAssignmentRecord</nowiki>\|Description=<nowiki>Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=Array of QAS\|Name=<nowiki>FinishedList</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>pageSize</nowiki>\|Description=<nowiki>How many items to fetch</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>page</nowiki>\|Description=<nowiki>Which page to fetch records for</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>FinishedListCount</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get count of qas on the given list.</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=Array of numbers\|Name=<nowiki>ListOfInterviewers</nowiki>\|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records today.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Array of numbers\|Name=<nowiki>ListOfInterviewers</nowiki>\|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records today.</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=Array of QAS\|Name=<nowiki>MainList</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>pageSize</nowiki>\|Description=<nowiki>How many items to fetch</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>page</nowiki>\|Description=<nowiki>Which page to fetch records for</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>MainListCount</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get count of qas on the given list.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=Array of QAS\|Name=<nowiki>OngoingList</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>pageSize</nowiki>\|Description=<nowiki>How many items to fetch</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>page</nowiki>\|Description=<nowiki>Which page to fetch records for</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}~~
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>OngoingListCount</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get count of qas on the given list.</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>RemoveRestrictSampleTo</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>RemoveRestrictSampleTo</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=SampleRule\|Name=<nowiki>sr</nowiki>\|Description=<nowiki>Samplerule to remove restrict to.</nowiki>}}		{{CGscriptParameters_Template\|Type=SampleRule\|Name=<nowiki>sr</nowiki>\|Description=<nowiki>Samplerule to remove restrict to.</nowiki>}}
	\|Description=<nowiki>Remove restrict interviewer to only allow access to a specific sample.</nowiki>}}		\|Description=<nowiki>Remove restrict interviewer to only allow access to a specific sample.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>RestrictSampleToList</nowiki>\|Description=<nowiki>List of samples interviewer is restricted to. None means access to all.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>RestrictSampleToList</nowiki>\|Description=<nowiki>List of samples interviewer is restricted to. None means access to all.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=~~Array of QAS~~\|Name=<nowiki>~~RetryList~~</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=CatiQasSearchQuery\|Name=<nowiki>SearchQuery</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>~~pageSize~~</nowiki>\|Description=<nowiki>~~How many items~~ to ~~fetch~~</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=~~int~~\|Name=<nowiki>~~page~~</nowiki>\|Description=<nowiki>~~Which page to fetch records for~~</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>catiList</nowiki>\|Description=<nowiki>Which list to return</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>allowNoPhone</nowiki>\|Description=<nowiki>Include those without phonenumbers in the result</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}		\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
	~~{{CGscriptMethods_Template\|ReturnType=int\|Name=<nowiki>RetryListCount</nowiki>\|Parameters=~~
	{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	~~\|Description=<nowiki>Get count of qas on the given list.</nowiki>}}~~
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=

Administrator: Created page with "{{CGscriptClass_Template |Name=FieldWorkManagement |Description=Manage cati questionnaire. |Constructors= {{CGscriptConstructors_Template|Par..."

2019-01-29T09:13:18Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>FieldWorkManagement</nowiki> |Description=<nowiki>Manage cati questionnaire.</nowiki> |Constructors= {{CGscriptConstructors_Template|Par..."

New page

{{CGscriptClass_Template
|Name=<nowiki>FieldWorkManagement</nowiki>
|Description=<nowiki>Manage cati questionnaire.</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Resource id of the questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>interviewerResourceId</nowiki>|Description=<nowiki>Resource id of the user that is interviewing. 0 to use current user</nowiki>}}
|Description=<nowiki>Manage the given questionnaire and interviewer.</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>AddRestrictSampleTo</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=SampleRule|Name=<nowiki>sr</nowiki>|Description=<nowiki>Samplerule to restrict to.</nowiki>}}
|Description=<nowiki>Restrict interviewer to only allow access to a specific sample. Return false if already restricted.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of QAS|Name=<nowiki>AppointmentList</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>pageSize</nowiki>|Description=<nowiki>How many items to fetch</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>page</nowiki>|Description=<nowiki>Which page to fetch records for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>AppointmentListCount</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get count of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>EnsureEmployeeAssignmentRecord</nowiki>|Description=<nowiki>Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of QAS|Name=<nowiki>FinishedList</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>pageSize</nowiki>|Description=<nowiki>How many items to fetch</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>page</nowiki>|Description=<nowiki>Which page to fetch records for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>FinishedListCount</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get count of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of numbers|Name=<nowiki>ListOfInterviewers</nowiki>|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records today.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of QAS|Name=<nowiki>MainList</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>pageSize</nowiki>|Description=<nowiki>How many items to fetch</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>page</nowiki>|Description=<nowiki>Which page to fetch records for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>MainListCount</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get count of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of QAS|Name=<nowiki>OngoingList</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>pageSize</nowiki>|Description=<nowiki>How many items to fetch</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>page</nowiki>|Description=<nowiki>Which page to fetch records for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>OngoingListCount</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get count of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveRestrictSampleTo</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=SampleRule|Name=<nowiki>sr</nowiki>|Description=<nowiki>Samplerule to remove restrict to.</nowiki>}}
|Description=<nowiki>Remove restrict interviewer to only allow access to a specific sample.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of SampleRule|Name=<nowiki>RestrictSampleToList</nowiki>|Description=<nowiki>List of samples interviewer is restricted to. None means access to all.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=Array of QAS|Name=<nowiki>RetryList</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=int|Name=<nowiki>pageSize</nowiki>|Description=<nowiki>How many items to fetch</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>page</nowiki>|Description=<nowiki>Which page to fetch records for</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=int|Name=<nowiki>RetryListCount</nowiki>|Parameters=
{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
|Description=<nowiki>Get count of qas on the given list.</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

← Older revision		Revision as of 07:08, 2 July 2020
Line 2:		Line 2:
	\|Name=<nowiki>FieldWorkManagement</nowiki>		\|Name=<nowiki>FieldWorkManagement</nowiki>
	\|Description=<nowiki>Manage cati questionnaire.</nowiki>		\|Description=<nowiki>Manage cati questionnaire.</nowiki>
	\|Constructors=		\|InheritsFrom=object\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of the questionnaire</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>interviewerResourceId</nowiki>\|Description=<nowiki>Resource id of the user that is interviewing. 0 to use current user</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of the questionnaire</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>interviewerResourceId</nowiki>\|Description=<nowiki>Resource id of the user that is interviewing. 0 to use current user</nowiki>}}
Line 11:		Line 11:
	\|Description=<nowiki>Restrict interviewer to only allow access to a specific sample. Return false if already restricted.</nowiki>}}		\|Description=<nowiki>Restrict interviewer to only allow access to a specific sample. Return false if already restricted.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>EnsureEmployeeAssignmentRecord</nowiki>\|Description=<nowiki>Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=bool\|Name=<nowiki>EnsureEmployeeAssignmentRecord</nowiki>\|Description=<nowiki>Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Array of ~~numbers~~\|Name=<nowiki>ListOfInterviewers</nowiki>\|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records today.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Array of ints\|Name=<nowiki>ListOfInterviewers</nowiki>\|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records today.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>RemoveRestrictSampleTo</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>RemoveRestrictSampleTo</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=SampleRule\|Name=<nowiki>sr</nowiki>\|Description=<nowiki>Samplerule to remove restrict to.</nowiki>}}		{{CGscriptParameters_Template\|Type=SampleRule\|Name=<nowiki>sr</nowiki>\|Description=<nowiki>Samplerule to remove restrict to.</nowiki>}}
Line 17:		Line 17:
	{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>RestrictSampleToList</nowiki>\|Description=<nowiki>List of samples interviewer is restricted to. None means access to all.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>RestrictSampleToList</nowiki>\|Description=<nowiki>List of samples interviewer is restricted to. None means access to all.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=CatiQasSearchQuery\|Name=<nowiki>SearchQuery</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=CatiQasSearchQuery\|Name=<nowiki>SearchQuery</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=~~int~~\|Name=<nowiki>catiList</nowiki>\|Description=<nowiki>Which list to return</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>allowNoPhone</nowiki>\|Description=<nowiki>Include those without phonenumbers in the result</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=bool\|Name=<nowiki>forInterviewer</nowiki>\|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Unknown\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}		{{CGscriptParameters_Template\|Type=CatiListType constant\|Name=<nowiki>catiList</nowiki>\|Description=<nowiki>Which list to return</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Array of ints\|Name=<nowiki>restrictToSampleIds</nowiki>\|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}}
	\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}		\|Description=<nowiki>Get list of qas on the given list.</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|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=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Inherited=object\|Description=<nowiki>Get information about this class.</nowiki>}}
	}}		}}