Skip to main content

Version: 23.10

GET Portal User ToDo

Retrieve the list of to do items for a user similar to what the to do page on a Journey Manager user space displays.

Request​

HTTP request​

GET https://<JM_SERVER>/manager/secure/rest/transactions/v1/portal/user-todo

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.

All parameters are optional except where otherwise indicated.

ParameterDescription
formStatusFilter on the submission form status.
Values: Assigned, Opened, Saved, Submitted, Completed, Cancelled, Abandoned
includeGroupItemsWhether to include transactions associated with groups the user is a member of.
Values: true, false).
Note: By default, anonymous transactions are included.
keywordInclude only those transactions that fit the keyword.
portalNameFilter on the name of the space for which submissions are to be retrieved.
Note: portalName is required when invoking the service mounted on the management console; that is, for the context path /manager.
userLoginNameRequired. Filter on the user login name for which transactions are to be retrieved.

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/portal/user-todo?portalName=Maguire&amp;userLoginName=someAdmin&amp;formStatus=Saved
Example response
[
  {
    "id": 63744,
    "trackingCode": "LFS2HH",
    "submitKey": "8113f5a32e0647321b8047c5c8034bb1",
    "taskFlag": true,
    "taskKey": "8113f5a32e0647321b8047c5c8034bb1",
    "taskType": "Form",
    "taskCreatedTimestamp": "2015-08-06T11:04:53+10:00",
    "taskSubject": "Test Task 4.0",
    "formCode": "pf-lt418",
    "formName": "Payment Form",
    "formVersion": "1.0",
    "clientCode": "lt418",
    "clientName": "Test Client (4.1.8)",
    "fieldWorkerFlag": false,
    "testMode": false,
    "userLoginName": "someadmin",
    "formStatus": "Assigned",
    "userAgentBrowser": "",
    "userAgentOs": "",
    "dataDeleted": false
  },
  {
    "id": 54315,
    "trackingCode": "2QJHMB",
    "receiptNumber": "pf-lt41-14",
    "submitKey": "b097f6a9878a27c5ad29844e97c7d237",
    "taskFlag": false,
    "formCode": "pf-lt41",
    "formName": "Payment Form",
    "formVersion": "1.0",
    "clientCode": "lt41",
    "clientName": "Test Client (4.1)",
    "portalName": "Maguire",
    "fieldWorkerFlag": false,
    "testMode": false,
    "userLoginName": "someadmin",
    "formStatus": "Submitted",
    "timeRequest": "2015-05-19T11:30:36+10:00",
    "timeSubmission": "2015-05-19T11:32:33+10:00",
    "timeLastUserActivity": "2015-05-19T11:32:55+10:00",
    "timeToSubmitSec": 117,
    "ipAddress": "114.141.100.203",
    "requestCookie": "JSESSIONID=iIsfRT+sa4I1T2inf0nk5M57; __utma=264897119.59525688.1351658449...",
    "referer": "https://transact.maguire.com/maguire/landing.htm?formCode=pf-lt41",
    "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:37.0) Gecko/20100101 Firefox/37.0",
    "userAgentBrowser": "Firefox 37",
    "userAgentBrowserType": "Firefox",
    "userAgentBrowserVersion": "37",
    "userAgentDeviceType": "Desktop",
    "userAgentOs": "Windows 7",
    "userAgentOsType": "Windows",
    "userAgentOsVersion": "7",
    "paymentStatus": "Required",
    "paymentType": "Hosted",
    "paymentTotal": 112.0,
    "paymentLog": {
      "paymentStatus": "Cancelled",
      "paymentLogKey": "cab053fa940afb12fabce66a36ac0496",
      "paymentServiceCode": "WestpacQuickWeb",
      "userIpAddress": "114.141.100.203",
      "doTimestamp": "2015-05-19T11:32:41+10:00",
      "doAmount": 11200,
      "doMerchTxnRef": "9fb84dad611a5",
      "doVersion": "76.0",
      "drTxnResponseCode": "Cancelled",
      "drTxnResponseMsg": "The transaction has been cancelled by the user"
    },
    "deliveryStatus": "Not Ready",
    "dataDeleted": false
  }
]