Skip to main content

Version: 24.10

GET Transactions

Retrieve a list of transactions, filtered by various parameters. By default, the results are sorted by database ID in descending order, although the order can be customized.

Request​

HTTP request​

GET https://<JM_SERVER>/manager/secure/rest/transactions/v1/

Parameters​

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

note

The special parameter value null can be used to specify that transactions are included only if the corresponding field is not set to a value.

For example, passing in the parameter paymentStatus=null excludes all transactions for which payment has been requested because those submissions would have a specific value for the payment status.

All parameters are optional except where otherwise indicated.

ParameterDescription
abandonmentFormStatusFilter on the form status of an abandoned transaction at abandonment time.
Values: null, Assigned, Opened, Saved, Submitted
attachmentsStatusFilter on the attachment status of the submission.
Values: null, Required, Optional, Completed
clientCodeFilter on the organization code.
clientNameFilter on the organization name.
contactEmailAddressFilter on the contact email address extracted from transaction data.
contactPhoneFilter on the contact phone number extracted from transaction data.
deletedFlagFilter on the transaction data deleted flag.
Values: true, false
deliveryStatusFilter on the delivery status of the submission.
Values: null, Not Required, Not Ready, Ready, Sent Email, Sent WS, In Progress, Pending, Completed, Error, Undeliverable
endDateInclude transactions requested before the specified end date only.
Format: yyyy-MM-dd
externalProfileIdFilter on the external profile ID of the submission.
Note: This is relevant only if set by an external system or Groovy script.
fetchLimitThe maximum number of transactions to return.
Value: In the range 1 - 10000.
This parameter defaults to 1000 if a valid value is not provided.
fieldWorkerFlagFilter on the set of spaces associated with a submission.
Values: true, false
If this parameter is true, the set of spaces must contain a TransactField space.
formCodeFilter on the form code.
formNameFilter on the form name.
formStatusFilter on the form status of the submission
Values: null, Assigned, Opened, Saved, Submitted, Completed, Expired, Abandoned
Specify multiple values as a list, like this: [Saved, Submitted]
formVersionFilter on the transaction's form version number; for example, 1.0.
idFilter on the transaction database ID.
jobKeyFilter on the job key.
Note: The job key is set only if the transaction is associated with a collaboration job.
Note: To exclude transactions associated with collaboration jobs, set this parameter to "".
loginNameFilter on the login name of the user associated with the transaction.
If this parameter is null, the result set includes all transactions that aren't associated with any user.
orderByAscSort the results by the specified field in ascending order.
Note: Sorting is case sensitive for string fields.
orderByDscSort the results by the specified field in descending order.
Note: This parameter is ignored if orderByAsc is set.
Note: Sorting is case sensitive for string fields.
paymentStatusFilter on the payment status of the transaction.
Values: null, Required, Pending, Completed, Error
portalNameFilter on the name of a space associated with the transaction.
receiptNumberFilter on the transaction receipt number.
receiptStatusFilter on the receipt status of the transaction.
Values: null, Completed, Error, Error - No Data
referenceNumberFilter on the job reference number
Note: The job reference number is set only if the transaction is associated with a collaboration job.
startDateReturn transactions requested on or after the specified start date.
Format: yyyy-MM-dd
submitKeyFilter on the transaction submit key (a GUID).
taskFlagFilter on whether the transaction is a task.
Values: true, false
taskKeyFilter on the transaction task key (a GUID).
testModeFilter on the transaction test mode flag.
Values: true, false
trackingCodeFilter on the transaction tracking code.
transRefNumberFilter on the transaction reference number.

Response​

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

Example​

Example request
GET https://transact.maguire.com/manager/secure/rest/transactions/v1/?startDate=2015-09-28&formCode=credit-card
Example response
[
  {
    "id": 71865,
    "trackingCode": "B25LWD",
    "receiptNumber": "attachments-for-diff-1",
    "submitKey": "7b44754c1c8e1fc4ecd9dd0d0ecd5319",
    "taskFlag": false,
    "formCode": "credit-card",
    "formName": "Platinum Credit Card",
    "formVersion": "1.0",
    "clientCode": "maguire",
    "clientName": "Maguire Finance",
    "portalName": "Web Plugin",
    "fieldWorkerFlag": false,
    "testMode": false,
    "formStatus": "Completed",
    "timeRequest": "2015-09-28T16:13:53+10:00",
    "timeSubmission": "2015-09-28T16:14:00+10:00",
    "timeLastUserActivity": "2015-09-28T16:14:00+10:00",
    "timeFormCompleted": "2015-09-28T16:14:00+10:00",
    "timeToSubmitSec": 7,
    "ipAddress": "123.134.145.156",
    "requestCookie": "JSESSIONID=HD3Tet57kC-Pqda7+jGO7ubT; _ga=GA1.2.1363876154.1441243068;",
    "referer": "https://transact.maguire.com/manager/admin/form/form-edit.htm?entityId=5013",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)...",
    "userAgentBrowser": "Edge 12",
    "userAgentBrowserType": "Edge",
    "userAgentBrowserVersion": "12",
    "userAgentDeviceType": "Desktop",
    "userAgentOs": "Windows 10",
    "userAgentOsType": "Windows",
    "userAgentOsVersion": "10",
    "deliveryStatus": "Ready",
    "dataDeleted": false,
    "xmlURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/71865/form.xml",
    "receiptURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/71865/receipt.pdf",
    "extractURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/71865/extract.xls"
  }