QAS new

From Catglobe Wiki
Revision as of 04:40, 20 July 2020 by Administrator (talk | contribs)
Jump to: navigation, search

QAS_new

Create a questionnaire answer sheet object

Syntax

QAS QAS_new(int questionnaireResourceId "Questionnaire resource id", int userResourceId "User resource id. 0 to use current.") - Create new qas.

QAS QAS_new(int questionnaireResourceId "Questionnaire resource id", int userResourceId "User resource id. 0 to use current.", bool setTest "Set QAS to test.") - Create new qas.

QAS QAS_new(int questionnaireResourceId "Questionnaire resource id") - Create new qas for current user.

QAS QAS_new(int questionnaireResourceId "Questionnaire resource id", bool setTest "Set QAS to test.") - Create new qas for current user.

Return value

An array, it is a questionnaire answer sheet object, which 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