Glossary Item Box

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

# DELETE_RESPONSE

# Message Source/Destination

Gateway to Portal/Client application

#

# Processing

This message will be returned by the Gateway in response to the DELETE_REQUEST message from the client application once all the resources relating to a CorrelationID have been successfully deleted.

# 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 the associated DELETE_REQUEST.
Header | MANDATORY.
MessageDetails | MANDATORY.
Class | MANDATORY. Identifies the class of XML document deleted from Gateway – supplied in the DELETE_REQUEST.
Qualifier | MANDATORY. Set to response.
Function | MANDATORY. Set to delete.
TransactionID | MANDATORY. If the DELETE_REQUEST supplied a TransactionID it will be returned in this element.
CorrelationID | MANDATORY. Populated with the value from the DELETE_REQUEST.
ResponseEndPoint | MANDATORY. Contains a valid HTTP end-point address. The PollInterval attribute is set to a non-negative integer. Note: This element and its value has no significance here and should be ignored.
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 delete response are shown in bold while optional elements appear in normal type.
<?xml version="1.0"?> <GovTalkMessage xmlns="http://www.govtalk.gov.uk/envelope"> <EnvelopeVersion>1.0</EnvelopeVersion> <Header> <MessageDetails> <Class>MOSWTSC2</Class> <Qualifier>response</Qualifier> <Function>delete</Function> <TransactionID/> <CorrelationID>B07B9ED3176193DDC4EC39063848A927</CorrelationID> <ResponseEndPoint PollInterval=”10”> https://secure.gateway.gov.uk/submission </ResponseEndPoint> <GatewayTimestamp>2001-02-25T16:32:18.795</GatewayTimestamp> </MessageDetails> <SenderDetails/> </Header> <GovTalkDetails> <Keys/> </GovTalkDetails> <Body> </Body> </GovTalkMessage>

© Crown Copyright 2008. All rights reserved