Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Rules and Instructions:

  • Buyer should use these two endpoints created by PureSpectrum:

  • 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

Schema:

image-20240619-165529.png

Buyer Note:

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

    • EXAMPLE TO ADD

  • Buyer should activate the supplier ID, survey ID, and transaction ID on the Buyer settings page.

    • Buyer Settings:

      Screenshot 2024-06-19 at 18.02.22.png

Suppliers to enable:

Suppliers that agreed to work with Modular Survey:

  • Prime

  • CPX

Note: David Breihan is working to onboard more supplier. The list is might not up to date.

API ENDPOINT SPECIFICATION:

(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 send us survey_id, supplier_id, and transaction_id (core transaction) in the API. 

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

Body (Optional if data is sent via URL):

{
    "supplier_id": 2,
    "transaction_id": "40AekOxWhKu8hffwcm7LC7"
}

Response (Transaction is valid for next study):

{
    "transaction_id": "01vA34sCj8wffKBmelT6xT"
}

Response (Transaction is NOT valid for next study):

{
    "ps_error_code": 1014,
    "ps_error_message": "Invalid 'transaction_id'."
}

Response (Supplier did NOT agree to Modular Survey):

{
    "ps_error_code": 1014,
    "ps_error_message": "The 'transaction_id' doesn’t belong to a supplier that agrees to Modular Survey."
}

(API) Endpoints 2: Register the Transaction as Complete

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

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

Body:

[]

Response 200 OK:

[]

NOTE:

  1. In case the survey uses the CPI override or fixed, the CPI associated with the new transaction is the same as the original transaction.

  2. In case the survey uses the dynamic price or dynamic CPI, the CPI associated with the new transaction is the one calculated within the last block.

  3. Buyer should always use the original transaction (core TX) to request a new transaction for a respondent eligible for modular study.

  4. Buyer should always use the API endpoint 2 to register the TX as Complete or any other status.

  5. Buyer should always redirect the respondent using the /surveyDone page and the initial transaction (core transaction)

Not developed:

  1. Assign a different CPI to any new transaction. Buyer might have a different CPI if the respondent complete a modular or long form study.

  2. Supplier is not advised if the respondent completed a modular study. They should provide an Endpoint that allow PureSpectrum to send the details.

  • No labels