| Warning |
|---|
This endpoint is not available on staging or production. The documentation is hidden from external users. |
An external system may update a transaction in PureSpectrum for a number of reasons such as:
...
Required Parameters must be present in the query string:
Status - STst
Optional Parameters
QLC Codes - QLCquota_id
Transaction can be changed only if is on these 3 states:
Buyer side in progress
Buyer drop
PS LOI threshold
API Parameters:
Request Parameter | Type | Description | Example |
|---|---|---|---|
st | integer - enum (17, 18, 20, 21, 30) | This is the PureSpectrum status code. Pass in the appropriate code corresponding to your desired status. 17 - OverQuota 18 - Termination 20 - Quality Termination 21 - Complete 30 - Dedupe | st=21 |
quota_id | string - comma separated values | This is the identifier of the quotas for which the respondent has qualified for. | abc123 |
Sample Request:
| Code Block | ||
|---|---|---|
| ||
POST /buyers/v2/surveys/:surveyId/transactions/transaction_id/status?st=21&qlcquota_id=1,2,3 |
Response:
Response Code:
200
Response Body:
| Code Block |
|---|
[] |
Other examples:
Once the survey respondent status is passed as “complete” through /surveydone endpoint, it is the final status of that transaction id. If tried to update the transaction using /status endpoint again, then it will throw the error as shown in below example -
Response Code:
400
Response Body:
| Code Block |
|---|
{
"ps_error_code": 1003,
"ps_error_message": "This transaction id already has a final status"
} |
Postman example:
...
Other Error Messages:
| Code Block | ||
|---|---|---|
| ||
{
"ps_error_code": 1001,
"ps_error_message":"Incorrect status code"
},
{
"ps_error_code": 1002,
"ps_error_message":"Insufficient parameters - please check your request"
},
{
"ps_error_code": 10031004,
"ps_error_message":"ThisTransaction ID Not found. Please check the survey id and transaction id already has a final status ID and try again."
},
{
"ps_error_code": 1005,
"ps_error_message":"Invalid or missing QLC codes"
} |