Get Reconciliation process information
Control the reconciliation process information using get reconciliation process list and get reconciliation process information
If you are using one of these endpoints:
implementing the following scripts allows any buyer to check the information of a reconciliation process.
These APIs allow to:
Return the list of Reconciliation processes launched in a survey.
Return the status of Reconciliation processes launched in a survey.
Return all the information based on a Reconciliation process is (
adjustment_id).
Reconciliation Process List
Production Endpoint
GET : https://api.spectrumsurveys.com/buyers/v2/surveys/{surveyId}/adjustments
Staging Endpoint
GET : https://staging.spectrumsurveys.com/buyers/v2/surveys/{surveyId}/adjustments($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)
API Parameters:
Request Parameter | Type | Description | Example |
|---|---|---|---|
surveyId | integer - enum | This is the Survey ID status code. Pass in the URL your survey ID. An invalid number will return an error message | 123456 1234567 |
Response
CODE: 200 OK
[
{
adjustment_id: "9967eed2-d06d-4197-8e53-eae2d8c0cc65",
"status": 6,
"statusDescription" : "Success"
},
{
adjustment_id: "dadasd-d06d-4197-8e53-eae2d8c0cc66",
"statusDescription" : "Error in Processing",
status: 5
},
{
adjustment_id: "9967eed2-d06d-asdasda-8e53-eae2d8c0cc67",
"statusDescription" : "User Terminated",
status: 2
},
]Errors:
CODE: 401 Unauthorized
If the user tries to get the reconciliation information by using an Invalid access-token or invalid survey ID then the below error message will be displayed with 401 Unauthorized
{
"ps_api_response_code": 9999,
"ps_api_response_message": "Not authorized to access survey id"
}Reconciliation Information
Endpoints
Production Endpoint
GET : https://api.spectrumsurveys.com/buyers/v2/surveys/{surveyId}/adjustments/{adjustmentId}
Staging Endpoint
GET : https://staging.spectrumsurveys.com/buyers/v2/surveys/{surveyId}/adjustments/{adjustmentId}($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)
API Parameters:
Request Parameter | Type | Description | Example |
|---|---|---|---|
surveyId | integer - enum | This is the Survey ID status code. Pass in the URL your survey ID. An invalid number will return an error message | 123456 1234567 |
adjustmentId | text | This is the you can get this ID from: | 9967eed2-d06d-4197-8e53-eae2d8c0cc65 |
Response
CODE: 200 OK
{
adjustment_id: "9967eed2-d06d-4197-8e53-eae2d8c0cc65",
status: 6,
statusDescription: "Success",
summary: {
currentCompletes: 1,
transactions: 1,
desiredStatus: 33,
validCap: true,
rejectPercentage: 100,
totalRejects: 1,
eligible: 1,
rejected: 1,
summaryPerSurvey: [
{
surveyId: 1108416,
currentCompletes: 1,
transactions: 1,
desiredStatus: 33,
validCap: true,
rejectPercentage: 100,
totalRejects: 1,
eligible: 1,
rejected: 1,
},
],
},
}Response:
Field | Description |
|---|---|
status | Status ID of the Reconciliation
|
statusDescription | Status of the Reconciliation
|
summary.currentCompletes | The number of transactions currently completes before this Reconciliation for all the surveys. (One process can handle transactions for multiple surveys) |
summary.previouslyRejectedCompletes | The number of transactions that were previously changed from Complete to Rejected before this Reconciliation |
summary.rejectingCompletesInCurrentUpload | The number of transactions that will or already changed from Complete to Rejected with this Reconciliation |
summary.acceptingCompletesInCurrentUpload | The number of transactions that will or already changed from Buyer_* to Complete with this Reconciliation |
summary.resultingCompletes | The number of transactions completed after this Reconciliation for all the surveys. (One process can handle transactions for multiple surveys) |
summary.totalRawCompletes | ?? |
summary.totalRejects | The number of transactions rejected after the competition with this Reconciliation process |
summary.desiredStatus | Indentify the transaction status that want to change to after the recocniliation.
|
summary.transactions | The number of transactions in this specific process. |
summary.liveReconciled | The number of transactions already reconciled. |
summary.isApiUser | Identify how the reconciliation process got requested
|
summary.validCap | Identify if the reconciliation cap is reached or not.
|
summary.invoiced | The number of transactions already invoiced. (valid only for companies that invoice per Project and PO) |
summary.rejectPercentage | The percentage of transactions already rejected previously and with this Reconciliation process |
summary.eligible | The number of transactions eligible to reconcile |
summary.rejected | The number of transactions that we reject with this reconciliation |
summary.test | The number of transactions created while testing the survey. Not counted in the reconciliation or survey goal |
summary.transactionsWithDesiredStatus | ?? |
summaryPerSurvey.currentCompletes |
|
summaryPerSurvey.previouslyRejectedCompletes |
|
summaryPerSurvey.rejectingCompletesInCurrentUpload |
|
summaryPerSurvey.acceptingCompletesInCurrentUpload |
|
summaryPerSurvey.resultingCompletes |
|
summaryPerSurvey.totalRawCompletes |
|
summaryPerSurvey.totalRejects |
|
summaryPerSurvey.desiredStatus |
|
summaryPerSurvey.transactions |
|
summaryPerSurvey.liveReconciled |
|
summaryPerSurvey.isApiUser |
|
summaryPerSurvey.validCap |
|
summaryPerSurvey.surveyId |
|
summaryPerSurvey.rejectPercentage |
|
summaryPerSurvey.eligible |
|
summaryPerSurvey.rejected |
|
summaryPerSurvey.test |
|
summaryPerSurvey.transactionsWithDesiredStatus |
|
summaryPerSurvey.surveyStatus |
|