Skip to main content

Version: 24.04

GET Transaction History

This API supports a single GET method, but provides a great deal of flexibility through a query builder API. Key features of this API include:

  • Filter criteria: Return an individual transaction or a filtered transaction record set.
  • Output formats: Specify JSON or CSV output format for the result set.
  • Fetch limits and offsets: Enables you to page through very large transaction history record sets.
  • Column filter: Specify the columns you want to see.

Request​

HTTP request​

GET https://<JM_SERVER>/manager/secure/rest/transaction-history/v1/

Parameters​

The table below shows the set of request parameters the can be used as additional search criteria. If multiple parameters are specified, all of them are applied to the result set.

All parameters are optional except where otherwise indicated.

ParameterDescription
abandonmentFormStatusFilter on the abandonment form status of an abandoned transaction at abandonment time
Values: Assigned, Opened, Saved, Submitted
clientCodeFilter on the organization code.
Note: This column is not indexed, and using clientOid will be more efficient.
clientOidFilter on the organization client OID primary key.
dwhPublishStatusFilter on data warehouse publish status, which can be set via the PUT operation.
This allows you to retrieve only values that you haven't previously retrieved and marked as published (via PUT).
Values: null (retrieve only unpublished values), Completed (retrieve only previously published values)
endDateInclude only those transactions requested before the specified time_request end date.
Specify a value using the format yyyy-MM-dd.
For example, the query parameters &startDate=2016-01-01&endDate=2016-06-30 includes transactions reqeusted between 1 January 2016 and 30 June 2016.
formCodeFilter on the form code.
Note: This column is not indexed, and using formOid will be more efficient.
formOidFilter on the form OID primary key.
formStatusFilter on the submission form status.
Values: Completed, Abandoned
formVersionNumberFilter on the form version number of the transaction; for example, 1.0.
portalNameFilter on the form space (portal) associated with the transaction.
receiptNumberFilter on the transaction receipt number.
refererFilter on the transaction referer using a like "%referer%" WHERE clause.
startDateInclude only those transactions requested on or after the specified time_request end date.
Specify a value using the format yyyy-MM-dd.
For example, the query parameters &startDate=2016-01-01&endDate=2016-06-30 includes transactions reqeusted between 1 January 2016 and 30 June 2016.
submitKeyFilter on the transaction submit key (GUID).
Note that this column is not indexed.
submissionOidFilter on the transaction submission OID primary key.
Note that this column is not indexed.
trackingCodeFilter on the transaction tracking code, also known as the tracking number.
trackingNumberFilter on the transaction tracking number, also known as the tracking code.
userAgentDeviceTypeFilter on the user agent device type.
Values: Desktop, Tablet, Mobile
userAgentBrowserTypeFilter on the user agent browser type.
userAgentBrowserVersionFilter on the user agent browser version.
userAgentOsTypeFilter on the user agent OS type.
userAgentOsVersionFilter on the user agent OS version.
fetchLimitThe maximum number of transactions to return.
Specify a number in the range 1 - 100,000. Defaults to 1,000 if a valid value is not provided.
For example: &fetchLimit=10000
fetchOffsetThe query fetch offset in rows.
Use the fetch offset to page through very large result sets.
For example, &fetchLimit=10000&fetchOffset=20000 returns the next 10,000 records after the 20,000 record offset.
formatSpecify the output format.
Values: JSON (JSON array), CSV. (Default: JSON).
columnsThe columns to return.
Specify a comma-separated list of column names; for example, &columns=[form_code, form_status, time_request].

Response​

If successful, this operation returns a response with a HTTP 200 OK status code.

Examples​

Example 1​

This example uses the filter criteria:

  • formCode=FTX-CCA: Include only transactions with the form code "FTX-CCA".
  • formStatus=Completed: Include only transactions with the form status "Completed".
  • fetchLimit=1: Return 1 record only.
Example request
GET https://transact.maguire.com/manager/secure/rest/transaction-history/v1/?formCode=FTX-CCA&formStatus=Completed&fetchLimit=1
Example successful response
[
  {
    "attachment_count": 0,
    "attachments_total_size": 0,
    "authenticated_flag": false,
    "client_code": "maguire",
    "client_name": "Maguire",
    "client_oid": 1,
    "content_length": "19163",
    "duration_client_response": 9,
    "duration_render": 253,
    "duration_total": 671,
    "far_data_version": "4.3.0sp2",
    "field_worker_flag": false,
    "form_code": "FTX-CCA",
    "form_name": "Credit Card Application",
    "form_oid": 2,
    "form_status": "Completed",
    "form_version_number": "3.0",
    "ip_address": "127.0.0.1",
    "pdf_submit_flag": false,
    "portal_name": "Maguire",
    "receipt_number": "FTX-CCA-2",
    "receipt_render_duration": 3497,
    "referer": "http://localhost:9080/manager/admin/form/form-search.htm?_wid=1101",
    "request_cookie": "JSESSIONID=Swc8R3ul6lbq8JvwCOTHajRD",
    "request_key": "618124c328c44eb376dd2f7a32e4081c",
    "request_log_count": 1,
    "request_url": "http://localhost:9080/maguire/servlet/SmartForm.html",
    "revision_number": 5,
    "submission_oid": 10,
    "submit_key": "1725c033d977b52bea9aef934cd63a58",
    "submitted_offline_flag": false,
    "task_flag": false,
    "time_form_completed": "2016-02-16T12:35+1100",
    "time_request": "2016-02-16T12:35+1100",
    "time_submission": "2016-02-16T12:35+1100",
    "time_to_submit_sec": 17,
    "tracking_number": "GD4ZFB",
    "transaction_history_oid": 4,
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; WOW64; rv:44.0) Gecko/20100101 Firefox/44.0",
    "user_agent_browser_type": "Firefox",
    "user_agent_browser_version": "44",
    "user_agent_device_type": "Desktop",
    "user_agent_os_type": "Windows",
    "user_agent_os_version": "10"
  }
]

Example 2​

This example uses the filter criteria:

  • formCode=FTX-CCA: Include only transactions with the form code "FTX-CCA".
  • fetchLimit=10: Return 10 records only.
  • format=CSV: Output in CSV format.
  • columns=[form_name,form_version_number,portal_name,submission_oid,tracking_number]: Include only these columns in the output: form_name, form_version_number, portal_name, submission_oid, and tracking_number.
Example request
GET https://transact.maguire.com/manager/secure/rest/transaction-history/v1/?formCode=FTX-CCA&fetchLimit=10&format=CSV&amp;columns=[form_name,form_version_number,portal_name,submission_oid,tracking_number]
Example successful response
"form_name","form_version_number","portal_name","submission_oid","tracking_number"
"Credit Card Application","3.0","Maguire",10,"GD4ZFB"
"Credit Card Application","3.0","Maguire",13,"7T5QJF"
"Credit Card Application","3.0","Maguire",27,"RC93C9"
"Credit Card Application","3.0","Maguire",612,"Y3RZZL"
"Credit Card Application","3.0","Maguire",617,"GTS32H"
"Credit Card Application","3.0","Maguire",716,"GC2HNB"
"Credit Card Application","3.0","Maguire",719,"9P8W56"
"Credit Card Application","3.0","Maguire",720,"VGLHKW"
"Credit Card Application","3.0","Maguire",721,"TP2G7P"
"Credit Card Application","3.0","Maguire",722,"DTD65S"