GET Submission

Return the submission for the specified submission id, organization and delivery channel.

info

The Delivery REST API Overview provides an introduction to this REST API, including information about:

• Security (authentication and authorization)
• Delivery channel
• Testing
• Delivery call sequence (POST Next, GET Data, POST Confirmation)
• Client failure recovery

Request

HTTP request

GET https://<JM_SERVER>/manager/secure/rest/delivery/v1/<ORG_CODE>/<DELIVERY_CHANNEL>/<SUBMISSION_ID>/

Parameters

This request takes no parameters.

Request body

Do not supply a request body for this operation.

Example

An example GET Submission request is shown below.

GET https://transact.maguire.com/manager/secure/rest/delivery/v1/maguire/credit-card/2039/

Response

If successful, this operation returns a response with a HTTP 200 OK status code. Otherwise, it returns an error response.

Error responses

HTTP status code	Description
401 Unauthorized	User not authorized to perform this operation.
404 Not Found	The organization code, delivery channel or submission id may not exist.
503 Service Unavailable	The JM System Deployment property Enable REST/Web Service Delivery has been set to false.

Example

A comprehensive example successful response is shown below.

{
  "id": 69,
  "trackingCode": "UD65H6",
  "receiptNumber": "FTX-CCA-16",
  "submitKey": "20bc0dd18c74ae4f4e714dc402728d96",
  "taskKey": "a7d7c46f590c87903e39f3eb7cc2cb06",
  "taskType": "Review",
  "taskSubject": "Review Job Example 1 by [email protected].",
  "taskMessage": "Please review the Job Example 1 by Malcolm Edgar.",
  "taskCreatedTimestamp": "2015-01-30T15:22:20+11:00",
  "job": {
    "id": 1,
    "jobName": "1 Step Review Job",
    "referenceNumber": "ZMYS4A",
    "jobKey": "24e67afe8ad22a92b1ebc3aa3dcad90c",
    "jobStep": "Application Review",
    "jobAction": "Assign Review"
  },
  "formCode": "FTX-CCA",
  "formName": "Credit Card Application",
  "formVersion": "1.0",
  "clientCode": "maguire",
  "clientName": "Maguire",
  "portal": "Maguire",
  "fieldWorkerFlag": false,
  "testMode": false,
  "contactEmailAddress": "[email protected]",
  "formStatus": "Completed",
  "timeRequest": "2015-01-27T14:51:38+11:00",
  "timeSubmission": "2015-01-27T14:52:04+11:00",
  "timeLastUserActivity": "2015-01-27T14:52:14+11:00",
  "timeFormCompleted": "2015-01-27T14:52:04+11:00",
  "ipAddress": "127.0.0.1",
  "requestCookie": "JSESSIONID\u003dPCgDnYPkLB+H6EHsXt2t6RHe; A983-2928-2398-3419\u003d",
  "referer": "http://localhost:9080/maguire/servlet/SmartForm.html?formCode\u003dFTX-CCA",
  "userAgent": "Mozilla/5.0 (Windows NT 10.0; WOW64; rv:35.0) Gecko/20100101 Firefox/35.0",
  "userAgentBrowser": "Firefox 35",
  "userAgentBrowserType": "Firefox",
  "userAgentBrowserVersion": "35",
  "userAgentDeviceType": "Desktop",
  "userAgentOs": "Windows 8.1",
  "userAgentOsType": "Windows",
  "userAgentOsVersion": "8.1",
  "paymentStatus": "Completed",
  "paymentType": "Credit/Debit Card",
  "paymentTotal": 23.5,
  "paymentLog": {
    "paymentStatus": "Completed",
    "paymentLogKey": "9cb2345c50968900ac7d05e3751e465f",
    "paymentServiceCode": "DEMO",
    "userIpAddress": "127.0.0.1",
    "doTimestamp": "2015-01-27T15:10:49+11:00",
    "doAmount": 2350,
    "doMerchTxnRef": "1",
    "doVersion": "1",
    "drTimestamp": "2015-01-27T15:10:49+11:00",
    "drAmount": 2350,
    "drMerchTxnRef": "1",
    "drReceiptNo": "27",
    "drTxnResponseCode": "0",
    "drTxnResponseMsg": "Transaction approved"
  },
  "attachmentsStatus": "Completed",
  "dataExtracts": {
    "First Name": "Jeff",
    "Last Name": "Johnson",
    "Email": "[email protected]"
  },
 "milestones": [
    {
      "milestone": "Complete Application UID: ed726afdc8f94513fdcd0b1d150a1c0c",
      "timeCreated": "2015-01-27T14:52:04+11:00"
    }
  ],
  "deliveryStatus": "Ready",
  "dataDeleted": false,
  "xmlURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/69/form.xml",
  "receiptURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/69/receipt.pdf",
  "extractURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/69/extract.xls",
  "attachments": [
    {
      "id": 41,
      "attachmentName": "Pay Slip",
      "requiredFlag": false,
      "fileName": "712.GIF",
      "fileSize": 31133,
      "fileURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/69/41/712.GIF",
      "contentType": "image/gif",
      "timeUploaded": "2015-01-27T14:51:57+11:00"
    },
    {
      "id": 42,
      "attachmentName": "Employment Contract",
      "requiredFlag": false,
      "fileName": "ABC-123.pdf",
      "fileSize": 29595,
      "fileURL": "http://localhost:9080/manager/secure/rest/delivery/v1/maguire/rest-service/69/42/ABC-123.pdf",
      "contentType": "application/pdf",
      "timeUploaded": "2015-01-27T14:52:00+11:00"
    }
  ]
}