...
The primary use of this API End Point is to check the PSID exclusion. The supplier can check whether a given PSID is present in the exclusion list or not.
| Warning |
|---|
Not yet available on Production. |
Implementation
PSIDEligible returns a response in form of either a 0 or 1.
Suppose that a PSID is present in the exclusion list, then the API response will be 0 which means that the PSID is not eligible for taking the survey, where as 1 means that it is eligible.
On the other hand lets suppose that a PSID is present in the inclusion list, then the API response will be 1 which means that the PSID is eligible for taking the survey, where as 0 means that it is not eligible.
API Response for "GET /surveys/:survey_id/PSIDEligible?PSID=75xxee23-370b-a8ye-e601-e1fzz59284c8"
| Code Block |
|---|
Example 1 :- When the PSID is present in the include List
{
"eligible": 1
}
Example 2 :- When the PSID is *NOT* present in the include List
{
"eligible": 0
}
Example 3 :- When the PSID is present in the Exclude List
{
"eligible": 0
}
Example 4 :- When the PSID is *NOT* present in the Exclude List
{
"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 | Nullable |
|---|---|---|---|
| eligible | number | Shows whether a PSID is eligible for inclusion / exclusion. Either a 0 or 1. | no |
HTTP Response Codes
Response | Status | Description |
|---|---|---|
200 | OK | |
| 400 | Bad Request | See Error Messages |
| 404 | Not Found | Qualification code doesn't exist in database |
5xx | Internal Server Error | Please Report to support@purespectrum.com |
Error Messages
Response | Description |
|---|---|
1001 | Invalid Survey ID |
| 1002 | Invalid PSID Format |
9999 | Unknown Error - Please Report to support@purespectrum.com |
...