Page Comparison

Rules and Instructions:

• Buyer 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)

    • Buyer 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:

      • https://purespectrum.atlassian.net/wiki/spaces/PBA/pages/2898493452/Modular+Survey+PS+Buyer+rules+and+API+instructions#(API)-Endpoints-1%3A-Validate-the-Transaction-and-create-a-new-Transaction

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

    • ENDPOINT SPECS:

      • https://purespectrum.atlassian.net/wiki/spaces/PBA/pages/2898493452/Modular+Survey+PS+Buyer+rules+and+API+instructions#(API)-Endpoints-2%3A-Register-the-Transaction-as-Complete

• Buyer 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, Buyer has to redirect and pass the 1st Transaction ID (core transaction) received.

    • NOTE: In case Buyer use a Transaction ID generated for a modular survey, the system will continue to accept the value and redirect the respondent to correspondent supplier.

• Buyer - Survey Creation in Marketplace:

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

  • 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“, and filter by the value TRUE

    • Modular Transaction

    • isModularTransaction

...

API ENDPOINT SPECIFICATION:

All our APIs are protected and they can be used only through an API token linked to your account. Please read this document before using the following endpoints.

...

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

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

Buyer should must send us the survey_id, supplier_id, and transaction_id (core transaction) in the API.

($apihost is the environment against which you are testing, and $basepath is the base path with the api version. All Buy API calls will require access-token parameter in the header) 

POST {{BASE_URL}}$apihost/$basepath/buyers/v2/surveys/SURVEY_ID/transactions?supplier_id=SUPPLIER_ID&transaction_id=TRANSACTION_ID

...

Use this API to complete a transaction (modular transaction).

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

...