Rules and Instructions:
JD Power should use these two endpoints created by PureSpectrum:
(API) Endpoints 1: YELLOW FLOW - Can validate the Respondent with PureSpectrum:
This endpoint is used to Validate the PSID if it belongs to a supplier that agreed to work with a Modular survey - In case the PSID is valid, the endpoint returns a new Transaction ID (modular transaction)
JD Power needs to capture from the Buyer/Live URL these 3 parameters:
Survey ID: Survey identification →
survey_id
Supplier ID: Supplier identification →
supplier_id
Transaction ID: Transaction identification →
transaction_id
(core transaction)NOTE: Make sure the 3 variables are enabled in Buyer settings
ENDPOINT SPECS:
(API) Endpoints 2: GREEN FLOW - When the respondent finalizes the screener or the modular study, use this endpoint to register the respondent as Complete
JD Power should redirect the Respondent to the PS redirect link
/surveydone
only at the end of the survey on these 2 occasions:Respondent is not qualified → Buyer terminated (18)
Respondent completed the study → Complete (21)
In both cases, JD Power has to redirect to and pass the 1st Transaction ID (core transaction) received.
NOTE: In case JD Power use a Transaction ID generated for a modular survey, the system will continue to accept the value and redirect the respondent to correspondent supplier.
JD Power - Survey Creation in Marketplace:
Create only one single survey and on the Launch page on Marketplace activate the feature
Modular Launch
To check the transaction ID that belongs to a Download the report from the survey dashboard (UI) in order to fetch the transaction IDs created through the ENDPOINT 1 (YELLOW FLOW). Use the column "MODULAR Survey“, you can and filter by this field name:
Status colour Red title FIELDNAME to ADD
the value TRUE
Modular Transaction
Schema:
...
Buyer Configuration:
...
Body:
Code Block | ||
---|---|---|
| ||
[] |
Response 200 OK:
Code Block | ||
---|---|---|
| ||
[] |
NOTE:
Modular transactions created via API endpoint 1 can only (YELLOW FLOW). Should be completed using API endpoint 2.
Any core transaction received initially in the buyer URL should be completed /or rejected using
s/surveyDone
endpoint.