Glossary Item Box

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

# SUBMISSION_ACKNOWLEDGEMENT

# Message Source/Destination

Gateway to Portal/Client application

#

# Processing

The SUBMISSION_ACKNOWLEDGEMENT message is returned from the Gateway in response to a SUBMISSION_REQUEST and then subsequent SUBMISSION_POLL messages (until a SUBMISSON_RESPONSE or SUBMISSION_ERROR) is returned. The CorrelationID returned is used in the SUBMISSION_POLL message to identify the submission the client is interested in.

# Message Structure

GovTalkMessage | MANDATORY. A default namespace specified as “http://www.govtalk.gov.uk/CM/envelope”.
EnvelopeVersion | MANDATORY. Set to 2.0 or 1.0 to mirror the EnvelopVersion value in request (i.e. SUBMISSION_REQUEST or the associated SUBMISSION_POLL).
Header | MANDATORY.
MessageDetails | MANDATORY.
Class | MANDATORY. Identifies the class of XML document contained within the Body of the originating submission.
Qualifier | MANDATORY. Set to acknowledgement.
Function | MANDATORY. Set to submit.
TransactionID | OPTIONAL. If a TransactionID value was provided in either a SUBMISSION_REQUEST or SUBMISSION_POLL it will be returned.
CorrelationID | MANDATORY. This element will contain a hexadecimal number encoded as an upper case text string of 32 characters in length ([0-9A-F]{0,32}). This will be used with the next SUBMISSION_POLL message.
ResponseEndPoint | MANDATORY. Contains a valid HTTP end point address. The PollInterval attribute will be set to an integer value. The Portal/client application should issue follow-on SUBMISSION_POLL messages to this end-point after the recommended delay (in seconds) specified by the value in the PollInterval attribute. Note: The PollInterval is based on the average response time for document submissions of this class.
GatewayTimestamp | MANDATORY. Contains the time the message was generated.
SenderDetails | MANDATORY. Element will be empty
GovTalkDetails | MANDATORY.
Keys | MANDATORY. Key elements will not be present.
Body | MANDATORY. Element will be empty.

# Samples

The mandatory elements within the following sample submission acknowledgement are shown in bold while optional elements appear in normal type.
<?xml version="1.0"?> <GovTalkMessage xmlns="http://www.govtalk.gov.uk/CM/envelope"> <EnvelopeVersion>1.0</EnvelopeVersion> <Header> <MessageDetails> <Class>MOSWTSC2</Class> <Qualifier>acknowledgement</Qualifier> <Function>submit</Function> <TransactionID>20021202ABC</TransactionID> <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <ResponseEndPoint PollInterval=”10”> https://secure.gateway.gov.uk/poll </ResponseEndPoint> <GatewayTimestamp>2001-01-31T10:20:18.345</GatewayTimestamp> </MessageDetails> <SenderDetails/> </Header> <GovTalkDetails> <Keys/> </GovTalkDetails> <Body/> </GovTalkMessage>

© Crown Copyright 2008. All rights reserved