Skip to main content

Version: 24.04

PUT Update Task

Update the task's form XML data and/or status.

Request​

HTTP request​

PUT https://<TM_SERVER>/manager/secure/rest/tasks/v1/<transaction id>

Request body​

The body of your PUT request must specify one or more of the following parameters.

  • formDataXml: The form XML data to update the task with.
  • formStatus: The form status information to update the task with. Must be one of: "Assigned", "Saved", "Abandoned".
  • processingStatus: The transaction processing status entry to add (visible to the user), but does not otherwise influence transaction processing.

Response​

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

Example​

The example below updates Task ID 72492 (as specified by the URL path transaction id) with the form XML data (formDataXml), form status (formStatus), and processing status message (processingStatus).

info

The form prefill data is application/x-www-form-urlencoded encoded. In practice, it may be easier to use a multipart POST request to upload the form XML data.

POST /manager/secure/rest/tasks/v1/72492/ HTTP/1.1
Host: https://transact.maguire.com
Content-Type: application/x-www-form-urlencoded

formDataXml=%3C%3Fxml+version%3D%221.0%22+encoding%3D%22UTF-8%22%3F%3E%0A%3CAvokaSmartForm%3E%0A++%3CAddressAustralia%3E%0A++++%3CAddressLine1%2F...
&formStatus=Saved
&processingStatus=Reverted to saved status at user request
Example response for a successful request
{
  "id": 72492,
  "trackingCode": "P74L3V",
  "receiptNumber": "pf-lt41-16",
  "submitKey": "9f746b51721051b674b057c37b4bee95",
  "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": "john.smith",
  "formStatus": "Saved",
  "timeRequest": "2015-10-02T14:07:39+10:00",
  "timeSubmission": "2015-10-02T14:10:25+10:00",
  "timeLastUserActivity": "2015-10-02T14:11:14+10:00",
  "timeToSubmitSec": 166,
  "ipAddress": "123.134.145.156",
  "requestCookie": "JSESSIONID=pfD+pEOezdTwyev-jINZSn1y; __utma=264897119.59525688.1351658449.1393997213...",
  "referer": "https://transact.maguire.com/maguire/login.htm",
  "userAgent": "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:40.0) Gecko/20100101 Firefox/40.0",
  "userAgentBrowser": "Firefox 40",
  "userAgentBrowserType": "Firefox",
  "userAgentBrowserVersion": "40",
  "userAgentDeviceType": "Desktop",
  "userAgentOs": "Windows 7",
  "userAgentOsType": "Windows",
  "userAgentOsVersion": "7",
  "attachmentsStatus": "Optional",
  "paymentStatus": "Required",
  "paymentType": "Hosted",
  "paymentTotal": 123.0,
  "processingStatus": "Reverted to saved status at user request",
  "processingStatusTime": "2015-10-02T14:11:14+10:00",
  "deliveryStatus": "Not Ready",
  "dataDeleted": false,
  "formURL": "https://transact.maguire.com/workspace/secure/servlet/SmartForm.html?submitKey=9f746b51721051b674b057c37b4bee95"
}