...
API Response for GET /surveys/:survey_id/PSIDref
| Code Block |
|---|
Example 1 : The PSIDRef Response when the survey is an include survey.( The "incl_excl" parameter shows status 1) { "apiStatus": "success", "msg": "PSIDRef List fetched successfully", "version": "2.0", "incl_excl": 1, "PSIDRef": [ "bfdc8e99-yybb-xxee-aajj-1e6493b92f7b", "09a290ee-aajj-yybb-xxee-47e7d4c44db0", "f1d0adb1-aajj-xxee-yybb-d2a3513390f1", "2a6511cf-aajj-yybb-xxee-a322fac3de33", "dccc33db-aajj-xxee-yybb-8a5aa7449155" ] } Example 2 : The PSIDRef Response when the survey is an Exclude survey.( The "incl_excl" parameter shows status 0) { "apiStatus": "success", "msg": "PSIDRef List fetched successfully", "version": "2.0", "incl_excl": 0, "PSIDRef": [ "75xxee23-370b-a8ye-e601-e1fzz59284c8" "94xx7b3b-4608-01y4-b908-8aezzab971e1" "24xx7db6-8507-47y9-9c67-0c6zz6244d98" ] } "bfdc8e99-yybb-xxee-aajj-1e6493b92f7b", "09a290ee-aajj-yybb-xxee-47e7d4c44db0", "f1d0adb1-aajj-xxee-yybb-d2a3513390f1", "2a6511cf-aajj-yybb-xxee-a322fac3de33", "dccc33db-aajj-xxee-yybb-8a5aa7449155" ] } |
Include
Include Survey's are sometimes referred to as recontact surveys. Effectively a buyer will define the list of respondents which they are attempting to reach. When a respondent that is on this list completes the survey, their id will automatically be removed from the PSIDRef list. As long as the PSID is present on the Ref list, the respondent may take the survey. PSID's are consistent across suppliers, so it is possible that the respondent may take a survey from one supplier, and be recontacted via a different supplier.
...