Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Api Call  - GET  http://api.spectrumsurveys.com/suppliers/v2/attributes/:qualification_code?localization=:localization

 GET /Surveys/:Survey_id/PSIDEligible?PSID=%PSID%&rd_device_id=[%%research_defender_respondent_ud%%]&ip_address=[%%ipv4_address%%]


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.


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
}



Research Defender /Predupe

By passing in a respondent's respondent_ud value, we are able to prevent duplicated clicks as determined by device id, which is a different dedupe mechanism than PSID.

Utilizing this feature will reduce the status "ps_df_dupe" - code 70


Respondent IP Addrress

By passing in a respondent's ip_address value, we are able to prequalify eligibility with some external partners.

Utilizing this feature will reduce the status "buyer_eligibility_precheck" - code 74



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

rd_device_idstringNoWill check a respondent using Research Defender's /predupe api.  Use this to reduce ps_df_dupe statuses
ip_addressstringNoWill check a respondent's eligibility with some buyers.  IP Address should be in the format 0.0.0.0


Response Parameters    

Parameter

Type

Description

Nullable
eligiblenumber

Shows whether a PSID is eligible for inclusion / exclusion. Either a 0 or 1. 

no

HTTP Response Codes

Response

Status

Description

200

OK


400Bad RequestSee Error Messages
404Not FoundQualification code doesn't exist in database

5xx

Internal Server Error

Please Report to support@purespectrum.com

Error Messages

Response

Description

1001

Invalid Survey ID

1002Invalid PSID Format

9999

Unknown Error - Please Report to support@purespectrum.com