Skip to main content

Version: 19.11 (EOL)

PUT Update Transaction

Update the status of a transaction.

Request

HTTP request

PUT https://<JM_SERVER>/manager/secure/rest/transactions/v1/<transaction id>

Request body

The body of your PUT request must contain a structure that looks like this:

{
"formStatus": <NEW_FORM_STATUS>,
"processingStatus": <NEW_PROCESSING_STATUS>
}

Both status values are optional.

  • <NEW_FORM_STATUS> can be "Saved" or "Abandoned".
  • <NEW_PROCESSING_STATUS> is added as a new processing status entry associated with the transaction (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

Example request
PUT https://transact.maguire.com/manager/secure/rest/transactions/v1/417

{
"formStatus": "Saved",
"processingStatus": "Reverted to saved status at user request"
}
Example response
{
"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": "someadmin",
"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/maguire/secure/servlet/SmartForm.html?submitKey=9f746b51721051b674b057c37b4bee95"
}