This is an old revision of the document!
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: Get Transaction Status And History
Request Endpoint
| Method | URL |
|---|---|
| GET | https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/transaction?submitter_id={submitter_id}&primary_reference={primary_reference}&include_history={true or false} |
Arguments:
| Variable | Usage | Description |
|---|---|---|
| {submitter_id} | Required | Submitter ID number. |
| {primary_reference} | Required | Primary_Reference for the transaction. |
| {include_history} | Optional | True or False |
Request Body
N/A
Request Headers
| Key | Value |
|---|---|
| access_token | {soft-token} |
JSON Request Parameters
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.
Sample Request - No History
Endpoint:
https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/transaction?submitter_id=35&primary_reference=TESTAGENT1-202007140415-00013.1.1
Sample Response
Status Code: 200
{
"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"
}
}
OR
Status Code: 500 (When an error occurs.)
{
"Exception": {
"Code": "Undefined",
"Message": "Submitter ID and Primary Reference must not be empty or null."
}
}
Sample Request - With History
Endpoint:
https://apex-prd.certna.org/APEX/Service/APEXPublicServer.svc/transaction?submitter_id=35&primary_reference=TESTAGENT1-202007140415-00013.1.1&include_history=true
Sample Response
Status Code: 200
{
"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"
}
]
}
}
OR
Status Code: 500 (When an error occurs.)
{
"Exception": {
"Code": "DatabaseError",
"Message": "Not Authorized To Access This Transaction."
}
}