An external system may update a transaction in PureSpectrum for a number of reasons such as:

• Making sure all completes are properly captured

• Verifying authenticity of a complete

• Recording a complete on an Augment survey

This API should not be used with the “Register Completes”

Request

POST $apihost/$basepath/surveys/:survey_id/transactions

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

Considerations

• 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

API Parameters:

Sample Request: 

POST api.spectrumsurveys.com/buyers/v2/surveys/:surveyId/transactions?supplier_id=2&member_id=3&session_id=4

Response

Response Code

201

Response Body

Response Code

400

Response Body

{ 
	"ps_error_code": 1001,
	"ps_error_message":"Invalid supplier ID"
},

{ 
	"ps_error_code": 1002,
	"ps_error_message":"Insufficient parameters - please check your request"
}