...
POST $apihost/$basepath/surveys/:survey_id/transactions/:transactionId/status
($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)
...
Required Parameters must be present in the query string. In order to make a successful request, one of two sets of parameters must be present:
Scenario 1 - Buyer calls API with parameters for:
supplierId
supplierRespondentId
supplierRespondentSessionId
Scenario 2 - Buyer calls API with old transaction ID:
oldTransactionId
Status - ST
Optional Parameters
QLC Codes - QLC
API Parameters:
Request Parameter | Type | Description | Example | ||||
|---|---|---|---|---|---|---|---|
supplierIdst | integer - enum (17, 18, 20, 21, 30) | This is the PureSpectrum supplier ID. An incorrect supplier ID, or the supplier ID of a supplier not currently allocated to the survey should result in an http 400 error. | 37 | supplierRespondentId | stringstatus code. | st=21 | |
qlc | string - comma separated values | This is the persistent member ID identifier of the quotas for which the respondent has qualified for. | abc123 | supplierSessionId | string | This is the unique session identified provided by the supplier | 1513326965960 |
Sample Request:
| Code Block | ||
|---|---|---|
| ||
POST api.spectrumsurveys.com/buyers/v2/surveys/:surveyId/transactions?supplier/transaction_id/status?st=221&member_id=3&session_id=4qlc=1,2,3 |
Response
...
Response Code
201
Response Body
...