GET /Surveys- http://api.spectrumsurveys.com/suppliers/v2/Surveys
GET /Surveys/:Survey_id - http://api.spectrumsurveys.com/suppliers/v2/Surveys/:Survey_id
GET /Surveys/:Survey_id/PSIDRef - http://api.spectrumsurveys.com/suppliers/v2/Surveys/:Survey_id/PSIDRef
GET /Surveys/:Survey_id/PSIDEligible - http://api.spectrumsurveys.com/suppliers/v2/Surveys/:Survey_id/PSIDEligible?PSID=%PSID%
...
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%, which will return back a response of
API Response for "GET /surveys/:survey_id/PSIDEligible?PSID=75xxee23-370b-a8ye-e601-e1fzz59284c8"
| Code Block |
|---|
{
"eligible":1 // 1 is eligible, 0 is ineligible
} |
...
Parameter | Type | Description | Nullable | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
text | string | The text of the question asked to the respondent | desc | string | A description of the question that is asked of the respondent | cat | string | Category name of the question that is asked of the respondent | type | integer | class | integer | ||
| PSIDRef | array | Contains a list of "PSIDRef" numbers which fall either under include or exclude category. |
...