Glossary Item Box

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

# SUBMISSION_POLL

# Message Source/Destination

Portal/Client Application to Gateway

#

# Processing

The SUBMISSION_POLL message is sent to the URL destination specified in the preceding SUBMISSION_ACKNOWLEDGEMENT message. The client can issue the SUBMISSION_POLL message after the recommended delay which is equal to at least the value in the PollInterval attribute supplied in the SUBMISSION_ACKNOWLEDGEMENT message.

The CorrelationID uniquely identifies the client. Its inclusion ensures that users with a digital signature submission do not have to constantly re-enter their PIN number. Any security details that are provided will be ignored.

The Class must match the Class value that was originally provided in the SUBMISSION_REQUEST which returned the CorrelationID. When performing a SUBMISSION_POLL Gateway checks if the given Class matches that stored in the Gateway corresponding to the associated CorrelationID. If no match is found an error is raised.

# Message Structure

GovTalkMessage | MANDATORY. A default namespace specified as “http://www.govtalk.gov.uk/CM/envelope”.
EnvelopeVersion | MANDATORY. Set to 2.0, or to 1.0 for backward compatibility.
Header | MANDATORY.
MessageDetails | MANDATORY.
Class | MANDATORY. Identifies the class of XML document contained within the Body of the originating submission.
Qualifier | MANDATORY. Set to poll.
Function | MANDATORY. Set to submit.
TransactionID | OPTIONAL. If present must conform to the XSD pattern defined in the GovTalk envelope specification ([0-9A-F]{0,32}). This value is returned by the corresponding SUBMISSION_ACKNOWLEDGEMENT message.
AuditID | OPTIONAL. If present must conform to the XSD pattern defined in the GovTalk envelope specification ([0-9A-F]{0,32}). This element are not currently used by the submission protocol. It is recommended is not present.
CorrelationID | MANDATORY. Must be set to the value returned by the SUBMISSION_ACKNOWLEDGEMENT.
Transformation | MANDATORY. Set to XML.
GatewayTimestamp | OPTIONAL. Element should be empty.
SenderDetails | OPTIONAL. Element should be empty. It is recommended that this element is not present.
GovTalkDetails | MANDATORY.
Keys | MANDATORY. Key elements should not be present.
Body | OPTIONAL. Element should be empty.

# Samples

The mandatory elements within the following sample submission poll 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>2.0</EnvelopeVersion> <Header> <MessageDetails> <Class>MOSWTSC2</Class> <Qualifier>poll</Qualifier> <Function>submit</Function> <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <Transformation>XML</Transformation> </MessageDetails> <SenderDetails/> </Header> <GovTalkDetails> <Keys/> </GovTalkDetails> <Body/> </GovTalkMessage>

© Crown Copyright 2008. All rights reserved