Updating the list of suppliers for a Survey

Overview

Every survey in PureSpectrum has a list of suppliers that send sample. You may update the list of suppliers, and their goal, using this API endpoint

Use

This API endpoint may be used to update a survey’s supplier list by updating a supplier’s “completes_required”, or by grouping suppliers together.

  • To “remove” a supplier - set their “completes_required” to 0.

  • Supplier allocations may add up to more than or less than 100% of the survey’s goal.

    • To set “flexibility” among suppliers, set the “completes_goal” values to be in excess of the survey’s goal.

    • To pace the flexibility among suppliers, set the “completes_goal” values to be less than the survey’s goal.

Important Considerations

  • This endpoint may only be used after a draft survey has been created

  • By default, all valid non-blocked suppliers in a locale are added to the survey upon creation. To update/remove suppliers, either omit their supplier ID from this endpoint, or set their “completes_required” to 0.

  • Suppliers can not be removed from a survey, though their allocations can be set to 0.

Request


PUT $apihost/$basepath/surveys/:surveyId/suppliers

($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) 

Request: 

PUT $apihost/$basepath/surveys/:surveyId/suppliers

1 2 3 4 5 6 7 8 9 10 11 12 [ { "cpi": 33.42, "completes_goal" : 25, "suppliers": [3] }, { "cpi": 12, "completes_goal" : 25, "suppliers": [1] } ]


Result 


Response Code

200

Response Body

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 [ { "group_ref": null, "group_name": null, "completes_goal": 25, "remaining": 100, "fielded": 0, "cpi": 33.42, "last_start_date": "", "intent": { "intent_value": 0 }, "suppliers": [ { "id": 3, "name": "Supplier 3" } ] }, { "group_ref": null, "group_name": null, "completes_goal": 25, "remaining": 100, "fielded": 0, "cpi": 12, "last_start_date": "", "intent": { "intent_value": 0 }, "suppliers": [ { "id": 1, "name": "Supplier 1" } ] } ]