GET Submissions

Return the list of submission ids with the status delivery "Ready", "In Progress" and "Error" for a specified 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>/

Parameters

This operation supports a deliveryStatus query parameter, which can be used to filter on "Ready", "In Progress", or "Error" values. The query parameter name and value are case sensitive. Any mismatches in the query parameter name or value will be treated as though the query parameter was not present.

For example, given the data in the example response below, the following request:

GET https://transact.maguire.com/manager/secure/rest/delivery/v1/maguire/credit-card/?deliveryStatus=Ready

returns this JSON response:

[
    "2301",
    "2302",
    "2303",
    "2304",
    "2305"
]

Request body

Do not supply a request body for this operation.

Example

An example GET Submissions request is shown below.

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

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 or delivery channel may not exist.
503 Service Unavailable	The JM System Deployment property Enable REST/Web Service Delivery has been set to false.

Example

An example successful response is shown below.

{
    "ready": [
        "2301",
        "2302",
        "2303",
        "2304",
        "2305"
    ],
    "inProgress": [
        "2300"
    ],
    "error": []
}