Skip to main content

Version: 23.04

POST Next Submission

Return the next submission ready for delivery for the specified organization and delivery channel. This operation changes the submission delivery status to "In Progress". The returned submission will not be returned again by this operation.

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​

POST https://<JM_SERVER>/manager/secure/rest/delivery/v1/<ORG_CODE>/<DELIVERY_CHANNEL>/next/

Parameters​

This request takes no parameters.

Request body​

Do not supply a request body for this operation.

Example​

POST https://transact.maguire.com/manager/secure/rest/delivery/v1/maguire/credit-card/next/

Response​

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

The response is the same as the GET Submission response except the delivery status values are also set.

Error responses​

HTTP status codeDescription
401 UnauthorizedUser not authorized to perform this operation.
404 Not FoundThe organization code or delivery channel may not exist. Ensure the HTTP method is POST, and not GET.
503 Service UnavailableThe JM System Deployment property Enable REST/Web Service Delivery has been set to false.

Example​

An example successful response is shown below.

{ 
  "id": 69,
  ...
  "deliveryStatus": "In Progress",
  "deliveryMethod": "REST Service",
  "deliveryMessage": "Delivered via \u0027REST Service\u0027 REST Service to administrator",
  "deliveryChannel": "REST Service",
  "deliveryTime": "2015-01-27T14:53:00+11:00"
  ...
}