Glossary Item Box

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

# Business Response

# Message Source/Destination

Gateway to Portal/Client application

#

# Processing

Once the Gateway has received the response corresponding to the original SUBMISSION_REQUEST message back from the Department back-end system, the Gateway will respond to the next SUBMISSION_POLL message, containing the matching CorrelationID, with the appropriate SUBMISSION_RESPONSE message.

This message may include a GovTalkMessage Body payload returned from the back-end system. This payload is opaque to the Gateway and will be associated with an appropriate XML namespace. The document contained within the Body element must therefore include a single root XML node which wraps the returned data.

The client may request the response document more than once by issuing additional SUBMISSION_POLL messages before finally deleting the response with a DELETE_REQUEST message. This would be necessary, for example, if the client encountered a transmission error during the previous SUBMISSION_POLL and received an HTTP error.

Note: The elements in the message are mostly populated from the Business Response received from the Department.

# 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 the mirror EnvelopVersion value in the associated SUBMISSION_POLL.
Header | MANDATORY.
MessageDetails | MANDATORY.
Class | MANDATORY. Identifies the class of XML document contained within the Body of the originating submission – supplied in the SUBMISSION_REQUEST.
Qualifier | MANDATORY. Set to response.
Function | MANDATORY. Set to submit.
TransactionID | MANDATORY. If the SUBMISSION_REQUEST supplied a TransactionID it will be returned in this element. Otherwise element will be empty.
CorrelationID | MANDATORY. Populated with CorrelationID associated with original submission (i.e returned in the SUBMISSION_ACKNOWLEDGE). This value is used in the DELETE_REQUEST 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 messages (e.g. DELETE_REQUEST or DATA_REQUEST) to this end-point.
Transformation | MANDATORY. Set to XML.
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.
TargetDetails | OPTIONAL.
Organisation | OPTIONAL. Populated with the Organisation element in the business response message returned from the Target Spoke (i.e Department). If present it will contain a string between 1 and 64 characters in length.
GatewayValidation | OPTIONAL. Populated with the GatewayValidation element/sub-elements in the business response message returned from the Target Spoke (i.e Department).
ChannelRouting | OPTIONAL. Populated with the ChannelRouting element/sub-elements in the business response message returned from the Target Spoke (i.e Department). Target Spokes (i.e. Departments) may use this element and its sub-ordinates to communicate details of their application name and version together with any specific transaction ID values for this submission.
Body | MANDATORY. The Body element may be empty or contain a valid business document returned from the back-end system. If a document is included it must have a single root node associated with another namespace specific to the submitted document type.

# Samples

The mandatory elements within the following sample submission business response 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>response</Qualifier> <Function>submit</Function> <TransactionID>20021202ABC</TransactionID> <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <ResponseEndPoint PollInterval=”2”> https://secure.gateway.gov.uk/submission </ResponseEndPoint> <Transformation>XML</Transformation> <GatewayTimestamp>2001-01-31T10:20:18.345</GatewayTimestamp> </MessageDetails> <SenderDetails/> </Header> <GovTalkDetails> <Keys/> </GovTalkDetails> <Body> <DepartmentDocument xmlns="http://www.organisation.gov.uk/namespace"> <Data> ABC </Data> </DepartmentDocument> </Body> </GovTalkMessage>

© Crown Copyright 2008. All rights reserved