Versions Compared

Version Old Version 20 New Version 21
Changes made by

Claudio Baldi

Claudio Baldi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PRODUCTION API END POINTS:

...

Code Block
languagejson
{
    "adjustment_id": "b43ce6a3-9578-4ba6-8cc5-a4add094a352",
    "summary": {
        "currentCompletes": 1916,
        "previouslyRejectedCompletes": 10,
        "rejectingCompletesInCurrentUpload": 14,
        "acceptingCompletesInCurrentUpload": 0,
        "resultingCompletes": 1816,
        "totalRawCompletes": 20,
        "totalRejects": 24,
        "rejectPercentage": "1022.0050",
        "desiredStatus": {21/33},
        "eligible": 14,
        "rejected": 14,
        "completed": 0,
        "test": 0,
        "transactions": 24,
        "transactionsWithDesiredStatus": 0,
        "summaryPerSurvey": [
            {
                "surveyId": 38226312,
                "currentCompletes": 1916,
                "previouslyRejectedCompletes": 10,
                "rejectingCompletesInCurrentUpload": 14,
                "acceptingCompletesInCurrentUpload": 0,
                "resultingCompletes": 1816,
                "totalRawCompletes": 20,
                "totalRejects": 24,
                "rejectPercentage": "1022.0050",
                "desiredStatus": 33,
                "eligible": 14,
                "rejected": 14,
                "completed": 0,
                "test": 0,
                "transactions": 24,
                "transactionsWithDesiredStatus": 0,
                "validCap": true
            }
        ],
        "validCap": true,
        "invoiced": 0,
        "isApiUser": true
    }
}
Note

NOTE: If one or more transaction_id/s (TXs) passed are ineligible or already reconciled, the system will start the reconciliation process and those TXs will be skipped.

...

Note

NOTE: to get the transactions not eligible to reconcile or not reconciled withing the recon process you can use this formula

transactions - eligible = not eligible / not reconciled

...

Code Block
languagejson
{
    "adjustment_id": "b43ce6a3-9578-4ba6-8cc5-a4add094a352",
    "summary": {
        "desiredStatuscurrentCompletes": 3316,
        "eligiblepreviouslyRejectedCompletes": 20,
        "rejectedrejectingCompletesInCurrentUpload": 24,
        "completedacceptingCompletesInCurrentUpload": 0,
        "testresultingCompletes": 016,
        "transactionstotalRawCompletes": 220,
        "transactionsWithDesiredStatustotalRejects": 04,
        "isApiUserrejectPercentage": true"22.50",
     } }

2 - Reconciliation multiple surveys (Bulk Reconciliation)

Buyer API endPoint - Change the transaction to Buyer_Reconciliation_Reject:

Code Block
POST : https://staging.spectrumsurveys.com/buyers/v2/adjustments?operationType=LIVE_RECONCILIATION&reconStatus=2
API:POST
Access-token:Buyer account

Request Payload:

Code Block
languagejson
[
    { "desiredStatus": {33},
        "eligible": 4,
        "rejected": 4,
        "completed": 0,
        "test": 0,
        "transactions": 4,
        "transactionsWithDesiredStatus": 0,
        "summaryPerSurvey": [
            {
                "surveyId": 38226312,
                "currentCompletes": 16,
                "previouslyRejectedCompletes": 0,
                "rejectingCompletesInCurrentUpload": 4,
                "acceptingCompletesInCurrentUpload": 0,
                "resultingCompletes": 16,
                "totalRawCompletes": 20,
                "totalRejects": 4,
                "rejectPercentage": "22.50",
                "desiredStatus": 33,
                "eligible": 4,
                "rejected": 4,
                "completed": 0,
                "test": 0,
                "transactions": 4,
                "transactionsWithDesiredStatus": 0,
                "validCap": true
            }
        ],
        "validCap": true,
        "invoiced": 0,
        "isApiUser": true
    }
}

2 - Reconciliation multiple surveys (Bulk Reconciliation)

Buyer API endPoint - Change the transaction to Buyer_Reconciliation_Reject:

Code Block
POST : https://staging.spectrumsurveys.com/buyers/v2/adjustments?operationType=LIVE_RECONCILIATION&reconStatus=2
API:POST
Access-token:Buyer account

Request Payload:

Code Block
languagejson
[
    {
        "transaction_id": "7by1JwD0oLzX1iip0liui4",
        "change_reason": "Suspected Fraud" // optional
    },
    {
        "transaction_id": "7Er50MDCnV0b0bc91S8Qr1",
        "change_reason": "Respondent Quality" // optional
    },
    {
        "transaction_id": "41JBHVbfHas8kzAwYhGW9l",
        "change_reason": "Ghost Completes" // optional
    },
    {
        "transaction_id": "7mwVC728181yok8mKgDzQv",
        "change_reason": "Client Rejected" // optional
    },
    {
        "transaction_id": "21NJOoeCB4mXoMZXg77bNo",
        "change_reason": "Duplicate Respondent" // optional
    },
    {
        "transaction_id": "5j2UOEpgsMlXoLix0qtU0W"
    }
]

Response:

Code Block
languagejson
{
    "adjustment_id": "b43ce6a3-9578-4ba6-8cc5-a4add094a352",
    "summary": {
        "currentCompletes": 16,
        "previouslyRejectedCompletes": 0,
        "rejectingCompletesInCurrentUpload": 4,
        "acceptingCompletesInCurrentUpload": 0,
        "resultingCompletes": 16,
        "totalRawCompletes": 20,
        "totalRejects": 4,
        "rejectPercentage": "22.50",
        "desiredStatus": {33},
        "eligible": 4,
        "rejected": 4,
        "completed": 0,
        "test": 0,
        "transactions": 4,
        "transactionsWithDesiredStatus": 0,
        "summaryPerSurvey": [
            {
                "surveyId": 38226312,
                "currentCompletes": 16,
                "transaction_idpreviouslyRejectedCompletes": "7by1JwD0oLzX1iip0liui4",0,
                "change_reasonrejectingCompletesInCurrentUpload": "Suspected Fraud" // optional 4,
                "acceptingCompletesInCurrentUpload": }0,
       {         "transaction_idresultingCompletes": "7Er50MDCnV0b0bc91S8Qr1"16,
        "change_reason": "Respondent Quality" // optional    "totalRawCompletes": }20,
       {         "transaction_idtotalRejects": "41JBHVbfHas8kzAwYhGW9l"4,
        "change_reason": "Ghost Completes" // optional     },"rejectPercentage": "22.50",
       {         "transaction_iddesiredStatus": "7mwVC728181yok8mKgDzQv"33,
        "change_reason": "Client Rejected" // optional    "eligible": }4,
       {         "transaction_idrejected": "21NJOoeCB4mXoMZXg77bNo"4,
        "change_reason": "Duplicate Respondent" // optional    "completed": }0,
       {         "transaction_idtest": "5j2UOEpgsMlXoLix0qtU0W" 0,
          } ]

Response:

Code Block
languagejson
{     "adjustment_idtransactions": "46e10177-c3a3-4246-a33a-0c8306f3a9a6",4,
      "summary": {         "desiredStatustransactionsWithDesiredStatus": 330,
        "eligible": 2,         "rejectedvalidCap": true
 2,         "completed": 0, }
       "test": 0],
        "transactionsvalidCap": 2true,
        "transactionsWithDesiredStatusinvoiced": 0,
        "isApiUser": true
    }
}
Info

NOTE 1:

...

The system always records any Reconciliation process made via API or UI and this information can be

...

found on the Survey dashboard → Reconciliation Tab

These are the label show:

  • Reject : Reconciliation via UI - TX changes to buyer_rejects

  • Reject (API): Reconciliation via API - TX changes to buyer_rejects

  • Complete: Reconciliation via UI - TX changes to complete

  • Complete (API): Reconciliation via UI - TX changes to buyer_rejects

  • Accept: Reconciliation via UI - Any TX in the file will changes to complete if they are eligible, and the TX current completes not in the file, will change buyer_rejects

  • Accept (API): Reconciliation via API - Any TX in the file will changes to complete if they are eligible, and the TX current completes not in the file, will change buyer_rejects

Screenshot 2024-02-01 at 15.13.02.png

Info

NOTE 2:

...

if you need to test the Live Reconciliation API and you want to create some test transactions, please ask your account manager or contact the PureSpectrum product team and they will give you access to a document that will allow you to create a transaction via API.

Info

NOTE 3:

...

10pm

10 pm PT is the absolute latest you can submit a reconciliation for it to be included in the next

months

month's invoice.