Difference between revisions of "QAS new"

From Catglobe Wiki
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
== QAS_new ==
 
== QAS_new ==
  
Create a questionnaire answer sheet object
+
Create a new qas
  
 
===Syntax===
 
===Syntax===
 +
* QAS_new(int questionnaireResourceId, int userResourceId) - Create new qas.
  
QAS_new(''questionnaireResourceId, userResourceId'')  
+
* QAS_new(int questionnaireResourceId, int userResourceId, bool setTest) - Create new qas.
  
or
+
* QAS_new(int questionnaireResourceId) - Create new qas for current user.
  
QAS_new(''questionnaireResourceId'')  
+
* QAS_new(int questionnaireResourceId, bool setTest) - Create new qas for current user.
  
===Arguments===
+
===Note===
  
*''questionnaireResourceId'': is a ''number ''expression. It is the questionnaire's resource id
+
userResourceId:
*''userResourecId'': is a ''number ''expression. It is the user's resource id
+
 
 +
* 0 is use current user
 +
* -1 to force no user
 +
* -2 to anonymous uer
  
 
===Return value===
 
===Return value===
  
An array, it is a questionnaire answer sheet object, which contains the following items:  
+
QAS class, or QAS object which is array contains the following items:  
  
 
{| class="tableintopic" style="border-collapse:collapse; border:1px solid #010101" width="875" cellspacing="0" cellpadding="2" border="1"
 
{| class="tableintopic" style="border-collapse:collapse; border:1px solid #010101" width="875" cellspacing="0" cellpadding="2" border="1"
Line 152: Line 156:
 
| style="border:1px solid #010101;" width="467" |  
 
| style="border:1px solid #010101;" width="467" |  
 
times called
 
times called
|-
 
|QUESTIONNAIRE_EDITOR_LINK
 
|string
 
|link to open questionnaire editor
 
 
|}
 
|}
  

Latest revision as of 06:00, 20 July 2020

QAS_new

Create a new qas

Syntax

  • QAS_new(int questionnaireResourceId, int userResourceId) - Create new qas.
  • QAS_new(int questionnaireResourceId, int userResourceId, bool setTest) - Create new qas.
  • QAS_new(int questionnaireResourceId) - Create new qas for current user.
  • QAS_new(int questionnaireResourceId, bool setTest) - Create new qas for current user.

Note

userResourceId:

  • 0 is use current user
  • -1 to force no user
  • -2 to anonymous uer

Return value

QAS class, or QAS object which is array contains the following items:

Index

Data type

Value

QAS_ID

number

Primary key

QAS_QUESTIONNAIRE_RESOURCE_ID

number

Questionnaire's resource id

QAS_USER_RESOURCE_ID

number

User's resource id

QAS_TEST

bool

If it is a test answer sheet

QAS_STATUS

number

Questionnaire answer sheet's status, it should be compared to/assigned with defined constants

(see getRPQStatus function for more information)

QAS_COMPLETED

bool

If the answer sheet is completed

QAS_STARTDATE

array

Start date

QAS_ENDDATE

array

End date

QAS_GUID

string

The unique id of qas

QAS_CATI_APPOINTMENT

array

Next contact datetime

QAS_CATI_LIST_TYPE

number

1: CATI_MAIN, 2: CATI_ONGOING, 3: CATI_APPOINMENT, 4: CATI_FINISHED, 5: CATI_RETRY NOTE! If the QAS is actually part of a CATI run, then this item should only be updated when the value is CATI_FINISHED, or when the CATI is not running, otherwise the CATI system may get confused.

QAS_CATI_TIMES_CALLED

number

times called

Example

array qas1 = QAS_new(33702597); 
qas1[QAS_TEST] = true;
QAS_save(qas1); 
array qas2 = QAS_new(33702597, 53468); 
QAS_save(qas2);

Availability

Version 5.6