CATI getCATIContacts: Difference between revisions

Revision as of 05:03, 28 December 2011

CATI_getCATIContacts

This script is used to get information of Cati contact with specified RPQ Id. If the RPQId is not input, you will need the RPQ context

Syntax

array CATI_getCATIContacts([number RPQId])

Arguments

RPQId : resource project questionnaire id (optional)

Return type

Array

Index	Data type	Value
OBJECT_TYPE	number
CATI_CONTACT_ID	number	Id of Cati contact
CATI_CONTACT_INTERVIEWER_USER_RESOURCE_ID	number	The interviewer resource id of Cati contact
CATI_CONTACT_START_DATE	array datetime	The start date of Cati contact
CATI_CONTACT_END_DATE	array datetime	The end date of Cati contact
CATI_CONTACT_OUTCOME_STATUS_ID	number	Status of Cati contact
CATI_CONTACT_OUTCOME_STATUS_AS_TEXT	string (read only)	The text of contact_status_id
CATI_CONTACT_DESCRIPTION	string	Description of Cati contact

Example

array a = CATI_getCATIContacts(89716960);

print(a);

// {{29,14358155,9960805,{2010,11,11,3,34,21,600,45,40},{2010,11,11,3,36,37,200,45,40},12939,Busy,Busy || retry on (03:51 - interviewer's time) (03:51 - respondent's time)},{29,14358161,9960805,{2010,11,11,3,53,22,0,45,40},{2010,11,11,4,26,39,800,45,40},12939,Busy,Busy || retry on (04:41 - interviewer's time) (04:41 - respondent's time)}}

Availability

Version 5.8

@@ Line 4: / Line 4: @@
 ====CATI_getCATIContacts====
-This script is used to get information of Cati contact with specified RPQ Id
+This script is used to get information of Cati contact with specified RPQ Id. If the RPQId is not input, you will need the RPQ context
 '''Syntax'''
@@ Line 82: / Line 82: @@
 | style="border: 1px solid #010101" width="195" |
 Description of Cati contact
+|}
 '''Example'''
-array a = CATI_getCATIContacts(123456);
+array a = CATI_getCATIContacts(89716960);
+print(a);
+// {{29,14358155,9960805,{2010,11,11,3,34,21,600,45,40},{2010,11,11,3,36,37,200,45,40},12939,Busy,Busy || retry on (03:51 - interviewer's time) (03:51 - respondent's time)},{29,14358161,9960805,{2010,11,11,3,53,22,0,45,40},{2010,11,11,4,26,39,800,45,40},12939,Busy,Busy || retry on (04:41 - interviewer's time) (04:41 - respondent's time)}}
 '''Availability'''