DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

==== Transaction ====

The transaction web service is a REST structured service that derives its functionality based on syntax used when calling the web service. There are two parameters required to uniquely identify a transaction, submitter_id and primary_reference. An additional optional parameter can be supplied to instruct the web service to include the transaction history along with the transaction details.
----

**Purpose:** <color #22b14c>**Get Transaction Status And History**</color>

<color #7092be>Request Endpoint</color>

{{tablelayout?colwidth="75px,575px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Method ^ URL ^
| GET | <nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/transaction?submitter_id={submitter_id}&primary_reference={primary_reference}&include_history={true or false}</nowiki> |

**Arguments:**

{{tablelayout?colwidth="175px,75px,400px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Variable ^ Usage ^ Description ^
| {submitter_id} | Required | Submitter ID number. |
| {primary_reference} | Required | Primary_Reference for the transaction.  |
| {include_history} | Optional | True or False  |

<color #7092be>Request Body</color>

N/A

<color #7092be>Request Headers</color>

{{tablelayout?colwidth="150px,450px"&rowsFixed=1&rowsVisible=10&float=center}}
^ Key ^ Value ^
| access_token | {soft-token} |

<color #7092be>JSON Request Parameters</color>

N/A

**Notes:**

Any condition that results in an unsuccessful call to the payloads web service will produce a JSON formatted response with a code and message property populated.

<color #7092be>Sample Request - No History</color>

**Endpoint:**

<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/transaction?submitter_id=35&primary_reference=TESTAGENT1-202007140415-00013.1.1</nowiki>

<color #7092be>Sample Response</color>

Status Code: 200

<code json>
{
    "result": {
        "TRANSACTION_ID": 4256051,
        "PRIMARY_REFERENCE": "TESTAGENT1-202007140415-00013.1.1",
        "SECONDARY_REFERENCE": "3453453453",
        "COUNTY_NAME": "TestCountyCER1",
        "SUBMITTER_ID": 35,
        "AGENT_ID": 6,
        "CREATOR_USER_NAME": "apexsvc65",
        "CREATED": "2020-07-23T14:23:56",
        "LAST_MODIFIED": "2020-07-23T15:14:46",
        "TRANSACTION_STATUS_ID": 32,
        "TRANSACTION_STATUS": "Archived"
    }
}
</code>

**OR**

Status Code: 500  (When an error occurs.)

<code json>
{
    "Exception": {
        "Code": "Undefined",
        "Message": "Submitter ID and Primary Reference must not be empty or null."
    }
}
</code>

<color #7092be>Sample Request - With History</color>

**Endpoint:**

<nowiki>https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/transaction?submitter_id=35&primary_reference=TESTAGENT1-202007140415-00013.1.1&include_history=true</nowiki>

<color #7092be>Sample Response</color>

Status Code: 200

<code json>
{
    "result": {
        "TRANSACTION_ID": 4256051,
        "PRIMARY_REFERENCE": "TESTAGENT1-202007140415-00013.1.1",
        "SECONDARY_REFERENCE": "3453453453",
        "COUNTY_NAME": "TestCountyCER1",
        "SUBMITTER_ID": 35,
        "AGENT_ID": 6,
        "CREATOR_USER_NAME": "apexsvc65",
        "CREATED": "2020-07-23T14:23:56",
        "LAST_MODIFIED": "2020-07-23T15:14:46",
        "TRANSACTION_STATUS_ID": 32,
        "TRANSACTION_STATUS": "Archived",
        "TRANSACTION_STATUS_HISTORY": [
            {
                "TRANSACTION_STATUS_ID": 1,
                "TRANSACTION_STATUS": "Draft",
                "TIMESTAMP": "2020-07-23T14:23:56"
            },
            {
                "TRANSACTION_STATUS_ID": 128,
                "TRANSACTION_STATUS": "Submitting",
                "TIMESTAMP": "2020-07-23T14:23:57"
            },
            {
                "TRANSACTION_STATUS_ID": 2,
                "TRANSACTION_STATUS": "Submitted",
                "TIMESTAMP": "2020-07-23T14:23:58"
            },
            {
                "TRANSACTION_STATUS_ID": 512,
                "TRANSACTION_STATUS": "RetrievingByCounty",
                "TIMESTAMP": "2020-07-23T14:30:35"
            },
            {
                "TRANSACTION_STATUS_ID": 4,
                "TRANSACTION_STATUS": "RetrievedByCounty",
                "TIMESTAMP": "2020-07-23T14:30:40"
            },
            {
                "TRANSACTION_STATUS_ID": 2048,
                "TRANSACTION_STATUS": "ReturningByCounty",
                "TIMESTAMP": "2020-07-23T14:53:31"
            },
            {
                "TRANSACTION_STATUS_ID": 8,
                "TRANSACTION_STATUS": "ReturnedByCounty",
                "TIMESTAMP": "2020-07-23T14:53:32"
            },
            {
                "TRANSACTION_STATUS_ID": 8192,
                "TRANSACTION_STATUS": "RetrievingBySubmitter",
                "TIMESTAMP": "2020-07-23T15:14:41"
            },
            {
                "TRANSACTION_STATUS_ID": 32,
                "TRANSACTION_STATUS": "Archived",
                "TIMESTAMP": "2020-07-23T15:14:46"
            }
        ]
    }
}
</code>

**OR**

Status Code: 500  (When an error occurs.)

<code json>
{
    "Exception": {
        "Code": "DatabaseError",
        "Message": "Not Authorized To Access This Transaction."
    }
}
</code>

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International