GET Portal Help Desk

Retrieve the list of help desk transactions similar to what the help desk page on a Journey Manager user space displays.

Request

HTTP request

GET https://<JM_SERVER>/manager/secure/rest/transactions/v1/portal/help-desk

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.

Parameter	Description
formStatus	Filter on the form status of the submission. Values: Assigned, Opened, Saved, Submitted, Completed, Cancelled, Abandoned
includeAnonymousSubmissions	Whether to include anonymous transactions. By default, anonymous transactions are included. Values: true, false
includeAuthenticatedSubmissions	Whether to include authenticated transactions. By default, authenticated transactions are included. Values: true, false
keyword	Include only those transactions that fit the keyword.
portalName	Filter on the name of the space for which help desk 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.
startDate	The search start date. Format: yyyy-MM-dd

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/help-desk?portalName=Maguire&formStatus=Submitted

Example response

[
  {
    "id": 69033,
    "trackingCode": "HX4BG7",
    "receiptNumber": "smartform-test-1",
    "submitKey": "0cedffee9c9af536c24315fc06a9330b",
    "taskFlag": false,
    "formCode": "smartform-test",
    "formName": "SmartForm Test",
    "formVersion": "1.0",
    "clientCode": "MACQUARIE",
    "clientName": "Macquarie",
    "portalName": "Maguire",
    "fieldWorkerFlag": false,
    "testMode": false,
    "formStatus": "Submitted",
    "timeRequest": "2015-09-07T10:31:02+10:00",
    "timeSubmission": "2015-09-07T10:31:23+10:00",
    "timeLastUserActivity": "2015-09-07T10:31:24+10:00",
    "timeToSubmitSec": 22,
    "ipAddress": "123.134.145.156",
    "referer": "https://transact.maguire.com/maguire/landing.htm?formCode=smartform-test",
    "userAgent": "AcroForms",
    "userAgentBrowser": "AcroForms Unknown",
    "userAgentBrowserType": "AcroForms",
    "userAgentBrowserVersion": "Unknown",
    "userAgentDeviceType": "Unknown",
    "userAgentOs": "Unknown ",
    "userAgentOsType": "Unknown",
    "userAgentOsVersion": "Unknown",
    "paymentStatus": "Required",
    "paymentType": "Credit/Debit Card",
    "paymentTotal": 49.0,
    "deliveryStatus": "Not Ready",
    "dataDeleted": false
  },
  {
    "id": 69031,
    "trackingCode": "6QZ6JD",
    "receiptNumber": "smartform-pdf-test-50",
    "submitKey": "bc47ba43993152ec2503167ce117c75a",
    "taskFlag": false,
    "formCode": "smartform-pdf-test",
    "formName": "SmartForm PDF Test",
    "formVersion": "1.0",
    "clientCode": "maguire",
    "clientName": "Maguire",
    "portalName": "Maguire",
    "fieldWorkerFlag": false,
    "testMode": false,
    "formStatus": "Submitted",
    "timeRequest": "2015-09-07T10:29:11+10:00",
    "timeSubmission": "2015-09-07T10:29:29+10:00",
    "timeLastUserActivity": "2015-09-07T10:29:29+10:00",
    "timeToSubmitSec": 18,
    "ipAddress": "123.134.145.156",
    "referer": "https://transact.maguire.com/manager/admin/form/form-search.htm?_wid=d51",
    "userAgent": "AcroForms",
    "userAgentBrowser": "AcroForms Unknown",
    "userAgentBrowserType": "AcroForms",
    "userAgentBrowserVersion": "Unknown",
    "userAgentDeviceType": "Unknown",
    "userAgentOs": "Unknown ",
    "userAgentOsType": "Unknown",
    "userAgentOsVersion": "Unknown",
    "attachmentsStatus": "Required",
    "paymentStatus": "Required",
    "paymentType": "Credit/Debit Card",
    "paymentTotal": 39.95,
    "dataExtracts": {
      "Given Name": "Test",
      "Family Name": "User",
      "Email": "[email protected]"
    },
    "deliveryStatus": "Not Ready",
    "dataDeleted": false
  },
  {
    "id": 69030,
    "trackingCode": "Z4QJWA",
    "receiptNumber": "smartform-pdf-test-49",
    "submitKey": "8fc87249c79ca45cb083879b678133b1",
    "taskFlag": false,
    "formCode": "smartform-pdf-test",
    "formName": "SmartForm PDF Test",
    "formVersion": "1.0",
    "clientCode": "maguire",
    "clientName": "Maguire",
    "portalName": "Maguire",
    "fieldWorkerFlag": false,
    "testMode": false,
    "formStatus": "Submitted",
    "timeRequest": "2015-09-07T10:27:59+10:00",
    "timeSubmission": "2015-09-07T10:28:48+10:00",
    "timeLastUserActivity": "2015-09-07T10:28:48+10:00",
    "timeToSubmitSec": 79,
    "ipAddress": "123.134.145.156",
    "referer": "https://transact.maguire.com/manager/admin/form/form-search.htm?_wid=d51",
    "userAgent": "AcroForms",
    "userAgentBrowser": "AcroForms Unknown",
    "userAgentBrowserType": "AcroForms",
    "userAgentBrowserVersion": "Unknown",
    "userAgentDeviceType": "Unknown",
    "userAgentOs": "Unknown ",
    "userAgentOsType": "Unknown",
    "userAgentOsVersion": "Unknown",
    "attachmentsStatus": "Required",
    "paymentStatus": "Required",
    "paymentType": "Credit/Debit Card",
    "paymentTotal": 39.95,
    "dataExtracts": {
      "Given Name": "First",
      "Family Name": "Last"
    },
    "deliveryStatus": "Not Ready",
    "dataDeleted": false
  }
]