...
| 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": [
"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"
]
}
|
...
API Response for "GET /surveys/:survey_id/PSIDEligible?PSID=75xxee23-370b-a8ye-e601-e1fzz59284c8"
| Code Block |
|---|
{Example 1 : If the "apiStatus": "success",PSIDRef is eligible { "msgeligible": "PSID Eligibility Checked successfully", "version": "2.0", 1 } Example 2 : If the PSIDRef is NOT eligible { "eligible": 1 } |
HEADER Parameters
...
Parameter
...
Type
...
Required
...
Description
...
access-token
...
string
...
Yes
...
Token used to identify the authenticity of the user.
Query String Parameters
...
Parameter
...
Type
...
Required
...
Description
...
PSID
...
string
...
Yes
...
The respondent's persistent PSID
Response Parameters
...
Parameter
...
Type
...
Description
...
text
...
string
...
The text of the question asked to the respondent
...
Contains a list of "PSIDRef" numbers which fall either under include or exclude category.
HTTP Response Codes
...
Response
...
Status
...
Description
...
200
...
OK
...
5xx
...
Please Report to support@purespectrum.com
Error Messages
...
Response
...
Description
...
1001
...
Invalid Survey ID
...
9999
...
0
} |