PS <> JD Power rules and API instructions

Rules and Instructions:

• JD Power should use these two endpoints created by PureSpectrum:

  • (API) Endpoints 1: YELLOW FLOW - Con-validate the Respondent with Pure-spectrum:

    • This end point is used to Validate the PSID if belongs to a supplier that agree to work with Modular survey - In case the PSID is valid, the end point returns a new Transaction ID

    • JD Power needs to capture from the URL these 3 parameters:

      • Survey ID: Survey identification → survey_id

      • Supplier ID: Supplier identification → supplier_id

      • Transaction ID: Transaction identification → transaction_id

      • NOTE: Make sure the 3 variable are enabled in Buyer settings

    • ENDPOINT SPECIFICATION HERE

      • LINK TO ADD

  • (API) Endpoints 2: GREEN FLOW - When the respondent finalize the screener or the modular study, use this endpoint to register the respondent as Complete

    • ENDPOINT SPECIFICATION HERE

      • LINK TO ADD

• JD Power should redirect the Respondent to PS redirect link /surveydone only at the end of the survey in 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 the 1st Transaction ID received.

• JD Power - Survey Creation in Marketplace:

  • Create a only one single survey and in Launch page on Marketplace activate the feature Modular Launch

  • In order to check the transaction id that belongs to a "MODULAR Survey“, you can filter by this field name:

    • FIELDNAME TO ADD

Schema:

Buyer Configuration:

• Operator should activate a configuration flag under Configuration Settings - Modular Survey

  • EXAMPLE TO ADD

• Buyer should activate the supplier ID in Buyer settings

  • Buyer Settings:

    

Supplier Configuration:

• Supplier should activate a flag to agree to work with Modular Supplier

Suppliers that agreed to work with Modular Survey:

• Supplier 1

• Supplier 2

• Supplier 3

API ENDPOINT SPECIFICATION:

(API) Endpoints 1: Validate Transaction and create a new Transaction

Use this API to validate the Respondent and in case of valid transaction,

JDPA can send us survey_id and supplier_id in the API then we can use an existing API

POST {{BASE_URL}}/buyers/v2/surveys/SURVEY_ID/transactions?supplier_id=SUPPLIER_ID

Body:

[]

Response (Transaction is valid for next study):

[]

Response (Transaction is NOT valid for next study):

[]

(API) Endpoints 2: Register the Transaction as Complete

Use this API to validate the Respondent and in case of valid transaction,

POST {{BASE_URL}}/buyers/v2/surveys/SURVEY_ID/transactions/TRANSACTION_ID/status?st=21

Body:

[]

Response:

[]