The following set of functions linked below can be used to facilitate linkages across different surveys and interview records. A common use case is when handling inbound calls and where there is a need to locate an applicable survey and interview record for the respondent. Initially the interviewer is put into a locating survey where they obtain relevant locating details from the respondent before being able to transfer to the appropriate survey/interview from a resulting lookup table.
GetCatiInterviews
GetCatiInterviews can be used to find other interview records, for example it can be used in an inbound call scenario to locate a pre-existing interview record when CLI matching is not possible and so a new temporary interview has been created.
GetCatiInterviews(string[] surveyList, string telephoneNumber, string respondentName, string filter)Both telephoneNumber and respondentName parameters work as a “starts with” filter. So if “1234” is specified as a telephoneNumber, it will search for all numbers starting with “1234”.
These parameters also support wildcards:
%- Any string of zero or more characters._(underscore) - Any single character.
So if %1234 is specified as a telephoneNumber, the system will search for all numbers containing 1234. The filter parameter makes it possible to search interviews by survey questions (only those that have the “Available as CATI filter” option enabled). Its format is:
“q2=2 AND q3=1”It does not support wildcards and must always be an exact match.
In the typical Inbound interview locating scenario, the function returns an array of objects which should be placed into an open text list variable. Then in turn a single type variable is used to show the results contained in the open text list so that the user is able to select a specific record. After the interviewer selects an applicable single response answer, it is necessary to parse the open text list item string to get the project id and resp id.
SetNextCatiInterview / SetNextCatiInterviewToPrevious
SetNextCatiInterview()SetNextCatiInterviewToPrevious()These functions do not immediately switch interview, but just set the next interview to start after finishing the current interview. SetNextCatiInterview determines which survey and interview record to start. SetNextCatiInterviewToPrevious returns interviewing activity back to the previous survey record.
GetCatiLinkedInterviews
GetCatiLinkedInterviews()This returns a list of “parent” interview records. This is a list of previously started interviews in the current linked interviews chain (where the SetNextCatiInterview function has been used).