Create a recontact survey

Owned by David Boyajian
Last updated: Nov 14, 2017
2 min read

Follow the format below to create a recontact survey

Overview:

By supplying us with a list of persistent PureSpectrum Respondent ID's (PSID's), you may attempt to recontact these specific respondents.

There are 2 steps to creating a recontact survey: 

1) Specify that the survey is a recontact survey by setting the parameter "incl_excl": 1 in the POST /surveys call.

2) Specify the list of respondents allowed to take the survey by creating a PSIDref list using the POST /surveys/:survey_id/PSIDref call.

You may not launch a survey where "incl_excl": 1 if there are no values in the PSIDref list.

You may not change the value of "incl_excl" after you have created the draft.

Passing in the parameter "incl_excl" with value 1 will set this survey up as a recontact survey.  PSID's present in the survey's PSIDref list will be the only respondents allowed in.  You may not change the value of this parameter at any time.  By default, all surveys are created with "incl_excl": 0, which is the format of an exclude survey - if "incl_excl": 0, the PSID's in the PSIDref list will not be allowed to take the survey.

Sample Request:

Body: 

POST /surveys
{
  "survey_title": "Automobile Preferences bapit-1",
  "survey_category_code": 231,
  "survey_localization": "en_US",
  "completes_required": 300,
  "offer_price": 3.25,
  "expected_ir": 60,
  "expected_loi": 10,
  "live_url": "https://my.survey.com?survey_id=1234",
  "test_url": "https://my.survey.com?survey_id=1234&test=1",
  "field_time": 10,
  "incl_excl": 1
}


Result 


Response Code

201

Response Body

{
  "survey_title": "Automobile Preferences bapit-1",
  "survey_category_code": 231,
  "completes_required": 300,
  "live_url": "https://my.survey.com?survey_id=1234",
  "test_url": "https://my.survey.com?survey_id=1234&test=1",
  "field_time": 10,
  "offer_price": 3.25,
  "ps_survey_status": 11,
  "expected_loi": 10,
  "expected_ir": 60,
  "ps_survey_id": 3366,
  "mod_on": 1489971961029,
  "crtd_on": 1489932661603,
  "test_ps_survey_entry_link": "http://dev.spectrumsurveys.com:3500/startsurvey?survey_id=3366&ps_redirect_test=1&bsec=a70mx8&supplier_id=23",
  "survey_localization": "en_US",
  "incl_excl": 1,
  "qualifications": [],
  "quotas": []
}

Part 2:

Sample Request: 

POST surveys/:survey_id/PSIDref
{
    "PSIDRef":[
        "75xxee23-370b-a8ye-e601-e1fzz59284c8",
        "94xx7b3b-4608-01y4-b908-8aezzab971e1",
        "24xx7db6-8507-47y9-9c67-0c6zz6244d98"
    ]
}


Result 


Response Code

201

Response Body

{
    "PSIDRef": [
        "75xxee23-370b-a8ye-e601-e1fzz59284c8", 
        "94xx7b3b-4608-01y4-b908-8aezzab971e1", 
	"24xx7db6-8507-47y9-9c67-0c6zz6244d98"    
    ]
}