Glossary Item Box

Government Gateway 2.2.0 (MR-01) ISV Developer Help (Doc Version 06/03/08) | Send comments on this topic.

# Document Submission Message Sequence

# Introduction

This is the typical sequence followed when a client application submits a document to a Target Spoke (i.e. a Department service) – assuming their are no errors.

Submission Sequence

Step | Action
1 | A SUBMISSION_REQUEST is sent to the Gateway to indicate that a new document is being submitted for processing.
2 | The Gateway replies to the client with a SUBMISSION_ACKNOWLEDGEMENT only once it has validated the GovTalk header (include credentials if required). The SUBMISSION_ACKNOWLEDGEMENT includes a CorrelationID to the client application which the client can use as an identifier for this document in future poll requests. The Gateway sends the submission on to the destination Department (DIS).
3 | The client application waits for the period specified in the PollInterval attribute of the GovTalk header of the SUBMISSION_ACKNOWLEDGEMENT message. Then checks the progress of the submission using the SUBMISSION_POLL message.
4 | The Gateway has not completed processing the message so again replies with a SUBMISSION_ACKNOWLEDGEMENT to indicate this to the client application.
5 | The client application again waits for period specified in the PollInterval attribute of the GovTalk header of the SUBMISSION_ACKNOWLEDGEMENT message. Then checks the progress of the submission using the SUBMISSION_POLL message.
6 | The Gateway has now processed the message so replies with a SUBMISSION_RESPONSE message to indicate to the client application that it has finished processing the document.
7 | Having received a SUBMISSION_RESPONSE the client application must delete the copy of the response stored on the gateway by submitting a DELETE_REQUEST message to the Gateway.
8 | The Gateway responds to let the client application know that the message (and all associated resources) have been deleted with a DELETE_RESPONSE.
9 | Although not necessary in this scenario, a client can issue a DATA_REQUEST to see the current status of any submissions sent the Gateway.
10 | The Gateway responds with a list of submission and their current state with a DATA_RESPONSE.

Note: A client Portal/application does not necessarily have to process each document sequentially as described above. Instead it could operated in a batch mode; submitting a number of documents over a period of time and then later using:

- DATA_REQUEST to examine the state of these submissions
- SUBMISSION_POLL to retrieve the corresponding response for each submission
- DELETE_REQUEST to delete each submission from the Gateway
- SUBMISSION_REQUEST to resubmit documents with recoverable errors

© Crown Copyright 2008. All rights reserved