GET PSIDRef

GET /Surveys/:Survey_id/PSIDRef 

PureSpectrum offers its buyers the ability to recontact respondents using their persistent PureSpectrum Id (PSID). The same mechanism is also used by suppliers to understand which respondents to exclude due to deduplication. 

Implementation

PSIDRef returns an array of PSID's, which are persistent respondent id's. You may use this list in conjunction with the value of `incl_excl` present in the GET /surveys & GET /surveys/:survey_id calls.  

API Response for GET /surveys/:survey_id/PSIDRef

Example 1 : The PSIDRef Response when the survey is an include survey.( The "incl_excl" parameter shows status 1)

{
    "incl_excl": 1,
    "refresh":1510843032899,
    "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)

{
    "incl_excl": 0,
    "refresh":1510843032899,
    "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"
    ]
}

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.

As a supplier, you should be storing the PSID of each respondent you send into PureSpectrum.  We always append the PSID of the Respondent on redirect back to you.  

If you see that a survey has "incl_excl":1, your system should call the api endpoint GET /surveys/:survey_id/PSIDRef.  If any of the PSID's match within your system, you may then target these respondents for this survey.

Exclude

If a survey is not defined as an include survey, the PSIDref list will always contain the EXCLUDE list.  This is the default for surveys created on PureSpectrum.  Leveraging the exclude list will allow you the ability to avoid termination due to deduplication.  You may either call the survey's PSIDRef list, and store it, or you may use the optional query string parameter /PSIDref?PSID=%respondent'sPSID% .  Documentation available here: GET PSIDEligible

Request Header Parameters

Response Parameters    

HTTP Response Codes

Error Messages